You are on page 1of 62

Citect Pty Ltd

3 Fitzsimmons Lane
Gordon NSW 2072
Australia
www.citect.com

















Installation and ASW Guide




























Version

1.1.1



2
CitectSCADA Installation and ASW Guide



DISCLAIMER

Citect Pty. Limited makes no representations or warranties with respect to this manual and, to
the maximum extent permitted by law, expressly limits its liability for breach of any warranty
that may be implied to the replacement of this manual with another. Further, Citect Pty. Limited
reserves the right to revise this publication at any time without incurring an obligation to notify
any person of the revision.

COPYRIGHT

Copyright 2004 Citect Pty Limited. All rights reserved.

TRADEMARKS

Citect Pty Limited has made every effort to supply trademark information about company
names, products and services mentioned in this manual. Trademarks shown below were
derived from various sources.

CitectSCADA, CitectHMI/SCADA, CitectFacilities and CitectSCADA Batch are registered
trademarks of Citect Pty. Limited.

IBM, IBM PC and IBM PC AT are registered trademarks of International Business Machine
Corporation.

MS-DOS, Windows, Windows 98, Windows 2000, Windows XP and Excel are trademarks of
Microsoft Corporation.

dBase is a trademark of Borland Inc.

General Notice:
Some product names used in this manual are used for identification purposes only and may be
trademarks of their respective companies.




November 2004 Edition for CitectSCADA Batch
Manual Revision 1.0.0
3
CitectSCADA Installation and ASW Guide




TABLE OF CONTENTS

1 INTRODUCTION.............................................................................................................................................. 4
2 GENERAL ITEMS............................................................................................................................................. 4
3 INSTALLATION................................................................................................................................................ 5
3.1 CITECT.......................................................................................................................................................... 5
3.2 ACROBAT READER ....................................................................................................................................... 5
3.3 INSTALL SHIELD........................................................................................................................................... 5
3.3.1 Common installation............................................................................................................................... 5
3.3.1.1 Any Client........................................................................................................................................................6
3.3.1.2 Batch Client......................................................................................................................................................9
3.3.1.3 Batch Server...................................................................................................................................................16
3.3.2 Failure Handling................................................................................................................................... 25
3.3.3 Uninstall ................................................................................................................................................ 26
3.3.4 Programs ............................................................................................................................................... 30
4 CTB INCLUDE................................................................................................................................................. 31
4.1 THE PROJ ECT CTB_INCLUDE CONTAINS FOLLOWING FILES....................................................................... 31
4.2 DEFINITION OF AN I/O SERVER AND I/O DEVICE....................................................................................... 32
4.2.1 Citect.ini Parameter: (Displayed are the default settings) .................................................................. 32
4.2.1.1 Cicode............................................................................................................................................................32
4.2.1.2 Citect INI settings..........................................................................................................................................32
4.3 DISPLAY OF PDF-REPORT:......................................................................................................................... 33
4.3.1 Citect.ini Parameter: (Displayed are the default settings) .................................................................. 33
4.3.2 Size of Active X Control ........................................................................................................................ 33
4.4 DISPLAY OF CTBSUM................................................................................................................................. 34
4.5 DISPLAY OF CTBS AND CTBV.................................................................................................................. 34
4.5.1 CtBS....................................................................................................................................................... 34
4.5.2 CTBV Detail .......................................................................................................................................... 34
4.5.3 CTBV Overview..................................................................................................................................... 35
4.6 CTBRP (REPORT CREATION)...................................................................................................................... 35
4.6.1 Devices .................................................................................................................................................. 35
4.6.2 Citect.ini Parameter: (Displayed are the default settings) .................................................................. 36
4.7 WATCHDOG................................................................................................................................................ 37
4.7.1 Citect.ini Parameter: (Displayed are the default settings) .................................................................. 38
4.8 CTBREDDB............................................................................................................................................... 39
4.8.1 Citect.ini Parameter: (Displayed are the default settings) .................................................................. 39
4.9 CTBBE....................................................................................................................................................... 39
4.10 CTBSUM..................................................................................................................................................... 40
4.10.1 Parameters:....................................................................................................................................... 40
4.10.2 Devices:............................................................................................................................................. 41
4.10.3 Periodical Event ............................................................................................................................... 42
4.10.4 Citect.ini Parameter: (Displayed are the default settings).............................................................. 42
4.10.5 User Interface ................................................................................................................................... 43
4.10.5.1 Example.........................................................................................................................................................44
5 ADVANCED BATCH SETUP WIZARD...................................................................................................... 45
5.1 STAND ALONE COMPUTER......................................................................................................................... 46
5.2 NETWORK COMPUTER................................................................................................................................ 49
5.2.1 Server and Display Client ..................................................................................................................... 49
5.2.2 Display Client........................................................................................................................................ 54
5.3 ANY CLIENT ............................................................................................................................................... 57
6 PROJECT CHANGE....................................................................................................................................... 61
6.1 CITECT........................................................................................................................................................ 61
6.2 EQUIPMENT OR RECIPE EDITOR ................................................................................................................. 61
6.3 START......................................................................................................................................................... 61
7 GLOSSARY...................................................................................................................................................... 62
4
CitectSCADA Installation and ASW Guide




1 Introduction
The installation of the batch is carried out in two steps. First you install the Batch application
via the Install Shield and secondly you set your parameters for the Batch Application via the
Advanced Batch Setup Wizard.

Citect has already to be installed on the PC, except that the user choose the setup type Any
Client.



2 General items
Citect SCADA Batch is tested on Citect SCADA 5.42 r0 and W2K SP3 and Win XP
Professional (English edition). CitectSCADA V5.41 will not be supported.

Citect SCADA Batch supports English, German and French Language. It is configured for the
resolution 1024x768.

Citect SCADA Batch uses a DAO Driver to communicate to the Audittrail Report.

Citect SCADA Batch requires one CT-API license and one Citect Client license in order to run
the Batch Engine; Citect IDC and Flying Licenses are not supported.

5
CitectSCADA Installation and ASW Guide



3 Installation
3.1 Citect
The Citect system has to be installed on the hard disk. During installation you should follow the
instructions of CiTechnologies and use the default settings.

3.2 Acrobat Reader
Acrobat Reader 4.0 or 5.0 should be installed.

3.3 Install Shield
3.3.1 Common installation
The install Shield is started via the setup.exe program in the following directory:








A double click on the setup.exe program starts the Install shield of CitectSCADA Batch.

The install shields starts with the following screen:
In this step you select the type of Setup you want to carry out.
The contains of the following window depends from your choice.

6
CitectSCADA Installation and ASW Guide



In general:
With next you go to the next step / window of the Install Shield.
With back you go one step / window back of the Install Shield.
With cancel you quit the Install Shield.


3.3.1.1 Any Client
If you select the set up type Any Client the following parameters can be defined.
With Select All you select all listed parameters.
With Clear all you deselect all listed parameters.


In the next window all selected parameters, in this case for the Any Client, are listed for your
information. The content of the window depends on the prior selected setup type and
components.


7
CitectSCADA Installation and ASW Guide



Here you select the folder in which you want CitectSCADA Batch be installed.


With Browse you open a second window to search for a destination folder different from the
default folder.


8
CitectSCADA Installation and ASW Guide



With next you start the copy process.

After the installation of CitectSCADA Batch the installation of the MSDE Client Connectivity will
be started.

9
CitectSCADA Installation and ASW Guide



After the installation of CitectSCADA Batch and the MSDE Connectivity the installation has
been finished.

To complete the Setup correctly you have to confirm the installation with the Finish button.



3.3.1.2 Batch Client
If you select the set up type Batch Client the following parameters can be defined.
With Select All you select all listed parameters.
With Clear all you deselect all listed parameters.

10
CitectSCADA Installation and ASW Guide



In the next window all selected parameters, in this case for the Batch Client, are listed for your
information. The content of the window depends on the prior selected setup type and
components.


Here you select the folder in which Citect has been installed.

11
CitectSCADA Installation and ASW Guide



With Browse you open a second window to search for a destination folder different from the
default folder.


With next you start the copy process.

12
CitectSCADA Installation and ASW Guide



The DAO installation starts with a welcome screen.

In general:
With next you go to the next step / window of the DAO Installation.
With back you go one step / window back of the DAO Installation.
With cancel you quit the DAO Installation.

In the following set up window you can define the components to be installed. It is
recommended not to change the standard settings during the DAO installation.

With back you go backward to the previous step in the install shield application.
With next you go forward to the next step in the install shield application.
With cancel you will stop the installation.
In the following set up window you can define the components to be installed. It is
recommended not to change the standard settings during the DAO installation.
13
CitectSCADA Installation and ASW Guide




With back you go backward to the previous step in the install shield application.
With next you go forward to the next step in the install shield application.
With cancel you will stop the installation.


With next you start the copy process.


14
CitectSCADA Installation and ASW Guide



After the DAO installation has been carried out an information message appears that has to be
confirmed with OK.


After the installation of DAO the installation of the MSDE Client Connectivity will be started.

15
CitectSCADA Installation and ASW Guide



After the installation of CitectSCADA Batch, DAO, and the MSDE Connectivity the installation
has been finished.

To complete the Setup correctly you have to confirm the installation with the Finish button.

16
CitectSCADA Installation and ASW Guide



3.3.1.3 Batch Server
If you select the set up type Batch Server the following parameters can be defined.
With Select All you select all listed parameters.
With Clear all you deselect all listed parameters.


In the next window all selected parameters, in this case for the Batch Server, are listed for
your information. The content of the window depends on the prior selected setup type.


17
CitectSCADA Installation and ASW Guide



Here you select the folder in which Citect has been installed.


With Browse you open a second window to search for a destination folder different from the
default folder.




18
CitectSCADA Installation and ASW Guide



If you choose a directory in which Citect isn't installed, following message appears that has to
be confirm with OK.

Confirm the message and browse for the correct directory.


With next you start the copy process.

19
CitectSCADA Installation and ASW Guide



The DAO installation starts with a welcome screen.

In general:
With next you go to the next step / window of the DAO Installation.
With back you go one step / window back of the DAO Installation.
With cancel you quit the DAO Installation.

In the following set up window you can define the components to be installed. It is
recommended not to change the standard settings during the DAO installation.

With back you go backward to the previous step in the install shield application.
With next you go forward to the next step in the install shield application.
With cancel you will stop the installation.
In the following set up window you can define the components to be installed. It is
recommended not to change the standard settings during the DAO installation.
20
CitectSCADA Installation and ASW Guide




With back you go backward to the previous step in the install shield application.
With next you go forward to the next step in the install shield application.
With cancel you will stop the installation.


With next you start the copy process.

21
CitectSCADA Installation and ASW Guide



After the DAO installation has been carried out an information message appears that has to be
confirmed with OK.

22
CitectSCADA Installation and ASW Guide



After the installation of DAO the installation of the MSDE will be started. The MSDE Setup
starts with the following screen, if no Microsoft SQL Server Installation is detected.



Here you define the destination folder for the MSDE SQL Server installation.


23
CitectSCADA Installation and ASW Guide



With Browse you open a second window to search for a destination folder different from the
default folder.


Here you define the destination folder for the MSDE SQL Data installation.

With Browse you open a second window to search for a destination folder different from the
default folder.


With next you start the installation process. The installation of the MSDE database takes a
couple of time.


24
CitectSCADA Installation and ASW Guide



Following window indicates that the installation of the CitectSCADA Batch has been carried
out.

To complete the Setup correctly you have to confirm the installation with the Finish button.

25
CitectSCADA Installation and ASW Guide



3.3.2 Failure Handling

Failure or Failure
text
Effect Possible Reason Actions
Wrong Parameter by
calling of setup
The directory name in
which the setup
program has been
saved is too long
The directory name
should be less than
70 characters
The setup can't
carried out
The directory
structure within the
setup directory has
been changed
The structure of the
subfolders in the
setup directory should
not be changed
Error message from
windows (Service
batch instance
couldn't be started)
No database
available
The service of the
Batch instance hasn't
be started
automatically.
Start the service
(batch instance)
manually
OSQL.exe not found.
Attach Database failed.
No database
available
The MSDE database
couldn't be installded.
Carry out the
installation again. If
failure occurs again
check the hardware
of you PC.



26
CitectSCADA Installation and ASW Guide



3.3.3 Uninstall
The first Step to uninstall the Batch Application is to stop the Citect Batch Redundant
Database Service.
First you open the Control Panel via Start settings Control panel
In the Control Panel you start the Service Program and stop the Service






















When the Service is stopped, got o the next uninstall step.

Uninstall of Citect Batch Redundant Database Service.
Open the Windows menu Start and Run

Change in the Citect \ Batch directory and type in the following cmd line:
C:\Citect\CitectSCADA\Batch\ctbreddb r


(Example)

The Service will remove.
When the Service is removed, got o the next uninstall step.


27
CitectSCADA Installation and ASW Guide



To uninstall the batch application you have to open the Add / Remove Program.
First you open the Control Panel via Start settings Control panel


In the Control Panel you start the Add / Remove Program.


28
CitectSCADA Installation and ASW Guide



In the Add / Remove Program you select the batch application and press the button
Change/Remove.


Do uninstall the batch application you have to confirm the following message with Yes.



29
CitectSCADA Installation and ASW Guide



After you uninstalled the batch application select the batch instance of the Microsoft SQL
Server Desktop Engine and press the button Remove.


Do uninstall the Microsoft SQL Server Desktop Engine you have to confirm the following
message with Yes.


30
CitectSCADA Installation and ASW Guide



3.3.4 Programs
The programs Batch Advanced Setup Wizard, Batch Equipment Editor, Batch Engine, and
Batch Recipe Editor can be called via Programs CitectSCADA Batch


31
CitectSCADA Installation and ASW Guide



4 CTB Include
4.1 The project CtB_Include contains following files
The files are located in the User directory of the project CtB_Include.
Cicode functions: Global.ci
Tools.ci
StartBatch1.ci
StartBatch2.ci
RedDB1.ci
RedDB2.ci
CtBSum_Log.ci
CtBSum_AddOn.ci
KW.ci
Watchdog.ci
pdf.ci
Report.ci
ActiveX.ci

Format files: AlmQue.cid
SU1.cid
SU2.cid
ReportInfo.cid
Recipe.cid

Symbol library: sym_gen.ctl

DLL libraries: FileInfo.dll
FileDel.dll
Ctutil.dll

Startup Function: StartBatch()
Shutdown Function: EndOfRuntime()


Note: The user has to call the functions, as the Startup and Shutdown function, within the
project.

Note: All Citect INI Parameters are set with the default values during the first start up of the
project.

32
CitectSCADA Installation and ASW Guide



4.2 Definition of an I/O Server and I/O Device
Following definitions should be carried out.


4.2.1 Citect.ini Parameter: (Displayed are the default settings)
If the project name is different from CtB_Include there are two possibilities to adapt the
settings.
4.2.1.1 Cicode
The function _StartBatch() in the StartBatch1.ci has to be adapted, accordingly to the entered
project name.


4.2.1.2 Citect INI settings
The entry in the Citect INI has to be adapted, accordingly to the entered project name.
[BatchInclude]
PathBatch=d:\citect\citect5.50build_108\batch
PathBatchProject=d:\citect\citect5.50build_108\User\CtB_Include
33
CitectSCADA Installation and ASW Guide



4.3 Display of PDF-Report:
Following elements / actions are required to display the PDF-Report:

Cicode function: pdf.ci
Symbol library: sym_gen.ctl

Page: CtBReport
PageEntry Function(): CreateReader()
PageExit Function(): ReaderExit()

Citect Tags Variable Tag Name: sPDF_Filename Data Type: STRING



4.3.1 Citect.ini Parameter: (Displayed are the default settings)
If Acrobat Reader Version 5 is installed, following settings has to be adapted..

[Acrobat]
Version=4 4 =Version 4 , 5 =Version 5

Requirements: Acrobat Reader has to be installed on the Computer.

4.3.2 Size of Active X Control
In the function CreateReader in the file pdf.ci adjustments regarding the size of the Active X
Control can be carried out.








34
CitectSCADA Installation and ASW Guide



4.4 Display of CtBSum
Cicode function: ActiveX.ci
ActiveX Control: CtBSum.ocx, has been installed during the CitectSCADA Batch
installation.

Page: CtBSum
PageEntry Function(): SleepMs(1);
_CreateAlarmHistorie("","",89,2,1020,601);


4.5 Display of CTBS and CTBV
Cicode function: ActiveX.ci
ActiveX Control: CtBSCtrl.ocx, has been installed during the CitectSCADA Batch
installation.

Following function is used to display the Active X Object:
FUNCTI ON _Cr eat eCt BSCt r l (I NT i Cont r ol t ype, STRI NG sCel l UI D, STRI NG sUni t UI D
= " " , I NT i Top = 0, I NT i Lef t =0, I NT i Wi ght = 1274, I NT i Hei ght = 787, I NT
i An = -1)

Parameters:
iControltype 0 =Scheduler
1 =ViewerDetail
2 =ViewerOverview
sCellUID 8 =used in the Demo project Cell 8 (Note: The UID number has to be confirm
with the UID number entered in the Equipment Editor
SUnitUID 0 =used in the Demo project Unit 8.0 (Note: The UID number has to be confirm
with the UID number entered in the Equipment Editor
iTop coordination point
iLeft coordination point
iWight coordination point
iHeight coordination point
iAn Animation Point

Following function is used to create the Active X Control, therefore you have to add the
Animation point to the pages as defined below:
Ct BSCt r l = DspAnCr eat eCont r ol Obj ect (201," Ct BSCt r l
Cont r ol " ,i Wi ght ,i Hei ght );

4.5.1 CtBS
Page: CtBScheduler
PageEntry Function(): SleepMs(1);
_CreateCtBSCtrl(0,"8","",89,2,1020,601);
Set the animation point to 201

4.5.2 CTBV Detail
Page: CtBViewerDetail
PageEntry Function(): SleepMs(1);
_CreateCtBSCtrl(1,"8","0",89,2,1020,601);
Set the animation point to 201

35
CitectSCADA Installation and ASW Guide



4.5.3 CTBV Overview
Page: CtBViewerOverview
PageEntry Function(): SleepMs(1);
_CreateCtBSCtrl(2,"8","0",89,2,1020,601);
Set the animation point to 201


4.6 CtBRP (Report creation)
Cicode function: Report.ci

Initialization function: InitReport() (the function is called from function StartBatch in the
file StartBatch1.ci)

4.6.1 Devices
Format Files: ReportInfo.cid
Recipe.cid

Following settings should be carried out:




36
CitectSCADA Installation and ASW Guide



4.6.2 Citect.ini Parameter: (Displayed are the default settings)
[CTBRP]
Redundancy=0
Enable=0

Note: The parameter Redundancy is not supported after installation, as the redundancy
depends on the project requirements and has to be defined during engineering. The report is
not enabled after installation.

Requirements: Reports have to be installed during the installation of CitectSCADA
Batch .

For detailed information see 3.3.1 Common installation.


Requirements: Database access is required.
Parameter [CTBE] Server Type has to be set to "PRIMARY" or
"STANDBY"

37
CitectSCADA Installation and ASW Guide



4.7 Watchdog
Cicode function: Watchdog.ci

Initializing function: StartBatchWatchdog() (the function is called from function StartBatch in
the file StartBatch1.ci)

Label: MAX_IP_INDEX, 25

Citect Tags Variable Tag Name: PrimaryTag Data Type: Integer
Variable Tag Name: Watchdog Data Type: Long (will be defined
during engineering as this is a PLC Tag)
Variable Tag Name: PrimaryBatchTag Data Type: Integer (will be
defined during engineering as this is a PLC Tag)


Following settings for the label should be carried out.


Following settings for the Citect Tags should be carried out.


The PrimaryTag will be used by the Batch Engine to define if the Batch Engine is Primary or
Standby on the PC.

38
CitectSCADA Installation and ASW Guide



4.7.1 Citect.ini Parameter: (Displayed are the default settings)
[CTBE]
Enable=0 1 =Enable, 0 =Disable
ServerType= PRIMARY =Primary Batch Server, STANDBY =Standby
Batch Server
ForceRed=0 0 - Redundancy works normal,
1 - Primary Batch Server is always active, Standby Batch
Server is always inactive
ServerCycle=6000 Polltime in Milliseconds
BatchServerOnCitectServer=1 1 - Batch runs on I/O - Sever,
0 - Batch runs on Citect Client

Following settings are required: IF Parameter BatchServerOnCitectServer=1
IP_Adress_Primary= IP-Adress of Primary Server
IP_Adress_Standby= IP-Adress of Standby Server
IP_Adress_Client1= IP-Adress of Clients...
IP_Adress_Client2= IP-Adress of Clients...
IP_Adress_Client3= IP-Adress of Clients...
IP_Adress_Client4= IP-Adress of Clients...
IP_Adress_Client5= IP-Adress of Clients...
IP_Adress_Client6= IP-Adress of Clients...
IP_Adress_Client7= IP-Adress of Clients...
IP_Adress_Client8= IP-Adress of Clients...
IP_Adress_Client9= IP-Adress of Clients...
IP_Adress_Client10= IP-Adress of Clients...
PingTimeout=0 Parameter for TCP/IP Ping
PingRetry=3 Parameter for TCP/IP Ping
PingDelay=100 Parameter for TCP/IP Ping

Following settings are required: IF Parameter BatchServerOnCitectServer=0
Partner_LAN_Node= [LAN] Node - Parameter of Batch-Partner
IOServerName1= IOServerName
IOServerName2= IOServerName
IOServerName3= IOServerName
IOServerName4= IOServerName
IOServerName5= IOServerName
IOServerName6= IOServerName


39
CitectSCADA Installation and ASW Guide



4.8 CtBREDDB
Cicode functions: RedDB1.ci
RedDB2.ci

Initialization function: StartRedDB() (the function is called from function StartBatch in
the file StartBatch1.ci)

Requirements: Installation of CitectSCADA Batch

4.8.1 Citect.ini Parameter: (Displayed are the default settings)
Following entries describe the access parameters for the database (e.g. for a view). The
settings depends on the current location and name of the database.

[RedDB]
UserNameDB=batch
PasswordDB=batch
DbServer=127.0.0.1\BATCH


4.9 CtBBE
Cicode function: StartBatch2.ci

Initialization function: StartBatchEXE() (the function is called from function StartBatch in
the file StartBatch1.ci)

Requirements: Installation of the Batch Engine

Note: With the actions as described above, the Batch Engine will be started with the start of
Citect Runtime.


40
CitectSCADA Installation and ASW Guide



4.10 CtBSum
Cicode functions: CtBSum_Log.ci
CtBSum_AddOn.ci

Initialization function: StartCTBSUM() (the function is called from function StartBatch in
the file StartBatch1.ci)

Note: The creation of files will only be carried out on the alarm server.

4.10.1 Parameters:
Following settings should be carried out:






41
CitectSCADA Installation and ASW Guide






4.10.2 Devices:
Format Files: AlmQue.cid
SU1.cid
SU2.cid (optional, for future extensions)

Following settings should be carried out:




42
CitectSCADA Installation and ASW Guide



(optional, for future extensions)


(optional, for future extensions)



4.10.3 Periodical Event
Following settings should be carried out:



Note: This element has to be activated via the compute setup in Citect on the Citect Primary
and Standby Server.
4.10.4 Citect.ini Parameter: (Displayed are the default settings)
[CTBSUM]
Enable=0 0 =Disable, 1 =Enable; NOTE: Enable only on the
43
CitectSCADA Installation and ASW Guide



AlarmServer
BatchEngineOnAlarmserver=1 0 =Batchengine runs not on an AlarmServer,
1 =Batchengine runs on an Alarmserver
NumberOfSum=1 the number of summary databases
EnableBackupSum=0 0 =no Backup File,
1 =Create a Backup File in Case of Redundancy
BackupPath= Path to store the Backup-File
ServerType=PRIMARY PRIMARY =Priimary Alarm Server,
STANDBY =Standby Alarm Server
DataPathPrimary= Data Path on Primary Alarm Server eg.
\\<ComputerNamePrimary>\Data'
DataPathStandby= Data Path on Standby Alarm Server eg.
'\\<ComputerNameStandby>\Data'
PrefixFilenameSum1=SU Prefix - FileName, should be only 2 characters long
PathSum1=Summary Folder for Summary Database
PeriodSum1=DAY DAY, WEEK, or MONTH
NumberOfDaysSum1=14 Time of History Files in days

Note: The paths DataPathPrimary and DataPathStandby has to be defined on the Citect
Alarm Servers and on the Citect Clients.

Note: The summary is not enabled after installation.


4.10.5 User Interface
Following function can be called from every Citect Client to store information in the Summary.
FUNCTI ON MsgToHi st or i e(STRI NG sBat chno, STRI NG sUser , STRI NG sText , STRI NG
sPr odukt no=" " , STRI NG sCompNo=" " , STRI NG sRohst of f Par t i e=" " , STRI NG
sSet Poi nt =" " , STRI NG sAct ual Val ue=" " , STRI NG sTag=" " )

Parameters:
sBatchno Batch number
sUser User who carried out the action
sText General Description
sProduktno Product number (end product)
sCompNo Component number (product number of the ingredient)
sRohstoffPartie Component lot number (batch number of the ingredient)
sSetPoint Set point
sActualValue Actual Value
stag Citect Tag

44
CitectSCADA Installation and ASW Guide



4.10.5.1 Example
Following test page can be defined.




45
CitectSCADA Installation and ASW Guide



5 Advanced Batch Setup Wizard
The Advanced Batch Setup Wizard is used to set the parameters of all CitectSCADA Batch
functions. These setting can only be done by a Citect engineer during engineering.

The Advanced Batch Setup Wizard is used to customize the Citect SCADA Batch.

The Advanced Batch Setup Wizard is called from a button in Citect (V5.5), if Citect is installed,
or via CitectSCADA Batch Batch Advanced Setup Wizard.


The Advanced Batch Setup Wizard is called without Citect by executing the file CTABSW.exe
from the Install Folder.


During installation you should follow the instructions and use the default settings.


In general:
With next you go to the next step / window of the Setup Wizard.
With back you go one step / window back of the Setup Wizard.
With cancel you quit the Advanced Batch Setup Wizard without any changes to the settings.


46
CitectSCADA Installation and ASW Guide



5.1 Stand Alone Computer
Here you configure the role of the computer in the system.


You have the possibility to run the Batch Application on a Stand Alone Computer, on a
network computer or on a computer without a Citect installation.
The Any Client only supports the Batch Recipe Editor and the Batch Equipment Editor.

If you select Stand Alone Computer (Server and Display Client), following windows will appear.


As the settings will be carried out for a Stand Alone Computer, only the port for the batch
engine listener (used by the Batch scheduler and / or Batch Viewer) has to be defined. The
port will be used for the XCOM communication.



47
CitectSCADA Installation and ASW Guide



In the next step you configure the project which the batch application should be run.
You have the possibility to select an existing project via the list box.



In the next step you select the language in which the Batch application will be run. Following
languages will be supported: German, English, and French


Here you select the language settings of the PC.


48
CitectSCADA Installation and ASW Guide



In the last step following actions are possible.


With finish you complete the Advanced Batch Setup Wizard and save the settings.
With Cancel you quit the Advanced Batch Setup Wizard without any changes to the settings.


49
CitectSCADA Installation and ASW Guide



5.2 Network Computer
5.2.1 Server and Display Client
Here you configure the role of the computer in the system.


You have the possibility to run the Batch Application on a Stand Alone Computer, on a
network computer or on a computer without a Citect installation.
The Any Client only supports the Batch Recipe Editor and the Batch Equipment Editor.

If you select Network computer and Server and Display Client, following windows will appear.


CTBREDDB Server
In the next step you decide if the computer will be run as an CTBREDDB Server. If the
checkbox is not activated, thus the computer will not run as an CTBREDDB Server it is not
possible to edit the other fields in the screen.


50
CitectSCADA Installation and ASW Guide



If the checkbox "This computer is an CTBREDDB Server" is activated following fields have to
be edit.
You have to enter the Computer name and the Port number of the redundant database
partner.

Note: If you leave the field of the computer name empty, the system will not be redundant.




No CTBREDDB Server
If you have decided that the computer will be not run as an CTBREDDB Server. Following
screen appears. Here you have to define the names and port of the redundant database
servers. If there is only one database server on the network leave the standby computer name
blank.

Note: If only one database server is on the network the system will not be redundant.



51
CitectSCADA Installation and ASW Guide



CitectSCADA Batch Server
In the next step you decide if the computer will be run as a CitectSCADA Batch Server. If the
checkbox is not activated, thus the computer will not run as a CitectSCADA Batch Server it is
not possible to edit the other fields in the screen.



If the checkbox "This computer is an SCADA Batch Server" is activated following fields have to
be edit.
First you have to decide if the Server is running as the Standby or the Primary Server. Then
you have to enter the Computer name from the SCADA Batch partner. The port number for the
batch engine listener should be defined as well (the port will be used for the XCOM
communication).

Note: If you leave the field of the computer name empty, the system will not be redundant.



52
CitectSCADA Installation and ASW Guide



No CitectSCADA Batch Server
If you have decided that the computer will be not run as a CitectSCADA Batch Server.
Following screen appears. Here you have to define the names and port of the redundant
CitectSCADA Batch Servers. If there is only one CitectSCADA Batch server on the network
leave the standby computer name blank.

Note: If only one database server is on the network the system will not be redundant.



In the next step you configure the project which the batch application should be run.
You have the possibility to select an existing project via the list box.





53
CitectSCADA Installation and ASW Guide



In the next step you select the language in which the Batch application will be run. Following
languages will be supported: German, English, and French


Here you select the language settings of the PC.


In the last step following actions are possible.


With finish you complete the Advanced Batch Setup Wizard and save the settings.
With Cancel you quit the Advanced Batch Setup Wizard without any changes to the settings.


54
CitectSCADA Installation and ASW Guide



5.2.2 Display Client
Here you configure the role of the computer in the system.


You have the possibility to run the Batch Application on a Stand Alone Computer, on a
network computer or on a computer without a Citect installation.
The Any Client only supports the Batch Recipe Editor and the Batch Equipment Editor.

If you select Network computer and Display Client, following windows will appear.

Here you have to define the names and port of the redundant database servers. If there is only
one database server on the network leave the standby computer name blank.

Note: If only one database server is on the network the system will not be redundant.




55
CitectSCADA Installation and ASW Guide



Next, following screen appears. Here you have to define the names and port of the redundant
CitectSCADA Batch Servers. If there is only one CitectSCADA Batch server on the network
leave the standby computer name blank.

Note: If only one database server is on the network the system will not be redundant.



In the next step you configure the project which the batch application should be run.
You have the possibility to select an existing project via the list box.



56
CitectSCADA Installation and ASW Guide



In the next step you select the language in which the Batch application will be run. Following
languages will be supported: German, English, and French


Here you select the language settings of the PC.


In the last step following actions are possible.


With finish you complete the Advanced Batch Setup Wizard and save the settings.
With Cancel you quit the Advanced Batch Setup Wizard without any changes to the settings.

57
CitectSCADA Installation and ASW Guide



5.3 Any Client
Here you configure the role of the computer in the system.


You have the possibility to run the Batch Application on a Stand Alone Computer, on a
network computer or on a computer without a Citect installation.
The Any Client only supports the Batch Recipe Editor and the Batch Equipment Editor.

If you select Any Client (Computer without Citect Installation), following windows will appear.


Here you have to define the names and port of the redundant database servers. If there is only
one database server on the network leave the standby computer name blank.

Note: If only one database server is on the network the system will not be redundant.



58
CitectSCADA Installation and ASW Guide



In the next step you configure the project which the batch application should be run.
You have the possibility to select an existing project via the list box.



In the next step you can select the option to change the value for standardize.
The standardize is used in the dialog Product in the Recipe Editor
The default standardize value is 100.




59
CitectSCADA Installation and ASW Guide



In the next step you can select the option if the assigned size in the dialog create control
recipe in the Recipe Editor is used as constant.
This has the effect that the amounts of the raw materials will multiply by the assigned size.

By the default setting will be the assigned size the sum of all raw material set points



In the next step you select the language in which the Batch application will be run. Following
languages will be supported: German, English, Sweden and French


Here you select the language settings of the PC.


60
CitectSCADA Installation and ASW Guide



In the last step following actions are possible.


With finish you complete the Advanced Batch Setup Wizard and save the settings.
With Cancel you quit the Advanced Batch Setup Wizard without any changes to the settings.


61
CitectSCADA Installation and ASW Guide



6 Project Change
6.1 Citect
Restore the required Project

Computer Setup Citect (custom)
Stand alone
project name
. all activated
activate events and transfer entry to events enabled if necessary

Compile the project

In the Citect INI File delete following entry before starting the Batch Engine:
[BatchInclude]
PathBatch=e:\Citect542\batch
PathBatchProject=e:\Citect542\User\BatchDemo has to be deleted

Configure Citect INI if necessary
Acrobat Reader ?
CTBRP Enable =?
CTBSUM Enable =?

6.2 Equipment or Recipe Editor
New Project with default.bak via RE or EE
Empty project

or Restore an existing project via RE or EE
existing project

CitectSCADA Batch ASW
change project

( or Via registry
HKEY_LOCAL_MACHINE/CTBE/REDDB/Catalog
HKEY_LOCAL_MACHINE/CTBRDBCI/ REDDB/Catalog)

6.3 Start
Start of the Citect project
Start of BE (eg. via the start function in the test page of the include project)




62
CitectSCADA Installation and ASW Guide



7 Glossary
CTBASW Citect Batch Advance Setup Wizard
CTBE Citect Batch Engine
CTBEE Citect Batch Equipment Editor
CTBRE Citect Batch Recipe Editor
CTBRDBG Citect Batch REDDB Gateway (former Red-DB-CT)
CTBREDDB Citect Batch REDDB (redundant database connection)
CTBRP Citect Batch Report
CTBS Citect Batch Scheduler
CTBSUM Citect Batch Summary (message report)
CTBV Citect Batch Viewer
CTBXG Citect Batch Xcom Gateway
XCOM Xcom2 module

You might also like