Metadata
Metadata is a list of names with corresponding values that is attached to an object's animation point. When using any of the DspAnGetMetadata Cicode functions this Metadata is processed, with the field values retrieved, and set at runtime. At runtime Metadata cannot be added or removed.
Metadata can be implemented when configuring the following animation objects-Free Hand Line, Straight Line, Rectangle, Ellipse, Polygon, Pipe, Text, Number, Button, Symbol Set, Trend, Paste Symbol, Active X, Process Analyst, Database Exchange Control, Pelco Camera View Controller, Citect SCADA Web Gate Control.
Note: Metadata can also be assigned to super genie associations. See Passing Animation Point Metadata as Super Genie Associations for more information.
Add a Metadata Entry
To add a Metadata entry:
- Click Add or double click on the row to make it editable.
- Insert the Name of the metadata.
- To start with an alphanumeric or “_” character
- To contain only those characters that are allowed as part of the tag name syntax (excluding the period character ‘.’ and reserved keywords), and not contain any white space.
- Be no more than 253 characters in length
- To be unique across a specific animation point.
- The name cannot be changed at runtime.
- The name can contain Genie substitutions
- Insert the corresponding Value of the specific metadata entry.
- The Value can contain Genie substitutions. E.g. %Level%
- To contain only those characters that are allowed in variable tag names or 'equipment.item' tag references, and not contain any white space.
- To be no more than 255 characters in length.
- Literal strings are supported and be specified within single quotes e.g.'Literal'.
Note: At runtime Values can be changed, however when the graphics page is closed the Values will revert to the original configuration.
- Click Add to save the row. The next row is highlighted and is now editable. Click on the ESC key to cancel this row or continue to enter name | value pairs until finished.
Edit a Metadata entry:
To edit a metadata entry:
- Double-click the cell you want to edit, or select a row and click the edit button.
- Modify the Name or Value .
Click Apply to bring your changes into effect and then OK to close the graphic object properties dialog.
Refer to Using Metadata for examples on how you can implement metadata in your project.
See Also
Published June 2018