Smart Tables#

Smart tables are general purpose context resolution tables to store data records. Each smart table has its own database table in the database and therefore requires a unique metadata definition. In addition, search precedence keys and order are a important part of the smart table definition.

System Smart Tables#

The Critical Manufacturing installation is populated automatically with a set of smart tables which are necessary for the normal functioning of the system:

Table: System Smart Tables

Smart Table Page Views#

Data View#

Lists all the data rows that are included in the Generic Table. You can add new rows or edit the existing ones. You can also export data to file.

Definition View#

• Smart Table Definition - Displays information on the actual table definition.
• Properties - Displays information on the actual table definition.
• Precedence Keys - Displays information on the actual table definition.

History View#

This view combines information concerning other objects that have references to the current Smart Table object:

• History - displays the history of the operations, associated information, user(s) performing the changes and date and time of the changes.

Creating a Smart Table#

SmartTable.Create

Step 1: General Data#

1. Enter a name for the Smart Table.
2. Optionally, enter the description.
3. Specify whether the table should keep History information.
4. Define the number of days to display in the history by default.
5. Select whether multiple values are allowed for the same keys.
6. Select whether change control is activated for the Smart Table. See Change Controlled Smart Tables below for more information.
7. Enter a key to be used for reference in Localized Messages.
8. Optionally, define a Rule to be used for Pre-validating data.
9. Optionally, define a Rule to be used for Post-validating data.
10. Select Next to define the Smart Table Properties

Step 2: Properties#

1. Add or remove as many properties as needed and you can also order them (use to add, to remove, and or to order properties). For each property, you need to enter:

   • Name.
   • Description.
   • Key status (setting a field as Key forces the Mandatory status to be set as well).
   • Mandatory status.
   • Whether the property will be indexed in the database.
   • Reference type (depending on the reference, additional details need to be provided below):
     • None
     • Entity Type
     • Entity Version - both the specific versioned Entity Type and the property to which it refers are required
     • Enum - specific enumeration needs to be specified
     • Lookup Table
     • Lookup Value - name of the table to use as a reference for the value
   • Data Type - depending on the reference type.
   • Size (applicable only to some data types - for example, VarChar, Decimal, among others).
   • Decimal places, applicable only to Decimal data type. Must be less or equal to the Size.
   • Validation range (optional) - a string like '[start,end]' to designate ranges between start and end. An open bracket at the end excludes the limit values, for example, [1,10] excludes the number 1 and includes the number 10.
   • Validation regular expression (optional).
   • Default value (optional).

2. Select Next to configure the Precedence Keys.

Step 3: Precedence Keys#

This step is used to configure the precedence keys for the Smart Tables. Searches are always performed in the order that the precedence keys are defined.

1. Add and remove precedence keys by selecting or , order them by selecting or .

2. Select Finish to complete the operation.

Step 3: Generating schema#

SmartTable.GenerateSchema

Steps 1-3 are used to create the table definition. To create the schema in the database and to be able to use it anywhere in the system, the Smart Table must be actually created and made active by inserting it into the database.

This schema generation is achieved by pressing the Generate Schema button from the Smart Table Definition View.

Editing a Smart Table Definition#

SmartTable.Edit

To edit the definition of the Smart Table, open the Definition View and select the button. A wizard will be displayed to allow editing the basic details as well as adding or removing properties or precedence keys. Selecting Finish will save the new settings.

Terminating a Smart Table#

SmartTable.Delete

To terminate a Smart Table, it is necessary to open the Smart Table details and select the Terminate button.

Editing Smart Tables Data#

SmartTable.EditData

To edit a smart table data, proceed as follows:

1. Open the desired Smart Table Data View.
2. Add new records by selecting on the top ribbon.
3. Selecting the button will open a dialog that allows the user to edit existing records.
4. Remove existing records by selecting the values and selecting the Remove button on the top ribbon.
5. Select Save to commit the changes.

Copy Smart Tables Data#

SmartTable.EditData

To copy smart table data, proceed as follows:

1. Open the Data View.
2. Select one or more records from the table.

3. Select Copy on the top ribbon.

   

4. In the wizard, select the record you want to copy.

5. Select the copy icon at the top of the grid.
6. For each copied record, make the changes you need.

7. Select Add to complete the operation.

   

It is also possible to copy records by using the Add operation on the top ribbon.

Change Controlled Smart Tables#

Change control can be enabled or disabled by configuration in the Smart Table definition. When change control is enabled, modifications to the Smart Table must follow the normal Change Set approval process.

When a Smart Table is embedded within an object (for example, StepChartContext) which is part of the Step, the Smart Table can no longer be edited as part of the main object. A separate Wizard will be used instead to manage the changes to the Smart Table as shown in the picture below.

It is possible to visualize the pending changes by selecting the Pending Changes tab.

Revision resolution#

When using versioned entities as keys or values in Smart Tables, be aware of the following system algorithms:

Using the default revision#

In this situation, the BOM used as value in the table is defined without any revision, which in effect amounts to declaring that the default revision should be taken into consideration when resolving the entry for that precedence key.

If you decide to add a new entry and this time attempt to reference the specific default BOM revision, the system will not allow that new entry because an entry already exists for the same precedence key, even though the specific revision is not referenced.

This happens because the system will use the default revision to load the entity using the name of the entity. This way, the resolution for that specific revision, despite not being visually identical, is in fact equivalent to the existing table entry and cannot be duplicated.

Precedence Key Uniqueness#

Considering a new situation with the same Smart Table.

This entry states that for that combination of keys (Step, Product and Flow being the matching precedence key), that BOM is to be used. Continuing to add more entries, you can be as specific as needed:

However, if you try to add an entry that has different revisions at the same level of precedence key:

The system will not allow it because there is no way to distinguish a unique key between two different entity revisions at the same level of precedence keys, resulting in an inability to select a single entry from the Smart Table, as it is intended by design with these data structures.

You can, however, use the maximum possible granularity and select specific revisions for all keys: