Dictionaries

Using the Toolbar

The toolbar at the top of every page has all of the common toolbar buttons, such as undo, redo, cut, copy, and paste, as well as buttons for common functions that are unique to FactoryStudio.
 
In addition, some buttons have additional options when you right-click them. For example, the Print and Find buttons have these additional options.

The print options let you either print or save to a CSV file.

The find options let you find, go to previous, and go to next. For more information, see Working with DataGrid Tables below.

Undoing and Redoing Changes

The Undo and Redo buttons on the toolbar let you undo or redo any operation. When editing tables, undo and redo are available for all changes during your editing session. When editing documents (in the Reports, and Scripts sections or in the Draw environment), undo and redo are available until you save changes.

Smart Cut, Copy and Paste

The Cut, Copy and Paste buttons are context sensitive. When the focus is on a DataGrid they will cut/copy and paste the selected rows. When the focus is on the drawing tool, they will act on the selected objects. The reason for the word "Smart" is that you can copy and paste rows to and from Excel, as well from other tables in the workspace, even if the columns are not all the same. When copying and pasting, the column titles are also copied to the clipboard, so the system is able to put the information in the right columns, no matter what order the columns are in, and no matter if some columns are not present, in the target table.

When copying from Excel make sure to select the row titles. You can also copy rows from the Tags tables to the Historian directly to enable data logging of those tags.

Print, Save to a File or Import
 

These commands allow you to print the selected document (either a DataGrid or a Drawing). The export button will save DataGrids to a CSV file and graphical displays to JPG files. The import button will import CSV files to the DataGrid.

Finding Objects

You may want to find where you have used a specific object, such as a tag, in a project. The Engineering workspace provides three ways to search.

 Find String button and Find Object Buttons 

The Find String button is used to search for a specific string in the current tab of the current datagrid. Type the string you want to search for in the text box and press the FindString button.

The Find Object button on the toolbar accesses the object cross reference, which lets you find where objects are used in the Project and go directly to each location. For more information on cross reference, see Cross Reference under Productivity Tools below.

Finally, you can filter the rows displayed on the datagrid by typing a mask string in the input field. Standard wildcards are supported. For example, if you set the filter to "abc" the display will show only the rows with the letters "abc" in any position of the name. A filter of "ab*" will show the rows with names starting with "ab". Click on the Home button to clear all the filters and reset the viewing state of all the datagrid columns to the system default.

New Tag and Tag Properties

New Tag: allows creation of a new tag in the real-time database.
Tag Properties: shows the properties of the tag selected in the text box.

Security Logon
 The tooltip shows the currently logged-in user and when you click it opens the Logon Dialog. By default, when the system starts, the Guest user is logged in.

Help Button

 The Help button displays the section Info-Help, which provides access to the local help file and enables searches on the online content. 

Navigating in the Workspace

Navigation in the FactoryStudio workspace is based on a hierarchy of user interface screens with three levels: environments, sections (or modules) and tabs. 

Any Engineering workspace user interface is, therefore, identified by 3 names: the Environment (main menu on top left), the Section (or sub-menu) and the Tab (or Table). To describe how to get to a specific location where you perform functions, we use a shorthand notation.

Working with DataGrid Tables

Many tabs in FactoryStudio display information in a table. All tables let you manipulate, copy, paste, and import data in the same way.

Editing Tables

FactoryStudio stores most configurations from the Edit menu, such as tags, alarms, and users, in tables. In most tables, you can add and edit information the same way. 

To add a new table item (row):

• Click the first column of the insertion row. The insertion row is the first row of the table and has an asterisk  next to it.

After you click a column in the row, the * becomes a pencil icon, showing that you are now editing that row. 

• Do one of the following in the column in which you clicked:
• If the column is a text field, enter the information.
• If the column is a selection field, click again, then select items from the drop-down list or pop-up window that displays.
• Press Tab to move through the columns in the row.

To edit an existing table row:

• Click the column in the row that you want to change.
• Do one of the following in the column in which you clicked:
• If the column is a text field, enter the new information. The system overwrites the text that was in the field. To change part of the text, click again, then make changes.
• If the column is a selection field, click again, then select items from the drop-down list or pop-up window that displays.

More than one person can edit a project at the same time. The system saves all changes to the project server and propagates the changes to other users. If two users modify the same configuration table or document, the changes from the last person who saves would overwrite any previous changes. 

Tooltips and Validation

Throughout FactoryStudio, fields and buttons have tooltips that contain information about the field or button. tooltips appear when you move your cursor over the related field or button. Some tooltips also include an example that can help you.

The system also validates what you enter in most fields, especially in tables. Validation rules may check that the input is in a correct format, that values are within the appropriate range, and other factors. The exact rules depend on the specific item. If you see a red outline around the table cell, the entry is not valid. 

Sorting, Filtering and Grouping

Information in many tabs within FactoryStudio displays in tables that you can sort, filter, and group. By default, items in a table are listed in the order in which you created them.

To sort a table:

• From any table, click the column heading you want to use to sort. The items now sort in ascending alphanumeric order based on that column.

• Click the column heading again to sort in descending alphanumeric order.
• Click the column heading again to return to the default order.

To filter a table:

• From any table, hover over the column heading you want to use to filter.
• An arrow for a drop-down list displays next to the column heading.

• Click the arrow to see the list of items in the column.

• Select the items you want to include in the filter.
• To remove the filter, click the drop-down list and click (Clear Filter).

To group items in a table:

• From any table, drag a column heading to the area above the columns to group by that column.

• To remove the grouping, drag the column name back to the column headers area.

Adding and Removing Columns

Tables in FactoryStudio display a default set of columns. Every table has additional columns that you can display, and you can remove any of the default columns. You can also change the order of the columns.

To add or remove a column:

• From any table, right-click in the column heading area.
• A list of all available columns for that table displays. Columns with a check mark next to them currently display in the table.
• Select or deselect columns in the list.
• Click outside the list to close it.
• To change the order of the columns, drag a column heading to a new location.
• To reset the columns to the default, click  Reset Grid to Default Settings.

Common Column Definitions

Several common columns are available from many tables. These columns are defined below, rather than repeating them in the description of every applicable table.

Copying and Pasting Rows

You can copy and paste rows into and from tables in FactoryStudio. The smart copy/paste functions let you copy rows from one table to another within FactoryStudio. For example, you can copy tags and paste them into the Historian tab or the Items tab under Alarms.You can also copy and paste to and from a spreadsheet. In addition, you can import a comma-separated values (.csv) file into any table. Column headings must match the table you are importing into. The best way to ensure that is to copy rows into a spreadsheet first, then edit the spreadsheet. 

Copying and Pasting Within FactoryStudio 

To copy rows to another tab in FactoryStudio:

• From any table, select one or more rows.
• Right-click and select Copy Selected Rows.
• Go to another tab in FactoryStudio.
• Right-click and select Paste Rows.

Copying and Pasting To or From a Spreadsheet 

To copy rows to a spreadsheet:

• From any table, select one or more rows.
• Right-click and select Copy Selected Rows.
• The copy automatically includes all available column headings for the tab you are in.
• Go to a spreadsheet and paste.

To paste rows from a spreadsheet:

• Set up the spreadsheet columns by following the copy steps above.
• Enter the information you want.
• Copy the information, including the headings, from the spreadsheet.
• From the corresponding table, right-click and select Paste Rows.
• The paste automatically places the data into the corresponding columns. Any empty cells are ignored.

Importing Data 

• Create the data in a spreadsheet. If you are creating tags or other objects, you can name the objects as needed. If you are populating other columns, the data in the columns must match what FactoryStudio expects.
• Save the file as a .csv.
• From the corresponding table in FactoryStudio, click  Import from a CSV file.
• Navigate to the .csv file and select it.
• Click Open.

The system imports the data into the table. 

Productivity Tools

This section explains the major tools and features that are included in FactoryStudio to assist with common tasks. 

Intellisense 

The Intellisense feature presents a list of valid objects according to the characters you are typing into a specific input field and the valid entries for that field. You can insert a selected item from that list by pressing enter, space, the dot key or other symbol keys. All the input fields, either on the datagrids or at the drawing tools, where you can use tag names or object names, are enabled through Intellisense. The Intellisense fields also have built-in tooltips and validation, as previously discussed. Putting the mouse over a field will present the expected entries to that field. When you have an invalid input, the border of the field will become red and the tooltip will show the error. 

Refactoring

Refactoring is the procedure of changing the definition of tag names, or any other object names (such as alarm groups, device nodes and any other) after that symbolic name is already in use in the application. Thanks to the centralized SQL configuration, FactoryStudio allows you to rename any object by simply typing the new name at the configuration table where that object is defined. All the references to that object will remain valid, using the new name with no actions required. For instance, to rename a tag that is already being used all across the project, just go to Edit-Tags-Objects and rename it. The same applies to Edit-Alarms-Groups, members at templates or any named object in the system. 

Cross Reference

You can view how many times each object in the project is used, as well as a list of objects that are not used. 

There are three distinct ways to select the object for which you want a cross reference.

1. Do one of the following:

• • From the table that has an occurrence of the object you want to find, select the object. For example, select the tag you want to find elsewhere in the project. The Find field in the toolbar auto-populates with the name of the selected tag.
  • In the Find field in the toolbar, enter the type of object (tag), followed by a . (period), followed by the name of the object (the tag name in this case). As you type in the field, the system matches the first entry to objects in the system. After the first period, it lists all objects of that type.
  • Next to the Find field, click .... .The Select Object window displays with a list of all the object types. When you select an object type, the names of that type display.

2. Click Find or, from the Select Object window, click OK. The results of the search display in the Find window at the bottom of the page.

3. Double-click any row in the find results to go to that item.

4. To close the results pane, click Find window at the bottom of the page.

To track object use:

• Go to Run > Tools > UseCount.

The table lists the number of references to every object in the system. To view objects that are not used, click the UnusedObjects tab. For a complete cross-reference of all objects, click the CrossReference tab.

Dictionaries

This section presents various types of dictionaries that can be created and used in FactoryStudio.

Localization

You can localize the text in your application in as many languages as needed. To do this, create a dictionary for each language. 

To create a localization dictionary:

• Go to Run > Dictionaries -> Localization.
• Click New.
• The Create New Localization Dictionary window displays.
• Enter a name for the dictionary.
• Click OK.
• Click Load Strings to populate the table with all controls that have strings that are set to Localizable. In the TranslatedText column, enter the text in the dictionary language.
• Create controls in a display or write a script to use the object called Client.Dictionary to configure the dictionary or dictionary options for the user. When the dictionary changes, the language changes throughout the application.

The alarm messages can also be included in the localization if the related check-box is set.

On Info-Project-Settings, you can also define the default Culture Information that the application is using. The runtime property Client.CultureInfo allows you to change it during runtime. Some display controls may get the Culture Info directly from the Operating System, so the correct procedure is to have both the Operating System setting and the project settings with the target culture to run the application.

Enumeration Sets

You can also use dictionaries to "translate" tag values to text. These dictionaries are called Enumeration Sets. For example, a device may have a value of 0  or 1 . Rather than display "0" or "1," you can display the strings "on" or "off."

To configure Enumeration sets:

• Go to Run > Dictionaries > Enumeration Sets.
• Click New.
• The Create New Dictionary window displays.
• Enter a name for the dictionary.
• Click OK.
• In the Value column, enter the numeric value, and in the Translated Text column, enter the string to display.
• For tags that use the numeric values as Enumeration Set, configure the Parameters column to use this set.
• When configuring a display component to use these tags, set the TextOutput to one of the following:
• Tagname or Tagname.Value: show the numeric value of the tag.
• Tagname.ValueAsString or Tagname.DisplayValue: show the enumeration string.

Categories

You can create a dictionary of Categories in order to allow classification of engineering objects. Most configuration tables, such as Tags, Device Nodes, or Alarm Groups, have the Category column, where you can apply one or more categories to that object.

• Go to Run > Dictionaries -> Categories.
• Edit the desired categories for this project.

The object categories can also be accessed during runtime for filtering and other custom applications, from the Category property of the objects. A list of all categories defined in the Project is available during runtime at the property Server.Categories. 

Import Wizards

On Run-Extensions-Import you can find a set of wizards to import project components. The contents displayed at that interface are dynamically created according to the DLLs found in the IMPORT folder of the project installation. System Integrators and other partner companies can create import wizards using the Toolkits.

The built-in Import tools installed with the product are:

Import FactoryStudio Projects: Add the components of the selected project into the current project.

Import Rockwell ControlLogix: Creates the Tag Names, Tag Templates and does the mapping of the PLC addresses, all according to the information available at the L5K file.

Import OPC server configuration: Creates the Tag Names, Tag Templates and does the mapping of the OPC Client addresses, all according to the information available by browsing to the OPC server.

Import From OSIsoft PI System: When connecting with PI System Historian Servers, this wizard automatically creates the link with the tags, elements and attributes from PI AF servers. When connecting with PI AF, the system automatically imports the definition of all templates and asset elements in the selected database, as well as the mapping to communicate with the server. 

Importing XML tag templates: Creates tag names and tag templates according to the data structure of the XML file. This wizard also creates the Edit-Datasets-Files configuration to read that file.

Importing .NET classes from a DLL: Creates tag templates that matches the selected .NET classes.

Preferences

You can configure the FactoryStudio theme and other preferences.

To configure preferences:

1. Click on the Application button (the Blue Cube on the top of the Toolbar).
2. Change or select the options you want. After you're done, click close in the upper-right corner.