Dynamic group definitions depend on the values set for the properties selected for the dynamic group definition. You can set up properties and then set the values through the Axeda® Connected Product Management Applications, through web services, or through XML files that are uploaded by Axeda® Gateway and Axeda® Connector Agents from the assets to the Axeda® Platform. For information on using web services, refer to the Axeda® Platform Web Services Reference Guide. This topic explains how to use an XML file and also how to use the Axeda applications to set up the properties and their values.
Important!
When assigning values to the properties that will create the hierarchy,
make sure that the fully qualified path name of the asset group will not
exceed 4000 characters. If the fully qualified path name exceeds 4000
characters, the asset group is NOT created. This limitation is a limitation
of the Platform.
When assigning values to properties, it is strongly recommended that you
NOT use a forward slash (/) character in the property value because this
slash is used as a delimiter in the fully qualified path of every asset
group. If you do use a forward slash in a property value, the Platform
automatically replaces the slash with a vertical bar (|) or "pipe"
when creating the name of the asset group.
Once assets have registered with the Platform, you can use the Model wizard of the Axeda® Configuration application to add the properties for all assets of each model. For details on this step of the Model wizard, refer to Model wizard_- Model Properties step.
After adding the properties to the model, you can assign values to the properties for the assets by selecting to edit the properties from the Properties module on the Asset dashboard of each asset. The properties page of the Asset wizard appears. For details about setting values for the properties, refer to Asset wizard - Asset Properties step.
This method of assigning values is useful if you need to make a temporary change (for example, you need to provide a different user temporary access to the asset) but is not practical when bringing many assets into the system at a time. A more efficient way to set properties for assets is to create an XML provisioning file that is uploaded by a File Watcher from the asset upon startup or upon changes detected by the Axeda® Agent.
You can configure Axeda Agents to upload an XML file that contains the property information, along with information that identifies the asset, as follows:
1. Create the XML file and store it in a subdirectory of the Agent installation directory on each asset that will run the project. The provisioning file can have any name, as long as its extension is xml.
2. Using Axeda® Builder, configure a File Watcher in the Agent project:
a. With your Agent project open, expand the model node in the Project Window, and click File Watcher to open the File Watcher window.
b. in the Project Window, right-click File Watcher and select Add New File Watcher.
c. In
the File Watcher dialog box, select or type values for the properties,
as requested. In particular:
§ You MUST configure a Hint for the File Watcher and you MUST call it "provisioning" (case insensitive), so that the Platform passes the file to the appropriate process for extracting the properties for the model and the property values for the asset.
§ Under Files, click the Add button and in the File Information dialog box, navigate to and select the XML file you created for provisioning.
§ You can set up the File Watcher to upload the XML file every time the Agent restarts (select the Initial Action check box).
§ If you want the file to remain on the asset, do NOT select the Transient check box.
§ When selecting a Compare Method, you are selecting the type of change that will cause the Agent to upload the file again: Time and Size or Contents (MD5 digest and time are both used).
§ Refer to the online help for additional
information (click Help
in the File Watcher dialog box for assistance with configuring
the File Watcher).
3. By default, the Agent checks the specified directory or file every five seconds. If you want to change this Scan Rate, select the Settings tool (Connector project) or the Configuration tool (Gateway project) in the Project window and then click the File Watch Settings icon.
4. In the Scan Rate field in the File Watcher Properties dialog box, type the number of seconds that you want the Agent to wait between checks of the specified directory or file. This value applies to all File Watchers in the project.
5. Click OK to save the new scan rate.
6. Save the project and download the project files to the asset(s). If you need assistance, refer to the online help for Builder.
7. If the Agents were running, restart them.
8. To check that the provisioning file was uploaded, go to the Asset dashboard (Axeda® Service application) for an asset that is running the project. You should see the file in the Uploaded Files module.
9. From the Asset dashboard, you can check the Properties module to see if the property values were loaded. You can also check the Audit Log module to see if the dynamic group definition ran.
10. To see the asset groups, you can go to the Home page of the Service application and select Asset Groups as the Browse tree filter. Then, expand the Root Asset Group node to see if the hierarchy has been created and also if the asset is assigned to the lowest group in the dynamic group hierarchy.
Once the Agent registers with the Platform and sends up the provisioning file, the Platform will assign the properties to the model (if they have not already been assigned) and set the property values for the asset. Once the property values are set, the dynamic group definition will run. If the file changes, the Agent will upload it again, the Platform will process it again, and if the values for the properties changed, the dynamic group definition will run again.