Use Pages and Templates

When you create a new project based on the Tab Style templates, the following templates are available for you to use as you create your graphics pages. These templates share Common Navigation Functionality, such as a customizable tabbed menu, a navigation toolbar and an alarm toolbar. This section describes the templates and their buttons, menus and tools.

The Tab Style template project has the following templates:

Normal

A template designed for creating user-necessary content and plant mimics. This page contains the custom tabbed menus, the standard navigation and alarm toolbars featured on tab style templates. If you are creating a project based on the tab style templates, use this template for your standard graphics pages.

The Normal template creates a page in display format to be shown with a title bar. Several sizes of templates are available including XGA (1024 x 768), SXGA (1280 x 1024), HD1080 (1920 x 1080) and WUXGA (1920 x 1200).

Note: Starting in version 7.20, you can customize the behavior of the standard window titlebar to lock down its functions to achieve the same result that used to be only possible by hiding it in the previous versions. This is achieved by overriding the titlebar events or setting the startup mode of the window.

Blank

The blank template is included for users who want to create their pages from scratch. There are no differences between the Tab Style blank template and the template in the include project.

Data Browse

The data browse template is included for users who want to create a page that displays a table of data retrieved from built-in data browse functions. The template includes the Equipment tree library control.

When using this template to create a new page within your project, configure the Data Browse pop up form. When configured the new page will display the appropriate data session at runtime.

Use the equipment tree to filter the data browse table at runtime. Items belonging to selected parent and child branches will be displayed with the exception of 'ServerBrowse' which is not associated with equipment.

Refer to Interactive Data Browse List for list display options available at runtime.

Alarm

Templates are included for the following types of alarm displays:

• Active Alarm Page (Alarm): Used to create a page displaying active alarms that are unacknowledged or acknowledged and still in alarm state.To create a default active alarm page for your project, create a new page based on this template. By default, the name of the page is expected to be "Alarm". However, you can change the name of the page by adjusting the setting for the INI parameter [Page]AlarmPage.

• Hardware Alarm Page (Hardware): Used to create a page displaying details of any system errors that are unacknowledged or acknowledged and still in alarm state, for example, if communications are lost, if Cicode can't execute, if a graphics page is not updating correctly, or if a server becomes inoperative, this page will alert you. To create a default hardware alarm page for your project, create a new page based on this template. By default, the name of the page is expected to be "Hardware". However, you can change the name of the page by adjusting the setting for the INI parameter [Page]HardwarePage.

• Disabled Alarm Page (Disabled): Used to create a page displaying alarms that are presently disabled in the system. The alarms will appear on this page when they have been disabled from the normal alarm system due to a maintenance shutdown, nuisance tripping etc. To create a default disabled alarm page for your project, create a new page based on this template. By default, the name of the page is expected to be "Disabled". However, you can change the name of the page by adjusting the setting for the INI parameter [Page]DisabledPage.

• Sequence of Events Page (SOE): Used to create a page displaying a snapshot of all state transitions of an alarm instance that have occurred. To create a default SOE page for your project, create a new page based on this template. By default, the name of the page is expected to be "SOE". However, you can change the name of the page by adjusting the setting for the INI parameter [Page]SOEPage. Unlike the active, hardware, disabled pages that are refreshed automatically at runtime to display real time data, the SOE and Summary pages display a snapshot of events that have occurred, therefore is not updated automatically. To retrieve the latest events you can manually refresh the page.

• Alarm Summary Page (Summary): Used to create a page displaying a historical log of alarms that have occurred. This page can be used for troubleshooting purposes. To create a default alarm summary page for your project, create a new page based on this template. By default, the name of the page is expected to be "Summary". However, you can change the name of the page by adjusting the setting for the INI parameter [Page]SummaryPage.

The alarm templates (except the hardware alarm template) display alarm lists using a "no draw" mode. The display of alarm fields is handled by a new set of template specific Cicode functions and genies to control each of the alarm fields' position and size. The alarm list is installed with a callback event function to redraw the alarm list upon data change. The "no draw" mode and data change callback event are supported by a modified form of the existing Cicode function AlarmDsp().

Process Analyst

The Process Analyst template is the default template for you to create trend pages. The Tab Style project includes templates for the three following types of trend display:

• SinglePA - A template that displays a single Process Analyst chart on the page. To create a default trend page for your project, please create a new page based on this template and name it "ProcessAnalyst". You can change the default page name by setting parameter [Page]ProcessAnalystPage.

• DoublePA - A template that displays two Process Analyst charts on the page.

• PopPA - A template that displays a single Process Analyst chart on the page. The size of the page is reduced to make it suitable for pop-up pages. To create a default trend pop-up page for your project, please create a new page based on this template and name it "!ProcessAnalystPopup". You can change the default page name by setting parameter [Page]ProcessAnalystPopupPage.

The functionality of traditional trends, double trends, and popup trends are largely incorporated into the Process Analyst on the new templates.

There is a key difference between the new PA templates and the existing trend templates, which is pen assignment. The trend templates can get pens assigned to the page at both design time and runtime, but every PA template needs the pens assigned at runtime only. This can be done by calling the Process Analyst Cicode Functions and pass the PAV file or individual trend pens to those functions.

There are two new items on the PA templates:

• The Show/Hide Trend Statistics button shows and hides trend statistics columns in the Process Analyst.

• The Std Deviation column works out the sample standard deviation value of the samples within the display area.

SPC

The Tab Style project includes the following trend templates for different types of statistical process control:

• SPCPareto: Displays a Pareto chart for multiple variable tags

• SPCCpk: Displays an SPC mean chart and a Capability chart

• SPCXRSChart: Displays SPC mean, range and standard deviation charts

• EventSPCXRS: Displays SPC mean, range and standard deviation charts for Event SPC trend tag

• MeanMeanChart: Displays SPC mean charts for two SPC trend tags

• RangeChart: Displays SPC mean and range charts for an SPC trend tag

• StandardChart: Displays SPC mean and standard deviation charts for an SPC trend tag

File

The tab style project includes the following templates for displaying different types of file:

• File: Displays a plain text file on the page. This template replicates the functionality of the original file template found in the standard Include project. The new template is compatible with any existing PageFile() or DspFile() Cicode functions. It can display up to 24 lines of text from a file at a time. Buttons are provided for the user to browse to different rows and columns of the file.

• File_RTF: Displays a rich text format (RTF) file on the page using the CiTextBox ActiveX control. It can also display plain text file.

• File_HTML: Displays a hypertext markup language (HTML) file or an universal resource locator (URL) link on the page. It needs Microsoft Edge to be installed on the machine.

Several common features are presented on the templates:

The new file templates replicate the functionality of the original file template in the Include project. The new templates are compatible with any existing PageFile() or DspFile() Cicode functions. They can display up to 24 lines of text from a file at a time. Buttons are provided for the user to browse to different rows and columns of the file.

Several new features are added to the templates:

• When you create a page based on any of these templates in Graphics Builder, you can predefine the file for display at runtime. Clicking anywhere on the page will show a genie style dialog to allow you to enter a file path to assign a file to the page. A Plant SCADA path substitution string can be used in the file path. When the page is recalled at runtime, for example via PageDisplay(), the specified file will be automatically displayed.

• The "Open File" button displays an Open File dialog to select a different file to display.

• The "Refresh" button reopens the already opened file to get the latest contents.

• The full path name of the currently opened file is displayed.

See Also

Create a New Project

Create Pages