Reference Guide
D5092
11-Dec-2007
Toolbox
Bristol OpenEnterprise Reference Guide
Toolbox
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D5092
11-Dec-2007 - Page 2
Toolbox
Contents
1 Toolbox..................................................................................................................................... 5
1.1 Toolbox Security Tokens..................................................................................................... 5
1.1.1 Required Tokens .......................................................................................................... 5
1.1.1.1 Mode Token ........................................................................................................... 5
1.1.1.2 Editor Tokens ......................................................................................................... 5
1.1.1.3 Action Tokens ........................................................................................................ 6
1.2 Toolbox W indow..................................................................................................................6
1.2.1 Tools Available ............................................................................................................. 6
2 File Menu .................................................................................................................................. 9
2.1 Select Database.................................................................................................................. 9
2.2 Select Database Dialog....................................................................................................... 9
2.2.1 Select Database Add Button ........................................................................................ 9
2.2.2 Add Database Dialog.................................................................................................... 9
2.2.2.1 New Database Field............................................................................................. 10
2.2.2.2 Defining OpenEnterprise Databases ................................................................... 10
2.2.2.2.1 Local Server/Workstation ............................................................................... 10
2.2.2.2.2 Standalone Server .......................................................................................... 10
2.2.2.2.3 Redundant Server........................................................................................... 10
2.2.3 Select Database Delete Button .................................................................................. 10
2.3 Save Database.................................................................................................................. 10
2.4 Export All ........................................................................................................................... 10
2.5 Export All Dialog................................................................................................................ 11
2.5.1 Output Filename ......................................................................................................... 11
2.5.2 Output File Browse Button.......................................................................................... 11
2.5.3 OK Button ................................................................................................................... 12
2.5.4 Cancel Button ............................................................................................................. 12
3 Security Menu ........................................................................................................................ 13
3.1 Login Dialog ...................................................................................................................... 13
3.1.1 User Name.................................................................................................................. 13
3.1.2 Log Out ....................................................................................................................... 13
3.1.3 Password .................................................................................................................... 13
3.1.4 OK Button ................................................................................................................... 13
3.1.5 Cancel Button ............................................................................................................. 14
3.1.6 Help Button ................................................................................................................. 14
3.1.7 More Button ................................................................................................................ 14
3.1.8 Login Client Database Connection Status.................................................................. 14
3.1.9 Diagnostics Section .................................................................................................... 14
3.1.9.1 Less Button .......................................................................................................... 15
3.1.9.2 Security Server Location...................................................................................... 15
3.1.9.3 Security Server Admin User................................................................................. 15
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D5092
11-Dec-2007 - Page 3
Toolbox
3.1.9.4
3.1.10 Change Password Dialog........................................................................................ 16
3.1.10.1 Old Password...................................................................................................... 16
3.1.10.2 New Password.................................................................................................... 16
3.1.10.3 Confirmation........................................................................................................ 16
3.1.10.4 Change Password Button ................................................................................... 16
3.1.10.5 Cancel Password Change ..................................................................................17
4 View Menu .............................................................................................................................. 18
4.1 Enabling the Export Config Menu ..................................................................................... 18
4.2 Options Dialog................................................................................................................... 18
4.2.1 Time Zone................................................................................................................... 18
4.2.2 SQL History Folder .....................................................................................................18
4.2.3 OK Button ................................................................................................................... 19
4.2.4 Cancel Button ............................................................................................................. 19
4.3 Export Configuration Dialog .............................................................................................. 19
4.3.1 Not Included List ......................................................................................................... 19
4.3.2 Add Button .................................................................................................................. 20
4.3.3 Remove Button ........................................................................................................... 20
4.3.4 Files Included List ....................................................................................................... 20
4.3.5 Pre-export filename .................................................................................................... 20
4.3.6 Pre-export browse button ........................................................................................... 20
4.3.7 Post-export filename................................................................................................... 21
4.3.8 Pre-export Timeout ..................................................................................................... 21
4.3.9 Post-export Timeout ................................................................................................... 21
4.3.10 Run Visible .............................................................................................................. 22
4.3.11 Dataservice as Command Line Parameter ............................................................. 22
4.3.12 OK Button................................................................................................................ 22
4.3.13 Cancel Button.......................................................................................................... 22
4.3.14 Help Button.............................................................................................................. 22
4.3.15 Post-export browse button ...................................................................................... 22
Current User Diagnostics..................................................................................... 15
3.1.9.4.1.1 Logged in.................................................................................................. 15
3.1.9.4.1.2 Location.................................................................................................... 15
3.1.9.4.1.3 Last Password change ............................................................................. 16
3.1.9.4.1.4 Password expires ..................................................................................... 16
5 Mode Menu ............................................................................................................................. 23
5.1 Tool Mode ......................................................................................................................... 23
5.2 Table Mode ....................................................................................................................... 23
5.2.1 Context Menus ........................................................................................................... 24
5.2.1.1 Insert Object ......................................................................................................... 24
5.2.1.2 Modify Objects ..................................................................................................... 24
5.2.1.3 Delete Object ....................................................................................................... 24
5.2.2 Insert Object Dialog .................................................................................................... 24
5.2.3 Modify Objects Dialog................................................................................................. 25
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D5092
11-Dec-2007 - Page 4
6
Index ....................................................................................................................................... 27
Toolbox
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D5092
11-Dec-2007 - Page 5
Toolbox
1 Toolbox
The OpenEnterprise Toolbox resides on both Server and Workstation machines. It contains a suite of
tools that enable the user to configure the Server database.
1.1 Toolbox Security Tokens
Access to the modes and to the editors available within the Toolbox is provided by the assignment of
Custom Security tokens. Custom Security tokens are configured by the User Security Configuration
Tool found within the Toolbox.
1.1.1 Required Tokens
The following tokens are required by ToolBox and the Editors described in this document.
1.1.1.1 Mode Token
If the OEConfig_Table_Mode Custom token is excluded from a user or group, then that user or group
will not have access to the Table Mode of the Toolbox.
1.1.1.2 Editor Tokens
If the following Custom tokens are excluded from a user or group, then the user or group will not have
access to the Editor within the Toolbox, and its icon will be removed.
BristolBabcock.OEAlarmPriorities The Alarm Priorities Tool
BristolBabcock.OEHistoricalConfig
BristolBabcock.OEConfigAlarmConditions
BristolBabcock.OEDiaryConfig
BristolBabcock.PatternConfig
BristolBabcock.OECalculationConfig
BristolBabcock.OEConfigObjectUnlock
The Historian Tool
The Alarm Conditions Tool
The Diary Tool
The Pattern Configuration Tool
The Calculation Configuration Tool
The Object Unlocking Tool
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D5092
11-Dec-2007 - Page 6
Toolbox
BristolBabcock.OEConfigNW3000
BristolBabcock.OESecurityConfig
1.1.1.3 Action Tokens
If the following Custom tokens are excluded from a user or group then the user or group will not be
able to perform the operations indicated whilst in Table mode.
OEConfig_Modify_Objects
OEConfig_Insert_Objects Required to be able to insert objects
OEConfig_Delete_Objects Required to be able to delete objects
The NW 3000 Configuration Tool
The User Configuration Tool
Required to be able to modify objects
when using table mode.
when using table mode.
when using table mode.
1.2 Toolbox Window
When the Toolbox starts, the login dialog appears. The available Tools depend on the Custom
security tokens granted to the logged in User.
1.2.1 Tools Available
• NW3000 Setup
Enables fast setup of NW3000 RTUs for use with OpenEnterprise . It is available only from the
Toolbox on the Server.
• NW3000 Advanced Config
Advanced configuration tool for NW3000 RTUs. This tool is available from the Toolbox on both
Server and Workstation.
• Monitor
Enables the monitoring of NW3000 and ControlWave RTU specific statistics, including Accol
versions and all types of data collection (RBE, Remote Alarm and Template).
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D5092
11-Dec-2007 - Page 7
• NW3000 Archive Configuration
Enables the importation of configuration set-up for audit and archive files from NW3000 RTUs
to the OpenEnterprise database. This tool is only available from the Toolbox on the
OpenEnterprise Server.
• Reporting Configuration Tool
A key component of the OpenEnterprise Report Suite. Enables the configuration of
OpenEnterprise Reports. The other components are the Report Plug-in
Scheduler.
• Calculation tool
Enables calculations to be scheduled for OpenEnterprise applications. Ready to run
calculations are available, for which only signal names need to be provided by the user.
• Alarm Condition tool
Enables the configuration of all types of local alarm conditions.
• Alarm Priority tool
Toolbox
and the Report
Enables the configuration of local alarm priorities.
• Security Configuration tool
Enables total control of all security configuration for any OpenEnterprise application.
• Messaging Configuration tool
Enables the configuration of Messaging Recipients and Routines.
• Historian Configuration tool
Enables the user to configure historical streams and datasets for archiving.
• Archive File Management tool
Enables configuration of historical archiving. Saved historical archive files can be easily
identified and brought online
• Diaries and Calendar Configuration Tool
Enables the configuration of Diaries which can be associated with Patterns or used with
calculations (via the Calculation tool) to schedule signal updates.
• Pattern tool
Configuration of Trigger, Control Curve and On/Off patterns to use with Diaries for scheduling
updates on signals.
• Locked Objects tool
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D5092
11-Dec-2007 - Page 8
Normally, any objects configured using the configuration tools of the Toolbox are locked to
support database integrity, and then released automatically. The Locked Objects tool provides
the ability to manually unlock objects which failed to be released during unusual
circumstances.
Toolbox
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D5092
11-Dec-2007 - Page 9
Toolbox
2 File Menu
The File menu provides a Select Database option and a Save Database option. The Save Database
option will be disabled for OpenEnterprise Workstations, and the Select Database option will be
disabled for OpenEnterprise Servers .
2.1 Select Database
For OpenEnterprise Workstations, selecting the 'Select Database' option displays the Select
Database Dialog. The option can be disabled by opening the Settings Editor and finding the following
value: -
Key: OpenEnterprise\Tasks\OEToolBox
Value: DisableSelectDatabase
Then set the value's data to 1. This allows the user to add or delete valid data sources. The Toolbox
will attempt a connection with the database that is currently selected from this list
2.2 Select Database Dialog
The Select Database dialog box allows database names to be entered and the current database to be
selected. Click on the [Add] and [Delete] buttons on the image below for further information.
2.2.1 Select Database Add Button
This button opens the Add Database dialog which enables a new database name to be entered. The
list of databases and the name of the currently selected Database is saved to the OpenEnterprise
settings file between sessions of the ToolBox.
2.2.2 Add Database Dialog
The example below shows a redundant database reference being added to the Toolbox list of
databases.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D5092
11-Dec-2007 - Page 10
2.2.2.1 New Database Field
Allows the user to enter the name of a new database for Toolbox to connect to.
2.2.2.2 Defining OpenEnterprise Databases
There are certain rules for defining OE Databases, depending on the OpenEnterprise installation type.
2.2.2.2.1 Local Server/Workstation
A local OpenEnterprise Database is referred to either by its TCP port number or the name that has
been assigned to the port. By default the port number is 1101, and the name given to this port in the
Services file is 'rtrdb1'. The Services file can be found in the C:\%WinDir%\System32\Drivers\etc
directory.
Toolbox
2.2.2.2.2 Standalone Server
A standalone OE Database is referred to by the Host name of the OE Server (as defined in the Hosts
file in the same directory as the Services file) followed by a colon, followed by the designated TCP
Services file name or Port number for the Database. This will be in the form: 'OEStandaloneServer:rtrdb1'.
2.2.2.2.3 Redundant Server
A redundant OpenEnterprise Database reference must contain the Host file name and TCP Services
name of both Servers, separated by a comma as follows: -
'OERedundantServer1:rtrdb1,OERedundantServer2:rtrdb1'.
2.2.3 Select Database Delete Button
This button will remove the current database from the list.
2.3 Save Database
For Servers, selecting the Save Database option will perform a 'save into realtime.dat', saving the
current contents of the real-time database into the 'realtime.dat' file.
2.4 Export All
This option is only available if a designated Administrative user is logged on at the OpenEnterprise
Server. The option can be disabled by using the Settings Editor to set the following value data to 1: -
Key: OpenEnterprise\Tasks\OEToolBox
Value: DisableExportAll
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D5092
11-Dec-2007 - Page 11
Toolbox
When selected, the 'Export All
configuration created by the configuration tools can be initiated.
' dialog is displayed, and the process of exporting all current database
2.5 Export All Dialog
The 'Export All' dialog enables you to confirm the default output filename, or to define another.
2.5.1 Output Filename
The output file name field will be initially populated with the default filename, as shown. You may
choose to override this initial selection either by means of the browse […] button, or by directly typing
into the edit box.
2.5.2 Output File Browse Button
Selection of the Output File Browse button will display the Windows™ 'Save As' dialog. You can
select the directory and file name of your choosing.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D5092
11-Dec-2007 - Page 12
Toolbox
2.5.3 OK Button
Selecting the OK button will begin the Export All process. The 'Export All Status' dialog will be
displayed. This will inform you of the progress of the Export All process. When the process is
complete, any errors will have been displayed in separate message boxes, and the steps of the whole
process will be displayed sequentially in the Process List. The [Close] button will be enabled when
the process has completed. Select it to close the dialog.
2.5.4 Cancel Button
Selecting the Cancel button will dismiss the dialog without beginning the Export All process.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D5092
11-Dec-2007 - Page 13
Toolbox
3 Security Menu
When running from a Workstation, the Toolbox has to log the user into the Server database. Selection of the Login... menu option will display the Login dialog
Note that this option is disabled when running the Toolbox from an OpenEnterprise Server, since the
Toolbox logs in automatically as an administrative user.
3.1 Login Dialog
The Login dialog provides enterable Username and Password text fields Click the hotspots* on the dialog below for help on each feature.
, which enables the user to login.
3.1.1 User Name
The user must type in a valid user name. The user name will automatically be displayed in uppercase.
3.1.2 Log Out
If selected, the current user is logged out.
3.1.3 Password
The user's password must be typed in here, using the correct case throughout. The password string is
displayed as asterisks.
3.1.4 OK Button
When selected, a login attempt is made using the username and password provided. If the login was
unsuccessful, an error message will be displayed.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D5092
11-Dec-2007 - Page 14
Toolbox
3.1.5 Cancel Button
Selection of this button aborts the login attempt.
3.1.6 Help Button
Selection of this button provides context sensitive help (this help file).
3.1.7 More Button
If selected, an additional area of the dialog is displayed. This provides details of the currently logged
in user along with the Administrator user login. The Administrator login refers to the name with which
the Security Manager has logged into the Iconics Security Server. This is necessary to enable the
transfer of updates of information about the currently logged in user. Absence of an Administrator
login could indicate problems. Click the link below to view the extra dialog information.
3.1.8 Login Client Database Connection Status
The Login Client status bar displays: -
• The current user;
• The configured Security Configuration Database;
• An icon indicating the current connectivity status of the Security Manager to the database.
An icon with a green surround indicates the Security Manager is connected to the database. An icon
with an amber surround indicates that the Security Manager is trying to connect to the database. An
icon with a red surround and red cross-bar indicates the Security Manager is not connected to the
database and is not trying to connect.
For example, the Login Client shown in the Login_Dialog
OpenEnterprise and the Security Configuration Database is 'oeserv3:rtrdb1', which is currently
connected to the Security Manager.
indicates user 'SYSTEM' is logged on to
3.1.9 Diagnostics Section
A dialog displaying diagnostic information is displayed when the [More >>] button is selected.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D5092
11-Dec-2007 - Page 15
Toolbox
3.1.9.1 Less Button
When this button is selected, the diagnostic information part of the Login dialog disappears. Click the
link below to see it's normal appearance.
3.1.9.2 Security Server Location
This field informs the user of the physical location of the Iconics Security Server. This will always
show the value Local, indicating that the Security Manger and Iconics Security Server are sited on the
same computer.
3.1.9.3 Security Server Admin User
This field indicates the name of the user being used to perform the administrative log on to the Iconics
Security Server. Remember that this can be, (and often will be) a different user to that logged on to
the system. One of the most common causes of problems with security will result from there being no
administrative user logged on to the Iconics Security Server.
3.1.9.4 Current User Diagnostics
The Current User Group Box displays additional diagnostic information.
3.1.9.4.1.1 Logged in
This field indicates the time the user logged onto the OpenEnterprise system on the Workstation.
3.1.9.4.1.2 Location
This is the name of the Workstation, on which the user is logged on, which will currently always be the
workstation on which the Login Client is running.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D5092
11-Dec-2007 - Page 16
3.1.9.4.1.3 Last Password change
This field indicates when the user last changed their password.
3.1.9.4.1.4 Password expires
This field indicates when the users password is due to expire, if at all.
Toolbox
3.1.10 Change Password Dialog
The Change Password Dialog enables the user to change their password. The 'Change Password'
button will not be enabled unless there is a current user, and it cannot be used to change the
password for any user other than the current user.
3.1.10.1 Old Password
The user should enter the old password here. Should this be incorrect, there will be an error message
given when the OK button is clicked, and the password will not be changed.
3.1.10.2 New Password
The new password is typed in here.
3.1.10.3 Confirmation
The new password must be typed in again here. The password will not be changed until the
Confirmation matches the New Password exactly.
3.1.10.4 Change Password Button
When the user selects the OK button, the server attempts to update the user's password. If the
password change is successful, the following message will be displayed:
A journal message of the following form will be inserted into the Event Log:
The password has been changed for user simon.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D5092
11-Dec-2007 - Page 17
If the confirmation field does not match the New Password exactly, or the Old Password was
incorrect, there will be an error message given when the user clicks the OK button, and the dialog will
be presented to the user again for correction. No password change will take place until these items
are correct.
3.1.10.5 Cancel Password Change
If this button is selected, the Change Password dialog will close and no changes to the users
password will be applied.
Toolbox
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D5092
11-Dec-2007 - Page 18
Toolbox
4 View Menu
The Options... menu item displays the Options dialog which enables you to change the Time Zone and the directory where Toolbox saves its SQL history logfile.
4.1 Enabling the Export Config Menu
The Export Config... menu item displays the Export Configuration dialog. This menu item can be
enabled by using the Settings Editor to set the DisableExportAll value to 0 on the following key: -
Key: OpenEnterprise\Tasks\OEToolBox
4.2 Options Dialog
The Options dialog box enables the user to set the Toolbox Time Zone and also to change the
location of the Toolbox SQL history log file. Click the hotspots* on the dialog below for help on each
feature.
4.2.1 Time Zone
This allows the user to select the time zone which will be used whenever ToolBox or any of the editor
tools displays a date/time.
4.2.2 SQL History Folder
This allows the user to specify where ToolBox will record any SQL transaction strings sent to the any
server data service.
ToolBox maintains a database transaction log file for each tool. The file is named <tool name>.sql
(e.g. transactions from the Historian tool will be written to a file named historian.sql). The file contains
the date, time and SQL of each transaction made by the tool. The [Browse] button displays a
standard directory browser if a different destination folder is required.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D5092
11-Dec-2007 - Page 19
Both options on this dialog are saved to the OpenEnterprise settings file.
Toolbox
4.2.3 OK Button
When selected, any changes made to the Options dialog will be applied, and the dialog will be closed.
4.2.4 Cancel Button
When selected, the Options dialog will close. Any changes made on the dialog will not be applied.
4.3 Export Configuration Dialog
The 'Export Configuration' dialog enables the user to select the configuration tools which will be used
to generate the Export All output file.
4.3.1 Not Included List
This is a list of all available configuration editors. When an item is selected from this list and added to
the 'Included' list, it is removed from this list.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D5092
11-Dec-2007 - Page 20
Toolbox
4.3.2 Add Button
This button is disabled until an item from the 'Not Included' list is selected. The selected editor can
then be added to the 'Files Included' list by selecting this button. The editor will then be removed from
the 'Not Included' list.
4.3.3 Remove Button
This button is disabled until an editor from the 'Files Included' list is selected. The selected item can
then be removed from the 'Files Included' list by selecting this button. The file will be replaced back
into the 'Not Included' list.
4.3.4 Files Included List
This list displays the configuration editors that will be used in the Export All process in the actual order
that they will be called. The order can be changed by dragging and dropping items up or down the list
within this window. Other editors can be added by selecting them from the 'Not Included' list and
selecting the [Add] button.
When the [OK] button is selected, the Editors, and the order they should be called to perform the
Export All function will be stored in the Export (DWORD) value on the particular editor's key, found in:
HKLM\SOFTWARE\
BristolBabcock\OpenEnterprise\Tasks\OEToolBox\Editors\<EditorName>
A non-zero Export value will indicate that the configuration tool should be included in the ‘Export All’
operation. This number will also dictate the ordering of invoking the tool in the Export All process, with
a lower number being invoked first.
4.3.5 Pre-export filename
This is the name of a pre-build file, (e.g. .cmd, .exe, .bat), that will be triggered as part of the ‘Export
All’ operation. When the [OK] button is selected, the full path-filename for this file will be saved to the
PreExport value in the OpenEnterprise settings file, on the following key: -
Key: OpenEnterprise\Tasks\OEToolBox
Toolbox will pass the dataservice of the OpenEnterprise Server upon which the ‘Export All’ is being
performed, as parameters to the pre-build file. This will allow systems to support multiple databases.
Whenever a user triggers an ‘Export All’, Toolbox will first invoke the pre-build file, (e.g.
pre_export.cmd). Once this has completed, then the applicable Configuration Tools will be requested
to perform their Exports, and then finally the post-build file will be invoked, (e.g. post_export.cmd).
Toolbox will inform the user of any error that is returned by the pre and post build files.
4.3.6 Pre-export browse button
Displays a standard File Open dialog for either the Pre-export or Post-export command file,
depending upon which file browse was selected. This dialog will be similar for either file, differing
simply by the appropriate initial filename.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D5092
11-Dec-2007 - Page 21
4.3.7 Post-export filename
Toolbox
This is the name of a post-build file, (e.g. .cmd, .exe, .bat), that will be triggered as part of the ‘Export
All’ operation. When the [OK] button is selected, the full path-filename for this file will be saved to the
PostExport value in the OpenEnterprise settings file, on the Toolbox key: -
Key: OpenEnterprise\Tasks\OEToolBox
Use the Settings Editor to view this value and its data.
Toolbox will pass the dataservice of the OpenEnterprise Server upon which the ‘Export All’ is being
performed, as parameters to the post-build file. This will allow systems to support multiple databases.
Whenever a user triggers an ‘Export All’, Toolbox will first invoke the pre-build file, (e.g.
pre_export.cmd). Once this has completed, then the applicable Configuration Tools will be requested
to perform their Exports, and then finally the post-build file will be invoked, (e.g. post_export.cmd).
Toolbox will inform the user of any error that is returned by the pre and post build files.
4.3.8 Pre-export Timeout
Contains the timeout value, in seconds, for the Pre-export command file. If the value is set to zero
then the process will wait indefinitely. If the value is not defined in the OpenEnterprise settings file,
then a default value of 30 seconds will be used and stored.
This value is stored in the PreTimeout value of the following OpenEnterprise settings key: -
Key: OpenEnterprise\Tasks\OEToolBox
Use the Settings Editor to view this value and its data.
4.3.9 Post-export Timeout
Contains the timeout value, in seconds, for the Post-export command file. If the value is set to zero
then the process will wait indefinitely. If the value is not defined in the OpenEnterprise Settings file ,
then a default value of 30 seconds will be used and stored.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D5092
11-Dec-2007 - Page 22
This value is stored in the PostTimeout value of the following key in the OpenEnterprise settings file: -
Key: OpenEnterprise\Tasks\OEToolBox
Use the Settings Editor to view this value and its data.
Toolbox
4.3.10 Run Visible
If checked, this specifies that the pre/post-export command file will run in hidden mode and, as such,
no user interaction will be possible.
4.3.11 Dataservice as Command Line Parameter
When checked, Toolbox will pass the dataservice of the OpenEnterprise Server upon which the
‘Export All’ is being performed, as parameters to the pre-build file. This allows systems to support
multiple databases.
4.3.12 OK Button
When selected, the configuration details on the dialog will be saved.
4.3.13 Cancel Button
When selected, the Export Configuration dialog will close without saving any of the currently
configured settings.
4.3.14 Help Button
Selection of this button provides context sensitive help (this help file).
4.3.15 Post-export browse button
Displays a standard File Open dialog for either the Pre-export or Post-export command file,
depending upon which file browse was selected. This dialog will be similar for either file, differing
simply by the appropriate initial filename.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D5092
11-Dec-2007 - Page 23
Toolbox
5 Mode Menu
This menu item exposes two options - Table and Tool. The Tool item is normally ticked, which means the Toolbox is normally in Tool mode
Table mode
Note that if the Toolbox is being run from an OpenEnterprise Server, that these two options will be
disabled and the Toolbox will be in Tool mode.
. Click on the hotspots* below for links to the Tool and Table mode topics.
5.1 Tool Mode
Toolbox defaults to Tool mode, in which case it displays the configuration tools in it's window, as
shown below.
. If the Table option is selected, the Toolbox window will go into
5.2 Table Mode
In Table Mode the main window is populated with the tables that make up the schema of the
connected database. Table Mode can be considered as an 'expert mode' where the user is
considered to have a good knowledge of the Database schema.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D5092
11-Dec-2007 - Page 24
Toolbox
5.2.1 Context Menus
Right clicking on a table name will display a context menu containing actions that can be performed
on that table or the records in that table.
5.2.1.1 Insert Object
The Insert Objects
the currently selected table.
5.2.1.2 Modify Objects
The Modify Objects dialog
defines the browser. This allows the most appropriate browser to be used for the objects in the table.
5.2.1.3 Delete Object
The Delete Objects dialog is displayed to allow the user to select an object to delete.
dialog will be displayed allowing the user to populate the attributes for an object of
is displayed to allow the user to select an object to update. The editor
5.2.2 Insert Object Dialog
The Insert Objects dialog enables you to insert objects into an database. The field that is displayed in
blue type is the key attribute of the selected table. If there are other not-null fields that are not filled in
a message will be displayed when the [Add] button is selected informing you that the field needs to
be filled in before the object can be added to the database.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D5092
11-Dec-2007 - Page 25
Toolbox
When the user completes the form and presses the [Add] button the change will be committed to the
Database. If any errors occur the user will be asked to fix the problems and resubmit the object to the
Database.
Once an object has been successfully committed to the Database the user will be prompted to add
another object or to cancel from the action.
To be able to insert objects it is necessary for the OEConfig_Insert_Objects security token to be
defined for the current user. If this token is not defined an error will be reported.
5.2.3 Modify Objects Dialog
This dialog enables you to modify the selected object. You can modify any attribute except the
primary key. The primary key attribute is displayed in blue type. The value field of the primary key is
non-editable.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D5092
11-Dec-2007 - Page 26
Toolbox
Once the selected object has been successfully committed to the Database the user will be returned
to the browser and allowed to select another object to update or to cancel from the action.
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D5092
11-Dec-2007 - Page 27
Toolbox
6 Index
A
Add Database Dialog .................................. 6
C
Cancel Button............................................ 12
Change Password ..................................... 15
Change Password Dialog.......................... 14
Confirmation .............................................. 15
Current User Diagnostics .......................... 14
I
Insert Objects Dialog ................................. 27
L
Less Button ............................................... 13
Log Out...................................................... 11
Login Client Status Bar ............................. 12
Login_Dialog ............................................. 11
M
Mode ......................................................... 25
Mode Menu ............................................... 25
Modify Objects Dialog ............................... 28
More Button............................................... 12
More Button Diagnostic Dialog.................. 13
S
Security Menu............................................11
Security Server Admin User ......................14
Security Server Location ...........................13
Select Database Add Button .......................6
Select Database Delete Button ...................7
Select Database Dialog ...............................5
SQL History Folder ....................................18
T
Table Mode................................................26
Time Zone..................................................17
U
User Name.................................................11
V
View Menu .................................................17
N
New Database Field .................................... 6
New Password .......................................... 15
O
OEToolbox Overview .................................. 1
OEToolbox Security Tokens ....................... 1
OEToolbox Window .................................... 2
OK Button.................................................. 12
Old Password ............................................ 15
OpenEnterprise Databases
Defining ................................................... 6
OpenEnterprise Databases......................... 6
Options Dialog........................................... 17
P
Password................................................... 12
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Reference Guide
D5092
11-Dec-2007
NOTICE
Remote Automation Solutions (“RAS”), division of Emerson Process Management shall not be liable for technical or editorial errors in this manual or omissions from this
manual. RAS MAKES NO WARRANTIES, EXPRESSED OR IMPLIED, INCLUDING TH E IMPLIED WARRANTIES OF MERCHANTABILITY AND F ITNESS FOR A
PARTICULAR PURPOSE W ITH RESPECT TO THIS MANUAL AND, I N NO EVENT SHALL RAS BE LIABLE FOR ANY INCID ENTAL, PUNITIVE, SPECIAL OR
CONSEQUENTIAL DAMAGES INCLUDING, BUT NOT LIMITED TO, LOSS OF PRODUCTION, LOSS OF PROFITS, LOSS OF REVENUE OR USE AND COSTS
INCURRED INLCUDING WITHOUT LIMITATION FOR CAPITAL, FUEL AND POW ER, AND CLAIMS OF THIRD PARTIES.
Bristol, Inc., Bristol Babcock Ltd, Bristol Canada, BBI SA de CV and the Flow Computer Division are wholly owned subsidiaries of Emerson Electric Co. doing business as
Remote Automation Solutions (“RAS”), a division of Emerson Process Management. ROC, FloBoss, ROCLINK, Bristol, Bristol Babcock, ControlWave, TeleFlow and
Helicoid are trademarks of RAS. AMS, PlantWeb and the PlantWeb logo are marks of Emerson Electric Co. The Emerson logo is a trademark and service mark of the
Emerson Electric Co. All other trademarks are property of their respective owners.
The contents of this publication are presented for informational purposes only. While every effort has been made to ensure informational accuracy, they are not to be
construed as warranties or guarantees, express or implied, regarding the products or services described herein or their use or applicability. RAS reserves the right to
modify or improve the designs or specifications of such products at any time without notice. All sales are governed by RAS’ terms and conditions which are available
upon request.
RAS does not assume responsibility for the selection, use or maintenance of any product. Responsibility for proper selection, use and maintenance of any RAS product
remains solely with the purchaser and end-user.
Engineered and supported by:
Remote Automation Solutions,
Bristol Babcock Ltd. Blackpole Road, Worcester, WR3 8YB, UK
Reg office: 2nd Floor, Accurist House, 44 Baker Street, London, W1U 7AL
Registered in England and Wales, Reg No. 2580226
VAT Reg No. GB 880 9839 67
Toolbox
Emerson Process Management
Remote Automation Solutions
1100 Buckingham St
Watertown, CT 06795
T 1 (860) 945 2200
F 1 (860) 945 2278
www.EmersonProcess.com/Remote
binfo@EmersonProcess.com
© 2007 Remote Automation Solutions, division of Emerson Process Management. All rights reserved.
Emerson Process Management
Remote Automation Solutions
Blackpole Road
Worcester, WR3 8YB
T 44 (0) 1905 856848
F 44 (0) 1905 856930
www.EmersonProcess.com/Remote
oedsupport@EmersonProcess.com
Loading...