DriveWorks Pro 22

Using The Dashboard DriveApp

To change the appearance:

• Logo

  Two versions of a logo are required:

  • Small - used in device responsive DriveApps, when viewed from a smaller screen (phone or tablet for example)
  • Large - used when viewed from a monitor screen or larger tablet
  Image files must be .jpg or .png file and less than 100kb.

  We recommend using .png with transparency set for any white space.

  Click the Upload button under each Logo version to apply a new image.

  The Preview tile will display the selected logo.

• Color Scheme

  The Dashboard uses four areas where the color scheme can be customized:

  • Highlight Color

    Controls the highlight strip applied just above the header.

  • Background Color

    Controls the header color.

  • Workspace Color

    Controls the color of the area behind the tiles.

  • Contrast Color

    Controls the color of any side menu that could become available.

  Each color area can have the following elements customized:

  • General Color

    Select the required element from the color area and enter the color Hex Code in the Preview Color field.

    Click the save icon to apply.

  • Font Color

    Select the required element from the color area and enter the color Hex Code in the Preview Color field.

    Click the save icon to apply.

  • Icon Color

    Select the required element from the color area and choose White or Black.

    Click the save icon to apply.

• Date Format

  Toggle between the preferred Date Format setting required for the Dashboard.

• Accessibility

  Controls the font size used for the Dashboard DriveApp.

The Language setting allows the DriveApp to translated into different languages.

The setting view will display all of the translatable text within the DriveApps.

There are two methods for translating the text:

1. Manual - enter the translation for each piece of text individually.
2. Bulk - export all of the text to a file, use a service to add translations and re-import into the DriveApp.

Manual Method

1. From the Language drop down, select the language to translate into.
2. From the list of text, select the row of text to be translated.
3. Click Edit.
4. Type the translation into the Translated Text box.
5. Click update.
6. Repeat from step 2 above for each piece of text to translate.
   Navigate up and down the list of text using the arrows next to the Edit button.

Bulk Method

The easiest method to translate uses a .csv file to export the text.

This allows translation of all the text either individually or by using a translation service.

Export the text to a .csv file

1. From the Language drop down, select the language to translate into.
2. Click Export.
3. Specify a Path to Export the .csv file to.
4. Click the Export button.
5. This will save the file to that location.
   The Export dialog will switch to the Import tab.

Add translations to the .csv file (individually)

6. Open the .csv file exported in the step 5 above.
   Using a spreadsheet application (such as Microsoft Excel) will open the file in a readable format.

   It will also allow the file to be saved in the correct format for importing back into the DriveApp.

7. Add the translations to the cells in the Translation column.
8. Save the file as CSV UTF-8 (overwriting the original exported file).
   Please note:

   The file must be saved as UTF-8 to allow for non-latin fonts.

9. Close the file.
10. Return to the Language setting in the DriveApp and click Import File in the Import dialog.

    Note the Path to Import field is pre-populated with the location and file name the original export was given.

    If the Import dialog (from step 5 above) was closed, it can be re-opened from the Language setting by clicking the Export button and then switching to the Import tab.
11. The Import will begin.
    This will take time, the import box will close when complete.

    Do not interact with the DriveApp during the import.

Add translations to the .csv file (automatically)

This method uses Microsoft Excel to open and save the .csv file and Google Sheets to automatically translate each text item.

6. Open the .csv file exported in the step 5 above.
   Using a spreadsheet application (such as Microsoft Excel) will open the file in a readable format.

   It will also allow the file to be saved in the correct format for importing back into the DriveApp.

7. Select the DefaultText and Translation columns, copy to the clipboard.
8. Open Google Sheets and paste the items above into a new blank sheet.
9. Type the following rule in the first Translation cell:

   =GOOGLETRANSLATE(A2,"en", "LangCode")

   Replace LangCode with the Google Translate code for the language required.

   Please see Google Translate Two-Letter Language Codes for a full list of codes.

10. Press enter to apply the rule in the selected cell.
11. Copy this rule to all other cells in the Translation column.
    Grab the blue square in the bottom right of the cell and drag to the last cell in Google Sheets.
12. Copy the two columns from Google Sheets and paste into the matching columns in the .csv file open in Microsoft Excel.
    Microsoft Excel may display a message about the data being pasted not being the same size as the selection.

    Click OK.

13. Save the file as CSV UTF-8 (overwriting the original exported file).
    Please note:

    The file must be saved as UTF-8 to allow for non-latin fonts.

14. Close the file.
15. Return to the Language setting in the DriveApp and click Import File in the Import dialog.

    Note the Path to Import field is pre-populated with the location and file name the original export was given.

    If the Import dialog (from step 5 above) was closed, it can be re-opened from the Language setting by clicking the Export button and then switching to the Import tab.
16. The Import will begin.
    This will take time, the import box will close when complete.

    Do not interact with the DriveApp during the import.

The default Dashboards that come setup are:

• Document KPI
• Home
• Model KPI
• Specification KPI

The four Icons on the right-hand side of the Dashboard Table are:

• Add

  To add a new Dashboard.

  1. Click Add.
  2. Enter a Dashboard Name.
  3. Enter a Description.
  4. Select the Justification for the tile positions.
  5. Upload an image for the background, if required.
• Edit Dashboard

  Edit the selected Dashboard to customize the Name, Description, Justification, and Background of the Dashboard.

• Edit Tiles

  Edit the tiles on the selected Dashboard to add, edit and position the tiles that will appear on that Dashboard.

  1. Click Edit Tiles on the right side of the Dashboards table.

     The Tile list will be displayed. Use this to delete, reorder and edit existing tiles on the Dashboard or add new tiles.

  2. To Add a new tile, select an empty row in the list and click the Add icon.
  3. Enter text to display on the Header of the tile.
  4. Enter a description.
  5. Select a Type for the tile.
     • Dashboard

       This will add a property called Dashboard. This is the Dashboard that will be loaded when this tile is selected

     • DriveWorks Project

       Two new properties will be added called Project and Data.

       Project is the DriveWorks Project that will be loaded when the tile is selected.

       Data is the text that will be passed into a constant called Data on the selected DriveWorks Project.

     • Hyperlink

       The property URL will be added where the required hyperlink for the tile to redirect to can be entered.

     • KPI

       This will change the Image menu to KPI Name.

       KPI Name is the KPI that you want to be displayed on the tile. Next to Background, there will also now be a Use KPI Settings button which will pull through the Background and Text Color of the KPI to be used on the tile if required.

     • KPI & Dashboard

       This will change the Image menu to KPI Name and add a property called Dashboard.

       KPI Name is the KPI that you want to be displayed on the tile. Next to Background, there will also now be a Use KPI Settings button which will pull through the Background and Text Color of the KPI to be used on the tile if required.

       Dashboard is the Dashboard that will be loaded when this tile is selected

     • KPI & DriveWorks Project

       This will change the Image menu to KPI Name and add two new properties called Project and Data.

       KPI Name is the KPI that you want to be displayed on the tile. Next to Background, there will also now be a Use KPI Settings button which will pull through the Background and Text Color of the KPI to be used on the tile if required.

       Project is the DriveWorks Project that will be loaded when the tile is selected.

       Data is the text that will be passed into a constant called Data on the selected DriveWorks Project.

     • KPI & Hyperlink

       This will change the Image menu to KPI Name and add a property called URL.

       KPI Name is the KPI that you want to be displayed on the tile. Next to Background, there will also now be a Use KPI Settings button which will pull through the Background and Text Color of the KPI to be used on the tile if required.

       The property URL will be added where the required hyperlink for the tile to redirect to can be entered.

     • DriveApp

       Two new properties will be added called DriveApp and Data.

       DriveApp is the DriveWorks DriveApp that will be loaded when the tile is selected.

       Data is text that will be passed into a constant called Data on the selected DriveWorks DriveApp.

     • KPI & DriveApp

       This will change the Image menu to KPI Name and add two new properties called DriveApp and Data.

       KPI Name is the KPI that you want to be displayed on the tile. Next to Background, there will also now be a Use KPI Settings button which will pull through the Background and Text Color of the KPI to be used on the tile if required.

       DriveApp is the DriveWorks DriveApp that will be loaded when the tile is selected.

       Data is text that will be passed into a constant called Data on the selected DriveWorks DriveApp.

     • List

       This adds a property called List and allows a list to be selected to be displayed on the KPI.

       Lists are set up in the List Manager.

       • List Administration
         This property value is currently reserved for a future service pack.
       • Teams

         This will allow the tile to access Teams administration.

         The default Teams tile (within the Security dashboard) uses this property.

       • Users

         This will allow the tile to access User administration.

         The default Users tile (within the Security dashboard) uses this property.

  6. Select the Background to be located on the tile, this can either be a default color or a custom background (created in the Tile Background Creator setting).
  7. Select an Image (optional) – an additional smaller image that appears on top of the tile can be selected.
  8. Select the Text Color – This can be toggled between Black or White.
  9. Select the Text Alignment - The options for the alignment are Left, Right, or Center and this will be how the text appears on the tile.
  10. Select Permissions.

      Permissions allows Teams access to the tile on the dashboard.

      By default this is set to Allow All.

      When a tile requires access for certain Teams only, they can be granted permission here.

      Once Custom is selected, the single chevron can be used to move the currently selected team to the allow column or the double chevron can be used to move all teams to the allowed column (the same works in reverse).

• Delete

  Delete the selected Dashboard.

  Deleting a Dashboard will prompt for further confirmation.

  Once deletion has been confirmed this action cannot be undone.

The Tile Background Creator consists of two tiles:

• Tile Background Creator
  1. Click the Upload Image icon to upload a custom image for the tile background.
  2. Choose Black or White for the Text Color.
  3. Choose an alignment for the text on the tile.
  Click Show Tile Backgrounds to open the folder location where the current background images are stored.
• Tile Preview

  This displays a preview of the tile.

On the right of the KPI Table, there are four icons:

• Refresh

  This is used to refresh the list of KPIs as well as clear the search and category’s filters.

  This is useful if multiple users are editing KPIs at the same time.

• Add

  Will add a new KPI.

  1. Click Add.

     This will open the KPI Editor.

     Click the Help button at the top of the editor for more information on the information each section requires.
  2. In the Name tab enter:

     All fields require completing.

     • Name

       This is the name the KPI is referred to in the search bar for the KPI table and the name the KPI is referred to when adding it to a tile on a Dashboard.

     • Category

       This is the category that the KPI will be linked to, this can either be a new category (this will appear in the category drop-down list) or a default category.

       Default categories include:

       • Documents
       • Machines
       • Models
       • Specifications

       Categories are not case sensitive.

     • Description

       This is the description of the KPI and will be displayed in the KPI Table, the description can also be displayed on the tile if required by selecting the Visible option.

     • Visible

       Select if the Description is to be displayed on the tile.

  3. In the Title tab enter:

     When the Visible option is selected all fields will require completing.

     • Visible

       Select if the Text is to be displayed on the tile.

     • Text

       Enter the text you want to be displayed on the KPI.

     • Color

       Enter a Windows color (for example Black) or a hex color code (for example #000000).

     • Font Size

       Enter the font size in points (for example 12).

     • Top Align - Bottom Align

       Toggle between top aligned or bottom aligned.

     • Font

       Enter any font installed on the machine running DriveWorks (for example Arial).

     • Font Style

       Enter any font styles to be applied (for example Bold).

  4. In the Data tab enter:
     • Type

       The format of the KPI data. Either Table, Value or Percentage.

     • Refresh Rate

       How often you want the KPI to refresh the data displayed in minutes.

     • Type Data

       The DriveWorks Rule to calculate the data to be rendered by the KPI.

       Build the Rule in DriveWorks Administrator and then copy and paste it into the KPI Data field.

       When Type is Table enter a rule in the Table field.

       When Type is Value enter a rule in the Value field.

       When Type is Percentage enter a rule in the Numerator and Denominator field.

  5. In the Colors tab:

     The Colors tab allows the color of the text that will be displayed on the KPI Tile to be selected.

     The fields displayed are dependent on the Type that has been chosen from the Data section.

     • Background

       Select a color for the background when the KPI is displayed on a tile.

       This color will only be used when the KPI is displayed on a tile and the Tile Setting - Use KPI Setting is selected.

     • For Table (selected from the Type field in the Data tab)

       Enter colors for the table Grid Line, Header and Text.

       Accepted values for Color properties are valid Windows colors (for example Black) or a hex color code (for example #000000).

     • For Value (selected from the Type field in the Data tab)

       Enter a Value Color for the displayed text.

       Accepted values for Color properties are valid Windows colors (for example Black) or a hex color code (for example #000000).

     • For Percentage (selected from the Type field in the Data tab)

       Enter colors for Color1, Color2 and Color3

       Accepted values for Color properties are valid Windows colors (for example Black) or a hex color code (for example #000000).

       Rules applied to the corresponding Rule field will result in that color being applied.

  6. In the Fonts tab enter:
     • Font - Enter any font installed on the machine running DriveWorks (for example Arial)
     • Size - Enter the font size in points (for example 12)
     • Style - Enter any font styles you want to apply (for example Bold)
  7. Click the Preview tab to view a preview of how the KPI will look on a Dashboard.
• Edit

  By default, the edit icon will be disabled until a KPI is selected from the list.

  This will load the KPI Editor and allow you to change any of the settings of any pre-created or custom KPI.

• Delete

  By default, the delete icon will be disabled until a KPI is selected from the list.

  When selected, the delete icon will immediately delete the selected KPI from the list.

  This action cannot be undone.

The List Manager will display a view of the default Lists.

The following icons appear at the top of the list:

• Add
  1. Click Add to create a new list.
  2. In the Adding List window, enter a List Name.
  3. Select a Data Provider from:
     • DriveApp-List-DataProvider

       This requires a List-DataProvider Project to be set up using the List-DataProvider Template.

     • DriveApp-Security-Teams-DataProvider

       Will display the Teams Administration list when selected from the running dashboard.

     • DriveApp-Security-Users-DataProvider

       Will display the Users Administration list when selected from the running dashboard.

  4. User Defined

     This option is currently reserved for a future service pack.

• Edit

  Select the list to edit, from the list view, and click edit.

  The Editing List window displays the same fields as the Adding List window described above.

• Delete

  Select the list to delete, from the list view, and click delete.