Launch data sheet definer to create mapping - SmartPlant Foundation - IM Update 48 - Help - Hexagon

The Data Sheet Definer is used to map the properties of the view definitions to the cells in the Excel worksheet. You create the mapping by checking out the data sheet template document and launching it with the Data Sheet Definer.

Once launched the Excel template file opens so that the cells in the spread sheet can be mapped to the schema required. For example, an unformatted data sheet opens, as illustrated in the following image:

1. In the Datasheet Definitions window, expand the view definitions.

2. To place a text label for a property:

   1. From the Drag & Drop Mode options, select Property label.

   2. From the displayed view definitions tree, select the property for which you wish to place the label.

   3. Drag the selected property into the selected cell in the Excel document where you wish to place the label.

   4. The display name defined for the property in the Schema is inserted into the selected Excel template cell.

   

   • If the property does not have a display name defined in the schema, the name of the property definition is inserted as the label text.

   • Ensure you not use special characters in mapped property names. Special characters include: | . - ! ? + ' % , ; & ~ * < >.

   

   • Some fields for properties gathered from across defined edges, cannot be modified as they are not editable; this is data that you would not author in a data sheet. Properties gathered from across relationships, and from differing component schemas, are the properties of other objects and they are therefore, by default, un-editable. This is a general rule and expected as normal behavior.

   • There is an additional flag on the Edge Name properties in the view definition in SmartPlant Foundation that can be set to read-write, read only or reference only. If a property is in another component schema, its edge should be set to reference only.

   • You can use read write for object edges as these are being created or updated in the data sheet. For view definition names, these can be set to reference only or read only, and then won’t be editable in the data sheet.

   • An example of an uneditable field is that the name of the Plant is set through SmartPlant Foundation Desktop Client. In a Data Sheet or Data List, the Plant name shows up as Site. The user cannot change the name of a Plant by modifying the Site field in a Data Sheet or Data List, as this is set to reference only.

   • Any change made to an uneditable field will not be reflected in the published data.

3. To map a property value to a cell in the template:

   1. From the Drag & Drop Mode options, select Property value.

   2. In the Excel template, select the cell, or range of cells, to which you wish to map the property value.

   3. From the displayed view definitions tree, check the check box beside the property to be mapped.

   4. The property name changes from red to green to indicate that it is mapped to the worksheet.

   

   • The definer automatically merges the selected cells into a single cell when the property to be mapped is selected.

   • Using a drag-and-drop operation to map a cell will clear any existing text, such as a label, from the cell. Do not use a drag-and-drop operation on a cell that already contains text.

     

4. Repeat the above procedure for each property to be mapped into the data sheet.

5. Click File > Save and close the Data Sheet Definer.