Bulk Configurator Quick Start

Create a New Bulk Instantiation Workbook

  1. Launch the Bulk Asset Configurator from the ICONICS > Tools folder in the Start Menu.

  2. Create a new bulk instantiation workbook by clicking on the   button from the File ribbon tab.

  3. Choose where to save the new file.

Preparing the Bulk Instantiation Workbook for Configuration

  1. Launch the Workbench from the ICONICS folder in the Start Menu

  2. In the Workbench, select the Assets provider.

  3. In the Assets provider, expand the server then the configuration database

  4. Right-click on 'Assets' and choose 'Add Equipment From Library' from the menu

  5. In the Equipment Class Library dialog, pick the desired equipment class to use from the tree.

  6. Click 'OK' to bring up the Instantiation Options dialog.

  7. From the Instantiation Options dialog, select all aliases and copy them with Ctrl+C

  8. Open the blank instantiation workbook created from the Bulk Asset Configurator tool.

  9. Select the ClassInstantiation sheet.

  10. Paste the copied alias selections into any unused cells in the ClassInstantiation sheet.

  11. Transpose the pasted aliases from rows to columns by re-copying the pasted list of aliases from the ClassInstantiation sheet.

  12. Select the Parameter 1 cell, which should be column D.

  13. On the Home tab of the Excel ribbon, expand the Paste options and select the Transpose icon ().

  14. The aliases should now be transposed from rows to columns, beginning at column D.

  15. Delete the list of alias names pasted in step 10.

Equipment Definitions

  1. Create a row for each piece of equipment you want instantiated by the tool with the following steps.

  2. In column A, under TargetEquipment, enter the full target path of the equipment.

  3. In column B, under InstanceName, enter the desired name of the equipment to be instantiated.

  4. In column C, under EquipmentClass, enter the full path of the equipment class used to prepare this bulk instantiation workbook.

  5. For each alias column, enter the appropriate alias value for that particular equipment.

History Definitions

  1. To have HyperHistorian tags be automatically created when an equipment class is instantiated, click on the ClassHistoryDefinitions sheet of the bulk instantiation workbook

  2. In column A, under EquipmentClass, enter the full path of the equipment class used to prepare this bulk instantiation workbook

  3. In column B, under Property, enter the name of the equipment property from the equipment class that should be collected by HyperHistorian

  4. In column C, under GenerateHistory, set it to ‘TRUE’

  5. In column D, under IsCollected, set it to ‘TRUE’

  6. In column E, under LoggingGroup, enter the name of an existing logging group in HH

  7. In column F, under CollectorGroup, enter the name of an existing collector group in HH

  8. For all other columns, enter the appropriate values. Refer to the ‘Historical Column Names’ sheet for reference.

  1. Any unused columns can be deleted from the sheet.

Alarm Definitions

  1. To have alarm tags be automatically created when an equipment class is instantiated, click on the ClassAlarmDefinitions sheet of the bulk instantiation workbook.

  2. In column A, under EquipmentClass, enter the full path of the equipment class that was used to prepare this bulk instantiation workbook.

  3. In column B, under Property, enter the name of the equipment property from the equipment class that should have alarms configured.

  4. In column C, under GenerateAlarm, set it to  ‘TRUE’.

  5. For all other columns, enter the appropriate values.

  1. Any unused columns can be deleted from the sheet.

Instantiating Equipment with a Configured Bulk Instantiation Workbook

  1. In the Bulk Asset Configurator, load the input file that is configured.

  2. Check the appropriate checkboxes to generate alarms and history.

  3. For the listed providers, if a non-active database is to be the target for the instantiation, enter the SQL connection string for the respective provider.

  4. Click on the 'Home' button in the ribbon.

  5. Click 'Execute'.

  6. The tool will read in the selected bulk instantiation workbook and instantiate equipment as configured.

See Also:

About the Bulk Asset Configurator