Configuration Procedure
The WDE Web Part Configuration panel is composed of a set of specific configuration parameters grouped by type. The types are:
Graphical Properties
The Graphical Properties manage the appearance of heading zone of web part, to support multi language and specific site configurations
Web Part Configuration - Graphical Properties
| Property Name | Description | |
|---|---|---|
| 1 | Case Label | The label before the list of AF cases. |
| 2 | Data Label | The initial label of the data selection summary. |
| 3 | User Label | The label for the logged in user. |
| 4 | Button Labels (use ; as a separator) | Labels for Save, Refresh and Lock buttons (visible only if "Lock/Unlock setting" is filled). A semicolon must be used as the separator between the label names. |
| 5 | Save Message Label | The content for pop-up windows that ask for confirmation before saving. |
| 6 | OK/Error Message | The content of the resulting message of the operation run through the 'Save' button.OK for writing successfullyError for writing with error(s) |
TimeRange Properties
The TimeRange Properties consist of 3 mandatory fields:
Web Part Configuration - TimeRange Properties
| Property Name | Description | |
|---|---|---|
| 1 | Case Search Range Start/End | These fields set the time range for the case search using the PI relative or absolute date/time syntax (e.g. *-10d). |
| 2 | Date Format | This is the Date/Time format used in the data reference to display the Start/End times of Cases. |
Sigmafine-AF Properties
The Sigmafine-AF Properties contains the information to connect and get data from the Sigmafine/AF server. Some of these values must be provided as parameters by a connected web part. Additionally, the Sigmafine-AF Properties must contain the name of the parameter whose value is the required setting; see the following table (Web Part Configuration - Sigmafine-AF Properties) of property configuration details for instructions.
A typical configuration for a Web Data Entry page is an OSIsoft RtTreeView WebPart that would “Provide Parameters To” the Pimsoft Tabular View Web Part. See Web Page Example for an example of this configuration.
IMPORTANT NOTE: the Sigmafine-AF Properties work in two ways:
If the prefix character $ is used, the rest of the setting value is taken as a constant.
If the prefix character $ is not used, the setting value is taken as the name of the Dynamic-Parameter coming from the connected Web Part. If connected to an OSISoft Web Part, the name of the parameter is defined by the parameter exported by the OSISoft Web Part itself.
Please refer to OSISoft PI-Web Part user’s manual documents for attributes exchanged via WP connections names and management.
Web Part Configuration - Sigmafine-AF Properties
| Property Name | Description | |
|---|---|---|
| 1 | Search String (*) | This property contains the rules used to select a certain set of AF Elements.The Search String must contain the name of a parameter provided by some web part, of which the value is a string in Sigmafine WSA Advanced rule syntax (see the Sigmafine WSA User Guide \topics for more information). |
| 2 | Attribute List | This property contains the list of AF attributes required to be shown. As with Search String, this property must contain the name of a parameter provided by some web part, of which the value is a string containing a list of “template.attribute”(s) separated by semicolon(s). For example:template1.attribute1;template1.attribute2;template2.attribute1;template2.attribute2 |
| 3 | Analysis setting (*) | This property contains the name of the AF analysis, again provided as parameter, in the format: \\server\database\model\analysis |
| 4 | Security setting | This property contains the information needed to verify the logged in user’s rights (read, write or all). The property must contain the name of a parameter which value is the full path of an AF Element, which security settings are used as a template to give permission to all elements shown in data table. |
| 5 | Area setting (*) | This property is used to complete a data selection summary in the web part heading zone, by inserting the description of selected area. The value is passed as a string parameter. |
| 6 | Group-By setting | This property is used if a graphical data grouping is required. The property must be filled with an “at” (@) sign followed by the name of attribute used to group the data. |
| 7 | Sort setting | This property is used for sorting the output. The possibilities are as follows:If Group-By is emptyIf the field 'Sort' is left empty, then a standard sort-by-name of the displayed Elements is applied.If the field 'Sort' contains a valid column name (within the list as specified in Attribute List), then displayed Elements will be sorted by the value of the column specified.If Group-By is not emptyIf the field 'Sort' is left empty, then a standard sort-by-name of Groups and then Elements is applied.If the field Sort contains a valid column name (within the list as specified in Attribute List), then Groups are displayed in alphabet order, and Elements are sorted by the value of the column specified.IMPORTANT NOTE: The sort field is not managed by the type of the column in AF. Instead, it is managed as an alphanumeric string. |
| 8 | Lock/Unlock setting | This property is used to lock data for editing. The property must contain the name of a parameter containing a value that is the full path of an AF Boolean attribute used to set locked status, and of which the element must be in the same model. |
Table Layout Properties
The Table Layout Properties are used to set the data table aspect. For example: column order, colors, size, etc.
Web Part Configuration - Table Layout Properties
| Property Name | Description |
|---|---|
| Column list | This property is used to set which columns will be shown in the data table and their layout. The value must be a string containing a list of sub-strings that define the column property, using the pipe “|” character as separator.Each column substring has the following syntax\<Attribute\>;\<Visible\>;\<Column Header\>;\<Alignment\>;\<Read/Write\>;\<Width\>;\<Data Type\>Where:\<Attribute\> = is the name of AF attribute to be shown\<Visible\> = set by default to “X”. Reserved for future use\<Column Header\> = is the header of column as shown in data table\<Alignment\> = set the alignment of values. Could be “Left”, “Center” or “Right”\<Read/Write\> = set this property to determine whether the table can be edited manually or not. The options are “R” or “RW”.\<Width\> = is the column width in pixels\<Data Type\> = is the kind of data. Options include “N” for number or “S” as String. |
| Table Width / Height (in 'px') | This property indicates the size of the data table in pixel. |
| Color Properties | Allows you to customize the table to fit your company's standard or brand colors:Column header, group-by rows, standard and alternate rows, and bad values can be personalized both in background and font colors.Every color property can be set as X11 color name (e.g. “White”, “Green”, “Yellow”…) or Hex triplet (preceded by #, e.g. “#00FF00”, “#FFFF00”…). |
| Show Table Grid | This property is a check box that is used to hide or show the grid on the data table. |
| Debug Flag | This property is a check box that allows you to activate the debugging flag.The Debug Flag should only be used in configuration mode, since it prints out a set of debugging messages on configuration and WDE connection data that is exchanged with other Web Parts. |