ISS Enterprise Manager 2.6 User's Guide

ISS Enterprise Manager 2.
6
User's Guide
ISS ENTERPRISE MANAGER
User's Guide
First Edition (September 2013)
This edition applies to Version 2.6 of ISS Enterprise Manager and to all subsequent releases and modifications until otherwis e
indicated in new editions.
ISS Group Limited 2013. All rights reserved.

Ground Floor, 40 Hasler Road, Osborne Park, WA, 6017, Australia
PO Box 1313, Osborne Park BC, Osborne Park, WA, 6916, Australia
Phone +61 8 9241 0300 Fax +61 8 9242 8121
Use of this product and accompanying documentation is subject to the terms and conditions set out in the Product Licence
Agreement.
BabelFish is not a primary alarming, machine health, or asset protection system. This function must be performed by low level
SCADA / Control Systems or machine monitoring equipment. BabelFish is provided for advisory, informational, optimisation and
diagnosis purposes.
Due to continued product development this information may change without notice. The information and intellectual property
contained herein remains the exclusive property of ISS Group Limited. If you find any problems in the documentation, please
report them to us in writing. ISS Group Limited does not warrant that this document is error -free.
Through product maintenance, ISS Group Limited endeavours to keep its applications up to date with major platform version
changes as these platform changes are adopted by our customers. Examples include Internet Explorer 8, Oracle 11g R2,
Microsoft Server 2008 R2. Whilst we cannot test our products against every service pack and patch within a whole third party
version release, we publish minimum required major version number, and offer support in the event that a minor patch
released by a third party vendor causes an issue.
For licensing purposes only, ISS Group Limited may track usage of this product by capturing the following details: IP address,
date/time, action (such as login, logout, timeout). No personal data such as user ID or passwords are tracked or recorded in this
process.
The example companies, organisations, products, domain names, email addresses, logos, people, places, and events depicted
herein are fictitious. No association with any real company, organisation, product, domain name, email address, logo, person,
place, or event is intended or should be inferred.
BabelFish, the BabelFish logo, and the ISS logo are either registered trademarks or trademarks of ISS Group Limited (and/or i ts
affiliates) in Australia and/or other countries.
OSIsoft and the PI System either registered trademarks or trademarks of OSIsoft, Inc.
Uniformance is a registered trademark of Honeywell International, Inc.
Aspen InfoPlus.21 and IP21 are either registered trademarks or trademarks of Aspen Technology, Inc.
Exaquantum is a registered trademark of Yokogawa, Yokogawa Electric Corporation and/or its affiliates.
ActiveX, Active Directory, Authenticode, Bing, Excel, Internet Explorer, Microsoft, SharePoint, SQL Server, Visual Studio,
Windows, Windows Server, and Windows Vista are either registered trademarks or trademarks of Microsoft Corporation in the
United States and/or other countries.
Other product and company names mentioned herein may be the trademarks of their respective owners.
ISS Group Limited 2013 ISS Enterprise Manager 2.6 User's Guide
CONFIDENTIAL
Contents
Preface ..................................................................................................................... 1
Who Should Read this Guide ...................................................................................................... 1
Related Reading ........................................................................................................................ 1
Help and Support ....................................................................................................................... 2
ISS Enterprise Manager Overview ............................................................................... 4

Enterprise Manager Interface ..................................................................................... 5
Toolbar ..................................................................................................................................... 6
Object Tabs ............................................................................................................................... 6
Getting Started .......................................................................................................... 8

Logging On and Off .................................................................................................................... 8
Profiles ..................................................................................................................... 9
Create a Profile .......................................................................................................................... 9
Edit a Profile ............................................................................................................................ 11
Close a Profile.......................................................................................................................... 12
Search .................................................................................................................... 13
Search Filters ........................................................................................................................... 15
BabelFish Data Dictionary ........................................................................................ 16

BabelFish Data Dictionary Hierarchy ......................................................................................... 17
Entities .................................................................................................................................... 18
Entity Hierarchies ..................................................................................................................... 19
Entity Definitions ...................................................................................................................... 24
Delete an Entity ........................................................................................................................ 29
Creating Entities ....................................................................................................................... 31
Edit an Entity ............................................................................................................................ 48
Datasources ............................................................................................................................ 59
Create a Datasource ................................................................................................................. 61
Edit a Datasource...................................................................................................................... 89
Delete a Data Source ................................................................................................................ 94
Check for New Tags .................................................................................................................. 95
Templates ............................................................................................................................. 101
Template Tokens .....................................................................................................................102
Templates Hierarchy ................................................................................................................102
Create a Template ...................................................................................................................103
Edit a Template .......................................................................................................................109
Delete a Template ...................................................................................................................123
Renderers .............................................................................................................................. 124
Create a Renderer....................................................................................................................125
CONFIDENTIAL
ii
Create a Renderer Group .........................................................................................................131

Create a Renderer Type ...........................................................................................................133
Import and Export ................................................................................................................. 135
Exporting Data .........................................................................................................................135
Importing Data ........................................................................................................................140
How-to: Creating a Template Instance (Profile) ....................................................................... 141
How-to: Creating Templated Pages ......................................................................................... 143
How-to: Creating Prefixed Tags .............................................................................................. 144
How-to: Configuring State Sets ............................................................................................... 146
How-to: Mapping State Tags .................................................................................................. 150
Portal Configuration ............................................................................................... 156

Runtime Information ............................................................................................................. 157
Configuration Database ......................................................................................................... 157
Registration Information ........................................................................................................ 158
Sitewide Parameters .............................................................................................................. 158
Security ................................................................................................................................. 163
BabelFish Security Model .........................................................................................................163
Users .......................................................................................................................................164
User Groups ............................................................................................................................168
Object Groups .........................................................................................................................171
Grant Permissions ....................................................................................................................175
Configuration ........................................................................................................................ 177
Application Configuration ........................................................................................................177
Data Sources............................................................................................................................181
DSNs ........................................................................................................................................186
Styles .......................................................................................................................................188
Pages .......................................................................................................................................198
Trends .....................................................................................................................................200
Framework Menus ...................................................................................................................201
Export Pages ............................................................................................................................210
Import Pages ...........................................................................................................................211
Preset Pages ............................................................................................................................213
Comment Categories ...............................................................................................................214
Mobile Device Licenses ............................................................................................................215
Publishing ............................................................................................................................. 216
Publish Pages ...........................................................................................................................218
Publish Trends .........................................................................................................................219
Publish Tags .............................................................................................................................220
Menu Publishing ......................................................................................................................221
BabelFish Configuration .......................................................................................... 222

Task Scheduler ....................................................................................................... 224
Add a Scheduled Task ............................................................................................................ 224
Scheduled Task Properties ..................................................................................................... 225
Schedule a Task .......................................................................................................................226
Task Type ................................................................................................................................227
Task Status ..............................................................................................................................236
CONFIDENTIAL
iii
Prefix Tags ............................................................................................................................. 236

Rename a Scheduled Task ...................................................................................................... 236
Delete a Scheduled Task ........................................................................................................ 237
Appendix A. Transforms .......................................................................................... 238

Raw Data Sample Interval (Density)........................................................................................ 238
Average ................................................................................................................................. 239
Last Known Value .................................................................................................................. 240
Linear Interpolate .................................................................................................................. 241
Raw Data Look-Ahead ..............................................................................................................242
Legacy Transforms ................................................................................................................. 242
Appendix B. Standalone Installation ......................................................................... 243

Glossary ................................................................................................................. 245
Index ..................................................................................................................... 249
CONFIDENTIAL
iv
Preface
ISS Enterprise Manager allows BabelFish administrators to exercise control over access to
the BabelFish Data Dictionary and BabelFish Explorer, as well as to schedule routine
BabelFish administration tasks.
Who Should Read this Guide

This guide is intended for BabelFish administrators who need to configure entities, access,
and performance settings for BabelFish Explorer and the BabelFish Data Dictionary.
This guide assumes working knowledge of:
ISS BabelFish
Microsoft Windows operating system
Microsoft Internet Explorer
Related Reading
Documents in the BabelFish technical documentation suite are as follows.
F O R B A BE L F I SH E X P L O R E R U SE R S
Title
Description
BabelFish Explorer User's

Guide
How to construct BabelFish pages that display information from

selected control systems in a meaningful way.
Calculation Engine
Reference
Comprehensive reference on the functions available from the

BabelFish Calculation Engine.
BabelFish Explorer
Trending Tool Reference
Comprehensive reference on the BabelFish Trending Tool, and how to

use it.
BabelFish Shapes
Reference
Comprehensive reference on all BabelFish shapes.
F O R B A BE L F I SH A D M IN I ST R A T O R S
BabelFish 2.6 Release
Notes
Release Notes for BabelFish version 2.6.
BabelFish Server
Installation Guide
Installing BabelFish components and configuring BabelFish for first

time use.
BabelFish SDK Installation How to install the BabelFish SDK.

Guide
ISS Enterprise Manager
User's Guide
How to use the Enterprise Manager tool to manage BabelFish.
BabelFish Administrator's
Guide
How to further configure and optimise your BabelFish installation.
CONFIDENTIAL
PREFACE
HELP AND SUPPORT
You may also find the following documents useful:

Title
Description
ISS Logger User's Guide
How to install ISS Logger, and how to use the Log Viewer to view log
files generated from ISS Enterprise Manager.
ISS Licence Manager

User's Guide
How to apply for and acquire a licence key for ISS products.
These documents are available from the ISS Support Group.
Help and Support

The ISS Support Group provides a central point of contact for software assistance and the
resolution of software issues. As part of this, ISS Group offers a variety of professional
services, online resources, and access to experienced product specialists who are able to
assist with your service requests. For support and information regarding our products, the
following resources are provided:
F RE E D OC U M E NT A T IO N R E S OU RC E S
PDF documentation supplied in the installation directory.

Online help provided with the product (if supplied).
O NL INE S U P P O RT P O RT A L
The ISS Support Portal provides access to online support, where you can raise service
requests for ISS software.
B A BE L F I SH U SE R G R OU P
ISS Group periodically hosts the BabelFish User Group event. This is a great opportunity for
you to network and find out how other people in the industry are using our products.
T RA IN IN G
ISS Group offers a variety of standard and customised training courses (ranging from
introductory courses through to administrator courses) to help you learn how to use ISS
products.
P E R F O RM A NC E T U NI N G
ISS Group offers a series of system checks to make sure your ISS systems are running as
efficiently as possible.
Y OU R F E E D B A C K
To help improve what we offer you, ISS Group would like your feedback about this guide.
Please send your comments by email to the ISS Support Group, specifying the name of the
guide, as well as section headings or page numbers for our reference.
CONFIDENTIAL
PREFACE
HELP AND SUPPORT
C O NTA C T D E T A I L S
You can contact the ISS Support Group via phone or email for technical support on any
aspect of ISS Group's products. Please also contact ISS Support Group for further
information on the BabelFish User Group event, access to the online support por tal,
Performance Tuning services, and information on available training courses. Feedback on
our products or user guides can also be sent to ISS Support Group.
Phone:
Email:
1300 739 969 (Australia only)

+61 8 9241 0300 (outside Australia)
support@issgroup.com.au
CONFIDENTIAL
ISS Enterprise Manager Overview

ISS Enterprise Manager (also known as the Administration Tool) is an administration tool
provided to manage the BabelFish Data Dictionary, BabelFish Explorer, Schedul ed Tasks,
and other modules that require the BabelFish Data Dictionary. External modules are
provided with a separately installed plug-in to Enterprise Manager, and are documented
separately.
The modules installed with BabelFish are:
BabelFish module, consisting of the following nodes:
BabelFish Data Dictionary (see page 16)

BabelFish Explorer (see page 156)
BabelFish Configuration (see page 222)
Task Scheduler module (see page 224).
Important: ISS Enterprise Manager uses transaction locking to facilitate rollbacks.

Therefore, whenever you make a change in Enterprise Manager, the Data Dictionary
database is locked until the change is saved. This means that other applications, such
as the Portal, cannot access the database. It is advisable to save changes frequently
to avoid instability.
CONFIDENTIAL
Enterprise Manager Interface

In This Chapter
Toolbar
Object Tabs
6
6
The ISS Enterprise Manager interface has the following features:
Menu bar. Provides access to standard editing functions (File, Edit, View, Help).
There is an additional menu item for every module managed by this Profile, such as
Data Dictionary and Scheduled Tasks.
Toolbar (see page 6). Shortcuts to commonly used functions for this Profile.
Navigation Hierarchy. The tree structure used to navigate between configuration
nodes in ISS Enterprise Manager. Also known as the hierarchy tree. At the bottom of
this tree structure are two tabs: Navigation (the default) and Search. Clicking on t he
Search tab opens the Enterprise Manager Search window (see page 13).
List view. Lists the items contained in the selected node in the navigation hierarchy.
Properties. Displays the properties for the selected item in the List view. Not used
for the Portal Configuration nodes. Configuration nodes and new applications, such
as Help, can be displayed in a new object tab (see page 6) at the bottom of this
section.
CONFIDENTIAL
ENTERPRISE MANAGER INTERFACE
TOOLBAR
Toolbar
The Enterprise Manager toolbar contains the following functions.
Button
Function
Description
New Profile
Open a new Enterprise Manager profile (see page 9).
Save
Save any changes made to the BabelFish Data Dictionary. It is only

enabled when changes have been made. Note: It is recommended you
click the Save button every time you make a change. Leaving Enterprise
Manager in an unsaved state may cause stability issues in BabelFish.
Search
Search (see page 13) for an item in Enterprise Manager.
New Entity
Hierarchy
Create a new Entity Hierarchy using the New Entity Hierarchy Wizard
(see page 20).
New Entity
Create a new Entity using the Entity Wizard (see page 18).
Object Tabs
Object tabs, located at the bottom of the properties panel, display information on selected
objects (nodes) in the Navigation Hierarchy. By default, when you click on a no de in the
Navigation Hierarchy, the contents are display in the currently selected object tab.
However, when you open the online help for Enterprise Manager, it opens in a new object
tab. You can therefore leave the help open while you use the program.
Similarly, you can open any object in the Navigation Hierarchy in a new tab:
1.
Right-click on the appropriate tree node.
2.
Select Display.
3.
Click New Tab.
CONFIDENTIAL
ENTERPRISE MANAGER INTERFACE
OBJECT TABS
N A V I GA TI NG T H R OU G H T A B S
Navigation controls are located to the right of the tabs, allowing you to scroll le ft and right
through the tabs, and to close a selected tab.
To scroll through the tabs, click the left and right arrows.
To close the selected tab, click the Close icon, indicated by a cross.
CONFIDENTIAL
Getting Started
In This Chapter
Logging On and Off
There are two ways you can access ISS Enterprise Manager:
Install Enterprise Manager on a computer on the same network as the BabelFish

server. Refer to the BabelFish Server Installation Guide.
Use Windows Remote Desktop to connect to a machine on which Enterprise

Manager is installed.
Check with your System Administrator to determine which option you will use.
Logging On and Off

To launch Enterprise Manager and log in:
1.
Double-click the ISS Enterprise Manager icon

on the desktop, or click Start > All
Programs > ISS > BabelFish > ISS Enterprise Manager.
2.
In the Select your profile window, double-click on the Profile (see page 9) you want
to open. The Profile for managing the BabelFish Data Dictionary is typically called
BabelFish Data Dictionary.
On successful login, ISS Enterprise Manager opens and the root node for the profile is
highlighted.
If the login is unsuccessful, a series of messages appears before ISS Enterprise Manager
opens with no nodes displayed. If this happens, you should close the profile and either:
Select a different profile to open.
If you are an administrator, amend the existing profile or create a new one.
If you are unsure, you should call your System Administrator.
CONFIDENTIAL
Profiles
In This Chapter
Create a Profile
Edit a Profile
Close a Profile
9
11
12
Profiles allow you to manage existing Data Dictionary schemas, the BabelFish Explorer, and
scheduled tasks.
A profile holds the configuration information for BabelFish or a plug-in product that
requires the BabelFish Data Dictionary (note some plug-ins that do not require BabelFish
can also be configured).
You can configure a single profile to manage all of these modules, or you can create
multiple profiles to manage individual modules.
When you open ISS Enterprise Manager, the Select your profile window presents a list of
profiles you can open. From here, you can also create and edit profiles (see page 11).
Note: You can only have one profile open at a time. To open a new profile, first close the
one currently open, then select New from the File menu (File > New).
Create a Profile
To create a new profile:
1.
Open the Select your profile window by starting ISS Enterprise Manager.
Alternatively, if ISS Enterprise Manager is already open, close the current profile ( File
> Close) and then click the New
button on the Enterprise Manager toolbar.
CONFIDENTIAL
PROFILES
CREATE A PROFILE
Note: You can only open a new profile if no other profiles are open. To close a
profile in order to open a new one, select Close from the File menu (File > Close).
Then you can open a new profile (File > Open).
2.
Click the New Profile button.

The Edit Profile window opens.
3.
In the Name box, type a name for the profile. This is the name that will appear in the
Select your profile list.
4.
In the Description box, type a profile description.
5.
In the File name box, type a profile file name.
6.
In the Plug-ins list on the left, select the required Plug-in check boxes. These are the
plug-ins that will be managed by this new profile.
Note: When you create a Profile, the password fields are masked. After a Profile has
been saved, the resulting XML file will have the passwords encrypted. This only
applies to the Data Dictionary plug-in.
7.
Enter the configuration details required to connect to the selected plug-in. Details
will vary for each plug-in and are fully described in their installation manuals.
CONFIDENTIAL
10
PROFILES
8.
EDIT A PROFILE
Click OK.
Edit a Profile
To edit an existing profile:
1.
Open the Select your profile window by starting ISS Enterprise Manager.
Alternatively, if ISS Enterprise Manager is already open, close the current profile ( File
> Close) and then click the New
Note: You can only open a new profile if no other profiles are open. To close a
profile in order to open a new one, select Close from the File menu (File > Close).
Then you can open a new profile (File > Open).
2.
Click on the profile you want to modify.
3.
Click the Edit Profile button.
4.
Click on the plug-ins you need to update.
5.
Update the profile with the configuration details for the plug-in, as described in the
plug-in's installation manual.
Note: When you edit a Profile, the password fields are masked. After a Profile has
been saved, the resulting XML file will have the passwords encrypted. This only
applies to the Data Dictionary plug-in.
6.
Click OK.
CONFIDENTIAL
11
PROFILES
CLOSE A PROFILE
Close a Profile
You need to close an open profile before you can open another or create a new one. To
close a profile:
From the File menu, click Close (File > Close).
CONFIDENTIAL
12
Search
In This Chapter
Search Filters
15
The Data Dictionary Search function allows you to easily find entities, templates,
Datasources, properties, attributes, and profiles located in the BabelFish Data Dictionary.
To access the Search function:
1.
Click the Search
tab at the bottom of the Navigation Hierarchy.
2.
In the Look for field, type the search criteria.
3.
In the Filtered by drop-down list, select the type of thing you are searching for:
Entity, Template, Data Source, Component, Attribute Name, Property, or Profile. For
more details, refer to Search Filters (see page 15).
4.
If you need a more refined search, click the Show Advanced Options link.
This allows you to constrain or expand your search to:
5.
A specified time period. Note: The Modified Between option is not currently
supported.
Only the name of the item. By default, searches are conducted using the Name
field of BabelFish Data Dictionary objects. You can change this to include the
Description field, by clearing the Search on Name only check box.
Click Search.
CONFIDENTIAL
13
SEARCH
CLOSE A PROFILE
The search results appear in a list below the search options.
6.
Double-click on a result to view the details in a new object tab.
If you want to delete any entities from the Data Dictionary, select the ones you want to
delete, and then click the Delete button.
If an entity in the results list is not visible in the navigation tree, you can move it into one
of the Entity Hierarchies by clicking on the entity, and dragging it first onto the Navigation
tab, and then onto the desired Entity Hierarchy.
CONFIDENTIAL
14
SEARCH
SEARCH FILTERS
Search Filters
The Filtered by list in the Data Dictionary Search (see page 13) allows you to target
searches to BabelFish Data Dictionary object types. The search is not case-sensitive and
performs partial matches by default. For example, if there are three entities in the
BabelFish Data Dictionary with names of:
Calc.Random.Small
Random.Normal.Calc
Large.Calc.Random
Then a default search on random returns all three entities.

The filters available are:
Filter
Description
(Default Filters)
Locates all Entities and Templates in the BabelFish Data Dictionary matching
the search criteria.
Entity
Locates all Entities in the BabelFish Data Dictionary matching the search
criteria.
Template
Locates all Templates in the BabelFish Data Dictionary matching the searc h
criteria.
Data Source
Locates all Datasources in the BabelFish Data Dictionary matching the search
criteria.
Component
Locates all Components (Adaptors, Parsers, Builders and Accumulators) in the

BabelFish Data Dictionary matching the search criteria.
Attribute Name
Locates all Attribute Names in the BabelFish Data Dictionary matching the
search criteria.
Property
Locates all Properties in the BabelFish Data Dictionary matching the search
criteria.
Profile
Locates all Template Instances in the BabelFish Data Dictionary matching the
search criteria.
CONFIDENTIAL
15
BabelFish Data Dictionary

In This Chapter
BabelFish Data Dictionary Hierarchy
Entities
Datasources
Templates
Renderers
Import and Export
How-to: Creating a Template Instance (Profile)
How-to: Creating Templated Pages
How-to: Creating Prefixed Tags
How-to: Configuring State Sets
How-to: Mapping State Tags
17
18
59
101
124
135
141
143
144
146
150
BabelFish is an integration framework for real time and relational process data. The
integrated data is made available across the enterprise, enabling informed engineering and
business decision-making.
The BabelFish Data Dictionary is a data store containing information about data items
stored within BabelFish data sources. Its role is to store information about the data items
and the ways in which they can be retrieved. It does not store any data itself.
ISS Enterprise Manager enables administrators to maintain, update, and modify the
BabelFish Data Dictionary. It provides the capability to:
Create, edit, and delete Entity Hierarchies (see page 19), Datasources (see page 59),
and Templates (see page 101).
Import tags (see page 135) from data sources into the BabelFish Data Dictionary, and
check for new tags (see page 95) in data sources.
Search (see page 13) the BabelFish Data Dictionary for entities, data sources,
templates, properties, and attributes.
View Datasource tags (see page 94) in the BabelFish Data Dictionary.
Add, edit, and delete Entities.
CONFIDENTIAL
16
BABELFISH DATA DICTIONARY
BABELFISH DATA DICTIONARY HIERARCHY
Maintain templates for structuring entities of a similar type in a standard manner.
H OW
D OE S TH E
D A TA D I C TI O NA RY
F IT IN T O
B A B E L F IS H ?
The Data Dictionary describes the relationships between entities, and groups information
into a logical hierarchical structure so that you see a complete picture of an asset. It also
stores information about data sources and the method or configuration used to fetch data
from those data sources. BabelFish does not store any data, it only accesses data from the
source system when an application requests it.
The BabelFish Data Dictionary is the core configuration storage of the BabelFish
infrastructure. From an application viewpoint, when requests for data are made, the
BabelFish infrastructure locates that data, and the way by which it can be retrieved, from
the BabelFish Data Dictionary.
You can build a reference model for an entire site with a hierarchical view of all
equipment, processes, and measures connected into the Data Dictionary. This can be built
up over time to leverage the information from all faculties of engineering within the
operation.
BabelFish Data Dictionary Hierarchy

The BabelFish Data Dictionary Navigation Hierarchy is organised into three main groups.
Entity Hierarchies
Contains the Entities (see page 18) configured in the BabelFish Data Dictionary,
organised into hierarchies (see page 19).
Data Sources
Displays the Datasources (see page 59) configured in the BabelFish Data Dictionary,
organised by data source type (see page 59).
CONFIDENTIAL
17
ENTITIES
Templates
Displays the Templates (see page 101) configured in the BabelFish Data Dictionary,
organised by template group (see page 102).
Entities
An entity represents any business element within BabelFish. They include things such as a
piece of equipment, a process tag, a report, and so on.
The following types of entities can be configured in the BabelFish Data Dictionary:
BabelFish Sourced Entity
Applies to all entities that fetch data, and represents a piece of data obtained from a
data source. This is the standard entity used to model business objects such a s tags
and SQL statements. These are normally initially created during installation (see
page 33).
Calculation Entity
Used to model any sort of calculation. The actual formula in the Calculation Entity
may reference other entities (that must return values). A Calculation Entity may
require fetching from multiple different data sources, or calculation of other
Calculation Entities to return values. A Calculation Entity is really a type of BabelFish
Sourced Entity, as it fetches data from a data source, however the process used to
create them (see page 36) is significantly different to the process for creating a
BabelFish Sourced Entity.
Summary Entity
A placeholder entity that can be used to provide a logical grouping for other entities,
or as a heading node within a hierarchy. Summary entities cannot fetch data and
must be created explicitly via the Entity Creation wizard (see page 41). Summary
entities also allow the user to model a real-world "thing". For example, Well1 may
be a Summary entity that defines Well1 by implementing the Well template.
External Referenced Entity
An External Referenced Entity (see page 44) can be considered a type of Summary
Entity in that it cannot fetch data. Instead, it sources its children from an external
system and is therefore used when the hierarchy (and entities in the hierarchy) are
controlled and displayed by a source outside BabelFish. An External Referenced
Entity can have one or more Templates (see page 101) associated with it. The
CONFIDENTIAL
18
ENTITIES
primary template tells BabelFish how to handle inputs on this part of the hierarchy.
All the entities in the hierarchy defined by the External Referenced Entity, inherit the
templates associated with the External Referenced Entity.
Shortcut Entity
A Shortcut Entity (see page 39) is an entity that is essentially a reference to an entity
in a different hierarchy, or which exists in a different location in the same hierarchy.
It can be considered a type of Summary Entity in that it cannot fetch data, and
instead sources its children from another part of the entity hierarchy.
Entity Hierarchies
The Entity Hierarchy in Enterprise Manager displays the entities configured in the
BabelFish Data Dictionary, organised into user-defined logical hierarchies with parent-child
relationships.
The Entity Hierarchy is designed to make data easy to locate. Entities can be located in
different places within the same hierarchy as well as in multiple hierarchies. This
organisation of the hierarchies provides an easy way to navigate through tens of
thousands of data items.
For example, a system containing well data may be organised into their corresponding
satellites, fields, and sites.
Note: When creating an entity hierarchy, take care not to create recursive hierarchies, as
this may cause data export to fail.
CONFIDENTIAL
19
ENTITIES
Hierarchy Display Order

The order in which the Entity Hierarchies appear is determined by their display order. You
can move nodes in the hierarchy to affect the order in which they are displayed. To do this:
1.
Click on the Entity Hierarchies node in the Data Dictionary tree.

A list of the hierarchies in their current order is displayed on the right.
2.
In this list, click on the hierarchy you want to move.
3.
Click the Move Up button to move the node up in the hierarchy, or click Move Down
to display it lower in the hierarchy.
4.
Click the Save
5.
From the View menu, select Refresh (View > Refresh) to make the changes visible in
the Entity Hierarchies list.
button in the Enterprise Manager toolbar.
Create an Entity Hierarchy

To add a new Entity Hierarchy:
1.
Click the New Entity Hierarchy
Alternatively, you can:
Select Add Entity Hierarchy from the Data Dictionary menu (Data Dictionary>
Add > Entity Hierarchy).
Right-click on Entity Hierarchies and select Add > New Hierarchy.
CONFIDENTIAL
20
ENTITIES
The New Hierarchy window opens.
2.
Enter the following fields:

Name: Unique name for the hierarchy. The hierarchy name entered must be unique.
If a non-unique name is entered, a warning appears and you need to choose an
alternative name for the hierarchy.
Description: Description of what the hierarchy is to be used for.
3.
(Optional) Click the Advanced button and enter the following fields:
Ordinal: Allocate a number to define the position of the Entity Hierarchy. An ordinal
of 1 means the Entity Hierarchy is always displayed at the top of the list.
Display Limit: The maximum number of entities (including attributes and properties)
to display under a node of the hierarchy. If a node has more entities beneath it than
the Display Limit, a button appears, providing the option to show more entities. This
prevents particular nodes of the tree taking a long time to load if it contains a large
number of entities. Entering -1 displays all entities. The Plant Model Tree in
BabelFish Explorer also uses this limit, however attributes and properties are not
included in the display limit.
4.
Click OK.
CONFIDENTIAL
21
ENTITIES
When the hierarchy is created, its properties are displayed in the Properties tab in
the lower window on the right.
Delete an Entity Hierarchy

To delete an Entity Hierarchy, but not the entities:
1.
Right-click on the Entity Hierarchy.
2.
Select Delete.
CONFIDENTIAL
22
3.
ENTITIES
At the confirmation message, click Delete. Make sure the Delete Entities check box is
NOT selected.
The entity hierarchy is removed from the BabelFish Data Dictionary.

Note: This deletes the hierarchy, but does not delete the entities that are contained within
the hierarchy. Because the entities remain in the database, you can perform a search
(see page 13) for them and add them to other hierarchies.
To delete all the entities in the hierarchy, as well as the Entity Hierarchy, select the Delete
Entities check box before clicking Delete.
Move an Entity
You can move an entity in a hierarchy and between hierarchies by using drag and drop:
To move an entity in the entity hierarchy tree view, click on the entity in the
hierarchy and drag it onto its new parent.
The entity is removed from the old parent and added to the new parent entity.
Put an Entity into Another Hierarchy

You can put an entity into more than one hierarchy. This will be exactly the same entity,
but it will reside in two different hierarchies. Any changes made to the entity when it is
accessed via one hierarchy will also affect the entity in the other hierarchy, because they
are in fact the same entity.
To put an entity into another Entity Hierarchy, while also keeping it in the same position in
its current Entity Hierarchy:
1.
Press the CTRL key.
2.
Click on the entity in the Entity Hierarchy.
CONFIDENTIAL
23
ENTITIES
3.
Drag the entity onto its new parent.
4.
At the Create Shortcut Entity message, click No. Clicking Yes will create a Shortcut
Entity (see page 39).
5.
At the Copy Entity Children message, click Yes if you also want to place the entity's
child nodes under the entity, in the hierarchy it which it has just been placed.
The entity is added to the new parent entity.
Entity Definitions
Entity Definitions allow you to pre-define entities that can be created in the Data
Dictionary. These definitions include the templates (see page 101) that are to be
associated with the entity when it is created, and its default icon and namespace.
This means that you never need to remember exactly what templates need to be added to
an entity, such as when you are creating a new pump. Creation of entities based upon
Entity Definitions alleviates the need to select templates and set property and attribute
values.
The Entity Definitions can be updated at any time if the icon, namespace, or templates
need to be changed. Because Entity Definitions are just another entity in the Data
Dictionary, it can be edited just like other entities. Note, however, that changes to the
definition do not affect entities which have been previously created. It will only affect new
entities created from this definition.
D E FA U L T P R O P E RT IE S
A ND
A T T RI BU TE S
Entity creation is simplified further by providing the ability to set default template
property and attribute values. Source systems typically follow a naming convention fo r tag
names and this can be used to automate the setting of the template attributes. The tag
CONFIDENTIAL
24
ENTITIES
names, however, commonly include things such as control system loop and area numbers,
which are typically different for each entity. The ability to use tokens in t he default values
allows entity-specific information to be deferred until the time of creation, when a prompt
appears asking for the template token values.
T E MP LA TE T O KE N S
Template tokens are Data Dictionary properties defined on a per template basis. They are
inputs required to set default values for template attributes and properties, and are stored
in the Data Dictionary database as template properties. Template tokens are distinguished
from other properties by having a TEMPLATE TOKEN property type.
Tokens can then be used in the default values of template properties and attributes.
Enterprise Manager, on creation of a new entity from an Entity Definition, determines the
tokens required and displays them to the user for entry. The profile properties and
attribute values are then set by replacing the tokens with the values entered by the user.
The template tokens included in the default values must be entered as follows:
TEMPLATE_TOKEN(token name). Any property defined as a template token appears in the
token list when you add or edit the template property.
E NT IT Y A T T RI BU TE S YN C H R O NI SA TI ON
While Entity Definitions go a long way to simplifying the creation of new entities, it does
not address the problem where the entity is created before all associated attri bute tags
are available. When this occurs, some (or possibly all) of the template attributes would not
be set to tags, and these would have to be manually set when the tags became available.
Given the possibility for a large number of entities in any system, manually administrating
this would be difficult. An automated means of setting attribute tags is therefore required.
The Task Scheduler allows you to schedule a type of task called the Custom Entity Attribute
Synchroniser (see page 228), which is an automated means of setting attribute tags. This
can be scheduled to run nightly to iteratively fill in missing attributes when the tags
become available based upon the default attribute values.
Additionally, configuration options allow the synchronisation to be controlled so that only
particular entities or templates are synchronised. You can configure a search pattern
(including wildcard characters) for the entity name or template name with the scheduled
task. Only entities and templates matching these patterns are processed. For example, if
both an entity mask and a template mask are specified, then only the entities that match
the name mask and have a template that matches the template mask will be synchronised.
You can also write the results (of the attributes that were successfully set) to an XML file.
Creating an Entity Definition

To create an Entity Definition:
1.
In the navigation hierarchy on the left, right-click an Entity Hierarchy

entity
and select Add > Entity Definition.
CONFIDENTIAL
or an
25
ENTITIES
Note: You can create an Entity Definition for any node in the Entity Hierarchies
category.
The Create new Custom Definition window opens.
2.
Enter the following parameters:

Name: The name of the Entity Definition.
Description: A description of the purpose of the Entity Definition.
Icon: The icon that represents the Entity Definition. Choose from:
Default, ePlant Tag
Facility
Entity, Category, Entity Hierarchy, Entity Category
Drilling, Well, Sub-sea related
Namespace
Electrical, Instruments
Profile
Export, Reinjection, Pipeline
Property
Processes
Template (Note: It may be useful to create a new
CONFIDENTIAL
Process
26
group for Template Page Renderers.)
ENTITIES
Drawing
Datasource Entity, Datasource
Unit
Datasource type
Compressor
Message
Meter Point
Component
Tags, ePlant Tag
Adaptor
Export + Reinjection Gas
Builder
Web Report
Parser
Well
Accumulator
Satellite
Company
ePlant Trend
Project
ePlant Page
Namespace: The namespace to which the Entity Definition belongs. All valid
namespaces are listed in the drop-down list.
Templates: Click the Template
icon to choose a template to associate with the
Entity Definition. You can associate more than one template, however if you do this
you will need to specify which template is the primary template. The primary
template determines how the Entity Definitions are grouped. If you do not specify a
template, then the Entity Definitions are grouped as Other. Note: If the template you
want to use does not exist, you can create one here.
3.
Click OK.
The Entity Definition is listed as a child node to the entity and appears in the
right-click menu below Entity Definition.
CONFIDENTIAL
27
ENTITIES
Creating Entities from Entity Definitions

To create an entity from an Entity Definition:
1.
Right-click on an entity in the navigation hierarchy, and select Add.

Entity Definitions are grouped by the template group of the primary template of the
Entity Definition. If an Entity Definition does not have a primary template, t hen it
will be grouped as "Other".
2.
Select the Entity Definition on which you want to base the new entity.
3.
In the Create Entity dialog box, enter the following parameters:

Name: The name for the new entity.
Description: A description of what the entity does.
CONFIDENTIAL
28
ENTITIES
Icon: Select the icon for the entity. Standard icons include:
Default, ePlant Tag
Entity, Category, Entity
Hierarchy, Entity Category
Facility
Namespace
Profile
Processes
Property
Template (Note: It may be useful
to create a new group for Template
Page Renderers.)
Datasource type
Message
Component
Adaptor
Builder
Parser
Accumulator
Company
Process
Drawing
Unit
Compressor
Meter Point
Tags, ePlant Tag
Web Report
Well
Satellite
ePlant Trend
ePlant Page
Project
Properties: If the templates associated with the Entity Definition contain property
tokens, they are listed here and you will need to specify the values for any tokens. If
left blank, then any property that references this token will have an empty value.
Note: Changes to the definition do not affect entities which have been previously
created. Changes will only affect new entities created from this definition.
4.
Click OK to create the entity.
Delete an Entity
When you delete an entity, you are offered the choice of deleting it from the Data
Dictionary or from only the Entity Hierarchy. Entities that have been deleted only from the
Entity Hierarchy remain in the Data Dictionary and can be retrieved using the Data
Dictionary Search function (see page 13).
FROM
1.
THE
E N TI TY H IE R A RC H Y
In the Entity Hierarchy, right-click on the entity you want to delete.
CONFIDENTIAL
29
2.
Select Delete.
3.
At the confirmation message, click Delete.
ENTITIES
To remove the entity from only the Entity Hierarchy but not from the
BabelFish Data Dictionary, click Hierarchy Only.
To remove the entity from both the Entity Hierarchy and the BabelFish Data
Dictionary, click Delete.
FROM
THE
D A TA D I C TI O NA RY
To delete an entity that is in the Data Dictionary but not in an Entity Hierarchy:
1.
Search for the entity in the Data Dictionary.
2.
From the search results, drag the entity onto an Entity Hierarchy.
3.
Right-click on the entity and select Delete, selecting the option to remove the entity
from the Data Dictionary.
FROM
THE
B A BE L F I SH E X P L O RE R
You can only delete a Calculation Tag from the BabelFish Explorer. Deleting the tag in
BabelFish Explorer also deletes the corresponding entity in the Data Dictionary and Entity
Hierarchy. Deleting other types of tags from BabelFish Explorer does not delete it from the
Data Dictionary.
To delete a tag from BabelFish Explorer:
1.
Open the Tag Editor by double-clicking it in Design mode or by opening the Point
Detail.
2.
Click the Delete Tag button.
CONFIDENTIAL
30
ENTITIES
Creating Entities
To create an entity:
1.
Right-click on a node in the entity hierarchy to which you want to add the entity, and
select Add > New Entity... .
Note: When creating an entity, take care not to create recursive hierarchies, as this
may cause data export to fail.
Alternatively, you can select Add Entity from the Data Dictionary menu (Add >
Entity).
Note: When you add an entity via the Data Dictionary menu, it will be added to the
corresponding Datasource in the Data Sources branch of the navigation tree. Note,
however, that Summary Entities and External Referenced Entities will be added to
the Data Dictionary, but will not appear in the navigation tree if they are created via
this method.
CONFIDENTIAL
31
ENTITIES
The Entity Creation Wizard appears.
2.
Click Next.
3.
In the Select Entity Type window, click on the type of entity you want to create.
Depending on the type of entity selected, you will be required to enter diffe rent fields.
These are described respectively in:
CONFIDENTIAL
32
ENTITIES
BabelFish Sourced Entity (see page 33)

Summary Entity (see page 41)
Calculation Entity (see page 36)

You can create a BabelFish Sourced Entity (also known as a BabelFish Entity or Sourced
Entity) in ISS Enterprise Manager using the Entity Creation Wizard.
To create a BabelFish Sourced Entity:
1.
Right-click on the entity or Entity Hierarchy that will be the parent of the new entity.
2.
From the menu, click Add > New Entity...
3.
In the Entity Creation Wizard, click Next.
4.
In the Select Entity Type screen, click BabelFish Entity
5.
Click Next.
6.
In the Select Data Source window, select the Datasource from which the entity will
access its data.
CONFIDENTIAL
33
ENTITIES
7.
Click Next.
8.
The Select Entity Template window allows you to associate the entity with a
template. If you do not need to do this, click Next.
If you want to associate the entity with a template, select the Associate Template
with Entity check box, and choose the template from the Properties tab, before
clicking Next.
For a description of what templates, properties, and attributes are, and when you
would want to associate a template with an entity, refer to Templates (see page
101).
CONFIDENTIAL
34
9.
ENTITIES
The Select Request Template window allows you to associate the entity with a
Request template. If you do not need to do this, click Next.
If you want to associate the entity with a Request Template, select the Associate
Request Template with Entity check box, and choose the Request Template from
the Properties tab, before clicking Next.
For a description of what templates, properties, and attributes are, and when you
would want to associate a Request Template with an entity, refer to Templates (see
page 101).
10.
In the Entity Detail window, type the name for the entity in the Name field.
Optionally enter the remaining parameters:
Description
A longer description of the purpose of the entity.
Namespace
The namespace to which the entity belongs. All valid namespaces are listed in the
drop-down list.
Location
The location of the entity, in general terms.
Data Type
The type of data that the entity is to collect. For example, the data may be time
series, relational, or object. All valid data types are listed in the drop-down list.
Native Name
Use the native name field when creating an alias for a data item. For example, if you
wanted to create an entity for a pump pressure tag in a Capture historian data
source, but wanted to refer to the entity by a more friendly name, then you can
CONFIDENTIAL
35
ENTITIES
create an alias. To do this, set the Native Name field to the Capture tag name (e.g.
DTP319003F), and specify the Name field as the desired name (e.g. Pump 52
Pressure). Note: An entity without a nativename may prevent the fetch request from
executing correctly.
Enabled
Select the Enabled check box to allow the entity to collect data.
11.
When you have finished, click Next.
12.
To proceed with creating the entity, click Finish.
The BabelFish Sourced Entity is now created.

Note: If you have created the entity via the Data Dictionary menu, it will be added to the
Data Source Entity Hierarchy. You can also find it by clicking on the Datasource (such
as BabelFish Data Dictionary) and selecting the Data Source Tags tab.
Calculation Entity
Calculation Entities are entities whose value is the result of a calculation. The calculation
can include predefined functions and other value-returning entities. For example, summing
gas production entities to get a total production value.
Previously, Calculation Entities could exist in the Data Dictionary separately from a
Calculation Tag in the BabelFish Explorer. Since BabelFish 2.2, Calculation Tags created in
BabelFish Explorer are now also created in the Data Dictionary as entities.
To create a Calculation Entity:
1.
Right-click on the entity or Entity Hierarchy that will be the parent of the new entity.
2.
From the menu, select Add > New Entity...
The Entity Creation Wizard appears.

3.
Click Next.
CONFIDENTIAL
36
ENTITIES
4.
In the Select Entity Type screen, click Calculation Entity
5.
In the Enter Calculation window, type your calculation, or use the Function
drop-down list to select a function from the BabelFish Calculation Engine. Click
Insert to use the selected function.
For a full list of functions supported by the BabelFish Calculation Engine, refer to the
Calculation Engine Reference.
Entities can be added to the calculation by clicking Insert Entity . This opens the
Data Dictionary Search window, allowing searches within the BabelFish Data
Dictionary. Click OK to add the selected entity to the calculation.
CONFIDENTIAL
37
ENTITIES
Note: The entities used in calculations must be either Calculation or BabelFish

Sourced entities. Summary entities cannot be used in calculation expressions
because they do not represent a data item in a data source. Properties or attributes
of entities associated with a template can also be referenced here, including those
belonging to a Summary Entity.
6.
When you have finished entering your calculation, click OK.
7.
In the Entity Detail window, type the name for the entity in the Name field.
Optionally enter the remaining parameters:
Description
A longer description of the purpose of the entity.
CONFIDENTIAL
38
ENTITIES
Namespace
The namespace to which the entity belongs. All valid namespaces are listed in the
drop-down list.
Location
The location of the entity, in general terms.
Data Type
The type of data that the entity is to collect. For example, the data may be time
series, relational, or object. All valid data types are listed in the drop-down list.
Enabled
Select the Enabled check box to allow the entity to collect data.
Note: The Native Name is the calculation detail and cannot be changed.
8.
When you have finished, click Next.
9.
To proceed with creating the entity, click Finish.
The Calculation Entity is now created and added to the selected Entity Hierarchy.
Note: If you have created the entity via the Data Dictionary menu, it will be added to the
Data Sources node of the navigation hierarchy. You can find it by clicking on the
Calculation Engine Data Source and selecting the Data Source Tags tab.
Shortcut Entity
A Shortcut Entity is an entity that is essentially a reference to an entity in a different Entity
Hierarchy.
For example, you might use Shortcut Entities to reference pump entities, where multiple
pump Entity Hierarchies are to be provided. One Entity Hierarchy may organise the pumps
by geographical location, whereas another organises the pumps by type. If we want to use
the same pump entities in both Entity Hierarchies (with the same child entities), we would
create the pumps and their child entities in one Entity Hierarchy, and then create a
shortcut to these pumps in the other Entity Hierarchy.
To create a Shortcut Entity in the entity hierarchy:
1.
Press the CTRL key.
2.
Click the entity in the hierarchy (this is the one you want the shortcut to refer to).
CONFIDENTIAL
39
3.
Drag the entity onto another parent.
4.
At the Create Shortcut Entity message, click Yes.
5.
At the confirmation message, click Yes.
6.
In the Create Shortcut Entity window, enter the following details:
ENTITIES
Name: The unique name of the entity.

Description: A description of the purpose of the entity.
Namespace: The unique category identifier of the entity. All valid namespaces are
listed in the drop-down list.
Location: The location from which the entity is collected, in general terms. This is a
free-text field.
CONFIDENTIAL
40
ENTITIES
Data Type: The type of data the entity is expected to collect. For example, the data
may be time series, relational, or object. All valid data types are listed in the
drop-down list.
Icon: The icon that represents the entity. Choose from:
Default, ePlant Tag
Facility
Namespace
Profile
Processes
Property
Page Renderers.)
Datasource type
Message
Component
Adaptor
Builder
Parser
Accumulator
Company
Process
Drawing
Unit
Compressor
Meter Point
Tags, ePlant Tag
Web Report
Well
Satellite
ePlant Trend
ePlant Page
Project
Native Name: The unique name of the entity in its original data source. For example,
a calculated entity would have its Native Name as the calculation. Use the native
name field when creating an alias for a data item. For example, if you wanted to
create an entity for a pump pressure tag in a PI historian data source, but wanted to
refer to the entity by a more friendly name, then you can create an alias. To do this,
set the Native Name field to the PI tag name (e.g. DTP319003F), and specify the
Name field as the desired name (e.g. Pump 52 Pressure). Note: An entity without a
nativename may prevent the fetch request from executing correctly.
Enabled: Select the Enabled check box to allow the entity to collect data.
7.
Click OK to create the entity. The new shortcut is added beneath the destination
entity hierarchy.
Summary Entity
Summary Entities are used to organise entities into logical hierarchies and do not
represent a data item in a data source. As such they are not associated with a Datasource
and cannot be used on BabelFish pages.
An example of a Summary Entity is a zone. A zone contains a number of items such as
pumps, but does not represent a data item in a data source.
CONFIDENTIAL
41
ENTITIES
To create a Summary Entity:

1.
Right-click on the entity or Entity Hierarchy that will be the parent of the new enti ty.
2.
From the menu, select Add > Summary Entity
3.
In the Create new Summary Entity window, enter the following details:

Default, ePlant Tag
Facility
Namespace
Profile
Processes
Property
Process
Drawing
Unit
CONFIDENTIAL
42
Page Renderers.)
ENTITIES
Compressor
Meter Point
Datasource type
Tags, ePlant Tag
Message
Component
Web Report
Adaptor
Well
Builder
Satellite
Parser
ePlant Trend
Accumulator
ePlant Page
Company
Project
4.
(Optional) If you want to further refine the details of the entity, click the Advanced
button and enter the following details:
Templates: If desired, you can associate a template with this entity. To do this, click
the New Template
button.
a.
In the Select Template window, click on the template you want to use.
If your list is long, you can choose to filter the list by either Template Group or
Template Type. If you need to create a new template, click the New button.
This invokes the Template Wizard (see page 103). Click through the wizard to
create the new template.
b.
Click OK.
You can add several templates to the list.

To delete a template from the list, first click on the template and then click the
Delete
button.
CONFIDENTIAL
43
ENTITIES
To designate a template as the primary template for the entity, click on the template
and then select the Primary check box.
The new entity is added to the Entity Hierarchy beneath the selected entity.
5.
When you have finished, click OK.
The new Summary Entity is added beneath the selected entity.

Note: If you add a Summary Entity via the Data Dictionary menu, it will not be added to
the Data Sources hierarchy or Entity Hierarchies in the Enterprise Manager
navigation hierarchy. The only way you will be able to retrieve the entity is by
performing a search (see page 13).

An external entity in BabelFish is one that is configured to extend the Data Dictionary
entity hierarchy (see page 19) by including a hierarchy from another system. The external
entity functionality is a developer extension implemented through the Treeview classes in
the BabelFish SDK. An example of this is the File Browser Plug-in, which allows for a
directory of documents or multimedia objects to be included in the Data Dictionary entity
hierarchy under a specified entity. For further details, contact the ISS Support Group or
refer to the BabelFish SDK Developer's Guide.
Note: For details on how to configure External Hierarchy Providers, contact the ISS Support
Group. Given that external content can be both Web and Intranet based, it is
expected that the source systems and external resources are correctly configured for
client machines to access them.
After the hierarchy of entities has been created, you connect to the external system by
configuring an External Referenced Entity in ISS Enterprise Manager. The hierarchy and its
entities are then available in BabelFish Explorer through the Plant Model Tree.
Note: You should not do this via the Data Dictionary menu, as the entity will not be added
to the Data Sources hierarchy or Entity Hierarchies in the Enterprise Manager
navigation hierarchy. The only way you will be able to retrieve the entity is by
performing a search (see page 13).
To create an External Referenced Entity:
1.
Right-click on the entity or hierarchy that will be the parent of the new entity.
2.
From the menu, select Add > Summary Entity
CONFIDENTIAL
44
3.
ENTITIES
In the Create new Summary Entity window, enter the following details:

Default, ePlant Tag
Facility
Namespace
Profile
Processes
Property
Page Renderers.)
Datasource type
Message
Component
Adaptor
Builder
Parser
Accumulator
Company
Process
Drawing
Unit
Compressor
Meter Point
Tags, ePlant Tag
Web Report
Well
Satellite
ePlant Trend
ePlant Page
Project
CONFIDENTIAL
45
ENTITIES
4.
Click the Advanced button.
5.
Select the Namespace. This is the unique category identifier of the entity. All valid
namespaces are listed in the drop-down list.
6.
Click the New Template
7.
In the Select Template window, click on the External Reference template, and then
click OK.
8.
button.
The new Summary Entity is added beneath the selected entity.

Note: If you have added the entity via the Data Dictionary menu, it will not be added
to the Entity Hierarchies. The only way you will be able to retrieve the entity is by
performing a search (see page 13) and then moving it to an Entity Hierarchy.
CONFIDENTIAL
46
9.
Click on the newly-added entity in the Entity Hierarchy.
10.
In the Properties tab, change the Entity Data Type to Application.
11.
Click on the Entity Templates tab.
12.
Click the
ENTITIES
button next to the EXT_REF_URL property.
The Property History window opens.

13.
Click the New button.
14.
In the Property Value field, type the URL to the External Hierarchy Provider (the web
service providing the External Reference Entity).
15.
Click Save.
CONFIDENTIAL
47
ENTITIES
Note: The data type should be set to Application.

16.
Click Close.
17.
In the Enterprise Manager toolbar, click the Save
button.
If the External Hierarchy Provider has been extended to support External Content (see
page 54), then there will be no further configuration required within BabelFish. These
entities will automatically have content associated with them in the Table of Contents.
L I MI TA T I ON S
The following limitations exist:
External entities do not appear in remote entity hierarchies.
When standard entities and external entities are selected together, only the
standard entities are displayed in the Table of Contents.
Edit an Entity
Editing an entity allows you to modify the properties of the entity, as well as the
templates, Datasources, and renderers.
To edit the properties of an entity:
1.
Select the entity:
From the Data Source Tags tab (see page 94) of the Datasource in the Data
Sources hierarchy, double-click on the entity.
OR
Click on the entity from the Entity Hierarchy.

OR
CONFIDENTIAL
48
2.
ENTITIES
Search (see page 13) for the entity to locate it and then double-click the entity
in the results list.
Edit the following properties as required:

Note: Fields are validated when you complete them and move to the next field.
Description: A description of the purpose of the entity, up to 2000 characters. This is
a free-text field.
Name: The unique name of the entity. This is a free-text field.
Enabled: True or False, whether or not the entity is enabled for data collection.
EntityDataType: The type of data the entity is expected to collect: Application,
Object, Relational, Time Series, Time Series Calculation, Time Series String, ePlant
Page, or ePlant Trend.
EntityType: The type of entity this is: BabelFish Sourced (including Calculation
Entities), Summary Entity, Shortcut Entity, External Referenced Entity, or Custom
Entity.
Location: The location from which the entity is collected. This is a free-text field.
Measurement Type: The type of measurement expected to be collected. All valid
measurement types are listed in the drop-down list.
CONFIDENTIAL
49
ENTITIES
NativeName: The Native Name of the entity. This is the unique name of the entity in
its original data source. For a Calculation Entity, the native name is the formula of
the calculation, therefore changing the native name changes the calculation.
Units: The unit measurement applicable to the entity. For example, Tonne.
3.
When you have finished, click the Save

toolbar.
button on the Enterprise Manager
You can also edit the Entity Templates (see page 50), Entity Data Source (see page 55), or
Renderers (see page 56).
Entity Templates
The Entity Templates tab allows you to associate templates with entities.
Templates are a collection of properties and attributes, and provide a means of

relating static and dynamic data to entities.
Properties are placeholders for static values, such as maximum and minimum r ange,
pump name, document location, and so on.
Attributes are placeholders for dynamic data and reference other entities within the
BabelFish Data Dictionary.
The Entity Templates tab is divided into two sections: the Templates list on the left, and
the Properties and Attributes tabs on the right.
T E MP LA TE S
The templates assigned to this entity are listed on the left. The designated primary
template for the entity is displayed in bold text. You can only assign one template to be
CONFIDENTIAL
50
ENTITIES
the primary template for an entity. You can add or delete templates from this list (see
page 51), however you can only directly modify the listed templates via the Templates
Hierarchy (see page 109).
P R O PE RT IE S
AND
A T T RI B U TE S
When you click on a template, the properties and attributes of that template are displayed
on the right. As well as changing their values, you can also view the history of changes (see
page 52).
How to Use an Entity Template

Entity templates are especially useful with Summary Entities. For example, to model a well
in BabelFish, you would create a summary entity to represent the well, because a well
does not represent a single piece of data.
You would then associate a Well template with the entity.
This template may have properties named Completion Diagram, Location, and Installation
Date, and attributes named Choke Position, Meter Run Differential Pressure, Meter Run
Pressure, and Tubing Head Pressure.
Entities coming from external data sources that represent the actual data points are then
assigned to these attributes.
Therefore, even though the well does not represent a single piece of data, it does ha ve a
set of related parameters, which are created using template attributes in the BabelFish
Data Dictionary. When the well entity is viewed in the entity hierarchy, its attributes are
displayed beneath the entity.
Add and Delete Templates

To add another template to the list in the Entity Templates tab:
1.
Select the entity from the Entity Hierarchy.
2.
Click the Entity Templates tab of the entity.
CONFIDENTIAL
51
3.
ENTITIES
Click the Add Template button.
The list of available templates appears.

4.
Click on the template you want to add. If your list is long, you can choose to filter the
list by either Template Group or Template Type.
If you need to create a new template, click the New button. This invokes the
Template Wizard (see page 103). Click through the wizard to create the new
template.
5.
Click OK.
To remove a template from an entity, first click on the template and then click the Delete
button.
Modify a Property or Attribute Value

To change the value of a template property in the Entity Templates tab:
1.
2.
Click the Entity Templates tab of the entity.
3.
Click the template containing the property or attribute you want to change.
CONFIDENTIAL
52
4.
Click the
ENTITIES
button next to the property or attribute you want to change.
The Property History or Attribute History window appears (as appropriate),

displaying the history of all modifications that have been made to the value of this
property or attribute.
From here, you can change the value of a property or attribute at any time in t he
past, or you can create a new property value or assign a new entity to the attribute,
that will apply from this time onwards.
5.
To add a new value, click the New button, and then:
If this is a property, type the new value into the Property Value field.
If this is an attribute, click the

button next to the Attribute field, search
for the attribute you want to add, and then double-click on it.
6.
If required, select the date from the drop-down list and change the time.
7.
When you have finished making your changes, click the Save button.
8.
Click Close.
CONFIDENTIAL
53
9.
Click the Save
ENTITIES
External Content Providers

The External Content Provider functionality allows external hierarchy plug-ins (see page
44) to also interact with the Table of Contents by providing additional content for an
external entity. As with external hierarchies themselves, this can be used to provide links
into any system. For example, you can extend the File Browser Plug-in to integrate with a
document management system where you can double-click the file entity on the hierarchy
to open it, or select the entity to display the Table of Contents with a link to the Content
Provider for the document in the document management system.
In the same manner as for external entities, BabelFish can also attach External Content
Providers directly to any standard BabelFish entity.
Note: For details on how to configure External Content Providers, contact the ISS Support
Group.
An External Content Provider consists of a single URL, similar to the Hierarchy Provider.
This URL can then provide any number of content links.
To configure an External Content Provider for an existing BabelFish entity:
1.
In the Entity Hierarchy, select the entity to which you want to apply the External
Content Provider.
2.
Click the Entity Templates tab.
3.
Click Add Template.
4.
Select the template you want to apply that will invoke the External Content Provider.
If no suitable template exists, create a new one:
a.
In the Select Template dialog, click New to launch the Template Wizard.
b.
Click Next.
c.
Select Entity Types as the Template Type, and then click Next.
d.
Select External Content Providers as the Template Group, and then click Next.
e.
Type a Name and a Description, and select an icon.

Note: The name will appear in the Table of Contents as a Content Group.
f.
Click Next.
g.
Select the EXT_REF_URL property, and any other properties for the Content
Provider you want to associate with the entity.
h.
Click Finish.
5.
Click OK to add the template to the entity.
6.
On the Entity Templates tab, click on the template you just added.
CONFIDENTIAL
54
7.
Click the
ENTITIES
button next to the EXT_REF_URL property.
The Property History window opens.

8.
In the Property Value field, type the URL to the External Content Provider for that
Content Group.
9.
Click Save and then click Close.
10.
In the Enterprise Manager toolbar, click the Save
button.
The External Content for entities should appear immediately in the Plant Model in the
BabelFish Explorer.
Entity Data Source

The Entity Data Source tab shows the Datasource that is related to the entity. If the entity
does not have an associated Datasource (such as Summary Entities), then nothing is
displayed.
The Datasource is where BabelFish retrieves the entity data from. As an example, for
Calculation Entities, this is the Calculation Engine Data Source. If the entity has an
associated Datasource, then entity and request templates can also be defined.
To associate an entity with a Datasource:
1.
2.
Click the Entity Data Source tab of the entity.
3.
Click the Datasource
button next to the Associated Data Source field.
CONFIDENTIAL
55
ENTITIES
If you are changing the associated Datasource, a prompt appears asking if you want
to remove the association between the entity and the Datasource. If you want to
proceed, click Yes.
4.
In the Select DataSource window, click the Datasource you want to use.
If the Datasource does not exist, click the New DataSource button to create a new
Datasource via the Data Source Wizard (see page 61).
5.
Click OK.
Renderers
The Renderers tab for a selected entity displays the renderers (see page 124) (or Content
Providers) configured for the entity.
Renderers can be applied at the entity level and the template level. Entity-level renderers
take precedence over template-level renderers, so if an entity has a template with a
primary renderer and also has a primary renderer configured for the entity itself, BabelFish
uses the entity renderer as the primary renderer for the entity.
You can also specify more than one renderer for an entity. If there are several entity
renderers configured, then the renderer marked as both default and primary is used as the
renderer to load when the entity is double-clicked from the Plant Model Tree. Note that
only one renderer can be marked as default and only one can be marked as primary for
any particular entity or template.
You can add renderers three ways here:
Add a new renderer.

Link to an existing renderer.
CONFIDENTIAL
56
ENTITIES
Add a renderer that is a copy of an existing renderer.
To add a renderer for the selected entity:

1.
2.
Click the Renderers tab of the entity.
3.
Choose the type of renderer you want to add.

Add a New Renderer
a.
Click New.
b.
The Renderer Wizard form appears in the previously empty area, with a
default name for the new renderer.
Link to an Existing Renderer

c.
Click Add Existing.
CONFIDENTIAL
57
ENTITIES
The Select Renderer screen appears, listing all the renderers (in their groups)
that are available and may be associated with this template.
d.
Select the renderer you want to link to. This uses an instance of the selected
renderer.
e.
Click OK.
Copy an Existing Renderer

f.
Click Add Existing.

that are available and may be associated with this entity.
g.
Select the renderer you want to copy.
CONFIDENTIAL
58
DATASOURCES
h.
Select the Copy Selected Renderer check box. This copies the properties of the
selected renderer into a new renderer of the specified name.
i.
In the Name field, change the default renderer name.
j.
Click OK.
4.
Fill in the remaining fields in the renderer form.
5.
Click Save
on the Enterprise Manager toolbar.
You can edit the renderer (see page 123) at any time after you add the renderer. However,
if you have selected the Link option, any changes you make will affect all entities and
templates that this renderer is linked to.
R E M OV E
R E ND E RE R
To remove a renderer from the list:

1.
Click on the renderer.
2.
Click the Delete button.
3.
At the message, click Yes or No accordingly.
Datasources
Generically, a data source is a specific site from which data can be obtained. This includes
any source of data from a database or data file.
In the BabelFish Data Dictionary, a Datasource is a one-to-one mapping between BabelFish
and a real world data store. A Datasource must exist in the Data Dictionary for every data
store that is to be connected to BabelFish.
Data sources are connected to BabelFish via Adaptors and translate the data so that
BabelFish can understand it.
In ISS Enterprise Manager, the Data Sources hierarchy displays the Datasources configured
in the BabelFish Data Dictionary, organised by data source type. These data source types
loosely correspond to Adaptors.
CONFIDENTIAL
59
DATASOURCES
Under each Datasource, the request and result messages configured for the Datasource
are displayed. Beneath these are then the Adaptors, builders, parsers, and accumulator
components that are used by the Datasource.
The data source types predefined the Enterprise Manager after a default installation are:
Data source type
Description
BabelFish Data
Dictionary
A BabelFish Data Dictionary database. There are three default Datasources

of this type:
BabelFish Data Dictionary. This is the Datasource for all BabelFish
Sourced Entities. Whenever a new BabelFish entity is created, it is listed
under this Datasource.
Calculation Engine Data Source. Whenever a Calculation Entity is
created, it is treated as having come from the Calculation E ngine Data
Source.
BabelNet
Any BabelNet data source. BabelNet is a default data source, and refers to
all the tags which have been created in the BabelFish Explorer. Whenever a
tag is exported from BabelFish Explorer to the Data Dictionary, an entity is
created and is associated with the BabelNet Datasource.
Exaquantum
Any Exaquantum historian.
NULL
Any data source that uses the Null Adaptor, which is a dummy data source
designed to facilitate testing. The Adaptor produces an echo response of the
request or a response of a set number of bytes. The Datasource uses the
BabelFish message broking system in a unique manner to associate two
request messages with the same response message (usually this is a
one-to-one mapping). The Data Dictionary also assumes that the Generic
Parser component is associated with this Datasource. This enables it to look
up the Generic Parser details if no other parser is associated with the
request message. The Generic Parser is used to do a pass-through
CONFIDENTIAL
60
Data source type
DATASOURCES
Description
functionality to Adaptors, where the original request message isn't modified
by the Data Dictionary and Get Data Parser.
ODBC
Any ODBC data source.
ODBCWide
Any ODBCWide data source.
PHD
Any Honeywell Uniformance PHD historian.
PI
Any OSIsoft PI historian.
Random
Used for data sources that produce random values.
Remote
Any data source that uses the Remote Adaptor.
Remote BabelFish
Any data source that uses a remote BabelFish DMS connection

(multi-server).
Create a Datasource
The Data Source Creation Wizard allows you to add a new Datasource to an existing data
source type in the Data Sources hierarchy. You can invoke the wizard in two ways:
In the Data Dictionary menu, select Add > New Data Source.
OR
Expand the Data Sources node in the hierarchy, right-click on the data source type,
and select Add >
New Data Source.
In the Data Source Creation Wizard:

1.
At the Welcome screen, click Next to start defining the Datasource.
2.
From the list, select the data source type and then click Next.
CONFIDENTIAL
61
DATASOURCES
Note: This step only appears if you have opened the Data Source Creation Wizard
from the Data Dictionary menu.
3.
In the Data Source Configuration window, enter the connection properties.

Note: This step does not appear for the Null and Data Dictionary data source types.
Note: Data source configuration differs for each data source type. For a list of
parameter definitions, refer to Datasource Parameters (see page 69). For further
information on the difference between the current and legacy transforms on raw
data, refer to Appendix A. Transforms (see page 238).
Recommendations:
For PHD and PI Adaptors, use the default value of Y for these Datasource
parameters. This means that the transforms are calculated by the historian,
which applies algorithms appropriate for the data they contain. Setting this to
N means that the Adaptor will calculate the transforms on the raw data
provided by the historian.
CONFIDENTIAL
62
DATASOURCES
For ODBC and ODBCWide Adaptors, set the value to N. This means that the
current functionality will be retained, and existing implementations will not be
affected.
ODBC Adaptor:
4.
The LOOK_BACK_TIME_INCREMENTS configuration parameter allows you to

configure, per Datasource, how far back in time to look for data samples, and
what increments to use. You can have as many, or as little, number of look
back time increments as you wish. When the adaptor reaches the last
increment without finding a value, it times out. The default is
1h,6h,1d,1w,4w,52w,78w.
Click Next.
For the Data Dictionary, Null, and Random data source types, the Select
Components window appears. For other Adaptors, these components have been
specified in the configuration file and therefore this window does not appear.
a.
Select the Adaptor for the data source type.

Usually, the name of the data source type will be an indicator of the Adaptor
to select. If you are not sure which one to use, then use the BabelFish Adaptor
Pooling Service.
Note that other Adaptors may appear in this list if they have been installed. If
you need to add a new Adaptor (see page 76), click the Add New link.
Adaptor
Use for
BabelFish Error Adaptor
Do not assign to a Datasource. This is used

automatically to process erroneous entities.
BabelFish Null Adaptor
Null Adaptor Datasource.
BabelFish PHD Adaptor
PHD Datasource.
CONFIDENTIAL
63
b.
DATASOURCES
Adaptor
Use for
BabelFish Property Adaptor
Do not assign to a Datasource. This is used

automatically to process entity$property entities.
BabelFish Calculation Engine

Adaptor
Calculation Engine Datasource (BabelFish Data

Dictionary data source type).
BabelFish Adaptor Pooling

Service
This is the ISSAdaptorPool.exe component, and

should be the Adaptor component assigned for
EVERY data source created by users, every time.
Data Source Adaptor
Deprecated.
Random Data Adaptor
Random Datasource.
BabelFish Adaptor Host
Do not assign to a Datasource. This is the

AdaptorHost.exe component, and is used in
combination with the ISSAdaptorPool.exe
component.
BabelFish OLEDB Adaptor
Do not use, deprecated by the General Relational

Adaptor.
BabelNet Adaptor
BabelNet Datasource.
PI Adaptor
PI Datasource.
ODBC Adaptor
ODBC Datasource.
ODBC Wide Adaptor
ODBCWide Datasource.
DMS Adaptor
Remote BabelFish Datasource. This is the Adaptor

used for corporate server fetches, in combination
with the Remote Adaptor, and is hosted on the
remote machine.
Remote Adaptor
Remote Datasource.
Select the Parser to be used for the new Datasource. If you are not sure which
one to use, then use the GetData / PutData Parser. If you need to add a new
parser (see page 78), click the Add New link.
Parser
Use for
BabelFish Generic Parser
This is a pass-through parser and doesnt

modify request data. Use this when you want
your Adaptor to get the exact request data.
BabelFish GetData / PutData Parser This is the default parser, and modifies request
data with Data Dictionary information.
BabelFish Token Parser
Deprecated (previously used for the OLEDB

Adaptor, which has been deprecated by the
General Relational Adaptor). This modifies the
request data after the GetData / PutData Parser
has processed it, replacing tokens with values.
CONFIDENTIAL
64
c.
d.
DATASOURCES
Select the Builder to be used for the new Datasource. If you are not sure
which one to use, then select No Builder. If you need to add a new builder
(see page 77), click the Add New link.
Builder
Use for
PHD Adaptor Builder
PHD Datasource.
Property Adaptor Builder
Deprecated.
Calculation Engine Adaptor Builder
Calculation Engine Datasource.
No Builder
Specifies that no Builder is to be used.
Data Source Time Series XML Builder
No longer used (previously only used by the

Exaquantum Adaptor). Builds the Time
Series XML responses from Data Source type
Adaptors.
Data Source SQL XML Builder
No longer used. Builds the SQL XML

responses from Data Source type adaptors.
OLEDB Adaptor Record Set Builder
Deprecated. Previously used by the OLEDB

Adaptor.
OLEDB Adaptor Time Series Builder
Deprecated. Previously used by the OLEDB

Adaptor.
Select the Accumulator to be used for the new Datasource. If you are not sure
which one to use, then select the GetData / PutData Accumulator. If you need
to add a new accumulator (see page 76), click the Add New link.
Accumulator
Use for
No Accumulator
Specifies that no Accumulator is to be used. Use this

whenever the request you are making and the
resulting Adaptor request is a 1:1 mapping.
BabelFish GetData / PutData Used by the Get Data Parser for GetTimeSeriesData
Accumulator
and GetSQLData (because the message formats are
very similar).
e.
Select the Messages to be used for the new Datasource. If you are not sure
which one to use, then select the GetTimeSeriesData /
GetTimeSeriesDataResult message combination. Generally, the messages
should reflect the type of data that is expected to be returned from the
Datasource.
CONFIDENTIAL
65
DATASOURCES
To select the messages, first click the New Message

button and then
choose the message combination from the Select Message drop-down list. If
you need to add a new message (see page 86), click the Add New link.
Usually there will only be a single request / result message mapping for a
Datasource, but there are exceptions. You would use more than one message
combination against a Datasource when it can supply different types of data.
For example, the General Relational Adaptor can fetch time series data, or SQL
data, thus it supports GetTimeSeriesData and GetSQLData.
Message
Request:
Test.NullAdaptor.Message
Use for
Data from the Null Adaptor.
OR
Test.NullAdaptor.Message.SendBytes
Result: Test.NullAdaptor.MessageResult
Request: GetTimeSeriesData
Result: GetTimeSeriesDataResult
Request: GetSQLData
GetTimeSeriesData is a request that

retrieves time series data from one or
more data sources. It has a very similar
format to the request message from a
PutTimeSeriesData result.
SQL data.
Result: GetSQLDataResult
Request: GetCommentsData
Comments data.
Result: GetCommentsDataResult
Request: PutTimeSeriesData
Result: PutTimeSeriesDataResult
PutTimeSeriesData is a request that puts

time series data into one or more data
sources. It has a very similar format to
the result message from a
GetTimeSeriesData request. Most of the
historian adaptors support put
operations, as does the General
Relational Adaptor.
To delete a message combination that is no longer required, first click on the

message and then click the Delete
button.
f.
Click Next.
CONFIDENTIAL
66
5.
DATASOURCES
In the Enter Data Source Details window, enter the following details.
Name: Name of the Datasource.

Description: Description of what the Datasource is used for.
Time Zone: If the Adaptor does not support GMT offset, but supports time zones,
then select a time zone and clear the Supports GMT Offset check box. Otherwise
leave the check box selected.
Security: The Security combo box allows the data source access to be set. It is only
enabled where the data source components have been specified in the configuration
file. If this is enabled, the data source can be created as read-only, read-write, or
write-only.
6.
Click Next.
7.
Click Finish.
CONFIDENTIAL
67
DATASOURCES
The new Datasource is added to the data source hierarchy beneath the selected data
source type, as shown below, and can also be seen in the Plant Model Tree.
CONFIDENTIAL
68
DATASOURCES
Datasource Parameters
The following table provides definitions of parameters for Datasource configuration.
Legend:
BN
BabelNet
EXA
Exaquantum
RAN
Random
RMB
Remote BabelFish
PHD
PHD
PI
PI
ODB
ODBC
REM
Remote
ODW
ODBCWide
For further information on the difference between the current and legacy transforms on raw data, refer to Appendix A. Transforms (see page
238).
Parameter
Description
Connection Details
Password
The password used to connect to the data source, server,

or remote system.
Server
The name of the server to which you want to connect.
User_ID
The user name with which to connect to the data source,

server, or remote system.
Settings and Template Properties

Aggregate_Scan_Periods
Specify the successive scan periods (minutes, hours, days)

used to fetch the last point for the linear interpolate
transform.
Allow_Write
Y or N. Whether or not write operations against the

historian are allowed.
Bad_Confidence_Value
Specify a value that represents a bad value or low

confidence.
Case_Sensitive
T or F. When set to False, comparisons for tag names are

not case sensitive.
Check_Database_Count
The number of times to attempt a connection before

giving up.
CONFIDENTIAL
Data Source Type

BN
EXA
ODB
ODW
PHD
PI
RAN
REM
RMB
BN
EXA
ODB
ODW
PHD
PI
RAN
REM
RMB
69
Parameter
Description
Connection Details
DATASOURCES
Data Source Type

BN
Check_Tag_Exists
Y or N. Check whether the tag exists outside of the

specified time boundary, or not at all.
Conflict_Prefix
The prefix to add to the entity name when an entity with

the existing name is found.
Conflict_Suffix
The suffix to add to the entity name when an entity with

the existing name is found.
Connect_Timeout
The timeout, in seconds, for connecting to the data

source.
DSN
The Data Source Name for the connection through ODBC,

ADO, or OLEDB.
Exclude_BF_Entities
Y or N. Whether or not BabelFish entities should be

excluded when doing a tag fetch.
History_Raw_Bad_Value_
Detect
Y or N. Whether or not to set the value to zero for the bad

confidence value on a history fetch.
Hosted_Prog_ID
The Prog ID of the Hosted Component. This is required by

BabelFish and is the ProgID of the Adaptor.
Import_Hierarchy
Y or N. Whether or not the remote hierarchy is visible in

the BabelFish Plant Model Tree.
Inactivity_Timeout_Secs
The timeout, in seconds, for the Adaptor in the adaptor

pool. Specifies the period of inactivity after which
BabelFish will unload the Adaptor.
EXA
ODB
ODW
PHD
PI
RAN
REM
RMB
Include_State_On_Numeri Y or N. When a state value is found on a numeric tag,

c_Tags
specifies whether to return the State ID (Y, TRUE, T, YES,X,
ON) or to return an error (N, all other values).
Init_Failure_Lock_Secs
After an Adaptor initialisation failure, this specifies the

amount of time (in seconds) for BabelFish to deny further
initialisation requests to the Adaptor.
Init_Timeout
The maximum period (in seconds) BabelFish will allow the

Adaptor to initialise before timing out.
ISS Group Limited 2013 ISS Enterprise Manager 2.6 User's Gu ide
CONFIDENTIAL
70
Parameter
Description
Connection Details
DATASOURCES
Data Source Type

BN
EXA
ODB
ODW
PHD
PI
RAN
REM
RMB
Last_Known_Value_Max_ For LastKnownValue, specifies the maximum interval for

Raw_Data_Sample_Interva which the transform will use a bulk Raw fetch. Any
l
interval beyond this will use spot LastKnownValue fetches
instead. Note this only applies when the transform is
used.
Linear_Interpolate_Max_ The maximum sample interval after which spot fetches are
Raw_Data_Sample_Interva done on each sample interval.
l
Linear_Interpolate_Max_ The maximum sample interval after which spot fetches are
Raw_Data_Sample_Interva done on each aggregate scan period to get the end point
l_ Endpoint
for the linear interpolate.
LKV_Empty_History_Raw
Y or N. Whether or not to use the Last Known Value for

Raw fetches that don't return a value.
LKV_History_Raw
Y or N. Whether or not to use the Last Known Value for

Raw fetches.
Log_Level
Debug, Verbose, or Error. Specifies the minimum severity

of messages to be logged by BabelFish components using
the legacy Mercury logging.
Log_Timing
Y or N. Whether or not BabelFish components using the

legacy Mercury logging should log timing information.
Look_Back_Time_Increme
nts
Allows you to configure, per Datasource, how far back in

time to look for data samples, and what increments to
use. You can have as many, or as little, number of look
back time increments in minutes (m), hours (h), and days
(d), as you wish. When the adaptor reaches the last
increment without finding a value, it times out. The
default is 1h,6h,1d,1w,4w,52w,78w.
NumberOfRandomTagsTo
Return
Number of additional random tags to return when doing a

tag fetch.
Offset_Seconds
The time offset, in seconds, between the server and the
CONFIDENTIAL
71
Parameter
Description
Connection Details
DATASOURCES
Data Source Type

BN
EXA
ODB
ODW
PHD
PI
RAN
REM
RMB
data source.
Perform_Reduction_
Average
True or False. Whether or not to perform automatic

time-weighted averages via reductions.
Pool_Checkout_Timeout_
Secs
Specifies period (in seconds) BabelFish will wait for a free

Adaptor instance in the pool before creating a single use
instance to service the request. Note if this is happening it
is likely that POOL_SIZE is set too low.
Pool_Size
Specifies how many Adaptor instances should be created

in the pool ready to service requests to this Datasource.
Pooled_Prog_ID
The Prog ID of the BabelFish Adaptor Host.
Prog_ID
The Prog ID of the component.
Questionable_Confidence_ Sets the confidence to be assigned when a data point has

Level
the Questionable flag set to True.
Reader_Class
The name of the internal class that the Adaptor uses to

read data.
Remote_Port
The optional remote port to which to connect.
Remote_Prog_ID
The Prog ID of the Adaptor to create on the remote

server.
Remote_Properties
Additional properties to pass to the Remote Adaptor, in

the format of name=value,name=value.
Remote_Server
The name of the remote server to which you want to

connect.
Remote_Server_Hostname The remote BabelFish object server host name.

Remote_Server_Port
The remote BabelFish object server port.
Remote_Timeout
The number of seconds to hold the Remote Adaptor after

its last access, before it is unloaded.
CONFIDENTIAL
72
Parameter
Description
Connection Details
Data Source Type

BN
Remote_Transport
The name of the remote transport method.
ReturnRandomProfiles
Y or N. Whether or not to return random entity profiles

with the tags from a tag fetch.
ReturnRandomStates
Y or N. Whether or not to return random state profiles

with the tags from a tag fetch.
Single_Point_Collapse_
Method
Oldest, Newest, or None. When more than one value is

returned for a single point fetch (start and end time are
the same) then the collapse method specifies whether to
use the value with the oldest or newest timestamp.
Specifying None will return both values along with an
error in BabelFish Explorer.
Spot_Time_Raw_Bad_
Value_Detect
Y or N. Whether or not to set the value to zero for the bad

confidence value on a spot time fetch.
SQL_Date_Field
The field that contains the timestamp.
SQL_From
SQL list of tables from which the query retrieves data.
SQL_Table
The name of the table to query.
SQL_Table_With_Date
The table from which the Date field originates. Used when
you are joining more than one table.
SQL_Tag_Field
The name of the field that contains the tag name.
SQL_Value_Field
The field that contains the value.
SQL_Where
Optional SQL WHERE clause that joins the tables in the

FROM clause, and further limits the query.
StateTagsExceptionOn
NonRawSampleMethod
Y or N. Whether or not to throw an exception when a

state set entity is requested in non-raw mode.
Submit_Timeout
The period (in seconds) that BabelFish will wait before

timing out submit requests for hosted components.
CONFIDENTIAL
DATASOURCES
EXA
ODB
ODW
PHD
PI
RAN
REM
RMB
73
Parameter
Description
Connection Details
DATASOURCES
Data Source Type

BN
Tag_Prefix
The prefix to apply to created entities when importing

tags from this data source.
Use_Legacy_Average_
Transform*
Y or N. Whether or not to use the legacy native data

source average transform or the new time-weighted
average transform. Default is Y.
Use_Legacy_Linear_
Interpolate_Transform*

source last known value transform or the new last known
value transform. Default is Y.
Use_Legacy_Last_Known_
Value_Transform*

source linear interpolate transform or the new linear
interpolate transform. Default is Y.
Use_Mercury
Y or N. Whether or not BabelFish components using legacy

Mercury logging should log to Mercury.
EXA
ODB
ODW
PHD
PI
RAN
REM
RMB
Use_True_Average_Fetch_ Y or N. Whether or not the PI Adaptor should attempt a

History
true fetch history average or a linear interpolate fetch
history.
Writer_Class
The name of the internal class that the Adaptor uses to

write data.
*Recommendations on the Use of Legacy Transforms:
For PHD and PI Adaptors, use the default value of Y for these Datasource parameters. This means that the transforms are calculated by
the historian, which applies algorithms appropriate for the data they contain. Setting this to N means that the Adaptor will calculate the
transforms on the raw data provided by the historian.
For ODBC and ODBCWide Adaptors, set the value to N. This means that the current functionality will be retained, and existing
implementations will not be affected.
CONFIDENTIAL
74
DATASOURCES
Data Dictionary Components

The BabelFish Data Dictionary contains four main types of component. All components
work together to allow the Data Dictionary to communicate with a data source.
Accumulators
An Accumulator is a component that joins Adaptor requests back together into a
single response. You can do without an Accumulator if the request you are making
and the Adaptor request that results is a 1:1 mapping.
An Accumulator Request is the record in the Data Dictionary that links a data source
to an Accumulator component. When you create a Datasource and assign it an
Accumulator component to use, it creates an Accumulator Request to make the
association. You can add further Accumulator Requests to a Datasource if you need
to use more than one Accumulator for the Datasource.
Adaptors
Connects the Data Dictionary with the data source.
A Data Source Adaptor is the record in the Data Dictionary that links a data source to
an Adaptor component. When you create a Datasource and assign it an Adaptor
component to use, it creates a Data Source Adaptor to make the association. You
can add further Data Source Adaptors to a Datasource if you need to use more than
one Adaptor component for the Datasource.
Builders
A Builder is a component that was intended to be used by Adaptors in order to
enable them to generate multiple different response message formats, irrespective
of the request message format.
However, the request and response are often in the same format, and therefore
Builders are not generally needed. As such, most Adaptors generate the response
document internally without using a Builder.
An Adaptor Result Builder is the record in the Data Dictionary that links a data
source to a Builder component. When you create a Datasource and assign it a
Builder component to use, it creates an Adaptor Result Builder to make the
association. You can add further Adaptor Result Builders to a Datasource if you need
to use more than one Builder for the Datasource.
Parsers
Extracts data from a Datasource.
A Parser Request is the record in the Data Dictionary that links a data source to a
Parser component. When you create a Datasource and assign it a Builder component
to use, it creates a Parser Request to make the association. You can add further
Parser Requests to a Datasource if you need to use more than one Parser
component for the Datasource.
CONFIDENTIAL
75
DATASOURCES
Add a New Accumulator

To add an Accumulator component (see page 75), you can either:
Click Add New next to the Accumulator drop-down list, in the Select Components
window of the Data Source Creation wizard.
From the Data Dictionary menu, click Add > Component.
OR
1.
In the Select Components window of the Data Source Creation wizard, click Add
New next to the Accumulator drop-down list.
2.
In the Create New Accumulator window, enter the following parameters:

Description: A description of the Accumulator.
Name: The name of the Accumulator.
Component Type: The type of component: Adaptor, Accumulator, Builder, Parser.
Select Accumulator.
Guid: The GUID of the Accumulator, if known.
Location: The full file path of the Accumulator.
ProgId: The ProgID of the Accumulator.
3.
Add a New Adaptor

If you have installed a new Adaptor and it does not appear in the Adaptors components
list, you will need to add it.
To add a new Adaptor component (see page 75), you can either:
Click Add New next to the Adaptor drop-down list, in the Select Components
OR
CONFIDENTIAL
76
1.
DATASOURCES
In the Create New Adaptor window, enter the following parameters:

Description: A description of the Adaptor.
Name: The name of the Adaptor.
Select Adaptor.
Guid: The GUID of the Adaptor, if known.
Location: The full file path of the Adaptor.
ProgId: The ProgID of the Adaptor.
2.
Add a New Builder

To add a Builder component (see page 75), you can either:
Click Add New next to the Builder drop-down list, in the Select Components window
of the Data Source Creation wizard.
OR
CONFIDENTIAL
77
1.
DATASOURCES
In the Create New Builder window, enter the following parameters:

Description: A description of the Builder.
Name: The name of the Builder.
Select Builder.
Guid: The GUID of the Builder, if known.
Location: The full file path of the Builder.
ProgId: The ProgID of the Builder.
2.
Add a New Parser

A Parser is used to extract data from a Datasource. To add a Parser component (see page
75), you can either:
Click Add New next to the Parser drop-down list, in the Select Components window
of the Data Source Creation wizard.
OR
CONFIDENTIAL
78
1.
DATASOURCES
In the Create New Parser window, enter the following parameters:

Description: A description of the Parser.
Name: The name of the Parser.
Select Parser.
Guid: The GUID of the Parser, if known.
Location: The full file path of the Parser.
ProgId: The ProgID of the Parser.
2.
Accumulator Request
To add a new Accumulator Request:
1.
From the Data Dictionary menu, click Add > Accumulator Request.
2.
In the Accumulator Request Wizard, click Next.
3.
In the Select Accumulator Component window, click on the Accumulator to be used,

and then click Next.
CONFIDENTIAL
79
DATASOURCES
4.
In the Select Request Message window, click on the Request Message to be used by
the Accumulator Request, and then click Next.
5.
In the Select Result Message window, click on the Result Message to be used by the
Accumulator Request, and then click Next.
6.
Click Finish.
7.
Click the Save
The new Accumulator Request appears in the relevant drop-down lists.
CONFIDENTIAL
80
DATASOURCES
Adaptor Result Builder

To add a new Adaptor Result Builder:
1.
From the Data Dictionary menu, click Add > Adaptor Result Builder.
2.
In the Adaptor Result Builder Wizard, click Next.
3.
In the Select Builder Component window, click on the Builder to be used, and then
click Next.
4.
In the Select Result Message window, click on the Result Message to be used by the
Adaptor Result Builder, and then click Next.
CONFIDENTIAL
81
DATASOURCES
5.
In the Select Data Source Adaptor window, click on the Data Source Adaptor to be
used by the Adaptor Result Builder, and then click Next.
6.
Click Finish.
7.
Click the Save
The new Adaptor Result Builder appears in the relevant drop-down lists.
Data Source Adaptor

To add a new Data Source Adaptor:
1.
From the Data Dictionary menu, click Add > Data Source Adaptor.
2.
In the Data Source Adaptor Wizard, click Next.
CONFIDENTIAL
82
DATASOURCES
3.
In the Select Data Source window, click on the Datasource being used, and then click
Next.
4.
In the Select Request Message window, click on the request message being used by
the Datasource, and then click Next.
CONFIDENTIAL
83
DATASOURCES
5.
In the Select Adaptor Component window, click on the Adaptor component being
used by the Datasource, and then click Next.
6.
In the Data Source Adaptor Details window, enter the following details:
Name: The name of the Data Source Adaptor.

Description: A description of the purpose of the Data Source Adaptor.
Default Data Source: Select this check box if this is the default Data Source Adaptor
for the specified Datasource.
7.
Click Next.
8.
Click Finish.
CONFIDENTIAL
84
9.
Click the Save
DATASOURCES
The new Data Source Adaptor appears in the relevant drop-down lists.
Parser Request
To add a new Parser Request:
1.
From the Data Dictionary menu, click Add > Parser Request.
2.
In the Parser Request Wizard, click Next.
3.
In the Select Parser Component window, click on the Parser component to be used,
and then click Next.
4.
In the Select Request Message window, click on the request message to be used by
the Parser Request, and then click Next.
5.
Click Finish.
CONFIDENTIAL
85
6.
Click the Save
DATASOURCES
The new Parser Request appears in the relevant drop-down lists.
Messages
To add a new Request or Result Message, you can either:
Click Add New next to the Request or Result drop-down list, in the Select Message
From the Data Dictionary menu, click Add > Message.
OR
1.
In the Create Request Message or Create Result Message window, enter the
following parameters:
Description: A description of the Message.
Name: The name of the Message.
FormatName: Do not use.
MessageFormat: The actual format of the message data: CSV, TSV, TXT, XML.
MessageType: The type of message: Get, Put, Update, Delete, Result.
2.
CONFIDENTIAL
86
DATASOURCES
Namespaces
A Namespace is a unique user-defined category that identifies the entity.
To add a Namespace:
1.
From the Data Dictionary menu, click Add > Namespace.
2.
In the Create new Namespace window, enter the following details:

Description: A description of what the Namespace is to be used for.
Name: The term by which you want to identify the Namespace.
3.
Click OK.
4.
Click the Save
The new Namespace appears in the relevant drop-down lists.
Units
Units are used by the BabelFish Explorer to label a tag with a standard of measurement
relevant to the process it represents. The units themselves are treated by BabelFish as
labels, as the Calculation Engine does not perform unit conversion or automatic
aggregation.
Units are automatically added when tags are imported, and may be added to on an ad-hoc
basis.
To add a unit:
CONFIDENTIAL
87
1.
From the Data Dictionary menu, click Add > Units.
2.
In the Create new units window, enter the following details:
DATASOURCES
Description: A description of what the unit is to be used for.

Name: The term by which you want to identify the unit. For example, Tonnes / hr.
3.
Click OK.
4.
Click the Save
The new unit appears in the relevant drop-down lists.
Time Zones
If you have servers or data sources located in different time zones, you can specify them
here to make sure all data is correctly synchronised and labelled, allowing your reports to
be more accurate.
To add a time zone:
1.
From the Data Dictionary menu, click Add > Time Zone.
CONFIDENTIAL
88
2.
DATASOURCES
In the Create Time Zone window, enter the following details:

Description: A description of the time zone.
Name: The term by which you want to identify the time zone. For example, GMT.
DaylightSavingsFinish: The date that Daylight Savings Time finishes for this time
zone.
DaylightSavingsStart: The date that Daylight Savings Time starts for this time zone.
DaylightSavingsUtcOffset: The time offset (in hours) from Coordinated Universal
Time (or Greenwich Mean Time), when this time zone is experiencing daylight
savings. For example, +6.
UtcOffset: The time offset (in hours) from Coordinated Universal Time (or Greenwich
Mean Time). For example, -5.
3.
Click OK.
4.
Click the Save
The new time zone appears in the relevant drop-down lists.
Edit a Datasource
Editing a Datasource allows you to modify the properties of the Datasource, as well as
adding templates and tags.
To edit the properties of a Datasource:
1.
Select the Datasource in the data source hierarchy.
CONFIDENTIAL
89
DATASOURCES
The Datasource properties are displayed in the Properties tab to the right.
2.
Edit the following parameters as required:

Name: The name of the Datasource. This is what appears in the navigation hierarchy
on the left.
Description: Description of the purpose of the Datasource.
DataSourceType: Select the Data Source Type to which the Datasource belongs. This
is the list of Data Source Types that appears in the navigation hierarchy.
SupportsGMTOffset: True or False. Specify whether or not the Datasource supports
GMT offset.
3.
When you have finished editing, click the Save
button to save your changes.
You can also edit the Datasource Template (see page 91) and Datasource Tags (see page
94).
CONFIDENTIAL
90
DATASOURCES
Datasource Template
The Data Source Template tab allows you to edit the values of properties and attributes of
the template (see page 101) associated with the Datasource. You can also change the
Datasource to use a different template or remove the current template association.
All Datasource templates also appear in the Templates Hierarchy (see page 102) in the
Data Source template group, where you can further edit properties, attributes, and
renderers (see page 109).
Properties and attributes are different for each template, and are defined when the
Datasource is first created. You cannot add further properties or attributes to the
template.
You can edit properties directly in the grid of the Data Source Template tab. However, the
TAG_PREFIX, CONFLICT_PREFIX, and CONFLICT_SUFFIX properties are edited by clicking on
the
button.
Note: Changing the TAG_PREFIX will result in all Data Dictionary and BabelFish Explorer
entities being renamed. If there are a large number of entities to rename, this may
take some time.
If required, you can change the template associated with the Datasource. To do this:
CONFIDENTIAL
91
1.
Click the New Template
2.
At the message, click Yes.
DATASOURCES
button.
The Template Instance Form appears.
3.
In the Template Instance Form, select Create New Template.

This allows you to create a completely new template for this Datasource.
4.
Enter the following parameters:

Name
The name of the template you want to create.
Description
A description of the purpose of the template.
CONFIDENTIAL
92
DATASOURCES
Template
You can base this template on another template. If you do this, the new template
will inherit the characteristics of the selected template, however you can give it a
different name, description, and icon.
Icon
Select the icon you want to represent this template:
Default, ePlant Tag
Facility
Namespace
Profile
Processes
Property
Page Renderers.)
Datasource type
Message
Component
Adaptor
Builder
Parser
Accumulator
Company
Process
Drawing
Unit
Compressor
Meter Point
Tags, ePlant Tag
Web Report
Well
Satellite
ePlant Trend
ePlant Page
Project
5.
Click OK in the Template Instance Form to change the template.
CONFIDENTIAL
93
DATASOURCES
Data Source Tags

The Data Source Tags tab displays the entities that are associated with the Datasource.
Double-clicking on an entity in the list allows you to view and change the properties of the
entity (see page 48).
Delete a Data Source

When you delete a Datasource from Enterprise Manager, you can choose to remove only
the Datasource, or remove both the Datasource and associated entities.
To delete a Datasource:
CONFIDENTIAL
94
DATASOURCES
1.
Right-click on the Datasource in the hierarchy, and select Delete.
2.
In the confirmation window, you can choose to also delete associated entities. This
is the default.
Note: If you do not want to delete associated entities, then clear the Delete Entities
check box.
3.
Click Delete to proceed.
Check for New Tags

Checking for new tags is a simple way to import data points (often called tags in the case
of historians) from a Datasource. You can use this to import tags for the first time, or you
can use it to routinely import any new tags that may have been added to the Datasource
after the initial BabelFish installation. For each new tag, a new entity is created, and these
are added to the Data Sources hierarchy.
Note: Not all Adaptors support the retrieval of tags. A message will appear if checking for
new tags is not supported.
CONFIDENTIAL
95
DATASOURCES
This procedure should be completed for each Datasource in your system except BabelNet,
as BabelFish Explorer now keeps BabelNet synchronised. To import tags for a Datasource:
1.
In ISS Enterprise Manager, expand the Data Sources node.
2.
Expand the Adaptor for which you want to import tags, and right-click on the
Datasource for that Adaptor. For example, the Capture Data Source.
3.
Select Check for New Tags
The Tag Import Wizard appears.

4.
Click Next to continue.

The Add Entity Templates window allows you to associate an Entity Template with
the imported tags. This step is optional.
CONFIDENTIAL
96
DATASOURCES
From the templates list, select the templates you want to associate with the
imported tags. You can filter the templates by template type or template group, and
you can select more than one template.
As you select the templates, they are added to the Templates to be associated with
each tag list, which displays only the selected templates. If you want to remove
templates from the list, first clear the appropriate check box, and then click the
Update link.
5.
When you have finished associating Entity Templates, click Next.

The Add Request Templates window allows you to associate a Request Template
with the imported tags. This step is optional.
A Request Template defines the properties and attributes that belong to a Request
profile, and specifies how to make requests from a Datasource during data fetches
and tag refreshes.
From the templates list, select the Request Template you want to associate with the
imported tags. You can filter the templates by template type or template group. You
can only associate one Request Template.
As you select the template, it is shown in the Templates to be associated with each
tag field, which displays only the selected template. If you want to remove this
template from the field, first clear the appropriate check box from the template list
above, and then click the Update link.
6.
When you have finished associating a Request Template, click Next.
CONFIDENTIAL
97
DATASOURCES
The Enter Tag Name & Filter Entity Details window appears.
7.
In the Filter Details group, specify a filter for the tags fetched from this Datasource.
If you only want to fetch one tag from the source system, then enter the tag name in
here.
If you want to fetch multiple tags, but not all, you will need to use a wildcard, which
is represented by an asterisk. For example, a filter of AUS.PERTH* will return all tags
which have a name beginning with "AUS.PERTH".
If you want all tags to be returned by the fetch, do not specify a filter.
Note: The filter or wildcard may not be an available feature for all Adaptor types.
8.
In the Entity Details group, specify the import-wide entity details. This information is
used when determining whether or not an entity needs to be updated. The
parameters are:
Namespace
The namespace of the entity.
Location
The location of the entity.
Primary Template
The main Entity Template to associate with the entity.
Enabled
Allows the entity to be displayed in BabelFish Explorer.
CONFIDENTIAL
98
DATASOURCES
Create new units...

Create new units for any entity whose units do not exist in the Data Dictionary. For
example, if an entity needs to specify kilometres per hour and this was not present
in the Data Dictionary, then this unit would be created.
Create new namespaces...
Create new namespaces for any entity whose namespaces do not exist in the Data
Dictionary.
9.
In the Update Options group, specify the parameters that are to be updated. The
parameters are: Ranges, Descriptions, Units, Namespaces, and Profiles.
10.
When you are finished, click Next.

A progress window opens while the tags are being loaded from the Datasource.
Note: If an error occurs indicating an "invalid class string", then this indicates that
the COM component for the Adaptor is not registered. Refer to the Adaptor
installation manual for registration instructions. If the error occurs with one of the
built-in Adaptors, follow this procedure:
a. Open the folder for the Adaptor requiring registration, and note the full path of
the Adaptor DLL file on the BabelFish server (it will be something like C:\ Program
Files (x86)\ ISS\ BabelFish\ Data Acquisition\ Adaptors\ <adaptor name>).
c. Open a command prompt.
d. Change to the directory containing the Adaptor DLL: cd c:\ Program Files
(x86)\ ISS\ BabelFish\ Data Acquisition\ Adaptors\ <adaptor name>
e. Type: regsvr32 [dll name]
f. Restart the ISS Adaptor Pool service.
CONFIDENTIAL
99
DATASOURCES
When the tags have finished being loaded, they are displayed on the New &
Modified Tags tab.
By default, all new tags are selected for importing into the BabelFish Data Dictionary.
11.
If you do not want to import some of the new tags, clear the corresponding check
box.
The Existing Tags tab shows the tags that already exist in the BabelFish Data
Dictionary, and the Errors tab shows any errors that occurred while fetching the
tags.
Note: To select or clear multiple tags in the list at once, select the entities by
pressing the CTRL key as you click the tags, then press the space bar to select or
clear them.
12.
When you are happy with the tags selected for import, click Next.
13.
Click Finish to start the tag import.

A progress window opens as the tags are imported.
14.
When the import is finished, click the Save

toolbar.
button in the Enterprise Manager
Repeat the above procedure for each Datasource in your system. After you have imported
all the tags from all your Datasources, you should test that the tags appear correctly in
BabelFish Explorer.
CONFIDENTIAL
100
TEMPLATES
Templates
Entities and Datasources in the Data Dictionary are able to have templates assigned to
them. A template is a placeholder for properties and attributes that define a category of
entities or Datasources. It only defines what the properties and attributes are, not their
values or referenced entities.
The template defines the properties and attributes that Profiles derived from it should
have. When a template is defined in BabelFish, properties and attributes must be specified
separately in the Profile. The reason for this is that when the template is then applied to
an entity, the value for an attribute must be a reference to an actual entity (either
calculated or one obtained from an external data source).
A Profile is a Template Instance that can be applied to an item in BabelFish. Profiles are
most commonly applied to entities. What the Profile stores depends on the template and
its intended usage. For an entity, a Profile would store additional information about the
entity that cannot be stored in the standard entity structure. These are typically things
that are used or required by some other system, such as an historian.
When you assign a template to something in BabelFish, a Profile is created off of that
template. Thus, the Profile automatically gets the same set of attributes and properties as
what the template has, and their values are set to some kind of default (depending on the
DEFAULT_VALUE from the relevant template attribute or template property).
A Profile then defines what the attributes and properties are for the item that it has been
assigned to.
So a template might specify that something has attributes A1 and A2, and properties P1
and P2. You assign the template to an entity. You then give the created Profile values from
A1, A2, P1, and P2 as required.
Except for managing the templates themselves, any time you do something with a
template, you are actually manipulating the Profile.
In a nutshell, a template defines what attributes and properties something has, but
doesn't define what they actually are. This is why templates dont have ENTITY_ID (profile
attributes) or PROPERTY_VALUE (profile properties).
It is possible to configure BabelFish pages that bind to a template (see page 143) rather
than a concrete instance of an entity.
For example, consider generic well screens where a single BabelFish page is bound to the
attributes of a generic well template. Using one BabelFish page, you can view values,
trends, and so on, for any chosen well entity as long as it has the generic well template
applied to it.
CONFIDENTIAL
101
TEMPLATES
Template Tokens
Template tokens are properties that are defined on a per template basis as inputs required
to set default values for other template attributes and properties. They are stored in the
Data Dictionary as template properties. Template tokens are distinguished from other
properties by having a TEMPLATE TOKEN property type.
Any property defined as a Template Token appears in the token list when you edit the
template property.
For a list of available keywords, refer to the BabelFish Calculation Engine Reference.
Templates Hierarchy
The Templates hierarchy in Enterprise Manager displays the templates configured in the
BabelFish Data Dictionary, organised by template groups (see page 102).
This template hierarchy allows users to see all of the templates configured in the BabelFish
Data Dictionary, including their properties, attributes, and renderers (see page 124).
Template names can be changed, properties and attributes can be added or removed, and
renderers can be configured.
Add a Template Group to the Hierarchy

The templates configured in the BabelFish Data Dictionary are displayed in a template
hierarchy (see page 102) organised by template group.
To add another group node to the Templates hierarchy:
1.
Right-click on the Templates node in the Data Dictionary navigation hierarchy.
CONFIDENTIAL
102
TEMPLATES
2.
From the menu, select Add and then click New Template Group (Add > New
Template Group).
3.
In the Create new template group window, type the group name, a description, and
select an icon.
Note: The name entered must be unique. If a non-unique name is entered, a warning
appears and you need to enter an alternative name before the template group can
be created.
4.
Click OK.
The new template group is added to the Templates hierarchy.
Create a Template
A template defines the properties and attributes that belong to a profile. It defines what
the properties and attributes are, but not their values or associated entities.
To create a template:
1.
Expand the Data Dictionary > Templates node and right-click on the template group
in which you want to add the new template.
CONFIDENTIAL
103
2.
TEMPLATES
From the menu, click Add and then click New Template.
The BabelFish Template Wizard appears.

3.
In the BabelFish Template Wizard, click Next to start defining the new template.
4.
In the Select Template Type screen, select the Template Type and click Next.
There are four types of templates:

Data Source Connection Parameters: Used by Datasources.
Entity types: Used by entities.
Metadata Collections: Associate defined metadata groups with entities.
Request Information: Used to create Request Templates.
CONFIDENTIAL
104
5.
TEMPLATES
In the Template Details window, enter the following parameters:
Name: Unique name of the new template.

Description: A description of what the template is to be used for.
Icon: From the drop-down list, choose the icon for the template. You should use the
Template
icon, unless you have a reason for choosing another one.
6.
Click Next.
7.
In the Select Template Properties screen, select the properties you want to include
in the template.
CONFIDENTIAL
105
TEMPLATES
Properties are placeholders for static values, such as maximum and minimum range,
pump name, server name, or document location.
If the property does not exist, you can create a new property (see page 112) by
clicking the New Property button.
8.
After you have selected all the properties to include on the template, click Next.
If you have selected one or more properties, you are provided with the opportunity
to specify default values for the selected properties.
9.
a.
For each property, enter the value you want to use as the default. If you want
to use a token property, either type in TEMPLATE_TOKEN(token name) or click
the
button next to the property to choose from a list.
b.
When you have entered all the default values, click Next.
In the Select Template Attributes screen, select the attributes for the template.
Attributes are placeholders for dynamic data and reference other entities within
BabelFish. For example, Choke Position, Meter Run Differential Pressure, or Flow
Rate.
CONFIDENTIAL
106
TEMPLATES
If the attribute does not exist, you can create a new attribute (see page 116) by
clicking the New Attribute button.
10.
After you have selected all the attributes to include on the template, click Next.
If you have selected one or more attributes, you are provided with the opportunity
to specify default values for the selected attributes.
11.
a.
For each attribute, enter the value you want to use as the default. If you want
to use a token property to develop the entity name, either type in
TEMPLATE_TOKEN(token name) or click the
button next to the attribute to
choose from a list.
b.
When you have entered all the default values, click Next.
Click Finish to create the template.
CONFIDENTIAL
107
12.
TEMPLATES
The new template appears in the Templates hierarchy beneath the selected
template group.
Creating a Template Outside a Group

Enterprise Manager allows you to create a template in several ways, not just from
right-clicking on an existing template group (see page 103).
When invoked from a different location (such as from within an Entity Definition or from
the Data Dictionary menu) the Template Wizard asks for the template group to which you
want to add the template, and also offers you the opportunity of creating a new template
group (see page 102) if required.
1.
Invoke the Template Wizard from any location, and click Next.
2.
In the Select Template Type screen, select the Template Type and click Next.
Note: If you intend to use the template with entities, you should use the Entity
Types template type.
CONFIDENTIAL
108
3.
TEMPLATES
In the Select Template Group screen, select the Template Group in which you want
to place this Template.
Note: If the Template Group does not exist, you can create it by clicking the New
Template Group button.
4.
Click Next.
5.
Continue through the rest of the wizard as described in Create a Template (see page
103).
The new template appears in the template hierarchy beneath the selected template group.
Edit a Template
When you click on a template in the Data Dictionary navigation hierarchy, the Properties
tab is activated in the window on the right.
The Properties of the template describe the characteristics of the template.
To edit a template, select the template in the template hierarchy and then change
the fields as required.
CONFIDENTIAL
109
TEMPLATES
The Properties tab allows you to edit the following parameters:
Description: The description of what the template is used for.
Name: Name of the template.
Icon: The icon to use for this template. Choose from:

Default, ePlant Tag
Facility
Namespace
Profile
Processes
Property
Page Renderers.)
Datasource type
Message
Component
Adaptor
Builder
Parser
Accumulator
Company
Process
Drawing
Unit
Compressor
Meter Point
Tags, ePlant Tag
Web Report
Well
Satellite
ePlant Trend
ePlant Page
Project
CONFIDENTIAL
110
TEMPLATES
TemplateGroup: Select the Template Group (see page 102) in the hierarchy that this
template belongs to. The groups available with a default installation are: Wells,
Default, Reports, BabelFish, ePlant, Data Source, External Content Providers.
TemplateType: Choose the type of template. The types available by default are:
Entity Types, Request Information, Data Source Connection Parameters, and
Metadata Collections.
You can also edit the:
Template Properties (see page 111)
Template Attributes (see page 115)
Template Renderers (see page 119)
Template Properties
Properties are placeholders for static values, such as maximum and minimum range, pump
name, server name, document location, and so on. Properties may also be used by custom
applications that create value-added functionality to BabelFish, such as an ASP page that
runs inside BabelFish Explorer, or a Windows program that allow you to use entities,
properties, and so on. For further information on creating custom applications, refer to the
BabelFish SDK Developer's Guide.
Template Properties are properties assigned to this template that are inherited by entities
associated with this template.
To add a property to this template, click the Add Property (see page 112) button.
To edit an existing property, first click on the property in the list and then click the
Edit (see page 114) button.
CONFIDENTIAL
111
TEMPLATES
To remove a property from the template, first click on the property and then click
the Delete button.
To update the list of properties, click the Refresh button.
Add Template Property

To add a property to a template:
1.
Select the template, click the Template Properties tab and then click the Add
Property button.
The Select Properties window lists all the properties that are available and may be
2.
In the Select Properties window, you can either select an existing property to
associate with the template, or create a new property.
Note: If you want to edit an existing property from here, first click on the property
and then click the Edit
icon.
CONFIDENTIAL
112
TEMPLATES
If you want to add a new property:

a.
Click the Add Property
button.
b.
In the Create new Property window, enter the following parameters:
Description: A description for what the property is used for.

Name: The name of the property.
AllowUserExtent: Deprecated, do not use.
HasSelectStatement: Deprecated, do not use.
PropertyType: The type of property. Available options are:
Property
Description of the property value
String
Any alphanumeric sequence, such as a word.
Password
An alphanumeric string that is intended to be used as a secure

password.
Float
A floating point number.
Integer
An integer number.
Select
An SQL SELECT statement.
Reference
A reference to a document stored somewhere, such as C:\ Docs\

MyDoc.doc.
ISO-8601
A date and time string (ISO-8601 is an international standard for

date and time representation).
Insert
An SQL INSERT statement.
Update
An SQL UPDATE statement.
Delete
An SQL DELETE statement.
SQL Param
The property is an SQL parameter.
Template Token The property is to be used as a template token.
CONFIDENTIAL
113
TEMPLATES
For example, if you had a property called MY_DATE you could use ISO-8601.
c.
3.
In the Select Properties window, select the property to use, and then click OK.
You can edit the template property (see page 114) at any time after you add the property.
Edit Template Property

Editing a template property allows you to change the default value for the template
property, and specify if the property is to be masked or encrypted.
To edit a template property:
1.
In the Template Properties tab, click on the property name.
2.
Click the Edit button.
3.
In the Template Property Default Value window, you can change the following
parameters:
Default Value: The value the property should have if an alternative value is not
specified. You can type any alphanumeric string or number, or enter a template
token displayed in the list. The template token must take the form of
TEMPLATE_TOKEN(token name).
Encrypted: Encrypts the property for added security. If selected, an X appears in the
Encrypted column.
Masked: Hides the default value with an asterisk (*). If selected, an X appears in the
Masked column, and the Default Value is hidden with an asterisk (*).
CONFIDENTIAL
114
TEMPLATES
Note: If you select Encrypted or Masked, Enterprise Manager needs to update all the
associated records and will prompt you for confirmation to proceed. If you choose to
proceed, a progress bar will be displayed while the update is in progress. Click OK
when the update has finished. Be aware that this may take several minutes.
4.
Click OK.
Template Attributes
Attributes are placeholders for dynamic data, and reference other entities within
BabelFish. For example, Choke Position, Meter Run Differential Pressure, Flow Rate, and so
on.
Attributes are a good way of creating associations between related entities. For example,
wells have related pressure, temperature, and choke size entities. These can be related to
the well entity using template attributes.
The Template Attributes tab displays the attributes of the template.
CONFIDENTIAL
115
TEMPLATES
To add an attribute to this template, click Add attribute (see page 116).
To edit an existing attribute, click on the attribute in the list and then click Edit (see
page 117).
To remove an attribute from the template, click on the attribute and then click
Delete.
To update the list of attributes, click Refresh.
Add Attribute
To add an attribute to a template:
1.
Select the template, click the Template Attributes tab, and then click the Add
attribute button.
The Select Attributes window lists all the attributes that are available and may be
CONFIDENTIAL
116
2.
TEMPLATES
In the Select Attributes window, you can either select existing attributes to
associate with the template, or create a new attribute.
Note: To select multiple attributes, press and hold the CTRL key as you click each
attribute you want to add.
If you want to create and add a new attribute:
a.
Click the New Attribute
button.
b.
In the Create new attribute window, enter the following parameters:
Description: A description for what the attribute is used for.

Name: The name of the attribute.
Icon: Choose an icon from the list.
c.
3.
In the Select Attribute window, click OK after you have selected the attributes.
You can edit the attribute (see page 117) at any time after you add the attribute.
Edit Attribute
Editing an attribute allows you to change the default value for the template attribute.
To edit a template attribute:
1.
In the Template Attributes tab, click on the attribute name.
CONFIDENTIAL
117
TEMPLATES
2.
Click Edit.
3.
In the Template Attribute Default Value window, you can change the Default Value
field. This is the value the attribute should have if an alternative value is not
specified. You can type any alphanumeric string or number, or enter a template
token displayed in the list. The template token must take the form of
TEMPLATE_TOKEN(token name). The string should represent the name of the entity
that should be associated with the attribute when none has been specified.
4.
Click OK.
Renaming an Attribute
To rename an existing attribute:
1.
Select the template, click the Template Attributes tab, and then click the Add
attribute button.
CONFIDENTIAL
118
TEMPLATES
2.
In the Select Attributes window, select the attribute you want to rename, and then
click the Edit
button.
3.
In the Edit object window, make the required changes and then click OK to save the
change to the database.
4.
Back in the Select Attribute window, click Cancel, because the attribute already
exists in the Data Dictionary.
Template Renderers
Template-level renderers (see page 124) are useful where all entities that are associated
with a template are to be displayed using the same content provider (renderer), such as
Word document entities. Configuring a renderer at the template level saves having to
associate a renderer with each individual entity.
In special cases where there is a need for an entity to have additional rende rers to that
configured for the entity template, a renderer can be associated with the entity (an Entity
Renderer). The primary and default settings configured on Entity Renderers will override
the primary and default settings of template level renderers.
CONFIDENTIAL
119
TEMPLATES
The Renderers tab displays the Renderers associated with the template.
To add a renderer (see page 120) to this template, click Add Renderer.
To edit an existing renderer (see page 123), click on the renderer in the list, make
the changes, and then click Save on the toolbar.
To remove a renderer from the template, click on the renderer and then click
Delete.
Assign a Renderer to a Template

You can assign renderers three ways:
Add a new renderer.
Link to an existing renderer.
Add a renderer that is a copy of an existing renderer.
To add a renderer to a template:

1.
In the Templates node, select the template.
CONFIDENTIAL
120
2.
Click the Renderers tab.
3.
Choose the type of renderer you want to add.
TEMPLATES
Add a New Renderer

a.
Click New.
b.
The Renderer Wizard form appears in the previously empty area, with a
default name for the new renderer.
Link to an Existing Renderer

c.
Click Add Existing.
CONFIDENTIAL
121
TEMPLATES
d.
Select the renderer you want to link to. This uses an instance of the selected
renderer.
e.
Click OK.
Copy an Existing Renderer

f.
Click Add Existing.

g.
CONFIDENTIAL
122
TEMPLATES
h.
Select the Copy Selected Renderer check box. This copies the properties of the
selected renderer into a new renderer of the specified name.
i.
In the Name field, change the default renderer name.
j.
Click OK.
4.
Fill in the remaining fields in the renderer form.
5.
Click Save
You can edit the renderer (see page 123) at any time after you add the renderer. However,
if you have selected the Link option, any changes you make will affect all entities and
templates that this renderer is linked to.
Edit a Template Renderer

Editing a renderer allows you to change any of the renderer's details, except for the name.
However, be aware that any changes made will also apply to other entities and templates
using this renderer.
To edit a template renderer:
1.
Select the template, click the Renderers tab and then select the renderer to edit.
2.
In the Renderer form, edit the properties as required.
3.
Click Save
Delete a Template
To delete a template:
1.
Right-click on the template in the Data Dictionary navigation hierarchy.
2.
Select Delete from the menu.
The template is removed from the BabelFish Data Dictionary.

Note: The properties and attributes associated with the template are not removed from
the BabelFish Data Dictionary. It is only their relationship with the template that is
deleted.
CONFIDENTIAL
123
RENDERERS
Renderers
A renderer (also known as a Content Provider) displays content related to an entity. For
example, the provider for a Word document entity is Microsoft Word, and the provider
for a tag is the BabelFish Explorer Tag Details screen.
The renderer functionality in BabelFish works on three separate levels. You can assign a
renderer at the:
ENTITY level
TEMPLATE level
ENTITY DATA TYPE level Renderers can either be marked as:
Primary
Default primary
The difference between PRIMARY and DEFAULT PRIMARY is as follows.

Primary means that the renderer is the primary renderer for the particular Renderer
Purpose (detail or display are the most common ones). As a result, you can have multiple
primary renderers associated with an entity, but only one should be primary for each
renderer purpose.
Default Primary means that the renderer is the primary renderer when you ask for a
renderer purpose of DEFAULT. Therefore, you would expect to only have one of these
associated with a particular entity, because the renderer purpose is predefined.
P RE C E D E N C E
The precedence order of renderers is from least reaching to most reaching:
Entity > Template > Entity Data Type
If BabelFish finds a suitable renderer at a particular level, it will not add it again from levels
lower down. For example, if it finds a renderer at the Entity level, and the same renderer
at the Entity Data Type level, the entity level renderer is the one that is used.
Additionally, template renderers (see page 119) can make use of profile properties (a
collection of profile properties is often called a property bag) in order to achieve
replacements on the URL string.
For example, profile(profile$property) or profile(profile:attribute). This is similar to the
tag() syntax.
O RD E RI N G
In the Table Of Contents (TOC), you can order the Renderer groups and each of the
renderers within those groups. Ordering is done by specifying an ordinal (a number
specifying the order in which the renderer is to appear in the list, with 1 being the first in
the list) for each renderer. If no ordinal is specified, it defaults to an alphabetical order. If
two or more renderers have the same ordinal, then ordering is based on the Display Name.
Null ordinals appear at the end of the list.
CONFIDENTIAL
124
RENDERERS
Create a Renderer
Renderers are created through a wizard, which can be opened from either the Enterprise
Manager toolbar or from the Renderer hierarchy.
1.
Open the Renderer Creation Wizard:
From the Data Dictionary menu, select Add and then click Renderer.
Right-click on the Renderer Type in the Data Dictionary hierarchy, and select
Add > New Renderer.
The Renderer Creation Wizard opens.
CONFIDENTIAL
125
RENDERERS
The window displayed here is also displayed in the Renderers tab of entities and
templates.
2.
In the Name field, type the name for the new renderer. Maximum length is 50
characters.
If an existing renderer that is similar to the one you want to create, click the Copy
Renderer
button.
In the Select Renderer screen:

a.
CONFIDENTIAL
126
RENDERERS
b.
Type a unique name. Maximum length is 50 characters.
c.
Click OK.
This copies the properties of the selected renderer into a new renderer of the
specified name.
3.
Enter the following details:

Primary: Select this option if you want to mark the renderer as the Primary Renderer
for the specified Renderer Purpose.
Default: Select this option if you want to mark the renderer as the Primary Renderer
when the Renderer Purpose is set to DEFAULT.
Display Name: The name to be used to specify the ordering if the ordinal for this
renderer is duplicated or not specified. This corresponds to the Friendly Name from
the renderer's parameter and is the name that is used for the renderer in the Table
of Contents. Maximum length is 2000 characters.
Description: A description of the purpose of the new renderer.
Icon: Select the icon that is to be used to represent the renderer. Choose from:
Default, ePlant Tag
Facility
Namespace
Profile
Processes
Property
Page Renderers.)
Datasource type
Message
Component
Adaptor
Builder
Parser
Accumulator
Company
Process
Drawing
Unit
Compressor
Meter Point
Tags, ePlant Tag
Web Report
Well
Satellite
ePlant Trend
ePlant Page
Project
Group: Choose the Renderer Group that this renderer belongs to. The default is
Portal. If you want to create a new Renderer Group (see page 131), click the
button.
Type: Choose the type of renderer. The default is Web. If you want to create a new
Renderer Type (see page 133), click the
button.
CONFIDENTIAL
127
RENDERERS
Purpose: Choose the purpose of this renderer. The default is Detail.

URL: Type the URL for the Renderer Type.
Ordinal: The order in which this renderer should be displayed in the BabelFish
Explorer Table of Contents. This appears in ascending order. Renderers with null
ordinals appear at the end of the list.
Parameters: Click View to display or edit the parameters for the renderer. The
parameters will differ depending on the renderer type chosen for the renderer when
it was first created. Most Renderers will be created using the Web Renderer type
and will therefore have parameters of Friendly Name and URL. You do not need to
use this if the only parameters are Friendly (Display) Name and URL.
Note: The URL for the default primary renderer is similar to this example:
/eplant/default.asp?page_id=2&SIMPLE
COMPRESSOR=tag(this|Name)
/eplant/default.asp?page_id=2 is the standard URL to a BabelFish Explorer

page. Update the actual Page ID as appropriate.
Update SIMPLE COMPRESSOR with the name of the template. This is used at
runtime to specify which SIMPLE COMPRESSOR is displayed when the page is
loaded.
The syntax of tag(this|Name) is replaced at runtime with the name of the
entity to which the template is assigned. This should not be updated.
Note: This also allows you to use the EP_TEMPLATE() keyword in BabelFish
Explorer. Using this example, a label on a page would have the text
EP_TEMPLATE(SIMPLE COMPRESSOR). It is recommended that you use the
name of the template in the EP_TEMPLATE keyword this, but can be changed.
For example,
/eplant/default.asp?page_id=2&SIMPLE COMPRESSOR=tag(this|Name)
could just as easily be:
/eplant/default.asp?page_id=2&SCOMP=tag(this|Name)
BabelFish Explorer references EP_TEMPLATE(SCOMP). The advantage of using
the template name is that this is the default when the template parameters
and attributes are dragged onto a page in Design mode.
4.
Click Finish.
5.
Click Save
CONFIDENTIAL
128
RENDERERS
Edit a Renderer
You can edit a renderer from three places in ISS Enterprise Manager:
The Renderers node in the Data Dictionary hierarchy.
The Renderers tab for an entity in the Entity Hierarchy.
The Renderers tab for a template in the Templates node.
R E ND E RE R S N OD E
1.
Click on any renderer in the Renderers node of the Data Dictionary hierarchy.
2.
Make any changes needed to the properties in the Properties tab.
3.
Click Save
in the Enterprise Manager toolbar.
R E ND E RE R S T A B
Both entities and templates contain a Renderers tab, where you can edit renderers for
those entities and templates. Note that when you make a change here, you also make the
change for all other entities and templates using that renderer.
1.
Click on any entity in the Entity Hierarchy.

OR
Click on any template in the Templates node.
2.
Select the Renderers tab.
CONFIDENTIAL
129
3.
Select the renderer you want to edit.
4.
Make any changes you require.
5.
Click Save
RENDERERS
in the Enterprise Manager toolbar.
Delete Renderer
You can only delete renderers that are not being used.
To delete a renderer, right-click on the renderer in the Renderers node, and select
Delete.
CONFIDENTIAL
130
RENDERERS
Create a Renderer Group

You can create a new Renderer Group in two main ways:
Create or edit an existing Renderer.
Right-click on Renderers in the hierarchy and select Add > New Renderer Group.
Both methods open the Add New Renderer Group form.

1.
In the Add New Renderer Group window, type a name and description for the
group, and specify an ordinal for where the group is to appear in the Table of
Contents.
2.
Click OK.
3.
Click Save
Note: Clicking Save on the Enterprise Manager toolbar ensures that the group is properly
created and that subsequent renderers can be properly associated with it.
CONFIDENTIAL
131
FROM
THE
RENDERERS
R E ND E RE R W IZ A RD
You can also create a new Renderer Group from within the Renderer Wizard.
1.
From the Renderer Wizard, click the
button next to the Group field.
2.
In the Add New Renderer Group window, type a name and description for the
group, and specify an ordinal for where the group is to appear in the Table of
Contents.
3.
Click OK.
You are returned to the Renderer Wizard.
4.
Fill in the rest of the details for the renderer you want to create.
5.
Click Save
CONFIDENTIAL
132
RENDERERS
Edit Renderer Group

To edit a renderer group:
1.
Click on the group in the Renderers node in the hierarchy.
2.
In the Properties tab, make the required changes.
Delete Renderer Group

You can only delete renderer groups that are not being used.
To delete a renderer group, right-click on the group in the Renderers node, and
select Delete.
Create a Renderer Type

The majority of renderers are calls to web URLs or file paths, so they will usually only
require the default Friendly Name and URL renderer types. However, you can add
renderer types to provide further contextual meaning for your organisation, and you can
also use them in custom applications created through the BabelFish API.
To create a new Renderer Type, you first need to create a Renderer (see page 125), or you
can edit an existing one.
1.
From the Renderer Wizard, click the
button next to the Type field.
CONFIDENTIAL
133
RENDERERS
2.
In the Create Renderer Type window, type a name for the type of renderer, and
provide a description for the renderer type.
3.
In the Parameters list, select the type of parameter, or create a new one (see page
134).
URL: The URL that is used to invoke the object when the user double-clicks the
renderer from the Table of Contents in the Plant Model Tree. For example,
file://docs/myworddoc.doc, or
/eplant/bin/tag_detail.srf?tagname=tag(this|FriendlyName). Note that there is
some support for replacement tokens in parameters. For example, tag(this|Friendly
Name) is replaced by the friendly name of the tag in the URL when it's used to
display the tag. Replacement tokens do not apply to Microsoft Word and other
similar renderers. For more information on replacement tokens, refer to the
BabelFish Explorer User's Guide.
Friendly Name: The name of the renderer that is displayed in the Table of Contents
in the Plant Model Tree.
4.
Click OK.
You are returned to the Create new Renderer window, where you can fill in the rest
of the details for the renderer you want to create.
Create a Renderer Parameter

Renderer parameters allow you to create a named value for a specified parameter for a
renderer.
To create a new Renderer Parameter, you first need to create a Renderer Type (see page
133), or you can edit an existing one.
CONFIDENTIAL
134
IMPORT AND EXPORT
1.
From the Create Renderer Type window, click the New Parameter button.
2.
In the Create Renderer Parameter window, type a name for the renderer parameter,
and a description of what it does.
3.
Click OK.
Import and Export

You can export data in the BabelFish Data Dictionary to XML files for importing into other
data dictionaries. Exports can be based on a Datasource, an entity hierarchy, or the whole
Data Dictionary.
Exporting Data
The Export function allows you to export the entire Data Dictionary or selected
Datasources and Entity Hierarchies.
Note: Data Dictionary exports only deal with Data Dictionary objects such as entities,
templates, profiles, and renderers. Any Portal Calculation tags or Portal SQL tags will
not be exported as part of this process.
Enterprise Manager provides you with two ways by which you can export data:
CONFIDENTIAL
135
IMPORT AND EXPORT
Selecting Export from the Data Dictionary menu (Data Dictionary > Export).
Right-clicking in the Navigation Hierarchy and selecting Export.
Both methods open the Data Dictionary Export window, from which you can choose to
export:
Entity Hierarchies (see page 138)
Datasources (see page 138)
The entire Data Dictionary (see page 137)
Note: Take care when creating an entity hierarchy, as recursive hierarchies may cause data
export to fail.
CONFIDENTIAL
136
IMPORT AND EXPORT
Export All
To export all data from the Data Dictionary:
1.
Select Export
2.
In the Data Dictionary Export window, make sure the Export All tab is active.
3.
In the Output File field, type the full path and name of the file in which you want to
save the data, or click the
button to navigate to it.
4.
Select or clear the check boxes to choose the fields you want to export.
5.
Click Export.
If the output file does not exist, a message appears asking if you would like to create
it. Click Yes.
The progress of the export appears in the Export Status field.
CONFIDENTIAL
137
IMPORT AND EXPORT
Export an Entity Hierarchy

You can export a single Entity Hierarchy, or several.
1.
Select Export
from the Data Dictionary menu, or right-click on the Entity
Hierarchy and select Export.
2.
In the Data Dictionary Export window, select the Entity Hierarchy Export tab.
3.
If you right-clicked on the Entity Hierarchy you want to export, it is selected by

default. Otherwise, select it.
4.
From the list, select any additional Entity Hierarchies you want to export.
5.
6.
Click Export.
If the output file does not exist, a message appears asking if you would like to create
it. Click Yes.
Export a Datasource
Exporting a Datasource involves exporting all its entities, templates, and their
dependencies (properties, attributes, profiles, and so on). You can export a single
Datasource, or several.
1.
Select Export
from the Data Dictionary menu, or right-click on the Datasource
and select Export.
CONFIDENTIAL
138
IMPORT AND EXPORT
2.
In the Data Dictionary Export window, select the Data Source Export tab.
3.
If you right-clicked on the Datasource you want to export, it is selected by default.

Otherwise, select it.
4.
From the list of Datasources, select any additional Datasources you want to export.
5.
Select or clear as appropriate, the Export data source entities check box.
The default setting exports the Datasource with its configuration profile and
associated properties, as well as all the entities assigned to the Datasource, and
their associated profiles and properties.
If not selected, then entities are not exported, only the Datasource (with its
configuration profile and associated properties) is exported.
6.
7.
Click Export.
If the output file does not exist, a message appears asking if you would like to cre ate
it. Click Yes.
CONFIDENTIAL
139
IMPORT AND EXPORT
Importing Data
Note: To ensure integrity of data, it is recommended that all pages are imported before a
Data Dictionary import takes places. Importing pages after the Data D ictionary will
result in Portal Calculation tags and Portal SQL tags not displaying correctly.
To import data into the BabelFish Data Dictionary:
1.
Select Import
2.
In the Data Dictionary Import window, click the

you want to import.
3.
Click Import.
button to navigate to the file
The progress of the import appears in the Import Status field.
CONFIDENTIAL
140
HOW-TO: CREATING A TEMPLATE INSTANCE

(PROFILE)
How-to: Creating a Template Instance (Profile)

A Profile (Template Instance) is an entity with a template assigned to it. Typically, thi s
would be a summary entity.
To create a Template Instance:
Step 1.
a.
Create a Summary Entity and assign a template to it.

In Enterprise Manager, create a Summary Entity. (see page 41)
Summary entities are used to organise entities into logical hierarchies and do
not represent a data item in a data source. As such they are not associated
with a data source and cannot be used on BabelFish pages.
b.
In the Entity Hierarchy, select the new Summary Entity, select the Entity
Template tab, and then click the Add Template button.
c.
In the Select Template window, select the template you want to apply to the
entity, and then click OK.
Step 2.
Set the Primary Entity Template.
The Entity Template must be set as the primary template for its properties and
attributes to display in the BabelFish Explorer Plant Model Tree.
a.
From the Entity Templates drop-down list, select the Entity Template that you
want to define as the primary.
b.
Select the Primary check box.
CONFIDENTIAL
141
HOW-TO: CREATING A TEMPLATE INSTANCE

(PROFILE)
Note: Make sure that only one template is set to Primary. Having two primary
templates causes it to appear twice in the BabelFish Explorer Plant Model
Tree.
Step 3.
a.
Add Property and Attribute details.

On the Entity Template tab, click the Properties tab.
Properties are typically constant values but can also be metadata such as
document names, labels, and so on.
b.
Add Properties (see page 111) as required.
c.
Click the Attribute tab.

Attributes are other entities providing data for a specific part of the template.
d.
Add Attributes (see page 115) as required.
To preview the updates in the BabelFish Explorer, open the Plant Model Tree and navigate
to the new entity. If the template has renderers assigned, they are displayed in the Table
of Contents when you click on the entity. Double-click a renderer to invoke it.
Only the attributes which have entities assigned to them are displayed as children for the
parent entity.
CONFIDENTIAL
142
HOW-TO: CREATING TEMPLATED PAGES
How-to: Creating Templated Pages

The BabelFish Data Dictionary allows for entities to be configured based on a template
(see page 101). Templates are essentially a way of defining a set of attributes and
properties that a group of entities have in common. When an entity is assigned a template,
an instance of that template is created, allowing other entities to be associated with it as
attributes as well as being able to specify static properties.
The BabelFish Explorer also supports Templated Pages. A Templated Page is a Babe lFish
Explorer page that is configured as a renderer to contain the properties and attributes of
the template.
Templated Pages therefore leverage the commonality of entities associated with a
template. This allows you to create a single page to display multiple entities that are
associated with the one template. Building a Templated Page involves working with both
ISS Enterprise Manager and BabelFish Explorer.
To build a templated page, do the following:
Step 1.
Create a Template (see page 103).
In Enterprise Manager, create an Entity Template within the template hierarchy.

Step 2.
In BabelFish Explorer, create a BabelFish Explorer page.
Make note of the page ID number, you will need this for the following steps. For
further information on creating pages in the BabelFish Explorer, refer to the
BabelFish Explorer User's Guide.
Step 3.
Associate the page with the template (created in step 2) as a renderer:
a.
Create a Renderer (see page 125).
b.
Assign a Renderer to a Template (see page 120).
c.
Edit a Template Renderer (see page 123). You will need the Page ID for this
step.
Step 4.
In Enterprise Manager, create a Template Instance (see page 141).
After the template is created, configure an entity as an instance of the template. You
need to create an entity for each real world implementation of the template, and
then assign the template to these entities.
Step 5.
Edit the Template Page within BabelFish Explorer.
This step is completed within the BabelFish Explorer. You need to edit the page
which is configured as a renderer, to contain the properties and attributes of the
template.
CONFIDENTIAL
143
HOW-TO: CREATING PREFIXED TAGS
How-to: Creating Prefixed Tags

The Tag Fetcher, a task within the Task Scheduler (see page 224), allows you to prefix all
tags from a given Datasource.
Step 1.
Add a tag prefix to the Data Source Template.
a.
Expand the Templates

hierarchy.
node in the Enterprise Manager navigation
b.
Expand the Data Source
c.
Click the Data Source Template for the Datasource you want to prefix. This is
normally indicated by the Datasource
icon.
node.
Alternatively, if the Data Source Template is not listed, create a template (see
page 103) by right-clicking on the Datasource, and selecting Add > New
Template.
d.
Click the Template Properties tab on the right.
e.
Click the Add Property button.
CONFIDENTIAL
144
f.
HOW-TO: CREATING PREFIXED TAGS
In the Select Properties window, scroll down to select TAG_PREFIX, and then
click OK.
Alternatively, if TAG_PREFIX is not listed, create a new property by clicking the
New Property button and typing TAG_PREFIX in the Name field. Click OK.
g.
Step 2.
Click OK.
Add the tag prefix to the Datasource.
a.
Expand the Data Sources
b.
Expand the specific Data Source Type
c.
Click the Datasource
d.
Click the Data Source Template tab on the right.
e.
Click in the TAG_PREFIX field and type the text you want to use as the prefix
for the tag.
Step 3.
node.
node, such as BabelNet.
node, such as BabelNet Datasource.
Complete the steps for the Tag Fetch from Historian (see page 232) task.
CONFIDENTIAL
145
HOW-TO: CONFIGURING STATE SETS
How-to: Configuring State Sets

The Random Adaptor is provided in ISS Enterprise Manager as a mechanism for testing
digital states. This procedure applies to all Adaptors that support tag imports that return
tags with digital states. Currently, these are the Random Adaptor, PI Adaptor, and Avocet
Data Manager (ADM) Connector. For further information, contact the ISS Support Group.
In Enterprise Manager:
1.
Expand the Data Sources
node in the BabelFish Data Dictionary.
2.
Click the Random Data Sources node, and wait for the window to update.
3.
In the lower right window, click the Data Source Template tab.
4.
In the Properties, set the value of ReturnRandomStates to Y.

This will cause the Random Data Adaptor to return state set information for one of
the entities when you check for new tags against the Random Data Source.
5.
Click the Save
6.
In the navigation hierarchy, right-click on the Random Data Source node

select Check for New Tags.
, and
The BabelFish Tag Import Wizard appears.

Click through the next four prompts, and wait for the Random Data Adaptor to
return the entities.
CONFIDENTIAL
146
Five entities are displayed.
7.
Click Next.
8.
Click Finish to begin importing the tags.
9.
At the Tag Import Successful window, click OK.
10.
Click the Save
button on the Enterprise Manager toolbar again.
Doing this will automatically create the Entity States template group, if it does not
already exist in the BabelFish Data Dictionary.
11.
Expand the Entity States
node under Templates
Check to see that this node contains the template

created for the
RandDataAdaptorEntity4 entity when it was imported. This template contains three
Template Properties: state0, state1, and state2.
CONFIDENTIAL
147
12.
Click on the Random Data Source
node again.
13.
In the Data Source Tags tab on the right, double-click on the

RandDataAdaptorEntity4 entity.
14.
Click on the Entity Templates tab.

The entity has three templates assigned: RandDataAdaptorEntity4 States, Time
Series Entity Template, and ePlant Tag.
The RandDataAdaptorEntity4 States template is the one that was created by the tag
import.
15.
Click on the RandDataAdaptorEntity4 States template in the list view.

This displays the properties and their values on the right.
CONFIDENTIAL
148
The template is specifying that the text 'state0' is represented by the value 0,
'state1' is represented by the value 1, and 'state2' is represented by the value 2. This
template provides the state set text to state set value (and vice versa) mappings for
BabelFish.
Now we can request the entity through BabelFish Explorer, and have the state set
information returned in the response for the request.
16.
Submitting the RandDataAdaptorEntity4 entity through the Data Broker Tester (on
the BabelFish server) gives the following response:
The information returned includes the value of the entity (can be either a numerical
value, or a state set text value). In the example above, RandDataAdaptorEntity4 can
return the following set of values: '0', '1', '2', 'state0', 'state1', or 'state2'.
The information returned also includes the state set information that is relevant for
the times specified in the original request. This is required by BabelFish pages and
trends, so that they can do substitutions when required (either from state set text
value or a numerical value, or vice versa). The time ranges are required because
state sets are stored as profiles, which can therefore be historised.
Note: If you do not see the state set information being returned in the data broker
response, the BabelFish Data Dictionary (BFDD) may need to be restarted so that the
cache updates. Alternatively you can wait for an automatic cache refresh to occur
(this is controlled via a configuration file located in the directory where BFDD.exe
resides).
Now that the BabelFish Data Dictionary configuration is complete, we can use the entity on
BabelFish pages and on trends, and see the state set text being displayed.
CONFIDENTIAL
149
HOW-TO: MAPPING STATE TAGS
Dropping the entity onto a BabelFish page:
The state set text value is displayed instead of the numerical value that it maps to.
Trending the entity with a BabelFish trend:
The state set text values are displayed on the y-axis. The numerical value that each
state set text value maps determines the relevant height on the y-axis.
The state set text values are also displayed on hairlines.
How-to: Mapping State Tags

If a state tag uses numeric values to define its states, you need to add a template to the
associated entity in the BabelFish Data Dictionary to allow it to trend correctly in the
BabelFish Explorer. In this example, we will name the template Entity States.
You can share the template with multiple entities which have the same set of states. There
are two main ways of doing this:
Create a generic On Off States template, which could be shared by all entities which
can be on or off, such as pumps, lights, sensors, and so on.
Configure one template for each type of object, such as Pump States, Light States,
Sensor States, and so on. This approach adds additional context to the template.
Note that the numeric values that map to the states are defined for each individual entity,
and so although a template is shared by multiple entities, the numeric values of the states
do not need to all be the same. For example, one type of pump could use 0 for on and 1 for
CONFIDENTIAL
150
off, while another type of pump uses the opposite of 0 for off and 1 for on, while a third
type of pump uses 2 for on and 4 for off. All three cases could still share the one Pump
States template, if desired.
To configure the template:
Step 1.
In Enterprise Manager, create an Entity States template group.
a.
Right-click on the Templates node and select Add > New Template Group.
b.
Enter Entity States as the name.
c.
Click OK.
Step 2.
a.
Add the Pump States template to the template group:

Right-click on the Entity States template group, and choose Add > New
Template.
CONFIDENTIAL
151
b.
On the first page of the Template Wizard, choose Entity Types for the template
type.
c.
Click Next.
d.
Specify the template name, provide a description, and choose an icon.
e.
Click Next.
CONFIDENTIAL
152
f.
Select each of the properties that correspond to the templates states. Each of
the possible states of the entity are configured as properties on the template.
If a property for the desired state does not currently exist, you can add one by
clicking the New Property button, entering the desired property name (that is,
state text), and then clicking the OK button. In the example below, a new
Bypass state is added.
g.
State templates do not require attributes, so click Next to skip the next page of
the Template Wizard.
h.
Click Finish to create the template, and then click the Save
Enterprise Manager toolbar.
Step 3.
button on the
Associate the state template with an entity.
CONFIDENTIAL
153
a.
Locate and select the entity that represents your state tag (navigate through
the hierarchy, or perform a search).
b.
Select the Entity Templates tab for the entity.
c.
Click Add Template to associate a Template with the entity.
d.
Select the template you previously created, and click OK.
Each of the states are presented as properties of the template and are listed in
the Entity Templates tab.
CONFIDENTIAL
154
e.
Enter numeric values for each of the desired states:

Click the
button next to the state to make changes to the Property
History. This is where you change the values for the state. You can also view
historised values here.
To add a new property value as a separate history entry, click the New button,
enter the value in the Property Value field, and then click Save.
To change an existing value, click on the date or value from the list, overwrite
the entry in the Property Value field, and then click Save.
Note that the numeric values do not need to be contiguous.
CONFIDENTIAL
155
Portal Configuration
In This Chapter
Runtime Information
Configuration Database
Registration Information
Sitewide Parameters
Security
Configuration
Publishing
157
157
158
158
163
177
216
The Portal Configuration node in ISS Enterprise Manager provides access to global settings
and management tools for BabelFish Explorer.
The Portal Configuration functionality available through ISS Enterprise Manager is also
available in the BabelFish Explorer Administration Console, accessible via the URL http: / /
<servername> / eplant / dll / eplant.dll. Refer also to the BabelFish Administrator's Guide.
CONFIDENTIAL
156
PORTAL CONFIGURATION
RUNTIME INFORMATION
Runtime Information
The Runtime Information screen appears automatically when you click on the Runtime
Information node in the Navigation Hierarchy. It displays runtime information about the
BabelFish server.
Configuration Database
The Configuration Database node displays information regarding the configuration of the
BabelFish server, and may assist with database tuning.
The Configuration Database screen displays four types of information:
Login
Login details for the BabelFish
database. If you have
sufficient privileges, you can
change the username,
password, and DSN of the
database.
ODBC Details
Displays the details of the
ODBC drivers for the
BabelFish database.
Pooling
Displays the pooling details for the BabelFish database.
CONFIDENTIAL
157
REGISTRATION INFORMATION
Caching
Displays details about the current cache activity, and allows you to reset the cache.
A cache is a high-speed storage mechanism, and can be either a reserved section of
main memory or an independent high-speed storage device.
A N O TE
ON
D A TA BA SE T U NI NG
To optimise the production environments of BabelFish, statistics form a vital part of the
overall solution. ISS will optimise as much as possible the database queries using explain
plans on the SQL within their test environment before shipping the software. It is,
however, the runtime environments and the specific data loads and volume that will
mostly affect the efficient running of the BabelFish environment.
The actual running of Statistics is not a BabelFish function and is therefore left to the
database management environment to run these. To best utilise the table sizes and
indexes, the statistics must be run on both the Table and Index. If assistance is required,
contact the ISS Support Group.
Registration Information
The Registration Information node displays the registration details for the BabelFish
licence.
System name
Name of the BabelFish server.
System Expiry Date
The date the licence expires.
Max Pages
The maximum number of pages
that can be created on this
licence. -1 means unlimited pages
can be created.
Max Trends
The maximum number of trends that can be created on this licence. -1 means
unlimited trends can be created.
Sitewide Parameters
The Sitewide Parameters screen lists all the options that can be set to provide values for
the settings or controls which apply across the entire BabelFish system. Some options
enable restrictions to be placed on the use of the system, such as timeout limits, which can
affect system performance if left uncontrolled, while others specify a value that can be
accessed in many places across the system, such as shift length.
Session Timeout (in minutes)
The amount of time, in minutes, that a user's logon can remain idle before they are
automatically logged out of the system. Default: 20.
CONFIDENTIAL
158
SITEWIDE PARAMETERS
Point Detail Refresh Interval (in seconds)

The amount of time, in seconds, that is to elapse before a tag's point detail is
refreshed. Default: 5.
Default Page ID
The page number that is set as the default page, which is displayed when a user
invokes the URL http:/ /<servername>/babelfish. This will be overridden by the
user's default page (see page 168), if set. Default: 1.
Default Page ID (for mobile devices)
The ID of the home page which initially displays when BabelFish is accessed from a
mobile device. This is different from the standard home page, which may not be
appropriate for mobile devices. Default: 1.
Default Frameset
The frameset within which you want all pages to open when they are first loaded. If
the pages belong to an application, then that frameset setting will override this one.
You should use the default setting of /eplant/BFframeset.srf.
Trend Trace Width (in pixels)
The width, in pixels, of line and stair traces on a trend. This cannot be set on an
individual basis and will affect all trend lines across the system. Default: 1.
Trend Trace Extrapolation
Whether or not you want all trend windows to continue the trend from the last
known value in the trend to the right edge of the window. This extension of the
trend line is based on previous trend figures. Default: Dont Extrapolate.
Show out of range warnings on the Trend when data is returned out of the requested
range
Whether or not to display "out of range" warnings on the trend when data is
returned out of the requested range. Default: Hide Warnings.
Confidence Cutoff
Confidence value below which a value is regarded as bad. Default: 20.
Calculation Confidence Cutoff
Confidence value below which a calculated value is regarded as bad. Default: -1.
Calculation Confidence Cutoff Behaviour
Determines whether data values with a confidence less than or equal to the
configured threshold are treated as errors or are removed from the data set when
performing calculations. Default: Error.
Maximum History Calculation Error Percentage
The maximum percentage of errors allowed in the data input to a history calculation.
Default: 0.
Automatically Create Users
Whether or not users are automatically added to the User database when they first
open a page. Initially, all users are members of the Everybody group and therefore
inherit the permissions associated with that group. By default this group ha s no
permissions. Default: Yes.
CONFIDENTIAL
159
SITEWIDE PARAMETERS
First Day of Week

What the system considers to be the first day of the production week. Default:
Sunday.
Start of Day Offset (in minutes)
The default start time of the day is at 12 midnight. This can be changed by adding
the number of minutes to this time that you would like the day to commence. The
system will then see this time as the start of the day. Default: 0.
Shift Length (in hours)
The length of time for the duration of each shift. Default: 8 hrs.
Show 'Toggle Design Mode' Button
Whether or not you want the edit button for the pages to be displayed or hidden.
You can still invoke the Edit function through the key combination Ctrl + Shift + E,
regardless of this setting. Default: Yes.
XY Trace Marker
The marker (used to mark the data sample points) to be displayed on a trend
diagram when the trace mode is set to XY. Default: Triangle.
Automatic Trend Reload Interval (in minutes, use -1 to disable)
Forces the trend to refresh after the number of minutes specified here. If not
required, set this to -1. Default: -1.
Trend Fetch Timeout (in seconds)
The amount of time, in seconds, that a trend will wait for data without aborting a
request. Default: 45.
Trend Save Dialog
Whether or not you want to display the Trend Saving dialog box when you close a
trend. If disabled, the dialog box will not appear when closing a trend and all
displayed trends will be discarded. After changing this setting, any open pages will
need to be refreshed before the setting will take effect.
Default: Disable.
Minimum Private Page ID
Minimum page ID allowed when creating BabelFish pages. This ensures that private
pages always have IDs greater than the number specified here. Default: -1.
Minimum Page Refresh Rate (in seconds, use -1 to disable)
The minimum number of seconds that can be chosen as the refresh rate when
creating or editing a BabelFish page. You can use this to prevent users from setting a
page refresh rate that puts an unnecessary load on the system due to frequently
refreshing the data on the page. For example, you may not want users to refresh a
page every second. If you do not want to specify a minimum, set this to -1.
Recommended setting: 60. Default: blank.
Note: Once set, this applies to new pages only. Pages created before this setting was
changed may still have values which are now considered too low.
CONFIDENTIAL
160
SITEWIDE PARAMETERS
Load Data With Page (used for new pages)

Whether a page loads its tag data at the same time that the page is loaded, or
whether a page obtains data only after the page has finished loading. This affects the
performance of the system. If you have fast, low latency data, you can set this to
Yes. If you have slow, high-latency data, your system may perform better with this
set to No. This setting is used as the default for new pages. Default: Yes.
Enable Compression of Selected Responses
Whether or not to use data compression on the HTTP responses, where available
(for example, pages, trend data, and trend page). Default: No.
SQL Table Data Source Connection Timeout
The maximum amount of time, in seconds, to wait whilst attempting to connect to a
database. Set this to -1 to use the default, and to 0 for infinite. Default: -1.
SQL Table Data Source Query Timeout
The maximum amount of time, in seconds, to wait for an SQL tables query to run. Set
this to -1 to use the default, and to 0 for infinite. Default: -1.
Page Data Load Timeout (in milliseconds)
The maximum amount of time, in milliseconds, that the page will wait for data
before timing out. Set to 0 for infinite. Default: 0.
Maximum Selectable Raw Timebase (for the diagnostic trend)
Restricts the time base that can be specified as the Timebase of any diagnostic
trend. Default: 8 hour.
Maximum Selectable Raw Timebase (for the fast trend)
Limits the time base that can be specified as the Timebase of any fast trend with a
sample method of Raw. Default: blank.
Maximum Zoom Level (for the diagnostic trend)
The maximum zoom capability allowed. If you want to choose a value over 16, you
should first consider the impact that this might have on performance. Default: blank.
Show Units on Tags (used for new tags)
The default value for the Show units check box (on the Appearance tab of the entity
editor) for when new tags are created, or when tags are dragged onto a page. If
selected, the units of the tag are automatically displayed after the tag value. Default:
No.
Default Alignment for Tags
How the tag objects will be aligned when they are first added to a page. Alignment
can be left, centre, or right. Default: Left.
Default Minimum Tag Display Range
The default minimum display range to use when creating tags. Default: 0.000000.
Default Maximum Tag Display Range
The default maximum display range to use when creating tags. Default: 1
0000.000000.
Default Number of Decimal Places
The default number of decimal places to use when creating tags. Default: 1.
CONFIDENTIAL
161
SITEWIDE PARAMETERS
Data Source Comments Maximum 'Show All' Day Range

Determines the day range used for fetching data source comments when Show All is
selected. Default: 31.
Maximum Menu Height (in pixels)
The maximum height, in pixels, of a menu list before the scrollbars are activated.
This applies only to customisable user-added menus in BabelFish Explorer, such as
tag menus, labels menus, and so on. This does not apply to built-in menus, such as
those in the trend menu bar. Default: 200.
BabelFish Splash Screen
Determines whether or not a splash screen appears when BabelFish Explorer starts.
Default: Enabled.
BabelFish Portal Calculations
Option to turn on or off the creation of any further Portal calculations. This
parameter is intended to facilitate the phase-out of legacy Portal calculations that
do not allow the versioning functionality, which is now standard functionality
available to all installations of BabelFish. Setting this to Disabled means that
calculations will only be available from the DMS Calculation Engine, and Portal
calculations will no longer be selectable. All existing Portal calculation tags will not
be changed and can still be viewed and searched, setting this value will only disable
the creation of new Portal calculations. Any existing pages with the Portal
calculations will also continue to work as they did before the change. No entities or
tags will be changed or removed when this setting is enabled or disabled.
Recommended setting: Disabled. Default: Enabled.
BabelFish Licence Notification
When less than a month remains on the current valid license, enabling this option
allows a notification to be included on the splash screen stating the number of days
remaining on the licence before it expires. Default: Enabled.
Tag Data Type Determination
Determines the method used to work out the tag value data type. Configured: use
the tag's current configuration. First Value: use the data type of the first value
fetched, every time a fetch occurs. Default: Configured.
Treeview Limit
Controls how many entries initially appear in lists, as well as how many are added for
each "Next..." expansion. Increasing this value may adversely affect performance.
Default: 200.
CONFIDENTIAL
162
SECURITY
Security
The BabelFish data security model is based on integrated Windows domain security, and is
configured within BabelFish Explorer. All content filtering, according to the user security
settings, is performed on the server, rather than the client. This makes sure only
authorised users can access the data. The security model supports industry standard
certification and encryption standards.
The Security node displays a series of tabs for users, user groups, object groups, and
permissions for BabelFish users.
These are discussed in detail in the following sections.
BabelFish Security Model

The BabelFish security model is a security model based around ownership of objects.
Objects include tags, menus, trends, and pages. When a user creates any of these objects,
rules for view and edit access can be specified using a combination of privileges for user
groups and object groups.
CONFIDENTIAL
163
SECURITY
It's important to note that security only applies to published objects.

Objects are initially created as private objects belonging to the user who created the
object. The private object can be viewed and edited only by its owner. When the owner is
satisfied with the object, it can be submitted to the BabelFish administrator for publishing.
After the administrator has published an object, it is no longer owned by the user who
created it; it is owned by all users in the user group that have been given permission to
view and edit the objects in the object group to which the object is assigned.
When objects are published, they are placed in an object group. Initially, all objects belong
to the *All Unassigned object group, and then the administrator may assign them to
various object groups.
User groups are granted permissions for object groups. Therefore, depending on the
privileges that have been granted, users within a user group can view or edit objects
within an object group.
All published objects also belong to the *All Groups object group, regardless of security.
Users
The Users tab of the Security node displays all the users that have access to the BabelFish
system. Users not listed here will not be able to log in and use BabelFish.
All valid BabelFish users are displayed in the list on the left, including Windows domain
users as well as non-domain users.
The Guest and Admin users are created by default.
Clicking on the user in the list displays their details on the right.
User details are as follows:

User ID
The unique identifier for this user. This is automatically allocated and cannot be
changed.
CONFIDENTIAL
164
SECURITY
Domain username
The Windows domain user name of this user. Optional.
First Name
The user's first (given) name.
Last Name
The user's surname or family name.
Description
A general description of the user. Optional.
Domain User
Select the check box if this user is on the Windows domain. If selected, the Domain
username field must be specified. Domain users are automatically logged in to
BabelFish if they are logged on to the Windows domain.
Disabled
Select the check box to block the user from accessing BabelFish.
Home Page ID
The BabelFish page to use as the user's home page. This will override the Default
Page set in the Sitewide Parameters (see page 158), but will be overridden by the
user's default page, if set.
Group Membership
The available User Groups (see page 168). Green
indicates this user is a member
of the group, and red
indicates the user is not a member.
Create Users
To add a new BabelFish user to Enterprise Manager:
1.
Click the Users tab of the Security node.
2.
Click the Add button.
3.

Username: The user name that this user will be using to log in to BabelFish.
CONFIDENTIAL
165
SECURITY
First Name: The first (given) name of the user.

Last Name: The last name (surname or family name) of the user.
Domain User: Select to indicate that the user is a Windows domain user. If the user
is a non-domain user, then clear the check box.
Note: After selecting the Domain User option, the system confirms the new
BabelFish user in the Windows Domain system. Where a user is already a member of
the network, he or she does not have to provide a User Name or Password to access
BabelFish. If Domain User is not selected, each time the new user attempts to access
BabelFish, they will be prompted to provide a User Name and Password. Applications
for this may include staff gaining access to the network via foreign hardware. This
will force a login challenge where the hardware is recognised by the network as
being foreign and does not share network access permissions.
Password: If the user is a Domain User, then you can leave this blank - they can use
their Windows password to log in. Otherwise, enter up to 40 characters for a
password for the user.
Description: Enter up to 100 characters to describe the user and their permissions.
4.
Click Add.
The new user is displayed in the list on the left.
Assign Users to Groups

Assigning a user to one more user groups allows the user to inherit the permissions
assigned to that user group.
In the Users tab of the Security node:
1.
Click on the user in the list.

The Group Membership field displays the list of available User Groups.
Red indicates the user is not assigned to that User Group.
Green indicates the user is assigned to the User Group.
2.
For each user group, double-click on the red or green indicators to assign or remove
a user from a group.
To assign a user to a group, double-click the red indicator until it turns green.
To remove a user from a group, double-click the green indicator until it turns red.
Note: The User Groups are defined in the User Groups tab and the permissions assigned to
User Groups are defined in the Grant Permissions tab.
CONFIDENTIAL
166
SECURITY
Disable Users
To temporarily prevent a user from accessing BabelFish, you can disable their account.
Note: The Guest user is disabled by default.
1.
Click on the user.
2.
Select the Disabled check box.
3.
Click Save.
Remove Users
To permanently remove a user from BabelFish, you need to delete them.
1.
Click on the user.
2.
Click the Delete button.
3.

The user is removed from the list and deleted from the system.
Note: Any private pages, tags, and trends belonging to the deleted user will be reassigned
to the relevant *All Unassigned group and will become public.
Change Passwords
If a user has forgotten their password, you can reset it to a new password.
Note: A password can only be updated if the user is not a Domain User.
1.
Click on the user.
CONFIDENTIAL
167
2.
Click the Change Password button.
3.
In the Enter password field, type the user's new password.
4.
In the Confirm password field, type the password again.
5.
Click OK.
SECURITY
Add a Home Page ID

A home page ID is the BabelFish page displayed by default when the user logs in.
Note: The user can change this setting via My Profile. This setting overrides the default
home page set via Sitewide Parameters (see page 158).
1.
Click on the user.
2.
If you know the BabelFish page ID, you can type it into the Home Page ID field.
Otherwise, click the Browse... link to select the page from the Pages list.
3.
Click Save.
User Groups
User Groups allow a user to inherit permissions assigned to the group. They are defined in
the User Groups tab, and the permissions assigned to User Groups are defined in the
Grant Permissions (see page 175) tab.
User Groups can also inherit permissions from another User Group, called a Parent Group.
The User Groups, and how they are configured, are displayed in the Hierarchy
Configuration list.
Note: The built-in User Security group Everybody is not displayed.
CONFIDENTIAL
168
SECURITY
User Group details are as follows:

Group ID
The unique identifier for this group. This is automatically allocated and cannot be
changed.
Group Name
The name by which this group is known.
Description
A general description of the group. Optional.
Inherits
Select the check box if you want the group to inherit the permissions of another
group.
Parent Group
From the drop-down list, select the group from which this group inherits
permissions.
Hierarchy Configuration
A listing of all the groups, and a visual representation of how they are related in
terms of inherited permissions. The default user groups are:
*Administrators: Edit access to everything in BabelFish Explorer.
*Editors: Ability to edit a page, tag, trend, or menu that they have access to, as
determined by the relevant security permissions.
*Everybody: Read access to pages, tags, trend, and menus as determined by the
relevant security permissions.
Note: You should always have at least one person in the *Administration group,
otherwise you may lock ISS Enterprise Manager, and reduce most of the features to
a read-only mode or exclude you from being able to view some features. The only
way to recover from this is to call the ISS Support Group.
CONFIDENTIAL
169
E D IT IN G
SECURITY
U SE R G R OU P
To change the details of a User Group:

1.
Select the User Group in the Hierarchy Configuration box.
2.
Update the details.
3.
Click Save Changes.
Create User Groups

User Groups can be created in a hierarchy, inheriting permissions from its parent group. A
User Group is either created at root level, or as a child of another group.
In the User Groups tab of the Security node:
1.
2.
Enter the following:

Name: Name for the user group. For example, Administrators.
Description: A description of the group and its intended use and permissions.
Inherits: Select this check box if you want to create a User Group that inherits the
permissions of an existing group. Clear the check box if you want to creat e a user
group at root level.
Parent group: Select the group from which you want this group to inherit
permissions. This is disabled if Inherits is not selected.
3.
Click Add.
Remove User Groups

You should only remove a User Group that does not have any users or permissions
assigned to it.
To remove a User Group:
1.
Remove permissions from the User Group:

a.
Click on the Grant Permissions tab in the Security node.
CONFIDENTIAL
170
a.
2.
3.
SECURITY
Click on the User Group you want to remove, and clear any security
permissions assigned to the User Group.
Remove the User Group from BabelFish:

a.
Click on the User Groups tab.
b.
In the Hierarchy Configuration field, click on the User Group you want to
remove.
Click the Remove button.
Note: If there are users or permissions assigned to the User Group, you are prompted to
either continue removing the group, or to not remove the group. If you decide to
remove the group, users will be reassigned to the *All Unassigned group.
Object Groups
The Object Groups tab of the Security node allows you to separately assign permissions for
objects (entities, entity hierarchies, trends, pages, or menus) contained in the group. For
example, you might want some menus or entity hierarchies to be restricted to
administrators only. To do this, you first add the objects to the group, and then grant
permissions to those groups separately.
Note: Data Source is not an Entity Hierarchy therefore it cannot be secured.
Objects can belong to more than one group.
The Object Groups tab is divided into three main sections:

Object Groups.
All objects are one of five types: Entity, Entity Hierarchy, Trend, Page, or Menu.
CONFIDENTIAL
171
SECURITY
Note: In BabelFish v2.5, the Tag object type has been removed and replaced with
the Entity and Entity Hierarchy object types. This means that you can now
apply security to all entities as well as entity hierarchies.
To apply security to individual tags, as per earlier versions of BabelFish, select
the Entity object type, and then expand the BabelNet Datasource in the
Object Pool to view all the tags in the system.
These object types can be further subdivided into object groups. When you select
the object type from the drop-down list, a list of groups (of that object type) is
displayed in the list below.
Group Members.
The list of object belonging to the selected object group. When you click on an
object group on the left, a list of group members is displayed. You can filter this list
to search for a specific member. To use the filter, type all or part of the name into
the Filter field, and click Go.
Object Pool.
A list of all objects of the selected object type. This list is not divided into object
groups. The options available here vary depending on the object type selected:
Trend
Launch a blank trend, create a new trend, launch a tag trend, filter by public
or private trends, or filter by expression.
Menu
Filter by public or private menus, show parent menus only, or filter by
expression.
Entity
Select from the Plant Model Tree, search for entities, or change Plant Model
Tree options.
Page
Create a new page, filter by public or private pages, or filter by expression.
Entity Hierarchy
Filter by public or private entity hierarchies or filter by expression.
Note: Tags and Entities that are private to the current viewing user, or if the user is an
Administrator or Editor, will bypass user group and object group security, as
described below. The following scenarios are possible.
Scenario 1:
Entity Hierarchy 1 (Secured)
> Entity 1 (Not Secured)
CONFIDENTIAL
172
SECURITY
Expected behaviour: Users who are not in the right user group cannot view Entity
Hierarchy 1 or Entity 1.
Scenario 2:
Entity Hierarchy 1 (Not Secured)
> Entity 1 (Secured)
Expected behaviour: Users who are not in the right user group cannot view Entity 1
but they can view Entity Hierarchy 1 and Entity 2.
Scenario 3:
Entity Hierarchy 1 (Not Secured)
> Attribute of Entity 1 is pointing to Entity 3 (Entity 3 is secured)
Expected behaviour: Users who are not in the right user group can view Entity
Hierarchy 1 and Entity 1 but they cannot view the attribute of Entity 1.
Adding an Object Group

To create an Object Group:
1.
2.
From the Object Type drop-down list, select the type of object for which you want to
create a group (entity, entity hierarchy, trend, page, menu). Note that objects must
be of the same type to belong to a group. For example, trends can only be added to
a Trend Group.
3.
Type a Name for the group.
4.
Type a Description to describe the purpose of the group.
5.
Click Add.
The new group appears in the Available Groups list below.
CONFIDENTIAL
173
SECURITY
E D IT
AN
1.
From the Object Type drop-down list, select the type of object group you want to
edit (entity, entity hierarchy, trend, page, menu).
2.
In the Available Groups list, click the name of the object group.
3.
Click the Edit button.
4.
Make the required changes.
5.
Click OK.
R E M OV E
O B JE C T G R OU P
AN
O B JE C T G R OU P
1.
From the Object Type drop-down list, select the type of Object Group you want to
remove (entity, entity hierarchy, trend, page, menu).
2.
On the Available Groups list, click the Object Group name.
3.
Click Remove.
This deletes the Object Group and removes it from the Available Groups list.
Note: If there are any objects (entities, entity hierarchies, pages, trends, or menus) in the
Existing group members list, the Object group will not be deleted until they are
removed.
Adding Objects to an Object Group

To add an entity, entity hierarchy, trend, menu, or page object to an Object Group:
1.
From the Object Type drop-down list, select the type of object you want to add
(entity, entity hierarchy, trend, page, menu).
2.
In the Available Groups list, click on the Object Group name.

The list of objects currently in that Object Group is displayed in the Existing group
members list in the centre.
To use the filter to search for a specific member, type all or part of the name into
the Filter field, and click Go.
CONFIDENTIAL
174
3.
SECURITY
To add an object, find the object in the Object Pool list on the right, and drag it to
the list in the centre.
R E M OV E
A N O B JE C T F R O M A N
O B JE C T G R OU P
1.
From the Object Type drop-down list, select the type of object you want to remove
(entity, entity hierarchy, trend, page, menu).
2.
In the Available Groups list, click on the Object Group name.
3.
Click on the object in the Existing group members list.

If you need to, you can filter this list to search for a specific member.
4.
Click the Remove button below the group members list.
Grant Permissions
Permissions are assigned to User Groups (see page 168), and object types (see page 171)
within User Groups.
CONFIDENTIAL
175
SECURITY
To assign permissions to a User Group:

1.
Select a User Group from the list.
2.
Select the Object Type from the drop-down list.
3.
Select a group from the list of Available Groups.

Note: * All and * All Unassigned are always listed.
4.
*A L L
Select or clear the relevant check boxes under Available Permissions. Selecting the
check box grants that permission to the group, and clearing the check box removes
that permission from the group. The following permissions are available for each
object type:
Object Type
Available Permissions
Tag
View, Edit, View Privileged Comment, Write Value
Trend
View, Edit
Page
View, Edit
Menu
View, Edit
A ND
*A L L U N A S S I GNE D O B JE C T G R OU P S
The *All group includes objects in the *All Unassigned group and all other Object Groups
of a similar type. If no permissions are set for *All Unassigned, but view permissions are
set for *All, then unassigned objects of that type will inherit the view permissions set for
*All.
For example, the *All Tags group includes tags in the *All Unassigned Tags group and all
other tags. Therefore, if no permissions are set for *All Unassigned Tags, but View
permissions are set for *All Tags, unassigned tags will automatically have the View
permissions set for *All Tags.
Similarly, if Edit permission is assigned to tags in a specific group, that permission will
remain in effect and those tags are also viewable under the *All Tags permissions.
If the *All Tags group is not assigned any permissions, the individual group permissions
and any used for *All Unassigned Tags, are not applied.
Note: It is recommended that permissions are not set for the *All and *All Unassigned
groups, as these will act as a repository for stray objects resulting from deletion of
users and user groups.
CONFIDENTIAL
176
CONFIGURATION
Configuration
This section folder contains the Application Configuration, Datasources, DSN, Pages,
Trends, Page Export and Import Utilities, Comment Categories, and Mobile Device
Licences.
Application Configuration
The Application Configuration node allows you to control the presentation and layout of a
group of BabelFish pages, referred to as an application.
Applications can be given a different default HTML frameset (that is, the layout of the
menu bars, styles, and colours), and they can also be given a default set of lega cy menus
on the page toolbar (not framework menus).
CONFIDENTIAL
177
CONFIGURATION
Although this feature is now rarely used, it is useful for configuring drill-down menus for
groups of pages, such as plant areas or departments.
Note: The default application, ePlant, controls the presentation of all BabelFish pages and
should not be modified.
To create a new application:
1.
2.
In the Application Details window, enter the following details:

Name: The name by which you want to refer to this set of pages.
Description: A description of what the pages represent.
Frameset: The frameset to use for this set of pages. A frameset must be a .srf file
and determines the BabelFish header and toolbar used to frame BabelFish pages.
Note: Frameset files should only be created by an experienced programmer.
To select another frameset:
a.
Click the Browse link.
b.
From the Look in drop-down list, select Framesets.

Note: You cannot upload new frameset files. If this functionality is required,
contact the ISS Support Group.
c.
3.
Click on the frameset file you want to use, and then click Open.
Click OK.
You can now allocate pages (see page 179) and configure menus (see page 180) for the
application.
CONFIDENTIAL
178
C H A N G IN G
AN
CONFIGURATION
A P P LIC A T IO N
To change the configuration details of an application:

1.
Click on the application.
2.
Click the Configure button.
3.
Make the changes, and then click OK.
D E LE TE
AN
A P P LIC A T IO N
Removing an application will revert those pages to use the default BabelFish frameset.
To remove an application:
1.
Click on the application.
2.
3.
Allocate Pages
To allocate BabelFish pages to an application:
1.
Click on the application to which you want to add pages.
2.
Click the Allocate Pages button.
The Application Page Allocation window is divided into two panels.

All Pages contains the complete list of BabelFish pages. The list on the right displays
the pages belonging to the selected application.
3.
To add a page to the application, click on the page you want to add, and then click
the Add button.
CONFIDENTIAL
179
CONFIGURATION
4.
To remove a page from the application, click on the page you want to remove, and
then click the Remove button.
5.
When you have finished, click Close.
Configure Menus
To allocate menus to an application:
1.
Click on the application to which you want to add menus.
2.
Click the Configure Menus button.
The Attach / Detach Associated Menus window is divided into two panels.
Menus contains the menus belonging to the selected application. The list on the
right displays the complete list of menus available in the BabelFish Explorer. You can
filter the list to search for specific menus, and you can also display only private or
public menus, or parent menus only.
3.
To add a menu to the application, click on the menu you want to add from the right,
and drag it onto the name of the application on the left.
You can also add a new menu item from here by clicking the New Item button. For
further details on adding menus, refer to the BabelFish Explorer User's Guide.
4.
To remove a menu from the application, click on the menu you want to remove, and
then press the Delete
5.
key.
When you have finished, click Close.
CONFIDENTIAL
180
CONFIGURATION
Data Sources
A data source is a real-time historian or an external database containing historical data.
Datasources contain tags, which can be added to a page, trended, and used in
mathematical expressions.
The Datasource configuration node consists of the following sections:

Data sources.
The Datasources configured in Enterprise Manager.
Configurable Parameters.
The parameters that can be configured for the selected Datasource.
Configuring Datasources
To add a new Datasource:
1.
A new row appears in the Datasources list.

2.
Enter the following details as required:
CONFIDENTIAL
181
CONFIGURATION
a.
The ID field displays -1. This the default ID for all new Datasource
configurations and is automatically set by the system.
b.
Select the Type of Datasource from the drop-down list.
c.
Type a Description for the Datasource.
d.
Enter an Age Limit in seconds. The Age Limit is the comparison of the date and
time set in the Date/Time picker with the date/time stamp of the entity value.
If the amount of time is greater than the number of seconds stored in the Age
Limit field, the value is displayed as ?.
e.
If you want to define a tag in this Datasource as a constant, select the

Constant check box.
Constant Tags (also known as Target Tags or Forecast Tags) are typically values
entered manually and compared against Actuals. They are different to normal
Tags in that when a Trend is being viewed in Average mode, these Tags are not
considered to be Averages but rather a constant value that are to be
compared with the Averages returned from other Tags. The essence of this is
that in Stair Mode the trace for a Constant Tag will be drawn forward from the
recorded point - even though the Trend is set to Average.
3.
Enter the Configurable parameters as required. The options available depend on the
type of Datasource:
Type
Properties
PHD
PHD Server: Name of PHD server.

Username: The user name of the PHD server.
Password: The password of the PHD server.
ODBC
DSN: DSN name of the ODBC database. This must be configured (see page 186)
before it will appear here.
Username: Username of the OBDC database.
Password: Password of the ODBC database.
Table: The name of the table containing the new data source. Can also be defined
as a SQL statement returning the columns Tag Name, Date/Time and Value.
Tag name field: The field name of the Tag in the above table.
Date field: The field name of the Date/Time in the above table.
Value field: The field name of the Value in the above table.
Allow write: Tick to allow users to create new values while viewing pages in
display mode.
Calc
This is added by default during installation.
PI
PI Server: Name of the PI server.

Username: Username of the PI server.
Password: Password of the PI server.
display mode.
CONFIDENTIAL
182
CONFIGURATION
Type
Properties
BabelFish
display mode.
Web
URL: Enter the URL of the features XML, or enter the fetch URL in Single Value,
history fetch URL in History and the tags list URL in Get tags fields.
HTTP: The HTTP method.
ODBCWide
ODBCWide data sources are used when Entity names are defined as columns in a
table as opposed to ODBC where Entity names are retrieved from rows within the
table.
DSN: DSN name of the ODBC database.
Username: Username of the OBDC database.
Password: Password of the OBDC database.
Table with date: The name of the table retrieving the new data source. Can also
be defined as a SQL statement returning the columns Tag Name, Date/Time and
Value.
Date field: The field name of the Date/Time in the above table.
From clause: The FROM clause of the SQL statement retrieving entity details.
Where clause (optional): The WHERE clause of the SQL statement if you require
the entity details to be retrieved conditionally.
ComplexSQL
The DSN must be set up before continuing.

DSN ID: The sequence number of the DSN as specified in the DSN configuration.
4.
When you have finished, click the Save
R E M OV IN G
TH E
button.
D A T A S OU RC E
Caution: Removing a Datasource removes all tags and tag comments associated with the
Datasource, along with all instances of tags on pages and trends.
To remove a Datasource:
1.
Click on the Datasource you want to remove.
2.
3.
R E F RE SH IN G D A T A S OU R C E S
You may need to refresh the Datasources list if new Datasources have been added, or if
Datasource errors start occurring.
1.
Click the Refresh all data sources button.

When the Datasources have been refreshed, a message appears.
2.
Click OK.
CONFIDENTIAL
183
CONFIGURATION
Fetching Datasource Tags

After the new Datasource is saved, you can fetch all the tags belonging to the Datasource.
This allows the tags to be displayed in the toolbox in the BabelFish Explorer.
Note: Some Datasources, including Complex SQL, Calc and BabelFish, do not support the
Get Tags functionality.
To fetch the Datasource tags:
1.
Click on the Datasource for which you want to retrieve the tags.
2.
Click the Get tags for selected button.
3.
If required, type a prefix that you want to attach to the beginning of all tags for this
Datasource.
4.
Select the check box to refresh the description and units of existing tags. This only
applies when the description or unit of an existing Datasource is changed.
5.
Click Start.
The results of the tag fetch is displayed.
6.
Click OK after the process is finished.
The number of tags processed and added is displayed.
R E M OV IN G T A G S
F RO M A
D A TA S OU RC E
In extreme cases, you may need to delete all the tags from an existing Datasource.
Caution: Removing tags from a Datasource will also remove all tag comments, as well as all
instances of the tags on pages and trends.
To remove tags:
1.
Click the Remove tags for selected button.
2.
Click Yes to confirm.
CONFIDENTIAL
184
CONFIGURATION
Menu Configuration
The Menu Configuration node allows you to add items to a tag's right-click menu. The
menu items, however, are added globally; that is, to all tags in the selected Datasource.
When you add a menu item, it is automatically added to all future tags for that
Datasource. However, you are also offered to option of adding the menu item to all
existing tags on that Datasource.
To add a menu item, click on the menu on the right, and drag it to the appropri ate
Datasource on the left.
From here, you can also double-click on a menu item to edit it (see page 207). For further
details, refer to the BabelFish Explorer User's Guide.
CONFIDENTIAL
185
R E M OV IN G M E NU I TE M S
CONFIGURATION
F R OM A
D A TA S OU RC E
Removing a menu item from a Datasource means that all future tags associated with this
Datasource will not display the menu. However, existing tags will retain the menu unless
you specify otherwise.
To remove a menu item from a Datasource:
1.
Click on the menu item attached to the Datasource on the left.
2.
Press the Delete
key.
The menu item is deleted from all tags associated with the Datasource.
3.
You are also offered the option of removing the menu item from all existing tags on
the Datasource. Click OK to proceed.
The menu is removed from the Datasource.
DSNs
A DSN allows you to connect to an ODBC database. DSNs created here can be used by
ODBC data sources and SQL tables.
System DSNs (see page 187) are configured directly on the BabelFish server, but you need
to define them here to allow BabelFish to use them.
To add a new DSN:

1.
Select the DSN node in the Configuration folder.
2.

A new row appears.
3.

ID: Initially displays as -1. This the default ID for all new DSN configurations and is
automatically set by the system.
DSN: List of all server DSNs.
Username: User name of system DSN.
CONFIDENTIAL
186
CONFIGURATION
Password: Password of system DSN.

Description: Description of the DSN.
TZ Offset: Time Zone Offset in minutes from Greenwich Mean Time.
4.
Click the Commit
button.
System DSNs
A DSN (Data Source Name) represents an ODBC connection to some kind of database
(Oracle, MS Access, SQL Server, etc). BabelFish Explorer requires a DSN to be configured on
the web server in order to connect to the Oracle alias or the SQL Server.
A System DSN (not a user DSN) must be available to connect to the Oracle alias, and
through this, to the Oracle or SQL Server database containing the BabelFish Explorer
configuration information.
C RE A TE DSN S
System DSNs are not created in Enterprise Manager, you must do this directly on the
BabelFish server through the Control Panel.
1.
Open Control Panel > Administrative Tools > Data Sources (ODBC).
2.
Click on the System DSN tab.
3.
Click Add.
4.
Select the ODBC driver.

For Oracle databases, select the driver made by Oracle.
For SQL databases, select SQL.
5.
Click Finish.
E NA B LE C ON NE C TI ON P O O LI NG
ODBC connection pooling should be enabled for optimum performance. The ODBC
connection pooling is a service provided by the operating system, holding connections to a
database open after an application has closed them. It saves the overhead associated with
repeated opening of connections to the same database.
A Pool is a cache of database connections maintained in the database's memory so that
the connections can be reused when the database receives future requests for data.
To enable connection pooling:
CONFIDENTIAL
187
CONFIGURATION
1.
From the OBDC Data Source Administrator window (Control Panel > Administrative
Tools > Data Sources (ODBC)), click the Connection Pooling tab.
2.
Double-click on the driver to open the Connection Pooling Attributes window.
3.
Select Pool Connections to this driver and enter a value. Typical values would
range from 60 seconds to 900 seconds.
4.
Click OK.
Styles
Styles define how elements appear on a page and can be created and stored to use
globally across all BabelFish pages.
For each style you create, you need to define the style attributes, which are based on the
Cascading Style Sheets (CSS) standard.
Note: In order to use styles effectively, knowledge of HTML and CSS is greatly beneficial,
but not required.
CONFIDENTIAL
188
CONFIGURATION
Styles have the following attributes.
Style Attributes
Clicking on a style name in the navigation hierarchy displays the style attributes in the
main window.
You can add up to 22 attributes for a style.
U PD A T IN G S T Y LE A T T RI BU TE S
To update the attributes of a style:
1.
Click on the style name in the navigation hierarchy.
2.
In the main window, click the Style Attribute drop-down list and select a new style
attribute.
CONFIDENTIAL
189
3.
CONFIGURATION
In the Value field, type an appropriate value for the attribute.
The attributes are:

Background Color (see Height (see
page 191)
page 192)
Font (see page

194)
Cursor (see page

196)
Text Color (see page

191)
Width (see page Font Family (see

192)
page 194)
Display (see page

197)
Text Decoration (see

page 191)
Border (see
page 192)
Font Size (see

page 195)
Filter (see page

197)
Margin (see page 191) Border Style

(see page 193)
Font Style (see

page 195)
Visibility (see page

198)
Padding (see page

192)
Font Weight (see

page 195)
z-Index (see page

198)
Border Width
(see page 193)
When you select an attribute, a new row is added so you can keep adding attributes
as required.
4.
Repeats the above steps until all attributes are added.
5.
When you have finished, click the Save button in the lower right corner.
R E M OV IN G A TT RI BU TE S
Click the Delete
R E V E RT IN G
TO
button next to the attribute you want to remove.
L A S T S A V E D L IS T
Even after you have clicked Save, you can go back to the previously saved attribute list for
a style.
Click the Revert button in the lower right corner.
CONFIDENTIAL
190
CONFIGURATION
Background Color
Defines the background colour of an element. You can use the colour name, hexadecimal
value (with or without the #), or transparent.
Examples:
Colour name:
Yellow
Hexadecimal:
#00ff00
Transparent:
transparent
Text Color
Defines the text colour of an element. You can use the colour name, hexadecimal value
(with or without the #), or transparent.
Examples:
Colour name:
Yellow
Hexadecimal:
#00ff00
Transparent:
transparent
Text Decoration
Defines the decorative element to use on the text.
Value
Example
none
underline
overline
line-through
Margin
Defines the space around the top, bottom, left, and right of the elements. Specify the
margin in pixels or percentage.
Value
Example
10px
20%
CONFIDENTIAL
191
CONFIGURATION
Padding
Defines the space between the element border and the element content. Specify the
padding in pixels or percentage.
Value
Example
10px
20%
Height
Defines the height of an element. Specify the height in pixels or percentage.
Value
Example
20px
100%
Width
Defines the width of an element. Specify the width in pixels or percentage.
Value
Example
10px
100%
Border
Defines the borders around an element. This attribute is a shorthand that includes Border
Width (see page 193) and Border Style (see page 193), and also allows you to specify the
border colour.
The border colour can be defined using the colour name, hexadecimal value (with or
without the #), or transparent.
The properties must be declared in this order.
Value
Example
border-width
thin dotted red
CONFIDENTIAL
192
CONFIGURATION
border-style
border-color
Defines the style of the four borders. You can have from one to four values. The values are
specified in the following order: Top, bottom, left, right.
Value
Example
Dotted
Dashed
Solid
Double
Groove
Ridge
Inset
Outset
Example:
Dotted dashed
solid double
Border Width
A shorthand property for setting the width of the four borders in one declaration. You can
have from one to four values. The values are specified in the following order: Top, bottom,
left, right.
Value
Example
Thin
CONFIDENTIAL
193
Value
CONFIGURATION
Example
Medium
Thick
Length in pixels
(example:1)
Example:
thin medium thick 1
Font
A shorthand property for setting all of the properties for a font in one declaration. This
attribute is a shorthand that includes font-style (see page 195), font-weight (see page
195), font-size (see page 195), font-family (see page 194), and also allows you to specify
the font variant.
The font variant can be defined as either normal or small-caps.
The properties must be declared in this order:
Value
Example
font-style
font-variant
font-weight
font-size
font-family
italic small-caps bold 12px arial
Font Family
A prioritised list of fonts or generic family names. The browser will use the first value it
recognises. If the font is not installed on the computer, then the browser will search for
the next font in the list.
There are two types of values:
Family name: The name of a font-family, such as times, courier, arial, and so on.
Generic family: The name of a generic family, such as serif, sans-serif, cursive,
fantasy, monospace.
Separate each value with a comma, and list a generic-family name as the last alternative.
Use double quotes around a family name if it contains a space, such as "Lucida console".
Font names are not case sensitive.
CONFIDENTIAL
194
Value
CONFIGURATION
Example
arial, sans-serif
courier, "lucida console", monospace
Font Size
Defines the size of a font. Specify one of the following values, or specify a size in pixels.
Value
Example
xx-small
x-small
small
medium
large
x-large
xx-large
(Example: small)
(Example: large)
(Example: 10)
Font Style
Defines the style of the font. Specify one of the following values:
Value
Example
normal
italic
Font Weight
Defines the weight of a font. Specify one of the following values:
Value
Example
normal
bold
CONFIDENTIAL
195
A number between
100-900
CONFIGURATION
(example: 300)
Normal is 400, bold is

700.
Cursor
Changes the style of the mouse cursor. Specify one of the following:
Value
Appearance
Description
auto
n/a
Default. The browser sets a cursor.
url
n/a
The URL of a custom cursor to be used.

Note: Always define a generic cursor at the end of the list in
case none of the url-defined cursors can be used.
crosshair
The cursor renders as a crosshair .
default
The default cursor (usually an arrow).
help
The cursor indicates that help is available (often a question mark

or a balloon).
move
The cursor indicates something that should be moved.
pointer
The cursor render as a pointer (a hand) that indicates a link.
text
The cursor indicates text.
wait
The cursor indicates that the program is busy (often a watch or

an hourglass).
e-resize
The cursor indicates that an edge of a box is to be moved right

(east).
w-resize
The cursor indicates that an edge of a box is to be moved left

(west).
ne-resize
The cursor indicates that an edge of a box is to be moved up and

right (north/east).
sw-resize
The cursor indicates that an edge of a box is to be moved down

and left (south/west).
nw-resize
The cursor indicates that an edge of a box is to be moved up and

left (north/west).
se-resize

and right (south/east).
n-resize
The cursor indicates that an edge of a box is to be moved up

(north).
s-resize

(south).
CONFIDENTIAL
196
CONFIGURATION
Display
Specify if the object is to be rendered on the screen. The display attribute specifies the
type of rendering area to be allocated to the relevant tag. Specify one of the following:
Value
Description
block
The element will be displayed as a block-level element, with a line break before and
after the element. This is the default.
inline
The element will be displayed as an in-line element, with no line break before or after
the element.
list-item
The element will be displayed as a list.
none
The element will not be displayed on the page.
Filter
The filter property allows you to add more style effects to your text and images. Always
specify the width of the element if you want to use the filter property. Some of the Filter
properties will not work unless the Background Color (see page 191) property is set to
transparent.
The full list of static filters and their descriptions can be found on the Microsoft website
(http://msdn.microsoft.com/en-us/library/ms673539(VS.85).aspx).
The filters are:
Alpha
BasicImage
BlendTrans
Blur
Chroma
Compositor
DropShadow
Emboss
Engrave
FlipH
FlipV
Glow
Gray
ICMFilter
Invert
MaskFilter
Matrix
MotionBlur
Redirect
RevealTrans
Shadow
Wave
Xray
CONFIDENTIAL
197
CONFIGURATION
Example of an image with different filters applied:
Visibility
The visibility property determines if an element is visible or not. Set to visibility:visible or
visibility:hidden.
z-Index
The z-index property is used to place an element "behind" another element. The default
z-index is 0. The higher number, the higher priority. z-index: -1 has the lowest priority.
Pages
The Pages node is used to review and delete BabelFish pages. All pages, whether they be
private or public, are listed for the BabelFish administrator to view or discard.
CONFIDENTIAL
198
V IE W
P A GE
Double click on a page name from the list of pages. The page opens in a new
window.
C RE A TE
CONFIGURATION
N E W P A GE
Click the Wizard

button to launch the Page Wizard. For details on the Page
Wizard, refer to the BabelFish Explorer User's Guide.
D E LE TE
P A GE
To delete a BabelFish page:

1.
Select the page from the list.
2.
Click the Delete
F I LTE R P A GE S
BY
button.
P U BL IC A TI O N S TA TU S
To display only private or public pages, select the appropriate option from the
drop-down list. A filtered list of pages is displayed.
F I LTE R
TH E
LIST
OF
PAGES
1.
Click the Filter
icon in the upper right corner.
2.
Type the filter criteria.
3.
Click OK to search.
Note: You can use wildcards on the filter.
R E F RE SH IN G
P A GE L IS T
Click Refresh
to reload the list to include new pages, updates to page names,
and any other changes made since the page list was displayed.
CONFIDENTIAL
199
CONFIGURATION
Trends
The Trends node is used to review and delete trends. All trends, whether they be private
or public, are listed for the BabelFish administrator to view or discard.
V IE W
T RE ND
Double click on the trend name from the list of trends. The trend is displayed in a
new window.
C RE A TE
N E W T RE N D
To create a new trend, either:
Click the Blank Trend

button to launch a blank trend.
Click the Wizard
button to launch the trend wizard.
For details on creating trends, refer to the BabelFish Explorer Trending Tool Reference.
D E LE TE
T RE ND
To delete a trend:
1.
Select the trend from the list of trends.
2.
Click the Delete
F I LTE R T RE N D S
BY
button.
P U B L I C A T IO N S T A TU S
To display only private or public trends, select the appropriate option from the
drop-down list. A filtered list of trends is displayed.
F I LTE R
TH E
LIST
OF
T RE ND S
1.
Click the Filter
icon.
2.
Type the filter criteria.
3.
Click OK to search.
Note: You can use wildcards on the filter.
CONFIDENTIAL
200
R E F RE SH IN G
CONFIGURATION
T RE ND L I ST
Click Refresh
to refresh the list to include new trends, updates to trend names,
and any other changes made since the trend list was displayed.
Framework Menus
The Framework Menus node in the Configuration folder allows you to add and remove
menus from the BabelFish framework.
From here, you can also create new menus that can be used in any page or page object in
the BabelFish Explorer.
The Framework Menus node mirrors the Add/Remove Associated Menus window in the
BabelFish Explorer, and therefore operates in the same way.
The list on the right displays all the current menus available for adding to the Framework.
Indicates a parent menu containing sub-menus or specific menu items.
Indicates a single menu item that causes an action (such as opening a page, URL, or
trend).
CONFIDENTIAL
201
CONFIGURATION
You can attach all menus to either the Framework Menu or to any parent menu.
ADD
M E NU
T O TH E
F R A M E W O RK
To add a menu, drag the menu from the list on the right, to the Framework Menu
item in the list on the left.
These menu items will all appear on the BabelFish Explorer toolbar.
F I LTE RI N G M E NU I TE M S
If the list of menus on the right is large, you can use three methods to search through the
list:
Use the filter
Use the drop-down list to restrict the list to selected categories: Private, Public, or all
menus.
Select the check box to restrict the list to displaying only parent
to find the menu item you are looking for.
CONFIDENTIAL
menus.
202
CONFIGURATION
C RE A TI N G C A SC A D I N G M E NU S
To create a cascading menu, add any menu item to a parent menu
on the left.
You can also add parent menus to other parent menus.
V IE W
EDIT
OR
MENU
To view details for the menu in the list on the right, double-click it. You can also edit a
menu (see page 207) here if you need to.
C RE A TE
M E NU
If the menu you want to use does not exist, you can create the menu (see page 203) first,
and then add it from here.
R E M OV E
OR
D E TA C H
M E NU
To remove a menu from the Framework, select the menu from the list on the left
and press the Delete key.
Create a Menu
To create a new menu:
1.
Click New Item.
CONFIDENTIAL
203
2.
CONFIGURATION
In the Edit Menu Details window, fill in the following parameters:
Description: Description of the menu item.

Menu Text: The text you want to display as the menu "name".
Function. Select Call up a URL to create a single menu item. This is the default.
Select Generate menus on server only if you want to create a parent menu (see page
205).
onclick URL. The URL that is to be launched when the menu is clicked. External links
must be fully qualified, for example, http://www.site.com. Internal links can use the
relative path, such as /eplant/dll/eplant.dll?. To test if the URL works, click the
Test... link. You can also use replacement tokens (see page 209).
File
Select if you want to specify an internal file path. Inserts file:// at the beginning of
the path name.
Page
Select if you want to link to another BabelFish page. The Pages list appears, from
which you can choose the page.
Trend
Select if you want to link to a BabelFish trend. The Trends list appears, from which
you can choose the trend.
Manual
Select if you want to specify an external URL. Inserts http:// at the beginning of the
path name.
Icon. If you want to place an icon that will appear to the left of the menu text, click
Select to navigate and choose the image.
Target. The window or frame in which the linked object is to be displayed. This can
be a new window, a parent frame, current frame, topmost frame, new tab, current
tab, or an iFrame on the same page.
Note: Setting New Window as the target does not necessarily ensure it always open
CONFIDENTIAL
204
CONFIGURATION
in a new window. The actual behaviour is determined in Internet Explorer itself

according to the Tabbed Browsing Settings in Internet Options.
3.
Click OK.
Create a Parent or Cascading Menu

Parent menus can have sub-menus (cascading menus). Note that only administrators can
detach a child menu from a cascading menu.
To create a new parent menu:
1.
Click New Item.
2.
In the Edit Menu Details window, fill in the following parameters:

Function: Select Generate menus on server to create a cascading menu. Select Call
up a URL only if you want to create a single menu (see page 203).
CONFIDENTIAL
205
3.
CONFIGURATION
The Edit Menu Details window changes to add fields for the child menus. Fill in the
remaining fields.
Child menus: For a cascading menu, select Use cascading submenus. If you want to
create an inline menu, select Display inline.
Std sub-menus? Selecting this option automatically generates the Server Menu URL.
This also enables you to drag and drop directly linked submenus onto this menu
when the menu list is displayed.
Server menu URL: If you are not using standard submenus, specify the URL that
points to a web service that provides valid menu XML.
Note: This document is normally created by a BabelFish Administrator.
The XML document must have the following structure:
4.
Click OK.
CONFIDENTIAL
206
CONFIGURATION
Edit a Menu
To edit a menu:
1.
Open the menu item from either the BabelFish Explorer or Enterprise Manager
(administrators only). Either:
Double-click on the menu in the Attach/Detach Associated Menus window.
- OR Click the Edit Item button in the Menu Items tab of the object editor.
Note: If you do not have permissions to edit the menu items, this button will instead
display Menu Details, which when clicked displays the Edit Menu Details dialog box
in view-only format.
CONFIDENTIAL
207
2.
CONFIGURATION
In the Edit Menu Details window, make the required changes.

Function: What you want the menu item to do, either Call up a URL or Generate
menus on the server.
onclick URL. The URL that is to be launched when the menu is clicked. External links
must be fully qualified, for example, http://www.site.com. Internal links can use the
relative path, such as /eplant/dll/eplant.dll?. To test if the URL works, click the
Test... link.
File
Select if you want to specify an internal file path. Inserts file:// at the beginning of
the path name.
Page
Select if you want to link to another BabelFish page. The Pages list appears, from
which you can choose the page.
Trend
Select if you want to link to a BabelFish trend. The Trends list appears, from which
you can choose the trend.
Manual
Select if you want to specify an external URL. Inserts http:// at the beginning of the
path name.
Icon: If you want to place an icon that will appear to the left of the menu text, click
Select to navigate and choose the image.
Target: The window or frame in which the linked object is to be displayed. This can
be a new window, a parent frame, current frame, topmost frame, new tab, current
tab, or an iFrame on the same page.
Note: Setting New Window as the target does not necessarily ensure it always open
CONFIDENTIAL
208
CONFIGURATION
in a new window. The actual behaviour is determined in Internet Explorer itself

according to the Tabbed Browsing Settings in Internet Options.
Child menus: For a cascading menu, select Use cascading submenus. If you want to
create an inline menu, select Display inline.
Std sub-menus? Selecting this option automatically generates the Server Menu URL.
This also enables you to drag and drop directly linked submenus onto this menu
when the menu list is displayed.
Server menu URL: If you are not using standard submenus, specify the URL that
points to a pre-configured XML document that specifies the submenus you would
like. Internal paths can use the relative path, such as /eplant/dll/eplant.dll? The XML
document must have the following structure:
3.
Click OK.
Replacement Tokens for Menus

All replacement tokens can be used in menu names and menu URLs. These tokens may be
used in both client-side and server-side URLs and names, unless otherwise indicated.
For a list of available replacement tokens, refer to Keyword Replacement Tokens.
Delete a Menu Item

Deleting a menu item from the Add/Detach Associated Menus list will also remove all
instances of the menu on any tags, pages, or applications.
To delete a menu item:
1.
Open the menu item (see page 207).
CONFIDENTIAL
209
2.
In the Edit Menu Details window, click the Delete button.
3.
CONFIGURATION
Export Pages
The Export Pages node is used to export BabelFish Explorer pages, Portal Calculation tags,
and Portal SQL tags to an XML file, which can be later imported back into BabelFish.
The exported pages are saved in an XML file in the /ePlant/dbdump/ folder on the
BabelFish server. This is the same directory in which backups are stored, and is created
during installation, usually as c:\ inetpub\ wwwroot\ ePlant\ dbdump. Write-security
access must be allowed for the anonymous Web user, typically IWAM_MACHINENAME.
1.
Select whether you want to export all BabelFish pages or only selected pages.
To export all pages, select the All option.
To export individual pages, or a range of pages, select the Pages option, and then
enter the page IDs you want to export, separated by a comma. For example, 1,3,8-12
would export pages 1, 3, 8, 9, 10, 11 and 12.
Note: The Pages (see page 198) node in the navigation hierarchy on the left shows
the list of available pages on the server, which can assist in selecting pages to
export.
2.
In the Filename field, type the name of the file to which you want to export the
pages. This is optional but recommended.
CONFIDENTIAL
210
CONFIGURATION
3.
In the Comment field, type a comment to make it easier to differentiate between

sets of exported pages when importing. This is optional.
4.
Click Export.
Import Pages
BabelFish Pages can be imported from an XML file on the server which you are using to
view the import utility, or from a remote server accessible by the server you are using.
1.
Choose the BabelFish server from which you want to import pages.
To import pages from the BabelFish server you are using now, select the This one
option.
To import pages from a remote server, select the Remote option and type in the
name of the server.
Note: The remote server must be running a version of BabelFish which supports
page importing.
2.
Click the Query button.

A list of XML files containing page backups is displayed. Each file may contain one or
more BabelFish page.
3.
Click + to display the list of pages in the XML backup files, and locate the pages you
want to import.
To import individual pages from an XML backup file, type a new page number (or
leave default) and click Import.
To import all pages from the XML backup file, and then click Import All.
4.
If the destination page exists, a warning is displayed. Click OK to proceed and delete
the existing page so you can replace it with the backup page.
CONFIDENTIAL
211
CONFIGURATION
Note: The Privacy/availability setting of the imported page is set to public access
(even if private when exported). The exception is to import it to over an existing
private page which overwrites the old page, but retains the private access only
setting.
D I RE C T A C C E S S
T O I M P O RT A N D
E X P O R T P A GE S
If direct access is required to the export and import utilities (for example, for integration
with other web-based management tools), then they can be accessed directly from the
following locations:
http://server/ePlant/bin/export.srf
http://server/ePlant/bin/import.srf
F O NT S TY LE S
When importing pages from a remote server, or from a file which was exported from a
different database, it is possible that the elements on the page use font styles which the
server you are importing to does not have. If this occurs, then the import utility will
automatically recreate the new font styles in the database.
However, for efficiency, font styles are cached instead of being reloaded from the
database each time a page is viewed. This therefore means that any new font s tyles
created by importing pages will not be picked up, and so text will be displayed on the new
page with a default font.
If this occurs, then /eplant/dll/eplant.dll?ReInit can be used to refresh the font style cache.
D A TA S OU RC E S
ON
T A R G E T S Y STE M
When importing pages with tags that do not exist, the tag is recreated if the Datasource
still exists on the target system. The import utility searches for a Datasource in the target
database with the same description as the Datasource used by that tag when it was
exported.
If a matching Datasource is not found then the import utility will not be able to restore the
tag, and so will fail with an error. To fix this problem you will need to manually create a
Datasource DSN with the description indicated in the error, and of the appropriate type for
the tags being restored. Behaviour is undefined if a Datasource with the correct
description exists, but is of the wrong type.
DSN S
A DSN contains information used to connect to an ODBC database, and is used by SQL
tables and ODBC data sources. When importing pages, if an SQL table on the imported
page does not exist in the database then it will be recreated, which requires a reference to
the DSN that the table uses to extract its data.
The import utility searches for a DSN in the target database with the same description as
the DSN used by the table when it was exported. If a matching DSN is not found then the
import utility will not be able to restore the table, and so will fail with an error. To fix this
problem you will need to manually create a DSN with the description indicated in the
CONFIDENTIAL
212
CONFIGURATION
error, which points to a database containing the same information as the DSN the table
was exported with.
I MA GE S
AND
OTHER FILES
The import utility only updates the BabelFish database. If a page contains references to
external files, such as background images, hyperlink icons, iFrame contents, and so on,
then the location of those files are entered into the database.
However, when importing from a remote server, the files themselves are not copied. Any
files which exist on the remote server and are referenced by the imported page need to be
copied manually to the server to which the page is imported.
P A GE S E C U RI TY
It is possible to give only certain users access to particular pages. When the page import
utility is used to replace an existing page, the existing access rights for that page are
retained. If this is not the desired behaviour, the access rights will need to be modified
manually.
P A GE C RE A TI O N D A TE S
When importing pages, the CREATE_DATE and MOD_DATE fields are set to the date of the
import, and the CREATE_USER and MOD_USER fields are set to the user who performed
the import. The Notes field should contain further information on when the page was first
created.
Preset Pages
An existing BabelFish page can be nominated as a Preset Page (also known as a template
page). This allows the page to be used as a template when new BabelFish pages are
created. You can quickly create similar pages without having to start with an empty page.
To create a Preset Page:

1.
Click the Preset Pages node in the Configuration folder.
2.
Click the New Preset Page button.
3.
In the new row, click the Select link to select the base page from the Pages list.
CONFIDENTIAL
213
CONFIGURATION
4.
In the Preset description field, type a description for the preset page. This will
appear in the Page Wizard.
5.
Click the Browse link to select an icon to appear as a thumbnail in the Page Wizard.
6.
Click the Save Changes button.
T O R E V E RT
L A ST S A V E D L IS T
Click Revert Changes.
D E LE TE
TO
P RE SE T P A GE
Click the Delete
icon next to the page.
Comment Categories
The Comment Categories node in the Configuration folder allows you to add and remove
categories in which comments are stored.
To add a new category:

1.
2.
Enter the following parameters in the new row:

Name: The name of the comment category.
Icon: The icon to display on a trend for the Datasources that return comments from
this category type. Choose from the default icon, arrow, outline arrow, cup, psi, and
rectangle.
CONFIDENTIAL
214
CONFIGURATION
Description: A description of the purpose of the category.

Default: Select the check box if you want this to be the default category.
3.
Click Save.
D E LE TE
C A TE G O RY
To delete a category, click the Delete button
next to it.
Note: You cannot delete the Default comment category. If you delete a comment category
and comments are using it, they will be reassigned to use the Default comment
category.
Mobile Device Licenses

The Mobile Device Licenses node allows you to control the mobile devices that are
registered for use with Mobile BabelFish.
This list is the reason why users must provide a device name when first registering their
mobile device so that administrators can tell them apart. An administrator can click the
Delete icon next to a registered device to unregister it, and therefore free the licence for
another device. This may be necessary, for example, when a device is no longer used.
Click the Delete icon
C H O O SI N G
TH E
to unregister a device.
M OB I LE B A BE L F I SH H OME P A GE
A BabelFish administrator can choose which page is to be used as the home page when
viewing BabelFish from a mobile device.
1.
Click the Sitewide Parameters node.
2.
In the Default Page for mobile devices field, type the page ID of the page you want
to set as the home page.
3.
Click Save.
CONFIDENTIAL
215
PUBLISHING
Note: This is independent of the home page used for BabelFish Explorer on the desktop. In
desktop BabelFish, individual users can override the default page by setting their
own home page in their profile in My Environment. This setting is not used by
Mobile BabelFish.
Publishing
Publishing enables BabelFish administrators to control which pages, tags, trends, and
menus are publicly available, allowing them to be checked before a release.
Each of these objects can be Public (available to everyone) or Private (available only to the
owner). Private items can only be viewed or edited by the owner or someone with
BabelFish administrative privileges.
The BabelFish administrators can only publish pages that have been submitted for
publishing by the owner.
The Publication section has separate screens for publishing pages, trends, tags, and
menus.
Each publishing screen is divided into two panels. The panel on the left displays private or
submitted objects, and the panel on the right lists all the public objects.
At the top of the screen is a drop-down list from which you choose to display either private
objects that have not been submitted, or private objects that have been submitted. This
selection is displayed in the panel on the left, grouped by owner.
When an object in the panel on the left is published, it is displayed in the panel on the
right as a public object.
CONFIDENTIAL
216
PUBLISHING
R E A SS I GN IN G O W NE RS H IP
Reassigning ownership is useful as a method of system control. If an object needs to be
edited, it can be assigned to a user to edit, then submitted for review before it is made
public again.
Above the lists of items on the publishing screens is a button that assigns the selected item
to a user. To set a page, tag, or trend as private:
1.
Select the page, tag, or trend in the list on the right.
2.
Click the Set as Private button.
3.
From the list of users that appears, double-click on the user to assign the object to
them.
P U B L IS H I NG
AN
O B JE C T
The publishing screens all have Publish and Reject buttons above the list of users on the
left.
To publish a page, trend, tag, or menu, select it from the list of users on the left, and
click the Publish button. The object is listed as public in the window on the right.
R E JE C TI N G
AN
O BJE C T
You can only reject a submitted page, trend, or tag.
To reject a page, trend, tag, or menu and send it back to the owner, select it and
click the Reject button.
CONFIDENTIAL
217
PUBLISHING
Publish Pages
Open the Page Publishing screen by clicking the Page Publishing
Publication folder.
V IE W
1.
From the drop-down list, select either Submitted Pages or Private Pages.
2.
Expand the list of users to view their pages.
3.
L I ST
OF
S U BM IT TE D
node in the
OR
P R IV A TE P A GE S
If required, Filter
the list of pages.
If required, click Refresh
to refresh the list of pages.
Double-click on the page to open it in a new window or tab in BabelFish.
P U B L IS H I NG
P A GE
A page can only be published when all of the tags it contains have also been published.
However, if a published page contains private menus, then you can still publish the page,
but users will not be able to view the private menus.
Note: When a page is submitted, any private tags on that page are also automatically
submitted. However, if the tag was added to the page after the page was submitted,
the tag is not submitted and will cause an error when attempting to publish the
page.
E D IT IN G
P A GE
A BabelFish administrator can edit any BabelFish page.

1.
Select the page from the list of users.
CONFIDENTIAL
218
PUBLISHING
The page opens in BabelFish Explorer.

2.
On the BabelFish toolbar, click the Page edit

icon.
3.
Make any required changes to the page.
icon, and then click the Design
Publish Trends
Open the Trend Publishing screen by clicking the Trend Publishing
Publication folder.
node in the
The Trend Publishing screen lists the Trends that require publishing, grouped by owner.
V IE W
1.
From the drop-down list, select either Submitted Trends or Private Trends.
2.
Expand the list of users to view their trends.
3.
L I ST
OF
S U BM IT TE D
OR
P R IV A TE T RE ND S
If required, Filter
the list of trends.
to refresh the list of trends.
Double-click on the trend to open it in BabelFish Explorer.
P U B L IS H
T RE ND
A trend can only be published when all tags used in the trend are public.
When a trend is submitted, the private tags on the page are automatically submitted (and
shown with the green tag). If the tag was added to the trend after the trend was
submitted, the tag is not submitted and a warning message is displayed when attempting
to publish the trend.
CONFIDENTIAL
219
PUBLISHING
Publish Tags
Open the Tag Publishing screen by clicking the Tag Publishing
folder.
node in the Publication
Note: When a page is submitted, any private tags on that page are also automatically
submitted.
V IE W
1.
From the drop-down list, select either Submitted Tags or Private Tags.
2.
Expand the list of users to view their tags.
3.
L I ST
OF
S U BM IT TE D
OR
P R IV A TE T A G S
If required, Filter
the list of tags.
to refresh the list of tags.
Double-click on the tag to open it in BabelFish Explorer.
CONFIDENTIAL
220
PUBLISHING
Menu Publishing
Open the Menu Publishing screen by clicking the Menu Publishing
Publication folder.
V IE W
1.
From the drop-down list, select either Submitted Menus or Private Menus.
2.
Expand the list of users on the left to view their menus.
E D IT
L I ST
OF
S U BM IT TE D
node in the
OR
P R IV A TE M E NU S
If required, Filter
the list of menus.

to refresh the list of menus.
M E NU
A BabelFish administrator can edit any BabelFish menu.

1.
Double-click on the menu to edit it.
2.
In the Edit Menu Details dialog box, make any required changes to the page.
3.
Click OK.
D E LE TE
M E NU
A BabelFish administrator can delete any BabelFish menu.

1.
Double-click on the menu to edit it.
2.
In the Edit Menu Details dialog box, click Delete Item.
3.

Note: Deleting a menu also deletes all instances of it on any tags, pages, and
applications.
4.
Click OK.
CONFIDENTIAL
221
BabelFish Configuration
The Entity Name Conflicts function in Enterprise Manager provides a mechanism to resolve
clashes in entity names when importing new entities.
You can supply either a prefix, or a suffix, or both, to add to the entity name to resolve any
name conflicts. These are called conflict resolvers.
CONFLICT_PREFIX
Adds the specified text to the beginning of the entity name. For example, Conflict_
CONFLICT_SUFFIX
Adds the specified text to the end of the entity name. For example, _Test
For example, if a tag already exists with a name of TestTag in the Data Dictionary, then the
tag will be created with a name of Conflict_TestTag_Test.
These conflict resolvers are global, that is they apply across the board to all tags. Some
Datasources (such as Remote BabelFish) have an additional local conflict prefix and suffix.
If these are defined in the tag, then these will be used in place of the global conflict
resolvers. Note that if you need both a prefix and suffix on a tag, then you need to specify
both at either the local or the global level. You cannot specify a local prefix and global
suffix, or vice versa.
Recommendation: Devise a consistent naming standard.
R E NA MI N G
Renaming of conflict resolvers is retrospective. That is, it applies to all entities that already
have a conflict resolver appended.
CONFIDENTIAL
222
BABELFISH CONFIGURATION
PUBLISHING
However, before making the change, Enterprise Manager checks whether or not the
entities will still conflict without a resolver. Any entities that no longer conflict will not use
a conflict resolver.
Renaming conflict resolvers will not affect entities that have had their names manually
changed. It only applies to entities where the entity name equals:
The native name.
The native name plus the tag prefix.
The native name plus the conflict prefix/suffix.
The native name plus the tag prefix, plus the conflict prefix/suffix.
To change the CONFLICT_PREFIX or CONFLICT_SUFFIX, click the
button.
Note: Changing these resolvers will result in renaming of all entities that have an existin g
CONFLICT_PREFIX or CONFLICT_SUFFIX. This includes all the properties and
attributes of the entity. If there are a large number of entities to rename, this may
take some time.
CONFIDENTIAL
223
Task Scheduler
In This Chapter
Add a Scheduled Task
Scheduled Task Properties
Prefix Tags
Rename a Scheduled Task
Delete a Scheduled Task
224
225
236
236
237
The Task Scheduler is part of the default BabelFish Server installation, and allows you to
schedule any task to run at a time convenient for you. Each task created consists of a
schedule, a task type, and a status.
To access the Task Scheduler, click the Scheduler node in the Enterprise Manager
navigation hierarchy.
Note: Before starting the Task Scheduler, it is important to make sure that no transaction
locking is occurring in ISS Enterprise Manager, otherwise frequent timeouts may
occur.
Add a Scheduled Task

To add a new scheduled task:
1.
Open the Add New Task window:

On the Scheduled Task menu, click Add New Task.
Right-click on Scheduled Tasks in the navigation hierarchy and select Add New
Task.
CONFIDENTIAL
224
TASK SCHEDULER
SCHEDULED TASK PROPERTIES
Click on the Scheduler node in the navigation hierarchy, and click Add New Task
in the main window.
2.
In the Add New Task window, type the name of the task you want to add.
3.
Click OK.
The new task appears in the navigation hierarchy underneath the Scheduled Tasks node.
Click on the new node to specify the properties for the task (see page 225).
Scheduled Task Properties

Information for a Scheduled Task is displayed in three tabs:
Schedule (see page 226). Specify when the task is to be run.
Task (see page 227). Specify the type of task to run.
CONFIDENTIAL
225
TASK SCHEDULER
Status (see page 236). View details of when the task was last run.
Schedule a Task
In the Schedule tab of the task object:
1.
From the Type drop-down list, click a schedule type. It can be Continuous, Daily,
Weekly, or Monthly.
The options available depend on the type of task selected, as not all options are
available for all types.
2.
The Run task every options allow you to specify the frequency of the task.
For Daily tasks, specify the time to run the task each day.
For Weekly tasks, specify the day of the week as well as the time.
For Monthly tasks, specify the day of the month as well as the time.
For Continuous tasks:
CONFIDENTIAL
226
TASK SCHEDULER
In the Run task every field, type a numeric value, and choose the type of
frequency you want: minutes, hours, or days.
For the Starting at options, specify the date and time you want the task to
start. Clicking the down-arrow opens the calendar, which you can use to
select the appropriate starting date.
3.
Click the Save button in the Enterprise Manager toolbar.
4.
Click Run Now to manually run the task.
Note: A continuous task defaults to run every one hour. Check that this is appropriate and
update the number if necessary.
Task Type
The Task tab allows you to specify the type of task to run, any filters to apply, and whether
or not to log messages to Mercury. The task options available depend on the type of task
selected.
To select a task:
1.
2.
In the Type drop-down list, select the type of task:
Custom Entity Attribute Synchroniser (see page 228)
Replicate Entity Values (see page 229)
Run External Application (see page 232)
Tag Fetch from Historian (see page 232)
Entity Synchronisation Task (see page 234)
Specify the options pertaining to the task selected in the previous step.
CONFIDENTIAL
227
TASK SCHEDULER
Custom Entity Attribute Synchroniser

Occasionally, an entity may need to be created before all associated tags are available.
When this occurs some (or possibly all) of the template attributes would not be set to tags,
and these would have to be manually set when the tags became available. Given the
potential for a large number of entities in the system, manually administering this would
be difficult.
The Custom Entity Attribute Synchroniser task automates the process of setting attribute
tags that were not able to be set when the entity was created.
It is recommended that this task be scheduled to run nightly to iteratively fill in missing
attributes when the tags become available, based upon the default attribute values.
The configuration options provided also allow you to control the synchronisation so that
only particular entities or templates are synchronised. This is done by using a search
pattern (including wildcards) for the entity name and/or template name that is to be
configured. Only entities and/or templates matching these patterns are processed. For
example, if both an entity mask and a template mask are specified, then only the entities
that match the name mask and have a template that matches the template mask will be
synchronised.
The options are:

Entity Name Mask
The search pattern for the name of the entity you want to synchronise.
Template Name Mask
The search pattern for the name of the template you want to synchronise.
Log status
Select the check box if you want to log the status reports in ISS Logger.
CONFIDENTIAL
228
TASK SCHEDULER
Replicate Entity Values

The Replicate Entity Values task allows you to copy entities from one Datasource to
another, and is often used to create cached tags.
1.
From the Type drop-down list, select Replicate Entity Values.
2.
Update the displayed pre-formatted XML configuration file as appropriate.

<Sample>
Specify the sampling method (and optionally, frequency) to use when fetching data
from the source data source. To specify the sampling method, set the method
attribute to Raw, LastKnownValue, Average, or LinearInterpolate. For every sampling
method aside from Raw, also set the frequency attribute to specify a sampling
frequency in seconds.
<SourceEntity>
The <SourceEntity> element relates to the Datasource containing the tags you want
to replicate. Specify the following:
<Name>
Specify a mask of source entities to transfer. This can be any valid BabelFish
search string. If a source data source name is also specified, the mask is
applied to entities against the Datasource only. Otherwise, it is applied to all
entities in the Data Dictionary.
<DataSource>
Specify a source data source to which to limit the name mask. If these are
portal tags created by any user, then this Datasource will be BabelNet. It is
expected that the data source specified for this exists and is configured
CONFIDENTIAL
229
TASK SCHEDULER
correctly to allow fetching of time-series data. If no Datasource is specified,

the entity name mask will apply to every matching entity in the Data
Dictionary.
<Entities>
Name of the tags. For each tag, add another <Name> </Name> element
bracket. This allows you to specify one or more specific entities to replicate in
the batch. These do not have to be located on the source data source, they
can be assigned with any data source in the Data Dictionary. The data source
that they are configured against needs to be configured for the fetching of
time-series data.
<DestinationEntity>
The <DestinationEntity> element relates to the Datasource in which you want the
caching information to reside. Specify the following:
<Name>
The mask that is used to generate the destination entity names for each entity
that is replicated. This mask is used to generate a regular expression which is
applied to each source entity name in order to obtain the correct destination
entity name. As such, this cannot be as complicated as the source mask.
Only asterisk (*) wildcards are allowed, but there can be more than one, and
they can be placed anywhere. Using the asterisk uses the same tag name that
is located within <SourceEntity> tags, with additional text added to the
beginning or end. For example, Backup.Calc.* adds Backup.Calc. to the start of
every tag name, resulting in the replicated tags being named
Backup.Calc.Tagname.
It is generally understood that the destination mask will usually contain a
section of the source name mask, although it does not have to.
<DataSource>
The name of the Datasource into which the destination entities are to be
replicated. This Datasource needs to be created prior to a replication and
needs to support the writing of time-series data. If no destination Datasource
is specified, it is expected that all generated destination entity names already
exist and are correctly configured in the Data Dictionary. If a destination
Datasource is specified, all generated destination entity names that do not
exist will be created and configured against this Datasource the first time the
replication is run.
Note: If any existing entities have the same name as any one that is generated,
they will be reassigned to this Datasource, so be careful what you use as a
destination mask.
If you want destination entities created on first replication, this limits the type
of data sources you can use as a destination Datasource. The following data
source types are currently supported:
Time-series historian data sources, such as Exaquantum, IP21, PHD, PI.
CONFIDENTIAL
230
TASK SCHEDULER
Time-series OLEDB data sources, such as Oracle (ODBC) and OLEDB

Datasource.
<EntityProfile>
Specify one or more entity profile properties to create or assign to each
destination entity when it is first replicated. Note that each replicated entity
gets a separate entity profile. The only wildcard replacement handled is
%destinationentityname%, which is replaced with the generated destination
entity name for each replicated entity. Note: Entity profiles are only created if
the entities are being replicated into supported destination data source types.
For time-series historian data sources, at least the following entity profile
properties are expected: Min, Max.
For time-series OLEDB data sources, at least the following profile properties
are expected: TagName, AllowUpdates, AllowDeletes.
<RequestProfile>
Specify one or more request profile properties to create or assign to every
destination entity that is replicated. Note that the same request profile will be
assigned to every replicated entity. This functionality is only intended to be
used by time-series OLEDB destination data sources, in which the request
profile specifies the table format into which the data is to be inserted. As such,
this section should be left out if replicating into a historian data source.
For time-series OLEDB data sources, at least the following request profile
properties are expected: SourceTable, TagColumn, TimestampColumn,
ValueColumn.
Note: It is expected that the table specified in the request profile already
exists in the relational database being written to, and that it is correctly
configured to store time-series data (compatible column types and sizes).
<?xml version="1.0" ?>
<Batches>
<Batch>
<Sample method="Raw"/>
<SourceEntity>
<Name>Calc.*</Name>
<DataSource>Calculation Engine Data Source</DataSource>
<Entities>
<Name>Calc.Random.Small</Name>
<Name>Calc.Random.Normal</Name>
</Entities>
</SourceEntity>
<DestinationEntity>
<Name>Backup.Calc.*</Name>
<DataSource>OLEDBCache</DataSource>
<EntityProfile>
<Property name="TagName"
type="STRING">%destinationentityname%</Property>
<Property name="AllowUpdates" type="STRING">true</Property>
<Property name="AllowDeletes" type="STRING">false</Property>
</EntityProfile>
<RequestProfile>
<Property name="SourceTable" type="STRING">BACKUP_CACHE</Property>
<Property name="TagColumn" type="STRING">TAGNAME</Property>
<Property name="TimestampColumn" type="STRING">TIMESTAMP</Property>
<Property name="ValueColumn" type="STRING">VALUE</Property>
CONFIDENTIAL
231
TASK SCHEDULER
</RequestProfile>
</DestinationEntity>
</Batch>
</Batches>
Note: To avoid performance issues, if you want to replicate or cache more than eight tags,
it is advisable to create another set of <Batch></Batch> tags after this first batch.
This restricts the replication process to eight tags per batch so the task does not
become a bottleneck and reduce performance when the task executes.
Run External Application

The Run External Application task provides an easy way of scheduling external programs to
run.
1.
From the Type drop-down list, select Run External Application.
2.
Click the Browse button.
3.
Navigate through Windows Explorer and select the application you want to run.
4.
If required, specify the command line arguments needed for the program to
correctly execute.
Tag Fetch from Historian

The Tag Fetch from Historian task (also known as the Tag Fetcher task) procures tags from
a time series Datasource. During the tag fetch, the task adds entities to the BabelFish Data
Dictionary and synchronises them with BabelFish Explorer.
Note: You must have administration privileges to perform this process.
CONFIDENTIAL
232
TASK SCHEDULER
1.
From the Type drop-down list, select Tag Fetch from Historian.
2.
In the BabelFish Datasource drop-down list, select the Datasource from which you
want to collect tags.
3.
In the Fetch Options group, specify the following:

Fetch from Entity Information File instead of adaptor: Select this check box if you
want to fetch tags from an XML file instead of from the Datasource tag check.
Specify a file in the entry box below, or browse for one. The specified file must be a
valid EntityInformationCollection XML file. A valid file can be obtained from either a
tag fetch writing this from the Adaptor, or a custom application using the SDK to
produce this XML.
Fetch Name Filter: If required, type a filter to specify which tags are to be collected.
You can use wildcards if required.
Fetch Entities in batches: Select this check box if you want to collect the entities as a
batch rather than individually. Batch fetching can be enabled where an Adaptor is
optimised for batch tag fetching. If selected, you also need to specify the Batch Size
(the number of tags per batch, default is 500). Note: This option is not
recommended for Adaptors such as PI, IP21 or PHD.
4.
In the Update Options group, specify the following:

Update Ranges: Forces all ranges to be updated from the Datasource.
Update Namespaces: Forces all entity namespaces to be updated from the
Datasource.
CONFIDENTIAL
233
TASK SCHEDULER
Update Descriptions: Forces all entity descriptions to be updated from the

Datasource.
Update Units: Forces all tag units to be updated from the Datasource.
Update Decimals: Forces all entity decimals to be updated from the Datasource.
Update Entity Type: Forces all entity types to be updated from the Datasource.
Update Data Type: Forces all entity data types to be updated from the Datasource.
5.
In the Logging group, specify your logging requirements:

Log status to logger: Logs all status reports to ISS Logger to aid in debugging any
issues occurring during the tag fetch. It is recommended that the basic log function
be used initially and then removed if no issues are found.
Log verbose status messages: Verbose status messages log every aspect of the tag
fetch and should only be used if required.
6.
In the XML Fetch Reports group, specify your reporting requirements:

Write new tags to XML: Provides a list of tags and their corresponding native
historian name. Typically, it also contains descriptions, units, and the tag ranges. The
file is named %Date% %Datasource% Tag Fetch Results n.xml. If batch fetching is
enabled, one file for each batch is created where n is the batch number.
Write all tags to XML: Provides a list of tags as received from the Datasource.
Typically, it also contains descriptions, units, and the tag ranges. The file is named
%Date% %Datasource% Tag Import.xml.
Both XML files are prefixed with the date and Datasource name and saved to C:\
Program Files\ ISS\ BabelFish\ Services\ Task Scheduler.
Entity Synchronisation Task

The Entity Synchronization Task replaces the ISS BabelFish Entity To Portal Tag Windows
service, which looks for entities that do not have corresponding tags and then creates
them.
Note: This may take a long time to complete for databases that contain a large number of
entities.
The task synchronises the data contained within Time Series type entities to corresponding
Portal tags, creating the new Portal tag if one doesn't already exist. If an entity contains
profile properties or profile attributes, the task also creates a corresponding Portal tag for
each property or attribute.
The task allows you to synchronise entities based on a filter of template name, entity
name, or both. The filtering can include the standard BabelFish wildcard characters:
*
An asterisk represents one or more characters in the object name. For example, t*t
will match test, that, and thought.
CONFIDENTIAL
234
TASK SCHEDULER
?
A question mark represents a single character. For example, t??t will only match test
and that.
After the task finishes, a brief description of the synchronisation is included in the Status
tab, and a more detailed log is saved in the specified location.
The options are:

Filter entities by template
Type the name of the template you want to filter by.
Filter by name
Type the name of the entity you want to filter by.
Batch size
Indicates how large each batch should be when fetching and synchronising entities.
For databases containing a very large number of entities, the scheduled task may not
run if the batch size is set too high. In this case, set the batch size to a lower limit.
Location to save log file
Browse to specify the location to which you want to save the resulting log file.
CONFIDENTIAL
235
TASK SCHEDULER
PREFIX TAGS
Task Status
The output of the Task Status Report varies depending on what happened during the task.
However, it always displays how many (even if 0) new entities or tags were created, and
the start and finish time of the task.
Prefix Tags
The Tag Fetcher (see page 232) allows all tags from a given Datasource to be prefixed.
When a Datasource is prefixed, all entities and tags are named using the prefix. The entity
retains the original name in the entity's Native Name property.
Note: The Tag Fetcher task skips any tags that conflict with existing tags on other
Datasources. When an entity is created, it attempts to set up a corresponding
BabelFish Explorer tag. If another tag exists with the same name but a different
Datasource, the tag is skipped. So if you update the prefix (including clearing it) and
run the scheduled task, it renames all of the Datasource entities and tags using the
prefix. It does not rename any instances of these within a calculation or where the
name is referenced in application components.
It is also possible when changing a prefix to create dead tags in the BabelFish Explorer. For
example, an entity is renamed and there is already a BabelFish Explorer calculation tag
with the same name. The BabelFish Explorer tag no longer points to a valid entity. These
are left in the system. The conflict can be manually resolved by renaming one of the tags
and removing the dead tag.
Rename a Scheduled Task

1.
Right-click on the task in the navigation hierarchy and select Rename.
2.
Type the new name for the task.
3.
Press the Enter key.
CONFIDENTIAL
236
TASK SCHEDULER
DELETE A SCHEDULED TASK
Delete a Scheduled Task

1.
Right-click on the task in the navigation hierarchy and select Delete.
2.
At the confirmation message, click OK.
CONFIDENTIAL
237
Appendix A. Transforms
In This Chapter
Raw Data Sample Interval (Density)
Average
Last Known Value
Linear Interpolate
Legacy Transforms
238
239
240
241
242
Data may be requested raw or processed in some way. Currently the three kinds of data
processing are average, last known value, and linear interpolate. These functions are also
known as aggregate functions because they aggregate raw data into a different format.
It is up to the BabelFish administrator to decide whether an Adaptor returns aggregate
data using aggregate functions supplied by the OPC Server, or using functions supplied
with the BabelFish SDK.
If the administrator wishes to use aggregate functions supplied by the OP C Server, then
they need to specify numeric identifiers for the server functions using the Aggregate
Function fields in the Adaptor configuration. If the BabelFish SDK aggregate function
implementations are to be used, then the Aggregate Function fields in the Adaptor
configuration should be left blank.
Each concrete transform selects data using the raw data delegate supplied, and performs
the appropriate transformation on that data.
Raw Data Sample Interval (Density)

While the aggregate data is being calculated, the request interval is divided into sample
intervals.
For high-density raw data with a large sample interval, a single-point fetch at the sample
interval boundary points improves performance for last known value and linear interpolate
functions, compared with requesting all the raw data for the entire request interval.
There is no reliable way of predicting the performance boost based on the sample interval
and the density of the raw data, so it is left as a configuration parameter for the BabelF ish
administrator.
The parameters configured by the BabelFish administrator are
LINEAR_INTERPOLATE_MAX_RAW_DATA_SAMPLE_INTERVAL
LINEAR_INTERPOLATE_MAX_RAW_DATA_SAMPLE_INTERVAL_ENDPOINT
LAST_KNOWN_VALUE_MAX_RAW_DATA_SAMPLE_INTERVAL
These LINEAR_INTERPOLATE_MAX_RAW_DATA_SAMPLE_INTERVAL and

LAST_KNOWN_VALUE_MAX_RAW_DATA_SAMPLE_INTERVAL parameters represent the
CONFIDENTIAL
238
APPENDIX A. TRANSFORMS
AVERAGE
largest sample interval for which BabelFish will fetch all contained raw data before
performing aggregate data functions.
If the request sample interval is larger than the corresponding parameter, then BabelFish
will perform individual single-point fetches at each interval in order to improve
performance.
The parameter values are configured to a single time value using the same suffixes as the
raw data look-ahead parameter (see page 242). The default value (if the property is not
defined) is 1d (one day). A value of 0 means that all raw data will be fetched regardless of
the sample interval.
Average
Average data sampled over an interval returns a time-weighted average of the raw data
over the specified interval. The set of time-value pairs returned are generated using the
following formula:
The request interval [ts, tf] is divided into intervals using the configured sample interval SI.
If the specified request interval is not an integral multiple of SI, then the returned results
will cover slightly less than the desired interval (this gap is the interval [S2, tf].
As a result, the request interval [ts, tf] will be broken into N intervals, where:
There will be N aggregate values returned at times (s0, s1, , sN), where:
A time-weighted average is calculated for each interval, which factors into the result the
amount of time each raw value was held during the sample interval.
CONFIDENTIAL
239
LAST KNOWN VALUE
In the above figure, the result for the second interval (s1,s2) will be v4, since the value is
constant over the entire interval.
As the raw value changes during (s0,s1), the reported value will be an average of the four
raw values over that interval, weighted by the duration that each raw value is held:
The data used to calculate an average value for s0 is based on an interval of SI that ends at
s0.
To fulfil a request for average-sampled data at a particular instant in time (ti), the Adaptor
examines the raw data over the interval (ti-SI, ti) and calculates the time-weighted average
value over that interval. The value is reported for time ti.
Last Known Value

The calculations of last known value aggregate data returns the last known raw value at
the end of each sampling interval.
As with time-weighted average data, the request interval [ts,tf] is first divided into N
sample intervals, and values are reported for the end of each interval. The set of reported
values are simply the raw value of the input at each of the times (s0, s1, , sN).
In the above figure, the returned data would be three points: (s0,v1), (s1,v4) and (s2,v4).
For last-known-value at a single-point instant, the algorithm looks for the most recent raw
value from the source, but returns it with a timestamp of the requested sample time,
which will be the same or after the raw value's actual time.
CONFIDENTIAL
240
LINEAR INTERPOLATE
Linear Interpolate
For linear interpolate aggregate data, the sample period (ts, tf) is divided into intervals
using the same process as for time-weighted average and last known value.
Sample values are reported at the start of the request period, and all sample interval
boundaries: (s0, s1, , sN).
For each sample point, the formula looks for the most recent raw value and the closest
subsequent raw value, and uses those two values as end points of a line. The value of that
line at the sample point is the returned aggregate value.
In the above figure, the value at s0 is based on the nearest previous value at t1 and the
nearest subsequent value at t2. The value reported at s0 would be:
In some situations, such as the values for s2 and s3, the same two raw value data points
may be used to calculate linear interpolated values for two different sample points.
For the last sample point, the formula will need a raw value potentially beyond the end of
the requested sample period (after tf). The Adaptor looks forward in time using
configuration values to find the next raw value (see page 242).
Note: PI does not natively support Linear Interpolate. Therefore when using the BabelFish
PI Adaptor for a ranged Linear Interpolate fetch, incorrect timestamps may be
returned. To obtain correct results, you need to enable the new transform code for
linear interpolate.
CONFIDENTIAL
241
LEGACY TRANSFORMS
Raw Data Look-Ahead

To implement linear interpolate, the concrete transform needs to fetch data from a time
point after the end of the required time interval. The amount of time the fetch should
"look forward" when scanning for raw data should depend upon the particular Datasource.
Datasources that update every hour should allow the Adaptor to look forward for data in
increments of hours. A Datasource that updates daily indicates that in order to efficiently
find the next raw data point, the Adaptor should immediately start incrementing by days.
The Datasource configuration property AGGREGATE_SCAN_PERIODS tells the Adaptor how
the Datasource should look forward for data. This property contains a comma -separated list
of time periods that the Adaptor should scan when looking for raw data to calculate the
aggregate functions. The time periods default to seconds, but other units can be specified:
Notation
Time Unit
seconds
minutes
hours
days
weeks
For example, for a Datasource that updates regularly, this property might contain
30,1m,10m,1h,1d which signifies "try 30 seconds, then 1 minute, then 10 minutes, then 1
hour, and then 1 day". If this field is not specified or is left blank, then it defaults to
1m,1h,1d. If no data is found after trying the largest of the periods specified, the Adaptor
will give up and return no forward-looking data.
Legacy Transforms
Recently, the logic for the three transforms (average, last known value, linear interpolate, )
has been moved back to some of the older Datasources (PI, PHD, IP21, ODBC and
ODBCWide) and, in the case of PI, PHD, and IP21, can be switched on with the following
parameters configured by the BabelFish administrator:
USE_LEGACY_LINEAR_INTERPOLATE_TRANSFORM
USE_LEGACY_LAST_KNOWN_VALUE_TRANSFORM
USE_LEGACY_AVERAGE_TRANSFORM
Recommendations:
For PHD and PI Adaptors, use the default value of Y for these Datasource
parameters. This means that the transforms are calculated by the historian, which
applies algorithms appropriate for the data they contain. Setting this to N means
that the Adaptor will calculate the transforms on the raw data provided by the
historian.
For ODBC and ODBCWide Adaptors, set the value to N. This means that the current
functionality will be retained, and existing implementations will not be affected.
CONFIDENTIAL
242
Appendix B. Standalone Installation

ISS Enterprise Manager is an administration tool provided to manage the BabelFish Data
Dictionary, Scheduled Tasks, and Security. It can be installed on any client computer to
access BabelFish and security administrative functionalities.
If you need to install ISS Enterprise Manager on a computer other than the BabelFish
server, do the following:
1.
Install the VC++ 2005 Redistributable pre-requisite (if it isnt already installed on the
server) by double-clicking the vcredist_x86_2005.exe program. The installation
window will close on its own after it is done.
2.
Install the VC++ 2008 Redistributable pre-requisite (if it isnt already installed on the
server):
a.
Double-click the vcredist_x86_2008.exe program.
b.
Click Next at the first setup screen.
c.
In the Licence Terms screen, select the I have read and accept the license
terms check box, and then click Install.
d.
At the Setup Complete screen, click Finish.
3.
Double-click the ISSEnterpriseManagerOnly.msi program.
4.
At the Welcome screen, click Next.
5.
In the Licence Agreement screen, select the I accept the terms in the License
Agreement check box, and then click Next.
6.
In the Custom Setup window, unless specifically required, you should accep t the
default installation directory. Otherwise, click Browse to change the location of the
installation directory.
7.
Click Next.
8.
In the Ready to Install screen, click Install.
9.
Administrative privileges are required for the installation. If a security message

appears, click Yes.
10.
When the installation has finished, click Finish.
11.
Copy the file SecurityManager.xml to the folder:

C:\Program Files (x86)\ISS\BabelFish\Admin\PlugIns
Note: If BabelFish Verify is not installed to the default folder, edit the
SecurityManager.xml file to correct the file path.
The software is now ready to use.
CONFIDENTIAL
243
APPENDIX B. STANDALONE INSTALLATION
When launching Enterprise Manager, you may need to run the program using the option
Run as administrator if no profiles are displayed on startup. To do this:
1.
Right-click on the application file:

C:\Program Files (x86)\ISS\BabelFish\Admin\ISSEnterpriseManager.exe
2.
Select Run as administrator.
3.
Click OK if you are prompted to load a plug-in.
Note: If the problem persists and there are no profiles displayed, check the User Account
Control (UAC) setting on the server. You may need to temporarily turn off UAC when
adding and configuring the profiles, or consider turning it off permanently. For more
information on UAC, refer to
http://technet.microsoft.com/en-us/library/cc709691(WS.10).aspx.
CONFIDENTIAL
244
Glossary
Content Provider
See Renderer.
Custom Entity
Accumulator
Plug-in component that recombines
requests separated by the data broker
for returning to client applications.
Adaptor
Plug-in component that is used to
retrieve data from, or push data to, a
data source.
Attribute
A reference to another entity that is
somehow related to the entity. For
example, a customer could have an
attribute of address. In the BabelFish
Data Dictionary, Attributes are
placeholders for dynamic data and
reference other entities within BabelFish.
Attributes are a good way of creating
associations between related entities.
Wells, for example, have related
pressure, temperature, and choke size
entities, and these can be related to the
well entity using template attributes.
See Entity Definition.

Data Dictionary
The BabelFish Data Dictionary is a data
store containing information about data
items stored within BabelFish data
sources. Its role is to store information
about the data items and the way in
which they can be retrieved. Data
Dictionary data sources are a one-to-one
mapping to real world database and
historian data sources.
Data source
A source of data that is required by the
system, typically in the form of a
database, such as Oracle, ODBC,
historians, and so on. All BabelFish
software can interact with data sources.
Datasource
A one-to-one mapping (of data items in
the Data Dictionary) to real world
database and historian data sources.
Default Renderer
Represents a piece of data within a data

source. This is the standard entity used
to model objects such as tags and SQL
statements.
The Renderer that is used when an entity

is double-clicked, such as on the plant
model.
Builder
Component used by adaptors to generate
a result message for the request message
passed to them. Allows adaptors to build
result messages of various formats.
Calculation Entity
Entity whose value is the result of a
calculation. The calculation can include
predefined functions and other
calculation or sourced entities. For
example, summing gas production
entities to get a total production value.
Entity
The unique name given to a piece of data
within BabelFish. The entity is configured
so that applications can use, find and
change the data it represents. All entities
within BabelFish must be configured and
added to the BabelFish Data Dictionary
before they can be used. Entity is also
used to refer to an instance of an item
within the BabelFish Data Dictionary. An
entity may be a physical item or a logical
grouping.
CONFIDENTIAL
245
GLOSSARY
Entity Definition
Message
Allows you to pre-define the entities that

can be created in the Data Dictionary.
These definitions include the templates
(see page 101) that are to be associated
with the entity when it is created, and its
default icon and namespace. Entity
Definitions can have default properties
and attributes, as well as template
tokens.
Any form of request or response made to

or from the OIC. A message can be of any
format, but the majority of messages
made will be in XML format.
Entity Hierarchy
Plug-in component that separates a

single request into multiple requests.
A hierarchical structure of entities

configured to make data easy to locate.
Entities can be located in different places
within the same hierarchy and in multiple
hierarchies. The organisation of the
hierarchies is a very important part of
BabelFish because it provides a
user-friendly way to navigate through the
tens of thousands of data items.
Namespace
A unique category identifier for an entity.
Parser
Plug-in
A module that interacts with ISS
Enterprise Manager to provide
management functionality for another
application programme.
Primary Renderer
See Template.
Legacy terminology that would be the

back up to the Default Renderer. This is
not used and will be removed in future
versions.
Profile
Used when the hierarchy and entities

contained within the hierarchy are
controlled and rendered by a source
outside BabelFish. For example, an
external referenced entity could be
created to generate an SDS hierarchy
containing cargos. When BabelFish
comes to display the SDS section of the
hierarchy, the information in the external
referenced entity directs BabelFish to
query the external system. The external
system returns an XML hierarchy that
BabelFish inserts into its hierarchy tree
representation. An external referenced
entity can have one or more templates
associated with it. The primary template
tells BabelFish how to handle clicks (and
so on) on this part of the hierarchy. All
the entities under the hierarchy defined
by the external referenced entity inherit
the templates associated with the
external referenced entity.
A Profile is a Template Instance that can

be applied to an item in BabelFish.
Profiles are most commonly applied to
entities and Datasources. What the
Profile stores depends on the template
and its intended usage. For an entity, a
Profile would store additional
information about the entity that cannot
be stored in the standard entity
structure. These are typically things that
are used or required by some other
system, such as an historian.
Entity Template
A collection of Profile properties is

usually called a property bag, because it
is a 'bag' full of profile property values.
Property
In the Data Dictionary, Properties are
placeholders for static values, such as
max and min range, pump name, or
CONFIDENTIAL
246
GLOSSARY
document location. A collection of profile

properties is often called a property bag.
Renderer
A display interpreter (Content Provider)
for an entity, used by BabelFish to
determine how to display entity data. For
example, the renderer for a Word
document entity is Microsoft Word, and
the renderer for a tag is the BabelFish
Tag Detail Screen.
Renderer Group
A named item that groups a collection of
Renderers for a given entity, template or
Data Source Type.
Renderer Type
Defines a type of content that can be
associated with a Renderer (Content
Provider). The Renderer Type defines
what can be browsed and added as a
Renderer. A Renderer type may define
the base URL and additional settings
required to define the Renderer.
Request Template
Defines the properties and attributes
that belong to a Request profile, and
determines how to fetch data from a
Datasource for that entity, during data
fetches and tag refreshes.
Shortcut Entity
An entity that is essentially a reference
to an entity in a different hierarchy. For
example, a shortcut entity may be used
in a well reference hierarchy where
multiple well hierarchies are to be
provided. One hierarchy may organise
the well by geographical location,
whereas another has the wells organised
by well type. We want to use the same
well entities in both hierarchies (with the
same child entities), so to do this we
create the wells and their child entities in
one hierarchy and then create a shortcut
to these wells in the other hierarchy.
Sourced Entity
See BabelFish Sourced Entity.
State Tag
A tag whose value at any time is derived
from a set of discrete values. A state can
be a simple binary set, such as on or off,
or can describe a range of set values,
such as small, medium, large. Typically,
the states are represented by numeric
values, with the value corresponding to
the state. For example, 0=off, 1=on.
Summary Entity
Used to organise entities into logical
hierarchies and do not represent a data
item in a data source. As such they are
not associated with a data source and
cannot be used on BabelFish web pages.
An example of a summary entity is a
Field. A field contains a number of wells,
but does not represent a data item in a
data source.
Tag
A label that refers to a piece of data, its
value (time series of values), and its
quality. A series of values can be
returned for a specific time period. There
are three types of tags: Datasource tags,
calculated tags and SQL tags.
Template
In the Data Dictionary, a collection of
properties and attributes to provide a
means of relating static and dynamic
data to entities. A template is a
placeholder for properties and attributes.
It defines the properties and attributes
that profiles derived from it should have.
It only defines what the properties and
attributes are, not their
values/referenced entities. It is possible
through BabelFish to configure pages
that bind to a template rather than a
concrete instance of an entity. For
example, generic well screens where a
single BabelFish page is bound to the
CONFIDENTIAL
247
GLOSSARY
attributes of a generic well template.

From one page a user can step through
different oil well instances (entities)
sharing the same template.
Template Instance
An entity with a template assigned to it.
Template Page
A BabelFish Explorer page that is
configured as a renderer, to contain the
properties and attributes of the
template.
Template token
Data Dictionary properties defined on a
per template basis. They are inputs
required to set default values for
template attributes and properties, and
are stored in the Data Dictionary
database as template properties.
Template tokens are distinguished from
other properties by having a TEMPLATE
TOKEN property type.
CONFIDENTIAL
248
Index
A
Add a Home Page ID 159
Add a New Accumulator 65
Add a New Adaptor 63
Add a New Builder 65
Add a New Parser 64
Add a Template Group to the Hierarchy 18, 102,
108
Add and Delete Templates 51
Add Attribute 107, 116
Add Template Property 106, 111
Allocate Pages 178
Appendix A. Transforms 62, 69
Assign a Renderer to a Template 120, 143
B
BabelFish Configuration 4
BabelFish Data Dictionary 4
BabelFish Sourced Entity 18, 33
Background Color 190, 197
Border 190
Border Width 190, 192
C
Calculation Entity 18, 33
Check for New Tags 16
Configure Menus 178
Create a Datasource 56
Create a Menu 203, 205
Create a Parent or Cascading Menu 204
Create a Renderer 133, 143
Create a Renderer Group 127
Create a Renderer Parameter 134
Create a Renderer Type 127, 134
Create a Template 43, 52, 108, 109, 143, 144
Create an Entity Hierarchy 6
Cursor 190
Custom Entity Attribute Synchroniser 25, 227
D
Data Dictionary Components 76, 77, 78
Data Source Tags 16, 48, 90
Datasource Parameters 62
Datasource Template 90
Datasources 16, 17
Display 190
DSNs 182
E
Edit a Menu 185, 203, 209
Edit a Profile 9
Edit a Template 51, 91
Edit a Template Renderer 59, 120, 123, 143
Edit an Entity 94
Edit Attribute 116, 117
Edit Template Property 111, 114
Entities 6, 17
Entity Data Source 50
Entity Hierarchies 16, 17, 44
Entity Synchronisation Task 227
Entity Templates 50
Export a Datasource 136
Export All 136
Export an Entity Hierarchy 136
External Content Providers 48
External Referenced Entity 18, 54
F
Filter 190
Font 190
Font Family 190, 194
Font Size 190, 194
Font Style 190, 194
Font Weight 190, 194
G
Grant Permissions 168
H
Height 190
How-to
Creating a Template Instance (Profile) 143
Creating Prefixed Tags 236
Creating Templated Pages 101
I
Import and Export 16
M
Margin 190
Messages 66
Modify a Property or Attribute Value 51
O
Object Groups 175
Object Tabs 5
P
Padding 190
Pages 210
Portal Configuration 4
Profiles 6, 8
R
Raw Data Look-Ahead 239, 241
Renderers 50, 56, 102, 119
Replacement Tokens for Menus 204
CONFIDENTIAL
249
INDEX
Replicate Entity Values 227

Run External Application 227
S
Schedule a Task 225
Scheduled Task Properties 225
Search 5, 6, 15, 16, 23, 29, 44, 46, 49
Search Filters 13
Shortcut Entity 19, 24
Sitewide Parameters 165, 168
Summary Entity 18, 33, 141
System DSNs 186
T
Tag Fetch from Historian 145, 227, 236
Task Scheduler 4, 144
Task Status 226
Task Type 225
Template Attributes 111, 142
Template Properties 111, 142
Template Renderers 111, 124
Templates 16, 18, 24, 34, 35, 91, 143, 246
Templates Hierarchy 91, 102, 111
Text Color 190
Text Decoration 190
Toolbar 5
U
User Groups 165, 175
V
Visibility 190
W
Width 190
Z
z-Index 190
CONFIDENTIAL
250

ISS Enterprise Manager 2.6 User&#39;s Guide

Transféré par

Informations du document

Copyright

Formats disponibles

Partager ce document

Partager ou intégrer le document

Options de partage

Avez-vous trouvé ce document utile ?

Ce contenu est-il inapproprié ?

Droits d'auteur :

Formats disponibles

ISS Enterprise Manager 2.6 User&#39;s Guide

Transféré par

Droits d'auteur :

Formats disponibles

ISS Enterprise Manager 2.

ISS ENTERPRISE MANAGER

ISS Group Limited 2013. All rights reserved.

ISS Enterprise Manager Overview ............................................................................... 4

Getting Started .......................................................................................................... 8

BabelFish Data Dictionary ........................................................................................ 16

Create a Renderer Group .........................................................................................................131

Portal Configuration ............................................................................................... 156

BabelFish Configuration .......................................................................................... 222

Prefix Tags ............................................................................................................................. 236

Appendix A. Transforms .......................................................................................... 238

Appendix B. Standalone Installation ......................................................................... 243

Who Should Read this Guide

BabelFish Explorer User's

How to construct BabelFish pages that display information from

Comprehensive reference on the functions available from the

Comprehensive reference on the BabelFish Trending Tool, and how to

Comprehensive reference on all BabelFish shapes.

Release Notes for BabelFish version 2.6.

Installing BabelFish components and configuring BabelFish for first

BabelFish SDK Installation How to install the BabelFish SDK.

How to use the Enterprise Manager tool to manage BabelFish.

How to further configure and optimise your BabelFish installation.

HELP AND SUPPORT

You may also find the following documents useful:

ISS Logger User's Guide

ISS Licence Manager

These documents are available from the ISS Support Group.

Help and Support

PDF documentation supplied in the installation directory.

HELP AND SUPPORT

1300 739 969 (Australia only)

ISS Enterprise Manager Overview

BabelFish module, consisting of the following nodes:

BabelFish Data Dictionary (see page 16)

Task Scheduler module (see page 224).

Important: ISS Enterprise Manager uses transaction locking to facilitate rollbacks.

Enterprise Manager Interface

The ISS Enterprise Manager interface has the following features:

ENTERPRISE MANAGER INTERFACE

Open a new Enterprise Manager profile (see page 9).

Save any changes made to the BabelFish Data Dictionary. It is only

Search (see page 13) for an item in Enterprise Manager.

Right-click on the appropriate tree node.

Click New Tab.

ENTERPRISE MANAGER INTERFACE

Install Enterprise Manager on a computer on the same network as the BabelFish

Use Windows Remote Desktop to connect to a machine on which Enterprise

Logging On and Off

Double-click the ISS Enterprise Manager icon

Select a different profile to open.

If you are unsure, you should call your System Administrator.

Click the New Profile button.

In the Description box, type a profile description.

In the File name box, type a profile file name.

Click on the profile you want to modify.

Click the Edit Profile button.

Click on the plug-ins you need to update.

From the File menu, click Close (File > Close).

Click the Search

tab at the bottom of the Navigation Hierarchy.

In the Look for field, type the search criteria.

The search results appear in a list below the search options.

Double-click on a result to view the details in a new object tab.

ISS Enterprise Manager 2.6 User's Guide

ISS Enterprise Manager 2.6 User's Guide