Graphics Builder > Graphics Objects > Edit Common Object Properties > Using Metadata
Using Metadata

The following examples provide a guide into how you can implement metadata within your project. In the first example you will set parameters using metadata, and in the second example see how genie substitutions can be used in metadata.

In the first two examples a paint factory needs to control the amount of Cyan, Magenta, Yellow, and Key (Black) (CMYK), which is mixed to create different colors in their color chart.

The third example illustrates how substituting the equipment name, in an equipment.item reference when configuring a Super Genies lessens the need to define large amounts of metadata in the genie calling it.

ClosedExample 1: Setting Parameters Using Metadata
  1. From the toolbox select the ‘number’ tool and in the Text Properties dialog configure as below. This is the pump that represents the color Cyan.

  2. Repeat to create the remaining pumps M_ PUMP, Y_ PUMP, B_ PUMP

    3. Note:Add these pumps to the example project as Local Variable tags

  3. Create a button object. This button when selected at runtime will set the CMYK values for a specific color e.g Pine Green

    4. Note: For Display functions DspAnGetMetadataAt, DspAnSetMetadata, DspAnGetMetadata, and DspAnSetMetadataAt -2 is the default value used to retrieve the unique animation number for the button object.When you need to know the AN that triggered the input/command, the KeyGetCursor() function may be used as it returns the AN where the cursor is currently positioned.

  4. At runtime when the ‘Pine green’ button is selected the values of the metadata defined for Cyan, Magenta, Yellow and Black are retrieved and the relevant pumps set.

ClosedExample 2: Using Genie Substitutions in Metadata

Instead of creating a new button for every color as you did in the previous example, you can create a genie and save it in the genie library. You can use the genie every time you need to create a new color button.Only needing to configure the name of the button and the CMYK values that belong to it.

  1. From File New-> Genie
  2. Add a button object onto the page
  3. Configure the button – the title of the button and the Value of the Metadata have been defined using genie substitutions e.g %Color% and %Cyan%.

  4. Save the genie in the appropriate genie library
  5. At design time paste the genie onto the graphics page. A dialog will open prompting you for the name of the button, and the numeric values for Cyan, Magenta, Yellow and Black. In this example the name of the color is “Purple Heart”

  6. At runtime when the ‘Purple Heart’ color button is selected the values of the metadata (that were entered in the genie prompt) are retrieved and the relevant pumps set.
ClosedExample 3: Using Partial Associations in Metadata

Partial associations, where only part of the variable tag, or equipment.item reference is substituted (with a name)in the Super Genie, can now be used lessening the need to define large amounts of metadata which is not easily maintainable.

In this example you will:

ClosedCreate the Genie
  1. In the Citect Graphics Builder go to File | New | Genie.
  2. A new genie will open.
  3. From the graphics toolbox select the select the Button tool and click on the page to position it.
  4. Draw the button and in the Button properties dialog configure the following:

  5. Click OK to close the dialog and save the button properties
  6. Click the Save tool, or choose File | Save.
  7. Select the Project and Library in which to store the Genie.
  8. Name the Genie e.g. Motor_Genie and click OK to save
ClosedCreate a Super Genie Library Object

To create the Super Genie shown above:

  1. From the toolbar select New, or choose File | New.
  2. Click the Super Genie option.
  3. A blank Super Genie library object page will open.
  4. In this example a pop up that displays 13 values will be created.
  5. Select the Text tool and click to position the text on the page and to open the Text properties dialog.
  6. In the text properties dialog enter _RUNNING.
  7. Repeat steps 5 and 6 for the remainder of the labels.
  8. Select the Numeric tool from the graphic toolbox and position next to the first label e.g _Running.
  9. Click to paste onto the page and to open the Text Properties dialog. Configure the Numeric expression as below with ?equip? being the substitution name.

  10. Click OK to save the text object and close the dialog.
  11. Repeat steps 9 and 10 for the remaining equipment.items, matching the label with the end of the expression. For example ?equip?.STOPPED.
  12. Click OK to apply the changes.
  13. Select File | Save.
  14. In the Save dialog, select the project the page will belong to.
  15. Name the Super Genie page (e.g.!Motor_Info) and click OK.
  16. Once saved you will need to Attach the Super Genie to the Genie you created previously.
ClosedAttach the Super Genie to a Genie
  1. Open the Genie
  2. With the Genie open, select Edit | Attach Super Genie.
  3. Click Add, and the Super Genie Dialog box will open.
  4. Select the library the Super Genie belongs to.
  5. Select the Super Genie to attach e.g. !motor_info and click OK.
  6. The Super Genie is added to the Attach Super Genie list.
  7. Click OK to save the changes, or click Cancel.
ClosedPaste onto Graphics Page
  1. Create or open an existing graphics page
  2. From the graphics page select Edit|Paste Genie, browse for the genie you created previously and select it.
  3. On pasting the genie, the dialog will open prompting you to fill in the ‘Equipment’ field with the name of equipment for example Plant100.Area1.PumpHouse1.Motor01.

  4. The Equipment name entered will replace the value in the metadata tab (in your button as part of the genie). For example %Equipment% becomes Plant100.Area1.PumpHouse1.Motor01.

At runtime, when the ‘info’ button is pressed the values of the equipment are dynamically generated and assigned to the matching Super Genie Association. E.g. All occurrences of the substitution name ?equip? will be replaced with Plant100.Area1.PumpHouse1.Motor01 (creating the full equipment.item reference) and the values for the equipment.item displayed.

See Also

Define Common Object Properties

Published June 2018