ThingWorx tutorials

The FairCom Edge schema is a list of all the databases, tables, and table fields (columns) that exist inside FairCom Edge. The schema can be thought of as a directory listing that tells you what files exist and what their attributes are but not the data inside the files. In other words, the schema knows about the tables' columns but not about the tables' rows.

UpdateFairComServer service

The UpdateFairComServer service updates the schema information inside of ThingWorx each time the service is run. Running this service is useful when ThingWorx's copy of the schema becomes outdated due to changes that occurred after the initial creation of the FairComeThing2 thing.

Important

It is important to realize that this service does not copy any of the data from the tables (the tables’ rows). To copy table data, the columns of the tables must first be mapped to ThingWorx properties.

Figure 3. UpdateFairComService service

UdpateFairComServer execute button

To run the UpdateFairComServer service so the schema inside ThingWorx is updated:

1. Navigate to the Services tab.

2. Scroll to the UpdateFairComServer service.

3. Click the UpdateFairComServer Execute button () (see Figure 3, “UpdateFairComService service”).

4. Click the Execute button in the Execute window that appears.

5. Wait for the service to say it executed successfully.

6. Click Done to dismiss the Execute window.

Once ThingWorx's copy of the FairCom Edge schema is up-to-date, the columns of FairCom Edge time series tables can be mapped into ThingWorx.

A time series table is one in which new data values are stored by inserting new records/rows into the table, rather than by editing existing rows in the table — for example, a device with several sensors might periodically sample those sensors and store their values in a table by inserting a new row which contains that set of samples, often with a timestamp. This allows the table to track the sensors' values over time. When we map a column of that table into ThingWorx, ThingWorx receives the data from the last row that was inserted into the time series table. 

When you map a FairCom Edge table column into ThingWorx, you create a new property inside the single FairComThing2 thing in ThingWorx. This property is updated with the latest value from the FairCom Edge table column.

If you map four FairCom Edge table columns into ThingWorx, you will have four properties inside your single ThingWorx thing, each of which will display the latest value from its FairCom Edge table column.

Fields in the selected table

The Fields window lists the fields/columns in the selected table.

Figure 4. Fields window

To change the settings of a field:

1. Click the Edit button () in the Actions column of the field you wish to edit.

2. Observe the Fields window that appears.

Edit the selected field

The Fields properties window is used to edit the mapping of the selected field, whose name is shown under FairComField.

Fields properties window features

Figure 5. Fields properties window

The Fields properties window includes:

• The FairComField textbox contains the name of the FairCom Edge table field/column.

  Important

  Do NOT edit this control.

• The IncludeInThingWorx checkbox causes the selected field to be mapped into the current ThingWorx thing as a new property when checked.

• The ThingWorxPropertyName textbox is used to give the new ThingWorx property a name in ThingWorx. If left blank, a name will be automatically generated following the pattern <databaseName>_<tableName>_<fieldName> . Names should not start with numerical digits or contain periods.

  Note

  Names should not start with numerical digits or contain periods.

• The ThingWorxType dropdown menu controls how ThingWorx interprets the data values from this field/column. If the field contains a binary image (such as a GIF or JPEG) change this from lvarbinary to image.

• The UpdateRateInSeconds textbox determines the ThingWorx update rate.

  • The default value of 0 specifies that FairCom Edge should update the value in ThingWorx as often as possible, skipping records as necessary in order to keep ThingWorx from falling behind.

  • A positive value tells FairCom Edge that it should not update this value in ThingWorx more than once in this many seconds.

    It also means that this value in ThingWorx will not be more than this many seconds old/out-of-date.

• The Set button is used to return to the Fields window when you are done editing the mapping values.

Mapping other fields

If you wish, you can now edit the mapping of a different field in this table, or click Done as many times as necessary, to back out to the point that allows you to edit the mappings of different fields, in different tables, in different databases, and so forth.

When you are done changing the mappings:

1. Click Done until you return to the FairComServer window.

   

2. Click Save.

   Warning

   Be careful not to press Done too quickly as you back out of the previous windows, or you may accidentally press Cancel on this last window, due to the fact that Cancel on this window is the same color and in the same position as Done in the previous windows.  This is a very easy mistake to make, and it will discard all the mapping changes you just finished.

3. After saving out of the FairComServer window, click Save for FairComThing2 to save your changes.

   

The Type mapping table shows the data-type mapping between the table fields in FairCom Edge and ThingWorx properties.