Page History

Understanding Symbols Libraries

The document elaborates on the concept of Smart Symbols, predefined or user-created symbols that can be widely used across solutions. It also delves into the creation, management, and utilization of symbols from the Local Symbols Gallery, highlighting their dynamic properties and tag mapping capabilities. There are repositories for reusable symbols: the Symbol Factory Library, and the Local Symbols Gallery. There are three main repositories for reusable components: the Images, the Symbol Factory library, and the Local Symbols Gallery. Let's delve into each one.

Local Symbols Library

The Local Symbol library's components may have built-in dynamic properties, and they may have an easy way to map them to the real-time tags in your application. This is explained in the following section.

If a symbol has both dynamic properties and tags, the system will automatically create label parameters for the symbol. After making a new symbol, double-click the symbol to check these parameters.

In order to Edit one of the symbols in the Local Symbol library, insert the symbol in a display, right-click it, and select Edit Symbol. This will allow you to change the symbol by changing the drawing tool and locking the other elements in the page. When you finish, right-click anywhere to select Save to Library, Save Only to Local display, or to cancel your editing.

The Local Symbols are composed of the default symbols in the SymbolLibrary.dbsln file and the symbols you created for your specific solution. If you change, delete, or insert a symbol in the SymbolLibrary.tproj, it will be accessible to any solution on that computer. The symbols you use in your solution are saved inside the SOLUTION file. Therefore, they are completely independent of any external file.

Symbol Factory Library

Custom Symbols And Data Types

You also have the flexibility to create your own symbols with any data links you want built in. You can tie them to a datatype, such as a pump object appearing every time you drag an integer datatype onto the screen. You can also create your own data types! For instance, you could make a pump data type with sub-parameters and link it to a symbol. Dropping the PumpUDT on the screen will bring ALL your data parameters with it automatically!igThere are three main repositories for reusable components: the Images, the Symbol Factory library, and the Local Symbols Gallery. Let's delve into each one.

Smart Symbols

Smart Symbols are among the most frequently used symbols. They include the symbols you create in a solution and a library of over 500 symbols specifically designed for FactoryStudio. The symbols in this library can be synchronized with the library, meaning any changes made to a symbol in this library will automatically apply to all displays using that symbol. Local Symbols can have dynamic properties that can be easily mapped to tags in displays; they can also be defined as the default graphical representation of tags.

All our symbol objects are vector-based, meaning they intelligently resize across all displays. These symbols can be used in both .NET and HTML5 displays, ensuring a uniform experience regardless of user display needs.

Symbols are powerful objects that can contain multiple data references or "input parameters", making them easy to replicate and use for various purposes while easily linking them to data-driven actions (such as showing color, running/off states, etc.).

Smart Symbols

The Smart Symbols Library includes the most frequently used graphics. You can create symbols and add them to a solution's local library. Symbols can be static images, or they can have dynamic properties and tags links.

To view the symbols used in your solution, do one of the following:

To see the symbols used in a specific solution, go to Displays → Symbols. You can export, import, or delete symbols on this page.
To see all of the available symbols, go to Displays →  Draw →Drawing, and click Insert Symbol.

Symbol Parameters

When you insert a symbol from the Symbol Library, it may have parameters. For our example, the VerticalTank symbol has the LevelValue, MaxScale, and MinScale parameters. To change the tags linked to these parameters, edit the new tag names in the dialog.

Editing and modifying symbols

Right-click the VerticalTank symbol and select Edit Symbol. This starts the Edit mode and allows you to see all of the objects that are part of the Vertical Tank.

Click on the black rectangle to see its Dynamics.

We use #<PropertyName>:TagName 

This syntax will create the exposed label parameters for the symbol. This makes it easier to map any linked tags when you are using the symbol.

For this example, the symbol has the "Level","MinScale", and "MaxScale" labels. When you insert this symbol in your display, you will be able to set the values for these parameters. The default value is after the colon ":" character.

"#LevelValue:Client.SimulationAnalog", creates a property called the "LevelValue" that has "Client.SimulationAnalog" as the default value.
You can use any name for the Label parameter.

When creating symbols, it is useful to initially map the properties to client.SimulationDigital, Client.SimulationAnalog, or Client.SimulationDouble. These are variables with values that change every second so you can see the result of your dynamic properties. You can use the internal Client.DigitalValue, Client.NumericValue, and Client.TextValue variables when you want to use a placeholder value without any built-in simulation.

In order to save the symbol, right-click the symbol or on the display and click Save to Symbol Library or click the Save icon on the top toolbar. Double-click the symbol to verify its properties. 

Working with Symbols

Creating New Symbols

You can use the drawing tools and the COMBINE commands in the horizontal toolbar to draw your own symbols.

You can also use the symbols from the Symbol Factory and click the UNGROUP command in the horizontal toolbar to edit the imported symbols.

You can use the Direct Selection cursor to edit internal elements without needing to ungroup.

If you want to save a new symbol to the Local Symbols Library, select the object or objects that you want to be part of the symbol. Then, right-click and select Make a new symbol. 

Enter the Name, Folder, and the description of the Symbol.

You can open the Symbol Library and choose the symbol to use in your displays.

Inserting A Local Symbol

Go to the Display Drawing Environment, right-click the screen and select Insert Symbol. Alternately, you can click the Local Symbol icon in the vertical toolbar.

After selecting a category and symbol, click the symbol. Then, click the screen to position the symbol. You can also drag-drop symbols onto the screen. If you double-click a symbol, it will close the library window and will allow you to insert the selected object.

Double-click a symbol to see its runtime properties and map it to the tags in your application.

Some symbols do not have custom parameters. In this case, double-clicking the symbol will show the Dynamics dialog.

Linking Symbols and Tags 

A symbol can be configured to be the default representation of a tag type. Every time you paste a tag into the Draw Environment, a symbol will be automatically created and mapped to the inserted tag.

The Digital, Integer, Double, Decimal, Text, DateTime, and TimeSpan tag types have the name of the tag and an input/output text box as their default visualization. To select multiple lines on Unified Namespace → Tags click on a line and hold Shift while clicking on another line to mark a range. The system will automatically create one object for each of the tags.

If you want to change any of the properties for the objects that were created, select all the TextBox objects by clicking and dragging over the display. Select the area with the objects and double-click on any selected object to open the "Edit Combined Dynamics" dialog.

The lines on Unified Namespace → Tags can be copied to Excel. Add the Left and Top columns to the Excel table. Then, copy/paste the table and its header column to the display. After this, the system will position the objects using the coordinates found in the table.

If you create a symbol with one dynamic parameter, and save it with the name "Integer", that will become the default visualization for the "Integer" tags. The same applies to any tag type. If you create a symbol with one dynamic parameter and save it with a name, it will become the default visualization for any tag with that name. For example, a symbol saved with the name Integer will become the default visualization for the "Integer" tags. 

Linking Symbols To Tag Templates

You can define a symbol to be the default view for a tag template.

Go to Unified Namespace → Data Templates to create a new template.

Go to Unified Namespace → Tags and create tags with Demo type.

In the Display Drawing environment, insert any objects that you want to be part of the symbol. In the example, we use a TextBlock and TextBox with the parameters #Tag: (Tag.Demo.Integer1) for their dynamic properties.

Now, select the TextBox and the TextBlock and right-click to make it a New Symbol with the Name and Folder called "Demo".

The parentheses () in the TextBox and TextBlock expression define the scope on what should be replaced when you map the symbol.

For the hashtag syntax, #Label: When you paste the tags, they become the placeholder that will show where the tag name should be replaced with the dynamic animations or expressions.

Go to Unified Namespace → Tags and copy all tags with Type:Demo.

Paste the tags in the Drawing environment 

When inserting tags of this template type, the system will look for a symbol with the same name of the template. If a match is found, the symbol is created and linked to the tag you inserted in the display. 

If you create symbols using only Tag Elements and not expressions, you do not need to explicitly use the full syntax: #Label:(tag.Demo).Integer1 to define the label parameters. If you just use your tag in the object's dynamic properties and execute the Make Symbol command, the system will automatically search for tags in the symbol and create the related parameters. When using expressions or when having multiple tags and templates in the same symbol, you must explicitly use the hash tag # and the parentheses in order to define the scope of your symbol's customizable parameters. 

Linking Symbols and Tags Using Categories

You can map a symbol to a group of tags, but you do not have to make the symbol map to all tags with the same type. To do this, use the Category column to link which symbols should be used as the default interface for each group of tags.

Go to Solution → Categories and create new categories.

Insert a symbol in the Drawing Environment. 

Go to the Displays→ Symbols tab and chose the respective category for the symbol in the Category column. 

If the Category column is not visible, right-click any Column name and select columns you want to see.

Go to Unified Namespace → Tags and define the category for the tags.

Select all the tags and copy/paste them into the Draw Environment. Each tag will map to the respective symbol, according to the association defined in the Category column. 

Usando exatamente as mesmas palavras

In this section: