XFolders

<< Click to Display Table of Contents >>

 

XFolders

An XFolder is a server object that allows organizing or creating a hierarchy of objects in the instances created. The objects that can be inserted in an XFolder instance are the following:

Data Folders

I/O Tags

Queries

Alarm Filters

XFolder and XObject instances

Alarms

 

NOTE

Users are not allowed to insert objects in an XFolder definition, only in its instances.

 

To create an XFolder, right-click the Objects Library - XFolders item in Domain mode, select the Insert XFolder in option and then the name of the Library.

Properties tab of an XFolder

Properties tab of an XFolder

When inserting an XFolder, the View of this object is opened, where user can insert variables. These variables are Properties to be exported by this object, which can be linked to a Tag or to any other property of an application when this object is in use in an application.

The variables to export can be inserted by pressing the INSERT key or by clicking Add Add and excluded by pressing the DELETE key or by clicking Remove Remove. The available options on the Properties tab are described on the next table.

Available options for Properties tab

Option

Description

Name

Specifies the XFolder's variable name

Type

Determines the data type supported by a variable. Notice that other data objects (XFolders and XObjects) can be declared as data types. This way, users can create a data object that contains another data object as a Property. Data objects can work as a structure or as a class in this case, as in the C/C++ programming language. When specifying an object type, such as DemoTag, IOTag, or XObject, this Property displays the following behavior:

In case the ElipseX is inactive: This Property works as a String, which specifies the path of the object instance of the configured data type

In case the ElipseX is active: On writing, this Property works the same way as the previous case. However, on reading this Property returns the specified object, if it exists. If the path does not point to an existing object at the time, this Property returns Nothing

This option corresponds to the Type property of a Property Definition object

Public Public Property

Enables or disables the visibility of a variable outside the Library, that is, determines whether a variable is public or not. This option corresponds to the Public property of a Property Definition object

Persistable Persistable Property

Determines whether a variable is saved in the project or not. This option corresponds to the Persistable property of a Property Definition object

Retentive Retentive Property

Determines whether this Property is retentive or not. This option corresponds to the Retentive property of a Property Definition object

Initial value

Determines the initial value of a variable. This option corresponds to the DefaultValue property of a Property Definition object

Help text

A text to declare and document a variable. This option corresponds to the HelpString property of a Property Definition object

 

Users can insert XFolders in any Data Server, by right-clicking the Data Server in Domain mode, selecting the Insert option and then the name of the XFolder, as shown on the next figure. In Explorer mode, right-click the project's Data Server, select the Insert option, and then the name of the XFolder.

Inserting an XFolder in Domain mode

Inserting an XFolder in Domain mode

Was this page useful?