My Demeter Documentation

What is it used for (purpose)?

• To create or view data tables and tags for process designs.

What is on the page?

Left-Hand Pane

• Data Tables
• Tags

Middle Pane

• Data Tables
  • Add button
  • Number of Data Tables
  • Refresh
  • Search
  • Actual list of Data Tables
• Tags
  • Add button
  • Number of tags
  • Search (Missing Functionality)
  • Actual list of Tags

Right-Hand Pane

• Data Tables
  • Name of the Selected Data Table
  • Ellipsis containing Rename & Delete options
  • Close
  • Data Tab, with Add Row button
  • Columns Tab, with Add Column button
  • External Source
  • Save
  • Undo
• Tags
  • Name of the selected Tag Type (editable)
  • Close
  • Tag Type
  • Delete
  • Save

How to use the functionality on this page? 

Left-Hand Pane 

Data Tables 

• • Click the Data Tables to load the list of existing data tables in the middle pane.
  • On the right-hand pane, “No Data Table Selected” will be displayed by default.
  • Click one of the data tables, the details of the table will be displayed on the right-hand pane.

Tags 

• • Click Tags to load the list of existing tags in the middle pane.
  • The right-hand pane will show “No Tag Type Selected” by default.
  • Click one of the tags, the right-hand pane will show the details of the selected tag.

Middle Pane 

Data Tables 

• • Add 
    • Click the ‘Add’ button that is located at the upper right-side, and a dialog box will appear. 
    • On the dialog box, by default the name of the data table is “New Data Table”, rename the Data Table Name based on your purpose. 
    • Select the appropriate shared data table type. There are two (2) options: 
      • Internal – a data table that is manually populated.
      • External – a data table with an external data source which must be selected to save settings. 
    • Click 'OK' to add the data table to the list. By default, the right-hand pane will display the Data Tab.
    • When you click the 'Cancel' button, no data table is added to the list.
  • Number of data tables - located beneath the Add button and displays the number of data tables in the list. (Broken Functionality)
  • Refresh
    • Allows your process design list to refresh.
    • If you click the ‘Refresh’ button, the middle-pane will load and refresh the list.
  • Search
    • Search Data Tables in the list.
    • In the search field, type the word(s) or letter(s). You can observe that return is based on what is typed. (Counts are broken)
    • To clear a search, click the clear or cross button, it will remove what you have typed in the search field and return full list of data tables.
  • Actual list of Data Tables
    • By default, Data Tables are listed in alphabetical order.
    • When you click one of the Data Tables in the list, you can notice that the right-hand pane will show the selected Data Table.

Tags

• •  Add
    • Click ‘Add’ button to create another tag type on the list. A dialog box where you can type the name of the new tag type loads.
    • When you click the Cancel button, no tag type is added to the list.
  • Number of tag types – displays the number of tag type created. (Broken Functionality)
  • A Tag Type can be renamed, select relevant tag type and change value in the right-hand pane.

Right-Hand Pane

Data Tables

• • Name of the Data Table - displays the name of the Data Table.
  • Ellipses with two (2) options as follows;
    • Rename – you can rename your Data Table to suit your purpose
      • On the dialog box, change the name of the Data table, click Ok to save the new name.
      • The name of the Data Table will update in the list.
    • Delete – this will remove the Data Table from the list
  • Close - allows you to close the whole pane for selected data tables and return to default display, which reads “No Data Table Selected”.
  • Data Tab
    • For the selected data table, the Data tab will display by default.
    • In order to add a row, you must first add columns for the Data Table. You can add a column in the Columns tab.
    • Available functionality:
      • Search – Search data (rows) from the list.
        • In the search field, type the word(s) or letter(s). The return is based on what is typed.
        • To clear a search, click the clear or cross button, it will remove what you typed in the search field and return full list of rows.
      • Add Row
        • When you click the ‘Add Row’ button, a new line item (row) appears in the data table. By default, a blank row will be added to the top of the list. Rows are inserted in a consistent order when multiple rows are added at once.
      • Rows
        • To populate a row, move cursor to a column and type value(s). Values and text in rows can be edited and saved. 
        • If an ID Column has been set for Internal Data Table, new or updated data rows with the same values in the unique column cannot be saved. A red banner appears at the top which reads ‘Please correct rows with duplicated identity column values.’
        • Actions you can take for each row:
          • Archive – this will archive the row.
          • Process Usage List - will inform which processes use the row: Process Name, Task(s) and name of field which uses the row.
        • Save
          • All row(s) added to a data table must be saved. Click the ‘Save’ button to retain changes made.
        • Undo
          • Clears all actions taken since last Save.
  • Columns Tab
    • Search – search data (rows) from the list.
      • In the search field, type the word(s) or letter(s). The return is based on what is typed.
      • To clear a search, click the clear or cross button, it will remove what you typed in the search field and return full list of rows.
    • Add Column– allows you to add a column to the data table.
      • When you click the ‘Add Column’ button, a new column appears in the data table. By default, a new line item (row) will be added to the top of the list with Column Name = New Column and Type = Display Text
    • Columns – to rename a column, move cursor to the column name cell and type value(s).
      • After that, you can select the type of data you want to enter. There are two (2) types of data available:
        • Display Text – is used to display text to the user.
        • Number Value – is used to store a value.
      • Actions you can take for each column:
        • Archive – this will archive the column.
        • Process Usage List - will inform which processes use the column: Process Name, Task(s) and name of field which uses the column.
    • Set ID Column
      • The ID Column is a unique identifier which is used as the primary key to identify a row of data from the specific table. You can only specify one “unique” column for a data table.
      • When clicked, a dialog box appears, allowing you to select an identifier column for the data table.
        • If no ID Column is specified for an Internal Data Table, a message banner will appear on top of the right-hand pane which reads ‘No identifier column has been selected. This could result in duplicated rows being entered.’
        • For External Data Table, if no ID Column is set, a message banner will appear on top of the right-hand pane which reads ‘No identifier column has been selected. This could result in incorrect syncing from the external data source.’
      • Click ‘Select’ from the dialog box and an asterisk will be visible in front of the column name.
      • Then click the ‘Save’ button located at the bottom of the right-hand pane to save the ID Column settings.
      • When you attempt to change the ID Column for the data table, the data from the column is validated to ensure values entered are unique.
        • A validation will appear which reads “Column cannot be selected as duplicate row values exist” if any value is duplicated.
    • Save
      • All columns added to a data table must be saved. Click the ‘Save’ button to retain changes made.
    • Undo
      • Clears all actions taken since last Save.
  • External Source - by default this is disabled for Internal Data Tables
    • Checked where an external data source is used.
      • URL
      • Initialize data table – connects with the external data source
      • Sync data – populates the table with data fetched from external source

Tags

• • Name of the Tag Type - You can rename the tag type by clicking the name field and then ‘Save’.
  • Other actions you can take:
    • Close
      • When you click the ‘Close’ button, you can observe that the right-hand pane will close the details of the selected tags and return to its default display, which reads “No Tag Selected.”
    • Delete
      • When you want to remove a tag type, just click the ‘Delete’ button.
        • The tag type is no longer on the list
        • The tag type is also removed from any existing process designs that use it.
    • Save
      • Click ‘Save’ button to save the changes.