Siemens

Energy & Automation

Configuration Guide

CG39RESINIT
Rev: 2
June 2001

Resource Initialization Utility

For
Version 4.20 or Higher

CG39RESINIT-1

Introduction

Table of Contents
Section

Title

1.0
1.1
1.2
1.2.1
1.2.2

Introduction ................................................................................................................... 1-1

Product Description ......................................................................................................1-1
Software Identification And Support ............................................................................1-2
Software Identification ...........................................................................................1-2
Product Support......................................................................................................1-2

2.0
2.1
2.2

Software Installation..................................................................................................... 2-1

Operating Systems ........................................................................................................2-1
Installation Procedures..................................................................................................2-1

3.0
3.1
3.2
3.2.1
3.2.2
3.2.3
3.2.4
3.2.5
3.2.6
3.3
3.3.1
3.3.2

Configuration................................................................................................................. 3-1
Operational Modes........................................................................................................3-1
Operational Parameters.................................................................................................3-1
Source Resource .....................................................................................................3-1
Destination Resource..............................................................................................3-2
Destination Name ...................................................................................................3-2
Overwrite................................................................................................................3-2
Auto Mode..............................................................................................................3-2
Nodisplay................................................................................................................3-2
Setup .............................................................................................................................3-3
Guidelines...............................................................................................................3-3
Command Line Examples ......................................................................................3-3

4.0
4.1
4.2
4.3
4.4

Operation And System Messages................................................................................. 4-1

Normal Operation .........................................................................................................4-1
Program Operation Errors.............................................................................................4-2
Operational Parameter Errors........................................................................................4-3
System Messages And Return Codes............................................................................4-3

June 2001

Page

Contents

CG39RESINIT-1

List of Tables
Table

Title

Page

Table 11 TIC Contact Information......................................................................................................... 1-3

Table 41 System Messages and Return Codes....................................................................................... 4-4

List of Illustrations
Figure
Figure 41
Figure 42
Figure 43
Figure 44

Title

Page

Main Operator Display ...........................................................................................................4-1

Completion Status Dialog Box ...............................................................................................4-2
Error Dialog Box ....................................................................................................................4-2
Program Information Screen...................................................................................................4-3

Siemens Energy and Automation, Inc., assumes no liability for errors or omissions in this document or for the application and use of
information included in this document. The information herein is subject to change without notice.
Procedures included in this document have been reviewed for compliance with applicable approval agency requirements and are considered
sound practice. Neither Siemens Energy and Automation, Inc., nor these agencies are responsible for repairs made by the user.
ProcessSuite, QUADLOG, 4-mation , and APACS+ are trademarks of Siemens Energy and Automation, Inc. All other trademarks are the
property of their respective owners.
2001 Siemens Energy and Automation, Inc. All rights reserved.

ii

June 2001

CG39RESINIT-1

1.0

Introduction

Introduction

The APACS+ Resource Initialization Utility version 4.20 is a Windows NT program that
automatically transfers an off-line configuration to an on-line system. It is intended for customers who
must re-initialize and configure their equipment automatically on machine power-up. This is necessary,
for example, after the ACM of a system that must be ready to perform on power up without technical
assistance unexpectedly resets, or loses power for a period of time longer than the battery life.
This document contains the following sections:

Section 1, Introduction Summarizes the information presented in this Guide, gives a product
description, provides details about Siemens Energy & Automation Technical Information Center
(TIC) that is available for customer support, and lists reference literature to consult for more
information.

Section 2, Software Installation Describes the procedures for performing initial software set-up. It
also explains how to identify your Resource Initialization Utility version.

Section 3, Configuration Describes the programs parameters and explains their implementation.

Section 4, Operation and System Codes Describes the operation of the Resource Initialization
Utility and lists the possible system messages and return codes.

1.1

Product Description

The APACS+ Resource Initialization Utility is a program for automatic initialization of an APACS+
resource with both the operating system code and a specified configuration. There are versions of the
program for Windows NT 4.0 operating systems. This program can initialize any APACS+ or
QUADLOG resource, such as an embedded Advanced Control Module (ACM), a PC controller, a Link
Interface Module (LIM), a QUADLOG ACM, or a Critical Control Module (CCM).
The program transfers the configuration from one resource to another resource. The resource being
initialized (the destination) can be either an on-line or an off-line resource, and the source resource can
also be either an on-line or an off-line resource. Additionally, the program may assign the resource name
of the destination resource if specified by the operational parameters. The program ensures that the
source configuration is compatible with the destination resource type.
If the destination resource is an on-line resource, the destination resources operating system code will be
initialized if the resource either (a) does not contain operating system code, or (b) contains operating
system code which is incompatible with the specified configuration. The program uses the appropriate
system code in the same manner as 4-mation. The system code is determined by the installed APACS+
and QUADLOG module components that are present in the MODULE.INI file. If the destination
resource already contains a configuration, the program can be instructed to overwrite that configuration if
necessary.
The program has two modes of operation:

June 2001

1-1

Introduction

CG39RESINIT-1

Automatic Mode In this mode, the program executes and completely terminates itself on
completion.

Semi-Automatic Mode In this mode the program executes, displays a completion status message in
a dialog box, and waits for user acknowledgment before terminating
NOTE
The default mode is the semi-automatic mode.

1.2

Software Identification And Support

1.2.1

Software Identification

The Resource Initialization Utility is bundled with APACS+ Version 3.01 and later control simulator and
control engine software.
1.2.2

Product Support

Product support can be obtained from a Technical Information Center (TIC). Each regional TIC is a
customer service center that provides direct telephone support on technical issues related to the
functionality, application, and integration of all products supplied by Siemens. Regional TIC contact
information is provided in Table 1-1. Your regional TIC is the first place you should call when seeking
product support information. When calling, it is helpful to have the following information ready:

Caller ID number, or name and company nameWhen someone calls for support for the first time, a
personal caller number is assigned. Having the number available when calling for support will allow
the TIC representative taking the call to use the central customer database to quickly identify the
callers location and past support needs.

Product part number or model number and version

If there is a problem with product operation:

- Whether or not the problem is intermittent
- The steps performed before the problem occurred
- Any error messages or LED indications displayed
- Installation environment

Customers that have a service agreement (ServiceSuite or Field Service Agreement) are granted access to
the secure area of our Web site (http://www.smpa.siemens.com/TechServices/TechLibrary.asp). This area
contains a variety of product support information. To log on, you will be prompted to enter your
username and password.

1-2

June 2001

CG39RESINIT-1

Introduction

Table 11 TIC Contact Information

TIC
NORTH AMERICA

Tel:

+1 215 646 7400, extension 4842

Fax:

+1 215 283 6343

E-mail:
Hours of Operation:
Secure Web Site:

TIC
ASIA

8 a.m. to 6 p.m. eastern time

Monday Friday (except holidays)
www.smpa.siemens.com/techservices

Tel:

+65 299 6051

Fax:

+65 299 6053

E-mail:

TICGroupAP@smpa.siemens.com

Hours of Operation:

9 a.m. to 6 p.m. Singapore time

Monday Friday (except holidays)

Secure Web Site:

TIC
EUROPE

TICGroupNA@sea.siemens.com

www.smpa.siemens.com/techservices

Tel:

+44 1935 470172

Fax:

+44 1935 706969

E-mail:
Hours of Operation:

TICGroupEurope@smpa.siemens.com
8:30 a.m. to 5:15 p.m. GMT/BST
Monday Thursday
(except holidays)
8:30 a.m. to 4:00 p.m. GMT/BST
Friday (except holidays)

Secure Web Site:

June 2001

www.smpa.siemens.com/techservices

1-3

Introduction

1.3

CG39RESINIT-1

Related Literature

The following documentation is available from Siemens. Generally, all needed documentation is supplied
on a CD-ROM supplied with your system. Refer to it as needed or as directed in text.

Installing 4-mation Version 4.20 or Higher (document number SG39-12)

Using the 4-mation Configuration Software for Version 4.20 or Higher (document number CG39-20)

Reference and technical manuals received with the workstation or PC on which the APACS+
Resource Initialization Utility software is installed.

Reference and technical manuals and online documentation received with the operating system being
used on the workstation or PC.
!

1-4

June 2001

CG39RESINIT-1

2.0

Software Installation

Software Installation

This section discusses the different versions of the utility required for the different operating systems on
which the software can be installed and explains how to install it.
2.1

Operating Systems

For each operating system, there is a version that uses Modulbus (M-BUS) communications and a version
that uses Ethernet (TCP/IP) communications. This results in the following versions of the program:
RESINITM.EXE
RESINITN.EXE
2.2

32-bit version for M-BUS

32-bit version for Ethernet

Installation Procedures

The APACS+ Resinit is installed when the control simulator or control engine is installed. The
Executable is in the same directory as 4-mation.
!

June 2001

2-1

Software Installation

2-2

CG39RESINIT-1

June 2001

CG39RESINIT-1

3.0

Configuration

Configuration

Configuration of the APACS+ Resource Initialization Utility involves specifying the required operational
parameters. This section explains the programs operational modes and explains the implementation of
the operational parameters.
3.1

Operational Modes

The program has two modes of operation:

Automatic Mode In this mode, the program executes and completely terminates itself on
completion. No status message appears on completion, but the program generates an exit code (refer
to Section 4, Operation and System Messages). Missing or erroneous operational parameters cause
an error dialog box to appear. The user must acknowledge the error before the program terminates.

Semi-Automatic Mode In this mode, the program executes, displays a completion status message
in a dialog box, and generates an exit code (refer to Section 4, Operation and System Messages).
The user must acknowledge the completion status message before the program terminates. Missing
or erroneous operational parameters cause an error dialog box to appear. The user must acknowledge
the error before the program terminates.

3.2

Operational Parameters

The APACS+ Resource Initialization Utility uses the operational parameters listed here. They can be
entered in shortcuts, Windows NT command lines or batch files as discussed in section 3.3, Setup
Guidelines.
NOTE
In the following parameter formats, UPPER CASE indicates values that
must be entered as they appear, and lowercase Italics indicates variable
values.
3.2.1

Source Resource

Format:

/S:system name:resource address

This parameter specifies the system name and resource address of the source resource. The system name
is either the full directory name for an off-line system (for example, C:\APACS\Systems\System1), or the
string SYSTEM for an on-line system. This parameter is required.
The resource address specifies the node/rack/slot address of the resource, and must be of the form
NxxRxxSxx where xx represents a two digit decimal numeric value. A colon (:) must separate the
system name and the resource address.

June 2001

3-1

Configuration

Examples:

CG39RESINIT-1

/S:C:\APACS\Systems\System1:N01R02S03
/S:SYSTEM:N03R02S01

3.2.2
Format:

Destination Resource
/D:system name:resource address

This parameter specifies the system name and resource address of the destination resource. It follows the
same format as the Source Resource parameter (section 3.1.1). This parameter is required.
3.2.3
Format:

Destination Name
/NAME:name

This parameter specifies the resource name that the destination resource will be assigned with as part of
the initialization process. This parameter is optional.
3.2.4
Format:

Overwrite
/OVERWRITE

If the destination resource already contains a configuration, this parameter specifies that it should be
automatically overwritten. This parameter is optional.
NOTE
If the destination resource already contains a configuration and the
/OVERWRITE parameter is not specified, the initialization will fail and
an error message will appear in the semi-automatic mode.
3.2.5
Format:

Auto Mode
/AUTO

This parameter specifies the automatic mode, as previously described. This parameter is optional.
NOTE
If the /AUTO parameter is not specified, the semi-automatic (default)
mode will be used.
3.2.6
Format:

3-2

Nodisplay
/NODISPLAY

June 2001

CG39RESINIT-1

Configuration

This parameter specifies that the normal operator displays are not visible during the program operation.
However, any error in operation parameters will still result in an error dialog box appearing. This
parameter is optional.
NOTE
The /NODISPLAY parameter can only be used when the /AUTO
parameter is specified (automatic mode).
3.3

Setup

3.3.1

Guidelines

The APACS+ Resource Initialization Utility can be invoked by a Windows shortcut, or by a command
line or a batch file (in a Prompt window or a Windows NT 4.0 command window). The program can also
be invoked from within another program (such as a Visual Basic application), using standard Windows
API functions to create a process. Refer to Windows printed and online documentation for procedures on
creating a shortcut or command line, and follow these guidelines:

Use a Windows shortcut only when configuring the program to initialize a single ACM. Otherwise,
you will need a shortcut for each ACM.

Create a Windows shortcut to execute the APACS+ Resource Initialization Utility with the desired
operational parameters.

In a Prompt window or a Windows NT 4.0 command window, enter the path to the APACS+
Resource Initialization Utility, followed by the operational parameters on each command line.

It is recommended to use the START/WAIT command as the first entry on each command line.

Use a batch file for initializing multiple APACS+/QUADLOG modules. Each line of the batch file
should invoke the program to initialize an individual module. Include the path and command in each
line, followed by the operational parameters.

3.3.2

Command Line Examples

This section contains examples of command lines for this program that follow the guidelines in section
3.3.1.

path\RESINITM.EXE /S:C:\APACS\Systems\System1:N00R01S02 /D:SYSTEM:N00R01S02

Transfer configuration from an offline system at C:\APACS\Systems\System1, Node 0 Rack 1 Slot 2,
to a resource in an online system at Node 0 Rack 1 Slot 2. If the target resource is already configured,
this command does not overwrite it.

path\RESINITM.EXE /S:C:\APACS\Systems\System1:N00R01S02 /D:SYSTEM:N00R01S02

/NAME:Resource1

June 2001

3-3

Configuration

CG39RESINIT-1

Transfers the same configuration as in the previous example, and assigns the name Resource1 to
the online resource.

path\RESINITM.EXE /S:C:\APACS\Systems\System1:N00R01S02 /D:SYSTEM:N00R01S02

/OVERWRITE
Transfers the same configuration as in the previous example, but forces an overwrite even if the target
resource is already configured.

path\RESINITM.EXE /S:SYSTEM:N00R01S02 /D:C:\APACS\Systems \System1:N00R01S02

/OVERWRITE /AUTO
Transfers the configuration from an online resource at Node 0 Rack 1 Slot 2 to an offline system at
C:\APACS\Systems\System1, Node 0 Rack 1 Slot 2. This method can be used to automatically make
a backup of a configuration being run (and possibly modified) in an online system. No user message
box is displayed on completion.

path\RESINIM Xfer.bat
Examples:
RESINITM/S:c:\APACS\Systems|System1:N00R01S02/D:SYSTEM:N00R01S02
/NAME:Resource1
dir c:\*.* /s (* Added for transfer delay *)
RESINITM /S:c:\APACS Systems|System1:N00R01S02 /D:SYSTEM:N00R01S03
/NAME:Resource2
dir c:\*.* /s (* Added for transfer delay *)
!

3-4

June 2001

CG39RESINIT-1

4.0

Operation And System Messages

Operation And System Messages

This section describes the operation of the Resource Initialization Utility and lists the possible system
messages and return codes.
4.1

Normal Operation

When the program is invoked, the Main Operator Display (Figure 4-1) appears.

Figure 41 Main Operator Display

This display indicates the source and destination resources, the assigned resource name (if specified),
other operational parameters, and program status information. The text indicating the current program
action (shown as Transferring Configuration in Figure 4-1) changes as the program initializes,
downloads the destination resources operating system code, and transfers the configuration. The percent
complete text and the progress bar indicate the status of each stage of the operation.
Click on Cancel to halt the resource initialization before completion.
When the program completes successfully in semi-automatic mode, a completion status dialog box
(Figure 4-2) appears.

June 2001

4-1

Operation And System Messages

CG39RESINIT-1

Figure 42 Completion Status Dialog Box

4.2

Program Operation Errors

In the case of a program operation error (semi-automatic mode only), an error dialog box (Figure 4-3)
appears.

Figure 43 Error Dialog Box

A specific error message corresponding to one of the return codes in Table 4-1 appears in the dialog box.
NOTE
The Error Codes that appear in the Error dialog box are not the same as
the Return codes in Table 4-1.
To resolve a program error condition:
1. Look up the text of the message in Table 4-1.
2. Click on OK to close the error dialog box
3. Perform the action indicated in Table 4-1.
4. Restart the Resource Initialization Utility.
If the problem cant be resolved, contact the Siemens Technical Information Center (TIC).

4-2

June 2001

CG39RESINIT-1

4.3

Operation And System Messages

Operational Parameter Errors

If the program is invoked with improper or incomplete operational parameters, the program information
screen (Figure 4-4) appears.

Figure 44 Program Information Screen

To resolve an operational parameter error condition:
1. Use this screen as a guide to review the parameters entered in the shortcut(s), the command line
(Windows NT) or in a batch file.
2. Then click on OK to close the program information screen.
3. Restart the program.
4.4

System Messages And Return Codes

The program performs several error checks while performing its operations. The program generates a
message and return code (available through the standard ERRORLEVEL batch command statements)
based on these checks to provide the operator with feedback on the status of the operation. Table 4-1 lists
the messages and return codes corresponding to the system conditions detected.
NOTE
Return codes are not error codes. They are used by advanced
programmers to troubleshoot the system.

June 2001

4-3

Operation And System Messages

CG39RESINIT-1

Table 41 System Messages and Return Codes

MESSAGE
Successful resource initialization
Cannot open source resource

Cannot read source configuration version

identifier
Configuration is incompatible with module
code

Destination resource could not be found or

accessed
Destination resource is already configured

Error clearing configuration from

destination resource

Error downloading module code

Error in operational parameters no

resource initialization done
Error initializing communications

Error initializing database MODULE.INI

error

4-4

DESCRIPTION
No error; initialization succeeded.
The source resource could not be opened,
possibly due to an access restriction or the
resource currently being edited. No
initialization performed.
The version identifier of the source
resource could not obtained. No
initialization performed.
The version of the specified configuration
is incompatible with the version of the
module code in the destination resource.
An attempt was made to update the version
of module code by downloading the
module code from disk file, but that
version was also incompatible. The
destination resource is left in an
unconfigured state.
The destination resource could not be
found. Either the system name or resource
address is probably incorrect.
The destination resource currently contains
a configuration, and the /OVERWRITE
parameter was not specified. No
initialization performed.
There was an error clearing the current
configuration from the destination
resource. The destination resource may
have been renamed (if specified by
program parameters). No initialization
performed.
There was an error downloading the
module code to the destination resource.
The destination resource is left in an
unconfigured state.
One or more operational parameters were
incorrect.
There was an error initializing the on-line
communications system (M-BUS or
Ethernet).
There was an error initializing the
programs internal database, most likely
caused by a missing or invalid
MODULE.INI file.

RETURN
CODE
0
7

16

10

17

15

1
2

June 2001

CG39RESINIT-1

Operation And System Messages

MESSAGE
Error renaming destination resource

Error transferring configuration

Invalid or unknown module type

Resource types are incompatible

Source configuration incompatible with

program
Source resource could not be found or
accessed
Source resource is not configured
Specified resource name already exists in
destination system

DESCRIPTION
There was an error assigning the name of
the destination resource. No initialization
performed.
There was an error downloading the
configuration from the source resource to
the destination resource. The destination
resource may be left in an unconfigured
state.
One of the resources was of a module type
that was not found in the MODULE.INI
file.
The source and destination resources are of
incompatible module types. No
initialization performed.
The source configuration version is
incompatible with this program. No
initialization performed.
The source resource could not be found.
Either the system name or resource address
is probably incorrect.
There is no configuration in the source
resource. No initialization performed.
The resource name specified for the
destination resource already exists in the
destination system. No initialization
performed.

RETURN
CODE
14

18

12

11
13

June 2001

4-5

Operation And System Messages

4-6

CG39RESINIT-1

June 2001