OI Server Manager User Guide
OI Server Manager User Guide
OI Server Manager User Guide
Contents
Getting Started ............................................................................................................. 7
Before You Begin ................................................................................................................................7
Windows Firewall Considerations .......................................................................................................8
Checklist for Setting Up an OI Server .................................................................................................8
Navigating the OI Server Manager ............................................................................. 10
Node Groups and Nodes ..................................................................................................................13
Server Groups ...................................................................................................................................14
Server Instances ...............................................................................................................................15
License Status...................................................................................................................................17
Configuring Your OI Server ........................................................................................ 19
Adding an Object...............................................................................................................................20
Renaming an Object .........................................................................................................................20
Instantiating Data Sources ................................................................................................................20
Enabling or Disabling an Object........................................................................................................21
Configuring an Object's Parameters .................................................................................................22
Advanced Settings ............................................................................................................................22
Archiving Configuration Sets .............................................................................................................24
Resetting an Object ..........................................................................................................................25
Deleting an Object ............................................................................................................................25
Configuring Global Parameters .................................................................................. 27
Accessing the Global Parameters.....................................................................................................27
Configuring Intervals for Device Group Updates and Slow Polling ..................................................29
Configuring Transaction and Subscription Settings ..........................................................................29
Configuring Protocol Timers .............................................................................................................30
Configuring the Poke Mode ..............................................................................................................31
Configuring Case Sensitivity for Item IDs and Device Group Names...............................................32
Enforcing Uniqueness for Device Group Names ..............................................................................32
Enabling the OI Server to Run in Simulation Mode ..........................................................................33
Showing or Hiding System Items ......................................................................................................33
Managing Device Groups ........................................................................................... 34
Viewing Common Device Groups .....................................................................................................35
3
Wonderware Operations Integration - Supervisory Server Manager (G-1.2 Series) User Guide Contents
4
© 2016 Schneider Electric Software, LLC. All rights reserved.
No part of this documentation shall be reproduced, stored in a retrieval system, or transmitted by any
means, electronic, mechanical, photocopying, recording, or otherwise, without the prior written
permission of Schneider Electric Software, LLC. No liability is assumed with respect to the use of the
information contained herein.
Although precaution has been taken in the preparation of this documentation, Schneider Electric
Software, LLC assumes no responsibility for errors or omissions. The information in this documentation
is subject to change without notice and does not represent a commitment on the part of Schneider
Electric Software, LLC. The software described in this documentation is furnished under a license
agreement. This software may be used or copied only in accordance with the terms of such license
agreement.
ArchestrA, Avantis, DYNSIM, eDNA, EYESIM, Foxboro, Foxboro Evo, I/A Series, InBatch, InduSoft,
InStep, IntelaTrac, InTouch, PIPEPHASE, PRiSM, PRO/II, PROVISION, ROMeo, Schneider Electric,
SIM4ME, SimCentral, SimSci, Skelta, SmartGlance, Spiral Software, VISUAL FLARE, WindowMaker,
WindowViewer, and Wonderware are trademarks of Schneider Electric SE, its subsidiaries, and
affiliated companies. An extensive listing of Schneider Electric Software, LLC trademarks can be found
at: http://software.schneider-electric.com/legal/trademarks/. All other brands may be trademarks of
their respective owners.
Schneider Electric Software, LLC
26561 Rancho Parkway South
Lake Forest, CA 92630 U.S.A.
(949) 727-3200
http://software.schneider-electric.com/
Publication date: 7/1/2016
Contact Us
Contact Schneider Electric Software Technical Support
Contact our Software Technical Support Group if you have a question or issue with Avantis, SimSci,
Skelta, or Wonderware software products.
Priority email for Customer First Members: [email protected]
Customers without a support agreement: [email protected]
Americas: Lake Forest, California, U.S.
Tel: + 1 800 966 3371 / + 1 949 639 8500
Asia Pacific: Shanghai, China
Tel: + 800 4500 3457 (All Asia) / + 400 820 1521 (China) / + 86 400 8201521
Email: [email protected]
Europe and Middle East, Africa (EMEA): Bratislava, Slovakia
Tel: + 421 2 32 200 342 / See our website at http://software.schneider-electric.com/ for a list of
toll-free numbers.
Contact Schneider Electric Software Learning Services
Contact Software Learning Services for assistance regarding classes, schedule, offerings, frequently
asked questions, tuition, policies, and more.
Phone: + 1 866 998 7246 in the U.S. and Canada
+ 1 949 639 8508 direct
Fax: + 1 949 639 1847
Email: [email protected]
Getting Started
The OI Server Manager is a part of the ArchestrA™ System Management Console (SMC) suite of
utilities. It enables the configuration, diagnosis, activation, or deactivation of a local OI Server or a
remote OI Server located on a different node from the OI Server Manager.
Use the OI Server Manager to view and configure the OI Servers. Servers developed with the Data
Access Server Toolkit can be stand-alone products or designed for use with ArchestrA based products.
You can open multiple instances of the OI Server Manager at the same time; however, you can use
only the first instance to create device hierarchies and configure an OI Server. In all other instances of
the OI Server Manager, hierarchy and configuration settings are set to read-only.
Note: The OI Server Manager user interface may look different on different versions of Microsoft
Windows. In addition, the version of Microsoft Management Console (MMC) installed on your computer
may affect the content and behavior of the user interface.
The OI Server Manager has one or more node groups in its hierarchy, and each node group comprises
one or more nodes. A node represents a computer that hosts at least one OI Server.
Furthermore, each OI Server is actually a server group that comprises one or more server instances,
and each server instance has its own hierarchy of configurable objects.
OI Servers that have been optimized for Wonderware Operations Integration are contained in the
Operations Integration Supervisory Servers folder. Only these OI Servers can have multiple server
instances.
Older, standalone OI Servers that have not been optimized are listed separately, and they cannot have
multiple server instances.
Note: To enable multiple server instances, you must have a Professional (Tier 2) or Elite (Tier 3)
license for OI Server.
So, generally speaking, the entire OI Server Manager hierarchy looks like this:
Note: The Operations Integration Supervisory Servers folder, with its hierarchy of server groups
and server instances, is shown only when you browse the Local node. All of the server instances on a
remote computer are listed together, regardless of their server groups.
Examples
In the following example, the SMC shows the OI Server Manager with OI.ABCIP.1 (Allen-Bradley
ABCIP) installed on a local computer node. The green icon next to the OI Server name indicates that
the OI Server is active. Inactive OI Servers, marked with a red icon, contain only the Configuration
node.
When expanded as shown, an active OI Server contains both Configuration and Diagnostics nodes.
Server Groups
A server group comprises one or more server instances that all use the same OI Server protocol.
When you install a specific OI Server on a computer, a server group and default server instance are
automatically created for that OI Server in the OI Server Manager. The server group has the same
short name as the OI Server itself, plus the manufacturer's name, for example, Allen-Bradley -
ABCIP. Since there is a limit of one server group per OI Server per computer node, that server group
effectively is the OI Server.
Where the server group appears in the OI Server Manager depends on what type of OI Server it is for.
Newer OI Servers that have been optimized for the Wonderware Operations Integration are contained
in the Operations Integration Supervisory Servers folder. Older, standalone OI Servers are listed
separately below the Operations Integration Supervisory Servers folder.
Although a server group is automatically created when you install an OI Server, there are some cases
in which you might need to create or remove a server group. For example, if you want to stop using a
specific OI Server but not uninstall it, you can simply remove the server group from the computer node
in the OI Server Manager. The OI Server will remain installed on the computer, and you can create the
server group again later if you need to.
Note: These procedures apply only to OI Servers that are contained in the Operations Integration
Supervisory Servers folder in the OI Server Manager. Older, standalone OI Servers do not support
creating or removing server groups. Instead, those OI Servers must be installed or uninstalled in their
entirety.
Also, the Wonderware OI Servers folder, with its hierarchy of server groups and server instances, is
shown only when you browse the Local node. All of the server instances on a remote computer are
listed together, regardless of their server groups.
To create a server group:
1. In the ArchestrA System Management Console, navigate to the Operations Integration Server
Manager folder.
2. Right-click Operations Integration Supervisory Servers, and then click Create Server Group on
the shortcut menu. The Create Server Group dialog box is displayed.
3. In the Server Group Name list, select the OI Server that you want to use.
4. Click OK. A new server group for the selected OI Server is created in the OI Server Manager, and
the server group contains a default server instance.
To remove a server group:
1. In the ArchestrA System Management Console, navigate to the Operations Integration Server
Manager folder.
2. Expand the server group.
3. Make sure all of the server instances are deactivated. A server group cannot be removed while it
contains active server instances. For more information, see Activating/Deactivating the OI Server
daserver_management_activate.html#daserver_management_activate.
4. Remove all of the server instances other than the default server instance. A server group cannot
be removed while it contains multiple server instances. For more information, see Server Instances
daserver_manager_navigation_serverinstances.html#daserver_manager_navigation_serverinstanc
es.
5. Right-click the server group, and then click Remove Server Group on the shortcut menu.
6. Click Yes to confirm. The server group and all of its instances are removed.
Server Instances
Each server instance has its own configuration and diagnostics, can be activated and deactivated
separate from all other server instances, and appears as a separate application to external clients.
When you install a specific OI Server on a computer, a server group and default server instance are
automatically created for that OI Server in the OI Server Manager. The name of the default server
instance is based on the short name of the OI Server itself. For example, for the Wonderware
Simulation OI Server, the default server instance is named OI.SIM.1. All server instance names follow
this basic format.
The middle part of a server instance name becomes the application name that external clients will use
to access OI Server data. For example, if a server instance is named OI.SIM_0001.1, the
corresponding application name will be SIM_0001.
Newer OI Servers that have been optimized for Wonderware Operations Integration support multiple
server instances, which means that you create additional server instances and even clone existing
server instances in those server groups.
Important: The creation of a new server instance uses the base instance as a template. All
configuration parameters of the base template are copied to the new instance during the creation
operation.
Keep in mind that a server instance name — including the underscore and suffix — is limited to 16
characters. When you try to create or rename a server instance, names that exceed the limit will be
rejected.
Notes:
These procedures apply only to OI Servers that are contained in the Operations Integration
Supervisory Servers folder in the OI Server Manager. Older, standalone OI Servers do not support
multiple server instances.
The Operations Integration Supervisory Servers folder, with its hierarchy of server groups and
server instances, is shown only when you browse the Local node. All of the server instances on a
remote computer are listed together, regardless of their server groups.
To enable multiple server instances, you must have a Professional (Tier 2) or Elite (Tier 3) license for
OI Server.
To create new server instances in a server group (in addition to the group's default
instance):
1. In the OI Server Manager, navigate to the server group:
a. Expand Operations Integration Server Manager, expand Default Group, and then expand
Local.
b. Expand Operations Integration Supervisory Servers.
2. Right-click the server group, and then click Create Server Instance on the shortcut menu. The
Create OI Server Instance dialog box is displayed.
3. In the Starting Instance and Ending Instance boxes, type the starting and ending numbers for
sequentially numbered instances. For example, if Starting Instance is 0001 and Ending Instance
is 0005, five instances numbered from 0001 to 0005 will be created.
4. In the Custom Name box, type a custom name for the new instances. This is optional, but if you
do type something, it will be combined with the instance number to form the actual suffix. For
example, if Custom Name is A and the instances are numbered from 0001 to 0005, the actual
suffixes will be from A0001 to A0005.
5. Click OK. The new instances are created.
To clone an existing server instance:
1. In the OI Server Manager, navigate to the server instance:
a. Expand the Operations Integration Server Manager, expand Default Group, and then
expand Local.
b. Expand Operations Integration Supervisory Servers.
c. Expand the server group that contains the existing server instance.
2. Right-click the server instance, and then click Clone Instance on the shortcut menu. The Clone OI
Server Instance dialog box is displayed.
3. In the Custom Instance Name box, type a custom name for the new instance. This is optional.
4. Click OK. The new instance is created.
To remove an existing server instance (other than a server group's default instance):
1. In the OI Server Manager, navigate to the server instance:
a. Expand the Operations Integration Server Manager, expand Default Group, and then
expand Local.
b. Expand Operations Integration Supervisory Servers
c. Expand the server group that contains the existing server instance.
2. Make sure the server instance that you want to remove is deactivated. A server instance cannot be
removed while it is active.
3. Right-click the server instance, and then click Remove Instance on the shortcut menu.
4. Click Yes to confirm. The server instance is removed.
To rename an existing server instance (other than a server group's default instance):
1. In the OI Server Manager, navigate to the server instance:
a. Expand the OI Server Manager, expand Default Group, and then expand Local.
b. Expand Wonderware OI Servers.
c. Expand the server group that contains the existing server instance.
2. Make sure the server instance that you want to rename is deactivated. A server instance cannot be
renamed while it is active.
3. Right-click the server instance, and then click Rename Instance on the shortcut menu. The
Rename OI Server Instance dialog box is displayed.
4. In the Custom Instance Name box, type the new value that should be appended to the base
name.
5. Click OK. The server instance is renamed.
License Status
You can view the icon of the active OI Server to determine its license status.
Icon Description
The OI Server in active state, running not as a service with a valid license.
The OI Server in active state, running not as a service in the demo mode.
The OI Server in active state, running not as a service, and without a valid license.
The OI Server in active state, running as a service, and with a valid license.
The OI Server in active state, running as a service, and in demo mode.
The OI Server in active state, running as a service, without a valid license, and not in a demo mode.
Adding an Object
The first step in configuring the connection between the OI Server and a physical device is to add an
object that represents the device.
To add an object to the OI Server configuration:
1. In the OI Server Manager, navigate to the Configuration node.
a. Expand the OI Server Manager, expand Default Group (or the node group name), and then
expand Local (or the remote computer name).
b. Expand the OI Server, and then expand its Configuration node.
2. Right-click Configuration, and then click Add Object on the shortcut menu. The type of object
varies by OI Server and node level. For more information, see the documentation for the specific
OI Server. The console tree shows a new object with its default name selected.
3. Type a new name, if desired, and then press Return.
Renaming an Object
New objects in an OI Server configuration are given default names. You can rename an object to make
it clear what the object represents.
If you rename an object, the change takes effect immediately.
However, you cannot rename an object if the OI Server is active and items are subscribed to the
object. You can rename the object only after removing all subscribed items.
To rename an object in an OI Server configuration:
1. In the OI Server Manager, navigate to the Configuration node.
a. Expand the OI Server Manager, expand Default Group (or the node group name), and then
expand Local (or the remote computer name).
b. Expand the OI Server, and then expand its Configuration node.
2. Right-click the object in the OI Server configuration, and then click Rename on the shortcut menu.
3. Type the new name, and then press Return.
Advanced Settings
Many of the OI Servers included in the Operations Integration Supervisory Servers have a common set
of advanced communication settings. These settings are in addition to the object parameters that are
described in the documentation for your specific OI Server.
To determine if your OI Server has these settings, right-click Configuration. If your OI Server has
these settings, you will see the Add ChannelSelector Object in the context menu options.
You might need to change these settings if the OI Server behaves unexpectedly during run time, but
the default settings should work for most network configurations.
To change the advanced settings for a ChannelSelector object:
1. In the OI Server Manager, navigate to the Configuration node of your OI Server.
a. Expand the OI Server Manager, expand the node group, and then expand Local (or the
remote computer name).
b. Expand the OI Server, and then expand its Configuration node.
2. Select the ChannelSelector object in the OI Server configuration. The object's parameters are
displayed in the details pane on the right.
3. Click Advanced. The Advanced Settings dialog appears.
Timeout Start message The timeout (in milliseconds) to receive the start of a mes
End message The timeout (in milliseconds) to receive the end of a mes
Interval between char The interval (in milliseconds) between characters in a me
Simultaneous Maximum The maximum number of requests (up to 32) that can be
Requests
Note: There is a limit of 100 total simultaneous requests
can have three channels at 32 each, four channels at 24
channels at 1 each, or any combination thereof.
Maximum per station The maximum number of requests that can be sent at the
varies, so for more information, see the documentation fo
Protocol Station The station number or ID of the channel, according to the
consider the OI Server to be another slave device and th
information, see the documentation for the specific OI Se
Retries The number of times that the OI Server will retry the sam
Buffers Length Tx Buffer The transmission buffer length (in bytes).
Rx Buffer The reception buffer length (in bytes).
5. Click OK to close the Advanced Settings dialog box.
6. Click the Save icon.
Archiving Configuration Sets
A configuration set includes the OI Server’s global parameters; each channel and its parameters; and
each device and its parameters, device groups, and device items. It lets you manage the settings of
different OI Server configurations.
The OI Server contains a default configuration set. You cannot delete the default configuration set.
You can create multiple configuration sets and switch between them. Archiving, clearing, and switching
configuration sets can only be done when the OI Server is deactivated.
You cannot use COM1 through COM9 as the name of a configuration set, as these names are
reserved for system functions.
Before you create a configuration set, verify that you have saved any changes you made to the global
parameters. If you change a parameter and then immediately create a configuration set, the original
parameter value is saved as part of the configuration set, not the changed value.
To save a global parameter, click the Save icon.
To archive a configuration set
1. In the OI Server Manager, navigate to the configuration node.
a. Expand OI Server Manager, expand the node group, and then expand Local or the remote
computer name.
b. Expand the OI Server.
2. Right-click Configuration, and then click Archive Configuration Set on the shortcut menu.
3. In the dialog box, type the configuration set name, and then click Archive. All the current
configuration values are saved to the set.
After you archive at least one configuration set, you can select it for use.
To select a configuration set
1. In the OI Server Manager, navigate to the configuration node.
a. Expand OI Server Manager, expand the node group, and then expand Local or the remote
computer name.
b. Expand the OI Server.
2. Right-click Configuration, point to Use Another Configuration Set on the shortcut menu, and
then click the configuration set that you want to use.
To change the parameter values saved in a configuration set, make sure the desired configuration set
is shown, and then follow this procedure.
To change the parameter values in a configuration set
1. In the OI Server Manager, navigate to the configuration node.
a. Expand OI Server Manager, expand the node group, and then expand Local or the remote
computer name.
b. Expand the OI Server.
2. Click Configuration.
3. Change the parameters that you want to change.
4. Click the Save icon.
Clearing a configuration set returns the parameters to their default values.
To clear a configuration set
1. In the OI Server Manager, navigate to the configuration node.
a. Expand OI Server Manager, expand the node group, and then expand Local or the remote
computer name.
b. Expand the OI Server.
2. Right-click Configuration, and then click Clear Configuration Set on the shortcut menu.
3. Read the warning message, and then click Yes. The parameters are set to the default values.
To delete a configuration set
1. In the OI Server Manager, navigate to the configuration node.
a. Expand OI Server Manager, expand the node group, and then expand Local or the remote
computer name.
b. Expand the OI Server.
2. Right-click Configuration, point to Delete Configuration Set on the shortcut menu, and then click
the configuration set that you want to delete.
3. Read the warning message, and then click Yes.
Resetting an Object
You can reset an object in an OI Server configuration in order to make modified configuration
parameters take effect without deactivating and then reactivating the OI Server. Resetting an object
also resets all of its child objects.
The OI Server and Configuration nodes, and the nodes between them, cannot be reset.
To reset an object in an OI Server configuration:
1. In the OI Server Manager, navigate to the Configuration node.
a. Expand the OI Server Manager, expand the node group, and then expand Local (or the
remote computer name).
b. Expand the OI Server, and then expand its Configuration node.
2. Right-click the object in the OI Server configuration, and then click Reset on the shortcut menu.
Deleting an Object
You can delete an object in an OI Server configuration when you no longer need it.
If you delete an object, the deletion takes effect immediately.
However, you cannot delete an object if the OI Server is active and items are subscribed to the object.
You can delete the object only after removing all subscribed items.
To delete an object in an OI Server configuration:
1. In the OI Server Manager, navigate to the Configuration node.
a. Expand the OI Server Manager, expand the node group, and then expand Local (or the
remote computer name).
b. Expand the OI Server, and then expand its Configuration node.
2. Right-click the object in the OI Server configuration, and then click Delete on the shortcut menu.
Configuring Global Parameters
Each OI Server has a unique set of parameters that you can configure for your particular environment.
For descriptions of those configuration parameters, see your OI Server-specific documentation.
Using the OI Server Manager, you can also configure a set of common, or global, parameters for each
OI Server.
Accessing the Global Parameters on page 27
Configuring Intervals for Device Group Updates and Slow Polling on page 29
Configuring Transaction and Subscription Settings on page 29
You can set the following transaction and subscription settings.
Configuring Protocol Timers on page 30
You can use the server protocol timer to control the interval between protocol activities for timer-driven
OI Servers. Your specific OI Server documentation will describe whether the OI Server uses this value.
Configuring the Poke Mode on page 31
You can use the poke mode to control how the OI Server optimizes and folds pokes within a
transaction.
Configuring Case Sensitivity for Item IDs and Device Group Names on page 32
You can control how the OI Server scans items and device group names with respect to upper and
lower case. The default is set to case insensitive, which is recommended if you are working with legacy
applications.
Enforcing Uniqueness for Device Group Names on page 32
You can control whether the device group names are checked for uniqueness across all device nodes
of an OI Server.
Enabling the OI Server to Run in Simulation Mode on page 33
Some OI Servers can simulate communication with a field device. Availability of a simulation mode is
OI Server-specific. If the OI Server does not support this mode, the element is not available.
Showing or Hiding System Items on page 33
You can specify whether system items appear in the browser interface. This option also confirms
recognition of system items as valid ItemIDs by the OI Server's data acquisition interfaces.
3. Click the Save icon to write the current data to the OI Server’s configuration set. If the OI Server is
enabled and you have changed a global parameter, the new value takes effect when you save the
configuration. For more information, see Hot Configuration
daserver_management_hotconfiguration.html#daserver_management_hotconfiguration. When you
click the Save icon, leading zeros are truncated from your entries in numerical fields. The behavior
of the rest of the OI Server’s configuration hierarchy depends on the refresh mechanism of the
server-specific programming logic.
Note: Device group names are not case sensitive. Therefore, ensure you do not use two device groups
with the same name with different case. Each device group name must be unique, including case.
Device Registers
Item references are addresses of device registers, and device registers are specific locations in a
device's memory.
In most cases, each item reference has the following attributes:
register type
What the memory location is used for. Register types include inputs, outputs, link relays, latch
relays, timer bits, and so on. For limitations on register types, see the manufacturer's
documentation for your device.
range
The range of valid addresses for a given register type. A complete address typically consists of a
prefix indicating the register type and a numerical value indicating the specific memory location.
data type
The types of data the client can request when it accesses the specified memory location. Data
types include Short, Word, BCD, and so on. The data type is often optional because most memory
locations have a default data type.
access
What a client application can do with the memory location. Some locations are read only or write
only, while others are fully read/write.
For a complete description of the item reference syntax and options for a specific OI Server, see the
documentation for that OI Server.
$SYS$Licensed Boolean/Read Binary status indication of the existence of a valid license for the OI Serv
If FALSE, this item causes the OI Server to stop updating existing tags,
activation of new tags, and to reject write requests in addition to setting
all items to BAD. If TRUE, the OI Server functions as configured.
All instances have the same value.
$SYS$ReadOnly Boolean/Read Binary status indication of the Read Only state of an OI Server.
If TRUE, the Read/Write access of all items are overridden to read only
be written. If an item is written, a line is logged in the SMC Logger and
request is rejected. If FALSE, the OI Server items are read/write or read
according to their individual configurations.
$SYS$Status Boolean/Read Binary status indication of the connection state to the device (hierarchy
item is attached to. The device group (OPC access path/topic) does not
value.
The status can be good even if individual items have errors.
For DDE/SuiteLink clients, $SYS$Status always comes from the leaf lev
Server hierarchy branch, which is the destination PLC node. For OPC c
$SYS$Status can be accessed at all hierarchy levels. $SYS$Status at t
of the whole hierarchy tree is always good, as it represents the quality s
local computer itself. Hence, for practical application, OPC clients shoul
$SYS$Status at any hierarchy levels other than the root.
$SYS$ErrorCode Longint/Read Detailed error code of the communications state to the device.
The device group (OPC access path/topic) does not affect the value.
$SYS$ErrorText String/Read Detailed error string of the communications state of the device.
The device group (OPC access path/topic) does not affect the value.
$SYS$StoreSettings Integer/ReadWri Makes the temporary update interval changes via the $SYS$UpdateInte
te permanent. If the client pokes a value of 1 into this system item, the cur
update interval is written to the server’s configuration file.
The value of this system item clears to 0 after being set, if the configura
write is successful. If the write fails, then the value is set to -1.
If the update interval changes via the $SYS$UpdateInterval item and th
poked to 1, the OI Server uses the original update interval for that topic
time it is started.
Reading the item always provides 0. Read/Write values are persisted on
this system item. The values other than this persist only for the life of th
$SYS$UpdateInterval DWord/ReadWri Accesses the currently set update interval. It is the current update inter
te group in milliseconds. A client can poke new values into this item.
The value of zero indicates that non-system items on that topic are not
these items are not acquired from the device).
$SYS$MaxInterval DWord/Read Used to access the currently measured maximum update interval in m
of the corresponding device group. This item is read-only. The value o
displayed.
$SYS$ActiveItemCount DWord/Read Accesses the number of active items in the corresponding device grou
read-only.
$SYS$ErrorCount DWord/Read Accesses the number of all items (active and inactive) that have errors
quality) in the corresponding topic.
If the communications status of a device group is bad, all items have e
read-only.
$SYS$PollNow Boolean/ReadW Poking a 1 to this item forces all items in the corresponding device gro
rite immediately (all messages in this device group become due). This is u
force to get the newest values from the device, regardless of its update
works on device groups with a zero update interval (manual protocol tr
Type/Access
System Item Name Rights Description
$SYS$ForceFailover Boolean/ This is required to achieve the failover condition to be forced by clien
ReadWrite
Note: By poking a value of "1" (True) into the Force Failover item, a c
conveniently switch to the secondary device.
$SYS$ActiveDevice String/Read This system item will show the current runtime active device.
$SYS$FailoverTime Time/Read This system item will show the time at which the switch occurred.
$SYS$StandbyDevice String/Read This system item will show the current runtime standby device.
$SYS$SecondaryDevice Boolean/Read This system item will show the status of the secondary device. This i
Status second device defined in the configuration and is not changed with a
RANGE: 0, 1
$SYS$PrimaryDevice Boolean/Read This system item will show the status of the primary device. This is th
Status device defined in the configuration and is not changed with any failov
$SYS$FailoverReason String/Read This system item will show the reason for the failover.
Important! The Redundant Hierarchy, including the Device Group, is not hot-configurable, and
requires a Reset on the Redundant Hierarchy to effect a configuration change.
Generic OPC Syntax
A DAServer serves as a container for the OPC Groups, which provide the mechanism for containing
and logically organizing OPC items. Within each OPC Group, an OPC-compliant client can register
OPC items, which represent connections to devices in the field device. In other words, all access to
OPC items is maintained through the OPC Group.
The fully qualified name for an OPC item is called the Item ID (equivalent to Item Name). The syntax
for specifying a unique Item ID is DAServer-dependent. In OPC data acquisition DAServers, the syntax
can be as follows:
AREA10.VESSEL1.TIC1.PLC.400001
where each component (delimited by a period) represents a branch or leaf of the field device’s
hierarchy.
In this example:
AREA10.VESSEL1.TIC1 is the link name for a DAServer.
PLC is the name of the target PLC.
400001 is the specific data point (Item) desired.
An item is typically a single value such as an analog, digital, or string value.
Where Item ID describes the syntax for defining the desired data point, OPC provides for another
parameter, called Access Path, that defines optional specifications for obtaining that data.
In DAServers, Access Paths are equivalent to Device Groups; it is this parameter that is used to define
the update interval between the DAServer and the field device for accessing the values of data points
in the PLC.
Managing Your OI Server
taking After you configure the OI Server, there are two steps to take before you can access data with
your client application.
The first step is to determine what kind of client applications are to be used with this OI Server. If any
of your client applications use DDE/SuiteLink, you must configure the OI Server as a service. If only
OPC client applications will be used, you can configure the OI Server as a service or as not a service.
The last step is to activate the OI Server. Some client applications can programatically activate the OI
Server. If you configure the OI Server as an automatic service, the OI Server is started and activated
when the computer on which the OI Server is installed starts up. If you configure the OI Server as a
manual service, the OI Server is not started when the computer starts up. Instead, it is started upon the
first connection from an OPC client or when activated from the OI Server Manager.
After an OI Server is running as an auto or manual service, it stays running until explicitly stopped in
the OI Server Manager or the computer shuts down.
Running the OI Server as a Service on page 49
To support DDE/SuiteLink clients, the OI Server must be configured to run as a service.
Archiving Configuration Sets on page 24
A configuration set includes the OI Server’s global parameters; each channel and its parameters; and
each device and its parameters, device groups, and device items. It lets you manage the settings of
different OI Server configurations.
Activating/Deactivating the OI Server on page 51
When you activate the OI Server, it starts communicating and accepting requests from client
applications. If an OI Server is configured as an automatic service, the OI Server is started and
activated when the computer starts up. Also, an OI Server can be activated by the an OPC client
connection request.
OPC/COM Activation on page 52
The OI Server can run only out-of-process (i.e., as a stand-alone process).
Hot Configuration on page 52
Hot configuration allows you to configure some parameters in the OI Server while it is running.
Demo Mode on page 52
You can install the OI Server without a license. The OI Server runs without a license in Demo mode for
120 minutes.
Auto Service The OI Server will run as service, and it starts automatically when the computer is turn
Manual Service The OI Server will run as a service, and it must be started manually after the compute
Not a Service The OI Server will not run as a service.
4. Read the warning message, and then click Yes.
If the OI Server is running as a service, the icon on the OI Server node in the SMC is yellow. If the OI
Server is running as not a service, the icon is white.
Note: an OI Server with active OPC clients does not stop until the last OPC client shuts down.
OPC/COM Activation
The OI Server can run only out-of-process (i.e., as a stand-alone process).
If a client uses the CLSCTX_ALL value in an activation call (e.g., CoCreateInstance) to activate the OI
Server, out-of-process activation is triggered. Explicitly starting the OI Server in-process (i.e., as a part
of the client process) is not supported.
Using the CLSCTX_ACTIVATE _64_BIT_SERVER value in an activation call is also not supported.
When the OI Server is running out-of-process, it supports requests from both DDE/SuiteLink and OPC
client applications.
Hot Configuration
Hot configuration allows you to configure some parameters in the OI Server while it is running.
If you change the value of a parameter and it immediately takes effect while the OI Server is running,
the parameter is hot-configurable.
The following parameters and features in the OI Server are hot-configurable:
Global parameters on the Configuration node.
Adding, deleting, or modifying a device in a channel. (Modifying a device does not affect other
devices except for the children of the modified device.)
Adding, deleting, or modifying a device group, in the Device Groups tab on a device node.
Adding, deleting, or modifying an item reference, in the Device Items tab on a device node.
There is no support for hot configuration of server-specific parameters. You can configure
server-specific parameters while the OI Server is running, but if you do, the OI Server will send a
warning message to the log and you must restart the OI Server to have the changes take effect.
See the sections about the specific parameters for limitations or constraints.
Demo Mode
You can install the OI Server without a license. The OI Server runs without a license in Demo mode for
120 minutes.
While in demo mode the OI Server checks for a license every 30 seconds. When the 120 minutes
expires:
the OI Server stops updating items.
all non-system items have a Bad quality status.
new items are rejected.
After the 120 minutes the OI Server checks for a license every thirty seconds. If a license is not found,
the OI Server logs a warning.
You can use the $SYS$Licensed system item to check the status of your license. This item returns true
if the proper license is found or the OI Server is in demo mode (the 120 minutes), otherwise, it returns
false.
After the OI Server finds a valid license, it logs a message, stops looking for a license, and begins
running normally. For more information, see the License Utility User Guide.
Accessing the Data in Your OI Server
Client applications read and write to data items that are internal to the OI Server, as well as to the
items located in the devices. Client application communication with the OI Server is done using either
OPC or the DDE/SuiteLink protocols. The client application may or may not be on the same computer
as the OI Server.
You do not need to create device items in the OI Server for your OPC client application.
For information on how to specify item references, see Item Reference Descriptions
daserver_itemreference.html#daserver_itemreference.
Application Name:
Base Instance: <Server Instance> (for example: MBTCP)
Cloned Instance: <Server instance>_n; where n = Custom Instance Name (for example:
MBTCP_1)
Troubleshooting
You can troubleshoot problems with the OI Server using the:
Windows Task Manager
Windows Performance and Alerts (PerfMon) application, also called Performance Monitor
OI Server Diagnostics
ArchestrA Log Flag Editor
ArchestrA Log Viewer
Your client application may let you view error messages, monitor the status of requests, and allow you
to request data on the status of the OI Server and connected devices. For more information, see your
client application documentation.
Using the Diagnostics Node on page 56
The OI Server Manager has information that may be useful in troubleshooting problems. When the OI
Server is active, a Diagnostics node is present below the Configuration node in the console tree of
the System Management Console.
Using the Wonderware Log Viewer on page 57
Error messages are created by the OI Server and logged by the Logger. You can view these
messages with the Log Viewer. The Log Viewer help files explain how to view messages and how to
filter which messages are shown.
Using the Windows Tools on page 58
Windows has two tools that may be useful in troubleshooting performance problems.
Note: Generating large numbers of diagnostic messages can impact OI Server performance. You
should not run in production with any more flags than those set when the OI Server is installed. To
troubleshoot you can turn on more flags, but there is a performance impact. For more information, see
the Log Flag Editor User Guide.