Automation Design Suite - Basics

Download as pdf or txt
Download as pdf or txt
You are on page 1of 176

Automation Design Suite

Basics

IM 33J10A10-01EN

IM 33J10A10-01EN
11th Edition
i

Introduction
This manual describes an overview and the basic functions of the Automation Design Suite. It
describes the functions that are common to the two engineering approaches of CENTUM VP:
module-based engineering and module-less engineering. So, read this manual regardless of
which approach you use.

11th Edition : Feb. 2021 (YK) IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


All Rights Reserved. Copyright © 2015, Yokogawa Electric Corporation
ii

Safety Precautions for Use


n Safety, Protection, and Modification of the Product
• To protect the system controlled by the Product and the Product itself and to ensure safe
operation, please observe the safety precautions described in this Manual. Yokogawa
Electric Corporation ("YOKOGAWA") assumes no liability for safety if users fail to observe
the safety precautions and instructions when operating the Product.
• If the Product is used in a manner not specified in the User's Manuals, the protection pro-
vided by the Product may be impaired.
• If any protection or safety circuit is required for the system controlled by the Product or for
the Product itself, please install it externally.
• Be sure to confirm the specifications and required settings of the devices that are used in
combination with the Product by referring to the instruction manual or other documents of
the devices.
• Use only spare parts that are approved by YOKOGAWA when replacing parts or consum-
ables of the Product.
• Do not use the Product and its accessories such as power cords on devices that are not
approved by YOKOGAWA. Do not use the Product and its accessories for any purpose
other than those intended by YOKOGAWA.
• Modification of the Product is strictly prohibited.
• The following symbols are used in the Product and User's Manuals to indicate the accom-
panying safety precautions:
Indicates that caution is required. This symbol for the Product indicates the possi-
bility of dangers such as electric shock on personnel and equipment, and also indi-
cates that the user must refer to the User’s Manuals for necessary actions. In the
User’s Manuals, this symbol is used together with a word “CAUTION” or “WARN-
ING” at the locations where precautions for avoiding dangers are described.
<French> Signale qu’il faut faire preuve de prudence. Ce symbole pour le produit
signale la possibilité d’un danger pour le personnel et l’équipement comme un
choc électrique, et signale également que l’utilisateur doit se référer au Manuel de
l’utilisateur afin de prendre les mesures nécessaires. Dans le Manuel de l’utilisa-
teur, ce symbole est utilisé conjointement avec la mention «CAUTION» ou
«WARNING» aux endroits où sont décrites les précautions pour éviter les
dangers.
Indicates that caution is required for hot surface. Note that the devices with this
symbol become hot. The risk of burn injury or some damages exists if the devices
are touched or contacted.
<French> Signale qu'il faut faire preuve de prudence avec la surface brûlante. Les
appareils sur lesquels est apposé ce symbole risquent de devenir brûlants. Tout
contact physique ou matériel avec ces appareils risque de provoquer des brûlures
ou des dommages.
Identifies a protective conductor terminal. Before using the Product, you must
ground the protective conductor terminal to avoid electric shock.
Identifies a functional grounding terminal. A terminal marked "FG" also has the
same function. This terminal is used for grounding other than protective grounding.
Before using the Product, you must ground this terminal.
Indicates an AC supply.
Indicates a DC supply.

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


iii
Indicates that a component such as a power supply switch is turned ON.

Indicates that a component such as a power supply switch is turned OFF.

n Notes on Handling User's Manuals


• Hand over the User's Manuals to your end users so that they can keep the User's Man-
uals on hand for convenient reference.
• Thoroughly read and understand the information in the User's Manuals before using the
Product.
• For the avoidance of doubt, the purpose of the User's Manuals is not to warrant that the
Product is suitable for any particular purpose but to describe the functional details of the
Product.
• Contents of the User's Manuals are subject to change without notice.
• Every effort has been made to ensure the accuracy of contents in the User's Manuals.
However, should you have any questions or find any errors, contact us or your local dis-
tributor. The User's Manuals with unordered or missing pages will be replaced.

n Warning and Disclaimer


• Except as specified in the warranty terms, YOKOGAWA shall not provide any warranty for
the Product.
• YOKOGAWA shall not be liable for any indirect or consequential loss incurred by either
using or not being able to use the Product.

n Notes on Software
• YOKOGAWA makes no warranties, either expressed or implied, with respect to the Soft-
ware Product's merchantability or suitability for any particular purpose, except as speci-
fied in the warranty terms.
• Purchase the appropriate number of licenses of the Software Product according to the
number of computers to be used.
• No copy of the Software Product may be made for any purpose other than backup; other-
wise, it is deemed as an infringement of YOKOGAWA's Intellectual Property rights.
• Keep the software medium of the Software Product in a safe place.
• No reverse engineering, reverse compiling, reverse assembling, or converting the Soft-
ware Product to human-readable format may be performed for the Software Product.
• No part of the Software Product may be transferred, converted, or sublet for use by any
third-party, without prior written consent from YOKOGAWA.

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


iv

Documentation Conventions
n Symbols
The following symbols are used in the User's Manuals.
Indicates precautions to avoid a danger that may lead to death or
WARNING severe injury.

Indicates precautions to avoid a danger that may lead to minor or


CAUTION moderate injury or property damage.

IMPORTANT Indicates important information required to understand operations or


functions.
Indicates additional information.

Indicates referenced content.


In online manuals, you can view the referenced content by clicking
the links that are in green text. However, this action does not apply
to the links that are in black text.

n Typographical Conventions
The following typographical conventions are used throughout the User's Manuals.

l Commonly Used Conventions throughout the User's Manuals


• Character string to be entered
The characters that must be entered are shown in monospace font as follows:
Example:
FIC100.SV=50.0
• ▼ Mark
This symbol indicates the description for an item for which you should make a setting in
the product's engineering window.
While operating an engineering window, the help information for the selected item can be
accessed from "Builder Definition Items" in the Help menu. Listing more than one defini-
tion item after this symbol implies that the paragraph on the page describes more than
one definition items.
Example:
▼ Tag Name, Station Name
• Δ Mark
Indicates that a space must be entered between character strings.
Example:
.ALΔPIC010Δ-SC
• Character string enclosed by braces { }
Indicates character strings that may be omitted.
Example:
.PRΔTAG{Δ.sheet name}

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


v

l Conventions Used to Show Key or Button Operations


• Characters enclosed by brackets [ ]
When characters are enclosed by brackets in the description of a key or button operation,
it indicates a key on the keyboard, a key on the operation keyboard, a button name in a
window, or an item in a list box displayed in a window.
Example:
To alter the function, press the [ESC] key.

l Conventions Used in Command Syntax or Program Statements


The following conventions are used within a command syntax or program statement format:
• Characters enclosed by angle brackets < >
Indicate character strings that user can specify freely according to certain guidelines.
Example:
#define <Identifier> <Character string>
• "..."
Indicates previous command or argument that may be repeated.
Example:
Imax (arg1, arg2, ...)
• Characters enclosed by brackets [ ]
Indicate character strings that may be omitted.
Example:
sysalarm <format character string> [, <output value>…]
• Characters enclosed by separators | |
Indicates character strings that can be selected from more than one option.
Example:
opeguide <format character string> [, <output value>...]
OG, <element number>

n Drawing Conventions
Drawings used in the User's Manuals may be partially emphasized, simplified, or omitted for
the convenience of description.
Drawings of windows may be slightly different from the actual screenshots with different set-
tings or fonts. The difference does not hamper the understanding of basic functionalities and
operation and monitoring tasks.

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


vi

Copyright and Trademark Notices


n All Rights Reserved
The copyright of the programs and online manuals contained in the software medium of the
Software Product shall remain with YOKOGAWA.
You are allowed to print the required pages of the online manuals for the purposes of using or
operating the Product; however, reprinting or reproducing the entire document is strictly pro-
hibited by the Copyright Law.
Except as stated above, no part of the online manuals may be reproduced, transferred, sold,
or distributed to a third party in any manner (either in electronic or written form including, with-
out limitation, in the forms of paper documents, electronic media, and transmission via the
network). Nor it may be registered or recorded in the media such as films without permission.

n Trademark Acknowledgements
• CENTUM, ProSafe, Vnet/IP, PRM, Exaopc, Exapilot, Exaquantum, Exasmoc, Exarqe,
Multivariable Optimizing Control/Robust Quality Estimation, StoryVIEW and FieldMate
Validator are the registered trademarks or trademarks of Yokogawa Electric Corporation.
• The names of corporations, organizations, products and logos herein are either regis-
tered trademarks or trademarks of Yokogawa Electric Corporation and their respective
holders.

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


TocA-1

Automation Design Suite Basics

IM 33J10A10-01EN 11th Edition

CONTENTS
PART-A Overview of Automation Design Suite.......... A-1
A1. What is AD Suite?.............................................................................. A1-1
A2. Overview of AD Suite functions....................................................... A2-1
A2.1 Basic functions.......................................................................................... A2-2
A2.2 Module-based engineering........................................................................A2-4
A2.3 Document generation................................................................................ A2-6
A2.4 Bulk editing.................................................................................................A2-7
A2.5 Tuning parameter management................................................................A2-8
A2.6 Dependency Analysis.............................................................................. A2-11
A2.7 Change management...............................................................................A2-12
A3. Examples of system configurations................................................ A3-1
A4. AD Suite capacity limits.................................................................... A4-1

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


Blank Page
TocB-1

Automation Design Suite Basics

IM 33J10A10-01EN 11th Edition

CONTENTS
PART-B Starting engineering........................................B-1
B1. How to start engineering when AD Suite is first introduced to the
system.................................................................................................B1-1
B1.1 Setting the ADMDB location..................................................................... B1-4
B1.2 Creating an AD project.............................................................................. B1-5
B1.3 Registering users in the AD project......................................................... B1-6
B1.4 Creating a VP project.................................................................................B1-8
B1.5 Registering a VP project in the AD project..............................................B1-9
B1.5.1 Managing VP projects................................................................ B1-11
B2. How to start engineering after upgrading the CENTUM VP software...
............................................................................................................. B2-1
B2.1 Upgrading the AD Server data.................................................................. B2-3
B2.2 Upgrading AD projects.............................................................................. B2-4
B2.3 Upgrading VP projects.............................................................................. B2-6

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


Blank Page
TocC-1

Automation Design Suite Basics

IM 33J10A10-01EN 11th Edition

CONTENTS
PART-C Basic functions................................................C-1
C1. Managing AD Server and AD projects............................................. C1-1
C1.1 Overview of AD Server and AD project management.............................C1-2
C1.1.1 Setting the AD Server options..................................................... C1-4
C1.1.2 Backing up and restoring the ADMDB......................................... C1-5
C1.1.3 Viewing the history of backup and export operations.................. C1-8
C1.1.4 Creating and deleting AD projects............................................... C1-9
C1.1.5 Modifying AD project properties.................................................C1-10
C1.1.6 Controlling access to AD projects.............................................. C1-11
C1.1.7 Exporting and importing AD projects......................................... C1-21
C1.1.8 Prohibiting and permitting AD project data modifications.......... C1-24
C1.1.9 Forcibly canceling the checked-out status of currently checked out
files............................................................................................ C1-25
C1.2 Managing the AD Server..........................................................................C1-26
C1.2.1 Setting the ADMDB location...................................................... C1-27
C1.2.2 Changing the AD Server option settings....................................C1-30
C1.2.3 Backing up the ADMDB............................................................. C1-31
C1.2.4 Restoring the backed-up ADMDB..............................................C1-32
C1.2.5 Viewing the history of backup and export operations................ C1-34
C1.3 Managing AD projects............................................................................. C1-35
C1.3.1 Creating an AD project.............................................................. C1-36
C1.3.2 Deleting an AD project...............................................................C1-37
C1.3.3 Modifying AD project properties.................................................C1-38
C1.3.4 Exporting AD projects................................................................ C1-39
C1.3.5 Importing AD projects................................................................ C1-40
C1.3.6 Prohibiting or canceling the prohibition of AD project data
modifications..............................................................................C1-41
C1.3.7 Forcibly canceling the checked-out status of currently checked out
files............................................................................................ C1-42
C1.4 Setting user security for AD projects.....................................................C1-43
C1.4.1 Defining customizable user roles...............................................C1-46
C1.4.2 Defining access scopes............................................................. C1-47
C1.4.3 Setting security for Windows users............................................C1-48

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


TocC-2
C1.5 Notes on concurrent use of access control for AD projects and Access
Administrator Package (FDA : 21 CFR Part 11 compliant) or Access
Control Package for VP projects............................................................ C1-49
C2. History management......................................................................... C2-1
C2.1 Overview of history management.............................................................C2-2
C2.2 Starting AD Organizer................................................................................C2-3
C2.3 Setting labels..............................................................................................C2-4
C2.4 Displaying the revision history and labels.............................................. C2-5
C2.4.1 Displaying the Revision History window...................................... C2-6
C2.4.2 Displaying Change Set details.....................................................C2-9
C2.4.3 Displaying a list view and detail view of files..............................C2-11
C2.4.4 Displaying label details.............................................................. C2-12
C2.4.5 Associating ModPacks with Change Sets................................. C2-14
C2.4.6 Comparing the details of engineering data................................ C2-16
C2.5 Managing the revision history of VP projects....................................... C2-18
C2.6 Operations and the files used in revision history management..........C2-20
C2.6.1 Operations that update the files in AD Organizer...................... C2-21
C2.6.2 Operations that update the files in System View....................... C2-22
C2.6.3 Operations that update VP builder files..................................... C2-38
C2.6.4 VP generation............................................................................ C2-44
C2.6.5 Running the Revision History Utility...........................................C2-45
C2.6.6 Labels for operations not accompanied by file modification...... C2-46

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


TocApp.-1

Automation Design Suite Basics

IM 33J10A10-01EN 11th Edition

CONTENTS
Appendix
Appendix 1. Error Codes..................................................................... App.1-1

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


Blank Page
<A. Overview of Automation Design Suite> A-1

A. Overview of Automation Design


Suite
This section provides an overview of the Automation Design Suite (AD Suite).

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


Blank Page
<A1. What is AD Suite?> A1-1

A1. What is AD Suite?


AD Suite is an engineering environment that is designed for developing and maintaining an
entire instrumentation system.
AD Suite provides a new engineering method while continuing to support the engineering pro-
cesses that have been used in CENTUM VP R5 and earlier versions.

n Engineering methods that are provided by AD Suite


AD Suite provides the following engineering methods:
• Module-based engineering
• Module-less engineering
These two engineering methods are very different, but only for FCS engineering. For stations
other than FCS, there is no difference between the two methods.
You decide which engineering method to use when creating a new FCS. After an FCS is cre-
ated, the engineering method is fixed and cannot be changed.

l Module-based engineering
Module-based engineering is an engineering method introduced in CENTUM VP R6 that ena-
bles you to develop control applications in modular units. A module stores not only control
logic but also design information, alarm attributes, and attached documents. Using module-
based engineering, you can perform CENTUM VP engineering and also store engineering de-
sign information and documentation of engineering results.
With module-based engineering, you can also work on the following engineering phases si-
multaneously:
• Design for I/O
• Design for control application
• Design for station configuration
Thus, you can start designing for control application or designing for I/O before the design of
the station configuration is finished. You also have the flexibility to change the I/O design after
designing the control application.
Module-based engineering is available on FCSs that meet the following conditions:
• FCS type is FFCS-C, FFCS-V, or FFCS-R
• FCS is newly created using R6 or later
TIP The Module-based Engineering Package is required to perform module-based engineering.

However, even if you adopt module-based engineering, you perform engineering for the fol-
lowing stations and part of FCS functionality based on the hardware configuration in the same
way as CENTUM VP R5 and earlier versions:
• FCS common section
• HIS, UGS, SIOS, GSGW, and BCV
SEE
ALSO For more information about FCS category, refer to:
A1.1, “FCS Types” in Field Control Stations Reference (IM 33J15A10-01EN)

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<A1. What is AD Suite?> A1-2

l Module-less engineering
Module-less engineering is an engineering method that develops control applications without
modules. It is supported by CENTUM VP R5 and earlier versions.
Module-less engineering is also an engineering method that you perform engineering on each
hardware element after the hardware configuration is fixed.
You need to use this engineering method for FCSs where module-based engineering is not
applicable. However, you can also continue to use module-less engineering on FCSs that are
eligible for module-based engineering as well.

n Structure of AD Suite
The following figure shows the structure of AD Suite.

AD Suite

System builders Automation Design Server

Automation Design Automation Design Suite


Organizer Administration Tool

VP builders Automation Design


Master Database

Figure A1-1 Structure of AD Suite

l System builders
System builders are used for performing CENTUM VP engineering.
• Automation Design Organizer
Automation Design Organizer (AD Organizer) is the engineering tool that provides the
central function of module-based engineering. The major engineering functions for the
FCS are performed by this tool.

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<A1. What is AD Suite?> A1-3

Figure A1-2 AD Organizer

• VP builders
VP builders refer to the group of engineering tools that provide the central function of
module-less engineering. VP builders comprise System View, Recipe View, and the build-
ers that are launched by them.
This group of engineering software tools is used for the stations other than FCSs, and for
system configuration settings even when you choose module-based engineering.

Figure A1-3 System View

l Automation Design Server


Automation Design Server (AD Server) is a data server that manages the engineering data.

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<A1. What is AD Suite?> A1-4
• Automation Design Master Database
Automation Design Master Database (ADMDB) is the database that stores all of the engi-
neering data. It provides a history management function for the engineering data.
• Automation Design Server Administration Tool
Automation Design Server Administration Tool (ADS Administration Tool) is a tool for
managing AD Servers.

Figure A1-4 ADS Administration Tool

n Engineering data that is edited by the system builders


Engineering data that is edited by the system builders is stored in the following projects:
• Automation Design project
An Automation Design project (AD project) stores the engineering data that is edited by
AD Organizer. AD projects are created in the ADMDB on the AD Server. Multiple AD proj-
ects can be created in the ADMDB.
• VP project
A VP project stores the engineering data that is edited by VP builders. A VP project is
created on a computer with system builders or a file server. A VP project becomes availa-
ble for use only after it is registered in an AD project.
TIP You can register multiple VP projects in an AD project.

The following figure shows an outline of the data flow between AD Organizer, VP builders, AD
projects, and VP projects.

AD Organizer VP builders

Displays and stores Displays and stores


the engineering data the engineering data

Stores revision
AD project history
in which the VP VP project
project is registered

Figure A1-5 Flow of engineering data

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<A1. What is AD Suite?> A1-5
As indicated, the engineering data from AD Organizer is stored in the AD project, and the en-
gineering data from VP builders is stored in the VP project. The revision history of the VP
project is stored in the AD project in which the VP project is registered.

l Behavior of VP builders when the system builder function fails to connect


to the AD Server
VP projects are connected to the AD projects on the AD Server through VP builders, which
are part of the system builders. Because of this, the system builders must be connected to the
AD Server when they are used. If a system builder fails to connect to the AD Server, the VP
builders behave as follows:
• System View can start, but the builders that are called up from System View will start in
reference-only mode.
• Any actions that make changes to engineering data, such as creating nodes and I/O
modules, running generation, and downloading configuration data, are disabled.
However, the operation and monitoring functions are available as normal even when the sys-
tem builders are unable to connect to the AD Server.

n Terms
The following table shows terms that are used in AD Suite.

Table A1-1 Terms for AD Suite


No. Term Description
1 Automation Design Suite Indicates the entire engineering environment of CENTUM
(AD Suite) VP R6.
2 Automation Design Organizer An engineering tool that is the central function of module-
(AD Organizer) based engineering.
3 Automation Design Server The feature that manages the engineering data of the AD
(AD Server) Suite.
4 Automation Design Master Database A database that saves the engineering data and history of
(ADMDB) AD Suite. ADMDB is stored on the AD server.
5 Automation Design project A collection of engineering data. In the AD Suite, the engi-
(AD project) neering data is managed separately for each AD project.
6 Automation Design Server Administration A tool for managing AD Server.
Tool
(ADS Administration Tool)
7 VP builders A generic term for System View, Recipe View, and the
builders that are launched by them.
8 VP project A collection of engineering data that is edited by VP build-
ers and data that is converted as a result of VP generation.
9 System builders These builders perform the CENTUM VP engineering.
10 Module-based engineering An engineering method that performs FCS engineering by
using the module as unit.
11 Module-less engineering An engineering method that performs engineering based on
the hardware configuration, not as a module unit.
12 History management A function that manages the revision history of engineering
data.
13 Change management A function that supports managing the process of modifying
engineering data.
14 Process I/O list An I/O list defined in module-based engineering. Defines
analog I/O, discrete I/O, FOUNDATION fieldbus I/O, and
HART I/O. Defines data for each I/O point.
Continues on the next page

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<A1. What is AD Suite?> A1-6
Table A1-1 Terms for AD Suite (Table continued)
No. Term Description
15 Communication I/O list An I/O list defined in module-based engineering.
Defines Ethernet communication I/O RS communication
I/O, field wireless I/O, PROFIBUS I/O, PROFINET I/O, and
turbomachinery I/O.
Defines data for each I/O point.
16 IOM Definition A definition for I/O modules that is defined in module-based
engineering.
17 Class module, Application module Module-based engineering manages a control application
that contains multiple function blocks and I/Os as a module.
The module can store not only control logic but also design
information, alarm attributes, and attached documents.
A class module is a template for an application module.
An application module is a module that stores control appli-
cations that are activated in FCS.
There are two types of application modules: class-based
application modules that are created from a class module,
and class-less application modules that are created directly.
18 Instantiate To create an application module by assigning I/O points or
tag names to the template class module. You can create
multiple application modules from one class module.
19 Drawing module A module to which you can assign single or multiple appli-
cation modules. One or more drawing modules are pre-
pared for each FCS and mediates between application
modules and control drawings that are created by System
View. The drawing module is converted to control drawings
by VP generation.
20 Module binding A function that assigns application modules to a drawing
module.
21 Module group A group that binds multiple application modules. The appli-
cation modules that are bound in this group are assigned to
the same drawing module when the module binding runs.
22 VP generation A function that converts a set of engineering data in the AD
Organizer to engineering data in the VP project.

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<A2. Overview of AD Suite functions> A2-1

A2. Overview of AD Suite functions


This section provides an overview of the functions available in the AD suite.
These are the AD suite functions:
• Basic functions
• Module-based engineering
• Document generation
• Bulk editing
• Tuning parameter management
• Dependency Analysis
• Change management

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<A2.1 Basic functions > A2-2

A2.1 Basic functions


This section gives an overview of the basic function of AD Suite.
You can use these basic functions of AD Suite in CENTUM VP R6.01 and later versions.
The following list shows the basic functions:
• Module-less engineering
• History management
• Management of AD server and AD project
The following figure shows an outline of the basic functions.
System builders

AD Organizer VP builders
Edits module-less
Displays revision engineering data
history

Reads revision Displays and stores


history data Stores revision the engineering data
history
ADS Administration Tool
History
management VP project

AD project
Manages AD Servers
Downloading
and AD projects

AD Server
Station

Figure A2.1-1 Basic functions

n Module-less engineering
When you use module-less engineering, you perform all engineering by using VP builders.
The engineering data that is edited by VP builders is stored in the VP project.
SEE
ALSO For more information about module-less engineering, refer to:
2., “System Configuration” in Engineering Reference Vol.1 (IM 33J10D10-01EN)

n History management
History management stores the revision history of VP projects. Whenever a file in a VP proj-
ect is updated, the revision history is automatically stored in the history management data-
base in the AD Server. The revision history that is stored in the history management database
can be displayed in AD Organizer.
SEE
ALSO For more information about history management, refer to:
C2., “History management” on page C2-1

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<A2.1 Basic functions > A2-3

n Management of AD Server and AD projects


You can manage AD Server and AD projects by using the ADS Administration Tool.
SEE
ALSO For more information about management of AD server and AD project, refer to:
C1., “Managing AD Server and AD projects” on page C1-1

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<A2.2 Module-based engineering > A2-4

A2.2 Module-based engineering


This section gives an overview of the module-based engineering function.
The following figure shows an outline of module-based engineering.
AD Organizer VP builders
Edits engineering data
Edits engineering Displays concerning station
data of I/O and control revision history configuration and stations
application

Displays and stores Reads revision Displays and stores


the engineering data history data the engineering data
Converts
collectively
History
management VP project
Stores
AD project revision history

Downloading

Station

Figure A2.2-1 Module-based engineering

The module-based Engineering Package needs to be installed in order to use module-based


engineering.
SEE
ALSO For more information about module-based engineering, refer to:
• A., “Overview of module-based engineering” in Automation Design Suite Module-based Engineer-
ing Vol.1 (IM 33J10A15-01EN)
• B., “Basic operations of AD Organizer” in Automation Design Suite Module-based Engineering Vol.1
(IM 33J10A15-01EN)

n Engineering tools for module-based engineering


In module-based engineering, you perform engineering by using AD Organizer and VP build-
ers.
The AD Organizer handles engineering of I/O and control applications in FCS.
The VP builders handle the following engineering:
• Station configuration and VP project common items
• Engineering of FCS except for I/O and control application
• Engineering of all of HIS, UGS, SIOS, GSGW, and BCV
When engineering using VP builders, you decide the station configuration first, the same as in
module-less engineering, and then you perform engineering on stations after that.

n Engineering data flow of module-based engineering


The engineering data that is edited by VP builders is stored in the VP project.

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<A2.2 Module-based engineering > A2-5
The engineering data of I/O and control applications that are handled by AD Organizer is stor-
ed in the AD project. Therefore, you can design for I/O and control applications independently
from station configuration.
The I/O and control application engineering data that is edited independently from the station
configuration is eventually assigned to FCS, converted collectively to the engineering data for
the VP project, and stored in the VP project.

n History management for module-based engineering


The revision history for the engineering data that was edited using AD Organizer is stored in
the history management database in the AD Server. Similarly, for the engineering data for a
VP project, all of the following revision history data is stored in the history management data-
base of the AD Server.
• Engineering data that is edited by VP builders
• Engineering data that is edited by AD Organizer and converted collectively
The revision history that is stored in the history management database can be displayed in
AD Organizer.

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<A2.3 Document generation > A2-6

A2.3 Document generation


This section gives an overview of the document generation function.
The document generation function creates documents that compile engineering results. Docu-
ment generation is available when you use module-based engineering.
The module-based Engineering Package needs to be installed in order to use document gen-
eration.
The following figure shows an outline of the document generation.
AD Organizer

Creates user-defined template


Sets document layout
Document generation

Displays and stores the data

History
management

AD project

Figure A2.3-1 Document generation

The document generation process consists of the following tasks:


• Creating a user-defined template
You can define the format of the document as a user-defined template. If you use the sys-
tem template which AD suite provides, this task is not required.
• Setting the document layout
You can arrange the contents and define the table of contents. Contents can consist of
any of the following information:
• Design information for the module
• Engineering results
• User text
• Generating a Word file
The document is created as a Word file with a ".docx" extension from the template and
the document layout settings.
All these operations are performed by using AD Organizer and the edited data is stored in the
AD project.
TIP When user utilizes any shape on Word Document as Design Information, it is necessary to select the [In Line
with text] of Layout Option.
Otherwise, it might be possible for its location to be shifted on the generated document.

SEE
ALSO For more information about document generation, refer to:
C3., “Generate documents” in Automation Design Suite Module-based Engineering Vol.2 (IM
33J10A16-01EN)

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<A2.4 Bulk editing > A2-7

A2.4 Bulk editing


This section gives an overview of the bulk editing function.
Module-based engineering can be done without using bulk editing, but using bulk editing
makes module-based engineering more efficient.
Both the Module-based Engineering Package and the Bulk Editing Package (for Module-
based Engineering) need to be installed for you to be able to use bulk editing.
The following figure shows an outline of bulk editing.
AD Organizer

Bulk engineering on mass editor


Bulk engineering with grid rule

Displays and stores


the engineering data

History
management

AD project

Figure A2.4-1 Bulk editing

Bulk editing provides the following functions:


• Bulk engineering in a mass editor
You can edit the parameters of multiple function blocks in table format in the mass edi-
tors. Bulk engineering is performed by setting the parameters for multiple function blocks
together in table format.
• Bulk engineering using grid rules
You can set up simple programs as rules in order to automatically set parameter lists in
table format. Bulk engineering is executed by setting and activating the rules.
SEE
ALSO For more information about the mass editors, refer to:
C1., “Edit control logic, alarm attributes, and generic names of unit instrument blocks in the table format”
in Automation Design Suite Module-based Engineering Vol.2 (IM 33J10A16-01EN)
For more information about grid rules, refer to:
C2., “Define a grid rule” in Automation Design Suite Module-based Engineering Vol.2 (IM
33J10A16-01EN)

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<A2.5 Tuning parameter management > A2-8

A2.5 Tuning parameter management


This section gives an overview of the tuning parameter management function.
Tuning parameter management provides functions for setting the design values of tuning pa-
rameters in a module, and for setting those values in the FCS.
Tuning parameter management is available when you use module-based engineering.
Both the Module-based Engineering Package and the Tuning Parameter Management Pack-
age (for Module-based Engineering) need to be installed in order to use tuning parameter
management. The Operation and Monitoring function also needs to be installed if you want to
compare and set the design value and the current values of the tuning parameters.
Tuning parameter management provides the following functions:
• Defining design values for tuning parameters
You can define design values for the tuning parameters in the class module and applica-
tion modules.
The following figure shows an outline of defining design values for tuning parameters.
AD Organizer
Defines design values
for tuning parameter

Displays and stores


the engineering data

History
management

AD project

Figure A2.5-1 Defining design values for tuning parameters

Using this function, you can define the design values of tuning parameters that are used
for control. If you want to define the design values for the tuning parameters related to
alarms used in UACS or CAMS for HIS, define them as alarm attributes in module-based
engineering.
TIP The design values for the tuning parameters that are defined in the alarm attributes in module-based engi-
neering are collectively converted into files that are used for UACS alarms and CAMS for HIS alarms.

• Collective setting of the tuning parameters


With the Set All Tuning Parameter Tool, in one action you can set in the FCS all of the
tuning parameter design values that are set in the application modules.
The following figure shows an outline of the collective setting of tuning parameters.

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<A2.5 Tuning parameter management > A2-9
Computer with AD server

Ethernet

Set All Tuning Computer with HIS


Parameter Tool system builders

Sets design values


of tuning parameters
Control bus

FCS

Figure A2.5-2 Collective setting of the tuning parameters

TIP You can use this function to set all the following tuning parameters on FCS.
• Tuning parameters that are handled in defining design values for the tuning parameters
• Tuning parameters that are handled in defining alarm attributes

• Comparing and reflecting the design value and the current value of the tuning parameters
Using the Tuning Parameter Comparison Tool, you can compare the design values of the
tuning parameters that are set in the application module and the current values of the tun-
ing parameters in FCS. If necessary, you can set the design values of the tuning parame-
ters into the FCS or set the current values of the tuning parameters into the application
module as the design values.
The following figure shows an outline of comparing and setting the design value and the
current value of the tuning parameters.
Computer with AD server

Ethernet

Tuning Parameter HIS with system builders HIS


Comparison Tool

Sets design values


of tuning parameter
Control bus

Retrieves current values


of tuning parameter
FCS

Figure A2.5-3 Comparing and setting the design values and the current values of the tuning parame-
ters

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<A2.5 Tuning parameter management > A2-10
TIP You can use this function to compare and set all of the following tuning parameters:
• Tuning parameters that are handled in defining design values for the tuning parameters
• Tuning parameters that are handled in defining alarm attributes

SEE
ALSO For more information about tuning parameter management, refer to:
C4., “Manage the tuning parameters” in Automation Design Suite Module-based Engineering Vol.2 (IM
33J10A16-01EN)
For more information about defining alarm attributes in module-based engineering, refer to:
D2.5.5, “Define alarm attributes for a class module” in Automation Design Suite Module-based Engineer-
ing Vol.1 (IM 33J10A15-01EN)
For more information about the computer with AD Server, computer with system builders, and HIS with sys-
tem builders, refer to:
A3., “Examples of system configurations” on page A3-1

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<A2.6 Dependency Analysis > A2-11

A2.6 Dependency Analysis


This section gives an overview of the Dependency Analysis function.
With this function, you can analyze the dependencies of control logic, I/O, and graphics,
based on keywords that you specify. Dependency Analysis is available for both module-based
engineering and module-less engineering.
In order to use Dependency Analysis, the Dependency Analysis Package must be activated.
The following figure shows an outline of Dependency Analysis.
Dependency Analyzer
Displays dependency
by using keyword

Reads dependency
analysis data

Dependency Analysis
Dependency History
analysis data management

AD project

Figure A2.6-1 Dependency Analysis

The latest data of the VP project that is saved in the history management database is conver-
ted to Dependency Analysis data in the AD project.
You can view the dependency analysis data in the AD project by using the Dependency Ana-
lyzer.
SEE
ALSO For more information about Dependency Analysis, refer to:
A., “Analyzing dependencies” in Automation Design Suite Optional Functions (IM 33J10A20-01EN)

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<A2.7 Change management > A2-12

A2.7 Change management


This section gives an overview of the change management function.
Change management controls the process of modifying engineering data. The modification
process is managed by editing a ModPack (Modification Package), which records the activi-
ties of implementing the change. Change management is available both for module-based en-
gineering and module-less engineering.
The Change Management Package must be activated in order to use Change management.
The following figure shows an outline of change management.
AD Organizer
Edits ModPack

Displays and stores ModPack

History
management

AD project

Figure A2.7-1 Change management

The following list shows the steps for using change management:
1. Register a modification request in a ModPack.
2. Analyze the impact of the modification, and enter the modification location on the Mod-
Pack.
3. Assign the person in charge of the modification to the ModPack.
4. Modify the engineering data and register the revision history in the ModPack.
5. Test the modification and record the test results in the ModPack.
6. Make a final check of the modification and record the result in the ModPack.
SEE
ALSO For more information about change management, refer to:
B., “Change management” in Automation Design Suite Optional Functions (IM 33J10A20-01EN)

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<A3. Examples of system configurations> A3-1

A3. Examples of system configurations


This section shows examples of the system configurations in CENTUM VP including AD
Suite.

n Minimum system configuration example


The following figure shows an example of the minimum system configuration.
HIS with AD Server
and system builders

Control bus

FCS

Figure A3-1 Example of the minimum system configuration

The HIS with AD server and system builders has the following functions installed.
• AD Server
• System builders
• Operation and monitoring function

n Example of a medium or large scale system configuration


The following figure shows an example of a medium or large scale system configuration.
Computer with AD Server

Ethernet

Computer with HIS with HIS HIS


system builders system builders

Control bus

FCS FCS

Figure A3-2 Example of a medium or large scale system configuration

In this sample configuration, the following functions are installed separately, each on a differ-
ent computer.
• AD Server: A computer with AD Server
• System builders: A computer with system builders

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<A3. Examples of system configurations> A3-2
• Operation and monitoring function: HIS
You can also use an HIS with system builders that is a single computer with both system
builders and the operation and monitoring functions.
As indicated, you can perform concurrent engineering by using a computer with system build-
ers or multiple HISs with system builders. You need one computer with AD Server for each
system.

n Example of a system configuration that manages multiple VP


projects
The following figure shows an example of a system configuration in which a single computer
with AD Server manages multiple VP projects.

IMPORTANT
The security model of each CENTUM VP system that is connected to the single AD Server
must be the same.

Computer with AD Server

Ethernet

HIS with HIS HIS HIS with HIS HIS


system system
builders builders

Control bus Control bus

FCS FCS FCS FCS

VP project-A VP project-B

Figure A3-3 Example of a system configuration that manages multiple VP projects

In this case, you perform engineering on VP project-A by using an HIS with system builders
that belongs to VP project-A. You cannot perform engineering on VP project-B by using any of
the HISs with system builders that belong to VP project-A, nor vice versa.
Also, you can manage multiple VP projects that are connected to each other by using a single
computer with AD Server.
SEE
ALSO For more information about project connection, refer to:
6., “Multiple Project Connection” in Optional Functions Reference (IM 33J05H10-01EN)

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<A4. AD Suite capacity limits> A4-1

A4. AD Suite capacity limits


The following tables show capacity limitations for AD Suite applications.

Table A4-1 AD Server capacity limits


Item Maximum
Total number of computers and HISs with system builders 100
Number of AD projects 16

Table A4-2 AD project capacity limits


Item Maximum
Number of registered VP projects 32
Number of Windows users or Windows user groups that can be registered for access 500
control.
Number of custom user roles that can be registered for access control 500
Number of access scopes that can be registered for access control 500

SEE
ALSO For more information about access control to AD projects, refer to:
C1.4, “Setting user security for AD projects” on page C1-43

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


Blank Page
<B. Starting engineering> B-1

B. Starting engineering
This section explains the starting procedures for performing module-based engineering and
module-less engineering.

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


Blank Page
<B1. How to start engineering when AD Suite is first introduced to the system > B1-1

B1. How to start engineering when AD


Suite is first introduced to the
system
To start engineering with AD Suite when CENTUM VP is newly installed or when an existing
CENTUM VP system is upgraded from R5 or earlier versions, an AD project and VP project
must be set up.
This section describes how to start engineering with a new installation of CENTUM VP, or ver-
sion upgrade from R5 or earlier.

n Overview
The following figure shows the procedures for starting engineering.

Start

Set the location of ADMDB

Create an AD project

Register users in the AD project

Create a VP project

Register the VP project in the AD project

Start module-based engineering Start module-less engineering

Figure B1-1 Procedures for starting engineering

TIP If you already have a VP project that has been upgraded from CENTUM VP R5 or earlier, you do not need to
create another VP project.

SEE
ALSO For more information about module-based engineering, refer to:
A., “Overview of module-based engineering” in Automation Design Suite Module-based Engineering
Vol.1 (IM 33J10A15-01EN)
For more information about module-less engineering, refer to:
2., “System Configuration” in Engineering Reference Vol.1 (IM 33J10D10-01EN)

n Items that need to be decided before starting engineering


In the procedure for starting the engineering, you are required to decide the following items in
advance:

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<B1. How to start engineering when AD Suite is first introduced to the system > B1-2
• The location for the ADMDB
• The project name and comments of the AD project
• The project name and attributes of the VP project
• Windows users and user groups that will have access to the AD project
TIP If you already have a VP project that has been upgraded from CENTUM VP R5 or earlier, you do not need to
decide the project name nor the attributes for the VP project.

SEE
ALSO For more information about restriction on the length of the project name and comments of AD projects, refer
to:
“n Creating an AD project” on page C1-9
For more information about the project name and attributes of the VP project, refer to:
2.2, “Creating a New Project” in Engineering Reference Vol.1 (IM 33J10D10-01EN)
For more information about Windows users and user groups that will have access to the AD project, refer to:
C1.1.6, “Controlling access to AD projects” on page C1-11

n Access rights for use of ADS Administration Tool


To be able to use the ADS Administration Tool in engineering, access rights are required ac-
cording to the IT security model. If the IT security model is the Standard model or the
Strengthened model, log on to a computer with AD Server by using an account that belongs
to either of the following groups:
• ADS_MANAGER group
• ADS_MANAGER_LCL group
The ADS Administration Tool has the function to back up VP projects at the same time as
when you back up the ADMDB or export an AD project. To activate this function, you must log
on to a computer with AD Server by using an account that belongs to the following groups:
• ADS_MANAGER group or ADS_MANAGER_LCL group
• CTM_MAINTENANCE

n Setting before starting engineering


Before starting engineering, you must activate the VP project backup function. Start the ADS
Administration Tool and, in the following Activation Setting for System Project Backup Func-
tion dialog box that appears, click [Activate].

Figure B1-2 Activation Setting for System Project Backup Function dialog box

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<B1. How to start engineering when AD Suite is first introduced to the system > B1-3
SEE
ALSO For more information about the function to back up VP projects at the same time as backing up the ADMDB
or exporting an AD project, refer to:
• C1.1.2, “Backing up and restoring the ADMDB” on page C1-5
• C1.1.7, “Exporting and importing AD projects” on page C1-21

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<B1.1 Setting the ADMDB location > B1-4

B1.1 Setting the ADMDB location


You can specify a folder where the ADMDB is to be placed. To perform this task, use the ADS
Administration Tool on the computer with AD Server.

n Setting the location of ADMDB for the first time


Follow these steps to set the location of ADMDB for the first time:
1. Log on to the computer with AD Server. If the IT security model is the Standard model or
Strengthened model, log on as a member of the ADS_MANAGER or ADS_MANAG-
ER_LCL group.
2. Start the ADS Administration Tool.
3. Set the location of the ADMDB.
SEE
ALSO For more information about how to set the location of the ADMDB, refer to:
C1.2.1, “Setting the ADMDB location” on page C1-27

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<B1.2 Creating an AD project> B1-5

B1.2 Creating an AD project


To perform this task use the ADS Administration Tool on the computer with AD server.

n Creating a new AD project


Follow these steps to create an AD project:
1. Log on to the computer with AD Server. If the IT security model is the Standard model or
Strengthened model, log on as a member of the ADS_MANAGER or ADS_MANAG-
ER_LCL group.
2. Start the ADS Administration Tool.
3. Create a new AD project.
SEE
ALSO For more information about creating an AD project, refer to:
C1.3, “Managing AD projects” on page C1-35

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<B1.3 Registering users in the AD project> B1-6

B1.3 Registering users in the AD project


In AD Suite, the access by users who perform engineering on CENTUM VP is controlled for
each AD project.
This section describes how to register Windows users or user groups for the AD project.
To perform this task, you use the ADS Administration Tool on the computer with AD server.

n Registering an engineering user and configuring access control for


the user
Follow these steps to register a user and configure the access control for the user:
1. Use the ADS Administration Tool to register a user or a user group for engineering in the
AD project.
2. Configure access control for the user or user group that you have registered.
TIP Register a user with at least access rights to add VP projects. Users whose User Role is VP Lead Engineer
or VP Engineer have the access rights to add VP projects.

SEE
ALSO For more information about registering users and configuring access control, refer to:
C1.4.3, “Setting security for Windows users” on page C1-48

l Configuring access control for an AD project


In addition to access control for AD projects, the following types of access control is available
in CENTUM VP engineering:
• Access control through IT security settings
• Access control for FDA:21 CFR Part 11 compliance
TIP The access control for FDA:21 CFR Part 11 compliance includes access control that is provided in the Access
Control Package.

These three access controls are independent from one another. Users who log on need to be
granted access permission in all of these access controls in order to be able to perform engi-
neering on CENTUM VP.
Configure access control for the AD project depending on the following conditions:
• When not configuring access control for the AD project:
When you configure access control for IT security and FDA:21 CFR Part 11 compliance
but not for AD project:
In this case, give all Windows users who log on to the computer with system builders per-
mission for reading, writing, adding, and deleting as their access control for the AD proj-
ect.
TIP You should also configure access control in this way if you use CENTUM authentication mode, because in
that case AD project access control is not performed.

• When not configuring access control for FDA:21 CFR Part 11 compliance:
When you configure access control for the AD project and IT security, but not for FDA:21
CFR Part 11 compliance:
In this case, grant appropriate access permissions for each Windows user for the AD
project.

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<B1.3 Registering users in the AD project> B1-7
• When configuring all of the access controls:
When you configure access control for IT security, FDA:21 CFR Part 11 compliance, and
AD project:
In this case, grant the same access permissions for the AD project as you grant for ac-
cess control for FDA:21 CFR Part 11 compliance.
TIP When creating a new VP project, configure the access control for FDA:21 CFR Part 11 compliance after the
VP project is created.
If the VP project is upgraded from CENTUM VP R5 or earlier, grant the same access permissions to the AD
project as you already granted for access control for FDA:21 CFR Part 11 compliance.

SEE
ALSO For more information about precautions on using the access control for FDA:21 CFR Part 11 compliance and
access control for AD projects together, refer to:
C1.5, “Notes on concurrent use of access control for AD projects and Access Administrator Package
(FDA : 21 CFR Part 11 compliant) or Access Control Package for VP projects” on page C1-49

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<B1.4 Creating a VP project> B1-8

B1.4 Creating a VP project


To perform this task, use System View on the computer with system builders.
TIP • This task is unnecessary if you have a VP project that is already registered in System View, such as
when you have upgraded the system from CENTUM VP R5 or earlier. In that case, start System View.
The VP project is upgraded when you start System View.
• If you have a VP project that is not yet registered in System View, such as a VP project from CENTUM
VP R5 or earlier, register the VP project in System View and do not perform this task. The VP project is
upgraded when you start System View.

SEE
ALSO For more information about registering a VP project in System View, refer to:
“■ Registering a Project” in 2.3, “Project's Attribution Utility” in Engineering Reference Vol.1 (IM
33J10D10-01EN)

n Creating a VP project
Follow these steps to create a VP project:
1. Start System View.
2. Create a VP project.
TIP Dialog boxes for creating an HIS or FCS appear while you are creating the VP project. If you want to use
module-based engineering, configure the settings for module-based engineering when the new FCS is cre-
ated. However, you cannot change the engineering method after the FCS is created.

SEE
ALSO For more information about creating an VP project, refer to:
2., “System Configuration” in Engineering Reference Vol.1 (IM 33J10D10-01EN)
For more information about settings for module-based engineering when creating a new FCS, refer to:
“● Add FCS that is a target of module-based engineering” in “■ For FCS that is a target of module-based
engineering” in E3., “Add or delete project devices of the VP project” in Automation Design Suite Mod-
ule-based Engineering Vol.1 (IM 33J10A15-01EN)

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<B1.5 Registering a VP project in the AD project> B1-9

B1.5 Registering a VP project in the AD project


To perform this task, use AD Organizer on the computer with system builders.
If you have multiple computers with system builders, you should perform this task by using the
computer that has the VP project in its own hard disk.
If the VP project exists on a file server and none of computers with system builders has the
VP project on its own hard disk, you can perform the task on any of the computers with sys-
tem builders.
When you perform this task, the registration of the VP project is accepted in the other comput-
ers with system builders.
TIP Even if the VP project folder has been specified with a local path in System View, the VP project folder will be
registered in the AD project with a network path.
If the VP project folder cannot be specified with a network path, such as the case when the VP project is
placed in a folder other than <CENTUM VP installation folder>\eng\BKProject, an error will result. In this
case, configure the folder that contains the VP project folder as a share folder before performing this task.

n Starting AD Organizer
Follow these steps to start AD Organizer:
1. Log on as a user who has the access rights to add VP projects.
2. Start AD Organizer.
When AD Organizer is started for the first time, the Select AD Project dialog box appears.
3. Select the computer name or IP address of the computer with AD server, and click [Con-
nect].
AD projects that have been created in the AD Server appear.
TIP If you want to set a port number, type a colon ":" and the port number after the computer name or the IP ad-
dress.

4. Select an AD project and click [Open].


SEE
ALSO For more information about the login user when starting AD Organizer, refer to:
C1.1.6, “Controlling access to AD projects” on page C1-11
For more information about setting a port number for AD Server, refer to:
C1.1.1, “Setting the AD Server options” on page C1-4
For more information about switching the connected AD project, refer to:
B4.1, “Change AD project that is a target of editing” in Automation Design Suite Module-based Engineer-
ing Vol.1 (IM 33J10A15-01EN)

n Registering a VP project in the AD project


Follow these steps to register a VP project in the AD project:
1. From the menu bar on AD Organizer, select [View] > [System Structure Navigator].
The System Structure Navigator appears.
2. On the toolbar, click [Sub menu] and select [Register System Project].
System Project Registration dialog box appears.
3. From the Project drop-down list, select the VP project name and click [Register].
The VP project that you have registered appears on the System Structure Navigator.

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<B1.5 Registering a VP project in the AD project> B1-10
TIP • History management of the VP project automatically starts when the VP project is registered.
• If a VP project of the same name is registered already, you cannot register the VP project.
• You cannot change the name of a VP project that is registered in the AD project. If you want to change
the name of a VP project, you must unregister the VP project from the AD project, rename the project
name, and then reregister the VP project in the AD project.
• If a VP project is registered in an AD project, you cannot register the VP project in another AD project.

SEE
ALSO For more information about System Structure Navigator, refer to:
“■ System Structure Navigator” in B3.1.1, “Navigation window” in Automation Design Suite Module-
based Engineering Vol.1 (IM 33J10A15-01EN)
For more information about history management, refer to:
C2., “History management” on page C2-1
For more information about starting and stopping the history management of VP projects, refer to:
C2.5, “Managing the revision history of VP projects” on page C2-18

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<B1.5 Registering a VP project in the AD project> B1-11

B1.5.1 Managing VP projects


This section describes how to manage VP projects, such as modifying or unregistering them.
You perform this task on a computer with system builders.

n Unregistering a VP project from the AD project


Follow these steps to unregister a VP project from the AD project:
TIP When you perform this task on one of the computers with system builders, the unregistration of the VP project
is accepted in the other computers even if you have multiple computers with system builders that are connec-
ted to the AD project.

IMPORTANT
When you unregister a VP project from the AD project, all revision history of the VP project is
deleted. Note that even if you register the same VP project again, the project is regarded as a
different VP project from before.

1. Select a VP project on the System Structure Navigator.


2. On the toolbar, click [Sub menu] and select [Unregister System Project].
3. In the confirmation dialog box, select the check box and select [OK].
TIP • By this operation, the VP project is unregistered from the AD project, whereas System View still retains
the VP project.
• If you use module-based engineering, unregistering the VP project needs to meet the following require-
ments:
• All the files under the VP project that is to be unregistered on System Structure Navigator are
checked-in.
• None of the I/O in the process I/O list and communication I/O list is assigned to the FCS that belongs
to the VP project to be unregistered.
• In the Module Binding Window, no application module is assigned to the drawing modules of the
FCSs that belong to the VP project to be unregistered.

SEE
ALSO For more information about System Structure Navigator, refer to:
“■ System Structure Navigator” in B3.1.1, “Navigation window” in Automation Design Suite Module-
based Engineering Vol.1 (IM 33J10A15-01EN)
For more information about check-in, refer to:
B3.1.6, “Check-in Window” in Automation Design Suite Module-based Engineering Vol.1 (IM
33J10A15-01EN)
For more information about the process I/O list and communication I/O list, refer to:
C., “Designing I/O” in Automation Design Suite Module-based Engineering Vol.1 (IM 33J10A15-01EN)
For more information about Module Binding Window, refer to:
F., “Assigning application modules to drawing modules” in Automation Design Suite Module-based Engi-
neering Vol.1 (IM 33J10A15-01EN)

n Operating VP projects
This section describes the procedures to operate VP projects.

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<B1.5 Registering a VP project in the AD project> B1-12

l Changing attributes of a VP project


If you want to change an attribute of a VP project, use the Project's Attribution Utility.
SEE
ALSO For more information about changing attributes of a VP project, refer to:
“■ Changing the Attribute of a Project” in 2.3, “Project's Attribution Utility” in Engineering Reference Vol.1
(IM 33J10D10-01EN)

l Unregistering a VP project from System View


Follow these steps to unregister a VP project from System View.
1. Unregister the VP project from the AD project.
2. Delete the VP project from System View by using the Project's Attribution Utility.
SEE
ALSO For more information about deleting a VP project by using the Project's Attribution Utility, refer to:
“■ Deleting a Project” in 2.3, “Project's Attribution Utility” in Engineering Reference Vol.1 (IM
33J10D10-01EN)

l Backing up a VP project to the AD project


You must back up the VP project to the AD project before backing up the ADMDB or exporting
the AD project. Follow these steps to back up the VP project to the AD project by using AD
Organizer:
TIP • From the second time that you back up the VP project, the previous backup data is replaced with the
new backup data.
• When backing up ADMDB or when exporting the AD project, you can also back up multiple VP projects
together by using the ADS Administration Tool.

1. From the menu bar on the AD Organizer, select [View] > [System Structure Navigator].
The System Structure Navigator appears.
2. In the System Structure Navigator, select the VP project to back up.
3. On the toolbar, click [Sub menu] and select [Back up].
A confirmation dialog box appears.
4. Click [Yes].
Backup of the VP project starts.
SEE
ALSO For more information about backing up the ADMDB or exporting an AD project, refer to:
C1., “Managing AD Server and AD projects” on page C1-1
For more information about method of using the ADS Administration Tool to back up multiple VP projects to-
gether, refer to:
• “n Backing up the ADMDB” on page C1-5
• “n Exporting AD projects” on page C1-21

l Restoring a VP project from the AD project


You need to restore the VP project from the AD project after restoring the ADMDB or import-
ing the AD project. Follow these steps to restore the backup VP project from the AD project:

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<B1.5 Registering a VP project in the AD project> B1-13

IMPORTANT
• You must perform this task after restoring the ADMDB or importing the AD project.
• Restoring a VP project may cancel the sharing setting of the top folder of the VP project.
When you have restored a VP project, check that the top folder of the VP project is set as
shared. If sharing has been canceled, set the share name CS1000PJT.
Example when the project name is MYPJT:
Set the share name CS1000PJT for the following MYPJT folder.
<CENTUM VP installation folder>\eng\BKProject\MYPJT

1. From the menu bar on the AD Organizer, select [View] > [System Structure Navigator].
The System Structure Navigator appears.
2. In the System Structure Navigator, select a VP project.
3. On the toolbar, click [Sub menu] and select [Restore from Back up].
The System Project Restore dialog box appears.

Figure B1.5.1-1 System Project Restore dialog box

4. Select the [Reregister the restored System Project to AD Project] check box, if necessary.
If you select the check box, the following actions run automatically.
• Registering the restored VP project in System View
• Reregistering the restored VP project in the AD project
TIP You cannot select this check box if any of the following cases are applicable.
• The project name of the VP project to be restored has been changed.
• The software revision of the VP project registered in the AD project is inconsistent with the software revi-
sion of the VP project to be restored.

5. If you want to change the name of restored VP project, type a new project name.
6. Specify the folder where the VP project is to be restored, and click [Restore].
Restoring the VP project in the specified folder starts.
If the [Reregister the restored System Project to AD Project] check box is selected, the
VP project is registered in System View and AD project automatically after the restoration
is complete.

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<B1.5 Registering a VP project in the AD project> B1-14
7. If the [Reregister the restored System Project to AD Project] check box is not selected,
register the restored VP project in System View manually.
TIP • If you have restored the VP project with a changed name, select the new project name.
• If you have restored the VP project without renaming it in order to replace an existing VP project, follow
these steps. The VP project must stay registered in the AD project when you perform this task.
1. Delete the existing VP project by using the Project's Attribution Utility.
2. Register the VP project that you restored by using the Project's Attribution Utility.

8. Register the VP project that you have restored in the AD project manually.
TIP Also when you restore a VP project without renaming it to replace the existing VP project, register the VP
project that you restored in the AD project again.

SEE
ALSO For more information about backing up the ADMDB or exporting an AD project, refer to:
C1., “Managing AD Server and AD projects” on page C1-1
For more information about registering and deleting VP projects in System View, refer to:
2.3, “Project's Attribution Utility” in Engineering Reference Vol.1 (IM 33J10D10-01EN)
For more information about registering VP projects in an AD project, refer to:
B1.5, “Registering a VP project in the AD project” on page B1-9

l Copying a VP project
Follow these steps to copy a VP project:
TIP You can develop a test environment by copying the current VP project to a user-defined project.

1. Back up the VP project to the AD project.


2. Restore the VP project from the AD project using an alias.
SEE
ALSO For more information about backing up a VP project, refer to:
“l Backing up a VP project to the AD project” on page B1-12
For more information about restoring a VP project, refer to:
“l Restoring a VP project from the AD project” on page B1-12

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<B2. How to start engineering after upgrading the CENTUM VP software > B2-1

B2. How to start engineering after


upgrading the CENTUM VP software
Before starting engineering after you have upgraded the CENTUM VP software, you must al-
so upgrade the data in the AD project and VP project.
This section describes how to start engineering after CENTUM VP has been upgraded.

n Procedure for starting engineering


The following figure shows the procedure for starting engineering.

Start

Upgrade AD Server data

Upgrade the AD project

Upgrade the VP projects

End

Figure B2-1 Procedure for starting engineering

TIP For some steps in this procedure, upgrading may not be required. In this case, do not quit the engineering at
such a step and proceed to the next step.

n Access rights for use of ADS Administration Tool


To be able to use the ADS Administration Tool in engineering, access rights are required ac-
cording to the IT security model. If the IT security model is the Standard model or the
Strengthened model, log on to a computer with AD Server by using an account that belongs
to either of the following groups:
• ADS_MANAGER group
• ADS_MANAGER_LCL group
The ADS Administration Tool has the function to back up VP projects at the same time as
when you back up the ADMDB or export an AD project. To activate this function, you must log
on to a computer with AD Server by using an account that belongs to the following groups:
• ADS_MANAGER group or ADS_MANAGER_LCL group
• CTM_MAINTENANCE

n Setting before starting engineering


Before starting engineering, you must activate the VP project backup function. Start the ADS
Administration Tool and, in the following Activation Setting for System Project Backup Func-
tion dialog box that appears, click [Activate].

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<B2. How to start engineering after upgrading the CENTUM VP software > B2-2

Figure B2-2 Activation Setting for System Project Backup Function dialog box

SEE
ALSO For more information about the function to back up VP projects at the same time as backing up the ADMDB
or exporting an AD project, refer to:
• C1.1.2, “Backing up and restoring the ADMDB” on page C1-5
• C1.1.7, “Exporting and importing AD projects” on page C1-21

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<B2.1 Upgrading the AD Server data > B2-3

B2.1 Upgrading the AD Server data


You must upgrade the following data on the AD Server:
• Back-up and restore history of the ADMDB
• Export and import history information of AD projects
• Option settings
To perform this task use the ADS Administration Tool on the computer with AD Server.

n Upgrading the AD Server data


Follow these steps to upgrade the AD Server data:
1. Log on to the computer with AD Server. If the IT security model is the Standard model or
Strengthened model, log on as a member of the ADS_MANAGER or ADS_MANAG-
ER_LCL group.
2. Start the ADS Administration Tool.
If upgrading of the AD server data is required, the AD Server Data Upgrade Dialog Box
appears.
3. Click [OK].
Data upgrade starts. When the upgrade is complete, the Upgrade Complete Dialog Box
appears.
4. Click [Exit ADS Administration tool].
The AD Server restarts to complete the data upgrade.
TIP Performing this task does not upgrade AD project data.

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<B2.2 Upgrading AD projects > B2-4

B2.2 Upgrading AD projects


You must upgrade the AD project data.
To perform this task use AD Organizer on a computer with system builders.
If there are multiple computers with system builders, you can use any of these computers.

IMPORTANT
• Do not start System View until upgrade of the AD project is complete. If you start System
View before the completion of the upgrade, the VP project fails to upgrade and is unregis-
tered from System View.
If this happens, re-register the VP project to System View in the Project’s Attribution Utility
after completing the AD project upgrade.
• Before you upgrade an AD project, close AD Organizer on all computers except the one
where you perform the upgrade.

SEE
ALSO For more information about registering a VP project in System View, refer to:
“■ Registering a Project” in 2.3, “Project's Attribution Utility” in Engineering Reference Vol.1 (IM
33J10D10-01EN)

n Upgrading an AD project
Follow these steps to upgrade an AD project:
1. Log on to the computer with system builders as a user with modifying access rights to all
data in the AD project.
TIP During upgrade of an AD project, AD project files are checked out, updated, and checked in. If you log on as
a user who does not have modifying access rights, upgrade of the AD project fails with an error.
You must log on as a user whose user role is VP Lead Engineer and whose access scope is All Scope.

2. Start AD Organizer.
If upgrading of an AD project is required, the Upgrade dialog box appears.
3. Click [Yes].
The upgrade for the AD project starts. When the upgrade is complete, the Update Com-
plete dialog box appears.

IMPORTANT
While revision upgrade of the AD project proceeds, make sure that communication between
AD Server and AD Organizer is not interrupted. If the communication is interrupted, upgrade
of the AD project fails with an error.
When upgrading the AD project fails with an error due to an interruption, check to see if there
are any checked-out files in the AD project. If there are any, forcibly cancel the checked-out
status by using the ADS Administration Tool and start AD project upgrade again.

4. Click [OK].

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<B2.2 Upgrading AD projects > B2-5
SEE
ALSO For more information about how to confirm the checked-out status of AD project files, refer to:
• C1.1.9, “Forcibly canceling the checked-out status of currently checked out files” on page C1-25
• C1.3.7, “Forcibly canceling the checked-out status of currently checked out files” on page C1-42

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<B2.3 Upgrading VP projects > B2-6

B2.3 Upgrading VP projects


You must upgrade the VP projects.
To perform this task, use a computer with system builders.
If there are multiple computers with system builders, you can use any of these computers.

n Upgrading the revision of a VP project


Follow these steps to upgrade a VP project:
1. Log on as a user with modifying access rights to the VP project.
TIP Log on as a user whose user role is VP Lead Engineer or VP Engineer.

2. Start AD Organizer.
3. On the toolbar of the System Structure Navigator, click [System View].
If upgrading of the VP project is required, a dialog box appears, asking you whether to
upgrade the VP project.
4. Click [OK].
A dialog box appears, asking you whether to back up the VP project.
5. If necessary, click [Yes] and specify the location for saving. Otherwise click [No].
Upgrading of the VP project starts. When the upgrade is complete, the Upgrade Com-
plete dialog box appears.
6. Click [OK].
System View starts, and now the upgrade of the VP project is finished.
7. On the System Structure Navigator in AD Organizer, select a VP project.
8. On the toolbar, click [Sub menu] and select [Back up].
A confirmation dialog box appears.
9. Click [Yes].
The upgraded VP project is backed up.

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<C. Basic functions> C-1

C. Basic functions
PART-C explains how to manage AD Server and AD project by using the Automation Design
Suite Administration Tool (below, "ADS Administration Tool") as well as history management
for the AD Suite.

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


Blank Page
<C1. Managing AD Server and AD projects> C1-1

C1. Managing AD Server and AD


projects
Managing AD Server includes setting the location of the ADMDB, backing up and restoring
the ADMDB, and so on. Managing AD projects includes creating AD projects, exporting and
importing project data, and configuring access control settings, and so on.

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<C1.1 Overview of AD Server and AD project management> C1-2

C1.1 Overview of AD Server and AD project


management
AD Server and AD project are managed using the ADS Administration Tool. The ADS Admin-
istration Tool runs on a computer with AD Server. To use the ADS Administration Tool, the
user must have the proper access rights.

Figure C1.1-1 ADS Administration Tool

IMPORTANT
Before you work with the ADS Administration Tool, close AD Organizer on all computers.

n Functions of the ADS Administration Tool


The ADS Administration Tool provides AD Server management functions and AD project man-
agement functions.

l AD Server management functions


The ADS Administration Tool provides the following functions for managing AD Servers:
• Setting the ADMDB location
• Setting the AD Server options
• Backing up and restoring the ADMDB
• Viewing the history of backup and export operations

l AD project management functions


The ADS Administration Tool provides the following functions for managing AD projects:
• Creating and deleting AD projects
• Modifying AD project properties
• Controlling access to AD projects
• Exporting and importing AD projects
• Prohibiting and permitting AD project data modifications

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<C1.1 Overview of AD Server and AD project management> C1-3
• Forcibly canceling the checked-out status of currently checked out AD project files

n Access rights that are required to use the ADS Administration Tool
To be able to use each function of the ADS Administration Tool, access rights are required
according to the IT security model. If the IT security model is the Standard model or Strength-
ened model, you should log on to a computer with AD Server by using an account that be-
longs to either of the following groups:
• ADS_MANAGER group
• ADS_MANAGER_LCL group

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<C1.1 Overview of AD Server and AD project management> C1-4

C1.1.1 Setting the AD Server options


Two AD Server options are available: one for setting up communication and the other one for
setting up ADMDB encryption. Set the AD Server options in the Option Setting Dialog Box of
the ADS Administration Tool.

Figure C1.1.1-1 Option Setting Dialog Box

n Communication setup
You can change the port number used by AD Organizer to communicate with the AD Server.
If the computer with AD Server has multiple network interface cards installed in it, you can set
which network interface card is used.
TIP After changing the communication setup, restart the computer with AD Server.

IMPORTANT
If the computer with AD Server is connected to the control bus, the control bus network inter-
face also appears in the Option Setting Dialog Box. However, you must be aware that AD Or-
ganizer and AD Server cannot communicate each other through the control bus.
In the standard settings, the IP address of the control bus network interface is 172.16.<do-
main number>.<station number>.

SEE
ALSO For more information about the network settings for control bus, refer to:
B4.3.4, “Configuring Windows Network Settings” in CENTUM VP Installation (IM 33J01C10-01EN)

n Setting up ADMDB encryption


You can encrypt the ADMDB by using the Encrypting File System. You can set whether or not
to encrypt the ADMDB. The default setting is not to encrypt the database.
TIP • After changing the ADMDB encryption setting, restart the computer with AD Server. When the computer
is restarted, the encryption or decryption process is performed.
• It takes some time to encrypt or decrypt the ADMDB.

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<C1.1 Overview of AD Server and AD project management> C1-5

C1.1.2 Backing up and restoring the ADMDB


You can back up or restore the ADMDB.

n Backing up the ADMDB


Back up the ADMDB in the Server Backup Dialog Box of the ADS Administration Tool.

Figure C1.1.2-1 Server Backup Dialog Box

Backing up the ADMDB includes all data in the database.

IMPORTANT
Before backing up the ADMDB, back up all VP projects to the AD project. When restoring the
backed-up ADMDB, you must also restore the VP projects.

TIP • You cannot back up only a part of ADMDB data.


• You cannot back up the ADMDB while it is being updated.
• If a data modification request is received from AD Organizer while the ADMDB is being backed up, the
data modification request from AD Organizer will either end in an error or will be made to wait until the
backup is complete.
• If any files are checked-out when you back up the ADMDB, the backup is executed with the checked-out
status of the files discarded. Therefore, the checked-out status is not inherited when restoring the
backed up ADMDB.

l Backup password
You need to enter a password to back up the database. You will need this password to restore
the database.

l Items set in the Server Backup Dialog Box


The following table explains the items that are set in the Server Backup Dialog Box.

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<C1.1 Overview of AD Server and AD project management> C1-6
Table C1.1.2-1 Items set in the Server Backup Dialog Box
Setting Explanation
Backup File Path Specify the folder in which the backup file is to be saved. The
file path can contain up to 180 characters.
The backup file is saved to this folder. When the size of the
backup file exceeds 100 MB, the file is automatically split into
and saved as multiple files.
Backup System Projects prior to Server Specifies whether the VP project is backed up together with the
Backup. check box ADMDB. When this check box is selected and the backup target
VP project is selected, this VP project is backed up to the
ADMDB. This check box is selected in the default settings.
Comment Enter a comment. The text appears in the Server Restoration
Dialog Box when restoring the database. The maximum number
of characters is 128.
Password Enter a 1 to 8-character length password that will be required
when restoring the database. You can use single-byte alphanu-
meric characters, under score (_), hyphen (-), and period. The
password is case-sensitive.
Confirm Password Enter the password again to confirm.

l Selection of VP project for backup


The VP project for backup is selected in the System Project Selection dialog box of the ADS
Administration Tool.

Figure C1.1.2-2 System Project Selection dialog box

The System Project Selection dialog box appears when the [Select] button in the Server
Backup dialog box is clicked. The VP projects contained in the ADMDB are shown in the Sys-
tem Project Selection dialog box. The VP project selected by the check box is backed up.

n Restoring the ADMDB


You can restore the backed-up ADMDB. Restore the ADMDB in the Server Restoration Dialog
Box of the ADS Administration Tool.

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<C1.1 Overview of AD Server and AD project management> C1-7

Figure C1.1.2-3 Server Restoration Dialog Box

Restoration replaces the ADMDB with the restored ADMDB. The AD Server that the database
is restored to must have the defined the Windows users and user groups which were used in
the AD Server from which the database was backed up. To restore the database, enter the
password that was entered at the time of backup.

IMPORTANT
After restoring the ADMDB, you must also restore the VP projects using AD Organizer.
Failing to restore the VP projects leads to inconsistencies between the AD project database
and VP project database.

TIP • You cannot restore the ADMDB while it is being updated.


• Encryption of the restored ADMDB depends on the encryption setting on the computer where the
ADMDB is restored regardless of the encryption setting on the computer where the backup ADMDB is
stored.

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<C1.1 Overview of AD Server and AD project management> C1-8

C1.1.3 Viewing the history of backup and export operations


You can view the backup history of the ADMDB and the export history of AD projects.
SEE
ALSO For more information about exporting AD projects, refer to:
C1.1.7, “Exporting and importing AD projects” on page C1-21

n Viewing the history


You can view the history of backup and export operations through the Backup/Export History
Dialog Box.

Figure C1.1.3-1 Backup/Export History Dialog Box

l Items displayed in the Backup/Export History Dialog Box


The following table shows the items shown in the Backup/Export History Dialog Box.

Table C1.1.3-1 Items displayed in the Backup/Export History Dialog Box


Item Description
Backup or Export "Backup" or "Export" is displayed.
Project@ChangeSet List "AD project name@Change Set ID" is displayed.
If two or more AD projects had been registered in the ADMDB when
the ADMDB was backed up, the AD projects are listed with a comma in
between.
User The name of the user who executed the backup or export is displayed.
Date The date and time of backup or export execution is displayed.
Comment The comment that was set at the time of backup or export is displayed.

SEE
ALSO For more information about Change Set IDs, refer to:
“l Saving Change Sets” on page C2-2

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<C1.1 Overview of AD Server and AD project management> C1-9

C1.1.4 Creating and deleting AD projects


You can create or delete AD projects on or from the AD Server.

n Creating an AD project
You can create an AD project on the AD Server. Create an AD project in the Project Creation
Dialog Box of the ADS Administration Tool.

Figure C1.1.4-1 Project Creation Dialog Box

The following table explains the items set in the Project Creation Dialog Box.

Table C1.1.4-1 Items set in the Dialog Box


Setting Explanation
Project Name Enter an AD project name using up to 50 single-byte alphanumeric
characters and "_" (underscore). The first character must be an alpha-
betic character. The default project name is OURPJT.
Project Comment Enter a comment for the AD project using up to 128 characters.

n Deleting an AD project
You can delete any AD project that was created on the AD Server. When you delete an AD
project, you are required to confirm the deletion.

Figure C1.1.4-2 Confirm to delete an AD project

IMPORTANT
When you delete an AD project, you must first unregister the VP project from the AD project
and then delete the AD project.
If you delete an AD project without unregistering the VP project, you can no longer perform
operations on VP projects, such as registering or deleting a VP project.
If you have deleted an AD project without unregistering the VP project, contact YOKOGAWA
Service.

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<C1.1 Overview of AD Server and AD project management> C1-10

C1.1.5 Modifying AD project properties


You can modify the Project Name and Project Comment of any AD project that is created on
the AD Server.

n Modifying the Project Name and Project Comment


Modify the Project Name and Project Comment of an AD project in the Project Property Dia-
log Box of the ADS Administration Tool.

Figure C1.1.5-1 Project Property Dialog Box

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<C1.1 Overview of AD Server and AD project management> C1-11

C1.1.6 Controlling access to AD projects


User security in the AD Suite is achieved by "user authentication" and "access control."
"User authentication" uses Windows functions. The user name and password of the currently
logged-on Windows user are authenticated against the computer running AD Organizer and
the AD Server.
"Access control" involves granting access permissions to Windows users or groups to control
their access to each function. An access permission consists of "user role" and "access
scope."
Use Windows function
User security

User authentication

Access control Access permission User role

Access scope

Figure C1.1.6-1 Access control to AD projects

TIP You must configure access control to AD projects for all users who perform engineering or maintenance
works of CENTUM VP.
If the IT security model is set to the Standard model or Strengthened model, configure access control to AD
projects for all users who belong to the following groups:
• CTM_ENGINEER
• CTM_ENGINEER_ADM
• CTM_MAINTENANCE
• CTM_MAINTENANCE_LCL

n User roles
A user role is a set of access rights that is defined according to the role of the user. Access
rights are classified into two types: access rights on objects and access rights on functions.
• Access rights on objects
Reference, modify, create, and delete data
• Access rights on functions
Permit/deny executing a function
There are two types of user roles: user roles provided by the system and user roles defined
by the user using the ADS Administration Tool. User roles provided by the system are referred
to as "Pre-defined user roles." User roles defined by the user using the ADS Administration
Tool are referred to as "Customizable user roles."
For example, a Pre-defined user role "Control Logic Engineer" permits module modification,
but not modification of process I/O lists.
SEE
ALSO For more information about pre-defined user role access rights, refer to:
“l Pre-defined user role” on page C1-14

l List of access rights on objects


The following four types of access rights on objects are available:

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<C1.1 Overview of AD Server and AD project management> C1-12
Table C1.1.6-1 List of access rights on objects
Access right Explanation
R Able to reference the applicable object
RW Able to reference and modify the applicable object
RWA Able to reference, modify and create the applicable object
RWAD Able to reference, modify, create and delete the applicable object

l List of objects for which access rights can be defined


You can define access rights for the objects shown in the following table.

Table C1.1.6-2 List of objects for which access rights can be defined
Data type Target Operations on the applicable folder or file
Large category Medium category
Control Logic Class Module AD project • Create and delete class modules
• Edit using the Design Information Editor
• Edit using the Control Logic Editor
• Edit using the Tuning Parameter Editor
• Edit using the Alarm Attribute Editor (in-
cluding application of alarm profiles)
• Edit in the Attachment List Window
• Create, edit, and delete module rules
Application Mod- AD project • Create and delete application modules
ule • Edit using the Design Information Editor
• Edit using the Control Logic Editor
• Edit using the Tuning Parameter Editor
• Edit using the Alarm Attribute Editor (in-
cluding application of alarm profiles)
• Edit in the Attachment List Window
• Edit using the Control Logic Mass Editor
Create, edit, apply, and delete grid rules
• Edit using the Alarm Attribute Mass Editor
Create, edit, apply, and delete grid rules
• Edit using the Module Update Manager
• Create, edit, and delete module rules
• Create and delete folders and move appli-
cation modules by using the Application
Configuration Navigator
Alarm Alarm Profile AD project Edit alarm profiles
Library Sequence Library AD project • Create and delete SEBOL user functions
• Create and delete SFC sequences
• Create and delete unit procedures
• Edit using the Sequence Library Editor
I/O Process I/O List AD project • Create, edit, and delete a process I/O list
• Create, edit, apply, and delete grid rules
• Create and delete IOM folders of the Sys-
tem Configuration Navigator
Communication AD project • Create, edit, and delete a communication
I/O List I/O list
• Create, edit, apply, and delete grid rules
Continues on the next page

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<C1.1 Overview of AD Server and AD project management> C1-13
Table C1.1.6-2 List of objects for which access rights can be defined (Table continued)
Data type Target Operations on the applicable folder or file
Large category Medium category
VP Project VP project • Create, copy, delete, and edit the folders
and files under the project folder in System
View
• Edit, and modify the properties of, the files
directly under the project folder in System
View
• Execute VP generation for all folders and
files in System View that are the targets of
VP generation. Access right is not required
to execute conversion.
AD project • Register and delete the folders and files
under the VP project folder in System
Structure Navigator, and back up and re-
store VP projects using AD Organizer
FCS VP project • Create, copy, delete, and edit the folders
and files under the FCSddss folder in Sys-
tem View
Limited to those editable in System View in
the case of module-based engineering
(e.g., sequence libraries).
All folders and files under the FCSddss
folder are the target in the case of module-
less engineering.
AD project • In System Configuration Navigator, create
folders and files under FCSddss folders,
delete FCSs, create, edit, apply, and delete
grid rules
IOM AD project • Edit using the IOM Definition Editor
• Create and delete IOM folders of System
Configuration Navigator
Control Drawing AD project • Create and edit in the Module Binding Win-
dow
• Edit using the Control Drawing Builder
Message AD project • Edit using the Annunciator Editor
• Edit using the Signal Event Editor
• Edit using the Operator Guide Editor
• Edit using the Printout Message Editor
• Create, edit, apply, and delete grid rules
Switch AD project • Edit using the Common Switch Editor
• Edit using the Global Switch Editor
• Create, edit, apply, and delete grid rules
Sequence Library AD project • Start the SEBOL User Function Builder
• Start the SFC Sequence Builder
• Start the Unit Procedure Builder
• Edit using the Sequence Library Editor
Common VP project Folders and files under the COMMON folder
in System View (*1)
Batch VP project Folders and files under the BATCH folder in
System View
HIS VP project Folders and files under the HISddss folder in
System View
Other Station VP project Folders and files under other station
(BCVVddss, etc.) folders in System View
*1: Access rights can be defined for "Engineering unit symbol, "Switch position label", "CAMS", and "UACS" under the Common
folder, separately from other files.

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<C1.1 Overview of AD Server and AD project management> C1-14
TIP • Fixed access rights may be set depending on the data type. For example, alarm profiles can only be
edited, so any access rights on an alarm profile are treated as RW even when RWA or RWAD is defined.
• For access control of the grid rules, only the access rights that are defined for user roles are applied.
Access to grid rules is not limited by the access scope.

l List of functions for which access rights can be defined


You can define access rights for permitting or denying operations with respect to the functions
shown in the following table.

Table C1.1.6-3 List of functions for which access rights can be defined
Type of function Operation and access rights on function
Large category Medium category
Document Document Permit/deny operations in the Document Navigator
• Permit: Able to create, reference, and delete
documents
• Deny: Only able to reference documents
ModPack Creation Permit/deny operations in the ModPack Navigator
and ModPack List Window
Closing
Reopen
Management
Implementation
Revision History Re-assign ModPack Permit/deny changing the ModPack IDs in the revi-
sion history
Modify Comment Permit/deny changing the check-in comment in the
revision history
Set Label Permit/deny setting labels
Delete Label Permit/deny deleting labels
Change Label Permit/deny changing label comments
Utility Permit/deny executing the Revision History Utility

SEE
ALSO For more information about details of access rights on ModPack, refer to:
B1.3, “Access control on ModPack operation” in Automation Design Suite Optional Functions (IM
33J10A20-01EN)

l Pre-defined user role


The following eight pre-defined user roles are available:
• VP Lead Engineer
• Control Logic Engineer
• Alarm Engineer
• Process I/O Engineer
• VP Engineer
• RS Lead Engineer
• Safety I/O Engineer
• RS Engineer

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<C1.1 Overview of AD Server and AD project management> C1-15
The following table shows the access rights that are defined by default for the Pre-defined
user roles.

Table C1.1.6-4 Access rights on objects


Data types Pre-defined user role
Large catego- Medium cate- VP Lead En- Control Logic Alarm Engi- Process I/O VP Engineer
ry gory gineer Engineer neer Engineer
Control Logic Class Module RWAD RWAD RW R R
Application RWAD RWAD RW R R
Module
Alarm Alarm Profile RWAD R RWAD R R
Library Sequence Li- RWAD RWAD R R R
brary
I/O Process I/O RWAD R R RWAD R
List
Communica- RWAD R R RWAD R
tion I/O List
VP Project RWAD R R R RWAD
FCS RWAD R R R RWAD
IOM RWAD R R RWAD RWAD
Control Draw- RWAD R R R RWAD
ing
Message RWAD R R R RWAD
Switch RWAD R R R RWAD
Sequence Li- RWAD R R R RWAD
brary
Common (*1) RWAD R R R RWAD
Batch RWAD R R R RWAD
HIS RWAD R R R RWAD
Other Station RWAD R R R RWAD
*1: Access rights can be defined for "Engineering unit symbol, "Switch position label", "CAMS", and "UACS" under the Common
folder, separately from other files.

Table C1.1.6-5 Access rights on functions


Data types Pre-defined user role (*1)
Large catego- Medium cate- VP Lead En- Control Logic Alarm Engi- Process I/O VP Engineer
ry gory gineer Engineer neer Engineer
Document Document Yes Yes Yes Yes Yes
ModPack Creation Yes No No No No
Closing Yes No No No No
Reopen Yes No No No No
Management Yes No No No No
Implementa- Yes Yes Yes Yes Yes
tion
Continues on the next page

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<C1.1 Overview of AD Server and AD project management> C1-16
Table C1.1.6-5 Access rights on functions (Table continued)
Data types Pre-defined user role (*1)
Large catego- Medium cate- VP Lead En- Control Logic Alarm Engi- Process I/O VP Engineer
ry gory gineer Engineer neer Engineer
Revision His- Re-assign Yes No No No No
tory ModPack
Modify Com- Yes No No No No
ment
Set Label Yes Yes Yes Yes Yes
Delete Label Yes No No No No
Change Label Yes No No No No
Utility Yes No No No No
*1: Yes: Able to perform the applicable function
No: Unable to perform the applicable function

TIP Users cannot modify the details of Pre-defined user roles.

SEE
ALSO For more information about RS Lead Engineer, Safety I/O Engineer, and RS Engineer access rights, refer to:
Engineer's Reference Manual (IM 32P04B10-01EN)

n Access scope
An access scope is the definition of a range of folders and files within the data hierarchy of
each navigator of AD Organizer, or within the System View data, to which access rights can
be defined.
Example:
User A can modify the data belonging to folder A, but cannot modify the data belonging to
folder B.

l List of access rights for access scopes


The following four types of access rights are available for access scope:

Table C1.1.6-6 List of access rights for access scopes


Access rights Explanation
R Able to reference the applicable folder or file
RW Able to modify the applicable folder or file
A W right on a folder permits modifying the folder's name and properties.
RWA Able to create folders and files under the applicable folder in addition to
what is permitted under RW
RWAD Able to delete the applicable folder or file in addition to what is permitted
under RWA

An access scope named "All Scope" is provided by default. Set under this All Scope are
RWAD access rights on all AD project folders and files.
TIP Users cannot modify the details of All Scope.

You can define access rights on the following Navigator and View hierarchy (folders and files):
• Library Navigator
• Application Structure Navigator

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<C1.1 Overview of AD Server and AD project management> C1-17
• System Structure Navigator
• CENTUM VP System View

l Library Navigator access scope


The following figure shows the access scope for the Library Navigator. You can define access
rights on the folders and files that are boxed in the figure.

Figure C1.1.6-2 Library Navigator access scope

l Application Structure Navigator access scope


The following figure shows the access scope for the Application Structure Navigator. You can
define access rights on the folders and files inside the boxes in the figure.

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<C1.1 Overview of AD Server and AD project management> C1-18

Figure C1.1.6-3 Application Structure Navigator access scope

l System Structure Navigator access scope


The following figure shows the access scope for the System Configuration Navigator. You can
define access rights on the folders and files inside the boxes in the figure.

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<C1.1 Overview of AD Server and AD project management> C1-19

Figure C1.1.6-4 System Structure Navigator access scope

l CEMTUM VP System View access scope


The following figure shows the access scope for the CENTUM VP System View. You can de-
fine access rights on the folders inside the boxes in the figure.
For the access scope for the CENTUM VP System View, only R and RWAD access can be
defined. RW and RWA access cannot be defined.

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<C1.1 Overview of AD Server and AD project management> C1-20

Figure C1.1.6-5 CEMTUM VP System View access scope

TIP VP projects have folders other than those shown in the figure, but those folders are excluded from the access
scope.

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<C1.1 Overview of AD Server and AD project management> C1-21

C1.1.7 Exporting and importing AD projects


You can export and import AD projects. By exporting an AD project and then importing it, you
can create a copy of the AD project.

n Exporting AD projects
You can export an AD project in the Project Export Dialog Box of the ADS Administration Tool.

Figure C1.1.7-1 Project Export Dialog Box

When exporting an AD project, you can select whether to export only the latest data or to also
include revision history information together with the data. After importing an AD project
where only the latest data was exported, only a check-in log of the latest files appears in the
Revision History window at the location where the database was imported.

IMPORTANT
Before exporting an AD project, you must back up all VP projects to the AD project. When
importing the exported AD project, you must also restore the VP projects.

TIP • When exporting an AD project, you cannot export only a part of the history.
• If you export an AD project while other user is checking in files, the export fails with an error message.
You must export the database after check-in is complete.
• If any checked-out file exists when you export an AD project, the project is exported with the checked-
out status of the files discarded. Therefore, the checked-out status is not inherited by importing the ex-
ported AD project.

l Export password
You need to enter a password to export the database. This password is required when import-
ing the database.

l Items set in the Project Export Dialog Box


The following table explains the items set in the Project Export Dialog Box.

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<C1.1 Overview of AD Server and AD project management> C1-22
Table C1.1.7-1 Items set in the Project Export Dialog Box
Setting Explanation
Output Path Specify the folder to which the file is exported. The file path can contain
up to 180 characters.
Backup System Projects prior to Specifies whether the VP project is backed up together with exporting
AD Project Export check box of the AD project. When this check box is selected, and the backup tar-
get VP project is selected in the System Project Selection dialog box,
this VP project is backed up to the AD project. This check box is selec-
ted in the default settings.
Includes Revision History informa- Specify whether to include the history information in the export file. Se-
tion check box lecting the check box includes all revision history information in the ex-
port file. By default, it is selected.
Comment Enter a comment, if necessary. The text appears in the Project Import
Dialog Box when importing the database. The maximum number of
characters is 128.
Password Enter a 1 to 8-character length password that is required when import-
ing the database. You can use single-byte alphanumeric characters,
under score (_), hyphen (-), and period. The password is case-sensi-
tive.
Confirm Password Enter the password again to confirm.

l Selection of VP project for backup


The VP project for backup is selected in the System Project Selection dialog box of the ADS
Administration Tool.

Figure C1.1.7-2 System Project Selection dialog box

The System Project Selection dialog box appears when the [Select] button in the Export Proj-
ect dialog box is clicked. The VP projects contained in the AD project are shown in the Sys-
tem Project Selection dialog box. The VP project selected by the check box is backed up.

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<C1.1 Overview of AD Server and AD project management> C1-23

n Importing AD projects
You can import an exported AD project. An AD project can be imported through the Project
Import Dialog Box of the ADS Administration Tool.

Figure C1.1.7-3 Project Import Dialog Box

The AD project is imported separately from any AD project that already exists on the comput-
er where you import the AD project. If a project of the same name exists at the import destina-
tion, the dialog box for changing the project name appears at the time of import.
The AD Server to which the database is imported must have defined the Windows users and
user groups that are used in the AD Server from which the database was exported. At the
time of import, enter the password that was entered at the time of export.

IMPORTANT
After importing the AD project, you must also restore the VP projects by using AD Organizer.
Failing to restore the VP projects leads to inconsistencies between the AD project database
and VP project database.

TIP Encryption of the imported AD project database depends on the encryption setting on the computer to which
the database is imported, regardless of the encryption setting on the computer from which you exported the
database.

SEE
ALSO For more information about restoring VP projects by using the AD Organizer, refer to:
“l Restoring a VP project from the AD project” on page B1-12

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<C1.1 Overview of AD Server and AD project management> C1-24

C1.1.8 Prohibiting and permitting AD project data


modifications
You can prohibit modification of the data in an AD project. Data is "frozen" while modification
is prohibited. When a frozen AD project is activated, the prohibition of data modification is
canceled. Whether a given project is frozen or active can be checked using the ADS Adminis-
tration Tool.

n Modifying frozen data


While an AD project is frozen, check-in and check-out of all its data are prohibited. VP gener-
ation is also prohibited. However, you can still reference the data and cancel the checked-out
status of files of a frozen AD project, and you can delete a frozen AD project.

n The purpose of prohibiting AD project data modifications


Use this function to prohibit, for a specific period, modifying the data of an active AD project
when software is to be modified.
For example, you may want to export active AD project data and modify it at a different loca-
tion as part of plant reconstruction, etc., and then import the data to an active AD project at
the plant site to reflect the changes. If you don't want the data of the active AD project at the
plant site to be modified between the time that the project data is exported and it is imported,
you can freeze the AD project.

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<C1.1 Overview of AD Server and AD project management> C1-25

C1.1.9 Forcibly canceling the checked-out status of


currently checked out files
You can forcibly cancel the checked-out status of all files that are currently checked out by
certain users on certain computers at a time. You can use this function to cancel the checked-
out status of files that remain checked out for some reason.

n Discard Check-out Dialog Box


You can forcibly cancel the checked-out status in the Discard Check-out Dialog Box of the
ADS Administration Tool. The Discard Check-out Dialog Box shows a list of files that are cur-
rently checked out under the applicable project.

Figure C1.1.9-1 Discard Check-out Dialog Box

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<C1.2 Managing the AD Server> C1-26

C1.2 Managing the AD Server


The following AD Server management tasks can be performed using the ADS Administration
Tool:
• Setting the ADMDB location
• Setting the AD Server options
• Backing up the ADMDB
• Restoring the backed-up ADMDB
• Viewing the history of backup and export operations

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<C1.2 Managing the AD Server> C1-27

C1.2.1 Setting the ADMDB location


You can specify a folder where the ADMDB for the AD Server is to be placed. By default, the
ADMDB is created in the system drive. If you cannot place the ADMDB in the system drive
because there is not enough disk space or the size of the ADMDB has increased significantly
as a result of engineering work, you can place it in any other folder.
• Default location
<System drive>\ProgramData\Yokogawa\IA\iPCS\Products\ChronusENG
• User-specified location
<Any drive>\<Any folder>\ChronusENG

IMPORTANT
• User-specified locations must be in folders under the local drive.
• The following folders cannot be specified as user-specified locations:
ProgramData
Program Files
Program Files(x86)
CENTUM VP installation folder
Installation folders of other coexisting YOKOGAWA products
Hidden folders

n Setting the initial location of the ADMDB


Follow these steps when you install AD Server and set the location of the ADMDB for the first
time. Set the location of the ADMDB when you start the ADS Administration Tool for the first
time.
1. In the ADMDB Location Setting Dialog Box, specify the folder where the ADMDB is to be
placed and click [OK].
2. Start the IT Security Tool and configure the IT security settings to the values that were set
when CENTUM is installed.
3. Restart the computer.
SEE
ALSO For more information about IT security settings, refer to:
• 6.9, “Viewing the Information Configured by the IT Security Tool” in CENTUM VP Security Guide
(IM 33J01C30-01EN)
• B4.7, “Configuring IT Security Settings” in CENTUM VP Installation (IM 33J01C10-01EN)

n Changing the location of the ADMDB


Follow these steps to change the location of the ADMDB while AD Server is operating:

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<C1.2 Managing the AD Server> C1-28

IMPORTANT
• If the AD project has any checked-out files, make sure that all checked-out files are
checked-in or cancel the checked-out status before changing the location of the ADMDB.
• Before moving existing ADMDB data to a new location, you must back up the ADMDB or
export the AD project. In the course of backing up the ADMDB or exporting the AD proj-
ect, you must back up the latest VP projects to the AD project.
• Backing up and restoring of the ADMDB and display of the operation history are per-
formed for the ADMDB that is stored in the set location.

1. To move the existing ADMDB data to a new location, perform one of the following opera-
tions in the old location:
• If you are moving the entire ADMDB data, back up the ADMDB.
• If you are moving individual AD projects in the ADMDB, export the AD projects.
2. Log on to the computer with AD Server. If the IT security model is the Standard model or
Strengthened model, log on as a member of the ADS_MANAGER or ADS_MANAG-
ER_LCL group.
3. Start the ADS Administration Tool.
4. From the menu bar of the ADS Administration Tool, select [Server] > [Set ADMDB Loca-
tion].
The ADMDB Location Setting Dialog Box appears.
5. Specify the folder where the ADMDB is to be placed and click [OK].
6. Start the IT Security Tool and configure the IT security settings to the values that were set
when CENTUM is installed.
TIP Folders registered in the software restriction policy cannot be deleted with the IT Security Tool. Delete the
folder path of the old location from the software restriction policy.

7. Restart the computer.


An empty ADMDB is created in the new location.
TIP If a ChronusENG folder is already created in the new location and an ADMDB exists in it, that ADMDB is read
after the computer is restarted. If the ADMDB contains any AD project, that AD project is also read at the
same time.

8. If any AD Server options were set before changing the location, set the AD Server op-
tions again.
9. Start the ADS Administration Tool and register the AD project. To register the project, per-
form one of the following operations:
• Create a new AD project.
• Restore the backed-up ADMDB.
• Import an exported AD project.
10. Start AD Organizer and register the VP project in the AD project. To register the project,
perform one of the following operations:
• If you have created a new AD project, register the VP projects in the AD project.
• If you have restored an ADMDB or imported an AD project, restore the backed up VP
projects from the AD project.

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<C1.2 Managing the AD Server> C1-29
TIP The AD Server and AD Organizer is disconnected when you change the ADMDB location. After changing the
ADMDB location, reconnect to the AD Server.

TIP After moving an existing AD project to a new location, it is recommended that you delete the AD project from
the old location.

SEE
ALSO For more information about how to back up the ADMDB, refer to:
C1.2.3, “Backing up the ADMDB” on page C1-31
For more information about how to export AD projects, refer to:
C1.3.4, “Exporting AD projects” on page C1-39
For more information about IT security settings, refer to:
• 6.9, “Viewing the Information Configured by the IT Security Tool” in CENTUM VP Security Guide
(IM 33J01C30-01EN)
• B4.7, “Configuring IT Security Settings” in CENTUM VP Installation (IM 33J01C10-01EN)
For more information about setting the ADMDB options, refer to:
C1.2.2, “Changing the AD Server option settings” on page C1-30
For more information about how to create a new AD project, refer to:
C1.3.1, “Creating an AD project” on page C1-36
For more information about how to restore the ADMDB, refer to:
C1.2.4, “Restoring the backed-up ADMDB” on page C1-32
For more information about how to import AD projects, refer to:
C1.3.5, “Importing AD projects” on page C1-40
For more information about how to register a VP project in the AD project, refer to:
B1.5, “Registering a VP project in the AD project” on page B1-9
For more information about how to restore a VP project from the AD project, refer to:
“l Restoring a VP project from the AD project” on page B1-12

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<C1.2 Managing the AD Server> C1-30

C1.2.2 Changing the AD Server option settings


Two AD Server options are available: one for setting up communication and the other one for
setting up ADMDB encryption.

IMPORTANT
After changing any option setting, you must restart the computer with AD Server.

n Changing the communication settings


Follow these steps to change the communication settings of the AD Server:
1. From the menu bar of the ADS Administration Tool, select [Server] > [Option Setting].
The Option Setting Dialog Box appears.
2. From the IP address list, select the radio button of the network interface card to be used.
3. Change the port number, if necessary.
4. In the Option Setting Dialog Box, click [OK].
The AD Server Restart Confirmation Dialog Box appears.
5. Restart the computer with AD Server.

n Setting up ADMDB encryption


Follow these steps to encrypt the ADMDB:
1. From the menu bar of the ADS Administration Tool, select [Server] > [Option Setting].
The Option Setting Dialog Box appears.
2. Select the [Encrypt AD Server database] check box.
3. In the Option Setting Dialog Box, click [OK].
The Encryption Time Message Dialog Box appears.
4. In the Message Dialog Box, click [OK].
5. Restart the AD Server-installed computer.
TIP You can also decrypt the encrypted ADMDB. To decrypt the database, clear the check box in step 2 and per-
form steps 3 onward.

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<C1.2 Managing the AD Server> C1-31

C1.2.3 Backing up the ADMDB


Backing up the ADMDB includes all data in the database.

n Backing up the ADMDB


Follow these steps to back up the ADMDB:
1. From the menu bar of the ADS Administration Tool, select [Server] > [Back Up].
The Backup Confirmation dialog box appears.
2. In the Backup Confirmation Dialog Box, click [OK].
The Server Backup Dialog Box appears.
3. In the Server Backup dialog box, specify [Backup File Path] and enter the information for
[Comment] and [Password]. To back up the latest VP project to the AD project before
backing up the ADMDB, perform these steps:
a. Select the [Backup System Projects prior to Server Backup] check box.
b. Click [Select].
The System Project Selection dialog box appears, and the VP projects contained in
the ADMDB are shown in the list.
c. Select the check box for the VP project for backup, and click [OK].
TIP Even if an error has occurred during backup of a VP project, to proceed with the process for backing up the
next VP project without aborting, select the [Continue even if error occurs in System Project Backup.].

4. In the Server Backup Dialog Box, click [OK].


Backup of the ADMDB starts and the Server Backup Progress Dialog Box appears.

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<C1.2 Managing the AD Server> C1-32

C1.2.4 Restoring the backed-up ADMDB


Restoring the backed-up ADMDB replaces the restoration destination ADMDB with the re-
stored ADMDB.

n Restoring the backed-up ADMDB


Follow these steps to restore the backed up ADMDB:
1. From the menu bar of the ADS Administration Tool, select [Server] > [Restore].
The Server Restoration Dialog Box appears.
2. In the Server Restoration Dialog Box, click [OK].
The Server Restoration Dialog Box appears.
3. In the Server Restoration Dialog Box, click the file selection button and select the folder
you want to restore.
In the Server Restoration Dialog Box, the path of the file to be restored appears under
[Source File Path].
4. Under [Password] in the Server Restoration Dialog Box, enter the password that was en-
tered at the time of backup.
5. In the Server Restoration Dialog Box, click [OK].
6. If any AD Server setting information or AD project exists at the destination, a confirmation
dialog box appears. In the Restore Confirmation Dialog Box, select the [Yes, I want to re-
store.] check box and click [OK].
Restoration of the ADMDB starts, and the Server Restore Progress Dialog Box appears.
If no AD Server setting information or AD project exists on the destination computer, re-
storation of the ADMDB starts without any confirmation dialog and the Server Restore
Progress Dialog Box appears.
7. When restoration of the ADMDB is complete, restore the VP projects using AD Organizer.
TIP If you have restored the ADMDB on a computer that is not the one where you took a backup, review the com-
munication setup of the AD Server.

SEE
ALSO For more information about restoring a VP project, refer to:
“l Restoring a VP project from the AD project” on page B1-12
For more information about communication setup, refer to:
“n Communication setup” on page C1-4

n When moving the AD Server by restoring the ADMDB on a different


computer or when changing the IP address of the AD Server
Follow these steps to move the AD Server by restoring the ADMDB on a different computer or
to change the IP address of the AD Server:
1. If you want to move the AD Server to a different computer, restore the backed-up ADMDB
on the destination computer. If you want to change the IP address of the AD Server,
change the IP address.
2. Check the communication settings of the AD Server.
3. Start AD Organizer.
The Select AD Project Dialog Box appears.
4. In the Select AD Project Dialog Box, specify the AD Server and select the AD projects.

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<C1.2 Managing the AD Server> C1-33
5. If you are restoring the ADMDB, restore VP projects on the AD Organizer.
6. Open the System Structure Navigator in AD Organizer and start the Revision History Utili-
ty.
7. After starting the Revision History Utility, just close it without doing anything else.
The internal data that is related to the AD Server address is updated.
SEE
ALSO For more information about restoring the backed-up ADMDB, refer to:
“n Restoring the backed-up ADMDB” on page C1-32
For more information about changing the IP address of AD Server, refer to:
“n Changing the communication settings” on page C1-30
For more information about restoring a VP project, refer to:
“l Restoring a VP project from the AD project” on page B1-12
For more information about starting the Revision History Utility, refer to:
“n Starting the Revision History Utility” on page C2-19

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<C1.2 Managing the AD Server> C1-34

C1.2.5 Viewing the history of backup and export operations


You can view the backup history of the ADMDB and export history of AD projects.

n Viewing the history


Follow this step to view the history of backup and export operations:
• From the menu bar of the ADS Administration Tool, select [File] > [Back Up/Export Histo-
ry].

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<C1.3 Managing AD projects> C1-35

C1.3 Managing AD projects


The following AD project management tasks can be performed by using the ADS Administra-
tion Tool:
• Creating and deleting AD projects
• Modifying AD project properties
• Controlling access to AD projects
• Exporting and importing AD projects
• Prohibiting and permitting AD project data modifications
• Forcibly canceling the checked-out status of the currently checked-out AD project files
SEE
ALSO For more information about controlling access to AD projects, refer to:
C1.4, “Setting user security for AD projects” on page C1-43

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<C1.3 Managing AD projects> C1-36

C1.3.1 Creating an AD project


You can create an AD project on the AD Server.

n Creating an AD project
Follow these steps to create an AD project:
1. On the toolbar of the ADS Administration Tool, click [Create Project].
The Project Creation Dialog Box appears.
2. In the Project Creation Dialog Box, enter the project name and project comment and then
click [OK].
The AD project is created. The created project appears in the list of the ADS Administra-
tion Tool.

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<C1.3 Managing AD projects> C1-37

C1.3.2 Deleting an AD project


You can delete any AD project that was created on the AD Server.

n Deleting an AD project
Follow these steps to delete an AD project:
1. In AD Organizer, unregister the VP project from the AD project that you want to delete.
2. In the ADS Administration Tool, select the project you want to delete.
3. On the toolbar, click [Delete Project].
The Project Delete Confirmation Dialog Box appears.
4. In the Project Delete Confirmation Dialog Box, select the [Yes, I want to delete the proj-
ect.] check box and click [OK].
SEE
ALSO For more information about how to unregister a VP project, refer to:
“n Unregistering a VP project from the AD project” on page B1-11

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<C1.3 Managing AD projects> C1-38

C1.3.3 Modifying AD project properties


You can modify the project name and project comment of any AD project.

n Modifying AD project properties


Follow these steps to modify the properties of an AD project:
1. In the ADS Administration Tool, select the project the properties of which you want to
modify.
2. From the menu bar of the ADS Administration Tool, select [Project] > [Properties].
The Project Property Dialog Box appears.
3. Enter the project name and project comment and then click [OK].

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<C1.3 Managing AD projects> C1-39

C1.3.4 Exporting AD projects


When exporting an AD project, you can select whether to export only the latest data or to also
include revision history information together with the data.

n Exporting AD projects
Follow these steps to export an AD project:
1. In the ADS Administration Tool, select the AD project you want to export.
2. From the menu bar of the ADS Administration Tool, select [Project] > [Export].
The Project Export Confirmation Dialog Box appears.
3. In the Project Export Confirmation Dialog Box, click [OK].
The Project Export Dialog Box appears.
4. In the Project Export dialog box, specify [Output Path], and enter the information for
[Comment] and [Password]. To include the revision history information in the export file,
select [Includes Revision History information] check box. To back up the latest VP project
to the AD project before backing up the AD project, perform these steps:
a. Select the [Backup System Projects prior to AD Project Export] check box.
b. Click [Select].
The System Project Selection dialog box appears, and the VP projects contained in
the AD project are shown in the list.
c. Select the check box for the VP project for backup, and click [OK].
TIP Even if an error has occurred during backup of a VP project, to proceed with the process for backing up the
next VP project without aborting, select the [Continue even if error occurs in System Project Backup.].

5. In the Project Export Dialog Box, click [OK].


Export of the AD project starts and the Project Export Progress Dialog Box appears.

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<C1.3 Managing AD projects> C1-40

C1.3.5 Importing AD projects


You can import an exported AD project. The AD project database is imported separately from
any AD project that already exists on the import destination computer.

n Importing AD projects
Follow these steps to import an exported AD project:
1. From the menu bar of the ADS Administration Tool, select [Project] > [Import].
The Project Import Confirmation Dialog Box appears.
2. In the Project Import Confirmation Dialog Box, click [OK].
The Project Import Dialog Box appears.
3. In the Project Import Dialog Box, click the folder selection button and select the folder you
wish to import.
The path of the file to be imported appears under [Source File Path] in the Project Import
Dialog Box.
4. Under [Password] in the Project Import Dialog Box, enter the password entered at the
time of export.
5. In the Project Import Dialog Box, click [OK].
6. If an AD project of the same name exists at the import destination, the Project Name
Change Dialog Box appears. In the Project Name Change Dialog Box, change the project
name and click [OK].
Import of the AD project starts and the Project Import Progress Dialog Box appears.
If no AD project of the same name exists at the import destination, import of the AD proj-
ect starts, and the Project Import Progress Dialog Box appears.
7. When the import is complete, restore the VP projects by using AD Organizer.
SEE
ALSO For more information about restoring a VP project, refer to:
“l Restoring a VP project from the AD project” on page B1-12

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<C1.3 Managing AD projects> C1-41

C1.3.6 Prohibiting or canceling the prohibition of AD


project data modifications
You can prohibit or cancel the prohibition of AD project data modifications.

n Prohibiting AD project data modifications


Follow these steps to prohibit modifying AD project data:
1. In the ADS Administration Tool, select the project whose data you want to prohibit modify-
ing.
2. From the menu bar of the ADS Administration Tool, select [Project] > [Freeze/Activate].
The Freeze/Activate Dialog Box appears.
3. In the Freeze/Activate Dialog Box, click [OK].

n Canceling the prohibition of AD project data modifications


Follow these steps to cancel the prohibition of AD project data modification:
1. In the ADS Administration Tool, select the project for which you want to cancel the prohib-
ition of data modification.
2. From the menu bar of the ADS Administration Tool, select [Project] > [Freeze/Activate].
The Freeze/Activate Dialog Box appears.
3. In the Freeze/Activate Dialog Box, click [OK].

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<C1.3 Managing AD projects> C1-42

C1.3.7 Forcibly canceling the checked-out status of


currently checked out files
You can forcibly cancel the checked-out status of all files that are currently checked out by
certain users on certain computers at a time.

IMPORTANT
If you forcibly cancel the checked-out status on the AD Server, the edited contents of the
file(s) currently checked out in AD Organizer are lost. If you need the edited contents, you
must export or check in the file(s) being edited in AD Organizer before you forcibly cancel the
checked-out status on the AD Server.

n Forcibly canceling the checked-out status


Follow these steps to forcibly cancel the checked-out status of a file currently checked out:
1. In the ADS Administration Tool, select the project whose checked-out status you want to
cancel.
2. From the menu bar of the ADS Administration Tool, select [Project] > [Discard Check-out].
The Discard Check-out Dialog Box appears.
3. In the Discard Check-out Dialog Box, click the file whose checked-out status you want to
cancel.
All files that are checked out by the same user are selected.
TIP Forcible cancellation of the checked-out status is done for each user. If you want to discard check-out for
each file, discard check-out in AD Organizer.

4. In the Discard Check-out Dialog Box, click [Discard Check-out].


SEE
ALSO For more information about how to discard check-out in AD Organizer, refer to:
“■ Discard check-out” in B4.2.1, “Check-Out” in Automation Design Suite Module-based Engineering
Vol.1 (IM 33J10A15-01EN)

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<C1.4 Setting user security for AD projects> C1-43

C1.4 Setting user security for AD projects


User security consists of "user role" and "access scope." Access control can be implemented
by defining a user role and access scope and then applying the defined user role and access
scope to a Windows user or group.
TIP • If the name of the computer with AD Server is identical to the name of the domain to which the computer
belongs, a user who tries to access the AD Server from AD Organizer is regarded as a local user even if
the user is a member of the domain.
• When you change Windows user settings, such as the password or the group to which a user belongs,
the change may not be reflected immediately. If this happens, log off from the computer where AD Or-
ganizer is installed and log on again. Logging off and on is not required on the computer with AD Server.
If you are a domain user, you must log off and on twice.

n Flow of setting user security


The flow of user security setting includes defining a customizable user role, defining an ac-
cess scope, and then applying the defined user role and access scope to a Windows user or
group.
The following figure shows the flow of setting user security.

Start

Define customizable user roles Define in the User Role Definition dialog box

Define access scopes Define in the Access Scope Definition dialog box

Apply defined customizable


user roles and access scopes Apply in the Access Permission Definition dialog box
to Windows users or groups

End

Figure C1.4-1 Flow of setting user security

l Access Permission Definition Dialog Box


Apply a user role and access scope to a Windows user or group in the Access Permission
Definition Dialog Box. The Access Permission Definition Dialog Box is called from the ADS
Administration Tool.
The Access Permission Definition Dialog Box shows a list of Windows users and groups as
well as user roles and access scopes applied to them. There are also buttons to call the User
Role Definition Dialog Box for defining a user role and the Access Scope Definition Dialog
Box for defining an access scope.

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<C1.4 Setting user security for AD projects> C1-44

Figure C1.4-2 Access Permission Definition Dialog Box

l User Role Definition Dialog Box


Define custom user roles in the User Role Definition Dialog Box. The User Role Definition
Dialog Box is called from the Access Permission Definition Dialog Box.

Figure C1.4-3 User Role Definition Dialog Box

l Access Scope Definition Dialog Box


Define access scopes in the Access Scope Definition Dialog Box. The Access Scope Defini-
tion Dialog Box is called from the Access Permission Definition Dialog Box.

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<C1.4 Setting user security for AD projects> C1-45

Figure C1.4-4 Access Scope Definition Dialog Box

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<C1.4 Setting user security for AD projects> C1-46

C1.4.1 Defining customizable user roles


Define customizable user roles in the User Role Definition Dialog Box.

n Defining a customizable user role


Follow these steps to define a customizable user role:
1. In the ADS Administration Tool, select the project to which you want to apply access con-
trol.
2. On the toolbar, click [Access Control].
The Access Permission Definition Dialog Box appears.
3. In the Access Permission Definition Dialog Box, click [All User Role].
The User Role Definition Dialog Box appears.
4. On the toolbar, click [Add User Role].
The Add User Role Dialog Box appears.
5. Enter a user role name consisting of up to 20 characters. A user role name can contain
single-byte alphanumeric characters, single-byte space and single-byte period.
6. Click [OK].
A column for a new user role is added to the User Role Definition Dialog Box.
7. Specify access rights. By default, full control is set. Select desired access rights on ob-
jects from the drop-down list. Specify desired access rights on functions by using the ap-
plicable check box.
8. In the User Role Definition Dialog Box, click [OK].
TIP • To change a customizable user role name, right-click on the user role name and then select [Edit User
Role Name].
• To delete a customizable user role, select the user role name and click [Delete User Role] on the toolbar.
• To duplicate an existing user role, right-click on the user role name and select [Duplicate User Role].

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<C1.4 Setting user security for AD projects> C1-47

C1.4.2 Defining access scopes


Define access scopes in the Access Scope Definition Dialog Box.

n Define an access scope


Follow these steps to define an access scope:
1. In the ADS Administration Tool, select the project for which you want to implement access
control.
2. On the toolbar, click [Access Control].
The Access Permission Definition Dialog Box appears.
3. In the Access Permission Definition Dialog Box, click [All Access Scope].
The Access Scope Definition Dialog Box appears.
4. On the toolbar, click [Add Access Scope].
The Add Access Scope Dialog Box appears.
5. Enter an access scope name consisting of up to 20 characters. An access scope name
can contain single-byte alphanumeric characters, single-byte space and single-byte peri-
od.
6. Click [OK].
A column for a new access scope is added to the Access Scope Definition Dialog Box.
7. Define access rights for each folder or file. The default is the same rights as those consti-
tuting All Scope. Select desired access rights from the drop-down list.
Selecting [Inheritance of Access Permission] from the drop-down list defines the same
rights as those applied to the selected folder, for all folders and files under that folder.
8. In the Access Scope Definition Dialog Box, click [OK].
TIP • To change an access scope name, right-click on the access scope name and select [Edit Access Scope
Name].
• To delete an access scope, select the access scope name and click [Delete Access Scope] on the tool-
bar.
• To duplicate an existing access scope, right-click on the access scope and select [Duplicate Access
Scope].
• If you click [OK] or [Apply] in the Access Scope Definition Dialog Box while check-in is being performed
by another user, your operation on the access scope definition may fail with a warning message. If this
happens, wait until the check-in is complete and then click [OK] or [Apply] in the Access Scope Definition
Dialog Box.

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<C1.4 Setting user security for AD projects> C1-48

C1.4.3 Setting security for Windows users


Apply defined user roles and access scopes to Windows users or groups. Set user security in
the Access Permission Definition Dialog Box.

n User security setting


Follow these steps to set security for a Windows user or group:
1. In the ADS Administration Tool, select the project for which you want to implement access
control.
2. On the toolbar, click [Access Control].
The Access Permission Definition Dialog Box appears.
3. On the toolbar, click [Add User].
A line to add a user is added in the Access Permission Definition Dialog Box.
4. Enter a Windows user name or group name consisting of up to 36 characters. To register
a local user or local group, enter the user name or group name. To register a domain user
or domain group, enter the name in this format: domain name\user name or domain
name\group name. For the Standard or Strengthened IT security model, specify all users
that belong to the following groups:
• CTM_ENGINEER
• CTM_ENGINEER_ADM
• CTM_MAINTENANCE
• CTM_MAINTENANCE_LCL
You can also preregister a user not yet registered to Windows. In this case, enter a name
according to the Windows naming rules.
5. Select the desired user role from the drop-down list. You can select multiple user roles.
By default, VP Lead Engineer and RS Lead Engineer are selected.
6. Select the desired access scope from the drop-down list. You can select only one access
scope. All Scope is selected by default.
7. In the Access Permission Definition Dialog Box, click [OK].
TIP • To change a user name, select the cell containing the user name and change the name.
• To delete a user, select the user name and click [Delete User] on the toolbar.

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<C1.5 Notes on concurrent use of access control for AD projects and Access Administrator Package (FDA : 21
CFR Part 11 compliant) or Access Control Package for VP projects> C1-49

C1.5 Notes on concurrent use of access control


for AD projects and Access Administrator
Package (FDA : 21 CFR Part 11 compliant)
or Access Control Package for VP projects
You can use access control for AD projects together with the Access Administrator Package
(FDA : 21 CFR Part 11 compliant) or Access Control Package for VP projects. There are sev-
eral points you should note when using them together.
TIP In this document, access control for VP projects by using the Access Administrator Package (FDA : 21 CFR
Part 11 compliant) or Access Control Package is referred to as "VP Access Control."

n Notes on the authentication mode


The method of checking access rights varies depending on whether access control for AD
projects is used together with VP Access Control. The following table shows the difference in
operations based on whether the two are used together or not.

Table C1.5-1 Difference in operations


Used together Operation
Yes Access rights are checked based on the AND of access rights under access control
for AD projects and access rights under VP Access Control.
No Access rights are checked only based on access control for AD projects.

n Correspondence between access rights under access control for AD


projects and those under VP Access Control
A user attempting to perform an operation can perform the operation only when the user has
an applicable access right under access control for AD projects and also under VP Access
Control.
The following table shows the correspondence between access rights under access control
for AD projects and those under VP Access Control.

Table C1.5-2 Correspondence of access rights


Access rights under ac- Access rights under VP Remarks
cess control for AD proj- Access Control
ects
RWAD Right to create Able to create new files or delete existing files in
System View.
RWAD Right to write Able to read/write and save existing files.
R Right to read Able to read existing files.

n Performing access control based on only VP Access Control


In the AD Suite, you can perform access control based only on VP Access Control. In this
case, all access rights under the VP project are set to RWAD. This setting is applied to each
user and group.

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


Blank Page
<C2. History management> C2-1

C2. History management


AD Suite saves the revision history in chronological order of all the changes that users make
to engineering data. This makes it possible to trace changes and also to spot check past
points of time, in order to understand which changes had been made and the state of system
information active at any given point in time.

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<C2.1 Overview of history management> C2-2

C2.1 Overview of history management


All history management data that is checked in from AD Organizer or is entered in the build-
ers that are started from System View, is saved to the ADMDB. Since the data is recorded at
the time of check-in, the user can reference or extract whatever data was checked in at any
point in time in the past. Historical differences can also be displayed to see the difference be-
tween the data at one point in time versus the data at a different point in time. History man-
agement is performed in AD Organizer and by a separate manager in System View.

n Functional composition of history management


History management consists of the following three functions:
• Saving Change Sets
• Setting labels
• Displaying revision history

l Saving Change Sets


In engineering using AD Organizer, files that are checked in at the same time are grouped to-
gether as a set. This grouped set of files is referred to as a "Change Set."
In engineering using System View, any builder files that are downloaded or overwritten are
saved to the VP project. At that time, the applicable builder files are also saved to the ADMDB
as a Change Set.
A unique number is assigned to each Change Set. This number is referred to as the "Change
Set ID." Change Set IDs are automatically assigned by AD Server. You can associate a
Change Set with a ModPack.
SEE
ALSO For more information about ModPack, refer to:
B., “Change management” in Automation Design Suite Optional Functions (IM 33J10A20-01EN)

l Setting labels
You can define any string as a label for the latest of the chronologically saved files on AD
Server. You can search for files by label in the Check-in window.
Some labels are set by the user, while other labels are set automatically by the system. When
any of the following operations is performed, a label is automatically set by the system:
• Engineering in System View
A label is automatically assigned to the Change Set following a successful download or
save operation in the VP builders.

l Displaying the Revision History


Change Sets and labels that have been saved can be displayed in the Revision History win-
dow of AD Organizer.

n History management for AD Organizer and System View


History management for AD Organizer is performed automatically. History management for
System View, however, can be started or stopped by the user.

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<C2.2 Starting AD Organizer> C2-3

C2.2 Starting AD Organizer


The Revision History window, which shows the revision history and labels, is opened from AD
Organizer.

n Starting AD Organizer
Follow these steps to start AD Organizer:
1. Log on to a computer with system builders. If the IT security model is the standard model
or the strengthened model, log on to an account that belongs to one of these groups:
CTM_ENGINEER, CTM_ENGINEER_ADM, CTM_MAINTENANCE, or CTM_MAINTE-
NANCE_LCL.
2. Start AD Organizer.

Figure C2.2-1 AD Organizer

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<C2.3 Setting labels> C2-4

C2.3 Setting labels


Labels are set in the tree view of each navigator in AD Organizer.

n Setting labels
You can set labels for folders and files that are shown in the tree view of each navigator of AD
Organizer.
Labels can be created in two ways: Batch labeling for all of the folders and files in the tree
view, or individual labeling for specific folders or files.
SEE
ALSO For more information about how to change and delete a set label, refer to:
C2.4.4, “Displaying label details” on page C2-12

l Batch labeling
Follow these steps to batch label all files and folders:
1. In AD Organizer, open a navigator. You can assign labels to all of the folders or files
shown in the tree view of this navigator.
2. On the toolbar, click [Sub Menu] and select [Add Label to All].
The Label dialog box appears.
3. In the Label dialog box, enter a label name and label comment.
The label name can contain up to 100 double-byte or single-byte characters, while a label
comment can contain up to 1000 double-byte or single-byte characters.
4. In the Label dialog box, click [OK].
The label is assigned to each of the folders and files shown in the tree view of the naviga-
tor.

l Setting labels individually


Follow these steps to assign labels individually:
1. In the tree view of the navigator, select the folder or file to which you want to assign a
label.
2. On the toolbar, click [Sub Menu] and select [Add Label].
The Label dialog box appears.
TIP To display the Label dialog box, you can also right-click the mouse and select [Add Label].

3. In the Label dialog box, enter a label name and label comment.
The label name can contain up to 100 double-byte or single-byte characters, while a label
comment can contain up to 1000 double-byte or single-byte characters.
4. In the Label dialog box, click [OK].
The label is assigned to the folder or file that is selected in the tree view of the navigator.

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<C2.4 Displaying the revision history and labels> C2-5

C2.4 Displaying the revision history and labels


The Revision History window enables you to view the revision history and labels. In the Revi-
sion History window you can perform the following tasks:
• Displaying a list view and detail view of Change Sets
• Displaying a list view and detail view of files
• Displaying a list view and detail view of labels, modifying labels, and deleting labels
• Displaying engineering data associated with Change Sets
• Associating ModPacks with Change Sets
• Comparing the details of engineering data

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<C2.4 Displaying the revision history and labels> C2-6

C2.4.1 Displaying the Revision History window


The Revision History window consists of the Revision History tab and Labels tab. On the Re-
vision History tab, you can view a list of Change Sets and call up the dialog box for showing
the details of a Change Set. On the Label tab, you can view a list of labels and call up the
dialog box for showing the details of a label. You can also change and delete labels. When
the Revision History window appears, the Revision History tab appears by default.

n Opening the Revision History window


Follow these steps to open the Revision History window:
1. Starting AD Organizer
2. In an AD Organizer navigator, right-click a folder or file and select [View Revision History].
TIP If you select a folder that is editable by VP builders in the System Structure Navigator, the Revision History
dialog box appears. In the Revision History dialog box, you can specify the names of folders and files that are
editable by VP builders. The Revision History window shows the revision history of the folders and files that
you specify in this dialog box.
Note that the folder names and file names you specify in the Revision History dialog box are case-sensitive.

Figure C2.4.1-1 The Revision History window (Revision History tab)

Figure C2.4.1-2 The Revision History window (Labels tab)

n Filtering Change Sets displayed on the Revision History tab


By default, latest 100 Change Sets are displayed on the Revision History tab. You can filter
Change Sets to be displayed on the Revision History tab in the following two ways.
• Filter by ranges of Change Sets
• Filter by dates of Change Sets

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<C2.4 Displaying the revision history and labels> C2-7

l Filtering by specifying a range of Change Sets


Follow these steps to specify the range of Change Sets to be displayed on the Revision Histo-
ry tab:
1. On the toolbar, click [Specify Range].
The Specify Range dialog box appears.

Figure C2.4.1-3 Specify Range dialog box (Change Set tab)

2. Select the [Change Set] tab.


TIP By default, the Change Set tab is selected.

3. Enter the range of the Change Sets to be displayed, and click [OK].

l Filtering by dates of Change Sets


Follow these steps to specify the date of Change Sets to be displayed on the Revision History
tab:
1. On the toolbar, click [Specify Range].
The Specify Range dialog box appears.
2. Select the [Date] tab.

Figure C2.4.1-4 Specify Range dialog box (Date tab)

3. Enter the date range of the Change Sets to be displayed, and click [OK].

n Items displayed in the Revision History window


The Revision History window consists of the Revision History tab and Label tab.

l Items displayed on the Revision History tab


The following table shows the items that are displayed on the Revision History tab of the Re-
vision History window.

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<C2.4 Displaying the revision history and labels> C2-8
Table C2.4.1-1 Items displayed on the Revision History tab of the Revision History window
Item Description Remarks
Change Set The Change Set ID is displayed.
User The name of the user who checked in the
files is displayed.
Date The date and time of check-in is dis-
played.
Comment The check-in comment is displayed.
ModPack ID The ModPack ID of the ModPack that is Association with a ModPack is performed
associated with the Change Set is dis- at check-in. You can also associate a
played. ModPack with a Change Set in the Revi-
sion History window.

l Items displayed on the Label tab


The following table shows the items displayed on the Label tab of the Revision History win-
dow.

Table C2.4.1-2 Items displayed in the Label tab of the Revision History window
Item Description
Name The label name is displayed.
User The name of the user who set the label is displayed.
Date The date and time when the label was set is displayed.
Comment The label comment is displayed.

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<C2.4 Displaying the revision history and labels> C2-9

C2.4.2 Displaying Change Set details


You can display the details for a Change Set in the Change Set Detail dialog box that is called
up from the Revision History window.
In the Change Set Detail dialog box, you can display the details for individual files in the
Change Set, and modify the check-in comment.

n Displaying Change Set details


Follow these steps to display the details of a Change Set:
1. On the Revision History tab of the Revision History window, select the Change Set for
which you want to display details.
2. On the toolbar, click [Details].
The Change Set Detail dialog box appears.

Figure C2.4.2-1 Change Set Detail dialog box

l Items displayed in the Change Set Detail dialog box


The following table shows the items displayed in the Change Set Detail dialog box.

Table C2.4.2-1 Items displayed in the Change Set Detail dialog box
Item Description Remarks
Change Set The Change Set ID is displayed.
User The name of the user who checked in the
files is displayed.
Date The date and time of check-in is displayed.
Continues on the next page

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<C2.4 Displaying the revision history and labels> C2-10
Table C2.4.2-1 Items displayed in the Change Set Detail dialog box (Table continued)
Item Description Remarks
ModPack ID The ModPack ID of the ModPack associated Clicking the ModPack ID opens the Mod-
with this Change Set is displayed. Pack.
Data The names of individual files constituting the To start the editor for editing the file, right-
Change Set are displayed. click on a file and select [Launch Editor]. You
can also select [View Revision History] from
the right-click menu to display the revision
history of the file.
Change The type of change is displayed.
Added, Modified, or Deleted is displayed.
Path The file path is displayed.
Comment The check-in comment is displayed. You can change the check-in comment. After
editing the check-in comment, click [Save] to
save the edited check-in comment.

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<C2.4 Displaying the revision history and labels> C2-11

C2.4.3 Displaying a list view and detail view of files


You can display the list view of files in the file list pane of the Revision History window. When
the Revision History window appears, files under the folder selected in the navigator are lis-
ted. You can also filter the list of displayed files.

n Displaying the file list pane


Follow these steps to display the file list pane in the Revision History window.
• On the toolbar in the Revision History window, click [File List].
The file list pane appears in the Revision History window.
TIP • Repeat this operation to show and hide the file list pane.
• The files in the list are displayed in order of check-in date and file path.

Specify Range File List button


button

File list pane

Figure C2.4.3-1 Revision History window showing the file list pane

n Filtering Change Sets by selecting a file


You can select a file in the file list pane to display only the Change Sets that include the file.
Follow these steps to select a file and filter Change Sets.
• Select a file in the file list pane.
Only Change Sets that include the selected file are displayed in the Revision History win-
dow. If the selected file is not included in any Change Set, no Change Set is displayed.

l Clearing a filter that applies to Change Sets


Follow these steps to clear a filter that applies to Change Sets.
• Select the file in the file list pane while holding down the [Ctrl] key.

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<C2.4 Displaying the revision history and labels> C2-12

C2.4.4 Displaying label details


You can display the details of a label in the Label Detail dialog box that is called up from the
Revision History window.
In the Label Detail dialog box, you can display the list of files and folders that have the selec-
ted label assigned to them, and you can also change the label comment.

n Displaying the details of a label


Follow these steps to display the details of a label:
1. On the Labels tab of the Revision History window, select the label for which you want to
display details.
2. On the toolbar, click [Details].
The Label Detail dialog box appears.

Figure C2.4.4-1 Label Detail dialog box

l Items displayed in the Label Detail dialog box


The following table shows the items displayed in the Label Detail dialog box.

Table C2.4.4-1 Items displayed in the Label Detail dialog box


Item Description Remarks
Label name The label name is displayed.
Creator The name of the user who set the
label is displayed.
Date of creation The date and time when the label
was set is displayed.
Continues on the next page

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<C2.4 Displaying the revision history and labels> C2-13
Table C2.4.4-1 Items displayed in the Label Detail dialog box (Table continued)
Item Description Remarks
Data The names of the folders and files To start the editor for editing the file, right-click on a
for which the selected label is set file and select [Launch Editor] You can also select
are displayed. [View Revision History] from the right-click menu to
display the revision history of the file.
Path The folder or file path is displayed.
Comment The label comment is displayed. You can change the label comment. After editing the
label comment, click [Save] to save the edited label
comment.

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<C2.4 Displaying the revision history and labels> C2-14

C2.4.5 Associating ModPacks with Change Sets


You can associate a ModPack with any of the Change Sets that are displayed on the Revision
History tab of the Revision History window.
TIP You need the Change Management Package to use ModPacks.

SEE
ALSO For more information about ModPack, refer to:
B., “Change management” in Automation Design Suite Optional Functions (IM 33J10A20-01EN)

n Associating a ModPack with a Change Set


Follow these steps to associate a ModPack with a Change Set:
1. On the Revision History tab of the Revision History window, select the Change Set that
you want to associate with a ModPack.
2. On the toolbar, click [Assign ModPack].
The Associate ModPack dialog box appears.

Figure C2.4.5-1 Associate ModPack dialog box

3. In the ModPack list view area, select the ModPack to associate and click [OK].
The ModPack ID of the associated ModPack appears on the Revision History tab of the
Revision History window.

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<C2.4 Displaying the revision history and labels> C2-15
TIP • You can select only one ModPack in the Associate ModPack dialog box.
• To cancel association with the ModPack, click [Unassign] in the Associate ModPack dialog box.

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<C2.4 Displaying the revision history and labels> C2-16

C2.4.6 Comparing the details of engineering data


You can use the Compare editor to compare engineering data at two different points in time.

Figure C2.4.6-1 Example of the Compare editor view

n Types of comparison supported by the Compare editor


In the Compare editor, you can compare the following files:
• Comparing the file that is currently checked out against the file that was last saved to the
ADMDB
• Comparing files that were saved at two different points in the past

l Comparing the file currently checked out and the latest file saved in the
ADMDB
Select a file in the Check-in window and start the Compare editor to automatically check the
file currently checked out on the local computer against the latest file saved to the ADMDB.
The editor window of the latest file saved to the ADMDB appears on the left side, while the
editor window of the file currently checked out appears on the right side of the Compare edi-
tor. You can edit the file currently checked out.

l Comparing files saved at two different points in the past


In the Revision History window, select files saved at two points in time and start the Compare
editor, to automatically compare the two selected files.
Alternatively, to automatically compare the selected file and the file currently checked out on
the local computer, if any, select only one file in the Revision History window and then start
the Compare editor. If no file is currently checked out, the selected file is compared against
the latest file saved to the ADMDB.
The editor window of the older file appears on the left side, while the editor window of the
newer file appears on the right side of the Compare editor. If the newer file is currently
checked out, you can edit the file.
TIP To select a file in the Revision History window, select Revision History on the Revision History tab or select
Label on the Label tab.

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<C2.4 Displaying the revision history and labels> C2-17

n Starting the Compare editor


Follow these steps to start the Compare editor:
1. Display the Revision History window.
2. Display the revision history in the Revision History Window.
3. In the Revision History window, select the file(s) to compare.
You can select one or two files. To select the second file, select the file while holding
down the [Ctrl] key.
4. On the toolbar, click [Comparison].

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<C2.5 Managing the revision history of VP projects> C2-18

C2.5 Managing the revision history of VP


projects
Use the Revision History Utility to manage the revision history of VP projects. The Revision
History Utility is a tool for starting and stopping the history management and updating the revi-
sion history of VP projects.
TIP Only Windows users who have both the following access rights can start, stop, or update revision histories:
• RWAD rights for all files under the target VP project
• The right to run the Revision History Utility, which is granted in the access control setting of the AD proj-
ect

n Window structure of the Revision History Utility


The following figure shows the window layout of the Revision History Utility.

Figure C2.5-1 Window structure of the Revision History Utility

l Items displayed in the Revision History Utility


The following table shows the items that are displayed in the Revision History Utility.

Table C2.5-1 Items displayed in the Revision History Utility


Item Description Remarks
System Project A list of the VP projects that are regis- Only the VP projects shown in AD Organ-
tered to the AD project is displayed. They izer on the local computer are displayed.
are displayed in the same order as in the
tree view of System View.
Status The status of history management is dis-
played. There are two statuses: Running
and Stopped.
• Running
History management is active for the
VP project.
• Stopped
History management is inactive for the
VP project.
Continues on the next page

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<C2.5 Managing the revision history of VP projects> C2-19
Table C2.5-1 Items displayed in the Revision History Utility (Table continued)
Item Description Remarks
Difference If an error occurs for some reason while If Difference is [Yes], click [Start] or [Up-
saving a file to the ADMDB, a difference date] in the Revision History Utility to
may occur between the ADMDB and VP eliminate the difference. When the differ-
project database. Whether or not this dif- ence is successfully eliminated, the text
ference exists is displayed. changes to [No].
• Yes
There may be a file that could not be
saved to the ADMDB.
• No
There are no files that could not be
saved to the ADMDB.

n Starting the Revision History Utility


Follow these steps to start the Revision History Utility:
1. In AD Organizer, open the System Structure Navigator.
2. On the toolbar, click [Sub Menu] and select [CENTUM VP] > [Revision History Utility].

n Starting revision history management for a VP project


Follow these steps to start history management for a VP project:
1. Start the Revision History Utility.
2. Select the VP project for which you want to start history management.
3. Click [Start] in the Revision History Utility.
History management starts for the selected VP project. If Difference is [Yes], history man-
agement for the VP project starts only after the difference is eliminated.

n Stopping revision history management of a VP project


Follow these steps to stop history management of a VP project.
1. Start the Revision History Utility.
2. Select the VP project for which you want to stop history management.
3. Click [Stop] in the Revision History Utility.

n Eliminating file differences


Differences may occur between the ADMDB and the VP project database due to a communi-
cation error, or some other reason. You can eliminate these differences. Follow these steps to
eliminate any differences:
1. Start the Revision History Utility.
2. Select the VP project for which you want to eliminate differences.
3. Click [Update] in the Revision History Utility.
The differences are eliminated and the text under Difference changes to [No].

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<C2.6 Operations and the files used in revision history management> C2-20

C2.6 Operations and the files used in revision


history management
History management uses different files in engineering using AD Organizer versus engineer-
ing using System View.

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<C2.6 Operations and the files used in revision history management> C2-21

C2.6.1 Operations that update the files in AD Organizer


When you perform engineering work in AD organizer, the files are saved to the ADMDB at
certain timing in order to manage the revision history.

n Timing of saving to the ADMDB


When you perform engineering work by using AD organizer, the files are saved to the ADMDB
at the following two times to manage the revision history:
• At check-in
• At VP generation

n Files that are the target of history management


In AD organizer, all files that can be checked in are the target( of history management.

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<C2.6 Operations and the files used in revision history management> C2-22

C2.6.2 Operations that update the files in System View


When you perform engineering work by using System View, the files are saved to the ADMDB
through menu and object operations to manage a revision history. For some operations, a la-
bel is automatically generated for the target file, so that operation can be recorded.

n Operations where the files are saved


In System View, some menu and object operations cause files to be saved.

l Menu operations
The following table shows a list of menu operations in System View where the files are saved.

Table C2.6.2-1 Menu operations where the files are saved


Menu operations Saves a Remarks
file (*1)
File Create New (*2)
Open No
Import Window Hierarchy No
Export Window Hierarchy No
Delete (*2)
Properties (*2)
Print Preview No
Print No
Exit System View No
Edit Cut (*2)
Copy (*2)
Paste (*2)
Paste Shortcut (*2)
Move Upward (*2)
Move Downward (*2)
View Toolbar No
Status Bar No
Message Display Area No
Large Icon No
Small Icon No
List No
Details No
Arrange Icons No
All control drawing display No
Refresh No
Continues on the next page

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<C2.6 Operations and the files used in revision history management> C2-23
Table C2.6.2-1 Menu operations where the files are saved (Table continued)
Menu operations Saves a Remarks
file (*1)
Tools Builder Quick Start No
Check for Double-Defined Tags No
Reference All Elements/Tags No
Self Document Printing No
Print Parameters No
Search by Name No
Plant Hierarchy Viewer No
Logging No
Status Display Setting No
Environment Setting No
Tuning Parameter Saving Yes
Offline Loading No (*3)
Generate Host File No
Pre-check before downloading No
Block Parameter Validation No
Upload All Yes (*3)
Download All Yes Initial load only
(*3)
Device Panel No In the case of software download, the
files are saved by history management.
When a device on the FF-H1 bus is se-
lected and equalized or registered, the
files are saved in the Fieldbus Builder.
Software Download No If fieldbus devices are registered, the files
are saved in the Fieldbus Builder.
Pre-check before downloading PROFIBUS No
communication settings
Save PROFIBUS communication settings Yes The files are saved when the VP project
has the attribute of default project or
user-defined project.
(*3)
Download PROFIBUS communication set- Yes The files are saved when the VP project
tings has the attribute of current project.
HIS Database Conversion Tool No
Linked Part Updating No
Control Drawing Smart-Parts Manager No The files are saved in the Control Draw-
ing Builder when "Download" or "Save" is
selected in the Linked Part Updating dia-
log box.
Data Exchange No
SCS Taglist Import No
Set Backup No
Start Backup No
FCS Database Diagnosis Tool No
Audit Trail DB Viewer No
Continues on the next page

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<C2.6 Operations and the files used in revision history management> C2-24
Table C2.6.2-1 Menu operations where the files are saved (Table continued)
Menu operations Saves a Remarks
file (*1)
Load Download Project Common Section No (*3)
Download to IOM No
Save FCS Tuning Parameter Yes
Offline Download to FCS No FCS offline download after saving the
tuning parameters is assumed.
(*3)
Download to HIS No (*3)
Download Tag-List No
Download Status Display File No (*3)
Offline Download to BCV No (*3)
Download Tag-List/Gateway Information No
Save BCV Operation Mark No
Download to CGW No (*3)
Download Common Block No (*3)
Project Open Project No
Close Project No
Resolve Invalid Element No
FCS Error Check No
Resource Information No
Test Function No
All Generation Yes
HIS Virtual HIS No
UACS UACS Simulator No
Help Using the Online Manual No
Engineering Tutorial No
Builder Definition Items No
Version Information No
Other Domain Properties Yes
opera-
tion Revising project No Revision upgrade operation when starting
System View.
Starting PROFIBUS-DP Configurator No
Starting PROFINET Configurator No
*1: Yes: The file is saved.
No: The file is not saved or not applicable to history management.
*2: Varies depending on the type of object.
*3: There are some specification differences with history management in VP Access Control. For example, AD Suite may save a
file for history management but VP Access Control does not save any file for history management, or there may be other
specification differences.

l Operations on objects
The following table shows a list of object operations in System View where the files are saved.

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<C2.6 Operations and the files used in revision history management> C2-25
Table C2.6.2-2 Object operations where the files are saved
Object and operation on the Saves a file Remarks
object (*1)
Project Create New No Not applicable because history management is not yet
started with a new project.
Delete No Not applicable because a VP project registered to an AD
project cannot be deleted.
Properties Yes (*2)
Copy No Not applicable because the VP project is not yet registered
to the AD project immediately after copying.
FCS Create New Yes (*2)
Delete Yes StnConf.edf is saved.
(*2)
Properties Yes
Copy Yes (*2)
HIS Create New Yes (*2)
Delete Yes StnConf.edf is saved.
(*2)
Properties Yes (*2)
Copy Yes (*2)
BCV Create New Yes (*2)
Delete Yes StnConf.edf is saved.
(*2)
Properties Yes
CGW Create New Yes (*2)
Delete Yes StnConf.edf is saved.
(*2)
Properties Yes
SCS Create New Yes
Delete Yes StnConf.edf is saved.
Properties Yes
UACS Create New Yes
Delete Yes StnConf.edf is saved.
Properties Yes
STN Create New Yes
Delete Yes StnConf.edf is saved.
Properties Yes
State Transition Create New Yes History management is managed by a builder.
Matrix
Delete Yes (*2)
Control Draw- Properties Yes (*2)
ing
SEBOL User Create New Yes History management is managed by a builder.
Function
Delete Yes (*2)
SFC Sequence Create New Yes History management is managed by a builder.
Delete Yes (*2)
Continues on the next page

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<C2.6 Operations and the files used in revision history management> C2-26
Table C2.6.2-2 Object operations where the files are saved (Table continued)
Object and operation on the Saves a file Remarks
object (*1)
Unit Procedure Create New Yes History management is managed by a builder.
Delete Yes (*2)
FCS-C Task Create New Yes (*2)
Delete Yes (*2)
User Customiz- Create New Yes (*2)
able Algorithm
Delete Yes (*2)
Copy Yes (*2)
Node Create New Yes
Delete Yes (*2)
Properties Yes
Nest Create New Yes
Delete Yes (*2)
Properties Yes
IOM Create New Yes
Delete Yes (*2)
Properties Yes
IOM Properties Yes ALF111 only
(Port)
Trend Acquisi- Create New Yes (*2)
tion Pen As-
signment Properties Yes (*2)

Window Create New Yes (*2)


Delete Yes The window hierarchy information is saved. (*2)
Properties Yes (*2)
Copy Yes (*2)
Move Yes (*2)
Help Message Create New Yes (*2)
Delete Yes (*2)
Properties Yes (*2)
Copy Yes (*2)
Common Block Create New Yes (*2)
Delete Yes (*2)
Properties Yes (*2)
Recipe Group Create New Yes (*2)
Delete Yes (*2)
Properties No No modifiable item is available.
Continues on the next page

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<C2.6 Operations and the files used in revision history management> C2-27
Table C2.6.2-2 Object operations where the files are saved (Table continued)
Object and operation on the Saves a file Remarks
object (*1)
Shortcut win- Create New Yes (*2)
dow (Paste Short-
cut)
Delete Yes (*2)
Properties Yes (*2)
Copy Yes (*2)
Move Yes (*2)
*1: Yes: The file is saved.
No: The file is not saved or not applicable to history management.
*2: There are some specification differences with history management in VP Access Control. For example, AD Suite may save a
file for history management but VP Access Control does not save any file for history management, or there may be other
specification differences.

n Files that are saved


In System View, files are saved due to menu operations or operations on objects.

l Menu operations
The following table shows the files that are saved as a result of menu operations in System
View.

Table C2.6.2-3 Menu operations


Menu operations File(s) saved Remarks
Tool Tuning Parameter Saving Saved tuning parameter in- (*1)
formation
(both TuningData.txt and tag
name.edf)
Download All ALF111-p.edf Initial load only (*1)
Device tag name.edf
Upload All ALF111-p.edf (*1)
Device tag name.edf
Save/download PROFIBUS ALP121.edf file
communication settings Config.csv file
Load Save FCS Tuning Parameter Saved tuning parameter in- (*1)
formation
(both TuningData.txt and tag
name.edf)
FCS All Generation Files subject to bulk file gen-
eration
Other Domain Properties Domain property information
*1: There are some specification differences with history management in VP Access Control. For example, AD Suite may save a
file for history management but VP Access Control does not save any file for history management, or there may be other
specification differences.

l Operations on Objects
The following table shows the files that are saved as a result of operations on object in Sys-
tem View.

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<C2.6 Operations and the files used in revision history management> C2-28
Table C2.6.2-4 Files saved as a result of operations on objects
Object and operation on the object Information that is saved Remarks
Project Properties Project property information (*1)
FCS Create New, Delete FCS property information (*1)
edf files under FCSddss
Property information under FCSddss
Status display files under FCSddss
StnConf.edf
Copy FCS property information (*1)
edf files under FCSddss
Property information under FCSddss
Status display files under FCSddss
StnConf.edf
Properties FCS property information
StnConf.edf
HIS Create New, Delete HIS property information (*1)
edf files under HISddss
Property information under HISddss
Window hierarchy information
StnConf.edf
Copy HIS property information (*1)
edf files under HISddss
Property information under HISddss
Window hierarchy information
StnConf.edf
Properties HIS property information (*1)
StnConf.edf
BCV Create New, Delete BCV property information (*1)
StnConf.edf
Properties BCV property information
StnConf.edf
CGW Create New, Delete CGW property information (*1)
StnConf.edf
Properties CGW property information
StnConf.edf
SCS Create New, Delete SCS property information (*1)
StnConf.edf
Properties SCS property information (*1)
StnConf.edf
Continues on the next page

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<C2.6 Operations and the files used in revision history management> C2-29
Table C2.6.2-4 Files saved as a result of operations on objects (Table continued)
Object and operation on the object Information that is saved Remarks
UACS Create New, Delete UACS property information (*1)
StnConf.edf
Properties UACS property information (*1)
StnConf.edf
Station Create New, Delete Station property information (*1)
edf files under STNddss
StnConf.edf
Properties Station property information
StnConf.edf
State Transi- Create New, Delete edf file (*1)
tion Matrix
Control Draw- Properties Control drawing property information (*1)
ing
SEBOL User Create New, Delete edf file (*1)
Function
SFC Sequence Create New, Delete edf file (*1)
Unit Procedure Create New, Delete edf file (*1)
FCS-C Task Create New, Delete FCS-C task files (*1)
User Custom- Create New, Delete User-customizable algorithm files (*1)
izable Algo-
rithm Copy User-customizable algorithm files (*1)

Node Create New, Delete Node property information (*1)


Properties Node property information
Nest Create New, Delete Nest property information (*1)
Properties Nest property information
IOM Create New, Delete IOM property information (*1)
edf file
Properties IOM property information
edf file
IOM Properties Port property information Applicable to ALF111 only
(Port)
Trend Acquisi- Create New, Delete Trend pen assignment property infor- (*1)
tion Pen As- mation
signment
edf file
Properties Trend pen assignment property infor- (*1)
mation
edf file
Continues on the next page

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<C2.6 Operations and the files used in revision history management> C2-30
Table C2.6.2-4 Files saved as a result of operations on objects (Table continued)
Object and operation on the object Information that is saved Remarks
Window Create New, Delete Window property information (*1)
edf file
Window hierarchy information
Properties Window property information (*1)
edf file
Copy Window property information (*1)
edf file
Window hierarchy information
Move Window hierarchy information (*1)
Help Message Create New, Delete Help message property information (*1)
edf file
Properties Help message property information (*1)
edf file
Copy Help message property information (*1)
edf file
Common Block Create New, Delete Common block property information (*1)
edf file
Properties Common block property information (*1)
edf file
Recipe Group Create New, Delete Recipe group property information (*1)
edf file
Shortcut win- Create New, Delete Shortcut window property information (*1)
dow
edf file
Window hierarchy information
Properties Shortcut window property information (*1)
edf file
Copy Shortcut window property information (*1)
edf file
Window hierarchy information
Move Window hierarchy information (*1)
*1: There are some specification differences with history management in VP Access Control. For example, AD Suite may save a
file for history management but VP Access Control does not save any file for history management, or there may be other
specification differences.

n Labels
When files are saved as a result of an operation in System View, a label is also saved to the
ADMDB. The label is a character string consisting of the following items:
Program name, operation name, target of the operation

l Menu operations
The following table shows the labels that are saved as a result of menu operations in System
View.

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<C2.6 Operations and the files used in revision history management> C2-31
Table C2.6.2-5 Labels that are saved as a result of menu operations
Menu operations Label (*1)
Program name Operation name Target of operation
File Create New (*2) (*2)
Open No No No
Import Window Hierar- No No No
chy
Export Window Hierar- No No No
chy
Delete (*2) (*2)
Properties (*2) (*2)
Print Preview No No No
Print No No No
Exit System View No No No
Edit Cut (*2) (*2)
Copy (*2) (*2)
Paste (*2) (*2)
Paste Shortcut (*2) (*2)
Move Upward (*2) (*2)
Move Downward (*2) (*2)
View Toolbar No No No
Status Bar No No No
Message Display Area No No No
Large Icon No No No
Small Icon No No No
List No No No
Details No No No
Arrange Icons No No No
All control drawing dis- No No No
play
Refresh No No No
Continues on the next page

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<C2.6 Operations and the files used in revision history management> C2-32
Table C2.6.2-5 Labels that are saved as a result of menu operations (Table continued)
Menu operations Label (*1)
Program name Operation name Target of operation
Tools Builder Quick Start No No No
Check for Double-De- No No No
fined Tags
Reference All Elements/ No No No
Tags
Self Document Printing No No No
Print Parameters No No No
Search by Name No No No
Plant Hierarchy Viewer No No No
Logging No No No
Status Display Setting No No No
Environment Setting No No No
Tuning Parameter Sav- System View Save FCS Tuning Pa- Station name
ing rameter
Generate Host File No No No
Pre-check before down- No No No
loading
Block Parameter Valida- No No No
tion
Upload All System View Upload All I/O module name
Download All System View Download All Path name of the device
tag.edf of the first device
(path name after the sta-
tion name)
Device Panel No No No
Software Download No No No
Pre-check before down- No No No
loading PROFIBUS
communication settings
Save PROFIBUS com- System View Save PROFIBUS com- Selected IOM name
munication settings munication settings (path name after the sta-
tion name)
Download PROFIBUS System View Download PROFIBUS Selected IOM name
communication settings communication settings (path name after the sta-
tion name)
HIS Database Conver- No No No
sion Tool
Linked Part Updating No No No
(update)
Linked Part Updating No No No
(update and download)
Control Drawing Smart- No No No
Parts Manager
Continues on the next page

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<C2.6 Operations and the files used in revision history management> C2-33
Table C2.6.2-5 Labels that are saved as a result of menu operations (Table continued)
Menu operations Label (*1)
Program name Operation name Target of operation
Tools Data Exchange No No No
SCS Taglist Import No No No
Set Backup No No No
Start Backup No No No
FCS Database Diagno- No No No
sis Tool
Audit Trail DB Viewer No No No
Load Download Project Com- No No No
mon Section
Download to IOM No No No
Save FCS Tuning Pa- System View Save FCS Tuning Pa- Station name
rameter rameter
Offline Download to FCS No No No
Download to HIS No No No
Download Tag-List No No No
Download Status Dis- No No No
play File
Offline Download to BCV No No No
Download Tag-List/Gate- No No No
way Information
Save BCV Operation No No No
Mark
Download to CGW No No No
Download Common No No No
Block
Project Open Project No No No
Close Project No No No
Resolve Invalid Element No No No
FCS Error Check No No No
Resource Information No No No
Test Function No No No
All Generation System View All Generation Station name
HIS Virtual HIS No No No
UACS UACS Simulator No No No
Help Using the Online Manual No No No
Engineering Tutorial No No No
Builder Definition Items No No No
Version Information No No No
Other Domain Properties System View Change Domain Proper- Domain number
opera- ties
tion
*1: No: Either the label is not saved, or the operation is not applicable to history management.
*2: Varies depending on the type of the object that is the target of the menu operation.

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<C2.6 Operations and the files used in revision history management> C2-34
SEE
ALSO For more information about the label that is saved due to a menu operation in System View that does not
cause changes to file, refer to:
“n Labels that are saved as a result of menu operations in System View” on page C2-47

l Operations on Objects
The following table shows the labels that are saved as a result of operations on objects in
System View.

Table C2.6.2-6 Labels that are saved as a result of operations on objects


Object and operation on the ob- Label(*1)
ject Program name Operation name Target of operation
Project Create New No No No
Delete No No No
Properties System View Project property modifi- Project name
cation
Copy No No No
FCS Create New System View FCS creation Station name
Delete System View FCS deletion Station name
Properties System View FCS property modifica- Station name
tion
Copy System View FCS copy Name of station to copy
to
HIS Create New System View HIS creation Station name
Delete System View HIS deletion Station name
Properties System View HIS property modifica- Station name
tion
Copy System View HIS copy Name of station to copy
to
BCV Create New System View BCV creation Station name
Delete System View BCV deletion Station name
Properties System View BCV property modifica- Station name
tion
CGW Create New System View CGW creation Station name
Delete System View CGW deletion Station name
Properties System View CGW property modifica- Station name
tion
SCS Create New System View SCS creation Station name
Delete System View SCS deletion Station name
Properties System View SCS property modifica- Station name
tion
UACS Create New System View UACS creation Station name
Delete System View UACS deletion Station name
Properties System View UACS property modifica- Station name
tion
Continues on the next page

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<C2.6 Operations and the files used in revision history management> C2-35
Table C2.6.2-6 Labels that are saved as a result of operations on objects (Table continued)
Object and operation on the ob- Label(*1)
ject Program name Operation name Target of operation
STN Create New System View STN creation Station name
Delete No No No
Properties System View STN property modifica- Station name
tion
State Transi- Create New State Transition Create New Matrix name
tion Matrix Matrix Builder
Delete System View State transition matrix Matrix name
deletion
Control draw- Properties System View Control drawing property Drawing name
ing modification
SEBOL User Create New SEBOL User Create New Function name (path af-
Function Function Builder ter the station name)
Delete System View SEBOL User Function Function name (path af-
deletion ter the station name)
SFC Se- Create New SFC Sequence Create New Sequence name (path
quence Builder after the station name)
Delete System View SFC sequence deletion Sequence name (path
after the station name)
Unit Proce- Create New Unit Procedure Create New Procedure name (path
dure Builder after the station name)
Delete System View Unit procedure deletion Procedure name (path
after the station name)
FCS-C Task Create New System View FCS-C task creation Task name (path after
the station name)
Delete System View FCS-C task deletion Task name (path after
the station name)
User Custom- Create New System View User-customizable algo- Program name (path af-
izable Algo- rithm creation ter the station name)
rithm
Delete System View User customizable algo- Program name (path af-
rithm deletion ter the station name)
Copy System View User-customizable algo- Program name (path af-
rithm copy ter the station name)
Node Create New System View Node creation Node name (path after
the station name)
Delete System View Node deletion Node name (path after
the station name)
Properties System View Node property modifica- Node name (path after
tion the station name)
Nest Create New System View Nest creation Nest name (path after
the station name)
Delete System View Nest deletion Nest name (path after
the station name)
Properties System View Nest property modifica- Nest name (path after
tion the station name)
Continues on the next page

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<C2.6 Operations and the files used in revision history management> C2-36
Table C2.6.2-6 Labels that are saved as a result of operations on objects (Table continued)
Object and operation on the ob- Label(*1)
ject Program name Operation name Target of operation
IOM Create New System View IOM creation IOM name (path after
the station name)
Delete System View IOM deletion IOM name (path after
the station name)
Properties System View IOM property modifica- IOM name (path after
tion the station name)
IOM Port properties System View IOM property modifica- IOM name-p (path after
(Port) tion the station name)
Trend Acquisi- Create New System View Trend acquisition pen as- Trend acquisition pen
tion Pen As- signment creation assignment name (after
signment the station)
Properties System View Trend acquisition pen as- Trend acquisition pen
signment property modi- assignment name (after
fication the station)
Window Create New System View Window creation Window name (path af-
ter the station name)
Delete System View Window deletion Window name (path af-
ter the station name)
Properties System View Window property modifi- Window name (path af-
cation ter the station name)
Copy System View Window copy Window name (path af-
ter the station name)
Move System View Window move Window name (path af-
ter the station name)
Help Message Create New System View Help message creation Help message name
(path after the station
name)
Delete System View Help message deletion Help message name
(path after the station
name)
Properties System View Help message property Help message name
modification (path after the station
name)
Copy System View Help message copy Help message name
(path after the station
name)
Common Create New System View Common block creation Common block name
Block (path after the station
name)
Delete System View Common block deletion Common block name
(path after the station
name)
Properties System View Common block property Common block name
modification (path after the station
name)
Recipe Group Create New System View Recipe group creation Recipe group name
(path after the station
name)
Delete System View Recipe group deletion Recipe group name
(path after the station
name)
Continues on the next page

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<C2.6 Operations and the files used in revision history management> C2-37
Table C2.6.2-6 Labels that are saved as a result of operations on objects (Table continued)
Object and operation on the ob- Label(*1)
ject Program name Operation name Target of operation
Station Create New System View Station creation Station name
Delete System View Station deletion Station name
Properties System View Station property modifi- Station name
cation
Shortcut win- Create New System View Shortcut window creation Shortcut window name
dow (Paste Shortcut) (path after the station
name)
Delete System View Shortcut window deletion Shortcut window name
(path after the station
name)
Properties System View Shortcut window proper- Shortcut window name
ty modification (path after the station
name)
Copy System View Shortcut window copy Shortcut window name
(path after the station
name)
Move System View Shortcut window move Shortcut window name
(path after the station
name)
*1: No: Either the label is not saved, or the operation is not applicable to history management.

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<C2.6 Operations and the files used in revision history management> C2-38

C2.6.3 Operations that update VP builder files


Revision history is also managed in the builders (VP builders) that are started from System
View.

n Timing of file saving


The following table shows the timing at which files are saved as a result of VP builders opera-
tion.

Table C2.6.3-1 Timing at which the files are saved as a result of VP builders operation
No. Type of builder or ed- Timing at which modified files are saved Remarks
itor file name Current project Default project / user-
defined project
1 Project common build- Upon successful Upon successful Save
ers download operation (*1)
BATCH builders (including when equal-
FCS builders ization fails or there is
(excluding 3 to 9 be- nothing to be equal-
low) ized)
2 HIS builders Upon successful Upon successful Save The builder files are
download (Save oper- operation (*1) updated and then
ation and equalization) equalized. Even when
or successful Save equalization of the up-
operation (*1) dated files fails, the
files are still saved
(same condition as af-
ter the Save opera-
tion). (*1)
3 State Transition Matrix Upon successful Save Same as with the cur- Download from the
(Common to all proj- operation rent project (*1) builder is not permit-
ects) ted.
4 Status Change Com- Upon successful Save Same as with the cur- Download from the
mand Character String operation rent project (*1) builder is not permit-
(Common to all proj- ted.
ects)
5 Block Status Charac- Upon successful Save Same as with the cur- Download from the
ter String operation rent project (*1) builder is not permit-
(Common to all proj- ted.
ects)
6 Unit Common Block Upon successful Save Same as with the cur- Download from the
(BATCH) operation rent project (*1) builder is not permit-
ted.
7 Tag-List Generation Upon successful Save Same as with the cur- Download from the
(STN) operation rent project (*1) builder is not permit-
ted.
8 Control drawing/Logic Upon successful crea- Same as with the cur- With the current proj-
chart status display tion of Control draw- rent project (*1) ect, a status display
file (updated from the ing/Logic chart status file is created after a
Control Drawing Build- display file successful download
er, Function Block of control drawings
Overview Builder, and and function blocks
Function Block Detail (even when an equali-
Builder) zation error occurs).
Even when tag-list
equalization or status
display file equaliza-
tion fails, the file is still
saved.
Continues on the next page

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<C2.6 Operations and the files used in revision history management> C2-39
Table C2.6.3-1 Timing at which the files are saved as a result of VP builders operation (Table continued)
No. Type of builder or ed- Timing at which modified files are saved Remarks
itor file name Current project Default project / user-
defined project
9 Control drawing/Logic Upon updating of Con- Same as with the cur- With the current proj-
chart status display trol drawing/Logic rent project (*1) ect, equalization is
file (updated from the chart status display performed after the
Control Drawing/Logic file control drawing status
Chart Status Display display file is updated.
Builder) Even when status dis-
play file equalization
fails or there is nothing
to be equalized, the
file is still saved.
10 Fieldbus Builder Upon successful Upon successful Save Saved when the build-
download (*1), suc- operation (*1) er files are updated.
cessful offline load (in-
itial load) to a device,
or successful block
parameter upload (*1)
11 UACS Alarm Builder Upon successful Save Upon successful Save
(Common to all proj- operation (*1), suc- operation (*1)
ects) cessful download, or
setting of all alarm set
values at once
12 CAMS for HIS Alarm Upon successful Save Upon successful Save
Builder operation (*1), suc- operation (*1)
(Common to all proj- cessful download, or
ects) setting of all alarm set
values at once
13 UGS Builder Upon successful Upon successful Save
download, or success- operation (*1), or suc-
ful Save operation by cessful Save opera-
using the User-defined tion by using the User-
Faceplate Block Crea- defined Faceplate
tor Block Creator (*1)
14 SIOS Engineering Upon successful Load Upon successful Load Revision history is not
window (*1) All or Load operation All or Load operation managed following a
(*1) (only Save is per- Save operation of
formed in reality) (*1) BCVOpcElement.csv
or other SIOS-related
CSV file.
*1: VP Access Control upon successful Save operation. For example, the AD Suite saves the files for history management even
for user-defined projects but VP Access Control saves the files for history management only for the current project, or there is
other specification difference.

n Files that are saved


The following table shows the files that are saved as a result of VP builders operation.

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<C2.6 Operations and the files used in revision history management> C2-40
Table C2.6.3-2 Files that are saved as a result of VP builders operation
Project hierarchy VP builders name File name
Project common Station Configuration StnConf.edf
Security UserSec.edf
Alarm Priority AlmPri.edf
Alarm Processing Table AlmTbl.edf
Alarm Status Character String AlmStsLabel.edf
Block Status Character String BlkStsLabel.edf
Plant Hierarchy CustomPlant.edf
PlantClass.l
Engineering Unit Symbol EngUnit.edf
Switch Position Label InstLabel.edf
Multiple Projects Connection Function MultiPjt.edf
Operation Mark OpeMark.edf
Status Change Command Character StsChange.edf
String
UACS Alarm Builder UACSAlm.edf
UACS Alarm Group Builder UACSAlmgrp.edf
UACS Assignment Builder UACSAsgn.edf
UACS Filter Builder UACSFilter.edf
UACS Shelf Builder UACSShelf.edf
UACS Suppression Group Builder UACSSupgrp.edf
UACS View Layout Builder UACSViewLayout.edf
CAMS for HIS Alarm CAMSAlm.edf
CAMS for HIS Alarm Group CAMSAlmgrp.edf
CAMS for HIS Message Monitor Definition CAMSMsgMonitor.edf
CAMS for HIS Shelf CAMSShelf.edf
State Transition Matrix Matrixn.def
Tag Name Hierarchy TagHierDef.edf
Buzzer Assignment BuzzerAssign.edf
BATCH Process Management Configuration BatchConf.edf
Unit Common Block UnitCommonBlk.edf
Common Block RDTnnnn.edf
Product Control ProductWnd.edf
Train TrainName.edf
Continues on the next page

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<C2.6 Operations and the files used in revision history management> C2-41
Table C2.6.3-2 Files that are saved as a result of VP builders operation (Table continued)
Project hierarchy VP builders name File name
FCS FCS Constants StnDef.edf
Equipment Equipment.edf
PlantClass.l
SEBOL User Function SEBOL user function name.edf
SEBOL Include Files (*1)
SFC Sequence SFC sequence name.edf
SEBOL Include Files (*1)
Unit Procedure Unit procedure name.edf
IOM (other than Fieldbus) IOM name.edf
Logic Definition Builder IOM name.edf
Fieldbus ALF111-n.edf, etc.
Communication I/O CommonDataWW.edf
Expanded Communication I/O CommonDataXW.edf
Global Switch GSwitchDef.edf
InstLabel.edf
Common Switch SwitchDef.edf
InstLabel.edf
Communication I/O Tag WBTagDef.edf
InstLabel.edf
Expanded Communication I/O Tag XBTagDef.edf
InstLabel.edf
Annunciator AN{ss01}.edf
InstLabel.edf
Signal Event EV{ss01}.edf
Operator Guide OG{ss01}.edf
Printout Message SD{ss01}.edf
Control Drawing DRnnnn.edf/Tag name.edf
SEBOL Include Files (*1)
EngUnit.edf
InstLabel.edf
PlantClass.l
Function Block Overview DRnnnn.edf/Tag name.edf
SEBOL Include Files (*1)
EngUnit.edf
InstLabel.edf
PlantClass.l
Function Block Detail Tag name.edf
SEBOL Include Files (*1)
EngUnit.edf
InstLabel.edf
PlantClass.l
Control drawing/Logic chart status display DRnnnn.dsp/Tag name.dsp
BCV UGS BCV-UGS.edf
User-defined Faceplate Block Creator UGS-Inst.edf
SIOS Engineering window BCV-OPC.edf (*2)
xxxx.csv (*2)
Continues on the next page

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<C2.6 Operations and the files used in revision history management> C2-42
Table C2.6.3-2 Files that are saved as a result of VP builders operation (Table continued)
Project hierarchy VP builders name File name
HIS Assign Function Keys FuncKey.edf
Sequence Message Request MsgReqDef.edf
HIS Constants OpeconDef.edf
Panel Set PanelSet.edf
Scheduler Scheduler.edf
Trend Acquisition Pen Assignment TRnnnn.edf
Graphic (Control) Window name.edf (*2)
Graphic (Graphic) Window name.edf (*2)
Graphic (Overview) Window name.edf (*2)
Help HWnnnn.edf
STN Tag-List Generation (Operator Guide OGDATA.edf
Message)
Tag-List Generation (Print Message) PRDATA.edf
Tag-List Generation (Sequence Message) SMDATA.edf
Tag-List Generation (Tag Name) TFDATA.edf
Tag-List Generation (Area Name) AreaDef.edf
*1: Upon any save operation in the Builder, these files are saved if it is determined that the SEBOL include files were added or
modified.
*2: There are some specification differences compared to the history management of VP Access Control.

n Labels
When files are saved as a result of a VP builders operation, a label is also saved to the
ADMDB. The label is a character string consisting of the following items:
Program name, operation name, target of the operation
The following table shows the labels that are saved as a result of VP builders operations.

Table C2.6.3-3 Labels that are saved as a result of VP builders operations


No. Builder types Labels
Program Operation name Target of operation
name
1 Project common builders Builder Download/save Example: COMMON\Alm-
BATCH builders name Pri.edf
FCS builders
(excluding 3 to 8 below)
2 HIS builders Builder Save Example: HISddss\CONFIG-
name URATION\FuncKey.edf
3 State Transition Matrix Builder Save Example: COMMON\Matrix
(Common to all projects) name \Matrix1.edf
4 Status Change Command Builder Save Example: COMMON
Character String name \StsChange.edf
(Common to all projects)
5 Block Status Character Builder Save Example: COMMON
String name \BlkStsLabel.edf
(Common to all projects)
6 Unit Common Block Builder Save Example: BATCH\UnitCom-
(BATCH) name monBlk.edf
Continues on the next page

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<C2.6 Operations and the files used in revision history management> C2-43
Table C2.6.3-3 Labels that are saved as a result of VP builders operations (Table continued)
No. Builder types Labels
Program Operation name Target of operation
name
7 Tag-List Generation Builder Save Example: STNddss\TAG-
(STN) name LIST\TFDATA.edf
8 Control drawing/Logic chart Builder Status display file cre- Example: FCSddss\DIS-
status display file name ation PLAY\DRnnnn.dsp
(updated from the Control
Drawing Builder, Function
Block Overview Builder, and
Function Block Detail Build-
er)
9 Control drawing/Logic chart Builder Status display file cre- Example: FCSddss\DIS-
status display file name ation PLAY\LOGICCHART\LC.dsp
(updated from the Control
Drawing Builder or Logic
Chart Status Display Build-
er)
10 Fieldbus Builder Builder Download/save Example: FCSddss\IOM
name \NODEn\nALF111\nALF111-
m.edf
Builder Block parameter up- Example: FCSddss\IOM
name load \NODEn\nALF111\nALF111-
m\EJX_01.edf
Builder Offline load to device Example: FCSddss\IOM
name (Initial Load) \NODEn\nALF111\nALF111-
m\EJX_01.edf
11 UACS Alarm Builder Builder Download/save Example: COMMON\UACS
(Common to all projects) name \UACSAlm.edf
12 CAMS for HIS Alarm Builder Builder Download/save Example: COMMON
(Common to all projects) name \CAMS_FOR_HIS\CAM-
SAlm.edf
13 UGS Builder Download/save Example: BCVUddss\CON-
name FIGURATION\BCV-UGS.edf
14 SIOS Engineering window Builder Download Example: BCVOddss\CON-
name FIGURATION\BCV-OPC.edf

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<C2.6 Operations and the files used in revision history management> C2-44

C2.6.4 VP generation
When VP generation is performed using AD Organizer, the files and labels are saved.

n Timing of file saving and files that are saved


The following table shows the files that are saved as a result of VP generation and when they
are saved.

Table C2.6.4-1 Files that are saved as a result of VP generation and when they are saved.
Operation When the file is saved Information that is saved
FCS generation Upon completion of FCS genera- Files subjected to FCS generation
tion
IOM generation Upon completion of IOM genera- Files subjected to IOM generation
tion

n Labels
When files are saved as a result of VP generation, a label is also saved to the ADMDB. The
label is a character string consisting of the following items:
Program name, operation name, target of the operation
The following table shows the labels that are saved as a result of VP generation.

Table C2.6.4-2 Labels that are saved as a result of VP generation


Operation Labels
Program name Operation name Target of operation
FCS generation Generation Manager FCS generation Station name
IOM generation Generation Manager IOM generation Station name

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<C2.6 Operations and the files used in revision history management> C2-45

C2.6.5 Running the Revision History Utility


Running the Revision History Utility causes the files and labels to be saved.

n Timing of file saving and files that are saved


The following table shows the files that are saved as a result of operating the Revision History
Utility and when they are saved.

Table C2.6.5-1 Files that are saved as a result of operating the Revision History Utility and when they
are saved.
Operation When the file is Information that is saved Remarks
saved
Start When history man- Any file that has differences between the
agement is started ADMDB and VP project database
Stop Not subject to history Not subject to history management No file is saved.
management
Update When the revision Any file that has differences between the
history is updated ADMDB and VP project database

n Labels
When files are saved as a result of operating the Revision History Utility, a label is also saved
to the ADMDB. The label is a character string consisting of the following items:
Program name, operation name, target of the operation
The following table shows the labels that are saved as a result of operating the Revision His-
tory Utility.

Table C2.6.5-2 Labels that are saved as a result of operating Revision History Utility
Operation Labels Remarks
Program name Operation Target of oper-
name ation
Start Revision History Utili- Start revision Project name Even when no file is saved as a result
ty history man- of this operation, a label is still saved.
agement
Stop Revision History Utili- Stop revision Project name No file is saved as a result of this op-
ty history man- eration, but a label is still saved.
agement
Update Revision History Utili- Update revision Project name Even when no file is saved as a result
ty history of this operation, a label is still saved.

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<C2.6 Operations and the files used in revision history management> C2-46

C2.6.6 Labels for operations not accompanied by file


modification
Normally when a file is modified using an editor or builder, the modified file and its label are
saved to the ADMDB as revision history.
Some editor or builder operations are not accompanied by file modification. In operations not
accompanied by file modification, only their labels are saved to the ADMDB.

n Setting tuning parameters


Tuning parameters are set from the Set All Parameters window and no files are modified due
to this action. The following table shows the label that is saved by this operation.
The label is a character string consisting of the following items:
Program name, operation name, target of the operation

Table C2.6.6-1 Label that is saved as a result of tuning parameter setting


Function Label
Program name Operation name Target of operation
Setting tuning parame- Setting Tuning Parame- Setting all at once Station name
ters ters

SEE
ALSO For more information about set tuning parameters in the Set All Parameter Window, refer to:
C4.3, “Set all tuning parameters in FCS in bulk” in Automation Design Suite Module-based Engineering
Vol.2 (IM 33J10A16-01EN)

n Tuning parameter comparison and setting


The tuning parameter comparison and setting operation in the Tuning Parameter Differences
window does not result in any files being modified. The following table shows the label that is
saved as a result of this operation.
The label is a character string consisting of the following items:
Program name, operation name, target of the operation

Table C2.6.6-2 Label that is saved as a result of tuning parameter comparison and setting
Function Label
Program name Operation name Target of operation
Tuning parameter com- Tuning Parameter Com- Enforcement Station name
parison parison

SEE
ALSO For more information about compare and set tuning parameters in the Tuning Parameter Differences Window,
refer to:
C4.4, “Compare the design value of a tuning parameter to the current value” in Automation Design Suite
Module-based Engineering Vol.2 (IM 33J10A16-01EN)

n Labels that are saved as a result of VP builders operations


The following table shows the labels that are saved as a result of VP builders operations that
are not accompanied by file modification.
The label is a character string consisting of the following items:
Program name, operation name, target of the operation

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<C2.6 Operations and the files used in revision history management> C2-47
Table C2.6.6-3 Labels that are saved as a result of VP builders operations
Builder type Label
Program name Operation name Target of operation
Fieldbus Builder Fieldbus Builder Tag Assignment Example: FCSddss\IOM\NODEn
\nALF111\nALF111-m\EJX_01.edf
Fieldbus Builder Address Assignment
Fieldbus Builder Device class setting
Fieldbus Builder Device Restart
Fieldbus Builder Offline load to device
(Initial Load), Master
load
UACS Alarm Set All Setpoint Tool Set all alarm set val- Project name
ues
CAMS for HIS Alarm Set All Setpoint Tool Set all alarm set val- Project name
ues

n Labels that are saved as a result of menu operations in System View


The following table shows the labels that are saved as a result of menu bar operations in Sys-
tem View that do not cause file modification.
The label is a character string consisting of the following items:
Program name, operation name, target of the operation

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<C2.6 Operations and the files used in revision history management> C2-48
Table C2.6.6-4 Labels that are saved as a result of menu operations in System View
Function Label
Program name Operation name Target of operation
Tools Tuning Parameter System View Tuning Parameter Project name
Saving Saving
Offline Loading System View Offline Loading Project name
Download All (master System View Download All Path name of the de-
data download) vice tag.edf of the first
device (path name af-
ter the station name)
Device Panel DevicePanel Tag Assignment Path name of the de-
vice tag.edf of the first
DevicePanel Address Assignment device (path name af-
DevicePanel Device class setting ter the station name)

DevicePanel Device Restart


DevicePanel Device registration
DevicePanel Address clear
DevicePanel Tag clear
DevicePanel Master load
DevicePanel Block instantiation
Device Information Equalization Path name of the de-
Display dialog box vice tag.edf of the first
device (path name af-
DevicePanel Address re-assign- ter the station name)
ment
Software Download System View Software Download Path name of the de-
vice tag.edf of the first
device (path name af-
ter the station name)
Linked Part Updating System View Start Linked Part Up- Project name
dating (update)
End Linked Part Up- Project name
dating (update)
System View Start Linked Part Up- Project name
dating (update and
download)
End of linked part up- Project name
dating (update and
download)
Continues on the next page

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<C2.6 Operations and the files used in revision history management> C2-49
Table C2.6.6-4 Labels that are saved as a result of menu operations in System View (Table continued)
Function Label
Program name Operation name Target of operation
Tools Control Drawing Control Drawing Control drawing linked Project name
Smart-Parts Manager Smart-Parts Manager part modification
Control Drawing Control drawing linked Project names
Smart-Parts Manager part addition (*1)
Control Drawing Control drawing linked Project name
Smart-Parts Manager part addition (*2)
Control Drawing Control drawing linked Project name
Smart-Parts Manager part deletion
Control Drawing Control drawing linked Project name
Smart-Parts Manager part import
Linked Part Editor Control drawing Save Linked part name
operation in Linked
Part Editor
Control Drawing Build- Save operation in Linked part name
er Control Drawing Build-
er in Linked Part Edit
mode
Linked Parts Updating Start of updating all Project name
dialog box control drawing linked
parts at once
Load Download Project System View Download Project COMMON
Common Section Common Section
Download to IOM System View Download to IOM Path name to IOM
name.edf (path name
after the station name)
Offline Download to System View Offline Download to Station name
FCS FCS
Download to HIS System View Download to HIS Station name
Download Tag-List System View Download Tag-List Project name
Download Status Dis- System View Download Status Dis- FCSddss\DIS-
play File play File PLAY(dd: domain
number ss: system
number)
Offline Download to System View Offline Download to Station name
BCV BCV
Download Tag-List/ System View Download Tag-List/ Station name
Gateway Information Gateway Information
Save BCV Operation System View Save BCV Operation Station name
Mark Mark
Download to CGW System View Download to CGW Station name
Download Common System View Download Common BATCH\COM-
Block Block MON_BLOCK
Project Resolve Invalid Ele- System View Start Resolve Invalid Station name
ment Element
End Resolve Invalid Station name
Element
*1: Label for control drawing linked part addition operation
*2: Label for control drawing linked part pasting operation

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


Blank Page
<Appendix 1. Error Codes> App.1-1

Appendix 1. Error Codes


AD Suite displays errors in the following format:
<Category error code (16 bits)>-<Detailed error code (32 bits)>
Example: AD12-02005001
The typical category error codes for AD Suite are as follows:

Table Appendix 1-1 Category error code


Category Value Meaning
Server Error 0xAD12 Security Error
0xAD13 Access Error
0xAD14 Validation Error
Server Service Error 0xADA1 Revision Service Internal Error
0xADA2 Revision Service Access Error
0xADAB System Back up/Restore Error

The typical detailed error codes for AD Suite are as follows:

Table Appendix 1-2 Detailed error code for 0xAD12


Detailed error Meaning Action
codes
0x02000001 No access right (Write) for alarm profile. Perform engineering by a user having
access right.
0x02000002 No access right (Write) for grid rule of control Perform engineering by a user having
logic. access right.
0x02000003 No access right (Write) for grid rule of alarm. Perform engineering by a user having
access right.
0x02000004 No access right (Write) for grid rule of common Perform engineering by a user having
switch. access right.
0x02000005 No access right (Write) for grid rule of global Perform engineering by a user having
switch. access right.
0x02000006 No access right (Write) for grid rule of annuncia- Perform engineering by a user having
tor. access right.
0x02000007 No access right (Write) for grid rule of signal Perform engineering by a user having
event. access right.
0x02000008 No access right (Write) for grid rule of operation Perform engineering by a user having
guide. access right.
0x02000009 No access right (Write) for grid rule of printout Perform engineering by a user having
message. access right.
0x0200000A No access right (Write) for grid rule of process Perform engineering by a user having
I/O list. access right.
0x0200000B No access right (Write) for grid rule of communi- Perform engineering by a user having
cation I/O list. access right.
0x0200000E No access right (Add) for Sequence Library. Perform engineering by a user having
access right.
0x0200000F No access right (Delete) for Sequence Library. Perform engineering by a user having
access right.
0x02000010 No access right (Write) for Sequence Library. Perform engineering by a user having
access right.
Continues on the next page

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<Appendix 1. Error Codes> App.1-2
Table Appendix 1-2 Detailed error code for 0xAD12 (Table continued)
Detailed error Meaning Action
codes
0x02001001 No access right (Add) for class module. Perform engineering by a user having
access right.
0x02001002 No access right (Delete) for class module. Perform engineering by a user having
access right.
0x02001003 No access right (Write) for class module. Perform engineering by a user having
access right.
0x02001004 No access right (Move) for Class Module. Perform engineering by a user having
access right.
0x02001005 No access right (Add) for Class Folder. Perform engineering by a user having
access right.
0x02001006 No access right (Delete) for Class Folder. Perform engineering by a user having
access right.
0x02001007 No access right (Write, Lock) for Class Folder. Perform engineering by a user having
access right.
0x02001008 No access right (Move) for Class Folder. Perform engineering by a user having
access right.
0x02001009 No access right (Add) for Group Class Module. Perform engineering by a user having
access right.
0x0200100A No access right (Delete) for Group Class Mod- Perform engineering by a user having
ule. access right.
0x0200100B No access right (Write, Lock) for Group Class Perform engineering by a user having
Module. access right.
0x02002001 No access right (Add) for application module. Perform engineering by a user having
access right.
0x02002002 No access right (Delete) for application module. Perform engineering by a user having
access right.
0x02002003 No access right (Write) for application module. Perform engineering by a user having
access right.
0x02002004 No access right (Move) for application module. Perform engineering by a user having
access right.
0x02002005 No access right (Add) for application folder. Perform engineering by a user having
access right.
0x02002006 No access right (Delete) for application folder. Perform engineering by a user having
access right.
0x02002007 No access right (Write) for application folder. Perform engineering by a user having
access right.
0x02002008 No access right (Move) for application folder. Perform engineering by a user having
access right.
0x02002009 No access right (Add) for Group Application Perform engineering by a user having
Module. access right.
0x0200200A No access right (Write) for Group Application Perform engineering by a user having
Module. access right.
0x02003001 No access right (Add) for process I/O list. Perform engineering by a user having
access right.
0x02003002 No access right (Delete) for process I/O list. Perform engineering by a user having
access right.
0x02003003 No access right (Write) for process I/O list. Perform engineering by a user having
access right.
Continues on the next page

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<Appendix 1. Error Codes> App.1-3
Table Appendix 1-2 Detailed error code for 0xAD12 (Table continued)
Detailed error Meaning Action
codes
0x02003004 No access right (Add) for communication I/O list. Perform engineering by a user having
access right.
0x02003005 No access right (Delete) for communication I/O Perform engineering by a user having
list. access right.
0x02003006 No access right (Write) for communication I/O Perform engineering by a user having
list. access right.
0x02003007 No access right (Add) for VP project. Perform engineering by a user having
access right.
0x02003008 No access right (Delete) for VP project. Perform engineering by a user having
access right.
0x02003009 No access right (Delete) for FCS. Perform engineering by a user having
access right.
0x0200300D No access right (Add) for node. Perform engineering by a user having
access right.
0x0200300E No access right (Delete) for node. Perform engineering by a user having
access right.
0x0200300F No access right (Write) for node. Perform engineering by a user having
access right.
0x02003010 No access right (Add) for I/O module. Perform engineering by a user having
access right.
0x02003011 No access right (Delete) for I/O module. Perform engineering by a user having
access right.
0x02003012 No access right (Write) for I/O module. Perform engineering by a user having
access right.
0x02003013 No access right (Add) for drawing module. Perform engineering by a user having
access right.
0x02003014 No access right (Delete) for drawing module. Perform engineering by a user having
access right.
0x02003015 No access right (Write) for drawing module. Perform engineering by a user having
access right.
0x02003016 No access right (Write) for message definition. Perform engineering by a user having
access right.
0x02003017 No access right (Write) for switch definition. Perform engineering by a user having
access right.
0x02003018 No access right (Write) for module binding file. Perform engineering by a user having
access right.
0x02003019 No access right (Write) for communication I/O Perform engineering by a user having
list prepared for each FCS. access right.
0x02003032 No access right (Write) for FCS Sequence Li- Perform engineering by a user having
brary. access right.
0x02005001 User authentication failed. Register a user.
0x02006001 The currently logged-in name of the user was Register a user again.
deleted from the Administration Tool.

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<Appendix 1. Error Codes> App.1-4
Table Appendix 1-3 Detailed error code for 0xAD13
Detailed error Meaning Action
codes
0x02000004 Inconsistency is detected in a file on AD Organ- No action is required as the file is ac-
izer. quired automatically from AD Organizer
again.
0x02000006 Required disk space is insufficient. Expand the available disk space.
0x02010001 Communication time-out occurred. Check AD server is started or check the
communication status.
0x02010002 Cannot communicate to AD Server. Check AD server is started or check the
communication status.
0x02010003 Windows user authentication failed. Check the registered items for the Win-
dows user.
For example, check the user passwords
are identical between AD Organizer and
AD Server in a workgroup environment,
or check AD Organizer and AD Server
are belonging to the same domain.
0x02010004 Communication error occurred. Check that the AD server is running or
check the communication status, and
then try operation on AD Organizer
again.
0x02010009 Accessed incompatible server. Access a compatible server.

Table Appendix 1-4 Detailed error code for 0xAD14


Detailed error Meaning Action
codes
0x02141001 Class module names duplicate. Specify unique class module name.
0x02141002 Exceed maximum number of class modules. Delete some class modules.
0x02141003 Maximum Number Of Class Folders Check the number of class folders.
0x02141004 Maximum Number Of Group Class Modules Check the number of group class mod-
ules.
0x02141005 Maximum Number Of Class Module and Folder Check the number of class modules and
Under Group Module folders under the group module.
0x02141006 Duplicate Class Folder Full Name Specify unique class folder name.
0x02141007 Duplicate Class Module Full Name Under Group Specify unique class module name.
Module
0x02141008 Duplicate Class Folder Full Name Under Group Specify unique class folder name.
Module
0x02141009 Duplicate Group Class Module Full Name Specify unique group class module
name.
0x0214100A Can Not Delete Class Module. Exist a referring Delete the shortcut of the referring class
Class Module Shortcut. module first, and delete the class mod-
ule.
0x0214100C Can Not Delete Class Module. Exist a referring Delete the referring application module
Application Module. first, and delete the class module.
0x0214100D Can Not Delete Group Class Module. Exist a re- Delete the referring group application
ferring Group Application Module. module first, and delete the group class
module.
0x02142003 to Alarm profile does not exist. Check the alarm profile exists by using
0x02142006 Alarm Profile Editor.
0x02143001 Application module names duplicate in the fold- Specify unique application module
er. name.
Continues on the next page

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<Appendix 1. Error Codes> App.1-5
Table Appendix 1-4 Detailed error code for 0xAD14 (Table continued)
Detailed error Meaning Action
codes
0x02143002 Application folder names duplicate in the folder. Specify unique application folder name.
0x02143004 Exceed the maximum number of application Delete some application modules.
modules. (Up to 500000 application modules)
0x02143005 Exceed the maximum number of application fold- Delete some application folders.
ers.
0x02143006 Exceed the maximum number of function blocks. Delete some function blocks.
0x02143007 Exceed the maximum number of application Delete some application modules.
modules in the application folder. (Up to 1000
application modules)
0x02143008 Maximum Number Of Group Application Mod- Check the number of group application
ules modules.
0x02143009 Can Not Add Application Module.Not Exist a re- Create the referring class module first,
ferring Class Module. and create the application module.
0x0214300A Can Not Add Group Application Module. Not Ex- Create the referring group class module
ist a referring Group Class Module. first, and create the group application
module.
0x0214300B Can Not Add Application Folder. Not Exist a re- Create the referring class folder first,
ferring Class Folder. and create the application folder.
0x0214300C Can Not Add Application Module. Not Exist a re- Create shortcut of the referring class
ferring Shortcut Class Module. module first, and create the application
module.
0x02143101 Commit is canceled because Group Application Create the application module in a loca-
Module is not supported in current client version. tion other than the group application
module.
0x02144001 VP project names duplicate. Specify unique VP project name.
0x02144002 P&ID group names duplicate. Specify unique P&ID group name.
0x02144003 Exceed the maximum number of P&ID groups. Delete some P&ID groups.
0x02144004 Exceed the maximum number of VP projects. Delete some VP projects.
0x02144005 P&ID tags duplicate in the P&ID group. Specify unique P&ID tag name.
0x02144006 I/O tag names duplicate in the I/O group. Specify unique I/O tag name.
0x02144007 I/O tag names duplicate in the FCS. Specify unique I/O tag name.
0x02144008 Program groups duplicate in the AD project. Specify unique program group name.
0x0214400D Conflict Duplex Slot for IOM Correct the definition so as to avoid du-
plication.
0x02144010 A different I/O module is already defined in the Correct the definition so as to avoid du-
duplexed card position. plication.
0x02144011 I/O module installation positions duplicate. Specify a unique I/O module installation
position.
0x02144012 IOM Category of a duplex pair of I/O modules Specify the same IOM Category.
does not match.
0x02144013 Installation positions duplicate between an I/O Correct the definition so as to avoid du-
module that occupies specific slots and another plication.
I/O module.
0x02144014 Corresponding node does not exist. Create a node first.
0x02144015 NIO type confliction for IOM Correct the definition so as to avoid du-
plication.
Continues on the next page

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<Appendix 1. Error Codes> App.1-6
Table Appendix 1-4 Detailed error code for 0xAD14 (Table continued)
Detailed error Meaning Action
codes
0x02144016 Duplex value between IO/CIO and IOM is mis- Make the duplex specification the same
match between the Process I/O Editor/Commu-
nication I/O Editor and the IOM Editor.
0x02144020 Exceeded the maximum number of ALF cards in Delete some ALF cards in FFCS-V.
FFCS-V.
0x02144021 Exceeded the maximum number of ALR, ALE, or Delete some ALR, ALE, or ALP cards in
ALP cards in FFCS-V. FFCS-V.
0x02144022 Exceeded the maximum number of ALR, ALE, Delete some ALR, ALE, ALP, or ALF
ALP, or ALF cards in FFCS-V. cards in FFCS-V.
0x02144030 Exceeded the maximum number of ALF cards in Delete some ALF cards in FFCS-C.
FFCS-C.
0x02144031 Exceeded the maximum number of ALR, ALE, or Delete some ALR, ALE, or ALP cards in
ALP cards in FFCS-C. FFCS-C.
0x02144032 Exceeded the maximum number of ALR, ALE, Delete some ALR, ALE, ALP, or ALF
ALP, or ALF cards in FFCS-C. cards in FFCS-C.
0x02144033 Exceeded the maximum number of units in Delete some units in FFCS-C.
FFCS-C.
0x02144034 Exceeded the maximum number of I/O modules Delete some I/O modules in FFCS-C.
in FFCS-C.
0x02144040 Exceeded the maximum number of ALF cards in Delete some ALF cards in FFCS-R.
FFCS-R.
0x02144041 Exceeded the maximum number of ALR, ALE, or Delete some ALR, ALE, or ALP cards in
ALP cards in FFCS-R. FFCS-R.
0x02144042 Exceeded the maximum number of ALR, ALE, Delete some ALR, ALE, ALP, or ALF
ALP, or ALF cards in FFCS-R. cards in FFCS-R.
0x02144043 Exceeded the maximum number of units in Delete some units in FFCS-R.
FFCS-R.
0x02144044 Exceeded the maximum number of I/O modules Delete some I/O modules in FFCS-R.
in FFCS-R.
0x02145001 Template names of documents duplicate. Specify unique template name.
0x02145002 Document names duplicate. Specify unique document name.

Table Appendix 1-5 Detailed error code for 0xADA1


Detailed error Meaning Action
codes
0x02000005 Checked-out by another user. Try it again.
0x02000006 Canceled the checked-out status by ADS Admin- Check-out and then perform the opera-
istration Tool. tion again.
0x0200000A AD project is frozen now. If necessary, activate the AD project.
0x0200000B Another user is checking-in now. Try it again.

Table Appendix 1-6 Detailed error code for 0xADA2


Detailed error Meaning Action
codes
0x0200000B Required disk space is insufficient. Expand the available disk space.
0x02000015 Canceled checking-in by user's request. No action is required.
0x0200001C Lock is canceled because files are not supported Check out the file with a compatible cli-
in current client version. ent version.

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


<Appendix 1. Error Codes> App.1-7
Table Appendix 1-7 Detailed error code for 0xADAB
Detailed error Meaning Action
codes
0x0206000C Cannot execute the processing because other Retry the operation after confirming that
processing is being executed on the system proj- the backing up or restoration of system
ect backup data on the AD Server. project data by AD Organizer is comple-
ted.

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


Blank Page
Rev-1

Revision Information
Title : Automation Design Suite Basics
Manual No. : IM 33J10A10-01EN
Feb. 2021/11th Edition/R6.08 or later
C1.1.6 Added description to the table in "● List of objects for which access rights can be de-
fined.”
Added description to the table in "● Pre-defined user role.”
Updated figures in "● Access scope of CENTUM VP System View.”
C2.4 Descriptions have been added.
C2.4.1 Updated figures in “■ Opening the Revision History window.”
Added “■ Filtering Change Sets displayed on the Revision History tab.”
Added “● Filtering by dates of Change Sets.”
C2.4.3 Newly added.
Appendix 1 Added some detailed error codes.
May 2020/10th Edition/R6.07.10
General Updated reference links.
Aug. 2019/9th Edition/R6.07
A1. Added description to the table in "■ Terms."
A2.5 Added information related to UACS.
B1.5.1 Updated descriptions in "● Restoring a VP project from the AD project."
C1.1 Updated figures.
C1.1.6 Added description to the table in "● List of objects for which access rights can be de-
fined."
Added description to the table in "● Pre-defined user role."
C2.6.2 Added description to the table in "● Menu operations" in "■ Operations where the files
are saved."
Added description to the table in "● Operations on objects" in "■ Operations where the
files are saved."
Added description to the table in "● Operations on Objects" in "■ Files that are saved."
Added description to the table in "● Menu operations" in "■ Labels."
Added description to the table in "● Operations on Objects" in "■ Labels."
C2.6.3 Added description to the table in "■ Timing of file saving."
Added description to the table in "■ Files that are saved."
Added description to the table in "■ Labels."
C2.6.6 Added description to the table in "■ Labels that are saved as a result of VP builders op-
erations."
Aug. 2018/8th Edition/R6.06
A1. Figures have been updated in "● System builders."
B2.2 Descriptions have been added.
B2.3 Updated descriptions in "■ Upgrading the revision of VP projects."
C1.1 Descriptions have been added.

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


Rev-2
C1.1.6 A figure has been updated in "● Access scope of System Structure Navigator."
C2.4.5 A figure has been updated.
Nov. 2017/7th Edition/R6.05
B1.5.1 Added descriptions in “■ Unregistering a VP project from the AD project.”
C2.4.1 Descriptions have been updated.
Updated figures in “■ Opening the Revision History window.”
Added “● Switching the range of Change Sets displayed on the Revision History tab.”
C2.4.5 A figure has been updated.
Apr. 2017/6th Edition/R6.04
A2.2 Added descriptions in “■ Engineering tools for module-based engineering.”
B1.5.1 Updated descriptions in “● Backing up a VP project to the AD project.”
C1.1.2 Updated the figure in “■ Backing up the ADMDB.”
Added descriptions in “● Items set in the Server Backup Dialog Box.”
Added “● Select the VP project to back up.”
C1.1.7 Updated the figure in “■ Exporting AD projects.”
Added descriptions in “● Items set in the Project Export Dialog Box.”
Added “● Select the VP project to back up.”
C1.2.1 Updated descriptions in “■ Changing the location of the ADMDB.”
C1.2.3 Added descriptions in “■ Backing up the ADMDB.”
C1.3.4 Added descriptions in “■ Exporting AD projects.”
Appendix1. Added error code 0xADAB0206000C.
Updated description of the action for error code 0xAD1302010004.
General Descriptions for the start menu have been updated.
Sep. 2016/5th Edition/R6.03.10
B2. Added descriptions in "■ Procedure for starting engineering."
B2.1 Descriptions have been updated.
B2.2 Updated descriptions in "■ Upgrading the revision of an AD project."
B2.3 Updated descriptions in "■ Upgrading the revision of VP projects."
Jun. 2016/4th Edition/R6.03
A1. Added descriptions in "● Module-based engineering."
C1.1.9 Updated descriptions.
C1.3.7 Updated descriptions.
Dec. 2015/3rd Edition/R6.02
A1. Figures have been updated in "● System builders."
A figure has been updated in "● Automation Design Server."
A2.5 Descriptions have been updated.
A4. Descriptions have been updated.
B1. A figure has been updated in "■ Overview."
B1.1 Newly added.

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


Rev-3
B1.3 Descriptions have been updated in "■ Registering an engineering user and configuring
access control on the user."
B1.5.1 Descriptions have been updated in "● Restoring a VP project from the AD project."
B2. Newly added.
C1.1 A figure has been updated.
Descriptions have been added in "● AD Server management functions."
C1.1.2 A figure has been updated in "■ Restore the ADMDB."
C1.1.6 Descriptions have been updated in "● Pre-defined user role."
A figure has been updated in "● Access scope of System Structure Navigator."
C1.1.8 Descriptions have been updated in "■ Modify frozen data."
C1.1.9 Descriptions have been updated.
A figure has been updated in "■ Discard Check-out Dialog Box."
C1.2 Descriptions have been added.
C1.2.1 Newly added.
C1.3.1 Descriptions have been updated in "■ Create AD project."
C1.3.2 Descriptions have been updated in "■ Delete an AD project."
C1.3.7 Descriptions have been added in "■ Forcibly cancel the checked-out status."
C1.4 A figure has been updated in "● Access Permission Definition Dialog Box."
A figure has been updated in "● User Role Definition Dialog Box."
A figure has been updated in "● Access Scope Definition Dialog Box."
C1.4.1 Descriptions have been updated in "■ Define a customizable user role."
C1.4.2 Descriptions have been updated in "■ Define an access scope."
C1.4.3 Descriptions have been updated in "■ User security setting."
General The starting operation of various windows in AD Suite has been updated.
Apr. 2015/2nd Edition/R6.01.10
A1. Descriptions have been added to "● Module-based engineering."
"● Behavior of VP builders when the system builder function fails to connect to the AD
Server" has been added.
B5.1 Descriptions have been updated in "● Restoring a VP project from the AD project."
C1.1.3 Newly added.
C1.1.6 Descriptions have been added.
C1.2.3 "■ When moving the AD Server by restoring the ADMDB on a different computer or
when changing the IP address of the AD Server" has been added.
C1.2.4 Newly added.
C1.4.3 Descriptions have been updated in "■ User security setting."
Mar. 2015/1st Edition/R6.01
Newly published.

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00


Rev-4

n For Questions and More Information


Online Query: A query form is available from the following URL.
http://www.yokogawa.com/dcs/
n Written by Yokogawa Electric Corporation
n Published by Yokogawa Electric Corporation
2-9-32 Nakacho, Musashino-shi, Tokyo 180-8750, JAPAN

IM 33J10A10-01EN 11th Edition : Feb.19,2021-00

You might also like