Remote Automation Solutions Guide: OpenEnterprise Archive File Configuration Reference Guide Manuals & Guides
Page 1
Reference Guide
D301477X412
April 2012
OpenEnterprise Archive File
Configuration Reference Guide (V2.83)
Remote Automation Solutions
Website: www.EmersonProcess.com/Remote
Page 2
Reference Guide
D301477X412
April 2012
Archive File Configuration
Contents
1 Archive File Manager Config Tool..........................................................................................1
1.1 Overview .............................................................................................................................1
2 Archived Data...........................................................................................................................1
2.1 Archives Tree Pane.............................................................................................................2
2.2 Source Tables.....................................................................................................................3
2.3 Logging Stream...................................................................................................................3
2.4 Dataset................................................................................................................................3
2.5 Archive State Indicator........................................................................................................3
2.6 Offline Archive Files............................................................................................................3
2.7 Online Manual Archives......................................................................................................4
2.8 Online Automatic Archives..................................................................................................4
2.9 Archives Unavailable...........................................................................................................4
2.10 Notes on Automatically Online Archives..........................................................................4
2.11 Individual Archive Files....................................................................................................4
2.12 Properties Button.............................................................................................................4
2.13 Bring Online Button..........................................................................................................5
2.14 Take Offline Button..........................................................................................................5
2.14.1 Take Offline Timeout Setting.....................................................................................6
2.15 Select Data Button...........................................................................................................6
2.16 Refresh Button.................................................................................................................6
2.17 Add Archives Button........................................................................................................6
2.18 Archive Groups................................................................................................................7
2.19 OK Button ........................................................................................................................7
2.20 Cancel Button..................................................................................................................7
2.21 Apply Button ....................................................................................................................7
2.22 Help Button......................................................................................................................7
2.23 Dataset Properties...........................................................................................................7
2.23.1 Control.......................................................................................................................8
2.23.2 Compression.............................................................................................................8
2.23.3 Offline Folder.............................................................................................................8
2.23.4 Limit Online Archive Files..........................................................................................8
2.23.5 View Options.............................................................................................................8
2.23.5.1 'Sticky' options......................................................................................................8
2.23.6 View by......................................................................................................................9
2.23.6.1 Logging an Indexed Date/Time Field....................................................................9
2.23.7 Order by ..................................................................................................................10
2.23.7.1 Creation date......................................................................................................10
2.23.7.2 Most recent data available..................................................................................10
2.23.7.3 Oldest data available..........................................................................................10
2.23.8 OK Button................................................................................................................10
2.23.9 Cancel Button..........................................................................................................10
2.23.10 Help Button ..........................................................................................................11
2.24 Archive File Properties...................................................................................................11
2.24.1 Control.....................................................................................................................11
2.24.2 Compression...........................................................................................................11
2.24.3 File Path..................................................................................................................11
- i -
Page 3
Reference Guide
D301477X412
April 2012
Description ..............................................................................................................11
2.24.4
2.24.5 Creation Time..........................................................................................................12
2.24.6 Start Time................................................................................................................12
2.24.7 End Time.................................................................................................................12
2.24.8 Status......................................................................................................................12
2.24.9 Archive File Name Analysis ....................................................................................12
2.24.9.1 Group ID.............................................................................................................12
2.24.9.2 Compression Rate..............................................................................................12
2.24.9.3 Year....................................................................................................................12
2.24.9.4 Month..................................................................................................................12
2.24.9.5 Day......................................................................................................................12
2.24.9.6 Time....................................................................................................................12
2.24.9.7 Timespan............................................................................................................12
2.24.9.8 Serial Number..................................................................................................... 12
2.24.9.9 File Extension.....................................................................................................13
2.25 Online Properties...........................................................................................................13
2.25.1 Table .......................................................................................................................13
2.25.2 Control.....................................................................................................................13
2.25.3 Archive File List.......................................................................................................13
2.25.4 Keep Online Indefinitely..........................................................................................13
2.25.5 Keep Online For......................................................................................................13
2.25.6 Keep Online Until....................................................................................................14
2.25.7 Bring Online [OK] Button.........................................................................................14
2.26 Select Data....................................................................................................................14
2.26.1 Select Data - Table .................................................................................................14
2.26.2 Select Data - Name Column ...................................................................................14
2.26.3 Select Data - Name.................................................................................................15
2.26.4 Browse For Objects.................................................................................................15
2.26.4.1 Browse for Objects Filter Grid.............................................................................15
2.26.4.2 Browse for Objects Refresh Button....................................................................15
2.26.4.3 Browse for Objects Options Dialog.....................................................................16
2.26.4.3.1 Browse for Objects Options Dialog...............................................................16
2.26.4.3.2 Prompt for Filter............................................................................................16
2.26.4.3.3 Number of Objects to Retrieve per Query....................................................16
2.26.4.4 Browse for Objects List.......................................................................................16
2.26.4.5 Browse for Objects Next Button..........................................................................16
2.26.4.6 Browse for Objects [OK] Button..........................................................................16
2.26.5 Select Data - Control...............................................................................................16
2.26.6 Select Data - Compression.....................................................................................16
2.26.7 Select Data - Start Time and End Time..................................................................17
2.26.8 Select Data Bring Online Button .............................................................................17
2.27 Archive File Import.........................................................................................................17
2.27.1 Online Directory ......................................................................................................18
2.27.2 Example Online Directory Set-up............................................................................18
2.27.3 Archives List............................................................................................................18
2.27.4 Keep Files Online After Import................................................................................18
2.27.5 OK Button................................................................................................................18
2.27.6 Cancel Button..........................................................................................................18
2.27.7 Help Button..............................................................................................................18
Archive File Configuration
- ii -
Page 4
Reference Guide
D301477X412
April 2012
Backups..................................................................................................................................18
3
3.1 List of Backup Sets ...........................................................................................................19
3.2 Backup Properties Button .................................................................................................19
3.3 Add Backup Item Button ...................................................................................................19
3.4 Delete Button ....................................................................................................................19
3.5 Refresh Button ..................................................................................................................20
3.6 Schedule Element.............................................................................................................20
3.7 Backup Items ....................................................................................................................20
3.8 Backup Set Properties ......................................................................................................20
3.8.1 Backup Name Field....................................................................................................21
3.8.2 Backup Description.....................................................................................................21
3.8.3 Scheme Section .........................................................................................................21
3.8.4 On Creation ................................................................................................................21
3.8.5 When Offline...............................................................................................................21
3.8.6 Move File....................................................................................................................22
3.8.7 Timed Using Diary......................................................................................................22
3.8.8 Backup Items List.......................................................................................................22
3.8.9 Backup Item Properties Button...................................................................................22
3.8.10 Add Backup Item Button .........................................................................................22
3.8.11 Delete Backup Item Button .....................................................................................22
3.9 Backup Item Properties.....................................................................................................22
3.9.1 Backup Description.....................................................................................................23
3.9.2 Backup Item Logging Group.......................................................................................23
3.9.3 Backup Item Table......................................................................................................23
3.9.4 Backup Item Rate.......................................................................................................23
3.9.5 Backup Item Source Folder........................................................................................23
3.9.6 Backup Item Target Folder.........................................................................................23
3.9.7 Backup Item File Browse Buttons ..............................................................................23
Archive File Configuration
4 Index .......................................................................................................................................24
- iii -
Page 5
Reference Guide
D301477X412
April 2012
Archive File Configuration
1 Archive File Manager Config Tool
1.1 Overview
The OpenEnterprise Archive File Tool enables the user to manage archive files created by the
Historian. Its features are: -
• Hierarchical view of historical streams
• Easy identification of the time span of archive files
• Easy selection of archive files
• Easy identification of online, offline or missing archive files.
• Enables archives to be brought online manually.
• Enables archives to be taken offline manually.
• Configure manually brought online files to be taken offline after a configurable time.
• Defining archive file backup schedules.
Note: The Archive File Tool is a configuration tool that runs on OpenEnterprise Workstations.
OpenEnterprise Archive File Management also needs both the Archive File Manager and the
Scheduler to be running on the Server.
2 Archived Data
The Archived Data page displays the existing logging streams and their resulting archive files in a
hierarchical tree view. It has a number of buttons around the side and at the bottom of the page to
enable the user to take action on any selection from the display list.
- 1 -
Page 6
Reference Guide
D301477X412
April 2012
Archive File Configuration
2.1 Archives Tree Pane
The Archives Tree Pane displays the archives that have been created by the system.
They are displayed hierarchically according to the following structure -
• Source tables for which historical logging streams have been configured, sorted
alphabetically.
• Historical logging streams configured for each source table, sorted numerically.
- 2 -
Page 7
Reference Guide
D301477X412
April 2012
• Datasets created for each logging stream, sorted by rate.
• Archive file groups, sorted by date.
• Archive files, sorted by date.
Archive File Configuration
2.2 Source Tables
The Source Tables for the Historical Logging Groups are shown as the top level in the Archived Data
hierarchy for easy initial identification.
2.3 Logging Stream
Immediately under the Source Table in the hierarchy comes the Logging Stream. Each Logging
Stream has a unique ID number. If the Stream was given a description for ease of identification, this
will appear to the right of the number.
2.4 Dataset
Next in the hierarchy comes the Dataset identifier for that Logging Group. A value of 0s indicates a
Raw dataset. Any other number, such as 3600s indicates a Compressed Dataset, which applies a
number of compression algorithms to the raw data, such as Average or Maximum and Minimum
values.
2.5 Archive State Indicator
Archive files are grouped according to date and time, and whether or not they are: -
• Offline;
• Online - Manual;
• Online - Automatic;
2.6 Offline Archive Files
Offline archives are marked with a red cross. Contiguous offline archives will be grouped together.
The top level will have a plus sign to the left of it and will display the whole timescale covered by the
group. Selecting the plus sign will open the archive file group to reveal all of the archive files within it.
Click on the example for a demonstration.
- 3 -
Page 8
Reference Guide
D301477X412
April 2012
Archive File Configuration
2.7 Online Manual Archives
Archive files that are brought online manually are marked with a blue tick. Contiguous online archives
will be grouped together. The top level will have a plus sign to the left of it and will display the whole
timescale covered by the group. Selecting the plus sign will open the archive file group to reveal all of
the archive files in it.
2.8 Online Automatic Archives
Archive files brought online automatically are displayed in the Archive File Tool with a blue tick and a
small letter 'A' beneath the tick, like this -
Notes on Automatically Online Archives
2.9 Archives Unavailable
Archive files which are unavailable are displayed as a directory listing with a small red cross like this:
2.10 Notes on Automatically Online Archives
Archive files may be brought online automatically by checking the Automatically Online Archives
checkbox on the Archive Configuration dialog of the Historian Configuration Tool, and typing a
maximum number of automatic online archives into the box to the right of it.
2.11 Individual Archive Files
Individual archive files are displayed according to the time period that they cover. Contiguous archives
will be grouped together. The top level will have a plus sign to the left of it and will display the whole
timescale covered by the group. Selecting the plus sign will open the archive file group to reveal all of
the archive files within it.
2.12 Properties Button
When a dataset or an archive is selected, the [Properties] button becomes enabled. Depending on
which object has been selected, the Dataset Properties or Archive File Properties Dialog will be
displayed.
- 4 -
Page 9
Reference Guide
D301477X412
April 2012
Archive File Configuration
2.13 Bring Online Button
This button becomes enabled when a current offline archive is selected. If the button is then selected,
the Archive File Tool will begin the process of bringing the selected archive file online. A message is
displayed requesting the user to confirm the action: -
When the user selects the [Yes] button, the Online Properties dialog is displayed, showing the name
of the archive file, its source table and Control (Logging Group) ID number.
2.14 Take Offline Button
This button becomes enabled when an archive which has been brought online manually is selected. If
the button is then selected, the Archive File Tool will begin the process of taking the selected archive
file offline. A warning message is displayed requesting the user to confirm the action: -
If the user selects [Yes] the archive is set to be taken immediately offline by the Archive File
Manager. A progress bar is displayed on a Please Wait... dialog which displays the name of the
Archive which is being taken offline.
- 5 -
Page 10
Reference Guide
D301477X412
April 2012
Archive File Configuration
2.14.1 Take Offline Timeout Setting
When a user elects to take an Archive offline using the Archive File Tool, the Archive File Manager
begins the process of taking the file offline. In some cases this process may involve moving the file
from the online to the offline directory. When this has been done, the Archive File Manager marks the
Archive as being offline in the Database. Whilst the Please Wait... dialog is being displayed, the
Archive File Tool retries the Database 30 times to verify that the file has been marked offline by the
Archive File Manager. This retry number works fine with normal Archive files, but with larger Archive
files, the process of bringing an Archive offline may take longer than the time it takes for the Archive
File Tool to check the Database 30 times. The Please Wait... dialog may then close before the
Archive File Manager has finished taking the file offline, and the Archive File Tool would report that
the file had not been taken offline, when in fact it may have been. If Archive Files are likely to be very
large, there is a setting that can extend the number of retries made by the Archive File Tool before it
times out and declares that a file was not taken offline. Use the Settings Editor to find the:-
OpenEnterprise\Tasks\OEToolbox\Archive File Access
key, and a value on that key that has the name FileChangeStateRetries. This can be created if it is
not there already. The value data can then be set to a value greater than 30.
Note: It is not possible to use the Archive File Tool to take an automatically online archive file offline.
2.15 Select Data Button
This button is always enabled. It allows the user to select a source table, a Logging Group, a dataset
and a timespan for which the Archive File Tool is to bring archives online. When selected, the Select
Data Dialog is displayed.
2.16 Refresh Button
Refreshes the archive file data in the viewing pane.
2.17 Add Archives Button
Enables Archives that are not currently in the Archive Catalogue (and therefore cannot be brought
online by the Archive File Tool) to be imported, so that they can then be brought online. Archives may
not be in the Archive Catalogue if the Dataset from which they were created is not marked for
inclusion in the Archive Catalogue, or if they have been manually removed from it using SQL.
When a Dataset or one of its Archives is selected from the Archives Tree Pane, this button becomes
enabled. When it is selected, if the Dataset has its ArchiveCatalogue flag set to True in the
OELogData table, the Archive File Import Dialog is displayed. If the ArchiveCatalogue flag for the
selected Dataset is set to False, a message informs the user that the Dataset is not enabled for
Archive cataloguing, and the Archive cannot be imported.
Archives can only be imported for this stream when the ArchiveCatalogue attribute for the Dataset is
set to True in the OELogData table. This can be done using the SQL Client. Select Start->All
Programs->OpenEnterprise->SQL Client and type in:-
- 6 -
Page 11
Reference Guide
D301477X412
April 2012
update oelogdata set archivecatalogue = true where control =
<ControlIDNumber>;commit;
Archive File Configuration
2.18 Archive Groups
Archive groups are groups of archives with a contiguous Date-Time span. They are grouped in this
way to help in the selection of archives of interest. An archive group is identified by the tick to the left
of it. The time span of the whole group is displayed. A group can be opened by clicking on the tick to
the left of the group. The individual archives which make up the group can then be viewed .
2.19 OK Button
When selected, the dialog will close, and configuration entered on the dialog will be written to the
database.
2.20 Cancel Button
When selected, the current dialog will close. No configuration entered on the dialog will be
implemented.
2.21 Apply Button
When any new configuration is undertaken, this button becomes available. If selected, the new
configuration is saved to the database without closing the current dialog.
2.22 Help But ton
This button provides access to this help file, providing context sensitive help.
2.23 Dataset Properties
The Archive File Properties Dialog displays a number of properties of the selected archive file.
.
- 7 -
Page 12
Reference Guide
D301477X412
April 2012
Archive File Configuration
2.23.1 Control
This is the unique Logging Stream ID number. Each Logging Stream must have a unique ID number
that will be used in the names of the historical tables created for that stream. For example, a Logging
Stream with an ID number of 10 will have a default raw historical table created with the name
raw10_table. Any description given to the Stream when it was created will be shown to the right of the
ID number.
2.23.2 Compression
This field displays the compression rate of the dataset or archive file selected. A compression rate of
0s indicates the file has a raw compression rate. A compression rate of 3600s would indicate the file
has a compression rate of 1 hour.
2.23.3 Offline Folder
This editable field displays the currently configured Offline directory for archives. It may be changed
by typing in a new valid directory, or using the browse button to navigate to a new directory. The
browse button may only be used when: -
• Configuration is taking place on the OpenEnterprise Server
• If configuration is taking place on a Workstation, an identical offline directory can be created
on the Workstation, and then selected using this browse button. This is because the
designated offline directory should be local to the OpenEnterprise Server, and should not
contain a network path.
2.23.4 Limit Online Archive Files
The number of archive files which can be brought online at any one time can be limited to protect
Server resources. The current configuration can be changed by entering a new number here.
2.23.5 View Options
This section of the dialog is only enabled when an indexed date/time attribute from the source table is
being historically logged for the selected Dataset.
2.23.5.1 'Sticky' options
The option
settings file (OpenEnterprise.ini) so that they will be saved for next time the Archive Configuration
Tool is used.
The values will be stored under the following Settings file key (there will be a different key for each
dataset)
OpenEnterprise\Task\OEToolBox\Editors\Archive File
Access\DatasetViewOptions\<oelogcontrol.id>\<oelogdata.rate>
s selected in both the 'Order by' and 'View by' fields will be saved to the OpenEnterprise
In each key there will be 2 values (OrderBy and ViewBy), each storing a string representation of the
information from the relevant dropdown.
An example of these settings as seen in the OpenEnterprise Settings Editor is shown below.
- 8 -
Page 13
Reference Guide
D301477X412
April 2012
Archive File Configuration
2.23.6 View by
This control is only enabled when an indexed date/time attribute from the source table is being
historically logged for the Dataset. When this is the case, the option will be listed as well as the default
'timestamp' field in the 'View by' control:-
This feature is useful for SCADA projects where there is a high possibility that communication with the
data collection source (e.g. an RTU) may be interrupted for long periods, and the missing historical
data will need to be inserted into the Dataset from the data collection source at a later date.
OpenEnterprise can do this for Bristol ControlWave and NW3000 RTUs with its NW3000 Archive
Backfill functionality.
In this instance, the timestamp field will show the time that the data was inserted into the historical
Dataset, rather than the actual logged timestamp of the data when it was collected by the RTU. This
timestamp value will also appear in the next archive file when it is created. It would be easier to select
archives of interest in this case if archives could be viewed by occurrencetime rather than by
timestamp.
2.23.6.1 Logging an Indexed Date/Time Field
If there is a n
other another attribute that records the timestamp at the RTU should be included on the 'Selected
Fields' page of the Logging Group Wizard when configuring a historical logging group using the
Historical Configuration Tool. An example is shown below.
eed for viewing archives by something other than the timestamp, the 'occurrencetime' or
- 9 -
Page 14
Reference Guide
D301477X412
April 2012
Archive File Configuration
2.23.7 Order by
These options determine the order in which archive files will be displayed in the Archive File
Configuration Tool.
2.23.7.1 Creation date
This is th
option if archives have been created at a later date than the data was originally collected by the data
collection device.
2.23.7.2 Most recent data available
If this option is sel
will be viewed in the Archive Configuration Tool's 'Archived Data' tab in descending order according to
the 'maximumValue' and 'minimumValue' attributes for each archive file in the DateTimeArchiveIndex
table.
2.23.7.3 Oldest data available
If this option is sel
will be viewed in the Archive Configuration Tool's 'Archived Data' tab in ascending order according to
the 'maximumValue' and 'minimumValue' attributes for each archive file in the DateTimeArchiveIndex
table.
e default option. It sorts archives according to their creation date. This may not be the best
ected, and the alternative date/time field is selected in the 'View by' control, archives
ected, and the alternative date/time field is selected in the 'View by' control, archives
2.23.8 OK Button
When selected, the dialog will close, and configuration entered on the dialog will be written to the
database.
2.23.9 Cancel Button
When selected, the current dialog will close. No configuration entered on the dialog will be
implemented.
- 10 -
Page 15
Reference Guide
D301477X412
April 2012
Archive File Configuration
2.23.10 Help Button
This button provides access to this help file, providing context sensitive help.
2.24 Archive File Properties
The Archive File Properties Dialog displays a number of properties of the selected archive file.
2.24.1 Control
This is the unique Logging Stream ID number. Each Logging Stream must have a unique ID number
that will be used in the names of the historical tables created for that stream. For example, a Logging
Stream with an ID number of 10 will have a default raw historical table created with the name
raw10_table. Any description given to the Stream when it was created will be shown to the right of the
ID number.
2.24.2 Compression
This field displays the compression rate of the dataset or archive file selected. A compression rate of
0s indicates the file has a raw compression rate. A compression rate of 3600s would indicate the file
has a compression rate of 1 hour.
2.24.3 File Path
This is the path where the archive file is kept on the Server. It is determined by the Online and Offline
Archive directories specified in the Historian Configuration Tool.
2.24.4 Description
This provides a more detailed explanation of the archive file.
- 11 -
Page 16
Reference Guide
D301477X412
April 2012
Archive File Configuration
2.24.5 Creation Time
When the archive file was actually created.
2.24.6 Start Time
This is the start time of the archive file. The time of the first data sample in the archive.
2.24.7 End Time
This is the end time of the archive file. The time of the last data sample in the archive.
2.24.8 Status
This field gives information on the current online/offline status of the archive file.
2.24.9 Archive File Name Analysis
This field displays the archive file's name. It is constructed in the format shown below. The file name
is explained from left to right.
2.24.9.1 Group ID
The Log
2.24.9.2 Compression Rate
The Co
indicates a compressed Dataset.
2.24.9.3 Year
This was the
2.24.9.4 Month
This was the
2.24.9.5 Day
The Day of th
2.24.9.6 Time
This was the
format used is (HH:MM:SS).
ging Group ID (here 10) of the Dataset from which this archive was created.
mpression Rate of this Dataset. '0s' indicates a Raw Dataset. Any other number before the 's'
Year (2002) in which the archive was created
month (March = the 3rd month) in which the archive was created.
e month (4th day) in which the archive was created
Time the archive was created (05:39:13 = 39 minutes and 13 seconds past 5am). The
2.24.9.7 Timespan
This is th
2.24.9.8 Serial Number
The se
example this is the 310th archive).
e time span of the archive in seconds (here 12599 seconds).
rial number of this archive in terms of archives which have been created for this dataset (in the
- 12 -
Page 17
Reference Guide
D301477X412
April 2012
2.24.9.9 File Extension
Archive File Configuration
All archive fil
es are created with the .arch extension.
2.25 Online Properties
This dialog displays information about the archive that has been selected to bring online, and allows
the user to set a time when the archive will be taken back offline or to keep it online indefinitely.
2.25.1 Table
This is the source table of the archive file.
2.25.2 Control
This is the unique Logging Group ID number of the selected archive file.
2.25.3 Archive File List
This list details the archive files that have been chosen for bringing online. It displays the filenames
and their dataset rates.
2.25.4 Keep Online Indefinitely
If this button is selected, the archive file will remain online until it is manually removed by the user.
2.25.5 Keep Online For...
- 13 -
Page 18
Reference Guide
D301477X412
April 2012
If this button is selected, the user can specify a time for which the archive file will remain online. After
this time, the archive file(s) will be taken offline again.
Archive File Configuration
2.25.6 Keep Online Until
This button enables the user to select a specific date and time when the archive file will be taken
offline again. Selecting the drop-down date list reveals a calendar from which a new date can be
selected. The spin control is used to define a time in hours, minutes and seconds.
2.25.7 Bring Online [OK] Button
When this button is selected the Archive File Manager will bring the selected archive online. This
operation can be cancelled by selecting the [Cancel] button.
2.26 Select Data
The 'Select Data' dialog enables the user to specify a source table, Logging Group, dataset and
timespan for which the Archive Tool is to bring archives online.
2.26.1 Select Data - Table
This field is a drop-down list which displays the source tables currently being used by the Historian to
collect logged data: -
A source table must be selected.
2.26.2 Select Data - Name Column
This field displays the name column for the source table. This is the primary key of the table.
- 14 -
Page 19
Reference Guide
D301477X412
April 2012
Archive File Configuration
2.26.3 Select Data - Name
This field and it's [Browse] button become active when User Enabling has been set for a Logging
Stream (Control Group). User Enabling is activated when the Control Group is created if the Log All
Objects box is unchecked on the first dialog of the Historical Configuration wiza rd.
This then allows the user to select a signal or number of signals to be in this Control Group.
In order for the Archive File Tool to be able to find the correct Control Group for any object which the
user is interested in, the user must now indicate the object of interest. Selection of the [browse]
button to the right of the Name field on the Select Data dialog will display the Browse for Object
Dialog, which displays a list of all objects belonging user enabled control groups.
Browse for Objects Dialog
2.26.4 Browse For Objects
The list of objects may be filtered using the fields within the Filter section. More than one filter may be
applied.
2.26.4.1 Browse for Objects Filter Grid
In the example, the use
area, followed by an asterisk. The asterisk acts as a wildcard. The Archive Configuration Tool will
search for all signals in the database beginning with the string provided. A question mark (?) a cts a s a
single letter wildcard.
2.26.4.2 Browse for Objects Refresh Button
n this button is selected the Object List will be updated with a query based on the current filters
Whe
set up within the Filter Grid section of the Browse for Objects Dialog.
r has typed the beginning of a signal name into the Name field in the filter grid
- 15 -
Page 20
Reference Guide
D301477X412
April 2012
2.26.4.3 Browse for Objects Options Dialog
Archive File Configuration
2.26.4.3.1
The Option
Objects List per database query. The database is queried every time the [Refresh] button is selected.
The query will apply any filters found in the Filter Grid section of the Browse for Objects Dialog.
Browse for Objects Dialog
2.26.4.3.2 Prompt for Filter
When this box is checked the Archive File Configurati
top of the Objects List before running a query if the resulting query contains a large number of
objects.
2.26.4.3.3 Number of Objects to Retrieve per Query
Browse for Objects Options Dialog
s Dialog enables the user to specify a maximum number of objects to display within the
on Tool will display a cautionary message at the
The num
2.26.4.4 Browse for Objects List
The obje
determined by any filters specified within the Filter Grid and the number of objects to return per query
specified on the Options Dialog, which is opened by selecting the [Options] button.
2.26.4.5 Browse for Objects Next Button
When this but
settings from the Filter Grid and the Number of Objects to retrieve per query settings from the Options
Dialog .
2.26.4.6 Browse for Objects [OK] Button
Whe
Control field of the Select Data dialog.
ber of objects which each successive query returns can be changed here. The default is 100.
cts returned by the query when the [Refresh] button is selected. The number of objects is
ton is selected the Archive File Manager will requery the database using the filter
n this button is selected the the correct Control Group for the selected signal is passed to the
2.26.5 Select Data - Control
If an object has been selected using the browse button to the right of the Name field, then this dropdown list will contain only the Logging Control Groups that contain that object.
2.26.6 Select Data - Compression
This is a list field, which when selected displays all of the datasets for the currently selected Control
Group.
- 16 -
Page 21
Reference Guide
D301477X412
April 2012
Archive File Configuration
2.26.7 Select Data - Start Time and End Time
These fields become enabled once the Compression field has been selected, and the user is able to
specify a timespan for which archive files are needed to be brought online.
2.26.8 Select Data Bring Online Button
When this button is selected the Archive File Tool displays a message informing the user how many
archive files have been found which match the search criteria. It also allows the user to cancel the
action of attempting to bring them online. If the user selects the [Yes] button on this message box, the
Archive File Tool attempts to bring all archive files within the timespan specified on the above dialog
online.
2.27 Archive File Import
The Archive File Import Dialog displays a list of files that do not currently exist in the archive
catalogue, and enables them to be added to the catalogue.
Main Dialog Archived Data Page
- 17 -
Page 22
Reference Guide
D301477X412
April 2012
Archive File Configuration
2.27.1 Online Directory
This non-editable field displays the designated online archive file directory. Note that to set up
Archive File Import functionality with the Archive File Server, you must ensure that the actual Online
and Offline directories are made accessible to Workstations over the OpenEnterprise LAN by sha ring
and mapping these directories to a common drive on the Server. See the Example Online Directory
Set-up page for information on setting up this directory.
2.27.2 Example Online Directory Set-up
Suppose the OpenEnterprise Server has its online and offline folders on a physical D: drive, in
D:\Archive Files\Online Archives and D:\Archive Files\Offline Archives. Share th e D:\ Archi ve Files
directory across the network, then map this shared directory on the Server to say, a logical G: drive.
Now, all historical logging streams should have their online directory specified in the database as
G:\Online Archives, and all offline streams should have their offline directory specified as G:\Offline
Archives. Then, all Workstations will need to have a mapped drive G:, which looks at the
\\Server\Archive Files shared directory.
2.27.3 Archives List
This list displays any archives found in the configured archive directories which are not in the archive
catalogue. Multiple contiguous files may be selected by using the Shift key as you select files with the
mouse. Multiple non-contiguous files may be selected by holding the Control key as you select the
files.
2.27.4 Keep Files Online After Import
When files are entered into the archive catalogue, they are momentarily brought online. The user can
opt to keep them online by checking this box before the import. If this box is unchecked, the files will
be taken immediately offline after the import.
2.27.5 OK Button
When selected, the Archive File Manager will begin to add the selected archive(s) to the archive
catalogue, which will enable them to be displayed in the Archive Tree Pane, and brought online.
During the process, which will take a few moments to complete, a message will confirm that the
archive is being added to the catalogue.
2.27.6 Cancel Button
When selected, the current dialog will close. No configuration entered on the dialog will be
implemented.
2.27.7 Help Button
This button provides access to this help file, providing context sensitive help.
3 Backups
This dialog enables the user to automate the creation of backups for archive files.
- 18 -
Page 23
Reference Guide
D301477X412
April 2012
Archive File Configuration
3.1 List of Backup Sets
The main pane displays the currently configured list of Backup Sets
3.2 Backup Properties Button
When selected, either one of these two dialogs will be displayed, depending on whether a Backup
Schedule or a Backup Item is selected in the Backup List pane: -
1. Backup Set Properties Dialog
2. Backup Item Properties Dialog
3.3 Add Backup Item Button
When selected an empty Backup Item Properties Dialog is displayed, ready for entering the details of
the new Backup Item.
3.4 Delete Button
When a dataset from the Backup Items List is chosen the [Delete] button becomes enabled. Before
deleting the dataset from the Backup Items List, a message box is presented: -
- 19 -
Page 24
Reference Guide
D301477X412
April 2012
Selecting [No] will abort the delete action.
Archive File Configuration
3.5 Refresh Button
When selected, the Backup Sets pane will be refreshed, and any new sets and items will be
displayed.
3.6 Schedule Element
The Schedule Element contains the name of the Backup Set and the backup schedule details (i.e. On
Creation, When Offline or Timed).
3.7 Backup Items
These are the individual Backup Items to which the Backup Schedule applies.
3.8 Backup Set Properties
This Dialog displays data concerning the actual backup method used for this Backup Set along with a
list of backup items included in the set. When called from the [Add] button, the Name field is editable
and empty. When called from the [Properties] button, anything can be modified except for the
backup set name.
- 20 -
Page 25
Reference Guide
D301477X412
April 2012
Archive File Configuration
3.8.1 Backup Name Field
If the Backup Set Properties Dialog is opened with the [Properties] Button, this field is disabled as
the name of the Backup Set may not be changed. If it is opened with the [Add] button, this field will
be editable.
3.8.2 Backup Description
Text may be typed in here to give more information on the purpose of the Backup Set.
3.8.3 Scheme Section
This section contains five controls which determine the way that the archive files for this Set will be
managed.
3.8.4 On Creation
If this button is selected, then archive files will be backed up into the specified backup directory on the
Server when they are intially created. This means that a copy of the archive file will be placed into the
designated archive backup directory along with the original file, which will be placed into the
designated online or offline directory.
3.8.5 When Offline
If this button is selected, then a copy of the archive file will be placed in the designated backup
directory when the file is moved from online to offline status.
- 21 -
Page 26
Reference Guide
D301477X412
April 2012
Archive File Configuration
3.8.6 Move File
This option only applies if the [When Offline] button has been selected. It provides the user with the
option to move the file from the online directory to the backup directory, rather than making a copy of
it.
3.8.7 Timed Using Diary
Selecting this button allows the user to select a Diary which will govern when a backup of the archives
will be created. The copies are placed into the designated backup directory.
The drop-down list to the right of this button will display all of the useable diaries. The user must
select a diary from this list.
3.8.8 Backup Items List
This list displays the current datasets which have been included in this Backup Set. There are three
buttons to the right of the list, which enable the user to view the properties of configured datasets, add
new datasets or delete datasets.
3.8.9 Backup Item Properties Button
This button becomes enabled when a dataset is selected from the Backup Items pane. When
selected the Backup Item Properties Dialog is displayed.
3.8.10 Add Backup Item Button
When selected an empty Backup Item Properties Dialog is displayed, ready for entering the details of
the new Backup Item.
3.8.11 Delete Backup Item Button
When a dataset from the Backup Items List is chosen the [Delete] button becomes enabled. Before
deleting the dataset from the Backup Items List, a message box is presented: -
Selecting [No] will abort the delete action
3.9 Backup Item Properties
This Dialog enables the user to configure Backup Items. When called from the [Properties] button,
the Dialog displays the details of the Backup Item that had been selected. When called from the
[Add] button, the Dialog is empty.
- 22 -
Page 27
Reference Guide
D301477X412
April 2012
3.9.1 Backup Description
Archive File Configuration
Text may be typed in here to give more information on the purpose of the Backup Set.
3.9.2 Backup Item Logging Group
This drop-down list displays all available historical control groups. The user may change the Logging
Group later.
3.9.3 Backup Item Table
When a Logging Group is selected from the Logging Group list the source table for that grou p is
placed here. The field is non-editable.
3.9.4 Backup Item Rate
This is a drop-down list which displays the datasets available for the control group specified in the
Logging Group field. The user may change the dataset later.
3.9.5 Backup Item Source Folder
This is the folder from which the Backup Set will be taken.
3.9.6 Backup Item Target Folder
This is the backup directory to which the archive files will be copied. Please read the note above.
3.9.7 Backup Item File Browse Buttons
These buttons allow the User to browse for the desired directories for source an d target Backup files.
Note: The Source Folder is actually on the Server. The user cannot browse the network for this
folder, as this will place a network address into the field and the Archive File Manager needs the
folder path as it appears locally on the Server. It is therefore recommended that the user creates an
identical directory structure on the Workstation for the Online, Offline and Backup directories that is on
the Server, and uses the browse buttons on the Archive File Tool to select the correct directories from
the Workstation. Otherwise the directory will have to be typed in exactly as it is on the Server.
- 23 -
Page 28
Reference Guide
D301477X412
April 2012
4 Index
1
A
Add Backup Item Button ............................ 22, 24
Archive State Indicator....................................... 7
Archives Unavailable.......................................... 8
B
Backup Description.................................... 23, 25
Backup Item File Browse Buttons.................... 25
Backup Item Logging Group............................ 25
Backup Item Properties Button ........................ 24
Backup Item Properties Dialog ........................ 25
Backup Item Rate............................................. 25
Backup Item Source Folder.............................. 25
Backup Item Table........................................... 25
Backup Item Target Folder............................... 25
Backup Items ................................................... 23
Backup Items List............................................. 24
Backup Name Field.......................................... 23
Backup Properties Button ................................ 22
Backup Set Properties Dialog.......................... 23
Backup Sets..................................................... 22
Bring Online Button............................................ 8
Bring Online OK Button.................................... 17
Browse ....................................................... 18, 19
C
Compression........................................ 11, 14, 19
Compression Rate ........................................... 15
Control.................................................. 11, 14, 19
Creation............................................................ 24
Creation Time................................................... 14
D
Dataset............................................................... 7
Dataset Properties Dialog................................ 11
Day................................................................... 15
Delete Backup Item Button .............................. 24
Delete Button ................................................... 22
Description....................................................... 14
E
End Time.................................................... 15, 19
Example Online Directory Set-up..................... 21
Extension.......................................................... 15
Archive File Configuration
F
Filter..................................................................19
G
Group ID ...........................................................15
H
Help Button...........................................10, 13, 21
I
Individual Archive Files.......................................8
K
Keep Files Online After Import..........................21
Keep Online Indefinitely....................................16
Keep Online Until..............................................16
L
Limit Online Archive Files .................................11
Loggin Group Id..................................................7
M
Main Dialog Add Archives Button.....................10
Main Dialog Archived Data Page........................5
Main Dialog Backups Page...............................21
Main Dialog Refresh Button..............................10
Month................................................................15
Move File ..........................................................24
N
Name ..........................................................15, 17
Name Column...................................................17
Notes on Automatically Online Archives.............8
Number.............................................................19
O
Objects..............................................................19
Objects Filter Grid.............................................18
Objects List.......................................................19
Objects Next Button..........................................19
Objects Refresh Button.....................................18
Offline................................................................24
Offline Archive Files............................................7
OK.....................................................................19
Online Automatic Archives..................................8
Online Manual Archives......................................7
- 24 -
Page 29
Reference Guide
D301477X412
April 2012
Archive File Configuration
Online Properties Archive File List................... 16
Online Properties Dialog Control ..................... 16
Order................................................................ 13
Overview ............................................................ 5
P
Path.................................................................. 14
Prompt.............................................................. 19
Properties Button ............................................... 8
R
Refresh Button................................................. 23
Retrieve per Query........................................... 19
S
Schedule Element............................................ 23
Scheme Section............................................... 24
Select Data Bring Online Button...................... 20
Select Data Button............................................. 9
Select Data Dialog......................................17, 19
Serial Number...................................................15
Source Tables.....................................................7
Start Time ...................................................14, 19
Status................................................................15
T
Table...........................................................16, 17
Take Offline Button.............................................9
Time..................................................................15
Timed Using Diary ............................................24
Timespan..........................................................15
V
View ..................................................................12
Y
Year ..................................................................15
- 25 -
Page 30
Reference Guide
D301477X412
April 2012
DISCLAIMER
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 marks 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 mai nt en ance of any RAS
product remains solely with the purchaser and end-user.
Engineered and supported by:
Remote Automation Solutions,
Blackpole Road, Worcester, WR3 8YB, UK
Registered office: Meridian East, Leicester, LE19 1UX
Registered in England and Wales, Registration No. 00671801
VAT Reg No. GB 705 353 652
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
© 2001-2012 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...