September 2011

CDC Factory 7.1

ActivEssentials Administration Guide
CDC Factory 7.1
ActivEssentials Administration Guide
ii
Contents
Chapter 1 ActivEssentials Administration
Introduction to MI Admin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2
The AppCenter (MI Admin) Window. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2
Testing and Viewing the System Requirements . . . . . . . . . . . . . . . . . . . . . . . . 1-3
Logging onto MI Admin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-4
Changing your Password . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-5
Restarting, Shutting Down, and Locking AppCenter . . . . . . . . . . . . . . . . . . . . . 1-6
System Requirements. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-8
The MI Admin Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-9
The MI Admin Toolbar. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-10
Using Keyboard Shortcuts in MI Admin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-11
The MI Admin Taskbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-12
The Taskbar Organization. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-12
Minimizing the Taskbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-13
Plant Hierarchy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-14
Plants, Groups and Assets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-14
Object Library. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-15
Minimizing the Plant Hierarchy Frame . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-15
Keyboard Shortcuts in the Plant Hierarchy . . . . . . . . . . . . . . . . . . . . . . . . . . 1-16
The Secondary Frame. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-16
The Grid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-17
Editing in the Grid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-17
Illegal Characters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-17
The Status Bar. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-18
The Document Status Indicator. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-18
The Connection Integrity Monitor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-18
AppCenter Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-19
Common Functions Within MI Admin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-20
The Copy and Paste Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-21
Building your Data Collection System in MI Admin. . . . . . . . . . . . . . . . . . . . . . . . 1-24
Before you Begin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-24
Creating the Data Collection System. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-25
Minimum Requirements for Data Collection . . . . . . . . . . . . . . . . . . . . . . . 1-25
Chapter 2 System Settings
Introduction to System Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-2
ActivEssentials System Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-2
Opening the System Settings Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-2
Viewing Licensing Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-3
Changing the System Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-4
System Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-5
Units of Measurement and Number Formats . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-11
Creating Units of Measurement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-11
Editing and Deleting Units of Measurement . . . . . . . . . . . . . . . . . . . . . . . . . . 2-12
Viewing Number Formats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-13
Contents
CDC Factory 7.1
ActivEssentials Administration Guide
iii
Daylight Saving Time in ActivEssentials . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-15
DST Changes Affect Data Collection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-15
Rolling Forward. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-15
Rolling Back . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-15
How the Daylight Saving System Works . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-17
Time Change Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-17
Database Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-18
Daylight Saving Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-18
Actions Available in Daylight Saving . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-19
Terms Used in Daylight Saving . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-19
Using the Daylight Saving Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-21
Enabling the Daylight Saving Option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-21
Toggling the DST Option On and Off. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-22
Deleting a Time Change Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-23
Importing New Time Change Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-24
Swapping Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-25
Rescheduling a Data Swap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-26
Cancelling a Data Swap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-28
Toolbar Buttons, Menu Options, and Messages . . . . . . . . . . . . . . . . . . . . . . . .2-29
The Right-Click Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-30
Messages in the Status Column . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-31
Time Change Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-32
Best Practices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-33
Known Issues and Workarounds . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-34
Filtering Incident Data by IdentifiersChoosing the Right Method. . . . . . . . . . . . . .2-36
How Filtering WorksThree Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-36
How Filtering WorksTwo Models . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-37
The Full Duration Model . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-37
The Coincident Duration Model . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-38
Choosing the Filtering Model . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-39
Chapter 3 Plant Management
Introduction to Plant Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-2
Working in the Plant Management Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-2
Opening the Plant Management Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-2
The Plant Hierarchy Concept . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-3
The Plant Management Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-4
Basic Plant Management Editing Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-5
Navigating in the Plant Hierarchy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-5
Preparing for Plant Hierarchy Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . .3-6
Creating and Editing Groups and Assets. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-7
Creating a Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-7
Creating an Asset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-9
Deleting Groups and Assets. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-11
Copying Groups and Assets Within the Plant Hierarchy. . . . . . . . . . . . . . . . . . .3-12
Copying Groups and Assets Within the Grid. . . . . . . . . . . . . . . . . . . . . . . . . . .3-12
Moving or Copying Groups and Assets by Drag-and-Drop . . . . . . . . . . . . . . . . .3-13
Viewing and Editing Properties of Groups and Assets . . . . . . . . . . . . . . . . . . . .3-14
Editing Groups and Assets in the Grid. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-15
Changing the Order of Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-16
Rollover ValuesAn Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-17
Contents
CDC Factory 7.1
ActivEssentials Administration Guide
iv
Chapter 4 Application Template Management
Introduction to Application Template Management . . . . . . . . . . . . . . . . . . . . . . . . .4-2
Configuration Templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-2
Purpose of Templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-2
Application Template Types. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-3
Asset Templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-3
Configuration Template Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-6
Shift Configuration Templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-6
Report Configuration Templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-6
Applications and Templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-8
What is an Application?. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-8
Where are Applications Stored? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-8
Parameters when creating a new asset template . . . . . . . . . . . . . . . . . . . . . . . .4-9
Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-10
OPC Item Name Spaces. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-10
RTLE Item Device Names. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-11
Application and Template Tasks. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-11
Asset Level Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-11
ActivApplications Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-12
Options When Importing Applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-14
Importing Unimported Templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-14
Deciding What to Import . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-15
Choosing a Template. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-24
Understanding the Reimport Options for Existing Applications . . . . . . . . . . . . . .4-25
Options for Applying a Template to An Asset . . . . . . . . . . . . . . . . . . . . . . . . . .4-28
Scope Definition when Applying a Template . . . . . . . . . . . . . . . . . . . . . . . 4-28
Applying Templates. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-29
Applying vs. Reapplying. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-29
The Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-29
Understanding the Reimport Options for Template Asset Configuration. . . . . . . .4-35
Options When Removing a Template From an Asset . . . . . . . . . . . . . . . . . . . . .4-38
Initial Set Up of Configuration Templates. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-41
Creating an Application. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-41
Creating a New Asset Template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-42
Creating a New Shift Configuration Template . . . . . . . . . . . . . . . . . . . . . . . . .4-48
Creating a New Report Configuration Template . . . . . . . . . . . . . . . . . . . . . . . .4-49
Importing an Application. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-52
Exporting an Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-56
Creating a Workbook From an Application. . . . . . . . . . . . . . . . . . . . . . . . . . . .4-57
Specifying User-Defined Import Options at the Global Level . . . . . . . . . . . . . . .4-58
Specifying User-Defined Import Options for a Template Asset . . . . . . . . . . . . . .4-61
Providing Context in a Workbook . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-63
Asset Sheet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-64
Template Sheet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-64
Processing a Workbook. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-65
Applying a Template to an Asset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-70
Validating a Template. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-75
Maintaining your Configuration Templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-77
Detaching a Template from Assets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-77
Removing a Template from Assets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-79
Changing Template Removal Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-82
Resynchronizing Asset Configuration with a Template . . . . . . . . . . . . . . . . . . .4-84
Exporting your ActivEssentials Configuration . . . . . . . . . . . . . . . . . . . . . . . . . .4-88
Contents
CDC Factory 7.1
ActivEssentials Administration Guide
v
Setting Configuration File Transfer Size . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-90
Viewing a Template Definition Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-90
Viewing a template usage report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-91
Viewing a configuration report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-93
Editing and viewing application properties. . . . . . . . . . . . . . . . . . . . . . . . . . . .4-93
Editing and viewing application template properties . . . . . . . . . . . . . . . . . . . . .4-95
Chapter 5 OPC Server Configuration
Introduction to OPC Server Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-2
OPC Server Configuration in ActivEssentials . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-2
OPC Server Monitoring . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-2
What Happens if You Dont Use a Heartbeat Item? . . . . . . . . . . . . . . . . . . . . .5-3
The Reconnection Process. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-4
Setting Up a Heartbeat Data Item in the PLC . . . . . . . . . . . . . . . . . . . . . . . . .5-4
Configuring OPC Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-5
Opening the OPC Server Configuration Module . . . . . . . . . . . . . . . . . . . . . . . . .5-5
Adding an OPC Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-5
Deleting an OPC Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-8
Viewing and Editing OPC Server Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-9
Testing the OPC Server Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-11
Assigning an OPC Server to a Group or Asset . . . . . . . . . . . . . . . . . . . . . . . . .5-12
Changing the OPC Server Used by a Group or Asset. . . . . . . . . . . . . . . . . . . . .5-13
The OPC Server Configuration Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-14
Visual Cues in the OPC Server Configuration Grid . . . . . . . . . . . . . . . . . . . 5-14
Chapter 6 VPCollector Configuration
Introduction to VPCollector Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6-2
The Collector Configuration Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6-2
Opening the Collector Configuration Module . . . . . . . . . . . . . . . . . . . . . . . . . . .6-2
Description of the Collector Configuration Module . . . . . . . . . . . . . . . . . . . . . . .6-3
Creating and Editing VPCollectors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6-4
Creating a VPCollector Instance. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6-4
Viewing and Editing VPCollector Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . .6-6
Deleting a VPCollector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6-7
Caching Accumulator Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6-7
Applying VPCollector Instances to Assets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6-8
Assigning a VPCollector to a Group or Asset . . . . . . . . . . . . . . . . . . . . . . . . . . .6-8
Viewing the Properties of a VPCollector Used by an Asset . . . . . . . . . . . . . . . . . .6-9
Changing the VPCollector Used by an Asset. . . . . . . . . . . . . . . . . . . . . . . . . . .6-10
Starting, Stopping, and Refreshing VPCollector. . . . . . . . . . . . . . . . . . . . . . . . . . .6-12
Accessing the Activplant Control Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6-13
Starting and Stopping VPCollector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6-14
Effects of Stopping or Refreshing VPCollector . . . . . . . . . . . . . . . . . . . . . . . . .6-15
Changes That Cannot be Made if VPCollector is Running . . . . . . . . . . . . . . . . . .6-17
When to Refresh VPCollector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6-17
Manual Refresh. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-18
Automatic Refresh . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-18
No Need to Refresh. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-19
What Happens When You Make Changes . . . . . . . . . . . . . . . . . . . . . . . . . . . .6-19
If the Database is Unavailable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-20
Limitations to the Use of VPCollector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6-20
Contents
CDC Factory 7.1
ActivEssentials Administration Guide
vi
Chapter 7 Data Collection Configuration
Introduction to Data Collection Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7-2
The Data Collection Configuration Module Interface. . . . . . . . . . . . . . . . . . . . . . . . .7-3
Opening the Data Collection Configuration Module . . . . . . . . . . . . . . . . . . . . . . .7-3
Printing from the Data Collection Configuration Module . . . . . . . . . . . . . . . . . . .7-3
The Data Collection Configuration Grid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7-4
Data Configuration Through the Object Library. . . . . . . . . . . . . . . . . . . . . . 7-5
Data Configuration Through the Plant Hierarchy . . . . . . . . . . . . . . . . . . . . . 7-6
Data Collection Defined in ActivApplications . . . . . . . . . . . . . . . . . . . . . . . . 7-8
Icons Used in the Main Grid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-9
Saving Time in Configuring Data Items. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7-11
Categories, Collection Methods, and ActivEssentials . . . . . . . . . . . . . . . . . . . . . . .7-12
Creating a Collection Category. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7-12
Copying Categories Between Assets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7-14
Viewing and Editing Category Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . .7-15
Deleting a Data Collection Category . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7-16
ActivEssentials Collection Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7-17
Merging Incidents and Identifiers. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7-17
Creating Global Accumulators, Incidents, and Variables. . . . . . . . . . . . . . . . . . . . .7-19
Resetting VPServer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7-19
Creating a Global Accumulator Item. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7-20
Creating a Global Incident Item. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7-22
Creating a Global Event Variable Item . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7-25
Viewing and Editing Accumulator, Incident, and Variable Properties . . . . . . . . . .7-27
Deleting Global Data Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7-28
Incident Sub-Categories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7-30
Creating an Incident Sub-Category . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7-30
Viewing and Editing Sub-Category Properties . . . . . . . . . . . . . . . . . . . . . . . . .7-31
Copying an Incident Sub-Category. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7-32
Deleting an Incident Sub-Category. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7-33
Creating an Incident Sub-Category Item. . . . . . . . . . . . . . . . . . . . . . . . . . . . .7-33
Viewing and Editing Sub-Category Item Properties. . . . . . . . . . . . . . . . . . . . . .7-34
Copying an Incident Sub-Category Item. . . . . . . . . . . . . . . . . . . . . . . . . . . . .7-35
Deleting an Incident Sub-Category Item. . . . . . . . . . . . . . . . . . . . . . . . . . . . .7-36
Assigning Sub-Categories to Incident Categories . . . . . . . . . . . . . . . . . . . . . . .7-36
Linking the Incident Sub-Category at the Asset Level . . . . . . . . . . . . . . . . . . . .7-38
How Incident Sub-Categories Work . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7-40
Incident Sub-Category Links . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-41
Defining Global Identifiers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7-42
Attributes Defined When Creating a New Identifier Definition . . . . . . . . . . . . . .7-43
Identifier Values and Auto-Insert . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7-44
Attributes Defined as a part of an Extended Property . . . . . . . . . . . . . . . . . . . .7-45
Attributes Defined as Identifier Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7-48
Managing Extended Properties with Identifier Values. . . . . . . . . . . . . . . . . 7-49
Managing Time Sensitive Extended Properties . . . . . . . . . . . . . . . . . . . . . 7-50
Viewing and Using Identifier Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7-51
Creating a Global Identifier . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7-52
Viewing and Editing Identifier Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . .7-54
Creating and Editing Identifier Extended Properties . . . . . . . . . . . . . . . . . . . . .7-55
Creating Identifier Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7-58
Viewing and Editing Identifier Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7-65
Creating New Identifier Values from Existing Values. . . . . . . . . . . . . . . . . . . . .7-66
Copying the Extended Properties of One Identifier Value to Another. . . . . . . . . .7-68
Contents
CDC Factory 7.1
ActivEssentials Administration Guide
vii
Defining Accumulators, Incidents, and Identifiers on an Asset . . . . . . . . . . . . . . . .7-70
Refreshing VPCollector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7-71
Adding a Non-Incident Category to an Asset . . . . . . . . . . . . . . . . . . . . . . . . . .7-71
Adding an Incident Category to an Asset . . . . . . . . . . . . . . . . . . . . . . . . . . . .7-73
Adding an Accumulator Data Item to an Asset. . . . . . . . . . . . . . . . . . . . . . . . .7-75
Creating Links Between Identifiers and Accumulators. . . . . . . . . . . . . . . . . . . .7-79
Adding an Incident Item to an Asset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7-81
Adding an Identifier Item to an Asset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7-85
Viewing and Editing Data Item Definitions on an Asset . . . . . . . . . . . . . . . . . . .7-89
Deleting a Data Item From an Asset. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7-91
Copying Data Items Within an Asset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7-91
Copying Data Items Between Assets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7-92
Categories, Items, and Assets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7-93
Global and Local Data Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7-93
Linking Identifiers and Accumulators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7-94
Events in ActivEssentials . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7-95
The Types of Events. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7-95
Sample Time Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-96
Value Change Events. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-96
OPC Real-Time Events. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-96
Triggered Sample Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-96
Steps Involved in Defining Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7-97
Event Acknowledgment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7-97
Trigger Expressions for Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7-98
Data Types and VBScript Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-99
Examples of Trigger Expressions and Filters. . . . . . . . . . . . . . . . . . . . . . . 7-99
Sampled Events and Daylight Saving Time . . . . . . . . . . . . . . . . . . . . . . . . . . 7-100
Triggered Sample Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-100
Overview of Triggered Sample Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-101
The Trigger Item. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-101
Variable Values and Data Quality . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-102
Triggered Sampled EventsModes of Collection . . . . . . . . . . . . . . . . . . . . . . 7-102
Collecting While the Trigger is On . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-102
Collecting for a Defined Period of Time (Duration). . . . . . . . . . . . . . . . . . 7-102
Collection of Database Records Without a Sampling Duration . . . . . . . . . . . . . 7-103
The Basic Triggered Sample Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-103
Rapid Trigger Changes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-104
Collection of Database Records Using a Sampling Duration . . . . . . . . . . . . . . . 7-106
A Basic Triggered Sample Event Using a Duration. . . . . . . . . . . . . . . . . . 7-106
Other Duration Scenarios. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-107
Limitations of Triggered Sample Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-109
Defining Event Data Items on an Asset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-110
Creating a Sample Time Event. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-110
Creating a Value Change Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-112
Creating an OPC Real-Time Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-116
Creating a Triggered Sample Event Without a Duration . . . . . . . . . . . . . . . . . 7-118
Creating a Triggered Sample Event That Uses a Duration . . . . . . . . . . . . . . . . 7-121
Creating a Numeric Event Variable for an Asset . . . . . . . . . . . . . . . . . . . . . . . 7-123
Creating an Alphanumeric Variable for an Asset. . . . . . . . . . . . . . . . . . . . . . . 7-126
Viewing and Editing Event Data Item Definitions on an Asset . . . . . . . . . . . . . 7-129
Numeric and Alphanumeric Event Variables. . . . . . . . . . . . . . . . . . . . . . . . . . 7-130
Asset States. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-132
Creating an Asset State . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-132
Viewing and Editing Asset State Properties . . . . . . . . . . . . . . . . . . . . . . . . . . 7-135
Contents
CDC Factory 7.1
ActivEssentials Administration Guide
viii
Copying Asset States Within the Same Asset. . . . . . . . . . . . . . . . . . . . . . . . . 7-136
Deleting Asset States . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-136
Adding Asset States to an Asset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-137
Copying Asset States Between Assets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-140
Deleting an Asset State From an Asset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-141
Priorities in Asset States . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-142
Filtering Data by Means of Expressions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-143
Using Expressions to Filter Data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-143
Valid Expressions for Filtering Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-143
Special Cases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-145
Comparing a Negative Number . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-145
Overlapping Expressions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-145
Rollover Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-145
Expressions for Accumulators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-145
Solicited and Unsolicited Collection . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-146
Record Generation for Accumulators . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-146
Expressions for Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-147
Filtering Value Change Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-147
Filtering Triggered Sample Events. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-148
Event Variables. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-148
Expressions for incidents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-149
Incident Priorities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-149
Exporting and Importing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-150
Exporting the Data Collection Configuration for an Asset . . . . . . . . . . . . . . . . 7-151
Exporting the Asset State Configuration for an Asset . . . . . . . . . . . . . . . . . . . 7-152
Exporting Data Collection Configuration from the Object Library . . . . . . . . . . . 7-154
Importing to Create New Data Collection Categories . . . . . . . . . . . . . . . . . . . 7-155
Importing New Data Items into a Collection Category . . . . . . . . . . . . . . . . . . 7-158
Importing New Data Items at the Asset Level . . . . . . . . . . . . . . . . . . . . . . . . 7-162
Importing New Asset States for Individual Assets . . . . . . . . . . . . . . . . . . . . . 7-166
Operational and Security Considerations. . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-168
Cross-Database Import/Export . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-169
Security Considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-169
Time Taken to Export and Import Data . . . . . . . . . . . . . . . . . . . . . . . . . 7-169
Retro Stop and the Use of Export-Import. . . . . . . . . . . . . . . . . . . . . . . . 7-169
Data Available for Export at the Asset Data Collection Level . . . . . . . . . . . . . . 7-169
Data Available for Export at the Global Collection Level . . . . . . . . . . . . . . . . . 7-170
Building the Plant Configuration Using Excel . . . . . . . . . . . . . . . . . . . . . . . . . 7-172
Chapter 8 Calculations
Introduction to Calculations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8-2
Formulas, Calculation Templates, and Calculations . . . . . . . . . . . . . . . . . . . . . . . . .8-2
Opening the Calculations Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8-2
The Process of Defining Calculations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8-3
Where to Use Calculations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8-5
Calculations Defined in ActivApplications . . . . . . . . . . . . . . . . . . . . . . . . . . 8-5
The Calculation Building Blocks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8-6
The basic building blocks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-6
The Intermediate Building Blocks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-9
Types of Calculations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8-10
Numeric Calculations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8-10
Alphanumeric Calculations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8-10
Time-Based Calculations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8-11
Merging Records in Time-Based Calculations . . . . . . . . . . . . . . . . . . . . . . 8-12
Contents
CDC Factory 7.1
ActivEssentials Administration Guide
ix
Creating and Editing Formulas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8-13
Resetting VPServer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8-13
Creating a Numeric Formula . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8-14
Creating an Alphanumeric Formula . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8-16
Creating a Time-Based Formula. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8-17
Viewing and Editing Properties of Formulas . . . . . . . . . . . . . . . . . . . . . . . . . . .8-19
Copying a Formula. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8-20
Deleting a Formula. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8-21
Introduction to Formulas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8-21
Using the Formula Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8-22
Using the Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-23
Keyboard Shortcuts in the Formula Editor . . . . . . . . . . . . . . . . . . . . . . . . 8-24
Creating and Editing Calculation Templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8-25
Creating a Calculation Template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8-25
Viewing and Editing Properties of Calculation Templates . . . . . . . . . . . . . . . . . .8-30
Copying a Calculation Template. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8-31
Deleting a Calculation Template. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8-32
Data Aggregation Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8-32
Default Values in Calculations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8-33
Creating and Editing Calculations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8-36
Creating a New Calculation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8-36
Creating a Calculation Using a Calculation Template. . . . . . . . . . . . . . . . . . . . .8-39
Creating a Calculation Using a Formula. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8-41
Viewing and Editing Properties of Calculations . . . . . . . . . . . . . . . . . . . . . . . . .8-44
Copying a Calculation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8-46
Deleting a Calculation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8-46
Creating Calculations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8-47
Problems with Calculations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8-47
Create a Valid Calculation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-48
Other Causes of Error . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-49
Derived Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8-50
Creating a Derived Item . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8-50
Viewing and Editing Properties of Derived Items . . . . . . . . . . . . . . . . . . . . . . .8-54
Copying Derived Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8-55
Deleting a Derived Item . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8-56
How Derived Items are Built . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8-56
The Base Item . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-57
The Aggregation Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-57
The Time Frame . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-58
The Reading Frequency . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-58
Chapter 9 Shift Configuration
Introduction to Shift Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9-2
Shift Configuration in ActivEssentials. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9-3
Accessing the Shift Configuration Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9-3
Overview of Shift Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9-4
The Process of Shift Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-5
Shift Configuration Defined in ActivApplications . . . . . . . . . . . . . . . . . . . . . 9-6
Shift Periods. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9-7
Defining a New Shift Period. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9-7
Editing Shift Periods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9-8
Copying and Pasting a Shift Period. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9-9
Deleting a Shift Period . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9-10
Overview of Shift Periods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9-11
Contents
CDC Factory 7.1
ActivEssentials Administration Guide
x
Productive and Non-Productive Periods . . . . . . . . . . . . . . . . . . . . . . . . . . 9-11
Standard and Non-standard Periods . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-11
Shift Structures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-12
Shift Definitions and Shift Structures. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9-13
Creating a New Shift Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9-13
Defining a Shift Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9-14
Defining a Shift Structure When Creating a Shift . . . . . . . . . . . . . . . . . . . . . . .9-18
Defining a Structure for an Existing Shift . . . . . . . . . . . . . . . . . . . . . . . . . . . .9-20
Removing a Shift Structure from a Shift . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9-21
Editing Shift Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9-22
Copying and Pasting a Shift. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9-23
Deleting a Shift Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9-24
Understanding Shift Structures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9-25
Shift Schedule Types and Shift Schedules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9-26
Creating a Shift Schedule Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9-26
Editing a Shift Schedule Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9-29
Deleting a Shift Schedule Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9-31
Viewing the Shifts in a Shift Schedule Type. . . . . . . . . . . . . . . . . . . . . . . . . . .9-31
Creating a Shift Schedule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9-33
Editing a Shift Schedule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9-35
Deleting a Shift Schedule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9-36
Overview of Shift Schedule Types and Shift Schedules . . . . . . . . . . . . . . . . . . .9-37
The Shift Schedule Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9-37
The Shift Schedule. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9-38
Using Shift Schedules in the Plant Hierarchy . . . . . . . . . . . . . . . . . . . . . . . . . . . .9-40
Adding a Shift Schedule to Groups and Assets. . . . . . . . . . . . . . . . . . . . . . . . .9-40
Editing the Rotation Plan. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9-43
Overwriting Historical Data for a Rotation Plan . . . . . . . . . . . . . . . . . . . . . . . .9-45
Removing a Schedule from the Rotation Plan . . . . . . . . . . . . . . . . . . . . . . . . .9-46
Using Shift Schedules in Groups and Assets . . . . . . . . . . . . . . . . . . . . . . . . . .9-47
Relationships Between Group and Asset Schedules . . . . . . . . . . . . . . . . . . . . .9-48
When you Delete a Shift Schedule From a Rotation Plan. . . . . . . . . . . . . . . . . .9-49
When You Add an Aset to a Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9-49
When You Edit or Delete the Rotation Plan for an Asset . . . . . . . . . . . . . . . . . .9-50
Viewing Shift Rotation Plans in the Grid . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9-50
Overlapping Shift Schedules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9-51
Introduction to Shift Editing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9-53
Accessing the Production Shift Editor. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9-54
Security Governing Access to the Production Shift Editor . . . . . . . . . . . . . . . . .9-54
Accessing the Production Shift Editor within MI Admin . . . . . . . . . . . . . . . . . . .9-55
Logging on to the Production Shift Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . .9-55
Getting Started. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9-57
Shift Editing Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9-57
User Access to Shift Owners. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-58
Creating a Shift Editing Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9-58
Editing a Shift Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9-59
Deleting a Shift Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9-60
Selecting a Shift Editing Group and Date . . . . . . . . . . . . . . . . . . . . . . . . . . . .9-61
Overview of Shifts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9-62
Using the Production Shift Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9-62
Recognizing Where Changes Have Occurred. . . . . . . . . . . . . . . . . . . . . . . 9-63
Shift Editing Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9-64
Rules Applied in Shift Editing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-64
Working in the Grid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9-65
Contents
CDC Factory 7.1
ActivEssentials Administration Guide
xi
Displaying All or Just Non-Productive Time in the Grid. . . . . . . . . . . . . . . . 9-65
Switching Between Shift Configuration and the Production Shift Editor . . . . . . . .9-65
Daily Schedule Changes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9-67
Changing the Shift Time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9-67
Inserting a Shift Period. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9-69
Editing a Daily Schedule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9-71
Shift Editing in the Grid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9-74
Reapplying Shifts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9-76
Reapplying Shifts to a Schedule. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9-76
Assigning Temporary Shift Plans. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9-80
Temporary Shift Plans . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9-80
Creating a Temporary Shift Plan . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9-81
Stopping a Temporary Shift Plan . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9-82
Deleting a Temporary Shift Plan . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9-83
Editing a Shift. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9-84
Inserting a Shift Period. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9-84
Editing Shift Periods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9-86
Deleting a Shift Period . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9-87
Creating and Modifying Shifts. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9-88
Overview of Shift Creation Using the Production Shift Editor . . . . . . . . . . . . . . .9-89
Creating a Shift . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9-89
Modifying a Shift . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9-90
Deleting a Shift . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9-92
Creating and Modifying Shift Periods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9-94
About Shift Periods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9-94
Creating a Shift Period . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9-95
Modifying a Shift Period . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9-95
Deleting a Shift Period . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9-96
Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9-97
Generating a Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9-97
About Shift Editing Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9-98
The Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-99
The Shift Audit Log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-102
Viewing Changes in the Shift Audit Log. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-102
Example of Saving Changes in the Audit Log. . . . . . . . . . . . . . . . . . . . . . . . . 9-103
Temporary Shift Plans . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-106
Creating a Temporary Shift Plan . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-106
Editing a Temporary Shift Plan . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-108
Stopping a Temporary Shift Plan . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-109
Deleting a Temporary Plan . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-109
Temporary Shift Plans . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-110
Chapter 10 Security in AppCenter
Introduction to Security in AppCenter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .10-2
The ActivEssentials Security Model . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .10-2
ActivEssentials Privileges . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .10-3
ActivEssentials Roles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .10-4
Predefined Roles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-5
The Default Role . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .10-6
ActivEssentials Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .10-8
Predefined Users. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-8
Users and User Names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-8
User Account Expiry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-9
The Guest User Account . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .10-9
Contents
CDC Factory 7.1
ActivEssentials Administration Guide
xii
How the Security Model Works . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .10-9
Granting, Denying, and Revoking Privileges . . . . . . . . . . . . . . . . . . . . . . . . . 10-10
Extended Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-10
What Happens When a User Logs On . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-11
Access to ActivApplications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-12
Access to the Production Shift Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-13
Creating Roles and Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-14
Opening the Security Configuration Module. . . . . . . . . . . . . . . . . . . . . . . . . . 10-14
Creating a Role . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-15
Creating a User . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-16
Assigning a User to a Role . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-18
Assigning a Role to a User . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-20
Changing a Users Password . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-21
Changing the Default Role. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-22
Deleting Users. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-23
Deleting Roles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-24
Editing the Properties of a User . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-24
Editing the Properties of a Role . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-27
Setting up Network Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-30
Adding Network Domains . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-30
Adding Network Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-31
Importing Network Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-33
Handling User Name Duplication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-35
Viewing and Editing Network Domains . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-35
Viewing and Editing Network Group Properties . . . . . . . . . . . . . . . . . . . . . . . 10-36
Deleting a Network Group. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-38
Setting Privileges in the Plant Hierarchy. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-39
Assigning a Role to a Plant Hierarchy Object . . . . . . . . . . . . . . . . . . . . . . . . . 10-39
Controlling User Access in the Plant Hierarchy. . . . . . . . . . . . . . . . . . . . . . . . 10-41
Privileges and the Plant Hierarchy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-41
System Roles and System Users. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-42
System Roles and the Plant Hierarchy . . . . . . . . . . . . . . . . . . . . . . . . . . 10-43
Changing and Removing Roles, Users, and Privileges . . . . . . . . . . . . . . . . . . . . . 10-44
Changing the Privileges Assigned to a User . . . . . . . . . . . . . . . . . . . . . . . . . . 10-44
Changing the Privileges Assigned to a Role . . . . . . . . . . . . . . . . . . . . . . . . . . 10-46
The Principle of Inheritance. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-48
Inheritance Between Roles and Users . . . . . . . . . . . . . . . . . . . . . . . . . . 10-48
Inheritance in the Plant Hierarchy. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-48
Rules for Changes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-50
Inheritance of Granted Privileges . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-51
Inheritance of Denied Privileges. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-52
Interaction Between Role Privileges and User Privileges . . . . . . . . . . . . . . . . . 10-53
Users with Overlapping Roles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-54
Removing a Role From a Parent Group1. . . . . . . . . . . . . . . . . . . . . . . . . . . 10-54
Removing a Role From a Parent Group2. . . . . . . . . . . . . . . . . . . . . . . . . . . 10-55
Improving Access to LDAP/Active Directory . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-56
Connecting to a Remote Domain . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-56
Improving Performance for Larger Networks . . . . . . . . . . . . . . . . . . . . . . . . . 10-56
Chapter 11 Extended Properties of Groups and Assets
Introduction to Extended Properties of Groups and Assets . . . . . . . . . . . . . . . . . . .11-2
The Extended Properties Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .11-2
The Interface. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .11-2
Data Collection Defined in ActivApplications . . . . . . . . . . . . . . . . . . . . . . . . . .11-3
Contents
CDC Factory 7.1
ActivEssentials Administration Guide
xiii
Using Extended Properties in the Plant Hierarchy . . . . . . . . . . . . . . . . . . . . . . . . .11-5
Opening the Extended Properties Module . . . . . . . . . . . . . . . . . . . . . . . . . . . .11-5
Creating Extended Properties for a Plant or Group . . . . . . . . . . . . . . . . . . . . . .11-5
Creating Extended Properties for Assets . . . . . . . . . . . . . . . . . . . . . . . . . . . . .11-7
Editing Extended Properties of Plants, Groups, or Assets . . . . . . . . . . . . . . . . 11-10
Copying an Extended Property. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-11
Deleting an Extended Property of a Plant, Group, or Asset . . . . . . . . . . . . . . . 11-12
Types of Extended Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-12
Chapter 12Schedules and Real-time Triggers
Introduction to Schedules and Real-Time Triggers . . . . . . . . . . . . . . . . . . . . . . . .12-2
The Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .12-2
Opening the Schedules & Real-Time Triggers Module . . . . . . . . . . . . . . . . . . . .12-3
Updating Changes in Schedules & Real-Time Triggers . . . . . . . . . . . . . . . . . . .12-3
The Schedules & Real-Time Triggers Interface. . . . . . . . . . . . . . . . . . . . . . . . .12-3
The Icons in the Grid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .12-5
Toolbar Buttons and Context Menu Items . . . . . . . . . . . . . . . . . . . . . . . . . . . .12-6
Scheduling ActivEssentials Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .12-9
Schedule Structures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .12-9
The Schedule Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-10
Scheduling Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-10
Daily Schedules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-10
Weekly Schedules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-10
Monthly Schedules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-11
Questions to Ask When Creating a Schedule . . . . . . . . . . . . . . . . . . . . . . . . . 12-11
Examples of Schedules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-11
Creating Schedules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-13
Creating a Schedule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-13
Creating New Schedules from Existing Schedules. . . . . . . . . . . . . . . . . . . . . . 12-15
Maintaining Schedule Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-17
Viewing and Editing Schedule Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-17
Deleting Schedules. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-19
Activating and Deactivating Schedules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-20
Defining and Maintaining Trigger Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-21
How Triggers are Built . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-21
Defining a Trigger . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-22
Creating a Trigger Template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-26
Defining a Trigger Using a Template. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-27
Copying a Real-Time Trigger . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-29
Modifying a Real-Time Trigger . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-30
Deleting a Real-Time Trigger . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-30
Chapter 13 Data Management
Introduction to Data Management. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13-2
Backward Compatibility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13-2
The Data Management Interface. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13-2
Opening the Data Management Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13-3
Data Archiving Frame. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13-3
Archive Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-4
Archive Logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-4
Restore Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-4
Toolbar Buttons and Context Menu Options. . . . . . . . . . . . . . . . . . . . . . . . . . .13-5
Summary of the Tasks in Data Management . . . . . . . . . . . . . . . . . . . . . . . . . .13-7
Archive ConfigurationAvailable Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . 13-8
Contents
CDC Factory 7.1
ActivEssentials Administration Guide
xiv
Archive LogsAvailable Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-9
Restore DataAvailable Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-10
Data Archiving . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-11
Setting up Data Archiving in System Settings . . . . . . . . . . . . . . . . . . . . . . . . 13-11
Setting the Working Folder and Other Archive Settings. . . . . . . . . . . . . . . . . . 13-13
System Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-16
How Much Data to Include in an Archive. . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-16
Options for Data Archiving . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-17
Data Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-18
Data Items. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-18
Groups and/or Assets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-18
What Does the Scope Include? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-18
Age Before Expiry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-19
Archiving Actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-19
Oldest Date in Archive. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-19
Database Performance During a First Archive . . . . . . . . . . . . . . . . . . . . . . . . 13-20
Purging as an Archiving Activity. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-20
Understanding the Properties of Archives and Archive Files . . . . . . . . . . . . . . . . . 13-22
What to Expect When Creating Archive Definitions. . . . . . . . . . . . . . . . . . . . . 13-23
The Properties of Archive Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-24
Archive Configuration Best Practices. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-25
Understanding the Archive and Restore Logs . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-26
The Properties of the Archive Master Log . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-26
Understanding the Archive Detailed Logs . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-29
Properties in the Archive Detailed Log for Data Types . . . . . . . . . . . . . . . 13-29
Properties in the archive Detailed Log for Groups/Assets . . . . . . . . . . . . . 13-31
Understanding the Restore Data Logs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-32
Properties Available in Restore Data Grid. . . . . . . . . . . . . . . . . . . . . . . . 13-33
Properties in the Restore Logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-34
Properties in the Restore Detailed Log for Data Types . . . . . . . . . . . . . . . 13-34
Properties Available in the Restore Detailed Log for Groups/Assets . . . . . . 13-35
Managing the Archive Logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-35
Initial Configuration of Data Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-36
Creating a New Archive Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-36
Creating an Archive or Purge Schedule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-40
The Schedule Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-44
The Archive and Purge Jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-44
Database Performance and Schedules . . . . . . . . . . . . . . . . . . . . . . . . . . 13-44
Maintaining Configuration in Data Management . . . . . . . . . . . . . . . . . . . . . . . . . 13-45
Editing the System Archive Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-45
Modifying Archive and Purge Schedules . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-46
Deleting Archive and Purge Schedules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-49
Deleting Archive Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-50
Viewing the Logs and Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-52
Viewing and Editing the Archive Definition Properties . . . . . . . . . . . . . . . . . . . 13-52
Viewing the Archive Master Logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-57
Filtering the Archive Logs Grid. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-58
Viewing the Archive Detailed Logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-60
Viewing and Editing the Properties of a Restore Definition. . . . . . . . . . . . . . . . 13-61
Viewing the Restore Logs and Detailed Logs . . . . . . . . . . . . . . . . . . . . . . . . . 13-66
Filtering the Restore Data Grid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-68
Manual Archiving Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-70
Restoring Data from the Archives . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-70
Retrying a Failed Restore Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-75
Contents
CDC Factory 7.1
ActivEssentials Administration Guide
xv
Cancelling a Restore Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-76
Deleting a Restore Definition. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-77
Reprocessing Archived Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-77
Cancelling the Reprocess of Restored Data . . . . . . . . . . . . . . . . . . . . . . . . . . 13-78
Purging Restored Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-79
Cancelling the Purge Restored Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-80
Re-archiving Previously Archived Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-80
Cancelling a Re-Archive Instruction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-81
Deleting the Detailed Log for Groups/Assets . . . . . . . . . . . . . . . . . . . . . . . . . 13-82
What to Expect When Restoring Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-83
Data Restoration Set Up . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-84
Restore Definition Scheduling. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-84
Data Validation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-85
Limitations to Manual Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-85
Re-Archiving vs. Reprocessing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-86
Manual Actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-86
Active Restorations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-87
Manual Data Editing Violations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-87
Data Restore Mode Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-88
Changes and Cancellations of Scheduled Restorations . . . . . . . . . . . . . . . 13-89
Restore Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-89
Purge Restored Data Option. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-89
Data ManagementSupplementary Information. . . . . . . . . . . . . . . . . . . . . . . . . 13-90
How the Database Handles Data Archiving and Purging . . . . . . . . . . . . . . . . . 13-90
Data Archiving and Purging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-90
Data Archiving . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-92
Archived Data Verification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-95
Data Purging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-95
Archiving and Purging as Data Ages . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-96
Effects of Plant Hierarchy Reorganization . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-99
What to Do If You Need to Reorganize the Plant Hierarchy. . . . . . . . . . . . 13-99
Avoiding the Need to Restore and Re-Archive. . . . . . . . . . . . . . . . . . . . 13-100
Effects of Changing Archive Definitions. . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-100
Status of Archive Only Data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-100
Relationship to Other Data Management Activities . . . . . . . . . . . . . . . . . . . . 13-101
Swapping Data During DST Rollback Period . . . . . . . . . . . . . . . . . . . . . 13-101
Manual Data Editing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-101
Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-103
Privilege Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-104
Security for Archived Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-104
Chapter 14 Report Administration
Introduction to Reports Administration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .14-2
Getting Started in Reports Administration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .14-2
Opening the Reports Administration Module . . . . . . . . . . . . . . . . . . . . . . . . . .14-3
The Reports Administration Window. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .14-4
What You Will Do in Reports Administration . . . . . . . . . . . . . . . . . . . . . . . . . .14-6
Define One or More Report Servers. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-6
Create Report Categories and Styles . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-6
Administer Report Creation and Delivery . . . . . . . . . . . . . . . . . . . . . . . . . 14-7
Create and Administer Report Folders . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-7
How the Parts Fit Together . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .14-7
The Content Task Category . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-7
The Folders Task Category. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-8
Contents
CDC Factory 7.1
ActivEssentials Administration Guide
xvi
The Delivery Task Category . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-9
Putting it all together . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-9
How Much Hard Drive Space Do I Need?. . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-10
Reports Administration and the Report Viewer. . . . . . . . . . . . . . . . . . . . . . . . 14-11
Administrator and Non-Administrator Privileges in the Report Viewer . . . . 14-12
Reporting Privileges and User Levels . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-12
Folders and Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-13
Folder Navigation in Reports Administration . . . . . . . . . . . . . . . . . . . . . . . . . 14-13
Folders and Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-14
System Folders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-14
Limits to System Folders. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-15
How the Limits Work . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-15
Shared Folders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-16
Personal Folders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-16
Report Contents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-17
Report Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-17
Report Categories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-18
Report ProvidersWhich is Best for You? . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-18
Report Styles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-19
Creating a New Report Style . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-20
Overview of Report Templates. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-21
Time Frames for Report Templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-21
Distribution of Reports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-24
Schedule Structures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-24
Scheduled Reports and Report Distributions . . . . . . . . . . . . . . . . . . . . . . . . . 14-25
Scheduled reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-25
Report Styles in Scheduled Reports. . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-25
Template Suitability . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-26
Report Distributions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-27
Options for Report Distribution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-27
Configuring Folders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-29
Determining Realistic Limits for Folder Contents . . . . . . . . . . . . . . . . . . . . . . 14-29
Setting Default Limits for System Folders . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-30
Controlling Report Storage Limits By Role. . . . . . . . . . . . . . . . . . . . . . . . . . . 14-31
Controlling Report Storage Limits By User. . . . . . . . . . . . . . . . . . . . . . . . . . . 14-33
Creating a New Shared Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-34
Creating a New Shared Folder From an Existing Folder . . . . . . . . . . . . . . . . . . 14-35
Assigning Users to a Shared Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-36
Configuring Report Content . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-40
Setting Up a Report Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-40
Creating New Report Servers From Existing Servers. . . . . . . . . . . . . . . . . . . . 14-42
Creating a Report Category. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-43
Creating a New Report Category From an Existing Category . . . . . . . . . . . . . . 14-48
Linking to a Report Style . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-49
Creating a New Report Style From an Existing Style. . . . . . . . . . . . . . . . . . . . 14-50
Creating a Report Template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-51
Choosing Groups and AssetsAPRS SP-XML Report Template . . . . . . . . . . . . . 14-54
Choosing a Time FrameAPRS SP-XML Report Template . . . . . . . . . . . . . . . . 14-55
Choosing Data ItemsAPRS-SP XML Report Template . . . . . . . . . . . . . . . . . . 14-59
Enabling Scheduling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-60
Creating an Incident Reason Code Report Template . . . . . . . . . . . . . . . . . . . . 14-64
Structure of Report Content . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-67
Creating Legacy ReportsWizards For APRS SP-XML Report Categories . . . . . . 14-67
Using the Accumulator or Accumulator Summary Data Items Wizard . . . . . . . . 14-68
Contents
CDC Factory 7.1
ActivEssentials Administration Guide
xvii
Using the Event or Event Summary data items wizard . . . . . . . . . . . . . . . . . . 14-69
Using the Incident or Incident By Identifier Data Items Wizard . . . . . . . . . . . . 14-70
Using the Incident Summary Data Items Wizard . . . . . . . . . . . . . . . . . . . . . . 14-71
Using the Birth History Data Items Wizard . . . . . . . . . . . . . . . . . . . . . . . . . . 14-71
Filtering Options in Incident Reason Code Report category. . . . . . . . . . . . 14-72
Configuring Delivery Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-75
Creating a Scheduled Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-75
Creating a New Scheduled Report From an Existing Report . . . . . . . . . . . . . . . 14-79
Creating a Report Distribution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-80
Duplicating an Existing Report Distribution . . . . . . . . . . . . . . . . . . . . . . . . . . 14-86
Maintaining Folders and Content . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-88
Viewing and Editing System Folder Properties . . . . . . . . . . . . . . . . . . . . . . . . 14-88
Deleting a Users System Folder Contents. . . . . . . . . . . . . . . . . . . . . . . . . . . 14-89
Editing the Properties of Shared Folders . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-90
Deleting a Shared Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-90
Removing Users From a Shared Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-91
Deleting Reports From a Shared Folder. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-93
Viewing Properties of Personal Folders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-94
Deleting Reports From Personal Folders . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-95
Maintaining Report Content . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-96
Viewing and Editing Properties of Report Servers. . . . . . . . . . . . . . . . . . . . . . 14-96
Deleting a Report Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-97
Editing the Group/Asset List Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-98
Editing the Time Frame Definitions Parameter . . . . . . . . . . . . . . . . . . . . . . . 14-100
Viewing and Editing Data Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-105
Editing Report Parameters for APRS SP, APRS Query Server, and SQL Reporting Services
14-107
Changing a Report Template Style . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-107
Editing Report Template Destinations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-108
Editing the General Report Template Properties. . . . . . . . . . . . . . . . . . . . . . 14-109
Creating New Templates From Existing Report Templates . . . . . . . . . . . . . . . 14-112
Deleting a Report Template. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-113
Deleting all Templates in a Report Category . . . . . . . . . . . . . . . . . . . . . . . . 14-114
Viewing and Editing Properties of a Report Category . . . . . . . . . . . . . . . . . . 14-115
Deleting a Report Category . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-119
Viewing and Editing Properties of Report Styles . . . . . . . . . . . . . . . . . . . . . . 14-120
Deleting a Report Style. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-121
Viewing a Report Template Definition. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-122
Maintaining Data Item Configuration for APRS SP, APRS Query Server, and SQL Reporting
Service Report Categories. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-122
Maintaining Report Template Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-123
Maintaining Report Scheduling and Delivery. . . . . . . . . . . . . . . . . . . . . . . . . . . 14-124
Viewing the General Properties of a Scheduled Report . . . . . . . . . . . . . . . . . 14-124
Viewing and Editing Templates for Scheduled Reports . . . . . . . . . . . . . . . . . 14-125
Viewing and Editing the Schedule for a Scheduled Report . . . . . . . . . . . . . . . 14-128
Viewing and Editing the Delivery Instructions for a Scheduled Report. . . . . . . 14-130
Deleting a Scheduled Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-131
Viewing and Editing Report Distribution Properties . . . . . . . . . . . . . . . . . . . . 14-132
Deleting a Report Distribution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-137
Viewing the Properties of Scheduled Reports. . . . . . . . . . . . . . . . . . . . . . . . 14-138
Maintaining Report Distributions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-138
Database Rules for Cleaning up Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-139
Report References . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-139
Report References for Scheduled Reports . . . . . . . . . . . . . . . . . . . . . . . . . . 14-140
Contents
CDC Factory 7.1
ActivEssentials Administration Guide
xviii
Report Clean-up . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-140
Report Generation and a Users Folder Limits . . . . . . . . . . . . . . . . . . . . . . . . . . 14-141
Failure to Create a Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-141
Chapter 15Retroactive Incident Editing
Introduction to Retro Stop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15-2
How Retro Stop Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15-2
Changing the Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15-2
Incident Priorities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-4
Incident Merging. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-4
Retro Stop in Action . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15-4
The First Incident Occurs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-5
The Retro Stop Button is Pressed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-5
The Retro Stop Incident Starts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-6
The Retro Stop Incident Stops . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-6
The Correct Incident Starts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-6
The Correct Incident Ends . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-7
How the Database Handles Allowed Gap Timing Errors . . . . . . . . . . . . . . . . . . .15-7
Consequences of Misapplying Retro Stop . . . . . . . . . . . . . . . . . . . . . . . . . . . .15-9
Comparing Retro Stop with Root Cause Analysis . . . . . . . . . . . . . . . . . . . . . . 15-10
Retro Stop Methodology . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-10
Root Cause Analysis Methodology . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-11
Coexistence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-11
Retro Stop Set Up. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-12
Setting up Retro Stop in the System Settings . . . . . . . . . . . . . . . . . . . . . . . . 15-12
Creating the Retro Stop Incident Definition . . . . . . . . . . . . . . . . . . . . . . . . . . 15-14
Editing the Properties of the Retro Stop Incident Definition . . . . . . . . . . . . . . . 15-16
Adding Retro Stop Enabled Incident Categories to an Asset . . . . . . . . . . . . . . 15-18
Adding the Retro Stop Incident Item to an Asset Using a Wizard . . . . . . . . . . . 15-20
Adding the Retro Stop Incident Item to an Asset Using the Grid . . . . . . . . . . . 15-23
Enabling Incident Categories to Use Retro Stop . . . . . . . . . . . . . . . . . . . . . . . 15-25
Configuring the HMI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-26
The Retro Stop System Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-27
Effect of Disabling Incident Priorities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-27
Glossary
Index
CDC Factory 7.1
ActivEssentials Administration Guide
1-1
ActivEssentials Administration
ActivEssentials Administration
CDC Factory 7.1
ActivEssentials Administration Guide
1-2
Introduction to MI Admin
Welcome to the ActivEssentials MI Admin. MI Admin is hosted in the
AppCenter application container, which is the Web client that hosts all
of the ActivEssentials web-based applications.
This guide covers the administration of ActivEssentials.
This chapter covers the following topics:
The AppCenter (MI Admin) Window on page 1-2
Building your Data Collection System in MI Admin on page 1-24
The AppCenter (MI Admin) Window
MI Admin is deployed within AppCenter. It consists of a series of task
modules that you use to administer your ActivEssentials installation,
each of which appears as a web page.
This section covers the following topics:
Testing and Viewing the System Requirements on page 1-3
Logging onto MI Admin on page 1-4
Changing your Password on page 1-5
Restarting, Shutting Down, and Locking AppCenter on page 1-6
System Requirements on page 1-8
The MI Admin Window on page 1-9
The MI Admin Toolbar on page 1-10
Using Keyboard Shortcuts in MI Admin on page 1-11
The MI Admin Taskbar on page 1-12
Plant Hierarchy on page 1-14
Keyboard Shortcuts in the Plant Hierarchy on page 1-16
The Secondary Frame on page 1-16
The Grid on page 1-17
Illegal Characters on page 1-17
The Status Bar on page 1-18
Common Functions Within MI Admin on page 1-20
The Copy and Paste Functions on page 1-21
Note: Should you have difficulty in logging onto AppCenter, refer to the
Troubleshooting AppCenter section in the System Configuration Guide
(System Configuration Guide.pdf), which is located within the ActivEssentials
installation package.
ActivEssentials Administration
CDC Factory 7.1
ActivEssentials Administration Guide
1-3
Testing and Viewing the System
Requirements
Use the instructions below to check and view the system requirements
for using MI Admin (or any other application within AppCenter) on
your computer. If you have found that some functions in AppCenter
have not worked as expected, your computer might need additional
updates to ensure full functionality.
Prerequisites
Before doing this you need to have done or read the following:
Read System Requirements on page 1-8 for an understanding of
what is required.
Access the AppCenter log on window, but do not log on.
Procedure
1 Checking system requirements
2 Click on the Check System Requirements link at the bottom of
the Log On dialog box.
The Activplant Requirements window opens in a new browser
window.
ActivEssentials Administration
CDC Factory 7.1
ActivEssentials Administration Guide
1-4
Figure 1-1 The Activplant Requirements window
3 View the Status column to determine if your system fulfils the
minimum needs for viewing ActivEssentials and its components.
4 View the Current column to determine the version numbers of the
software installed relative to the Required and Recommended
columns.
5 Click on the underlined links to access files for upgrading your
system, if necessary.
6 Close the Activplant Requirements window to return to the Log On
window.
Logging onto MI Admin
Use the instructions below to open the MI Admin window on your
computer. You will need a user name and password that should be
supplied by your administrator. Your administrator should also supply
the Web address for AppCenter. The exact address will depend on the
name of the server that hosts the ActivEssentials server components.
You must have Microsoft Internet Explorer 6.0 or later installed on
your computer.
Prerequisites
Before doing this you need to have done or read the following:
AppCenter has a prerequisite software environment on the
computers where it is viewed, so you check this before you start.
See Testing and Viewing the System Requirements on page 1-3 for
more information.
Note: Read the text at the bottom of the Activplant Requirements window for quick
confirmation of your computers suitability for running ActivEssentials. For
further details, read the instructions below.
ActivEssentials Administration
CDC Factory 7.1
ActivEssentials Administration Guide
1-5
Procedure
1 Log on to your corporate network using the user name and
password given to you by your administrator.
2 Open Internet Explorer and type the URL for AppCenter into the
Address field and press the Enter key.
The AppCenter Log On dialog box opens.
Figure 1-2 The AppCenter Log On dialog box
3 In the dialog box, select the MI Admin application option, enter
your user name and password, and then click Log On. If you are a
network user, you will need to enter your user name in the
following format: domainname\username.
If you receive error messages, such as Permission denied or
Unknown name when trying to log on, contact your system
administrator. For further information, see Setting up Internet
Explorer for use with AppCenter in the System Configuration
Guide (System Configuration Guide.pdf), which is part of the
installation package.
If when you try to log on, the Log On dialog box refreshes and
displays the message that Log on failed: unable to contact
foundation at... you have tried to contact a server on which
VPFoundation is either not installed or not running.
4 When MI Admin opens, select the module in which you need to
work.
Changing your Password
Use the instructions below to change your password. If you are a
network (trusted) user, you will not be able to change your password
here.
Note: The Log on as Administrator checkbox allows only those users with the right
User name and Password to access the chosen AppCenter application with
administrator privileges.
ActivEssentials Administration
CDC Factory 7.1
ActivEssentials Administration Guide
1-6
Prerequisites
Before doing this you need to have done or read the following:
AppCenter has a prerequisite software environment on the
computers where it is viewed, so you check this before you start.
See Testing and Viewing the System Requirements on page 1-3 for
more information.
Access the AppCenter log on window, but do not log on.
Procedure
1 Accessing the Change Password dialog box.
2 Click the Change Password link.
The Change Password dialog box opens where you can make the
change.
3 Do the following:
a) Type your Username and current Password in the
appropriate fields.
b) Type your new password into both the New Password and
Verify New Password fields.
The password must contain at least 6 and no more than 20
characters, and is case sensitive.
4 Click the Confirm button.
You can log on with your new password.
Restarting, Shutting Down, and Locking
AppCenter
Use the instructions below to restart, lock or shut down AppCenter. If
you lock it, nobody can access it without entering a password.
1 With AppCenter open, do one of the following:
a) Click the Shut Down (F4) button on the toolbar, or
b) Press the F4 function key on your keyboard.
ActivEssentials Administration
CDC Factory 7.1
ActivEssentials Administration Guide
1-7
Figure 1-3 Shutting down AppCenter
The AppCenter Shutdown dialog box appears.
Figure 1-4 The AppCenter Shut Down dialog box.
2 Do one of the following:
a) To shut down, select Shut Down in the drop-down list, then
click OK.
b) To restart AppCenter, select Restart and click OK.
c) To lock the screen, select Lock AppCenter and click OK.
Note: If you choose the Lock AppCenter option, a log on dialog immediately opens.
You must log on again before you can continue working.
ActivEssentials Administration
CDC Factory 7.1
ActivEssentials Administration Guide
1-8
System Requirements
Before using AppCenter or any of its component modules, such as
VPWeb or MI Admin, you should check to see if your computer system
has all the necessary software to view AppCenter properly. The table
below gives an outline of the software components required for
successful use of AppCenter.
Note: The locked-out Log On dialog box.
Table 1-1 System requirements for viewing AppCenter modules
Component Recommend
ed
Installation
Minimum
Requirement
s
Comments
Operating System: Windows 98, ME, XP, 2000, or 2003 Server.
Internet
Explorer
6.0 SP1 or
better
6.0 or better Install all options available with the
Internet Explorer installation
JavaScript Enabled Enabled Installed as a part of the Internet
Explorer full installation
MSXML 2.0 through
4.0
4.0 As a minimum requirement, MSXML
4.0 must be installed. However you
will obtain further functionality if
versions 2.0 through to 4.0 are also
installed. The Activplant
Requirements dialog box provides
a link to the installation files on the
VPFoundation server for MSXML 4.0
only. You can obtain versions prior
to 4.0 from the Microsoft web site.
VML 6.0 or better 5.5 or better Installed as a part of the Internet
Explorer full installation.
Direct
Animation
6.0 or better None Installed as a part of the Internet
Explorer full installation. Although
Direct Animation is not required, it
is useful for future applications.
MDAC 2.7 or better Obtain the application
(mdac_typ.exe) from the Microsoft
web site.
.NET
Framework
2.0 or better None This is not a requirement but will be
required for future developments.
The AppCenter Requirements
dialog box provides a link to the
installation files on the
VPFoundation server.
ActivEssentials Administration
CDC Factory 7.1
ActivEssentials Administration Guide
1-9
The MI Admin Window
The MI Admin window contains the following elements:
The MI Admin toolbar. The toolbar contains several buttons.
Some buttons remain visible always because they belong to the
container itself. Other buttons appear on the toolbar depending on
the AppCenter module that you are using. For further information
see The MI Admin Toolbar on page 1-10.
The MI Admin taskbar. The taskbar contains category buttons
and individual module buttons. You have to select a category
button first, such as System, then select the appropriate module
button to open the module. For further information see The
MI Admin Taskbar on page 1-12.
The Plant Hierarchy frame. This frame displays the access path
with the plant, groups and assets that you have defined. It also
contains the Object Library, which is a repository for global items
that you create, and ActivApplications, which stores additional
packaged applications (such as Throughput Analyzer) for use in
ActivEssentials. In most modules you work with the Object Library
as well as with the plant hierarchy itself. For further information
see Plant Hierarchy on page 1-14.
Figure 1-5 The Plant Hierarchy frame
The Secondary frame.
This frame opens below the Plant Hierarchy frames, and changes
its name and its contents depending on the module in which you
are working. It often contains buttons which allow you to choose
among the tasks that are available in the module. For further
information see The Secondary Frame on page 1-16.
ActivEssentials Administration
CDC Factory 7.1
ActivEssentials Administration Guide
1-10
The Grid. The grid displays details of the items that have been
created in MI Admin. The contents of the grid vary depending on
the module that you have selected, the item selected in the Plant
Hierarchy frame, and the item selected in the secondary frame. For
further information see The Grid on page 1-17.
Figure 1-6 Collection categories displayed in the grid
The Status bar. The status bar usually appears at the very
bottom of the AppCenter window, and displays information about
the module selected and the integrity of the system. On the right
side of the status bar is a Document Status Indicator and the
Connection Integrity monitor. For further information see The
Status Bar on page 1-18.
The MI Admin Toolbar
The toolbar contains several buttons that are permanently displayed.
These are as follows:
ActivEssentials Administration
CDC Factory 7.1
ActivEssentials Administration Guide
1-11
Other buttons appear on the toolbar, depending on the module that
you have displayed and the functions you are using.
Using Keyboard Shortcuts in MI Admin
There are several keyboard shortcuts available for use in MI Admin.
Keyboard shortcuts allow you to access many of the often used
functions in the MI Admin without having to use the mouse.
Table 1-2 The MI Admin toolbar buttons
Icon and Name Used for
Show/Hide Frames Opens a menu with options that allow you to toggle the
display of the taskbar and the Plant Hierarchy frame. This
can also be done as required by clicking the arrow in a
taskbar category or Plant Hierarchy frame. See Minimizing
the Taskbar on page 1-13.
Shut Down (F4) Allows you to shut down, restart, or lock AppCenter.
Refresh (F5) Refreshes the information displayed in AppCenter.
However, if you wish to refresh all of the data in
AppCenter, hold the Ctrl button down when clicking the
Refresh button.
Options (F10) Opens a dialog box in which you can set options for
working in AppCenter. For more information, see
AppCenter Options on page 1-19.
Show Help (F1) Opens the Help system with information relating to the
operation of MI Admin.
Table 1-3 General keyboard shortcuts for AppCenter
Keyboard shortcuts What they do
F11 Shows or hides the Taskbar and Plant Hierarchy frames.
Ctrl+F11 Shows or hides the Taskbar frame.
Shift+F11 Shows or hides the Plant Hierarchy (and secondary frame, if
displayed).
F5 Causes the information, in all displayed frames, in AppCenter
to be refreshed.
Ctrl+F5 Causes AppCenter to completely reload.
F10 Shows the Options window.
Ctrl+F10 Loads the AppCenter Profiler and sets AppCenter into debug
mode.
F1 Opens the Help system.
F4 Opens the Shut Down window.
Alt+F4 Closes AppCenter down immediately.
ActivEssentials Administration
CDC Factory 7.1
ActivEssentials Administration Guide
1-12
The MI Admin Taskbar
There are many task modules in MI Admin, more than can be
displayed in the taskbar at any one time. To simplify the interface,
these tasks are grouped into categories that you access by first
clicking the appropriate category button at the top or bottom of the
taskbar, and then clicking the module button (icon) representing the
module you need to access.
The number of categories, and the modules available within them,
may vary depending on whether your administrator has added or
removed some. The following will probably be present:
System. This category gives access to the modules that control
the system environment for ActivEssentials.
Configuration. This category contains the modules that allow you
to configure the data collection, reporting, and data archiving
functions in ActivEssentials.
Applications. This category contains modules that can either be
used as separate programs, or that can provide data to external
sources.
Help. This category allows you to access Help, and information
about AppCenter.
If you right-click anywhere in the taskbar you have the option to run
modules that are not represented on the taskbar itself. For more
information, see AppCenter Options on page 1-19.
The Taskbar Organization
To access the task modules in MI Admin, you must first select the
appropriate category button within the taskbar, and then click the
module button. The organization of these task modules appears are
shown below:
Ctrl+Alt+F5 Locks AppCenter.
Ctrl+F4 Closes the current view.
Ctrl+Arrow keys Use to navigate through the plant hierarchy. See Keyboard
Shortcuts in the Plant Hierarchy on page 1-16 for further
information.
Table 1-3 General keyboard shortcuts for AppCenter (Continued)
Keyboard shortcuts What they do
ActivEssentials Administration
CDC Factory 7.1
ActivEssentials Administration Guide
1-13
Figure 1-7 The MI Admin taskbar for each of the categories
Minimizing the Taskbar
The System taskbar category has an arrow that when clicked, will
minimize the taskbar (if it is displayed), or maximize it if it is not
displayed. This can be helpful if you are using the grid to configure the
plant, and require more space to see grid columns.
When the taskbar is minimized, a smaller version of the module icons
appear along the left side of the screen, and the active taskbar
category is highlighted. The icons retain the taskbar organization; the
icons beneath the active module are the other icons for the other
modules within the taskbar category.
ActivEssentials Administration
CDC Factory 7.1
ActivEssentials Administration Guide
1-14
In the image example, the Taskbar category is System. The active
module is System Settings; the icon beneath it is Extended Properties.
The System Taskbar category is highlighted since System Settings is
within the System category.
To access modules within another category, click a category icon. The
module icons become the first in the minimized taskbar frame.
Plant Hierarchy
The Plant Hierarchy frame displays the plant hierarchy that belongs to
your data collection system. This includes the plants, groups, and
assets that you define in the Plant Management module.
To navigate in the plant hierarchy, click the and signs beside the
items in the hierarchy. Alternatively, you can double-click an item to
show or hide its descendants. For more information about the plant
hierarchy, see The Plant Hierarchy Concept on page 3-3.
Plants, Groups and Assets
A plant is the highest level in the hierarchy. It represents an
ActivEssentials database. Usually (but not necessarily) the plant
represents a single manufacturing facility. Plants can have either
groups or assets as their direct descendants in the plant hierarchy.
A group is any organizational item that you want it to be. It may be a
department, area, production line, or anything else you want to name
it. Groups can have either groups or assets as their direct descendants
in the plant hierarchy.
An asset is the lowest level of the plant hierarchy and usually
represents a machine or PLC. It is a point at which data collection
occurs.
Plants, groups, and assets in the hierarchy have their own icons. The
icons have different colors depending on whether the item is active or
inactive.
ActivEssentials Administration
CDC Factory 7.1
ActivEssentials Administration Guide
1-15
Object Library
The Object Library appears below the plant hierarchy in the Plant
Hierarchy frame (it is absent from some modules). It is a repository
for items that you can apply to plants, groups, or assets in the plant
hierarchy.
Example
For example, you may register an OPC server in the Object Library.
The OPC server is then available to be assigned to any asset in the
hierarchy.
Or you may create a calculation template in the Object Library. You
can then use this calculation template as a basis for a calculation on
any plant hierarchy object.
In many of the MI Admin modules you first create objects (for
example, OPC servers, VPCollectors, etc.) in the Object Library, and
later apply them to items in the plant hierarchy.
Minimizing the Plant Hierarchy Frame
You can also minimize or maximize the Plant Hierarchy and any
secondary frames by clicking the arrow on the Plant Hierarchy frame.
Table 1-4 Icons used in the Plant Hierarchy frame
Icon Meaning
Plant
Active group. The icon is colored.
Inactive group. The icon is greyed. If a group is inactive none of the
assets below it will collect data.
Active asset. The icon is colored.
Inactive asset. The icon is greyed. If an asset is inactive it will not collect
data.
Note: Note that active and inactive in this context refer to whether the plant, asset
or group has been activated. It does not mean that the item is currently
selected in the hierarchy.
ActivEssentials Administration
CDC Factory 7.1
ActivEssentials Administration Guide
1-16
Once the frame is minimized, you will see the selected plant hierarchy
item appear sideways within the compressed frame. You can maximize
the frame again by clicking the arrow at the top of the Plant Hierarchy
frame. To select another object from the Plant Hierarchy frame, or to
access any secondary frames, the frame needs to be fully displayed.
Keyboard Shortcuts in the Plant Hierarchy
The table below lists some common keyboard shortcuts that you can
use when navigating in the plant hierarchy in MI Admin.
The Secondary Frame
This frame appears below the Plant Hierarchy frame in most modules
of MI Admin. It appears automatically when needed; the frames name
changes from module to module, and sometimes within a module. It
may contain buttons that allow you to access the different functions
within the module, or a folder hierarchy. You cannot close this frame
when it is present, however it becomes minimized when the Plant
Hierarchy frame is minimized. Sometimes you can switch views in this
frame; if so, horizontal buttons appear at the top or bottom of it.
Table 1-5 Keyboard shortcuts used in the plant hierarchy
Keyboard command Action
These commands move the highlight, but do not move the selection until they are
accepted. To accept the command, type Ctrl+Enter afterwards. To cancel the
command, type Ctrl+Delete afterwards.
Ctrl + Up Move up the tree
Ctrl + Down Move down the tree
Ctrl + Left Expand or Collapse the tree
Ctrl + Right Expand or Collapse the tree
These commands move the highlight and the selection immediately.
Ctrl + Home Move to the top of the tree
Ctrl + End Move to the bottom of the tree
ActivEssentials Administration
CDC Factory 7.1
ActivEssentials Administration Guide
1-17
The Grid
The grid lists items that have been created, along with some of their
properties. The contents of the grid vary depending on the following
factors:
The module in which you are working.
The function within the module, as selected in the secondary
frame.
Whether you have selected the Object Library or a plant hierarchy
object (group or asset) in the Plant Hierarchy frame.
The grid may span several pages. To move to other pages, click the
arrow buttons at the top of the grid. However, the title of the grid
indicates the number of items displayed.
Items in the grid have an icon at the left side. The icon may change
color, depending on the status of the item it represents. For
information about an item in the grid, hover your mouse pointer over
its icon.
Editing in the Grid
Many of the properties of items in the grid are visible there, and you
can often edit these properties by clicking or double-clicking in the
appropriate column of the grid. When you edit in the grid, a pencil icon
appears on the left of the row. To save your changes, press Esc or
click outside the row you were editing; the pencil icon is replaced by
the regular icon for the item.
You can also create new items in the grid. To do so, go to the bottom
row of the grid, which has a beside it. Click or double-click in the
columns and enter the required information. The new item will be
saved when you click outside the row.
Illegal Characters
As you set up the various elements in ActivEssentials, you will need to
name each of these to suit your purposes. When creating new names,
there are restrictions to the characters you can use as their use can
lead to errors.
The restrictions can vary in different parts of ActivEssentials because
of the way the names are used by both ActivEssentials and Windows.
There are no restrictions to the characters you can use in descriptions;
the restrictions concern only the names you create.
Note: If you know the item number, enter it directly in the Items box, and press
Enter.
Note: To avoid errors, we recommend you use only the normal alphabetic and
numeric characters for any names you create.
ActivEssentials Administration
CDC Factory 7.1
ActivEssentials Administration Guide
1-18
Specifically, you cannot use the following characters in the names for
any reports: . ( ) ' " _ - / \ * ? |
Naming restrictions are less severe elsewhere in ActivEssentials, but
the following will still cause errors: . ( ) ' ". When naming plant
hierarchy items, in addition to the illegal characters already
mentioned, do not use an ampersand (&).
The Status Bar
The status bar displays useful information that varies according to the
module and to what you are doing. There are two status indicators on
the status bar: the Document Status Indicator and the Connection
Integrity Monitor.
The Document Status Indicator
This is a small icon on the right side of the status bar. The indicator
can have any of three forms:
The Connection Integrity Monitor
The Connection Integrity monitor is at the bottom right-hand corner of
the AppCenter window. If you rest your mouse pointer over it, you will
see a tool-tip showing the percentage integrity. The color of the
monitor changes from green to red when the connection integrity is
low or the connection is broken. If you need further information, click
on the icon and a message window appears with details of the elapsed
time since you connected to the server.
In most cases the monitor will show readings of 85100%, indicating
that the response time from VPFoundation is good. AppCenter will
function without problem with a Connection Integrity value of down to
50%. If the value goes down to 30% you will experience problems,
such as freezing. In this case you should either close AppCenter and
re-connect, or investigate and rectify the cause of the delay.
Table 1-6 The Document Status indicator
Icon Meaning Occurs when
Red checkmark The document displayed in the
AppCenter is a recognized
AppCenter module.
This is the usual appearance
when you are using AppCenter
modules that are known to
ActivEssentials.
Yellow warning The document displayed in the
AppCenter is not a recognized
AppCenter module.
The administrator has
specifically allowed
non-AppCenter documents to
be displayed, and the current
document is not an AppCenter
module.
Red no-entry
sign
The document displayed in the
AppCenter is not a recognized
AppCenter module and is not
in the same domain as
AppCenter.
The administrator has
specifically allowed documents
in other domains to be
displayed (for example,
external web sites).
ActivEssentials Administration
CDC Factory 7.1
ActivEssentials Administration Guide
1-19
How the Connection Integrity Monitor Works
The monitor measures the VPFoundation response time. It sends a
regular status check call to VPFoundation and times the response. The
percentage for connection integrity depends on the rapidity of
response from VPFoundation. The following factors can degrade the
response time:
Increased network traffic between VPFoundation and the
AppCenter client.
The load on VPFoundation. Tests indicate that this is unlikely to
cause a significant loss of connectivity.
Accessing VPFoundation through a slow modem, such as a 14.4
kbps dial-up modem, can lead to connectivity problems. The
bandwidth available may not be sufficient to allow for good
communication. A 56K modem should not cause a loss of
connectivity.
When VPFoundation stops responding, the following message pops up:
A response error occurred when polling VPFoundation. You may be
able to continue with partial functionality, but you should try logging in
again. If the problem persists, inform your Administrator or Activplant
technical support.
When this happens, AppCenter ceases performing status checks,
assuming that there will be no response, so that it does not crash the
client.
VPFoundation may also appear to stop responding if the network is
slow. If VPFoundation does crash, your token is no longer valid when it
starts up again, and you will have to log in again. If VPFoundation did
not crash but communication was only temporarily interrupted, your
token remains valid and you can continue working.
In both cases you must click on the red status indicator; AppCenter
does not resume checking status until you do this. This tells the
container that it is safe to try and re-establish the connection.
AppCenter then determines if your token is valid, and prompts you for
a log on if necessary.
AppCenter Options
There are several options that you can set in AppCenter. These are
accessible through the Options button on the AppCenter toolbar. If
you click this button the Options dialog box opens.
ActivEssentials Administration
CDC Factory 7.1
ActivEssentials Administration Guide
1-20
These functions are for administrator use. The options available in the
General tab of this dialog box are described in the following table:
Common Functions Within MI Admin
There are several functions that are common to most MI Admin
modules. The table below lists some of them.
Table 1-7 The Options dialog box
Option What it does
Number of items to display per
page in Grid view
Controls the number of rows in each page of the
grid. Select a number from the drop-down list.
Poll VPFoundation every --
seconds
The frequency with which the connection
integrity is monitored.
Enable Run Other option in
Taskbar
Adds function to allow users to run other
modules that do not normally run within MI
Admin.
Enable AppCenter Profiler Runs the AppCenter Profiler to monitor the calls
made from AppCenter to web services. This is
for application developers only.
Save preferences when AppCenter
closes
When AppCenter closes the users preferences
are automatically saved and used for the next
session.
Restore Default Settings Returns the Options settings to their default
settings.
Table 1-8 Common MI Admin functions
Function Description
Adding an object to the
Object Library
To do this, select the Object Library in the Plant Hierarchy
frame. Then choose the New button on the toolbar to
initiate a wizard; or create a new object in the grid (see
below).
Creating new objects in
the grid
Select the New row at the bottom of the grid. It has a
icon beside it. Then click or double-click in each column to
define the properties of the new item.
Deleting objects Select the object in the grid, then click the Delete button
on the toolbar, or right-click the object and choose Delete
from the context menu.
Viewing and editing
properties of objects
Some properties are visible in the grid, and you can often
edit these properties there. Often there are other
properties that are only visible in the Properties dialog
box. To open the Properties dialog box, select an object
and click the Properties button on the toolbar, or
right-click the object and choose Properties from the
context menu.
Copying and pasting
objects
This function is available in some modules. Select an
object, then click the Copy button on the toolbar to copy
it to the Windows clipboard. Click elsewhere and choose
the Paste button. See The Copy and Paste Functions on
page 1-21 for more information about the rules that apply
in copying and pasting.
ActivEssentials Administration
CDC Factory 7.1
ActivEssentials Administration Guide
1-21
The Copy and Paste Functions
You can use the Copy and Paste toolbar buttons to copy and paste
wherever copying and pasting are allowed. Alternatively, you can use
the same options on right-click menus. When using the copy and paste
functions in MI Admin, you can copy once and paste many times.
ActivEssentials allows you to copy objects you create in MI Admin by
using a naming convention that prevents duplication of object names.
In the first instance the copy uses the same name as the original,
prefixed with the term Copy of. So if you copy OrgName the copy
will be called Copy of OrgName.
When you paste many times, this naming convention has to be taken
further.
If you have an object to be copied named OrgName, the initial copy
will have the name Copy of OrgName. However, as you paste
additional copies of the original, the name is now suffixed by a
numbering scheme that honors the non-duplication of name rule.
Thus, a second copy of the original will be named Copy of
OrgName_1, a third copy of the original will be named Copy of
OrgName_2, and so on.
You can also copy an object which is itself a copy, but the naming
convention does not repeat the addition of the Copy of prefix.
Instead, the naming convention looks for occurrences of the
numbering suffix, and uses the next available increment. So if you
were to copy Copy of OrgName_1, the name would not be Copy of
Copy of OrgName_1, but Copy of OrgName_3, because 3 is the next
available number.
Finding and replacing These functions are available in some modules as toolbar
buttons. You can use these to search for text and replace
it. For example, you can find and replace OPC item
addresses.
Sorting In some modules you can sort items alphabetically in the
grid. To do so, click the header of the Name column.
Applying global objects
to plant hierarchy items
In the Plant Hierarchy frame, choose the Object Library.
In the Plant Hierarchy frame, navigate to the plant
hierarchy item to which you want to add the object, but
do not select the item. With the Object Library still
selected, click in the grid on the icon beside the object
you wish to apply, then drag and drop it on the plant
hierarchy item.
Typically you use this method to apply items such as OPC
servers, VPCollectors, or calculations to groups or assets.
Finding Help To open the Help module, select the Global category
button in the taskbar, then click the MI Admin Help
button, or press F1. Note: if you open the Help by clicking
the MI Admin Help button in the taskbar, the online help
is displayed within AppCenter, however, if you use press
F1 the Help opens in a new window.
Table 1-8 Common MI Admin functions (Continued)
Function Description
ActivEssentials Administration
CDC Factory 7.1
ActivEssentials Administration Guide
1-22
If you rename Copy of OrgName (the first copy), before pasting
further instances of the original the naming procedure will look for the
Copy of OrgName name before moving up the numbering scheme to
look for the next available numbered option. So in this instance,
because Copy of OrgName no longer exists, your next copy would be
Copy of OrgName.
Within MI Admin you can generate many different kinds of objects,
most of which can be copied and pasted into appropriate parts of the
MI Admin interface. When making copies, the attributes that
accompany any particular object are generally complete, but may not
be.
The following table lists the objects that can be copied, with any
conditions that might apply.
Table 1-9 Objects in MI Admin that can be copied
Object to be copied Conditions, if any
Accumulator items The Accumulator/Identifier link is not copied.
Assets All items of the asset are also copied.
Asset calculations Asset calculations can be copied to the same or different
assets.
Asset derived items Asset derived items can be copied to the same or different
assets.
Asset properties Asset properties can be copied to the same or different
assets.
Asset state global
definitions
Can be copied within the Object Library and from asset to
asset.
Asset state items Asset state items can be copied to the same or different
assets.
Asset trigger Asset triggers can be copied to the same or different
assets.
Calculation templates Can be copied within the grid.
Events Event variables and event acknowledgments are copied.
Event data types can be copied to the same or a different
asset.
Event alphanumeric
items
Alphanumeric items can be copied to the same or
different events.
Event numeric items Numeric items can be copied to the same or different
events.
Formulas Can be copied within the Object Library.
Groups All subgroups, assets and items are copied.
Group properties Group properties can be copied to the same or different
groups.
Items collected with the
Incidents method
The incident item sub-category link is copied.
Incident definitions Sub-category links are copied as well.
Incident sub-categories Sub-category items are also copied.
ActivEssentials Administration
CDC Factory 7.1
ActivEssentials Administration Guide
1-23
Incident sub-category
items
Items can be copied to the same subcategory or other
sub-categories.
Identifier definitions The properties of the identifier are not copied.
Identifier items Identifier items can be copied to the same or different
assets.
Identifier properties Identifier properties can be copied to other identifiers.
Report categories The report style and wizards of the categories are copied.
Report folders Cannot be copied.
Report styles Can be copied (duplicated).
Report templates Cannot be copied.
Run schedules Cannot be copied.
Shifts The shift structure is copied.
Shift periods Can be copied.
Shift schedules Can be copied.
Shift schedule types Can be copied.
Units Cannot be copied.
Variable definitions Numeric and alphanumeric variables can be copied.
Table 1-9 Objects in MI Admin that can be copied (Continued)
Object to be copied Conditions, if any
ActivEssentials Administration
CDC Factory 7.1
ActivEssentials Administration Guide
1-24
Building your Data Collection System in
MI Admin
MI Admin is the collective name for the administrative modules that
run in AppCenter. AppCenter itself is a container that hosts modules,
and each module behaves in very similar fashion within AppCenter.
This means that routine functions such as creating new items, viewing
properties, copying and pasting, etc. all behave in a similar way in
each module.
This section covers the following topics:
Before you Begin on page 1-24
Creating the Data Collection System on page 1-25
Before you Begin
Before you begin building your system, you must ensure that certain
things are in place. You should read the System Configuration Guide
(System Configuration Guide.pdf), which is available in the
ActivEssentials installation package before you start the configuration.
The present manual assumes that you have done so and that you have
installed the appropriate components on your network.
Here is a list of what you will need as a minimum:
Software installations. See the System Configuration Guide
(System Configuration Guide.pdf) in the ActivEssentials installation
package for details of the software prerequisites that you need. In
particular you will need:
The SQL Server database
VPFoundation on at least one server
VPCollector and an OPC server on at least one machine
Internet Explorer 6.0 or later on clients that will be used to
view data
Information requirements. Your integration engineer should be
able to supply you with the following:
Organizational structure plan, including the plant hierarchy
Server information, including the names of servers hosting the
ActivEssentials components
OPC server information
Shift schedule and shift calendar used in the organization
For every asset, details of the data items that will be collected
The list above covers the minimum requirements. There will probably
be other types of information that you need. For a detailed analysis of
these requirements, see the Discovery Assessment chapter System
Configuration Guide (System Configuration Guide.pdf) in the
ActivEssentials installation package.
ActivEssentials Administration
CDC Factory 7.1
ActivEssentials Administration Guide
1-25
Creating the Data Collection System
Creating a data collection system in MI Admin is a logical process in
which you have to create the building blocks, then assemble them into
more complex items. It is important to know the order in which things
should be done, because you will need certain precursors before you
can build the later objects. This section describes some of the basic
rules that you should observe.
The general steps to create the data collection system is as follows:
First, create the backbone of the plant hierarchy, including
departments, areas, production lines, and other group objects.
Register at least one OPC server that you have installed on a
machine on your network.
Register at least one VPCollector that you have installed
somewhere on your network.
When you have done these first three things, create a single asset
in your plant hierarchy. Choose a template asset to work on first,
because you can copy and paste this asset to other places of the
hierarchy after you have worked on a lot of the details of it.
Working on your template asset, create the data categories, data
items, shifts, calculations, and other things that you will need.
When you have completed most of the details on the template
asset, copy and paste it to other parts of your plant hierarchy, then
change the specific details for each copy. You can use
find-and-replace to edit details.
Minimum Requirements for Data Collection
As a minimum requirement for viable data collection, you need the
following as elements of your system (assuming that all the
prerequisite software installations are complete):
At least one installation of VPFoundation and SQL Server 2005.
At least one asset created in the Plant Management module of
MI Admin.
At least one VPCollector installed and registered in the Collector
Configuration module.
At least one OPC server registered in the OPC Servers module.
At least one active shift schedule created in the Shift Configuration
module.
At least one data category and one data item created in the Data
Collection Configuration module.
CDC Factory 7.1
ActivEssentials Administration Guide
2-1
System Settings
System Settings
CDC Factory 7.1
ActivEssentials Administration Guide
2-2
Introduction to System Settings
The System Settings module of AppCenter allows you to view licensing
information and to set or change the settings for your ActivEssentials
data collection system.
The settings in this module are general settings that affect the whole
data collection system, so you should read the information in this
section carefully before making any changes.
This chapter covers the following topics:
ActivEssentials System Settings on page 2-2
Units of Measurement and Number Formats on page 2-11
Daylight Saving Time in ActivEssentials on page 2-15
Using the Daylight Saving Functions on page 2-21
Filtering Incident Data by IdentifiersChoosing the Right Method
on page 2-36
ActivEssentials System Settings
The System Settings module of AppCenter allows you to view or
change the settings for your ActivEssentials data collection system.
This includes the license key and database settings.
You cannot create a license key in this module. You must generate a
license key in a separate application and install it on the VPFoundation
machine. For more information, see the ActivEssentials System
Configuration Guide (System Configuration Guide.pdf) in your
installation package.
This section covers the following topics:
Opening the System Settings Module on page 2-2
Viewing Licensing Information on page 2-3
Changing the System Settings on page 2-4
System Settings on page 2-5
Opening the System Settings Module
Use the instructions below to open the System Settings task module of
MI Admin.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
Read System Settings on page 2-5.
System Settings
CDC Factory 7.1
ActivEssentials Administration Guide
2-3
Procedure
1 In the taskbar, click the System category button.
The taskbar refreshes to display the task modules in the System
category.
2 In the taskbar, click the System Settings icon.
Viewing Licensing Information
Use the instructions below to view the licensing information for your
ActivEssentials system. You cannot change the information here
because licenses are generated in a separate application and then
applied to ActivEssentials database. For information on obtaining and
installing a license code, see the System Configuration Guide
(System Configuration Guide.pdf) in the ActivEssentials installation
package.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the System Settings module using the
instructions in Opening the System Settings Module on page 2-2.
Procedure
1 If necessary, in the secondary frame, select the System Settings
category button.
The System Settings frame contains icons for Plant License,
System Properties, and Daylight Saving.
2 In the secondary frame, click the Plant License icon.
The window refreshes to display the current plant license support
code, the number of assets that you are allowed to create, and the
expiry date of the license.
System Settings
CDC Factory 7.1
ActivEssentials Administration Guide
2-4
Figure 2-1 ActivEssentials licensing information
Changing the System Settings
Use the instructions below to change the system settings for
ActivEssentials. Note that these are global changes that will affect your
whole data collection system. For information on the meaning of these
settings, see System Settings on page 2-5.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, open the System Settings module using the
instructions in Opening the System Settings Module on page 2-2.
Read System Settings on page 2-5.
Procedure
1 If necessary, in the secondary frame, select the System Settings
category button.
The System Settings frame contains icons for Plant License,
System Properties, and Daylight Saving.
2 Click the System Properties icon.
The grid refreshes to display the system properties for your
ActivEssentials installation.
Warning! Be careful when changing system settings. Some settings may adversely
affect performance, and/or disable parts of the data collection system.
System Settings
CDC Factory 7.1
ActivEssentials Administration Guide
2-5
Figure 2-2 ActivEssentials system properties
3 Click or double-click in the Value column and make changes as
desired. Note that when you click in a cell some descriptive
information appears below.
System Settings
The System Settings module presents several settings that you can
view or change. Note that these are global settings that affect your
whole data collection system. When you select a setting in the grid,
some explanatory information appears below the grid. The following
table describes the settings that are available.
Note: There are other system settings not represented in this module. For information
on these, see the Configuration and Diagnosis guide in the ActivEssentials
installation package.
System Settings
CDC Factory 7.1
ActivEssentials Administration Guide
2-6
Note: In the following table, rows 28 to 31refer to table partitioning, which is a feature
that is supported only by the Enterprise and Developer versions of SQL Server
2005. If you are using any other version of SQL Server 2005, you cannot use
table partitioning, so the rows do not appear in the System Settings module.
This also causes the renumbering of any rows that follow.
Table 2-1 System settings and their meaning
Row Setting What it does
1 Scheduled Execution Tasks
Owner Alias Type
This is a legacy setting that relates to task
configuration. This setting has no effect in
ActivEssentials.
2 Scheduled Execution Tasks
Owner Alias Enabled
This is a legacy setting that relates to task
configuration. This setting has no effect in
ActivEssentials.
3 Linked Property Update Rate
(seconds)
This setting determines the time interval for
updating database records for linked
properties in task configuration. The valid
values are: 60, 120, 180, 240, 300, 360,
600, 720, 900, 1 200, 1 800, and 3 600. (All
are multiples of 60 and factors of one hour.)
The default value is 300.
4 Display Incident Reason
Code in VPWeb
Change the value from 0 to 1 if you want
incident reason codes to be displayed in
VPWeb.
5 Display Operator Comments
to Incidents in VPWeb
Change the value from 0 to 1 if you want
incident comments to be displayed in VPWeb.
6 Open Incident Expired Time
(days)
This value is the number of days after which
an open incident will be closed by the
database. The default value is 10.
7 Truncate Incidents in VPWeb Change the value from 0 to 1 if you want
VPWeb to truncate the incident if the start
and/or end time is outside the time frame set
in VPWeb.
Note: This setting applies to incidents
records displayed in Detailed View only.
Layout and Production views always truncate
incidents at the time frame boundary.
8 Display Incident Ack in
VPWeb
Determines whether incident
acknowledgments will be displayed or not.
1 = displayed; 0 = not displayed.
9 Display Incident
Subcategory in VPWeb
Determines whether incident sub-categories
will be displayed or not. 1 = displayed;
0 = not displayed.
10 Display Incident Category
Property in VPWeb
Determines whether incident category
properties will be displayed or not.
1 = displayed; 0 = not displayed.
System Settings
CDC Factory 7.1
ActivEssentials Administration Guide
2-7
11 Retro Stop Allowed Gap The value set here is the allowed gap (in
seconds) between database time stamps for
substituting incident records. The allowed gap
system property functions only if retroactive
incident editing (Retro Stop) has been
enabled. See Setting up Retro Stop in the
System Settings on page 15-12 for more
information.
12 Filter Incident by Duration
Only
When using an identifier to filter incidents in
VPWeb, you have two choices. You can view
the incident durations in their entirety when
they overlap with the identifier (the default),
or you can clip the incident duration to match
the durations of the identifier. See How
Filtering WorksTwo Models on page 2-37 for
more information.
13 Enable Incident Data Editing If enabled, users are allowed to edit incidents
in certain modules. Enabling editing impacts
system performance, so by default this
setting is off. 1 = Enabled; 0 = Disabled.
14 Calculate Open Incident
Duration
Enables or disables the ability to calculate the
duration of an open incident by the incident
start time and end time in Root Cause View.
1 = Enabled; 0 = Disabled.
15 Enable incident Retro Stop If enabled, users can use the retroactive
incident editing (Retro Stop) features.
1 = Enabled; 0 = Disabled.
16 Data Collection Support in
Daylight Saving Period
Enables or disables data collection support for
a daylight saving period. 1 = Enabled;
0 = Disabled. See Daylight Saving Time in
ActivEssentials on page 2-15 for more
information.
17 Number of Unique Identifier
Values
The value set here determines the number of
unique values for a non-unique identifier that
VPFoundation will look for when displaying
data. You can set this value to any number,
but higher numbers will adversely affect the
speed of the system.
18 Maximum Number of
Historical Data Rows
Deleted
This setting is the maximum number of
historical data rows that can be deleted from
the database in a single job. Whenever you
delete an asset, the historical data records for
the asset are deleted from the database,
beginning with the next scheduled database
job (usually in the middle of the night). For
an asset with millions of records, the records
are deleted in batches instead of all at once,
thereby conserving system resources for data
collection. More powerful systems can handle
higher values. The default value is 1 000 000.
If you set it to zero, no records will ever be
deleted.
Table 2-1 System settings and their meaning (Continued)
Row Setting What it does
System Settings
CDC Factory 7.1
ActivEssentials Administration Guide
2-8
19 APRS in Debug Mode This setting determines whether the database
will delete report meta data. (See property
number 20 for the time to keep report data.)
Use this setting if any reports you create are
producing incorrect data. The default setting
is 0, but if you need to debug your reports,
change the setting to 1.
20 Maximum Hours to Keep
Report Metadata
This setting determines how long report
metadata is kept before being discarded. The
initial setting is 30 hours, but there is no
actual limit to the number of hours you can
keep the data. However, to maintain database
performance, we recommend that you should
not keep metadata for more than 168 hours
(7 days).
21 Days to Keep APRS Delivery
Log
This setting controls the number of days the
database keeps a record of activity in the
Activplant reporting system.
22 Working Folder for Data
Archive
This identifies where SQL Server must save
the archive files from the archive definitions
created in Data Management, or created in
SQL Server for partitioning and archiving
tables.
23 Save Good Quality
Accumulator Value Zero
This refers to the creation of database
records when accumulators contain good
quality data, but the value is zero, such as
when a machine is sitting idle. You can
choose to keep or discard zero-value data. If
the likelihood of collecting zero-value data is
high, you could significantly reduce the
database size. The default system value is
1, which requires the database to save the
data, but a system value of 0 causes the
database to discard zero value data. If you
change this setting, you must refresh
VPCollector.
Changing this setting from its default changes
the way you collect accumulator data. If you
need more information about this option,
contact Activplant Technical Support and ask
for Technical Note 126.
24 Max Size of Application
Configuration File
This setting is for uploading or downloading
configuration templates directly to MI Admin.
The default value is 50 MB. You can set this to
any number (in MB), however if you set this
too high, your file transfer may fail. Set to 0 if
you do not want to allow file transfer
functionality.
Table 2-1 System settings and their meaning (Continued)
Row Setting What it does
System Settings
CDC Factory 7.1
ActivEssentials Administration Guide
2-9
25 Number of Assets or Groups
to Purge
This setting allows you to set a limit to the
number of groups or assets that are handled
in any one execution of a purge job. While
there is no limit to the number of groups or
assets to include in a restore configuration,
there are efficiencies to limiting the number
that are handled at any one time. See Basic
Process Data Unit on page 13-91 for more
information.
26 Number of Assets or Groups
to Restore
This setting allows you to set a limit to the
number of groups or assets that are handled
in any one execution of a restore job. While
there is no limit to the number of groups or
assets to include in a restore configuration,
there are efficiencies to limiting the number
that are handled at any one time. See Basic
Process Data Unit on page 13-91 for more
information.
27 Weeks to Keep Archive and
Restore Data Logs
This setting allows you to control how long
the database will keep the Detailed Log for
Groups/Assets for archiving and restoration
activity. Removing the logs does not prevent
you from restoring data, but does allow you
to manage the space used on the database
server hard drive.
28 Enable Table Partition 1 enables table partitioning, which is an
alternative to archiving data. This property
and the next three properties are only
available if you have SQL Server 2005
Enterprise or Developer edition, you have
chosen to partition tables, and are not
archiving data through the Data Management
module. Refer to Partitioning and Archiving
Tables in the System Configuration Guide
(System Configuration Guide.pdf) for more
information.
29 Partition Length This is the number of months of data that is
put into one partition. This is used as the
starting point for partitioning data; all other
settings are controlled by stored procedures
run in SQL Server.
30 Enable Partition Archive 1 enables archiving partitions. You can only
archive a partition if you have enabled table
partitioning (see system property 26). Once
you have enabled this archiving, you need to
run stored procedures in SQL Server. See
Partitioning and Archiving Tables in the
System Configuration Guide (System
Configuration Guide.pdf).
31 Number of Partitions to
Process
The number of partitions to archive at one
time. This number can be between 1 and 50.
If you leave the default at 1, then one
partition for one table will be processed per
job. Refer to the Partitioning and Archiving
Tables chapter in the System Configuration
Guide (System Configuration Guide.pdf), for
more information.
Table 2-1 System settings and their meaning (Continued)
Row Setting What it does
System Settings
CDC Factory 7.1
ActivEssentials Administration Guide
2-10
32 Suppress Filters for
Configured Data Items
This setting allows you to override how the
filtering in the various VPWeb views works.
Filtering is global for all views, but this option
enables you to display data from specific data
items. For more information, see the
Enabling the option to use Suppressed
Filtering section in the System
Configuration Guide (System Configuration
Guide.pdf).
33 Overwrite Activplant User by
Network User
This setting allows you to handle
ActivEssentials users and network users that
have the same user name. 1 replaces an
existing ActivEssentials user; 0 does not
replace the user, so the network user cannot
be added at log in time, nor log in.
34 ActivEssentials Database
Version
This value is filled in automatically, and gives
the version number of the ActivEssentials
database that is in use. This value cannot be
edited.
Table 2-1 System settings and their meaning (Continued)
Row Setting What it does
System Settings
CDC Factory 7.1
ActivEssentials Administration Guide
2-11
Units of Measurement and Number Formats
The System Settings module of AppCenter also allows you to create
units of measurement for the data items that you want to collect. You
can create as many units of measurement as you want, and give each
one a suitable abbreviation.
Also included in the System Settings module are formats for numerical
data. These are predefined and you cannot add new ones.
This section covers the following topics:
Creating Units of Measurement on page 2-11
Editing and Deleting Units of Measurement on page 2-12
Viewing Number Formats on page 2-13
Creating Units of Measurement
Use the instructions below to create new units of measurement. These
units are used by the rest of ActivEssentials to display data. In the
System Settings module you only create the units. You do not
associate them with any particular data itemthat is done when you
create the data items themselves.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, open the System Settings module using the
instructions in Opening the System Settings Module on page 2-2.
Procedure
1 If necessary, in the secondary frame, select the Units and
Formats category button.
The Units and Formats frame contains separate icons for Units and
Formats.
2 Click the Units icon.
The grid displays any units that have been defined already.
3 Right-click in the grid and choose New.
4 In the Add New Unit wizard, click Next to proceed past the
welcome page.
System Settings
CDC Factory 7.1
ActivEssentials Administration Guide
2-12
Figure 2-3 Name and Abbreviation for the units
5 Type a name (up to 50 characters) for the unit, and an abbreviation
(also up to 50 characters), then click Next.
6 Review the definition, then click Finish to save it.
Editing and Deleting Units of
Measurement
Use the instructions below to edit or delete units of measurement.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, open the System Settings module using the
instructions in Opening the System Settings Module on page 2-2.
Created at least one unit of measurement using the instructions in
Creating Units of Measurement on page 2-11.
Procedure
1 If necessary, in the secondary frame, select the Units and
Formats category button.
The Units and Formats frame contains separate icons for Units and
Formats.
2 Click the Units icon.
The grid displays any units that have been defined already.
Note: The Unit abbreviation field is required; you cannot leave it blank.
System Settings
CDC Factory 7.1
ActivEssentials Administration Guide
2-13
3 For each unit you need to edit, do the following:
a) Right-click on the appropriate row in the grid and select
Properties.
Figure 2-4 The properties dialog box for Units
b) Edit the Name or Unit Abbreviation fields and click OK.
4 For each unit you need to delete, right-click on the appropriate row
in the grid, select Delete, and then confirm.
Viewing Number Formats
Use the instructions below to view the formats that are available for
numbers, dates, etc. These formats are available in the data item
editors when you create data items. You cannot create new number
formats; you can only view them in the System Settings module.
System Settings
CDC Factory 7.1
ActivEssentials Administration Guide
2-14
Prerequisites
Before doing this you need to have done or read the following:
If necessary, open the System Settings module using the
instructions in Opening the System Settings Module on page 2-2.
Created at least one unit of measurement using the instructions in
Creating Units of Measurement on page 2-11.
Procedure
1 If necessary, in the secondary frame, select the Units and
Formats category button.
The Units and Formats frame contains separate icons for Units and
Formats.
2 In the secondary frame, click the Formats button.
The grid displays the pre-defined formats.
System Settings
CDC Factory 7.1
ActivEssentials Administration Guide
2-15
Daylight Saving Time in ActivEssentials
Many countries have annual time changes that are designed to save
daylight. Usually there is a change in Spring and a change in Autumn,
and the changes often involve rolling the time forward or backward by
one hour. This has serious implications for any data collection system,
and Activplant has responded to this need by including Daylight Saving
functionality.
This section covers the following topics:
DST Changes Affect Data Collection on page 2-15
How the Daylight Saving System Works on page 2-17
Terms Used in Daylight Saving on page 2-19
DST Changes Affect Data Collection
A time change has several effects in ActivEssentials. The effects of a
roll back in time are greater than in a roll forward.
Rolling Forward
Rolling the time forward creates an apparent (but unreal) gap in data
collection. If the roll forward occurs at 2:00:00 AM, the time-stamps
for data are normal up to 1:59:59 but change to 3:00:00 (instead of
2:00:00) the next second.
The main impact of this change is on open incidents and identifiers.
Without any special handling, an incident or identifier that was open at
the time of the roll forward would appear to have an extra hours
duration.
Rolling Back
Rolling back by one hour creates two duplicate hours, as shown in the
following figure. In this case the normal hour from 1:00:00 to 2:00:00
is called the first hour and the repeated hour is called the second
hour.
System Settings
CDC Factory 7.1
ActivEssentials Administration Guide
2-16
Figure 2-5 A rolling back time change
The effects of a roll back are as follows:
Data items that are collected at a pre-defined frequency, such as
solicited accumulators and sampled events, may have two records
with the same time-stamp.
For data items that last for a specific period of time, such as
incidents and identifiers, the start time and end time may be
reversed. For example, an incident that opens at 1:50:00 in the
first hour may close at 1:03:25 in the second hour. This results in a
negative duration that could cause the incident not to close.
Incidents and identifiers can be merged if the Merging option is
enabled and duplicate records exist (for example, as a result of
network disconnection). During the second hour an incident or
identifier could be mistakenly merged with one that happened over
an hour ago.
Identifiers can be viewed as a time-line in VPWeb. When the time
changes back, items in the time-line will overlap.
1
2
:
3
0
:
0
0
1
:
0
0
:
0
0
1
:
0
0
:
0
0
1
:
3
0
:
0
0
1
:
3
0
:
0
0
1
:
5
9
:
5
9
2
:
0
0
:
0
0
2
:
3
0
:
0
0
Second Hour First Hour
Roll Back at 2:00:00
System Settings
CDC Factory 7.1
ActivEssentials Administration Guide
2-17
How the Daylight Saving System Works
In order to avoid the problems listed in DST Changes Affect Data
Collection on page 2-15, the database includes Daylight Saving
functionality. This works as follows:
At the time of a roll forward, the database closes all open incidents
and identifiers and then reopens them as soon as the roll forward
is complete. This avoids the appearance of an extra hours
duration.
When there is roll back, the database does several things (see
Figure 2-5 on page 16):
It suspends merging of incident and identifier records at the
beginning of the first hour.
At the end of the first hour it begins moving the data from the
first hour out of the regular database tables and into a set of
parallel tables.
It stores data from the second hour in the regular tables.
At the end of the second hour it resumes merging of incident
and identifier records.
An administrator can decide which set of data (the first hour or the
second hour) is viewable in VPWeb and other client applications.
Time Change Definitions
A time change definition is an occurrence of a time change, whether
rolling backward or rolling forward. It consists of the following pieces
of information:
The Start Time. This is the time at which the time change occurs.
When rolling forward, it results in a gap corresponding to the time
change period. When rolling backward, it represents the time at
which data begins to be stored in the parallel tables.
The End Time. This is the end time of the time change period.
When rolling forward, this time is reached immediately. When
rolling backward, it represents the time at which data collection will
be switched back to the original database tables.
The Rolling Back parameter. This is a Yes/No setting (a checkbox)
that determines whether the change is a roll-back or not. For a
rolling forward change its value in the database is 0; when rolling
back its value is 1.
The First Hour In Log parameter. This is only relevant for rolling
back. It is a simple Yes/No setting that determines whether the
first hours data is stored separately. Log in this context is the
regular database tables. If the value in the database is 0, the first
hours data is stored separately; if it is 1, the second hours data is
stored separately. You do not need to set or change this value.
Note: The Allowed Gap value for merging must be less than 3600 seconds.
System Settings
CDC Factory 7.1
ActivEssentials Administration Guide
2-18
The time change definitions are contained in the
tblDST_DaylightSavingDefinitions table in the database. This table
is populated automatically in ActivEssentials.
Database Tables
In ActivEssentials, the Daylight Saving function creates a parallel set
of database tables for storage of the repeated hours data during a
roll-back. Each table is named according to the name of the regular
tables, with a _DST extension. The names of the tables and their
equivalent DST versions appear in the following table:
Daylight Saving Settings
The Daylight Saving settings are available in the System Settings
module of MI Admin. In this module you can enable or disable Daylight
Saving by clicking a toolbar button or setting a system property. Time
change definitions are retrieved automatically from the local settings
Table 2-2 Database tables used for Daylight Saving
Data Type Table DST Table
Accumulators tblDC_Accumulators tblDC_Accumulators_DST
Accumulator qualities tblDC_AcumulatorQualities tblDC_AccumulatorQualiti
es_DST
Events tblDC_Events tblDC_Events_DST
Event qualities tblDC_EventQualities tblDC_EventQualities_DS
T
Event numeric variables tblDC_EventVariables tblDC_EventVariables_DS
T
Event alphanumeric
variables
tblDC_EventAlphVariables tblDC_EventAlphVariables
_DST
Identifiers tblDC_Identifiers tblDC_Identifiers_DST
Identifier qualities tblDC_IdentifierQualities tblDC_IdentifierQualities_
DST
Incidents tblDC_Incidents tblDC_Incidents_DST
Incident qualities tblDC_IncidentQualities tblDC_IncidentQualities_
DST
Incident comments tblDC_IncidentComments tblDC_IncidentComments
_DST
Incident reason codes tblDC_IncidentReasons tblDC_IncidentReasons_D
ST
Incident links tblDC_IncidentReasons_Link tblDC_IncidentReasons_Li
nk_DST
Incident properties tblDC_IncidentProperties tblDC_IncidentProperties_
DST
Incident
acknowledgement
tblDC_IncidentAcks tblDC_IncidentAcks_DST
Data audit log tblDC_AuditLog tblDC_AuditLog_DST
System Settings
CDC Factory 7.1
ActivEssentials Administration Guide
2-19
of the operating system by a database job that runs every two
months. The job checks the available time change definitions for the
current and the next year.
When managing the data you collect during the time change period,
consider the following:
You can delete time change definitions that are still in the future,
but you cannot delete definitions that are in the past.
You cannot edit the dates and times, or add new definitions.
You can swap the data (first hour or second hour) that is stored
separately.
Figure 2-6 Daylight Saving in ActivEssentials
Actions Available in Daylight Saving
In the Daylight Saving part of the System Settings module you can:
Delete a time change definition that is still future.
Choose which hours data is stored separatelythe first hour or the
second hour.
Swap the data that is stored separately so that the other hours
data is stored separately instead.
Schedule a data swap for some time in the future.
Terms Used in Daylight Saving
The following terms are used in Daylight Saving:
Operating System
Locale Settings
VPCollector
AppCenter System Settings Module
activplant
Delete, but not add or modify
tblDST_DaylightSavingDefinitions
Parallel DST Tables
Regular Data Tables
S
w
a
p
H
o
u
rs
Refresh
System Settings
CDC Factory 7.1
ActivEssentials Administration Guide
2-20
Table 2-3 Table of terms used in daylight saving
Term Definition
Time Change
Definition
A date and time at which the change occurs. The definition
consists of (i) the beginning of the time change; (ii) the end of
the time change (whether the change is a roll forward or a roll
backwards); and (for a roll back) which hours data is to be
stored separately. The definitions are read from the operating
system. You can delete future (but not past) definitions, but you
cannot add or modify them.
Store Separately In the context of a roll back, this refers to the data that is
stored in the parallel database tables instead of the regular
tables. You can specify which hours data is stored separately,
and you can swap the data.
Data Swapping This is the process of exchanging the data that is stored
separately. If at present you have the first hours data stored
separately, you can swap it for the second hours data. You
cannot have a mixture of data from the two hours stored in the
same place; you can only swap the data.
Data Swap
Scheduling
You can schedule a data swap for some time in the future. If
you have a large amount of data stored separately that you now
wish to swap into the regular tables, you could schedule the
database job so that it runs at a time of low activity.
Cancelling You can at any time cancel a data swap that is scheduled in the
future. You can also cancel a swap that is already in progress; if
you do, any data that has been swapped already is
automatically swapped back.
System Settings
CDC Factory 7.1
ActivEssentials Administration Guide
2-21
Using the Daylight Saving Functions
ActivEssentials provides a means of separating the data captured
during a switch from daylight saving time to standard time. In most
jurisdictions where Daylight Saving Time is used, there is a period of
two hours where the time stamps that occur during the second hour
fall in the same range as the time stamps that occurred in the first
hour. This can create ambiguity in the collected data, so
ActivEssentials allows you to view only one set of data at a time.
This section covers the following topics:
Enabling the Daylight Saving Option on page 2-21
Toolbar Buttons, Menu Options, and Messages on page 2-29
Toggling the DST Option On and Off on page 2-22
Time Change Definitions on page 2-32
Deleting a Time Change Definition on page 2-23
Importing New Time Change Definitions on page 2-24
Swapping Data on page 2-25
Rescheduling a Data Swap on page 2-26
Cancelling a Data Swap on page 2-28
Best Practices on page 2-33
Known Issues and Workarounds on page 2-34
Enabling the Daylight Saving Option
Use the instructions below to enable the Daylight Saving option.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, open the System Settings module using the
instructions in Opening the System Settings Module on page 2-2.
Read the following:
Time Change Definitions on page 2-32
Best Practices on page 2-33
Known Issues and Workarounds on page 2-34
Procedure
1 If necessary, in the secondary frame, select the System Settings
category button.
2 In the secondary frame, click the System Properties icon.
3 Locate the row for the Data Collection Support in Daylight
Saving Period property, and double-click on the cell in the Value
column.
System Settings
CDC Factory 7.1
ActivEssentials Administration Guide
2-22
Figure 2-7 The Daylight Saving system property
4 Change the value from 0 to 1.
Toggling the DST Option On and Off
Use the instructions below to toggle the Daylight Saving option on or
off in MI Admin. The method given below overrides the setting in the
System Properties list.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, open the System Settings module using the
instructions in Opening the System Settings Module on page 2-2.
Read Time Change Definitions on page 2-32 and Best Practices on
page 2-33.
Procedure
1 If necessary, in the secondary frame, select the System Settings
category button.
The System Settings frame contains icons for Plant License,
System Properties, and Daylight Saving.
2 In the secondary frame, click the Daylight Saving icon.
The grid refreshes to display the daylight saving time periods, and
several new buttons appear on the toolbar.
3 Click the Enable (Disable) Daylight Saving button to toggle the
function on or off.
Note: You can also toggle the DST setting on and off in the Daylight Saving interface
of the System Settings module. For more information, see Toggling the DST
Option On and Off on page 2-22.
Note: The icon and the tool-tip change according to whether the function is on or off.
When disabled it is grey; when enabled it is red .
System Settings
CDC Factory 7.1
ActivEssentials Administration Guide
2-23
Deleting a Time Change Definition
Use the instructions below to delete future time change definitions.
You can only delete future definitions, not past ones. SQL Server runs
a job on the ActivEssentials database on the 1st day of every month to
import planned time change events. The information comes from the
operating system. Once these definitions are in the database, there is
no check to see if there are any changes to these planned dates.
Should the planned dates change, you must remove any future dates
stored in the database and manually import the new dates.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, open the System Settings module using the
instructions in Opening the System Settings Module on page 2-2.
Read Time Change Definitions on page 2-32.
Procedure
1 If necessary, in the secondary frame, select the System Settings
category button.
The System Settings frame contains icons for Plant License,
System Properties, and Daylight Saving.
2 Click the Daylight Saving icon.
The grid refreshes to display the daylight saving time periods, and
several new buttons appear on the toolbar.
Figure 2-8 Daylight saving definitions in the grid
3 If Daylight Saving is disabled, click the Daylight Saving Disabled
button.
The database confirms that daylight saving is enabled, and the
button changes color to red.
Note: You must be a member of the System Administrator role in ActivEssentials to
delete daylight saving definitions.
System Settings
CDC Factory 7.1
ActivEssentials Administration Guide
2-24
4 Right-click on a time change definition in the grid and select
Delete.
The database asks for confirmation.
5 Click OK.
Importing New Time Change Definitions
Use the instructions below to obtain the dates for future time changes
from the operating system. To get these time change definitions, you
must run a job in SQL Server Enterprise Manager on the
ActivEssentials database, and then confirm that the changes have
been set in the Daylight Saving Time task sub-module. This procedure
takes place on the server that hosts the ActivEssentials database.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, open the System Settings task module using the
instructions in Opening the System Settings Module on page 2-2.
If there are changes to the dates for planned time changes, you
need to remove any future time frame definitions from the
database. For more information, see Deleting a Time Change
Definition on page 2-23.
Read Time Change Definitions on page 2-32.
Procedure
1 Open the SQL Server Management Studio and connect to the
ActivEssentials database.
2 In the left pane, navigate down in the tree and select the server
that hosts the ActivEssentials database.
3 Expand the tree below the ActivEssentials database server as
follows: <server root> SQL Server Agent Jobs.
4 Select the Jobs entry.
The right pane refreshes to display the jobs available.
5 In the right pane, right-click on the entry for the
AP_GenerateDaylightSavingDefinitions job and select Start
Job.
When SQL Server Management Studio finishes, the Last Run Status
should read Succeeded.
6 Open the System Settings module and confirm that there are
new entries in the Daylight Saving Time task sub-module.
Note: If you have just installed ActivEssentials software, you might need to run the
job almost immediately. The database checks for future time change events on
the 1st day of every month and will import future changes at that time.
However, if you install the ActivEssentials software during March and the next
time change is scheduled for later the same month, you should import the
dates manually.
System Settings
CDC Factory 7.1
ActivEssentials Administration Guide
2-25
Swapping Data
Use the instructions below to swap the data that is stored separately
during a roll-back period. By default the first hours data is stored
separately, but you can swap this to the second hours data (and back
again) as required.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, open the System Settings module using the
instructions in Opening the System Settings Module on page 2-2.
Know the time change definitions as described in Time Change
Definitions on page 2-32.
Procedure
1 If necessary, open the System Settings module using the
instructions in Opening the System Settings Module on page 2-2.
2 If necessary, in the secondary frame, select the System Settings
category button.
The System Settings frame contains icons for Plant License,
System Properties, and Daylight Saving.
3 Click the Daylight Saving icon.
The grid refreshes to display the daylight saving time periods, and
several new buttons appear on the toolbar.
Figure 2-9 Daylight saving definitions in the grid
4 If Daylight Saving is disabled, click the Daylight Saving Disabled
button.
The database confirms that daylight saving is enabled, and the
button changes color to red.
Note: You can only schedule a data swap for time changes that have been rolled
back (that is, the Rolling Back column is checked).
System Settings
CDC Factory 7.1
ActivEssentials Administration Guide
2-26
5 Select the item that you want to change, then click the Swap Data
button.
A dialog box appears in which you can schedule the data swap.
Figure 2-10 Dialog box for scheduling a data swap
6 In the dialog box, do one of the following:
a) If you want the data swap to run immediately, select the Run
immediately option.
b) If you want to schedule the swap for some time in the future,
choose the Schedule at: option and set the date and time in
the date-time field.
7 Click OK to confirm the swap.
The information in the Status column changes accordingly, and
the Store Separately column changes.
Rescheduling a Data Swap
Use the instructions below to reschedule a swap of data that is stored
separately during a roll-back period.
Note: You must set the time to at least five minutes from now, otherwise you receive
an error message.
Note: The view does not update dynamically to show you the percentage complete.
Click the Refresh button to update the view. This is important if you later
want to cancel the swap, because the menu options and toolbar buttons will not
be enabled until you refresh the view.
Note: If the data swap fails, the message in the Status column changes. You can click
the Continue Processing toolbar button to try again.
System Settings
CDC Factory 7.1
ActivEssentials Administration Guide
2-27
Prerequisites
Before doing this you need to have done or read the following:
If necessary, open the System Settings module using the
instructions in Opening the System Settings Module on page 2-2.
Procedure
1 If necessary, in the secondary frame, select the System Settings
category button.
The System Settings frame contains icons for Plant License,
System Properties, and Daylight Saving.
2 Click the Daylight Saving icon.
The grid refreshes to display the daylight saving time periods, and
several new buttons appear on the toolbar.
Figure 2-11 Daylight saving definitions in the grid
3 If Daylight Saving is disabled, click the Daylight Saving Disabled
button.
The database confirms that daylight saving is enabled, and the
button changes color to red.
4 Select a rolling-back time change in the grid (ones with a
checkmark in the Rolling Back column) that has a data swap
scheduled.
5 Right-click and choose Swap Data.
A dialog box appears in which you can schedule the data swap.
Note: You can only schedule a data swap for time changes that have been rolled
back (that is, the Rolling Back column is checked).
System Settings
CDC Factory 7.1
ActivEssentials Administration Guide
2-28
Figure 2-12 Dialog box for scheduling a data swap
6 In the dialog box, do one of the following:
a) If you want the data swap to run immediately, select the Run
immediately option.
b) If you want to schedule the swap for some time in the future,
choose the Schedule at: option and set the date and time in
the date-time field.
7 Click OK to confirm the swap.
The information in the Status column changes accordingly, and
the Store Separately column changes from First Hour to Second
Hour, or vice versa.
Cancelling a Data Swap
Use the instructions below to cancel a data swap that has been
scheduled or is still running. If you cancel a swap that has not begun,
the information in the Status column changes. If you cancel a swap
that is still in progress, the database begins to swap back any data
that has been moved already.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, open the System Settings module using the
instructions in Opening the System Settings Module on page 2-2.
Note: You must set the time to at least five minutes from now. If you do not, the
database returns an error message.
Note: You can only cancel a data swap for time changes that have been rolled back
(that is, the Rolling Back column is checked).
System Settings
CDC Factory 7.1
ActivEssentials Administration Guide
2-29
Procedure
1 If necessary, in the secondary frame, select the System Settings
category button.
The System Settings frame contains icons for Plant License,
System Properties, and Daylight Saving.
2 Click the Daylight Saving icon.
The grid refreshes to display the daylight saving time periods, and
several new buttons appear on the toolbar.
Figure 2-13 Daylight saving definitions in the grid
3 If Daylight Saving is disabled, click the Daylight Saving Disabled
button.
The database confirms that daylight saving is enabled, and the
button changes color to red.
4 Right-click the time change definition and choose Cancel Data
Swapping.
5 Confirm the cancellation.
Toolbar Buttons, Menu Options, and
Messages
When you open the Daylight Saving system in System Settings, the
following toolbar buttons appear. They will be enabled or disabled
depending on your current selection in the interface.
System Settings
CDC Factory 7.1
ActivEssentials Administration Guide
2-30
The Right-Click Menu
If you right-click a time change definition in the grid, the following
menu options appear. They may or may not be present, depending on
the status of the time change definition.
Table 2-4 Toolbar button in Daylight Saving
Button and icon What it does
Refresh VPCollector When you click this button, VPCollector reloads time change
definitions, including those defined by the operating system.
Swap Data Initiates a data swap for the data that has been collected
during a time change. This is only available for time changes
in the past that were of the rolling back type. The swap begins
5 minutes later.
Cancel Data
Swapping
Cancels a data swap that is either still future or is already in
progress. When you cancel, any data that has already been
swapped is swapped back.
Reschedule Data
Swapping
Allows you to reschedule a data swap that has been scheduled
for some time in the future.
Continue Processing This button continues a process that was interrupted or failed
for some reason. For example, if a data swap fails when 50%
complete, you can use this button to resume the swap.
Daylight Saving
Enabled/Disabled
This is a toggle button that changes depending on whether
Daylight Saving is enabled or disabled. The setting of this
button overrides the setting in the System Properties table.
Table 2-5 Right-click menu options in Daylight Saving
Option What it does
Continue Processing This option continues a process that was interrupted or
failed for some reason. For example, if a data swap fails
when 50% complete, you can use this option to resume
the swap.
Delete Choose this option to delete a time change definition that
is still future. You cannot delete definitions that are in the
past.
System Settings
CDC Factory 7.1
ActivEssentials Administration Guide
2-31
Messages in the Status Column
The Status column of the grid shows the status of data that has been
stored separately. The information in this column is described in the
table below. Messages will change automatically depending on the
swap status of the stored data.
Refresh VPCollector When you choose this option, VPCollector reloads time
change definitions, including those defined by the
operating system.
Cancel Data Swapping This option cancels a data swap. If the data has already
been swapped, it is swapped back. If it has not yet been
swapped, the swap is cancelled and nothing happens.
Reschedule Data
Swapping
This option brings up the dialog box in which you can
schedule a data swap.
Table 2-5 Right-click menu options in Daylight Saving (Continued)
Option What it does
Table 2-6 Messages in the Status column
Message Context Meaning
No data swap has been
scheduled.
A future or a past
time change.
No swapping activity has ever
taken place.
No data swap has been
scheduled. The last swap
was finished at (date-time).
A past time
change.
The data has been swapped at
least once. Check the Stored
Separately column to see
which hours data is stored
separately.
No data swap has been
scheduled. The last swap
was cancelled at
(date-time).
A past time
change.
A data swap began, but was
cancelled.
Data swap is scheduled at
(date-time).
A past time
change.
A data swap has been
scheduled for some time in the
future.
Running data swap, xx%
complete.
A past time
change.
The data swap is in progress.
The percentage complete does
not update automatically. Click
the Refresh button on the
toolbar to update the status.
Data swap cancelled.
Reswapping is xx%
complete.
A past time
change.
A swap was in progress but
was cancelled. Reswapping is
now in progress. The
percentage complete does not
update automatically. Click the
Refresh button on the
toolbar to update the status.
Data swap scheduled at
(date-time) was deleted,
interrupted, or failed when
xx% complete.
A past time
change.
A swap was in progress but
was cancelled, manually
interrupted in the database, or
failed. Reswapping is complete.
System Settings
CDC Factory 7.1
ActivEssentials Administration Guide
2-32
Time Change Definitions
The dates and times of Daylight Saving changes are displayed in the
System Settings module. The dates and times are retrieved from the
local settings of the operating system, and they are stored in the
tblDST_DaylightSavingDefinitions database table. If you are a
member of the System Administrator role you can delete definitions,
as described in Enabling the Daylight Saving Option on page 2-21, but
you cannot add or modify them.
Figure 2-14 Time change definitions
Data swap rescheduled at
(date-time) after being
interrupted or failing at xx%
completion.
A past time
change.
A swap failed or was manually
stopped in the database. The
user has rescheduled the swap.
The cancel operation was
interrupted or failed when
reswapping was xx%
complete.
A past time
change.
A swap was cancelled, but the
cancel operation was manually
interrupted or failed in the
database.
Running data swap, xx%
complete.
A past time
change.
The data swap is running.
Table 2-6 Messages in the Status column (Continued)
Message Context Meaning
System Settings
CDC Factory 7.1
ActivEssentials Administration Guide
2-33
The definitions include the following information:
The date and time of the time change, including the Start Time
(the moment at which the roll forward or back occurs) and the End
Time (giving the duration of the changed period).
A checkbox indicating whether the change is a roll backwards. If
this is not checked the change is a roll forwards. The checkbox is
greyed out because you cannot edit this property.
The hours data that is stored separately (for roll-backs only). By
default this is the first hour, but by swapping the data you can
change it to the second hour. See Swapping Data on page 2-25.
The Status of data swapping tasks. For information on the
messages shown in this column, see Toolbar Buttons, Menu
Options, and Messages on page 2-29.
Best Practices
Here are some best practices for Daylight Saving configuration:
If production is stopped during the rolling back period, shut down
all VPCollectors and restart them after the time change period.
Avoid enabling the incident or identifier merging option during the
rolling back period. If you do enable it the data may be merged
with the wrong records and may result in identifiers and incidents
not being isolated and copied to the Daylight Saving data tables.
There is no server or database functionality to validate and enforce
this rule.
Avoid inserting incidents with a time frame overlapping the change
back period before the first hour is started. Instead, insert two
separate records with the Start Time of the first hour as the first
incidents end time and the second incidents start time.
Avoid inserting incidents with a time frame overlapping the change
back period after the second hour is ended. Otherwise, if the
second hours data is in the parallel data log, the overlapping part
will be treated as if it were in the second hour; if the first hours
System Settings
CDC Factory 7.1
ActivEssentials Administration Guide
2-34
data is in the parallel data log, it will be treated as first-hour data
(the second hour will not be included when first and second hour
data is switched).
Avoid changing an incident time frame to overlap with the change
back period before and after the change period.
Do not run time-consuming heavy database jobs during the change
back period. This will slow down the procedures used to move
data.
Avoid doing the following within 10 minutes of the start or end of
the first hour, or the end of the second hour, or the time of a
change forward:
Starting, stopping or refreshing VPCollector for asset
configuration changes
Disconnecting the VPCollector machine from the network
Shutting down or restarting OPC servers used by any
VPCollectors
Schedule data swapping jobs for times when the database server is
not busy, for example, at weekends.
Schedule data swapping jobs for different times so that only one
jobs runs at a time.
Do not query data while it is being swapped (for example, in
VPWeb), because the tables will contain a mixture of data.
Do not interrupt automatically scheduled jobs (such as data
swapping) through SQL Server Agent.
Do not use event sample times of one hour or longer. This applies
to sampled events and triggered sample events.
If these rules are not respected, VPCollector may miss some daylight
saving commands and collected data may be inaccurate.
Known Issues and Workarounds
Here are some known issues and workarounds for Daylight Saving:
Since identifier records are isolated for the rolling back period, a
unique identifier may have multiple records (at most three) with
the same value. This may be confusing when viewed in a VPWeb
time-line, and may produce inaccurate data when used to group
data in Production View. This may be handled in the future.
VPWeb views may experience performance degradation during the
rolling back period. If the Now checkbox is checked in VPWeb, the
last hours data will disappear and be gradually replaced by the
new hours data. Close unnecessary instances of VPWeb to speed
this process.
Special incident collection. Some customers use special trigger
values to open and close all incidents. The real incident trigger
(IncidentID) is unknown until the incident is closed. When the
database receives the FirstHourStart command, the open incidents
System Settings
CDC Factory 7.1
ActivEssentials Administration Guide
2-35
will be closed with an unknown trigger and thus an unknown
IncidentID. By rolling the incidents in and out of the data log, you
can correct the incidents afterwards.
Retro-Stop. If you have retroactive incident editing capability
(Retro-Stop), an operator can select a different incident for an
open incident and the application sends the new trigger to the PLC.
If an incident is opened before the first hour and closed in the first
hour, the part before the first hour is not retro-changed.
If a VPCollector is not running before the first hour Start Time, and
it is started during the first hour or the second hour, the user must
manually disable incident and identifier merging. Data collection
will not be affected.
If a VPCollector is running as normal, and is shut down before the
first hour End Time and restarted before the second hour End
Time, data collection for the second hour will not be functional. The
workaround is to run the stored procedure
dbo.usp_DST_SetVPCDataLog to manually move the first hour data
to the DST tables. For more information, please contact Activplant
Support.
If a VPCollector is running as normal, and is shut down before the
second hour End Time, and is restarted after the second hour End
Time, data collection will not be affected. However, identifier and
incident records will not be merged because merging options are
not restored. The workaround is to run the stored procedure
dbo.usp_DST_RestoreMergingEnabledItems to manually restore
the merging options. For more information, please contact
Activplant Support.
During a Daylight Saving period you must not do any of the
following:
Change the system time.
Shut down an OPC server.
Perform any action that may result in network disconnection.
We recommend that where possible you schedule the first hour (for
example, November 4th, 2007, 1:00 AM2:00 AM) as a
non-productive period.
System Settings
CDC Factory 7.1
ActivEssentials Administration Guide
2-36
Filtering Incident Data by IdentifiersChoosing
the Right Method
VPWeb allows you to filter incident data by using an identifier such as
a batch number, part number, or shift. Filtering affects all the VPWeb
views, so if you apply a filter when Production View is active, then
switch to Trend View, the filter still applies.
ActivEssentials applies filtering in VPWeb using two fundamentally
different models, with three options in each. The filtering model is set
in the System Setting module of MI Admin, and the viewing options
are set in VPWeb. The two models define incidents that overlap with
the spans of the filtering identifier differently.
For example, should the entire term of an incident that begins during a
lunch break but is not resolved until production resumes be included
as a part of the shift record? In one of the models the answer is yes,
but in the other the answer is no.
This section covers the following topics:
How Filtering WorksThree Options on page 2-36
How Filtering WorksTwo Models on page 2-37
How Filtering WorksThree Options
Filtering reduces the amount of data requested from the database.
These filtering options are available in each of the two filtering models,
but the data drawn from the database may differ. There are three
options available when filtering:
Inclusive. The Inclusive option allows you to view database
records (incidents and the like) that occur during the span of the
filtering identifier. No other data appears. For example, you may
want to view the faults that occurred during the term of a
particular batch number or shift.
Exclusive. The Exclusive option allows you to view all database
records that occurred outside the term of the filtering identifier. For
example, you may want to view incidents that occurred during the
day, but to exclude those that occurred during the manufacture of
a certain batch number.
Exclude All. The Exclude All option allows you to view all database
records that fall outside the terms for both the filtering identifier
and any other identifiers that overlap with this identifier.
Filtering affects all the VPWeb views, so if you apply a filter when
Production View is active, then switch to Trend View, the filter still
applies. If you apply a filter when viewing data at a level higher than
Note: The Exclude All filtering method applies only to Production View. If used with
any other view the results are the same as when using the Exclusive filtering
method.
System Settings
CDC Factory 7.1
ActivEssentials Administration Guide
2-37
the asset, such as at a group or the plant level, the filter applies to all
the assets below that level. If you are using the Inclusive option, data
appears for all assets that operate using the filtering identifier.
How Filtering WorksTwo Models
ActivEssentials provides two models for viewing incidents associated
with identifiers. You can associate the entire duration of all overlapping
incidents with the identifier, or clip the incident durations so you only
see the portion of the incident durations that occurred while the
identifier was in effect.
In both models, you have the option to view the data in two ways:
Inclusive filtering. You can view incident data for periods when
the identifier is in effect.
Exclusive filtering. You can view incident data for periods when
the identifier is not in effect.
Inclusive and exclusive filtering methods collectively recognize the
entire durations of all of the incidents, regardless of the filtering
model.
The Full Duration Model
In the diagram below, the model used separates incidents based on
their concurrence, or not, with the active periods of the identifier. The
identifier occurs five times during the time line, and during this same
period five incidents occur. However, the durations of the incidents do
not coincide with the spans of the identifier:
Incidents 1, 2, 3, and 5 have spans that overlap with the identifier,
and so are included in the results for inclusive filtering.
Incident 4 occurred outside the times when the identifier was
active, and so is the only incident captured using exclusive
filtering.
Note: ActivEssentials also provides the Exclude All filtering option for use in VPWeb.
Exclude All is intended for use in Production View only, but if it is selected the
results obtained through any of the other views are exactly the same as if
Exclusive filtering had been selected.
System Settings
CDC Factory 7.1
ActivEssentials Administration Guide
2-38
Figure 2-15 The full duration model
The Coincident Duration Model
In the diagram below, the model used splits incident durations based
on their concurrence, or not, with the active periods of the identifier.
The identifier occurs five times during the time line, and during this
same period five incidents occur. However, the model requires that
only the portions of the terms of the five incidents that overlap with
terms of the identifier should be associated with the identifier. Any
portions of any incidents that lie outside the term of the identifier
appear in the results for the exclusive filtering.
Incidents 1 and 2 are split as they both overlap identifier duration
F1, and so they appear in the results for both inclusive and
exclusive filtering.
Incident 3 has a duration that overspans both identifier durations
F2 and F3, and so occurs in the inclusive filtering record for both.
Incident 3 also has three durations outside the durations of the
identifier, so three records appear in the exclusive filtering.
Incident 4 occurred fully outside the terms of the identifier, so only
appears in the exclusive results
Incident 5 only appears in the inclusive filtering as it occurred fully
inside the duration of identifier duration F5.
Figure 2-16 The coincident duration model
0 5 10 15 20 25 30
Time line
Filter time chunks
Incidents
Results for inclusive filtering
Results for exclusive filtering
F1 F2 F3 F4 F5
1 2 3 4 5
1 2 3 3 5
4 1 2 3 3 3
System Settings
CDC Factory 7.1
ActivEssentials Administration Guide
2-39
Choosing the Filtering Model
The two filtering models provide alternative ways of viewing incident
data. The full duration model is the default with an installation of
ActivEssentials, so you must decide if it is best for your needs. You can
change this to the coincident duration model by altering the Filter
incident by duration only system setting (see System Settings on
page 2-5). If you do change the setting, the change affects the entire
installation of ActivEssentials.
Incidents can overlap with the terms of any identifier. When you set a
specific identifier to filter the incidents, you are building a relationship
between the two. Choosing whether to include the full duration of
incidents can provide very different data.
CDC Factory 7.1
ActivEssentials Administration Guide
3-1
Plant Management
Plant Management
CDC Factory 7.1
ActivEssentials Administration Guide
3-2
Introduction to Plant Management
Plant Management is an AppCenter module in which you define the
plant hierarchy for your data collection system. When you connect to
an ActivEssentials server it automatically places a Plant icon in the
Plant Management module. You then have to create the rest of the
hierarchy.
The first time you connect to the server you will see only a plant
icon, and you will have to supply an ActivEssentials license number in
order to make the system functional. Licensing is covered in the
System Configuration Guide (System Configuration Guide.pdf),
which is included in the ActivEssentials installation package.
This chapter covers the following topics:
Working in the Plant Management Module on page 3-2
Creating and Editing Groups and Assets on page 3-7
Working in the Plant Management Module
In the Plant Management module you create the plant hierarchy that
mimics the actual arrangement of assets in your manufacturing
facility. The Plant Management module has a Plant Hierarchy frame
and a grid showing details of the item highlighted in the plant
hierarchy.
There are just a few basic operations to perform in this module. You
can add extra groups and assets to the hierarchy for each plant.
This section covers the following topics:
Opening the Plant Management Module on page 3-2
Preparing for Plant Hierarchy Configuration on page 3-6
The Plant Hierarchy Concept on page 3-3
The Plant Management Module on page 3-4
Basic Plant Management Editing Functions on page 3-5
Opening the Plant Management Module
Use the instructions below to open the Plant Management module of
AppCenter. In this module you create the plant hierarchy consisting of
a plant, groups, and assets.
Note: You cannot begin work on the plant hierarchy until you have installed an
ActivEssentials license key. For information on how to do this, see the CDC
Factory System Configuration Guide, which is in your installation package.
Plant Management
CDC Factory 7.1
ActivEssentials Administration Guide
3-3
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
1 In the taskbar, click the Configuration category button.
The taskbar displays icons for the task modules in the
Configuration category.
2 In the taskbar, click the Plant Management button.
The Plant Hierarchy Concept
In most manufacturing facilities the machines which produce the final
product are organized into production lines, and parts flow from
machine to machine. The production lines themselves may also be
aggregated into areas, divisions or departmentswhatever
terminology is in use. The organization of departments, lines, and
assets (machines) constitutes the plant hierarchy of the facility.
In configuring your data collection system, you have to create a virtual
plant hierarchy in the AppCenter that is a mimic of your actual
production facility. If you are collecting data from some but not all of
your assets, you only have to include those from which data is being
collected.
As part of the needs assessment prior to installing ActivEssentials
software, the integrator should identify the hierarchy of machines,
lines, etc. that are part of the data collection system. You use this
information to configure the hierarchy in the Plant Management
module of AppCenter.
The plant hierarchy consists of three basic elements:
Plant. In ActivEssentials the plant corresponds to an
ActivEssentials database. In the Plant Hierarchy frame a plant has
a factory icon.
Group. A group is an organizational unit, such as a department,
area, or production line. You can have any number of levels of
groups in the hierarchy. For example, you may have areas,
departments, and production lines. Or you may have only
production lines.
Asset. An asset is a point at which data is collected. This may be
an individual machine or a PLC. Alternatively, you may split a large
machine into two or more assets, or use a single PLC to gather
information from two or more assets. An asset is the lowest level of
the hierarchy. You can add an asset directly to the plant level, or to
any group, but you cannot add an asset to an asset.
Note: The Plant Management module displays the plant hierarchy in the Plant
Hierarchy frame. If you select a plant or group in this frame, the grid on the right
displays any child objects of the selected one. If you select an asset in the
hierarchy, the right half of the screen presents links that allow you to go to
different asset functions.
Plant Management
CDC Factory 7.1
ActivEssentials Administration Guide
3-4
You can add, remove, copy, paste, or modify the plant hierarchy at any
time. You do not need to stop and restart the data collection system.
Whenever you make changes they carry through to the users view.
There is a limit of 9999 assets within a group, and 9999 groups within
another group. This is theoretical maximum, and it is unlikely that you
would approach this number. However, if you do have large numbers,
and you delete several thousands and replace them, it is theoretically
possible you could approach this limit, because the database may not
delete all the assets in one job, even when they are marked for
deletion. Deleting large numbers of groups or assets from the
database could take several days.
The Plant Management Module
The Plant Management frame is similar to other modules in AppCenter,
but there is no secondary frame, and the Object Library is not present
in the Plant Hierarchy frame.
The grid area can have one of two appearances:
If you select a higher-level item in the Plant Hierarchy frame, such as a
plant or a group that has descendants, the grid lists the descendants
of the selected item. This view is useful if you want to edit properties
of the descendants (to do so, select the descendant in the grid,
right-click, and choose Properties.
Figure 3-1 The grid showing descendants of a group, and the asset context menu
If you select an asset in the Plant Hierarchy frame, the grid area
displays a page showing links to other modules, and any template
configuration are applied to the asset (this area is empty if this is
the initial configuration). These links are useful when you are
configuring an asset.
Note: In the grid, active groups and assets have colored icons, while inactive groups
and assets have greyed icons.
Note: The plant hierarchy that you design in ActivEssentials does not necessarily
have to correspond to your actual plant hierarchy, but it makes sense if it does.
Remember that the reporting system will be organized according to the
hierarchy that you design.
Plant Management
CDC Factory 7.1
ActivEssentials Administration Guide
3-5
Figure 3-2 The asset links page (asset selected in the plant hierarchy)
Basic Plant Management Editing
Functions
The Plant Management module allows you to perform several
operations. You can:
Add or remove groups and assets. You usually perform these
actions by using the wizards which guide you through the process
and prompt you for the necessary information. You can also add a
new group or asset by editing directly in the grid.
Copy groups or assets from one part of the hierarchy to another.
You can use the toolbar buttons or context menus to copy and
paste groups or assets. Alternatively, you can drag a group or
asset and drop it in a different part of the plant hierarchy. You
cannot cut or move a group or asset without copying. When
copying a group, you have the option to copy all the descendants
(groups or assets) along with it.
View and edit the properties of groups or assets.
Navigating in the Plant Hierarchy
The plant hierarchy consists of a number of levels, each of which is a
parent or child of other items. A branch of the hierarchy may
appear expanded or collapsed.
A collapsed branch has a to the left. Click the to expand it.
An expanded branch has a to the left. Click the to collapse it.
An item that has no child has a beside it.
When you select an item in the plant hierarchy, the details of its
children (if any) appear in the grid. You can edit the children directly in
the grid view. You can navigate from one item to another in the plant
hierarchy by using the arrow keys on your keyboard.
Note: Group and asset names must be unique within a branch of the hierarchy, but
they can repeat in different branches. For example, you cannot have two
assets named Asset 1 within Group A, but you can have an Asset 1 in Group A
and in Group B.
Plant Management
CDC Factory 7.1
ActivEssentials Administration Guide
3-6
Preparing for Plant Hierarchy
Configuration
When creating object in the plant hierarchy you must proceed in the
order given below.
1 Start the VPFoundation service. To do this, on the VPFoundation
machine right-click the Activplant icon in the desktray, choose
VPFoundation, then Start. Do not start any of the other
ActivEssentials services yet.
2 Open the Plant Management module (see Opening the Plant
Management Module on page 3-2).
3 Do one of the following:
a) Create an asset immediately below the plant, or
b) Create a group and then an asset below the group.
See Creating a Group on page 3-7, and Creating an Asset on page
3-9.
4 Start the VPQManager and VPCollector services by right-clicking
the Activplant icon in the desktray on the appropriate machines,
and choosing the service and Start.
Note: It is important to start only VPFoundation first, then create at least one asset,
before starting VPQManager and VPCollector.
Plant Management
CDC Factory 7.1
ActivEssentials Administration Guide
3-7
Creating and Editing Groups and Assets
The Plant Management module of AppCenter allows you to define the
plant hierarchy by adding groups and assets to it. This section
describes these operations.
This section covers the following topics:
Creating a Group on page 3-7
Creating an Asset on page 3-9
Deleting Groups and Assets on page 3-11
Copying Groups and Assets Within the Plant Hierarchy on page
3-12
Copying Groups and Assets Within the Grid on page 3-12
Moving or Copying Groups and Assets by Drag-and-Drop on page
3-13
Viewing and Editing Properties of Groups and Assets on page 3-14
Editing Groups and Assets in the Grid on page 3-15
Changing the Order of Groups on page 3-16
Rollover ValuesAn Overview on page 3-17
Creating a Group
Use the instructions below to create a group. You can add a group to
the plant level, or to another group, but you cannot add a group to an
asset. If you are creating the first of your groups, you have to add it to
the plant, and it should represent the highest level of the hierarchy
(for example, a department). Then you add the lower levels of the
hierarchy (groups or assets) below it.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, open the Plant Management task module, using the
instructions in Opening the Plant Management Module on page 3-2.
Licensed and started VPFoundation. See Preparing for Plant
Hierarchy Configuration on page 3-6.
Read Basic Plant Management Editing Functions on page 3-5.
Note: It is best to create the backbone of the hierarchy (the groups) before creating
any assets. When you have done that, you should create just one asset (a
template asset), then define the data collection parameters for it. You can
then copy this asset to other parts of the hierarchy, editing only the parameters
that differ. This will save you a lot of time.
Plant Management
CDC Factory 7.1
ActivEssentials Administration Guide
3-8
Procedure
1 In the Plant Hierarchy frame, expand the hierarchy (if necessary)
until you can see the plant or group to which you wish to add the
new group, then select it.
2 Do one of the following:
a) Click the New Group button on the toolbar.
b) Right-click the plant or group to which you wish to add the new
group, and choose New Group from the menu.
The Add New Group wizard opens.
3 Click Next to proceed past the welcome screen.
4 Click in the Name field and type a name (up to 50 characters) for
the new group. If desired, type a code (up to 10 characters) and a
description (up to 255 characters) in the appropriate fields. (The
name must be unique at a particular point in the hierarchy; a
parent cannot have two child objects with the same name.)
Figure 3-3 The Name and Description wizard page
5 If you want the group to be active immediately, check the Active
checkbox.
6 Click Next.
7 Review the summary of the new group, then click Finish to save it.
Note: You cannot use the following characters when creating names in the Plant
Management module: & . ( ). For more information, see Illegal Characters on
page 1-17.
Note: You can also create a group or asset by clicking in the New row of the grid
(usually the bottom row). Double-click in the Name column, then fill in the other
columns as needed.
Plant Management
CDC Factory 7.1
ActivEssentials Administration Guide
3-9
Creating an Asset
Use the instructions below to create an asset. You can add an asset to
the plant level or to any group, but you cannot add an asset to an
asset. You will be prompted for the name of the VPCollector and the
OPC server that the asset will use for data collection; you do not need
to supply these at this point, but you will have to do so later on.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, open the Plant Management task module, using the
instructions in Opening the Plant Management Module on page 3-2.
Created a group in the plant hierarchy using the instructions in
Creating a Group on page 3-7.
Read Rollover ValuesAn Overview on page 3-17.
Procedure
1 In the Plant Hierarchy frame, expand the hierarchy (if necessary)
until you can see the plant or group to which you wish to add the
new asset, then select it.
2 Right-click on the plant or group and select New Asset.
The Add New Asset wizard opens.
3 Click in the Name field and type a name (up to 50 characters) for
the new asset. If desired, type a code (up to 10 characters) and a
description (up to 255 characters) in the appropriate fields. (The
name must be unique at a particular point in the hierarchy; a
parent cannot have two child objects with the same name.) Click
Next.
Note: You can save time by creating just one template asset and configuring it
completely with all the data items, etc. that it will use. You can then copy this
asset to different parts of the hierarchy and edit only the parameters that vary.
See Copying Groups and Assets Within the Plant Hierarchy on page 3-12 for
further information, but you will have to create some assets first.
Plant Management
CDC Factory 7.1
ActivEssentials Administration Guide
3-10
Figure 3-4 The Name and Description wizard page
4 Select a VPCollector and an OPC server that the asset will use for
data collection, and enter the name of the device (PLC, etc.) that
the asset uses in the Default access path field.
You need not enter this information yet if you have not defined any
VPCollectors or OPC servers. You can add these to the asset at a
later stage if desired.
Figure 3-5 VPCollector and OPC server information
5 If necessary, enter a rollover value for counters and timers. Note:
We strongly advise you to leave this at the default setting. This
value should be the same for all assets. Click Next.
Note: You cannot use the following characters when creating names in the Plant
Management module: & . ( ). For more information, see Illegal Characters on
page 1-17.
Plant Management
CDC Factory 7.1
ActivEssentials Administration Guide
3-11
6 Click Next. Review the summary of the new asset. Click Finish.
Deleting Groups and Assets
Use the instructions below to delete a group or asset from the plant
hierarchy. When you delete a group you have the option either to
delete the descendants of the group, or to reassign them to the parent
of the group you are deleting.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, open the Plant Management task module, using the
instructions in Opening the Plant Management Module on page 3-2.
If necessary, reassign assets you want to remain active to other
groups using the instructions in Copying Groups and Assets Within
the Plant Hierarchy on page 3-12.
Procedure
1 In the Plant Hierarchy frame, expand the hierarchy (if necessary)
until you can see the plant or group that you want to delete, then
select it.
2 Right-click the plant or group and choose Delete from the menu.
If you are deleting a group that has descendants, choose whether
to delete the descendants too, or to reassign them to the parent of
the group you are deleting, then click OK.
Figure 3-6 Deleting or reassigning descendants
3 If you are deleting an asset, or a group that has no descendants,
confirm the deletion in the message box that appears.
Note: You can also create a group or asset by clicking in the New row of the grid
(usually the bottom row). Double-click in the Name column, then fill in the other
columns as needed.
Warning! When you delete a group or asset, all data that has been collected for it is
deleted from the database. Consider whether you want to inactivate the
group or asset instead (inactive groups or assets do not appear in
VPWeb).
Plant Management
CDC Factory 7.1
ActivEssentials Administration Guide
3-12
Copying Groups and Assets Within the
Plant Hierarchy
Use the instructions below to copy a group or asset to another part of
the plant hierarchy. You can copy, but not move, groups and assets. To
move an asset, copy it to the new location, then delete the original. If
you copy an active group or asset, the copy is inactive; you have to
activate it afterwards.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, open the Plant Management task module, using the
instructions in Opening the Plant Management Module on page 3-2.
If you are using the Data Management function in MI Admin, you
should read Effects of Plant Hierarchy Reorganization on page
13-99 before you move any groups or assets.
When you move groups and assets, you might affect the
relationship between archived data and the plant hierarchy
structure. See Effects of Changing Archive Definitions on page
13-100 for more information.
Procedure
1 In the Plant Hierarchy frame, expand the hierarchy (if necessary)
until you can see the plant or group that you want to copy, then
select it.
2 Right-click on the group or asset and select Copy.
3 Navigate to the item in the plant hierarchy below which you want
to paste a copy of the group or asset, and select it.
4 Right-click on the group or asset and select Paste.
5 To commence data collection, activate the group or asset by
checking the Active checkbox in the grid.
Copying Groups and Assets Within the
Grid
Use the instructions below to copy and paste groups or assets within
the AppCenter grid.
Note: You can also delete child objects of a parent object by selecting the parent in
the Plant Hierarchy frame, then selecting and deleting the child objects in the
grid. Right-click in the grid and choose Delete.
Plant Management
CDC Factory 7.1
ActivEssentials Administration Guide
3-13
Prerequisites
Before doing this you need to have done or read the following:
If necessary, open the Plant Management task module, using the
instructions in Opening the Plant Management Module on page 3-2.
If you are using the Data Management function in MI Admin, you
should read Effects of Plant Hierarchy Reorganization on page
13-99 before you move any groups or assets.
When you move groups and assets, you might affect the
relationship between archived data and the plant hierarchy
structure. See Effects of Changing Archive Definitions on page
13-100 for more information.
Procedure
1 In the Plant Hierarchy frame, expand the plant hierarchy to a
point where you can see the group or asset you need to copy.
2 In the grid, right-click on the group or asset and select Copy.
3 Do one of the following:
a) If you need to create the copy in the same location, right-click
on the New row in the grid and select Paste.
b) If you need to create the copy in a different location, select the
new parent item in the plant hierarchy, (the grid refreshes) and
click the Paste button on the toolbar.
Moving or Copying Groups and Assets by
Drag-and-Drop
Use the instructions below to move or copy a group or asset by
dragging and dropping. If you copy an active group or asset, the copy
is inactive; you have to activate it afterwards. There are two ways to
copy by drag-and-drop: you can drag-and-drop within the Plant
Hierarchy frame, or you can drag-and-drop from the grid to the Plant
Hierarchy frame.
Note: When you copy to the same location, the copy is named Copy of (original
name). You can change the name in the Properties dialog boxseeViewing
and Editing Properties of Groups and Assets on page 3-14.
Note: When you copy a group or asset the copy is not active. It will not collect data
until you activate it by checking the Active checkbox in the grid.
Plant Management
CDC Factory 7.1
ActivEssentials Administration Guide
3-14
Prerequisites
Before doing this you need to have done or read the following:
If necessary, open the Plant Management task module, using the
instructions in Opening the Plant Management Module on page 3-2.
If you are using the Data Management function in MI Admin, you
should read Effects of Plant Hierarchy Reorganization on page
13-99 before you move any groups or assets.
When you move groups and assets, you might affect the
relationship between archived data and the plant hierarchy
structure. See Effects of Changing Archive Definitions on page
13-100 for more information.
Procedure
1 In the Plant Hierarchy frame, expand the hierarchy if necessary
so that you can see the groups or assets.
2 To move a group or asset, do one of the following:
a) Drag the icon next to an object in the Plant Hierarchy frame to
another place in the hierarchy, and drop it there. The copy
becomes a child of the object on which you drop it. Or,
b) Drag the icon next to an object in the grid, and drop it in the
Plant Hierarchy frame. The copy becomes a child of the object
on which you drop it.
3 To copy a group or asset, perform the steps outlined above but
hold down the Ctrl key while dragging.
4 If desired, activate the group or asset by checking the Active
checkbox in the grid.
Viewing and Editing Properties of Groups
and Assets
Use the instructions below to view or edit the properties of groups or
assets in the plant hierarchy.
To view all the properties of a group or asset you must use the
Properties dialog box as described here. You can also view or edit
some of the properties in the grid, as described in Editing Groups and
Assets in the Grid on page 3-15.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, open the Plant Management task module, using the
instructions in Opening the Plant Management Module on page 3-2.
Plant Management
CDC Factory 7.1
ActivEssentials Administration Guide
3-15
Procedure
1 In the Plant Hierarchy frame, expand the hierarchy (if necessary)
until you can see the plant or group that you want to view, then
select it.
2 Do one of the following:
3 Right-click on the group or asset and select Properties. The
Properties dialog box opens.
Figure 3-7 Asset Properties dialog box
4 In the Properties dialog box for a group you can change the order
of child objects by clicking the Ordinal Position button. Follow the
instruction given in Changing the Order of Groups on page 3-16.
Editing Groups and Assets in the Grid
Use the instructions below to edit the properties of groups and assets
in the grid. The grid allows you to edit the properties of several items
without having to navigate to them, so long as they all belong to the
same parent.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, open the Plant Management task module, using the
instructions in Opening the Plant Management Module on page 3-2.
Procedure
1 In the Plant Hierarchy frame, expand the hierarchy (if necessary)
until you can see the parent of the group or asset that you want to
edit, then select it.
The details of the children of this parent appear in the grid.
Plant Management
CDC Factory 7.1
ActivEssentials Administration Guide
3-16
2 To edit the name or description, double-click and type the text.
3 To change the VPCollector or OPC server, click in the column, then
click the down-arrow and select from the drop-down list.
4 To activate or inactivate a group or asset, click in the Active
checkbox. If you inactivate a group, all the assets below that group
will be inactive.
Changing the Order of Groups
Use the instructions below to change the order in which assets or
groups display under their parent. You change the order by editing the
ordinal position property. When you change the order, it is changed in
all views that use the plant hierarchy.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, open the Plant Management task module, using the
instructions in Opening the Plant Management Module on page 3-2.
Procedure
1 In the Plant Hierarchy frame, expand the hierarchy (if necessary)
until you can see the branch in which you want to change the order.
2 Right-click on the parent group and select Properties. A
properties dialog box opens.
Figure 3-8 Group Properties dialog box
Note: When you edit in the grid, a pencil icon replaces the group or asset icon at the
left end of the row. If you click outside the row, the pencil is replaced by the
group or asset icon, indicating that your changes have been saved.
Plant Management
CDC Factory 7.1
ActivEssentials Administration Guide
3-17
3 In the Properties dialog box, select the General tab, then click
the Ordinal Position button.
Figure 3-9 The Ordinal Position dialog box
4 Select an item in the list that appears, then click the up- or
down-arrows to change the order. Click OK when done.
Rollover ValuesAn Overview
When creating an asset you can set a rollover value that each
accumulator data item assigned to the asset can use. The value you
set for the asset must be within the maximum value set for the
instance of VPCollector that the asset uses. The rollover value can be
modified for any accumulator data item as is assigned to the asset.
Maximum rollover value. The global maximum rollover value is
set through the VPTray on the computer hosting VPFoundation.
This setting affect all instances of VPCollector installed within the
system. In a new installation of ActivEssentials software, the
default maximum value is 210 000, but you can set this maximum
value as high as 21 000 000.
Default rollover for an asset. You can define a default rollover
value to use with each accumulator data item added to the asset.
By default this is 32 000. You can change this to anything that is
Note: The maximum value displays in VPTray is 0. The default is 210 000, but
unless you need to alter this default value, it will continue to read 0.
Plant Management
CDC Factory 7.1
ActivEssentials Administration Guide
3-18
appropriate, but it can not exceed the maximum value defined
through VPTray. You set the value when creating the asset in the
Plant Configuration module; you can edit this value later.
Accumulator rollover values. When you assign an accumulator
data item, it will adopt the rollover value defined for the asset
(typically 32 000). Rollover values are only assigned to solicited
accumulators. You can override this default value and set any other
value that is appropriate. However, if you do change the value it
must be within the maximum value set in VPTray. If you set a value
other than the default, this value takes precedence.
CDC Factory 7.1
ActivEssentials Administration Guide
4-1
Application Template Management
Application Template Management
CDC Factory 7.1
ActivEssentials Administration Guide
4-2
Introduction to Application Template
Management
Building and maintaining an ActivEssentials system can include the use
of applications that run on the platform. An application is a container
for templates that have a common purpose, for example, the
Activplant Throughput Analyzer ActivApplication finds manufacturing
constraints, but to do this, Throughput Analyzer requires a variety of
templates that match different production environments.
An application can be an ActivApplication you purchase from CDC
Factory, or you can develop your own to fit your needs. The templates
within the application define its purpose.
ActivApplications are an integral part of ActivEssentials. However, to
ensure that ActivEssentials collects the required data and presents it in
the right way, you must apply specific configuration to each of the
assets from which you need the data. It is the templates contain the
configuration needed to support the applications. Once applied, you
can still upgrade the ActivApplications with updated templates that
provide new functionality and reporting.
This chapter covers the following topics:
Configuration Templates on page 4-2
Applications and Templates on page 4-8
Initial Set Up of Configuration Templates on page 4-41
Maintaining your Configuration Templates on page 4-77
Configuration Templates
Configuration templates enable you to rapidly deploy a model
configuration consisting of asset configuration templates, and
templates of your shift configuration and report configuration to one or
more ActivEssentials databases.
This section covers the following topics:
Purpose of Templates on page 4-2
Application Template Types on page 4-3
Configuration Template Types on page 4-6
Purpose of Templates
Templates provide a way of replicating asset configurations and
structures for shift scheduling and reporting so that they can be
distributed across an enterprise. The templates available are as
follows:
Configuration templates. These are templates that are compiled
from the structures that administer the shift scheduling and
reporting configuration. The templates consist of fully configured
Application Template Management
CDC Factory 7.1
ActivEssentials Administration Guide
4-3
data objects that define the data collected from the assets. They
are related by function and allow users to transfer configuration
from one ActivEssentials database to another. These templates
consist of the configuration for just one of the functional aspects,
but can be packaged with others when being exported.
Asset templates. These templates contain the definitions that
describe the data objects that are needed to support the collection
of data for user defined applications and for the ActivApplications.
The templates contain the structure for collecting the data needed
and the objects that provide analysis (such as calculations and
VPWeb views), but when applied to a plant, they acquire the
context in which they must work.
Asset templates can be applied to assets many times, but
configuration templates can only be imported once.
Application Template Types
An installation of ActivEssentials, which includes one or more
ActivApplications, also contains all the templates that define the
purpose of any applications.
In most cases, the packaged configuration templates are installed at
the same time as installing the ActivApplication, but the asset
templates are applied through the Plant Management module when
required. The packaged configuration provides the foundation for
handling the collected data, so these must be in place before applying
the asset templates.
Figure 4-1 ActivApplication templates
Asset Templates
Asset templates contain structural elements that define how to collect
the data from the asset. The figure to the right shows these individual
elements. The global definitions required to support the local data
DocunenLaLion & Help
SysLen
ApplicaLions ConfiguraLion ApplicaLion lnsLaller
ApplicaLion Specific
Modules
ApplicaLion ConfiguraLion
AcLivApplicaLion
keporL ConfiguraLion 1enplaLes
CollecLion ConfiguraLion
AsseL 1enplaLes
AsseL SLaLes
vPWeb views
CalculaLions
AsseL ProperLies
ShifL ConfiguraLion 1enplaLes
ShifLs
ShifL Periods
ShifL Schedules
ShifL Schedule 1ypes
Legend
AsseL 1enplaLes
Packaged ConfiguraLion 1enplaLes
keporL CaLegories
keporL lolders
keporL SLyles
keporL 1enplaLes*
keporL Schedules
keporL 1enplaLes differ fron keporL ConfiguraLion 1enplaLes in LhaL Lhey
describe Lhe conLenL of specific reporLs, whereas Lhe configuraLion
LenplaLes conLain all of Lhe configuraLion infornaLion needed Lo produce
Lhe reporLs needed by Lhe applicaLion, which can include reporL LenplaLes.
*
k1LE ConfiguraLion DaLaseLs
Application Template Management
CDC Factory 7.1
ActivEssentials Administration Guide
4-4
items (those with a purple border in the figure) are created when asset
templates are imported, but the process creates only the global
definitions that are required.
Asset templates include the following elements:
Collection Configuration. The asset templates contain all of the
global data definitions needed to support the ActivApplication, as
well as placeholders for the OPC Item IDs and the default Access
Paths. The import process defines the global definitions and then
creates the local data items, including any properties and property
values, needed for data collection.
vPWeb views
ProducLion view
DeLailed view
1rend view
LayouL view
AsseL SLaLes
SLaLe DefiniLions
CalculaLions
AsseL CalculaLions
AsseL ProperLies
ProperLy DefiniLions
AsseL ShifLs
koLaLion Plans
DaLa CaLegories
AccunulaLors
ldenLifiers
EvenLs
lncidenLs
Application Template Management
CDC Factory 7.1
ActivEssentials Administration Guide
4-5
Figure 4-2 Data collection configuration in an asset template
VPWeb Views. Users of VPWeb can access the ActivApplications
to find the data they need. The views needed for the various
applications vary, but they could be presented in any or all of the
following:
Production View
Detailed View
Trend View
Layout View0
Report Viewer (reports are also available through SSRS)
Asset States. To provide an understanding of the current and
historical condition of an asset, the template would define all of the
required state definitions, and contain placeholders for the actual
OPC Item ID and the Access Path.
Calculations. ActivApplications may rely on specific calculations to
present the data users need. As such, the templates include all of
the necessary calculations. When applying calculations to an asset,
the calculations can be applied directly, or drawn from calculations
templates. The templates include all relevant global definitions.
Asset Properties. Included in the template are placeholders for
all of the properties the application requires for the asset.
RTLE Configuration. The use of RTLE items in a template
depends on the needs of individual ActivApplications. RTLE
configuration includes RTLE items, triggers, trigger actions,
functions, and so on.
C
o
l
l
e
c
L
i
o
n

C
o
n
f
i
g
u
r
a
L
i
o
n
EvenL DaLa
CaLegory
AccunulaLor DaLa
CaLegories
ldenLifier DaLa
CaLegories
lncidenL DaLa
CaLegories
lncidenL
SubcaLegories
lncidenL keason
Codes
EvenLs
AccunulaLor lLens
ldenLifier lLens
lncidenL
lLens
Links Lo
SubcaLegories
Nuneric
variables
Alphanuneric
variables
ldenLifier
ProperLies
ldenLifier
values
ProperLy
values
EvenL
AcknowledgnenL
AccunulaLor
ldenLifier Links
SubcaLegories
keason
Codes
SubcaLegory
lLens
keason Code
ProperLies
Application Template Management
CDC Factory 7.1
ActivEssentials Administration Guide
4-6
Configuration Template Types
An ActivApplication requires a structure to handle the data collected
from the assets, including the configuration of reports and the
standardized shift structures. This structure is packaged as
configuration templates, and must be in place before applying the
asset templates.
Shift Configuration Templates
ActivEssentials includes a selection of standardized preconfigured
shifts, from which administrators can create shift packages for
deployment across the plant hierarchy. Users can also configure their
own shift structures, and assemble a shift configuration template for
deployment. If you have several ActivEssentials installations, you can
deploy the structure by exporting the configuration as a template and
then importing it on your other servers. Imported shift schedules are
assigned to assets in the same way as locally defined shift schedules.
Shift Schedules are the central element of shift structures, but they
depend on secondary definitions for Shift Periods, Shifts, and Shift
Schedule Types. When creating a shift configuration template these
secondary elements are also included, so there is no need to define
them in another ActivEssentials database.
Report Configuration Templates
The report configuration templates are installed with the
ActivApplications. These templates provide a means of deploying the
standardized reports needed for analyzing the collected data.
Report configuration templates contain all of the primary elements
needed for a report: the Report Categories, Report Templates, and
Report Styles. Depending on the report definitions, the templates can
ShifL ConfiguraLion 1enplaLes
keporL ConfiguraLion 1enplaLes
ShifL Schedules
ShifL 1ypes
ShifLs
ShifL Periods
keporL SLyles
keporL 1enplaLes
DaLaseL DefiniLions
Schedules keporLs
keporL Delivery Lo
Shared folders
Application Template Management
CDC Factory 7.1
ActivEssentials Administration Guide
4-7
also contain one or more secondary elements, such as the Report
Servers, Dataset Definitions, Shared Folders, and Run Schedules. The
definitions for these secondary elements are automatically included
when a package is defined in the ActivEssentials database, and form
part of the report configuration template when being deployed.
When you apply a template, you cannot choose specific elements from
that template; everything is applied. When creating a template, it is a
good practice to create model report categories that contain just
what is needed for later deployment as report configuration templates.
Report Configuration Template Best Practices
To ensure the effective deployment of a report configuration template,
ensure that you remember the following:
Report servers. All categories are assigned to a defined master
server, but must be reassigned later.
Report data items. Prior to applying a report configuration to
individual assets, users must apply the asset templates as these
contain all data items that are required for any reports.
Report parameters. Report Categories and Report Templates can
require that users enter parameters before they can run a report,
such as a selection in the Plant Hierarchy and a definition of the
time frame. Report developers should consider the following when
defining parameters:
Choose options for these parameters that do not require
references to specific entities within the installation. For
example, use the group/asset selection in VPWeb, or use
generic references to the time frame, such as the current shift,
or current time span in VPWeb.
For reports generated using the SQL Reporting Service, use the
option to display the SQL Server Parameter editor, so the user
who requests the report can set the parameters at the time.
For non-time frame and non-plant hierarchy parameters, create
parameters to generate meaningful reports, but that can be
altered later.
Note: You cannot include Production View report categories in a report configuration
template. The structures within Production View reports do not align with the
structures required for report configuration templates.
Application Template Management
CDC Factory 7.1
ActivEssentials Administration Guide
4-8
Applications and Templates
In ActivEssentials you can use the templates that come with an
ActivApplication or create a series of templates to use within an
application you define that suits your needs. Applications are
collections of templates that provide for the collection of detailed
information, in a consistent way, about the operation of your plant.
This section covers the following topics:
What is an Application? on page 4-8
Where are Applications Stored? on page 4-8
Parameters when creating a new asset template on page 4-9
Application and Template Tasks on page 4-11
Options When Importing Applications on page 4-14
Understanding the Reimport Options for Existing Applications on
page 4-25
Options for Applying a Template to An Asset on page 4-28
Options When Removing a Template From an Asset on page 4-38
What is an Application?
An application in ActivEssentials is a container that houses a collection
of templates. The templates you use must reside within an application,
but the application plays only a minimal role in how its templates are
imported into your ActivEssentials configuration. The templates within
an application can have a common theme, but do not need to, since
one or more templates can be imported at a time.
Example
The Throughput Analyzer contains several templates to find
constraints on assets. Since production methods vary significantly
between different industries, the templates analyze these constraints
in different ways; a template that might work well in the automotive
industry could be inappropriate in the bottling industry.
Where are Applications Stored?
If you are about to use an Activplant ActivApplication, you receive the
application as a seed database. A seed database can contain just one
application, so if you were to use two or more ActivApplications, you
would receive a seed database for each. You do not use this seed
database as your working database; it only stores the application and
its templates if you need to reinstall.
After installing the application, a reference to it appears in the tree
below the ActivApplications item in the Plant Hierarchy frame (see
figure along the side). However, the configuration (the templates) that
exists in an application does not become a part of working database
until you import the application.
Application Template Management
CDC Factory 7.1
ActivEssentials Administration Guide
4-9
Parameters when creating a new asset
template
Before you start to use your application, you should create at least one
empty application container in the working database. To do this you
add templates from the application(s) you have installed. Templates
are applied to assets using the standard template configuration.
Thereafter, the initially installed applications remain as a repository for
the templates they contain. You can create a series of applications and
add to them the templates, so the templates from an initial installation
can be used more than once in a variety of user created applications.
The database keeps a record of any changes that have occurred, which
acts as a reference for checking the existing configuration to the
originally applied configuration.
When creating an asset template, you need to provide a series of
parameters for a model asset, the base asset. As you then create the
template, you provide the context needed to apply the template to
other assets in your plant, which means you have to point the
configuration to the correct location to retrieve data.
Depending on how you collect the data, you choose either a OPC Item
Name Space or a RTLE Item Name Space. You then define the
following parameters when you create a new template:
The asset path (the path in plant hierarchy down to the asset)
The OPC server name (if you are using RTLE to collect data)
The search and replace parameters (to distribute the information).
You can provide a generic value which serves as a placeholder for
the plant hierarchy path, the name of the OPC server, or a Default
Value as a placeholder.
Note: CDC Factory may issue updates to its ActivApplications, which you should
store as a separate application. Set up a test asset with which to test the
functionality of the updated application to ensure that data collection occurs in
the manner you expect.
Note: Leave this value blank if you intend to apply the template to individual assets. If
you intend to use a workbook to build your plant, a default value is useful since
you do not have to change the configuration for each of the assets later.
Application Template Management
CDC Factory 7.1
ActivEssentials Administration Guide
4-10
Figure 4-3 The Asset Template Parameters dialog box
Before starting this process, you must know the structure of your
plant. If you are using RTLE instances, you need to know their names
and the names of the OPC servers that collect the data from the
assets. If you are collecting data directly from OPC servers, you need
to know the paths to each asset that should receive the template
configuration.
Process
Fully configuring all of your assets could require you to make many
entries in the Asset Template Parameters dialog box. The paths and
OPC server instances could vary considerably across your plant, so you
need to account for each variation. For example, you could have two
production lines that have an identical configuration, but the paths
down through the plant hierarchy are different since they belong to
different groups. You must then provide a separate entry for each
production line, and possibly a second entry for related OPC servers if
you are to use the RTLE.
OPC Item Name Spaces
An OPC item name space can either be a description of the path down
through the plant hierarchy to the group where the assets reside, or
an item that is defined in the RTLE. Depending on the particular item
name space, you will need to provide one or the other.
Application Template Management
CDC Factory 7.1
ActivEssentials Administration Guide
4-11
For asset path type name spaces, the following apply:
For the Base Object Value, this the common part of the OPC item
name at the base asset.
For the Search Pattern column, you can provide a generic path
down to the parent group level, which then acts as a placeholder
for the asset path in the template.
For the Default Value, you provide a path down to the parent group
(department, line, etc.). Depending on how you intend to use the
template, this column could be optional. If you intend to apply the
template to a variety of assets in organizationally different parts of
your plant hierarchy, you should leave the cell blank. However, if
you intend to use the template to apply the template to many
assets in the same group, you should complete the cell.
For the RTLE item name spaces, as the structures within RTLE
instances are the same, the entries in each of the three columns
should be the same.
RTLE Item Device Names
This parameter is available only if the base asset in the template uses
an RTLE OPC server. The process for configuring RTLE item device
names is similar to the OPC item name spaces, as you have to provide
a Base Object Value, Search Pattern, and Default Value. The difference
with the RTLE items is that you identify an OPC server instance for
each of the three values. As the structures are the same within each
RTLE instance, the provision of the three OPC server instance names is
sufficient. The Access Path parameter is available only if the template
asset uses a non-RTLE OPC server.
Application and Template Tasks
The operations with applications templates take place in the Plant
Management module at the asset level in the plant hierarchy, or below
the ActivApplications node in the Plant Hierarchy frame of the Plant
Management task module.
Asset Level Tasks
The template operations at the asset level affect only the selected
asset. The following table provides descriptions of the operations that
are available:
Note: When you apply the template, the process searches for the Search Pattern and
replaces it with the Default Value.
Application Template Management
CDC Factory 7.1
ActivEssentials Administration Guide
4-12
ActivApplications Tasks
Many of the operations in the ActivApplications node are similar to
those at the asset level. Some changes could be made at the asset
level, but ActivApplications provides a central location for performing
these tasks. Other operations in ActivApplication are global, as they
affect the use of templates wherever they are in use. The following
table provides descriptions of the operations that are available:
Table 4-1 Asset level operations
Task What it does
Selecting an asset This is the default view
1
when viewing templates, which
provides a listing of the templates that have already been
applied to the asset.
1. You must select the Templates sub-task option in the View (secondary)
frame first.
Creating a new
template
You can create new templates based on the configuration of a
selected asset. If you have made modifications to an asset
configuration that should also be applied to other assets, the
new template can distribute any new configuration.
Applying a template Starts the Apply Template wizard, to apply a particular
template to an asset.
Obtaining a
configuration report
Configuration reports show the configuration that exists at an
asset. For example, the report provides information that
indicates if configuration items were added by a user or were
created by a template, and if created by a template, if these
items were later modified.
Detaching a
template
When you detach a template, the historical data and the
template configuration is kept, but the link to the template is
broken. If the template is needed again, it must be reapplied.
Use this option if the purpose of a template no longer applies
to the asset.
Removing a
template
Removing a template also removes all historical data and any
configuration that was applied by the template. Use this option
with caution.
Resynchronizing
the configuration
with the template
You can reapply the template to restore the original template/
asset configuration, or to synchronize the template with the
asset.
Viewing a template
usage report
You can produce a report that displays how a template has
been applied to an asset. As the report shows only the
configuration applied by the template, you can view the
current status of all template created items.
Viewing template
properties as
applied to an asset
Displays a properties dialog box that provides the template
name, protection level, and current status; the user
parameters, template scope, and template options; and the
schedule used to apply the template.
Application Template Management
CDC Factory 7.1
ActivEssentials Administration Guide
4-13
Table 4-2 Operations available from the ActivApplications node
Task What it does
Operations from the ActivApplications node
Creating a new
application
An application is a container for the templates used to
distribute configuration across the ActivEssentials database. To
become functional, applications require the definition of
templates.
Importing an
application
You can import or reimport applications that are stored in the
ActivEssentials database. During an initial import process, the
templates within an application are imported as they were
created. When reimporting, you can choose what you want to
import.
Operations with applications level items
Creating a new
template
This options operates in the same way as creating a template
at the asset level, except you must select the asset to use as
the model.
Export template You can export the configuration of a template to a file. This
file can then be used to import that configuration into another
ActivEssentials installation.
Creating a
workbook
You can export the configuration of an application as an Excel
workbook. The file must be saved as an XML file, but could
then be modified and reimported.
Viewing application
properties
A dialog box shows general information about the application.
It is possible to change the application name, edit a
description, and activate or deactivate the application.
Operations with the templates level item
Apply a template This starts the Apply template to asset wizard, which allows
administrators to apply a template to an asset.
Removing a
template
Removing a template also removes all historical data relating
to the template from the database, for all affected assets, so
use this option with caution.
Detaching a
template
When a user detaches a template the historical data is kept,
as is the configuration applied by the template, but the link to
the template is broken for all affected assets. If the template
is needed again, it must be reapplied.
Deactivating a
template
When you deactivate a template, its use is suspended on all
affected assets. There is no loss of historical data, and the
template can easily be reactivated.
Validating a
template
Validating a template shows any errors and warnings about
the template configuration.
View template
report parameters
This option allows you to view a listing of the parameters
available in a template and whether or not they are included.
Operations in the grid at the template level
Application Template Management
CDC Factory 7.1
ActivEssentials Administration Guide
4-14
Options When Importing Applications
When importing an application, you can choose to import all of the
templates within the application, or to import just those that you need.
If you are importing templates for the first time, the import process
brings the templates in as they were originally prepared, but if you are
reimporting templates, you have many options.
Since it is possible to change the configuration of both the original
template and the configuration of the template as it exists in the
current configuration, the reimport options allow you to overwrite or
keep many aspects of the asset configuration as you import. The
reimport options work at several levels, so you can tailor the import
process to your needs.
Fro more information, see Understanding the Reimport Options for
Existing Applications on page 4-25.
Importing Unimported Templates
The import process is designed to recognize if you are importing the
templates in a application for the first time or reimporting. During an
initial import you might opt to import just some of the templates in an
application, but at a later time you could choose to import the
remaining templates.
If you are importing a mixture of previously imported and unimported
templates, the process is able to differentiate between the two.
Reimported templates have many options available, but any previously
Resynchronizing
the configuration
with the template
You can reapply the template to restore the original template/
asset configuration, or to synchronize the template with the
asset.
Viewing a template
usage report
Produces a report that displays how a template has been
applied to an asset. As the report focusses only on the
configuration applied by the template, you can view the
current status of all template created items.
Viewing template
properties as
applied to an asset
Displays the template the name, protection level, and current
status; the user parameters, template scope, and template
options; and the schedule used to apply the template.
Table 4-2 Operations available from the ActivApplications node (Continued)
Task What it does
Note: When you import the templates within an application, you are bringing the
template into the current configuration; you are not applying the templates to
individual assets.
Application Template Management
CDC Factory 7.1
ActivEssentials Administration Guide
4-15
unimported templates are imported as originally prepared. Any
existing configuration elements that match elements being imported
adhere to the following rules:
If a global definition has the same name in both current and
template configurations, but the configurations differ, the import
process creates a new definition using the same name as in the
current configuration, but suffixed with _01, _02, _03, etc.
If the import process finds a global definition, data item, or RTLE
item with configuration that matches those that are being
imported, the process adopts these definitions, items, or views as
a part of the template. In this instance, the process uses the
names used in the current configuration; it does not rename the
existing items.
Deciding What to Import
The options described here relate only to instances where you are
reimporting templates. Previously unimported templates are always
imported as they were supplied.
Whether you choose to reimport just one or all of the templates in an
application, you can restore the templates to where they were when
originally imported, import the templates along with any new updates,
or make item by item choices about how to handle the differences. You
can also make use of a number of predefined import options that
follow specific themes during the reimport process, or create your
own, if needed.
When importing templates, you have many options, which are listed
on five tabs in the options dialog box.
The Templates Tab
The options on the page describe how the import process should
handle the templates you are reimporting. When you reimport
template(s), the process updates the templates in line with the
configuration contained in the template(s), but you can modify the
behavior by controlling the options on the other tabs.
Reimporting applications templates. The Reimport option
has no effect if you are importing templates for the first time, as
the options available on each of the other tabs only apply to
reimport situations.
The Reimport previously imported templates checkbox is
selected by default when you import/reimport templates. If you
are importing the template(s) because of updates and have not
made any changes to how the template(s) were applied, the
default settings on each of the tabs should allow the
template(s) to update properly.
If you have made changes to a template after a previous
import, but there were no updates to the original template, you
can restore the configuration to where it was when first
imported. However, if you need to keep some of the changes,
you should review the options available on the other tabs.
Application Template Management
CDC Factory 7.1
ActivEssentials Administration Guide
4-16
Actions after import. These are the final tasks in an import
process.
The Delete the application seed database option provides a
way of removing the application seed database after importing
all of the templates you need. While the option is made
available, we do not recommended that you select this option
unless you have a backup copy available because you might
have to reimport the templates at a later time.
The You take ownership of the template(s) option
provides a way of severing the connection between the original
template and how it was used in the configuration. This allows
you to modify the template in any way you need, but you
cannot upgrade the configuration in the event that there are
updated distributions of the template(s). This options is
available for initial imports only.
Figure 4-4 The reimport options for templates
Note: If you deselect the Reimport option, this disables access to the options under
the other tabs.
Application Template Management
CDC Factory 7.1
ActivEssentials Administration Guide
4-17
The Global Definitions Tab
The options on this page relate to how the import process should
handle the global definitions. When reimporting the template(s), the
process compares the existing and template configurations, and then
uses the processing instructions on the page to decide what to do
when it recognizes differences.
Template created definitions that were modified by users.
When reimporting the template(s), the process might find global
definitions that were modified.
The Update the Item Name to match checkbox allows you to
change the definition name to that from the template. If you do
not select the checkbox, the import process updates the
definition with the template properties but leaves the name as
it is in the current configuration.
The Update all properties, except Item Name checkbox
lets you update all of the properties in a global definition, but
leaves the item name as it was in the existing configuration. If
you have changed imported configuration items, you can
choose to keep these changes or restore the configuration to
where it was. If you do not select the checkbox, the import
process updates the item name but leaves the configuration as
it is in the current configuration.
Note: If you leave both options deselected, the process leaves the modified global
definitions as they are.
Application Template Management
CDC Factory 7.1
ActivEssentials Administration Guide
4-18
Figure 4-5 The options available on the Global Definitions tab
User created definitions that are now used in template.
During the import, should the process find global definitions that
have the same name and/or are configured in exactly the same
way as definitions in the template, choose from the following:
The Update the item name to match option allows the
import process to adopt user-defined definitions that have
exactly the same configuration, but different names, by
updating the name to that from the template.
The Update all properties, except item name option allows
the import process to adopt any user-defined definitions that
have the same name as a definition in the template, by
updating the configuration to match that in the template.
Template created items that are no longer in template(s).
After the initial import of a template, some specific definitions from
the original template may have been removed. Since the
Note: If you leave both of the options deselected, the import process ignores the
existing definitions and creates new definitions from the template. If existing
definitions have the same name as imported the definitions, the process adds a
suffix in the form of _01, _02, _03, etc. to the newly created definitions.
Application Template Management
CDC Factory 7.1
ActivEssentials Administration Guide
4-19
definitions remain in the existing configuration, the import process
needs to know how to handle the differences. The initial settings
for the following are selected:
The Keep unmodified global definitions option allows you
retain previously imported definitions that were not modified in
the current configuration.
The Keep definitions modified by users option allows you to
retain previously imported definitions that were modified by
users.
The Data Items Tab
The options on this page relate to how the import process should
handle differences between data items in the existing and template
configurations.
Template created items that were modified by users. During
the import, the process could find template-created items that
were modified by users.
The Update the OPC item addresses option allows you to
restore the OPC item addresses to where they were after the
previous import.
The Update all properties except OPC option allows you to
update all of the properties, except the OPC item addresses.
User created data items that were adopted in template. If
the import process finds user-created data items that were
previously added by the template because they had the same
names or were configured in exactly the same way as items in the
template, choose from the following:
The Update the OPC item addresses option allows you to
update the OPC item addresses to match the template.
The Update all properties except OPC option allows you to
update all properties except the OPC item addresses.
Note: If you leave both options deselected, the import process only removes
definitions that have no local references. However, this check for local
references only occurs during the import process, so if the definitions are not
used, they are not discarded until the next reimport.
Note: If you leave both options deselected, the import process leaves the data items
in their modified forms.
Note: If you leave both options deselected, the import process leaves the data items
as they are and creates new data items from the template. If there is a naming
conflict, the process adds suffixes in the form _01, _02, _03, etc. to the new
data item names.
Application Template Management
CDC Factory 7.1
ActivEssentials Administration Guide
4-20
Figure 4-6 The options available on the Data Items tab
Template data items that were deleted by user. During a
reimport, the import process might find instances where
template-created data items were removed by users, so the
Recreate the data items option allows you to state whether the
process should restore these items from the template.
Template data items that are no longer in template. During
the development of a template, the developers might decide to
remove some data items from the template. If template-created
data items that exist in the current configuration are no longer in
the template, the import process needs to know how to handle the
differences.
The Keep unmodified items option allows you to retain items
that users did not modify.
The Keep items modified by users option allows you to
retain items that users modified. The initial setting is selected.
The Keep items that were originally user defined option
allows you to retain items that were originally user defined but
then adopted in the template configuration. The initial setting is
selected, as users might have had good reasons for creating
the item(s).
Application Template Management
CDC Factory 7.1
ActivEssentials Administration Guide
4-21
The RTLE Items Tab
The options on this page relate to how the import process should
handle differences between the current and template configurations,
and RTLE items. If the template does not contain RTLE configuration,
these choices will not have any effect during an import process.
Template created RTLE items that were modified by users.
The options relate to template-created RTLE items that have been
modified:
The Update the Value Expressions option allows you update
the Value Expression in an RTLE item, but to leave all other
properties as they are in the current configuration.
The Update all properties, except option allows you to use
all configuration properties from the template(s), except the
Value Expression.
Note: If you leave any items unchecked, the deleted items in the template are also
removed from the assets to which the template was applied. Any data related
to the deleted items is then also removed.
Note: If you leave both options deselected, the import process leaves any RTLE
items as they are in the configuration.
Application Template Management
CDC Factory 7.1
ActivEssentials Administration Guide
4-22
Figure 4-7 The options available on the RTLE Items tab
User created RTLE items that are now used in the template.
The options relate to user-created RTLE items that were adopted in
the template(s).
The Update the Value Expressions option allows you update
the Value Expression in an RTLE item, but to leave all other
properties as they are in the current configuration.
The Update all properties, except option allows you to use
all configuration properties from the template(s), except the
Value Expression.
Matching current with existing items. These options finds RTLE
items that are the same in the database and the template and
allows you to update these items in one of two ways:
The By Name option allows you to update any current RTLE
item names with item names that are in the template.
The By Name and Value Expression option finds matching
RTLE item name and value expression, and allows you to
update current items that match both parameters.
Template created RTLE items that no longer exist in
template. The options relate to RTLE items that were originally
template-created but no longer exist in the template.
The Keep unmodified items option allows you to retain items
that users have not modified.
Application Template Management
CDC Factory 7.1
ActivEssentials Administration Guide
4-23
The Keep modified items if still option allows you to retain
items that are still referenced in the configuration. This is
selected by default, as this ensures that data can be collected if
the item is still in use.
If there are no local references to the RTLE items, the process
removes them.
RTLE items that directly use. This option only applies to RTLE
items that directly use an OPC server that is not an OPC server.
This allows you to update the Value Expression of those items.
The Web Views Tab
The options on this page relate to how the import process should
handle differences between the VPWeb views in the current
configuration and in the template. Any changes in a view, even without
a change in data is considered modified.
Template views that were modified by users. You can choose
one of the following options for views users have changed.
The Replace views with those that match option allows you
to replace any view users have modified with new views from
the template.
The Keep any modified views option allows you to retain any
views users modified, and to create new views that match the
template. By default, this is selected, as this ensures that users
can continue to use modified views.
Template views that were deleted by users. The Recreate the
missing views option allows you to create new views from the
template to replace those that are missing.
Application Template Management
CDC Factory 7.1
ActivEssentials Administration Guide
4-24
Figure 4-8 The options available on the Web Views tab
Views that are no longer in template(s). The options relate to
views that were created during a previous import of the
template(s), but the views no longer appear in the template.
The Keep unmodified views option allows you retain any
template-created views that are no longer in the template(s).
The Keep views modified by users option allows you to
retain views users have modified. By default, this is selected, to
ensure that users still have access to views they modified.
Choosing a Template
When importing an application, you can select the templates that you
need and choose to include or omit items that have been modified.
Application Template Management
CDC Factory 7.1
ActivEssentials Administration Guide
4-25
Figure 4-9 Example of template import options when importing an application
Understanding the Reimport Options for
Existing Applications
During a reimport procedure, you can either make item by item
choices about how the database should handle differences between
the current configuration and the template configuration, or you can
use one of several import options that use a theme to control the
settings used in the reimport. These themes are as follows:
System Default. This takes a conservative approach by taking the
view that the reimportation process should respect any changes
you have made to the configuration. Only updated configuration in
unmodified areas or new configuration is imported.
Synchronize All. This option aggressively reimposes the
configuration of the template. If the template has been updated,
any changes in the template become a part of the configuration
wherever you have applied it.
Synchronize Insertion and Modification. This option reimposes
the configuration of the template wherever you have applied it.
However, the process respects any user defined changes in the
configuration, which ensures any custom configuration remains as
a part of the overall configuration.
User Defined Options. This option has no default options, as it
allows the user to reimport using exactly the same options as were
used during the previous reimportation. This means that the
options could be the same as, for example, the System Default, if
this is what was used the previous time.
You can also create your own import option schemes.
For more information, see Specifying User-Defined Import Options for
a Template Asset on page 4-61.
Application Template Management
CDC Factory 7.1
ActivEssentials Administration Guide
4-26
Note: With any of the options, you can consider these as a starting point. When
necessary, you can modify the options to fit specific needs before reimporting
the template. If you do modify the reimport options, you can use the User
Defined Options at a subsequent time to use the same set of options again.
Table 4-3 The default Import Options
Tab Option
1
System
Default
Synchroni
ze All
Synchronize Insertion
and Modification
Templates tab
Reimporting application templates
Reimport previously imported
templates
Actions after import
Delete the application seed database
You take ownership of the
template(s)
2
Global Definitions tab
Template created definitions that were modified by users
Update the Item Name to match with
template
Update all properties, except the Item
Name to match with template
User created definitions that are now used in template
Update the Item Name to match with
template
Update all properties, except the Item
Name, to match with the template
Template created defintions that are no longer in template
Keep unmodified global definitions
Keep definitions modified by users
Data Items tab
Template created items that were modified by users
Update the OPC item addresses
Update all properties except OPC item
addresses
User created items that are now used in template
Update the OPC item addresses
Application Template Management
CDC Factory 7.1
ActivEssentials Administration Guide
4-27
Update all properties except OPC item
addresses
Template items that were deleted by users
Recreate the items with latest
configuration
Template items that are no longer in template
Keep unmodified items
Keep items modified by users
Keep items that were originally user
defined
RTLE Items tab
Template created RTLE items that were modified by users
Update the Value Expression to match
with template
Update all properties, except the Value
Expression, to match with the
template
User created RTLE items that are now used in template
Update the Value Expression to match
with template
Update all properties, except the Value
Expression, to match with the
template
Match template RTLE items with existing items
By Name
By Name and Value Expression
Items that directly use an OPC server that is not a VPServer
Update the Value Expression to match
with template
Template created RTLE items that no longer exist in template
Keep unmodified items
Keep modified items
Web View tab
Template views that were modified by users
Table 4-3 The default Import Options (Continued)
Tab Option
1
System
Default
Synchroni
ze All
Synchronize Insertion
and Modification
Application Template Management
CDC Factory 7.1
ActivEssentials Administration Guide
4-28
Options for Applying a Template to An
Asset
After importing the templates you need, you apply these to the assets
in your ActivEssentials installation. Some templates are better suited
to retrieving data from particular kinds of assets than others, so you
need to apply the right templates. For example, the Throughput
Analyzer ActivApplication is designed to find production constraints.
Some templates are more effective in monitoring high-speed lines with
few inputs, such as bottling, and others that are better suited to
monitoring the creation of complex assemblies, such as automotive
products.
Scope Definition when Applying a Template
A template includes data items used in deriving the data that you
need, and the VPWeb views. When applying a template, you can select
what elements in the template you need; however, when you apply a
template for the first time, some elements are disabled as these items
are essential to the operation of the template.
Replace views with those that match
with the template
Keep any modified views and create
new views that match with template
Template views that were deleted by users
Recreate the missing views
Views that are no longer in template
Keep unmodified views
Keep views modified by users
1. This table does not contain any information about the User Defined Options as there are no
default setting for this option.
2. The You take ownership option applies only in situations where you are importing an
application for the first time; the option is disabled for any subsequent reimport operations.
Table 4-3 The default Import Options (Continued)
Tab Option
1
System
Default
Synchroni
ze All
Synchronize Insertion
and Modification
Application Template Management
CDC Factory 7.1
ActivEssentials Administration Guide
4-29
Figure 4-10 An example of the scope definition options
Applying Templates
You can apply templates to assets in several ways, including picking a
template and then picking the asset to which it should be applied, or
picking an asset and then picking the template to use. If you are
applying a template to many assets, you create a workbook that
contains all of the configuration data. In all instances, you must review
the options available.
Applying vs. Reapplying
When you initially apply a template to an asset, there are limited
options since you need to fully apply the template. These options
include variables that give the template local context. When you
reapply, you might need to account for changed configuration, or an
updated template to distribute. You need to make decisions about how
to handle specific differences between the configuration that exists at
the asset level and that in the template.
The Options
Apply/reapply options are available when you are applying a template
for the first time, or when resynchronizing the asset configuration to
the template. You can also make use of a number of predefined import
options that follow specific themes during the reimport process, or
create your own, if needed.
Note: Before reapplying a template, make sure you know about any changes that
have occurred, so you know what options relate to the reapplication. You
should also determine where changes have occurred in asset configuration, so
you can decide whether or not to keep these changes.
Application Template Management
CDC Factory 7.1
ActivEssentials Administration Guide
4-30
For more information, see Understanding the Reimport Options for
Template Asset Configuration on page 4-35 and Specifying
User-Defined Import Options for a Template Asset on page 4-61
The Data Items Tab
The majority of the options only apply to situations where you are
reapplying a template.
Template created items that were modified by users. The
options relate to items created when you first applied or reapplied the
template, but which have since been altered. These options are
available only when reapplying a template.
The Update the OPC item addresses option allows you to
update the OPC item addresses with those from the template. This
option leaves all other properties of the asset as they are.
The Update the protected properties option allows you to use
the protected properties from the template. This option leaves all
other properties as they are.
The Update all properties, except option allows you to update
from the template all asset properties, except the protected
properties and the OPC item addresses.
User created items that were adopted in template. The options
relate to items that existed in a configuration prior to applying a
template, but which are now a part of the template.
The Update the OPC address option allows you to use the
address in the template rather than address in the current
configuration.
The Update the protected properties option allows you to use
the protected properties from the template.
The Update properties other than option allows you update all
of the properties of the asset except those that are protected and
the OPC address.
The Change the status of option allows you to fully update all of
the data items that originally user-created and used at the asset. If
you select this option, this also selects all other options in the
groupbox.
This option is not available during an initial application of the
template.
Items created by template but later deleted from asset(s). The
option relates to template-created data items that were removed from
the asset configuration(s). The Recreate deleted items from
template option allows you to recreate these using the latest
configuration. This is a default selection that ensures that all necessary
data items are defined at the asset.
Application Template Management
CDC Factory 7.1
ActivEssentials Administration Guide
4-31
Figure 4-11 The options available on the Data Items tab
Items that no longer appear in template. These options relate to
items that were originally defined in the template, but are removed. If
these items still exist in the template, they could still collect data.
These options are available only when reapplying a template.
The Keep unmodified items in asset(s) option allows you to
retain originally template-created data items that were not
modified. This option is selected by default.
The Keep modified items in asset(s) option allows you to retain
data items that were originally template-created, but were later
modified. This option is selected by default as users probably had a
good reason for making the change.
Note: If you deselect either of these options, you could lose historical data.
Application Template Management
CDC Factory 7.1
ActivEssentials Administration Guide
4-32
The RTLE Items Tab
The options available for RTLE items apply only in situations where an
RTLE is needed to give context to the data collected from an asset.
Template created RTLE items that were modified by users.
The options relate to RTLE items that came from the template, but
users have chosen to modify them. These options are available
only when reapplying a template.
The Update the Value Expression option allow you to use
the Value Expression from the template. This option leaves all
other properties as they are.
The Update all properties except option allows you to use all
properties from the template, except the Value Expression.
Note: If you leave both of these options deselected, the apply template process
makes no changes to the user-modified RTLE items. However, if the template
includes updated configuration, you should determine if you should apply this
new configuration.
Application Template Management
CDC Factory 7.1
ActivEssentials Administration Guide
4-33
Figure 4-12 The options available on the RTLE Items tab
User created RTLE items that are/were adopted in template.
The options relate to RTLE items that were originally user-created,
but were later adopted for use in the template. Even though these
items are now in the template, the database always recognizes
that they were not a part of the original template configuration.
The Update the Value Expression option allows you to use
the Value Expression from the template. This option leaves all
other properties as they are.
The Update all properties except option allows you to use all
properties from the template, except the Value Expression.
Note: If you leave both options deselected, the process leaves the items as they are.
Application Template Management
CDC Factory 7.1
ActivEssentials Administration Guide
4-34
Matching current with existing items. These options finds RTLE
items that are the same in the database and the template and
allows you to update these items in one of two ways:
The By Name option allows you to update any current RTLE
item names with item names that are in the template.
The By Name and Value Expression option finds matching
RTLE item name and value expression, and allows you to
update current items that match both parameters.
RTLE items that directly use This option applies only to RTLE
items that directly use an OPC server that is not an OPC server.
This allows you to update the Value Expression of those items.
Template created RTLE items that were deleted. The option
relates to template-created RTLE items that were removed from
the asset configuration(s). The Recreate deleted RTLE items
option allows you to recreate these using the latest configuration.
Template created RTLE items that no longer exist in
template. The options relate to RTLE items that were originally
template-created, but the template developer has chosen to
remove them from the configuration. These options are available
only when reapplying a template.
The Keep user created items option allows you retain items
that were user-created but adopted in the template.
The Keep unmodified option allows you to retain
template-created items that were not modified.
The Keep modified option allows you to retain
template-created items that were modified.
The Web Views Tab
All of the options on the Web Views tab relate to reapplication
situations only; they have no effect during the initial application of a
template. In an initial application, you will need all of the VPWeb
views; only in reapply situations do you need handle any changes.
Template created views modified at the asset(s). The options
relate to template-created VPWeb views that were modified by
users.
The Update the views option allows you to restore any user
modified views to the template-defined configuration.
The Add new views option allows you to add to the
configuration any new views that are now in the template.
Note: Even if you leave all of these options in a deselected state, any RTLE items
that are still in use will remain in the current configuration.
Application Template Management
CDC Factory 7.1
ActivEssentials Administration Guide
4-35
Figure 4-13 The options available on the Web Views tab when applying a template
Template created views that were deleted from asset(s).
The options relate to any VPWeb views that were created by the
template, but were removed from the asset(s). The Recreate the
views option allows you create new views on the asset(s) to
replace those that are missing.
Template created views that no longer exist in template. The
options relate to VPWeb views that were created by the template,
but have been removed.
The Keep unmodified views option allows you to retain any
unmodified views.
The Keep modified views option allows you to retain any
views that users have modified.
Understanding the Reimport Options for
Template Asset Configuration
During a reimport procedure, you can either make item by item
choices about how the database should handle differences between
the current template asset configuration and that in the template
Note: If you do not choose these options, the reapply process will remove all views
that were also removed from the template.
Application Template Management
CDC Factory 7.1
ActivEssentials Administration Guide
4-36
configuration, or you can use one of several import options that use a
theme to control the settings used in the reimport. These themes are
as follows:
System Default. This takes a conservative approach by taking the
view that the reimportation process should respect any changes
you have made to the configuration. Only updated configuration in
unmodified areas or new configuration is imported.
Synchronize All. This option aggressively reimposes the
configuration of the template. If the template has been updated,
any changes in the template become a part of the configuration
wherever you have applied it.
Synchronize Insertion and Modification. This option reimposes
the configuration of the template wherever you have applied it.
However, the process respects any user defined changes in the
configuration, which ensures any custom configuration remains as
a part of the overall configuration.
User Defined Options. This option has no default options, as it
allows the user to reimport using exactly the same options as were
used during the previous reimportation. This means that the
options could be the same as, for example, the System Default, if
this is what was used the previous time.
It is also possible to save a set of user defined options for reuse.
For more information, see Specifying User-Defined Import Options for
a Template Asset on page 4-61.
Table 4-4 The default Import Options
Tab Option
1
System
Default
Synchronize All Synchronize
Insertion and
Modification
Data Items tab
Template created items that were modified by users
Update the OPC item addresses
Update the protected properties of the
asset(s)
Update all properties except the
protected and OPC item addresses
User created items that are now used in template
Update the OPC item addresses
Update the protected properties of the
asset(s)
Update all properties except the
protected and OPC item addresses
Change the status of the items to
match with the template
Application Template Management
CDC Factory 7.1
ActivEssentials Administration Guide
4-37
Items created by template but later deleted from asset(s)
Recreate deleted items from the
template
Template items that are no longer in template
Keep unmodified items in asset(s)
Keep items modified in asset(s)
RTLE Items tab
Template created RTLE items that were modified by users
Update the Value Expression
Update all properties, except the Value
Expression
User created RTLE items that are/were adopted in template
Update the Value Expression
Update all properties, except the Value
Expression
Match template RTLE items with existing items
By Name
By Name and Value Expression
Items that directly use an OPC server that is not a VPServer
Update the Value Expression to match
with template
Template created RTLE items that were deleted
Recreate deleted RTLE items
Template created RTLE items that no longer exist in template
Keep user created items
Keep unmodified templated created
items
Keep modified template created items
Web View tab
Template created views modified at the asset(s)
Table 4-4 The default Import Options (Continued)
Tab Option
1
System
Default
Synchronize All Synchronize
Insertion and
Modification
Application Template Management
CDC Factory 7.1
ActivEssentials Administration Guide
4-38
Options When Removing a Template From
an Asset
Even though a particular template is no longer relevant for an asset,
there could be elements of the template that you still want to use,
such as particular data items and VPWeb views. The template removal
process allows you to keep or remove the components of the template.
Update the views to match with the
template
Add new views
Template views that were deleted by users
Recreate the views
Template created views that no longer exist in template
Keep unmodified views
Keep modified views
1. This table does not contain any information about the User Defined Options as there are no default
setting for this option.
Table 4-4 The default Import Options (Continued)
Tab Option
1
System
Default
Synchronize All Synchronize
Insertion and
Modification
Application Template Management
CDC Factory 7.1
ActivEssentials Administration Guide
4-39
Figure 4-14 The options when removing a template
Data items and web views. The options relate to the
template-created data items and VPWeb views used for collecting
and then presenting data.
The Remove template created items option allows you to
discard any template-created items and views that were
modified by users.
The Remove unmodified template option allows you to
discard any user modified items and views.
Note: When removing data items, you break linkages in VPWeb views that reference
the items.
Application Template Management
CDC Factory 7.1
ActivEssentials Administration Guide
4-40
RTLE Items. The options relate to RTLE items that are a part of
the template configuration.
The Remove modified option allows you to discard
template-created RTLE items that users have modified.
The Remove unmodified option allows you to discard
template-created RTLE items that remain unmodified in the
configuration.
The Remove user created option allows you to discard
user-created RTLE items used in the template.
The Remove RTLE items option allows you to discard RTLE
items that still have dependent items.
OPC Server and addresses.
The Use the OPC server that option allows you to restore the
OPC server address that was in use before applying the
template.
The Remove the passthrough items option allows for the
restoration of an OPC server address if the previous data
collection source was not an RTLE instance.
The Copy the RTLE items option allows you to copy RTLE
items to the RTLE instance that was previously used to channel
data from an OPC server.
Application Template Management
CDC Factory 7.1
ActivEssentials Administration Guide
4-41
Initial Set Up of Configuration Templates
The applications and templates in your ActivEssentials installation are
located in the tree below the ActivApplication item, in the Plant
Hierarchy frame. Here you can perform almost all of the tasks that
relate to applications and templates.
This section covers the following topics:
Creating an Application on page 4-41
Creating a New Asset Template on page 4-42
Creating a New Shift Configuration Template on page 4-48
Creating a New Report Configuration Template on page 4-49
Importing an Application on page 4-52
Exporting an Application on page 4-56
Creating a Workbook From an Application on page 4-57
Providing Context in a Workbook on page 4-63
Processing a Workbook on page 4-65
Applying a Template to an Asset on page 4-70
Validating a Template on page 4-75
Creating an Application
Use the instructions below to create an application. An application is
just a container for the templates that you must define for use within
the application; applications, by themselves, do not contain any
configuration data.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, open the Plant Management module within
MI Admin. See Opening the Plant Management Module on page 3-2
for more information.
Procedure
1 Right-click on the ActivApplications item in the Plant Hierarchy
frame and select New Application.
The Create New Application wizard opens.
2 Click Next to move past the Welcome page.
The Create a new application page opens.
3 Do the following:
a) In the Name field, type a name for your application.
b) In the Description text area, type a description of the purpose
of the application.
Application Template Management
CDC Factory 7.1
ActivEssentials Administration Guide
4-42
4 Click Next.
A second Create a new application page opens.
5 Do the following, as needed:
a) In the Version field, type a version number for your
application.
By default, version 1.0.0 appears in the field but you can
change this.
b) In the Provider field, type whatever is appropriate.
By default, Activplant appears in the field but you can change
this.
c) If the application is required for use now, select the Active
checkbox.
6 Click Next.
The last page of the wizard opens.
7 Check the summary and then click Finish.
The new application appears in the grid.
Creating a New Asset Template
Use the instructions below to create a new asset template. You create
a template by taking the structure of the configuration that exists at a
particular asset and saving this to apply to other templates.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, open the Plant Management module within
MI Admin. See Opening the Plant Management Module on page 3-2
for more information.
If necessary, create a new application to contain the template
using the instructions in Creating an Application on page 4-41.
Read on page 4-9 for an understanding of what the parameters
represent in an asset template. This has particular reference to
Step 9 in the following.
Procedure
1 Expand the tree under the ActivApplications item in the Plant
Hierarchy frame.
The applications level of the tree opens.
2 Right-click on the application to which you need to add a template
and select New Template.
The Create New Application Template wizard opens.
3 Click Next to move past the welcome page.
The Create a new template page opens.
Application Template Management
CDC Factory 7.1
ActivEssentials Administration Guide
4-43
Figure 4-15 The Create a new template page
4 Do each of the following:
a) In the Name field, type a name for the template.
b) In the Description field, type a description of the purpose of
the template.
c) In the Template type field, click the down-arrow and select
Asset template
5 Click Next.
The Template Parameters Configuration page opens.
Note: The Application name is preselected for you, as it is taken from the application
where you started the wizard.
Application Template Management
CDC Factory 7.1
ActivEssentials Administration Guide
4-44
Figure 4-16 The Template Parameters Configuration page
6 Beside the Base asset field, click the ellipsis button.
The Plant Hierarchy browser window opens.
Figure 4-17 The Plant Hierarchy browser
7 As needed, expand the tree and select the asset, and then click
OK.
Note: In the next step you need to select the asset to use as the model for the
template. The asset you choose must have all of the data collection
configuration needed for the template.
Application Template Management
CDC Factory 7.1
ActivEssentials Administration Guide
4-45
The path to the asset appears in the Base asset field.
8 In the Template parameters section, click Parameters.
The Asset Template Parameters dialog box opens.
Figure 4-18 The Asset Template Parameters dialog box
9 To set the parameters for an OPC Item Name Space, do the
following, as needed:
a) In the Name column, on the next available row, click in the cell
and then click the down-arrow, and select OPC Item Name
Space from the list.
b) In the Search Pattern column, double-click in the cell and
type the generic plant hierarchy path you need to use for the
template.
c) In the Default Value column, double-click in the cell and type
the real path down to the parent group level. If you intend to
apply the template to individual assets, leave the cell blank
since you can use the template with assets at a variety of
locations within the Plant Hierarchy.
The path must end with a period.
Note: In the next step you need to determine the parameters used when applying a
template. These parameters include the source information, a generic
placeholder, and a real configuration point within your ActivEssentials
configuration. If you have not read the section on page 4-9, do so now.
Application Template Management
CDC Factory 7.1
ActivEssentials Administration Guide
4-46
d) In the Base Object Value column, double-click in the cell and
type the full path down to the base asset.
10 To set the parameters for an RTLE Item Device Name, do the
following, as needed:
a) In the Name column, on the next available row, click in the cell
and then click the down-arrow, and select the RTLE Item
Device Name from the list.
b) In the Search Pattern column, click in the cell and then click
the down-arrow that appears.
A drop-down list opens with a listing of the RTLE instances that
are currently defined in your ActivEssentials installation.
c) Select an RTLE instance.
The selection is a placeholder for the RTLE instance in the tem-
plate.
d) In the Default Value column, click in the cell and then click
the down-arrow that appears.
A drop-down list opens with a listing of the currently configured
RTLE instances.
e) Select the RTLE instance to use with the assets.
f) In the Base Object Value column, click in the cell and then
click the down-arrow that appears.
A drop-down list opens with a listing of the currently configured
RTLE instances.
g) Select the RTLE instance that is used with the base asset.
11 When finished adding the parameters, click OK.
Note: The path must end with a period (.) because if it does not, you run the risk of
ambiguity.
Note: In the following step, you set the parameters for an RTLE item device name. If
an RTLE instance has not been assigned to the base asset, you can omit this
step.
Note: After completing Steps 9 and 10 you might need to repeat these steps for
assets in different areas of the Plant Hierarchy. Create as many rows in the
Asset Template Parameters dialog box as you need to distribute the template
across your plant.
Application Template Management
CDC Factory 7.1
ActivEssentials Administration Guide
4-47
12 In the Template protection setting section, click the down-arrow
and select, as needed, the protection setting to limit how users can
modify the template:
Add items only.
Add items and modify the unprotected properties.
Add and modify any items.
Add, modify, and delete any items.
13 Click Next.
Figure 4-19 The Data Source Configuration page
14 Do the following:
a) In the VPCollector name field, click the down-arrow and
select the VPCollector instance that all assets should use.
b) In the OPC Server name field, click the down-arrow and select
the OPC server that should collect data from each of the assets.
c) In the Rollover value field, type an appropriate rollover value.
d) Check the Collect test data box if you want to collect test data
for this asset.
e) If you need the template to be immediately available, ensure
that the Active checkbox is selected.
15 Click Next.
The last page of the wizard opens.
16 Check the summary and then click Finish.
An entry for the new template appears in the grid.
Note: If you choose to collect test data, this template is counted as an asset in your
plant license. For information on checking your plant license asset limit, see
Viewing Licensing Information on page 2-3.
Application Template Management
CDC Factory 7.1
ActivEssentials Administration Guide
4-48
Creating a New Shift Configuration
Template
Use the instructions below to create a new shift configuration
template.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, open the Plant Management module within
MI Admin. See Opening the Plant Management Module on page 3-2
for more information.
If necessary, create a new application to contain the template
using the instructions in Creating an Application on page 4-41.
Procedure
1 Expand the tree under the ActivApplications item in the Plant
Hierarchy frame.
The applications level of the tree opens.
2 Right-click on the application to which you need to add a template
and select New Template.
The Create New Application Template wizard opens.
3 Click Next to move past the welcome page.
Figure 4-20 The Create a new template page
4 Do each of the following:
a) In the Name field, type a name for the template.
b) In the Description field, type a description of the purpose of
the template.
Application Template Management
CDC Factory 7.1
ActivEssentials Administration Guide
4-49
c) In the Template type field, click the down-arrow and select
Shift configuration template.
5 Click Next.
The Shift Configuration Template page opens with a listing of
the shift schedules already configured in your ActivEssentials
configuration.
6 Do the following:
a) Select the shift schedules you need to use in the template.
b) If you need the template immediately, ensure the Active
checkbox is selected.
7 Click Next.
The last page of the wizard opens.
8 Check the summary and then click Finish.
An entry for the new template appears in the grid.
Creating a New Report Configuration
Template
Use the instructions below to create a new report configuration
template.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, open the Plant Management module within
MI Admin. See Opening the Plant Management Module on page 3-2
for more information.
If necessary, create a new application to contain the template
using the instructions in Creating an Application on page 4-41.
Procedure
1 Expand the tree under the ActivApplications item in the Plant
Hierarchy frame.
The applications level of the tree opens.
2 Right-click on the application to which you need to add a template
and select New Template.
The Create New Application Template wizard opens.
3 Click Next to move past the welcome page.
Note: The Application name is preselected for you, as it is taken from the
application where you started the wizard.
Application Template Management
CDC Factory 7.1
ActivEssentials Administration Guide
4-50
Figure 4-21 The Create a new template page
4 Do each of the following:
a) In the Name field, type a name for the template.
b) In the Description field, type a description of the purpose of
the template.
c) In the Template type field, click the down-arrow and select
Report configuration template
5 Click Next.
The Report Configuration Template page opens with a listing of
the report categories already configured in your ActivEssentials
configuration.
Note: The Application name is preselected for you, as it is taken from the
application where you started the wizard.
Application Template Management
CDC Factory 7.1
ActivEssentials Administration Guide
4-51
Figure 4-22 The Report Configuration page
6 Select the report categories you need to use in the template.
7 Click Next.
A second Report Configuration page opens with a listing of the
dataset definitions already defined in your ActivEssentials
installation.
Figure 4-23 The second Report Configuration page
8 Do the following:
a) Select the dataset definitions you need to use in the template.
b) If you need the template immediately, ensure the Active
checkbox is selected.
Application Template Management
CDC Factory 7.1
ActivEssentials Administration Guide
4-52
9 Click Next.
The last page of the wizard opens.
10 Check the summary and then click Finish.
An entry for the new template appears in the grid.
Importing an Application
Use the instructions below to import an application. Applications are
containers for groupings of templates, so an import of an application
really deals with the import process for the templates.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, open the Plant Management module within
MI Admin. See Opening the Plant Management Module on page 3-2
for more information.
If necessary, create a new application using the instructions in
Creating an Application on page 4-41 .
Read the information about importing applications in Options When
Importing Applications on page 4-14 and Understanding the
Reimport Options for Existing Applications on page 4-25. This
information has particular reference to Step 5.c.ii, which deals with
the import options.
Procedure
1 Right-click on the ActivApplications item in the Plant Hierarchy
frame and select Import Application.
The Import Application wizard opens.
2 Click Next to move past the welcome page.
Note: Although the wizard title indicates that you are about to import an application, in
practice you import the templates that reside in the application.
Application Template Management
CDC Factory 7.1
ActivEssentials Administration Guide
4-53
Figure 4-24 The Import Application Templates page
3 Do the following:
a) In the Source application name field, click the down-arrow
and select the application that contains the templates.
b) In the Target application name field, click the down-arrow
and select the application where you intend to place the
templates.
This is a list of the applications created in MI Admin.
4 In the Application templates section, do one of the following:
a) If you intend to use all of the templates in the application,
select the All templates option.
You can check to see what templates the application contains
by clicking the View button.
b) If you do not need all of the templates, choose the Selected
templates option and click the Select button. When the
Application templates dialog box opens, select the
checkboxes for the templates you need to use and click OK.
Note: The Source application name listing includes just those applications that were
installed with that ActivApplication.
Application Template Management
CDC Factory 7.1
ActivEssentials Administration Guide
4-54
Figure 4-25 The Application Templates dialog box
5 For the Import options, do the following:
a) If all of the templates you are importing are being imported for
the first time, go to Step 6.
b) In the Import options field, click the down-arrow and select
the option that best suits your needs.
c) Do the following:
If you are prepared to accept the default options, go to Step
6.
If you need to control how the import process proceeds,
click the View/Edit button.
A dialog box opens with many options on several tabs. The
default options should work on most occasions. If you need
to make changes, read the information on the various tabs
to understand what each of the options does.
When finished, click OK.
6 For the Use existing OPC Server option, do one of the following:
a) If you have not selected an OPC server to use with the
template, ensure that the checkbox is cleared and go to Step 7.
Note: The Import options have no effect during an initial import.
Note: Remember that if you are importing several templates, each of which has been
imported before, the options that you select apply to all. If you need to treat the
templates differently, you must import them individually.
Application Template Management
CDC Factory 7.1
ActivEssentials Administration Guide
4-55
b) If you know the OPC server to use with template(s), ensure
that the checkbox is selected, and then click the down-arrow to
select the OPC server to use.
The OPC server listing also includes any existing RTLE
instances. Choose the correct RTLE instance if the template
requires that the raw data from the OPC server be processed
first.
7 Click Next. The Import template schedule page opens.
Figure 4-26 The Import template schedule page
8 Do one of the following:
a) If you need the import process to start immediately, select the
Run immediately option. This is the default option.
b) If you need to run the import process according to a schedule,
select the Schedule at option and then specify a date and
time.
9 Click Next.
The final page of the wizard opens.
10 Check the summary and then click Finish.
Note: If you use the Schedule at option, you need to allow sufficient time for the
validation process to complete. You should set a time that is at least five
minutes beyond the time you complete the wizard.
Note: After you start the import process, you can watch the progress in the status
column if you refresh the page.
Application Template Management
CDC Factory 7.1
ActivEssentials Administration Guide
4-56
Exporting an Application
Use the instructions below to export an application. When you export
an application, you can choose the templates to include. Once
exported, the application is stored in the database for later use.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, open the Plant Management module within
MI Admin. See Opening the Plant Management Module on page 3-2
for more information.
If necessary, create a new application using the instructions in
Creating an Application on page 4-41.
Procedure
1 Expand the tree under the ActivApplications item in the Plant
Hierarchy frame.
The applications level of the tree opens.
2 Right-click on the application you need to export and select Export
Application.
Figure 4-27 The Export Application Templates dialog box
Warning! If you are exporting a previously imported template, make sure that you do
not export it back to the database from which it was imported. If you do, the
template information might become corrupt.
Application Template Management
CDC Factory 7.1
ActivEssentials Administration Guide
4-57
3 Do one of the following:
a) If you need to export all of the templates with the application,
be sure to select the All active templates option.
If you click View you can see what templates exist in the appli-
cation.
b) If you need to pick specific templates to include, choose the
Selected templates option and then click the Select button.
When the Application templates dialog box opens, select the
templates you need and click OK.
4 On the Export Application Templates dialog box, click OK.
A progress bar window opens to show you the export progress, and
automatically closes when the export completes.
Creating a Workbook From an Application
Use the instructions below to create a workbook. When you create a
workbook, you export an XML formatted file that contains
configuration from the application. As a part of the export process, you
need to indicate which templates to include.
Prerequisites
Before doing this you need to have done or read the following:
Opened the Plant Management module within MI Admin. See
Opening the Plant Management Module on page 3-2 for more
information.
Created an application using the instructions in Creating an
Application on page 4-41.
Procedure
1 Expand the tree under the ActivApplications item in the Plant
Hierarchy frame.
The applications level of the tree opens.
2 Right-click on the application to which you need to add a template
and select Create Workbook.
Note: The workbook exports the current configuration of your plant, including assets
and OPC servers or RTLE servers used for data collection. The application
side of the workbook describes the default RTLE and OPC references, which
you must later replace with the actual OPC items or RTLE device names.
Application Template Management
CDC Factory 7.1
ActivEssentials Administration Guide
4-58
Figure 4-28 The Export Application Templates dialog box
3 Do one of the following:
a) If you need to include all of the templates with the application,
ensure that the All active templates option is selected.
If you click View you can see what templates exist in the appli-
cation.
b) If you need to pick specific templates to include, choose the
Selected templates option and then click the Select button.
4 On the Create Application Templates Workbook dialog box,
click OK.
When the workbook is created, Excel opens the workbook.
5 Save the file in .xml format to a convenient location.
Specifying User-Defined Import Options at
the Global Level
Use the instructions below to specify a customized set of options to
use when importing an application. You can do this to create a new set
of options or to edit a previously defined set. These options apply only
in situations where you are reimporting an application.
In the general way, when reimporting you can choose between using
one of several predefined option sets, each with a specific theme, or
you can customize the options to your needs. However, if you
anticipate having to continually deviate from the predefined option
sets, you can define your own.
Application Template Management
CDC Factory 7.1
ActivEssentials Administration Guide
4-59
Prerequisites
Before doing this you need to have done or read the following:
Opened the Plant Management module within MI Admin. See
Opening the Plant Management Module on page 3-2 for more
information.
Created an application using the instructions in Creating an
Application on page 4-41.
Read Options When Importing Applications on page 4-14 for an
understanding of what each of the options control.
Procedure
1 Select the ActivApplications item in the Plant Hierarchy frame.
A listing of the existing applications opens in the grid.
2 In the grid, right-click on the application where you need to define
the import option and select Properties.
The properties dialog box for the application opens.
3 Click the Options tab.
The tab opens with a listing of the import options schemes that
already exist.
4 Do one of the following:
a) If you need to edit an existing scheme, on its row, select the
cell in the View/Edit column, and then click the ellipsis button
that appears.
b) If you need to create a new scheme, click the Add button
below the grid.
Application Template Management
CDC Factory 7.1
ActivEssentials Administration Guide
4-60
Figure 4-29 The Import Options dialog box
5 On each of the tabs, select the options you need.
6 When finished, click either the Save button or Save As button.
A dialog box opens where you can define a name for the scheme
and provide a description of its purpose.
Note: The controls on this dialog box are the same as that you would use if you were
about to import/reimport an application, except that you can save the options
for later use.
Note: While you can edit the options provided with the system (System Default,
Synchronize All, etc.), you cannot Save your changes; you must use the
Save As option to create a new scheme. Furthermore, there is no option to
edit the User Defined Options, as this functions only as a way of repeating the
options chosen during the last reimport.
Application Template Management
CDC Factory 7.1
ActivEssentials Administration Guide
4-61
Figure 4-30 Providing details for a new scheme
7 When finished, click OK.
The dialog box closes and the new scheme appears in the
properties dialog box.
8 If necessary, change the default scheme by selecting the
appropriate checkbox in the Default column.
9 Click OK.
Specifying User-Defined Import Options
for a Template Asset
Use the instructions below to specify a customized set of options to
use when reimporting an application at a template asset. You can do
this to create a new set of options or to edit a previously defined
options set. These options apply only in situations where you are
reimporting an application.
In the general way, when reimporting you can choose between using
one of several predefined option sets, each with a specific theme, or
you can customize the options to your needs. However, if you
anticipate having to continually deviate from the predefined option
sets, you can define your own.
Prerequisites
Before doing this you need to have done or read the following:
Opened the Plant Management module within MI Admin. See
Opening the Plant Management Module on page 3-2 for more
information.
Created an application using the instructions in Creating an
Application on page 4-41.
Read Options for Applying a Template to An Asset on page 4-28 for
an understanding of what each of the options control.
Procedure
1 Expand the ActivApplications item in the Plant Hierarchy
frame.
The existing applications appear in the tree.
Application Template Management
CDC Factory 7.1
ActivEssentials Administration Guide
4-62
2 Select the application that you need to reimport.
The application templates appear in the grid.
3 Right-click on the asset template and select Properties.
The properties dialog box for the application opens.
4 Click the Options tab.
The tab opens with a listing of the import options schemes that
already exist.
5 Do one of the following:
a) If you need to edit an existing scheme, on its row, select the
cell in the View/Edit column, and then click the ellipsis button
that appears.
b) If you need to create a new scheme, click the Add button
below the grid.
Figure 4-31 The Import Options dialog box
6 On each of the tabs, select the options you need.
7 When finished, click either the Save button or Save As button.
Note: The controls on this dialog box are the same as that you would use if you were
about to import/reimport an application, except that you can save the options
for later use.
Application Template Management
CDC Factory 7.1
ActivEssentials Administration Guide
4-63
A dialog box opens where you can define a name for the scheme
and provide a description of its purpose.
Figure 4-32 Providing details for a new scheme
8 When finished, click OK.
The dialog box closes and the new scheme appears in the
properties dialog box.
9 If necessary, change the default scheme by selecting the
appropriate checkbox in the Default column.
10 Click OK.
Providing Context in a Workbook
After creating a workbook you must update the workbook so that the
default RTLE device names and OPC items are replaced with those that
point to where the data is really collected, from the assets. Before the
workbook is processed, you can define this change in configuration.
A workbook consists of two sheets: one that describes the assets in
the current configuration and the other that describes how to handle
the assets; that is, whether they are added, detached, or removed
from the template configuration.
Note: While you can edit the options provided with the system (System Default,
Synchronize All, etc.), you cannot Save your changes; you must use the
Save As option to create a new scheme. Furthermore, there is no option to
edit the User Defined Options, as this functions only as a way of repeating the
options chosen during the last reimport.
Application Template Management
CDC Factory 7.1
ActivEssentials Administration Guide
4-64
Asset Sheet
When created, the workbook contains a listing of all the assets in the
plant, using their full path name and NodeID. Users can also add new
assets to the configuration by adding them to the list of assets by
using their full path name. The following describes the columns that
appear on the sheet.
AssetFullPathName. This defines the assets that shall be
processed in the workbook, and can include new assets.
NodeID. This is the database identifier for the asset. If creating
new assets, this is created during the process. You cannot edit
entries in this column.
RTLEServerName. Shows the RTLE server, if used, which acts as
the OPC server.
RTLEDeviceName. Shows the device the RTLE server uses as a
data source.
OPCItemReplaceValue. This is a sample OPC item replace value
for the search pattern
Template Sheet
The template sheet contains the processing actions to properly apply
the template. The sheet contains a number of columns which depend
on the content of the template:
AssetFullPathName. This column is a duplicated listing of the
assets that appeared on the Asset sheet.
NodeID. This column is a duplicated listing of the asset identifiers
from the Asset sheet. You cannot edit entries in this column.
RTLEServerName. This lists the RTLE server used to collect data
from the asset. If an RTLE is not used with an asset, the cell in the
column is blank.
Device(DeviceName). This lists the replace values for a device
parameter. If more than one parameter is defined in the template,
there is a column for each. If the parameter contains a default
value, this value appears in the column.
OPCItem(OPCItemSearchPattern). This defines the replace
value for an OPC Item parameter, if the template has OPCItem
parameters. If the template contains more than one parameter,
there is a column for each. If the parameter contains a default
value, this value appears in the column.
AccessPath(AccessPath). This defines the replace value for the
OPC AccessPath parameter, if the template contains parameters of
this type. If the template contains more than one parameter, there
is a column for each. If the parameter contains a default value, this
value appears in the column.
Note: If an asset template uses an RTLE server, it cannot have an AccessPath
parameter, whereas if the template does not use an RTLE server, it can not
have a Device parameter.
Application Template Management
CDC Factory 7.1
ActivEssentials Administration Guide
4-65
If you are using a template for an asset, you need to replace the
replace value in the column header. You also need to provide a value
in the Action column. The actions are as follows:
Blank. If you leave the cell blank, no action is taken.
A. This means that the template will be applied to the asset.
D. This means that the template is detached from the asset. The
configuration applied by the template is retained, as is any
historical data.
R. This means that the configuration that was originally applied to
the asset is removed, as is any historical data that relates to the
template configuration. Use this option with caution.
Processing a Workbook
Use the instructions below to process a workbook. Workbooks provide
a way of quickly distributing configuration across an ActivEssentials
installation. You can use a workbook to apply asset templates to many
assets, and detach or remove templates. You can also use workbooks
to build assets and groups.
Prerequisites
Before doing this you should do or read the following:
If necessary, open the Plant Management module within
MI Admin. See Opening the Plant Management Module on page 3-2
for more information.
Read Options for Applying a Template to An Asset on page 4-28 for
an understanding of the template options. This has particular
reference to the Step 9.d in the following.
Procedure
1 On the toolbar, click the Process Workbook button.
The Process Workbook wizard opens.
2 Click Next to move past the Welcome page.
Application Template Management
CDC Factory 7.1
ActivEssentials Administration Guide
4-66
Figure 4-33 The Process Workbook page
3 Click Browse.
The Choose file dialog box opens.
4 Browse to and select the workbook file.
Workbooks that contain application configuration have an .xml
extension.
5 Click Open.
The path to the file appears in the Workbook name field.
6 Click Upload.
The page refreshes to show options for the upload.
Figure 4-34 The refreshed version of the Process Workbook page
Application Template Management
CDC Factory 7.1
ActivEssentials Administration Guide
4-67
7 Under the Application templates section, do one of the following:
a) If you need all of the templates, select the All active
templates option, and go to Step 8.
If you need to see a list of the templates, click the View but-
ton.
b) If you need to select particular templates, choose the Selected
templates option and click the Select button.
Figure 4-35 The Application templates dialog box
Select the checkboxes next to the templates names you
need.
Click OK.
8 Click Next.
Figure 4-36 The Processing Workbook Actions page
Application Template Management
CDC Factory 7.1
ActivEssentials Administration Guide
4-68
9 Select the Apply template checkbox and do the following:
a) If you need the complete configuration, select the Include
complete option, and go to Step 9.c
If you need to see what the configuration includes, click Scope.
b) If you need to limit the configuration, clear the checkbox and
click Scope.
Figure 4-37 The Data Items and Web Views dialog box
If necessary, clear the checkboxes for the items you do not
need.
Click OK.
c) If you need all of the template options, select the Include
default option and go to Step 9.e.
d) If you need to edit the template options, clear the Include
default option and click the Options button.
A dialog box opens with several tab and many options.
Note: All items are preselected, but you might find that some are disabled. This is
because these items are essential to the operation of the template.
Note: If you have not read Options for Applying a Template to An Asset on page 4-28,
do so now.
Application Template Management
CDC Factory 7.1
ActivEssentials Administration Guide
4-69
Review the options on the tabs, and clear or select the
checkboxes as needed.
In practice, the default selections on the tabs should work
for most occasions.
When finished, click OK.
e) In the Applied asset protection setting section, click the
down-arrow and select the protection setting to set limits on
how users can modify the asset configuration, as follows:
No modification allowed.
Add items only.
Add items and modify the unprotected properties.
Add and modify any items.
Add, modify, and delete any items.
10 Click Next. The Process Workbook Schedule page opens.
Figure 4-38 The Process Workbook Schedule page
11 Do one of the following:
a) If you need the import process to start immediately, select the
Run immediately option.
b) If you need to run the import process according to a schedule,
select the Schedule at option and then specify a date and
time.
12 Click Finish.
Note: If you use the Schedule at option, you need to allow sufficient time for the
validation process to complete. You should set a time of at least five minutes
beyond the time you complete the wizard.
Application Template Management
CDC Factory 7.1
ActivEssentials Administration Guide
4-70
Applying a Template to an Asset
Use the instructions below to apply a template to an asset. You can
apply a template to an asset in two ways:
You can select an asset and then select a template you want to
apply, or
Select a template and then select the asset to which it should be
applied.
Both options are available in the Plant Management module.
Prerequisites
Before doing this, you should do or read the following:
If necessary, open the Plant Management module within
MI Admin. See Opening the Plant Management Module on page 3-2
for more information.
During the process of applying a template, you need to apply
template parameters. To assist with an understanding of this part
of the process, read on page 4-9.
If necessary, create a new application using the instructions in
Creating an Application on page 4-41.
If necessary, create a template using the instructions in one of the
following:
Creating a New Asset Template on page 4-42
Creating a New Shift Configuration Template on page 4-48
Creating a New Report Configuration Template on page 4-49
Read Options for Applying a Template to An Asset on page 4-28
and Understanding the Reimport Options for Template Asset
Configuration on page 4-35 for an understanding of the options
when applying a template to an asset.
Procedure
1 Expand the tree under the ActivApplications item in the Plant
Hierarchy frame.
The applications level of the tree opens.
2 Select the application that contains the template you need to apply.
The grid displays the templates that belong to the application.
3 In the grid, right-click on the template you need to apply and select
Apply Template.
A wizard opens where you can start the process.
Note: You can watch the processing progress by viewing the grid after selecting the
appropriate template below the ActivApplications item. By occasionally
refreshing the screen, you can see at what stage the process is.
Application Template Management
CDC Factory 7.1
ActivEssentials Administration Guide
4-71
Figure 4-39 The Apply Template to Asset page
4 Click the ellipsis button to the right of the Asset name field.
Figure 4-40 The AppCenter Plant Hierarchy browser
5 Browse to and select the asset that requires the template
configuration, and click OK.
The asset, along with its plant hierarchy path, appear in the Asset
name field.
6 Click Next.
Note: The Application name and the Template name fields are preselected for you,
as these are taken from the point where you initiated the wizard.
Application Template Management
CDC Factory 7.1
ActivEssentials Administration Guide
4-72
Figure 4-41 The Apply Template Parameters page
7 In the Asset RTLE Server field, click the down-arrow to select the
server name that hosts the RTLE instance that handles data from
the asset.
8 Do the following, as needed:
a) If you need to complete any OPC Item Name Space rows,
double-click in the empty Value cell and add the plant
hierarchy path down to the parent group of the asset.
b) If you need to complete any RTLE Item Device Name rows,
click in the empty Value cell. Then click the down-arrow that
appears to select the RTLE instance that should collect data
from the asset.
This is the name of the OPC server that feeds data to the RTLE
instance.
9 Click Next.
Application Template Management
CDC Factory 7.1
ActivEssentials Administration Guide
4-73
Figure 4-42 The Apply Template Configuration page
10 In the Scope Definition section, do one of the following:
a) If you need to apply the complete template configuration,
select the Include complete template configuration
checkbox and go to Step 11.
b) If you need to modify the scope of the template configuration,
clear the Include complete template configuration
checkbox and click Scope.
Application Template Management
CDC Factory 7.1
ActivEssentials Administration Guide
4-74
Figure 4-43 The Data Items and Web Views editor
In the Data Items section, select or clear, as needed, the
checkboxes for the various entries.
Many of the options in the Data Items section could be
disabled. This is because these items are either essential to
the operation of the template, or were not needed in the
template. In practice you should leave these as they are.
In the Web Views section, select or clear, as needed, the
checkboxes for the various entries.
Unless you know that the template does not require any
VPWeb views in one or other of the options, you should
leave these as they are.
Click OK.
11 In the Options Definition section, do the following as needed:
a) If you are importing the template for the first time, the
template options have no effect, so go to Step 12.
b) If you are applying the template for a second or subsequent
time, do one of the following:
Click the down-arrow adjacent to the Apply options field
and select the reapply scheme you need.
For more information, see Options for Applying a Template to An Asset
on page 4-28 and Understanding the Reimport Options for Template
Asset Configuration on page 4-35.
Note: The predefined Apply options follow schemes that work within a range where
there is an aggressive reapplication of the template through to a full honoring of
any user changes. If these options do not meet your needs, you can edit the
options.
Application Template Management
CDC Factory 7.1
ActivEssentials Administration Guide
4-75
If you need to change the options when applying the
template, click the View/Edit button.
An editor windows opens with many options on several tabs.
12 In the Template Protection Definition section, click the
down-arrow beside the Applied template status field, and select
the protection status you need to apply.
13 Click Next.
The Apply Template Schedule page opens.
14 Do one of the following:
a) If you need the template application process to start
immediately, select the Run immediately option.
This is the default option.
b) If you need to run the template application process according
to a schedule, select the Schedule at option and then specify a
date and time.
15 Click Finish.
Validating a Template
Use the instructions below to validate a template.
Prerequisites
Before doing this you might need to do the following:
If necessary, open the Plant Management module within
MI Admin. See Opening the Plant Management Module on page 3-2
for more information.
If necessary, create a new application to contain the template
using the instructions in Creating an Application on page 4-41.
Note: Read the information on the various tabs to understand what each of the
options does.
Note: The status options provide a broad scope of control, ranging from open access
to no access to the configuration.
Note: If you use the Schedule at option, the run time must occur at least five
minutes after you complete the wizard to allow the validation process to
complete.
Application Template Management
CDC Factory 7.1
ActivEssentials Administration Guide
4-76
Procedure
1 Expand the tree below the ActivApplications item and select an
application.
The templates for that application display in the grid.
2 Right-click on the template you need to validate and select
Validate Template.
A window opens with the result of the query.
Figure 4-44 Examples of the results from validation queries
3 When finished viewing the results, click OK.
Note: The validation results show whether the template could be activated or not, as
it could highlight serious errors, warnings, and other information. If there are
errors, the template cannot be activated. If there are warnings, the template
might still activate but the configuration may not be what you expect.
Application Template Management
CDC Factory 7.1
ActivEssentials Administration Guide
4-77
Maintaining your Configuration Templates
The Plant Management module is where you can manage the use of
templates in your ActivEssentials installation. At the asset level in the
plant hierarchy, you can manage how any templates have been applied
to specific assets.
This section covers the following topics:
Detaching a Template from Assets on page 4-77
Removing a Template from Assets on page 4-79
Changing Template Removal Options on page 4-82
Resynchronizing Asset Configuration with a Template on page 4-84
Exporting your ActivEssentials Configuration on page 4-88
Setting Configuration File Transfer Size on page 4-90
Viewing a Template Definition Report on page 4-90
Viewing a template usage report on page 4-91
Viewing a configuration report on page 4-93
Detaching a Template from Assets
Use the instructions below to detach a template. Detaching a template
breaks the link between the template and assets. The configuration
that was applied to the assets remains as does any associated
historical data.
You can start this procedure from three different locations in the Plant
Management module:
By browsing to and selecting an asset in the Plant Hierarchy and
right-clicking on the template reference in the grid, or
By right-clicking on an asset inside the template, or
By right-clicking on a template item in the ActivApplications tree.
The following procedure detaches a template from the ActivApplication
tree, as this method allows you to select all or any of the assets where
the template is used.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, open the Plant Management module within
MI Admin. See Opening the Plant Management Module on page 3-2
for more information.
Application Template Management
CDC Factory 7.1
ActivEssentials Administration Guide
4-78
Procedure
1 Expand the tree under the ActivApplications item in the Plant
Hierarchy frame.
The applications level of the tree opens.
2 Select the application that contains the template you need to
detach.
The application templates display in the grid.
3 In the grid, right-click on the template you need to detach and
select Detach Template.
Figure 4-45 The Detach Template page
4 Do one of the following
a) If you need to detach the template from all the assets where it
is used, choose the All applied assets option and go to Step
5.
To see the assets to which the template is applied, click View.
b) If you need to detach the template from specific assets, choose
the Selected assets option and then click the Select button.
Application Template Management
CDC Factory 7.1
ActivEssentials Administration Guide
4-79
Figure 4-46 Asset selection dialog box
Browse to and select the assets from which you need to
detach the template.
Click OK.
5 Click Finish.
Removing a Template from Assets
Use the instructions below to remove a template. When you remove a
template, you also remove any associated historical data, but the
template remains available for reapplication. During the removal
process, you can choose to remove a template from all of the assets
where it was applied, or pick the specific assets from which it should
be removed.
You can start this procedure from three different locations in the Plant
Management module:
By browsing to and selecting an asset in the Plant Hierarchy and
right-clicking on the template reference in the grid, or
By right-clicking on an asset inside the template, or
By right-clicking on a template item in the ActivApplications tree.
The following procedure removes a template from the ActivApplication
tree, as this method allows you to select all or any of the assets where
the template is used.
Application Template Management
CDC Factory 7.1
ActivEssentials Administration Guide
4-80
Prerequisites
Before doing this you need to have done or read the following:
If necessary, open the Plant Management module within
MI Admin. See Opening the Plant Management Module on page 3-2
for more information.
Read Options When Removing a Template From an Asset on page
4-38 for an understanding of the options when removing a
template from an asset.
Procedure
1 Expand the tree under the ActivApplications item in the Plant
Hierarchy frame.
The applications level of the tree opens.
2 Select the application that contains the template you need to
remove.
The application templates display in the grid.
3 In the grid, right-click on the template you need to remove and
select Remove Template.
Figure 4-47 The Remove Template page
4 Do one of the following
a) If you need to remove the template from all the assets where it
is used, choose the All applied assets option and go to Step
5.
To see the assets to which the template is applied, click View.
b) If you need to remove the template from specific assets,
choose the Selected assets option and then click Select.
Application Template Management
CDC Factory 7.1
ActivEssentials Administration Guide
4-81
Figure 4-48 The Asset Selection dialog box
Browse to and select the assets from which you need to
remove the template.
Click OK.
5 In the Remove options section, select the Options tab.
An editor opens where you can control what is removed.
Figure 4-49 The options when removing a template
Application Template Management
CDC Factory 7.1
ActivEssentials Administration Guide
4-82
6 In the editor, review the default selections to see if they fit your
needs, and then select or clear the checkboxes as required.
7 Click Next.
The Remove Template Schedule page opens, where you can set
a schedule for removing the template.
Figure 4-50 The Remove Template Schedule page
8 Do one of the following:
a) If you need to remove the template as soon as possible, select
the Run immediately option and go to Step 9.
b) If you need to remove the template at a later time, select the
Schedule at option and then specify a date and time.
9 Click Finish.
Changing Template Removal Options
Use the instructions below to revise the options for removing the
template. This may include template items, or the scheduled removal
time. Note that this can only be done if the scheduled removal has not
yet taken place.
Note: If you have not yet read Options When Removing a Template From an Asset
on page 4-38 , do so now.
Note: If you are specifying a later date and time, the run time must occur at least five
minutes after you complete the wizard to allow for the validation process to
complete.
Application Template Management
CDC Factory 7.1
ActivEssentials Administration Guide
4-83
Prerequisites
If necessary, open the Plant Management module within
MI Admin. See Opening the Plant Management Module on page 3-2
for more information.
Read Options When Removing a Template From an Asset on page
4-38 for an understanding of the options when removing a
template from an asset.
Procedure
1 Expand the tree under the ActivApplications item in the Plant
Hierarchy frame.
The applications level of the tree opens.
2 Select the application that contains the template you need to
remove.
The application templates display in the grid.
3 Right-click on the template in the grid and select Properties.
A properties dialog box opens.
4 Click the Settings tab.
The Settings page opens.
Figure 4-51 The Settings tab
5 Click the Options button.
The Template removal options page displays the options you
chose to remove.
6 Clear or select the checkboxes to revise the template removal
options.
Application Template Management
CDC Factory 7.1
ActivEssentials Administration Guide
4-84
7 If you need to change the scheduled removal time, click the
Schedule tab and use the up- or down-arrows to change the
scheduled time.
8 Click OK, and then OK again to close the Properties dialog box.
Resynchronizing Asset Configuration with
a Template
Use the instructions below to resynchronize asset configuration with a
template. You might need to do this if you have made changes to the
asset configuration(s), and now need to restore the configuration to
match the template, or if you have made changes to the template and
now need to distribute the changes. When you resynchronize, you can
control synchronization parameters.
You can start this procedure from three different locations in the Plant
Management module:
By right-clicking on an asset in the Plant Hierarchy, or
By right-clicking on an asset in the grid below the template, or
By right-clicking on a template item in the ActivApplications tree.
The following procedure deals with resynchronizing a template from
the ActivApplication tree, as this method allows you to select all or
some of the assets where the template is used.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, open the Plant Management module within
MI Admin. See Opening the Plant Management Module on page 3-2
for more information.
Read Options for Applying a Template to An Asset on page 4-28
and Understanding the Reimport Options for Template Asset
Configuration on page 4-35 for an understanding of the options
when resynchronizing a template to an asset.
Procedure
1 Expand the tree under the ActivApplications item in the Plant
Hierarchy frame.
The applications level of the tree opens.
2 Expand the application that contains the template you need to
resynchronize.
3 Right-click on the template and select Resynchronize Template.
Application Template Management
CDC Factory 7.1
ActivEssentials Administration Guide
4-85
Figure 4-52 The Resynchronize Template page
4 Do one of the following:
a) To resynchronize all assets that use the template configuration,
select the All applied assets option, and go to Step 5.
If you need to confirm what assets are involved, click View.
b) If you need to specify which assets need resynchronizing,
choose the Select assets option and then click the Select
button.
The Asset Selection dialog box opens.
Figure 4-53 The Asset Selection dialog box
Expand the tree to find the assets that need
resynchronizing.
Select the checkboxes beside the asset names and click OK.
Application Template Management
CDC Factory 7.1
ActivEssentials Administration Guide
4-86
5 Click Next.
Figure 4-54 The Apply Template Configuration page
6 In the Scope Definition section, do one of the following:
a) If you need to apply the complete template configuration,
select the Include complete template configuration
checkbox and go to Step 7.
b) If you need to modify the scope of the template configuration,
clear the Include complete template configuration
checkbox and click the Scope button.
Application Template Management
CDC Factory 7.1
ActivEssentials Administration Guide
4-87
Figure 4-55 The Data Items and Web Views editor
In the Data Items section, select or clear, as needed, the
checkboxes for the various entries.
Many of the options in the Data Items section could be
disabled. This is because these items are either essential to
the operation of the template, or were not needed in the
template. In practice you should leave these as they are.
In the Web Views section, select or clear, as needed, the
checkboxes for the various entries.
Unless you know that the template does not require any
VPWeb views in one or other of the options, you should
leave these as they are.
Click OK.
7 In the Options Definition section, do the following as needed:
a) If you are importing the template for the first time, the
template options have no effect, so go to Step 8.
b) If you are applying the template for a second or subsequent
time, do one of the following:
Click the down-arrow adjacent to the Apply options field
and select the reapply scheme you need.
For more information, see Options for Applying a Template to An Asset
on page 4-28 and Understanding the Reimport Options for Template
Asset Configuration on page 4-35.
Note: The predefined Apply options follow schemes that work within a range where
there is an aggressive reapplication of the template through to a full honoring of
any user changes. If these options do not meet your needs, you can edit the
options.
Application Template Management
CDC Factory 7.1
ActivEssentials Administration Guide
4-88
If you need to change the options when applying the
template, click View/Edit.
An editor windows opens with many options on several tabs.
8 In the Template Protection Definition section, click the
down-arrow to the right of the Applied template status field, and
select the protection status you need to apply.
9 Click Next.
The Apply Template Schedule page opens.
10 Do one of the following:
a) If you need the template application process to start
immediately, select the Run immediately option.
This is the default option.
b) If you need to run the template application process according
to a schedule, select the Schedule at option and then specify a
date and time.
11 Click Finish.
Exporting your ActivEssentials
Configuration
Use the instructions below to export the configuration in your
ActivEssentials installation. The export function includes the option to
export sample data, which you can use to test database upgrades
before upgrading. This process is not meant as a database backup, as
you are limited to exporting data representing a span of about four
weeks.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, open the Plant Management module within
MI Admin. See Opening the Plant Management Module on page 3-2
for more information.
Note: Read the information on the various tabs to understand what each of the
options does.
Note: The status options provide a broad scope of control, ranging from open access
to no access to the configuration as applied by the template.
Note: If you use the Schedule at option, the run time must occur at least five
minutes after you complete the wizard to allow the validation process to
complete.
Application Template Management
CDC Factory 7.1
ActivEssentials Administration Guide
4-89
Procedure
1 In the Plant Hierarchy frame, right-click on the plant icon and
select Export AP Configuration.
The Export Activplant Configurations dialog box opens.
2 Do one of the following:
a) If you need only the configuration, select the Without sample
data option and go to Step 3.
b) If you need to export the configuration with data, select the
With sample data option and do the following:
Select the categories of data you need with the exported
configuration.
In the Start time and End time fields define a span of time
for the data by clicking the ellipsis buttons and specifying
appropriate dates.
3 Click OK.
Figure 4-56 The Export Progress window
4 Do one of the following:
a) If you are notified of the file location, then click OK to close the
window.
b) If you are prompted to open or save the file, then select Open
or Save.
Saved files are in .zip format.
Note: Depending on your system settings, the file is either saved on the Database
Server or is transferred to the computer where you are working so you can
save it there. When the process is complete, a message either indicates the file
location or prompts you to open or save the file.
Application Template Management
CDC Factory 7.1
ActivEssentials Administration Guide
4-90
Setting Configuration File Transfer Size
Use the instructions below to set a size for transferring application
configuration templates and configuration files. By default, this is set
to 50 MB in the System Settings module of MI Admin.
Prerequisites
Before doing this you need to have done or read the following:
Open the System Settings module using the instructions in
Opening the System Settings Module on page 2-2.
Procedure
1 In the secondary frame of the System Settings module, click the
System Properties icon.
The grid displays the system properties for your ActivEssentials
installation.
2 Locate the Max Size of Application Configuration File system
setting.
The default setting is 50 MB.
3 Double-click in the Value column to change the maximum size of
the file.
If you change this value to 0, then you will always be prompted to
open or save the file.
Viewing a Template Definition Report
Use the instructions below to view a template definition report. These
reports are available for asset templates, report configuration
templates, and shift configuration templates.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, open the Plant Management module within
MI Admin. See Opening the Plant Management Module on page 3-2
for more information.
Procedure
1 Expand the tree under the ActivApplications item in the Plant
Hierarchy frame.
The applications level of the tree opens.
2 Expand the tree under the application that contains the template
whose definition report you need to view.
3 Right-click on the template and select View Template Definition.
Note: If you choose to increase the amount allowed, then ensure that you have
enough network resources to support the file transfer; if the setting is too high,
the process might fail.
Application Template Management
CDC Factory 7.1
ActivEssentials Administration Guide
4-91
Depending on the type of template you chose, the Asset Template
Report Parameters dialog box, or the Shift Schedule
Configuration Template dialog box could open, or the report could
open directly.
Figure 4-57 The Asset Template Report Parameters dialog box
4 If Asset Template Report Parameters dialog box opens, and
you do not need the report to include specific parameters, then
click the cells in the Value column and change the value to False.
5 When done, click OK.
The Reporting Service then prepares the report and it opens in a
new window.
Viewing a template usage report
Use the instructions below to view a report that shows how and where
the template has been used.
Note: By default, the report includes all of the parameters. However, you can limit the
scope of the report.
Application Template Management
CDC Factory 7.1
ActivEssentials Administration Guide
4-92
Prerequisites
Before doing this you need to have done or read the following:
If necessary, open the Plant Management module within
MI Admin. See Opening the Plant Management Module on page 3-2
for more information.
Procedure
1 Expand the tree under the ActivApplications item in the Plant
Hierarchy frame, and then expand the application that contains
the template whose usage report you need to view.
2 Select the template.
The assets to which the template has been applied appear in the
grid.
3 In the grid, right-click on the entry for the asset you need and
select Template Usage Report.
The Template Usage Report Parameters dialog box opens with
all report parameters selected.
Figure 4-58 The Template Usage Report Parameters dialog box
4 If you do not need the report to include specific parameters, click in
the cells in the Value column and change the value to False.
5 When done, click OK.
The report opens in a new window.
Application Template Management
CDC Factory 7.1
ActivEssentials Administration Guide
4-93
Viewing a configuration report
Use the instructions below to view a configuration details for a specific
asset.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, open the Plant Management module within
MI Admin. See Opening the Plant Management Module on page 3-2
for more information.
Procedure
1 In the Plant Hierarchy frame, browse to and find the asset where
you need the configuration report.
2 Right-click on the asset and select Configuration Report.
The Asset Configuration Report Parameters dialog box opens
with all report parameters selected.
Figure 4-59 The Asset Configuration Report Parameters dialog box
3 If you do not need the report to include specific parameters, click in
the cells in the Value column and change the value to False.
4 When done, click OK.
The Reporting Service prepares the report, which then opens in a
new window.
Editing and viewing application properties
Use the instructions below to view application properties.
Application Template Management
CDC Factory 7.1
ActivEssentials Administration Guide
4-94
Prerequisites
Before doing this you need to have done or read the following:
If necessary, open the Plant Management module within
MI Admin. See Opening the Plant Management Module on page 3-2
for more information.
Read Understanding the Reimport Options for Existing Applications
on page 4-25 and Options When Importing Applications on page
4-14 for an understanding of how the application Import Options
work.
Procedure
1 In the Plant Hierarchy frame, browse down to and select the
ActivApplications item.
The applications that exist in the configuration appear in the grid.
2 In the grid, right-click on the application whose properties you
need to view and select Properties.
Figure 4-60 The General tab of the properties dialog box
3 Click the Options tab.
Note: The information on the General tab is information only.
Application Template Management
CDC Factory 7.1
ActivEssentials Administration Guide
4-95
Figure 4-61 The Options tab
The Options tab opens with a list of the defined import options.
4 Do the following, as needed:
If you need to change the default option, select another in the
Default column.
If you need to edit an option, on its row, click in the View/Edit
column, then click the ellipsis button that appears.
This opens the Import Options dialog box for the application,
where you can edit the many options available on each of the
several tabs. When finished, you can either Save the changes
or Save As to create a new option.
Click the Add button to define a new set of options in the
Import Options dialog box.
If you need to remove a user defined option, select it in the grid
and then click the Remove button.
5 When finished, click OK.
Editing and viewing application template
properties
Use the instructions below to view application template properties.
Note: The listing includes the system-defined and user-defined import options, and
indicates which of the options is the default when applying the application. You
cannot edit the system defined options, but you can use them as the basis for
defining a new option.
Application Template Management
CDC Factory 7.1
ActivEssentials Administration Guide
4-96
Prerequisites
Before doing this you need to have done or read the following:
If necessary, open the Plant Management module within
MI Admin. See Opening the Plant Management Module on page 3-2
for more information.
Read Options for Applying a Template to An Asset on page 4-28
and Understanding the Reimport Options for Template Asset
Configuration on page 4-35 for an understanding of how the
template Import Options work.
Procedure
1 In the Plant Hierarchy frame, browse down to and select the
ActivApplications item.
The applications that exist in the configuration appear in the grid.
2 In the grid, right-click on the application whose properties you
need to view and select Properties.
The Properties dialog box for the application opens.
Figure 4-62 The General tab of the properties dialog box
3 Click the Settings tab.
The Settings tab opens.
Note: The information on the General tab is editable for user created templates, but
information only for ActivApplications.
Application Template Management
CDC Factory 7.1
ActivEssentials Administration Guide
4-97
4 To edit the Template parameters configuration, click the
Parameters button and do the following, as needed:
If you need to add a parameter, do the following:
In the Name column, on the next available row, click in the
cell and then click the down-arrow, and select OPC Item
Name Space from the list.
In the Search Pattern column, double-click in the cell and
type the generic plant hierarchy path you need to use for
the template.
In the Default Value column, double-click in the cell and
type the real path down to the parent group level.
If you intend to apply the template to individual assets,
leave the cell blank since you can use the template with
assets at a variety of locations within the Plant Hierarchy.
If you need to edit a parameter, do the following, as needed, on
each of the rows you need to edit:
In the Name column, click in the cell, click the down-arrow
that appears, and select another OPC Item Name Space
from the list.
In the Search Pattern column, double-click in the cell and
amend the plant hierarchy path.
In the Default Value column, double-click in the cell and
amend the path down to the parent group level.
If you intend to apply the template to individual assets,
leave the cell blank since you can use the template with
assets at a variety of locations within the Plant Hierarchy.
Note: The path must end with a period (.) because if it does not, you run the risk of
ambiguity.
Note: The path must end with a period (.) because if it does not, you run the risk of
ambiguity.
Application Template Management
CDC Factory 7.1
ActivEssentials Administration Guide
4-98
If you need to delete a parameter, select its row and click the
Remove button.
If you need to edit the Template protection setting, click the
down-arrow and select from the following:
No Modifications allowed
Add items only.
Add items and modify the unprotected properties.
Add and modify any items.
Add, modify, and delete any items.
If you need to change the OPC Server name, click the
down-arrow and select another from the list.
If you need to edit the Rollover value, click in the field and
change it to what you need.
5 Click the Options tab.
Figure 4-63 The Options tab
The Options tab opens with a list of the defined import options.
Note: The listing includes the system-defined and user-defined import options, and
indicates which of the options is the default when applying the application. You
cannot edit the system defined options, but you can use them as the basis for
defining a new option.
Application Template Management
CDC Factory 7.1
ActivEssentials Administration Guide
4-99
6 Do the following, as needed:
If you need to change the default option, select another in the
Default column.
If you need to edit an option, on its row, click in the View/Edit
column, then click the ellipsis button that appears.
This opens the Import Options dialog box for the application,
where you can edit the many options available on each of the
several tabs. When finished, you can either Save the changes
or Save As to create a new option.
Click the Add button to define a new set of options in the
Import Options dialog box.
If you need to remove a user defined option, select it in the grid
and then click the Remove button.
7 When finished, click OK.
CDC Factory 7.1
ActivEssentials Administration Guide
5-1
OPC Server Configuration
OPC Server Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
5-2
Introduction to OPC Server Configuration
ActivEssentials can work with any PLC or other device that has an OPC
server. You can use as many different OPC servers as you wish, or
multiple installations of the same server. Install the OPC server(s) on
one or more machines in your data collection system, then register the
OPC server installations in the AppCenter. For information on
installation arrangements, see the System Configuration Guide
(System Configuration Guide.pdf), which is in your ActivEssentials
installation package.
This chapter covers the following topics:
OPC Server Configuration in ActivEssentials on page 5-2
Configuring OPC Servers on page 5-5
OPC Server Configuration in ActivEssentials
In the OPC Server Configuration module of the AppCenter you can
define the OPC servers that are in use anywhere in your data collection
system. You have to identify the OPC server and each machine that
has it installed. You do not at this point need to decide which assets
will use the OPC server.
As a general rule, you should have an OPC server installed on each
machine that hosts VPCollector. For more information on installation
arrangements, see the System Configuration Guide (System
Configuration Guide.pdf) supplied with your ActivEssentials installation
package. For instructions on installing and configuring the OPC server,
see the manufacturers documentation.
This section covers the following topics:
OPC Server Monitoring on page 5-2
What Happens if You Dont Use a Heartbeat Item? on page 5-3
The Reconnection Process on page 5-4
Setting Up a Heartbeat Data Item in the PLC on page 5-4
OPC Server Monitoring
ActivEssentials includes an OPC server monitoring function that allows
automatic reconnection if the OPC server stops for any reason. If
VPCollector does not receive a callback from any of the active data
items within a specified period (the quiet period), it assumes the
OPC server connection is interrupted and attempts to reconnect. (Most
OPC server lock up issues have occurred when using Windows 2000
Server SP3.)
Note: The active data items mentioned above do not include asset states, because
they are not recorded by VPCollector.
OPC Server Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
5-3
You can make best use of this feature by defining a heartbeat data
item in the PLC during your integration process. The advantage of
using a heartbeat item is that there may be periods (for example,
weekends) when in fact no other data item changes during the quiet
period, so the heartbeat item prevents VPCollector trying to reconnect
when it does not need to. The heartbeat item can be a boolean item
that switches from 1 to 0 and back again every 10 seconds or so, or
some other data item that changes frequently.
In AppCenter you then define the quiet period. This is the maximum
period that VPCollector will wait before assuming that the OPC server
is unavailable. The default (and maximum) value is 399 999 999
seconds. The minimum value is 300 seconds.
For information on how to set up a heartbeat item in the PLC, see
Setting Up a Heartbeat Data Item in the PLC on page 5-4.
What Happens if You Dont Use a
Heartbeat Item?
If you do not create a heartbeat item for the OPC server, VPCollector
uses any of the callback type data items defined in ActivEssentials to
monitor OPC server availability. In ActivEssentials all OPC groups are
of the callback type, except for solicited counters and sampled event
variables. The table below shows the types used for each data item
type.
If the production line is in production, data items will probably change
within the quiet period that you set. However, if the line is shut down
for lunch or the weekend it is quite likely that data items will not
change during this period. If you cannot guarantee that at least one
callback data item will change in the PLC within the quiet period, you
should increase the quiet period setting. This will prevent VPCollector
trying to reconnect when it does not need to.
Table 5-1 Data types and update rates for ActivEssentials data items
OPC Group Interface Type Group Update
Rate
VPFoundation: real-time data Callback 1.0 sec.
VPCollector: incidents Callback 1.0 sec.
VPCollector: unsolicited accumulators Callback 1.0 sec.
VPCollector: event sample rates Callback 5.0 sec.
VPCollector: value change event
triggers
Callback 1.0 sec.
VPCollector: value change events,
numeric and alphanumeric variables
Read 1.0 sec.
VPCollector: solicited counters Read 5.0 sec.
VPCollector: identifiers Callback 1.0 sec.
OPC Server Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
5-4
If a heartbeat item is not present, VPCollector will post the following
warning to the event log upon startup: An error occurred while
adding the OPC server status item. Check the items validation.
When reconnecting to the OPC server, VPCollector will delete and then
add again all assets associated with the OPC server.
The Reconnection Process
The reconnection process is as follows:
VPCollector receives no callback from the OPC server.
VPCollector waits for X seconds, where X is the quiet period defined
when you create the OPC server.
VPCollector posts the following message to the VPCollector event
log: There is no call back from OPC server within the
predefined period. VPCollector will reconnect the OPC server.
VPCollector attempts to re-establish the connection. It deletes and
then adds again all assets configured for the OPC Server.
If the reconnection fails, VPCollector tries again every X seconds
until the connection is restored, posting a message each time.
Setting Up a Heartbeat Data Item in the
PLC
Here are some recommendations for setting up a heartbeat data
item in the PLC:
Create the heartbeat item in the PLC. You may want to use a
boolean item that switches between ON and OFF, or some other
data item that changes frequently.
Set the change rate for the data item to between 10 seconds and
one minute.
Create one heartbeat location for each OPC server configured in
ActivEssentials. Configuring this signal ensures that at least one
data item will change at the given rate.
When you register the OPC server in AppCenter, specify the path
and the item ID of the heartbeat item. See Adding an OPC Server
on page 5-5for more information on how to do this.
OPC Server Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
5-5
Configuring OPC Servers
You use the OPC Servers module of AppCenter to add, edit, or delete
OPC servers in your data collection system. Before registering the OPC
servers in the data collection system you must install the OPC server
on each OPC server host machine. When you have done this, you
inform the data collection system of where the OPC server
installations are, and which assets are sending data to each.
This section covers the following topics:
Opening the OPC Server Configuration Module on page 5-5
The OPC Server Configuration Module on page 5-14
Adding an OPC Server on page 5-5
Deleting an OPC Server on page 5-8
Viewing and Editing OPC Server Properties on page 5-9
Testing the OPC Server Connection on page 5-11
Assigning an OPC Server to a Group or Asset on page 5-12
Changing the OPC Server Used by a Group or Asset on page 5-13
Opening the OPC Server Configuration
Module
Use the instructions below to open the OPC Server Configuration
module of AppCenter. In this module you can register OPC servers and
assign them to assets.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
Read The OPC Server Configuration Module on page 5-14.
Procedure
1 In the taskbar, click the System category icon.
The taskbar refreshes to display icons for the task modules in the
System category.
2 In the taskbar, click the OPC Server Configuration icon.
Adding an OPC Server
Use the instructions below to add an OPC server to AppCenter. The
OPC server should have been installed on a network computer. Some
OPC servers run as a service under Windows; others run as an
application. You will need to know which applies to the OPC server you
are registering. You will also need to know whether there is a
heartbeat item for monitoring the OPC server status.
OPC Server Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
5-6
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the OPC Server Configuration task module using
the instructions in Opening the OPC Server Configuration Module
on page 5-5.
Read The OPC Server Configuration Module on page 5-14.
Read about heartbeat items in OPC Server Monitoring on page 5-2.
Procedure
1 In the Plant Hierarchy frame, select the Object Library.
2 Click the New button on the toolbar to initiate the Add New OPC
Server wizard. Click Next to proceed past the welcome page.
Figure 5-1 The Name and Description wizard page
3 Type a name (up to 50 characters) for the OPC server in the OPC
Server Name field, and a description (up to 255 characters) if
desired.
4 For the Enable OPC Server Monitoring checkbox, do one of the
following:
a) If you do not want to monitor the OPC server, ensure the
checkbox is cleared and ignore the other fields and go to Step
7.
Note: The following are illegal characters that you cannot use when creating names
in ActivEssentials: . ( ). For more information, see Illegal Characters on page
1-17.
OPC Server Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
5-7
b) If you want to monitor the OPC server availability, select the
Enable OPC Server Monitoring checkbox.
5 If you are using a heartbeat item, type the name of the device in
the Access Path field and the PLC address in the OPC Item ID
field.
6 If you want to change the period that VPCollector should wait
before attempting to reconnect to the OPC server, edit the value in
the Quiet Period field. The minimum value is 300; the default
(and maximum) is 39 999 999. Click Next.
Figure 5-2 The Choose a Host Computer wizard page
7 In the Choose a Host Computer screen, do one of the following:
a) In the OPC Server Host field, type the name or IP address of
the computer on which the OPC server is installed, or
b) Click the ellipsis button by the OPC Server Host field, and
select a computer in the browse dialog box that opens. Click
OK to close the network browsing dialog box.
A list of OPC servers installed on the chosen host appears in the
Available OPC Servers box of the wizard.
Note: For more information, see OPC Server Monitoring on page 5-2.
Warning! If there are no OPC servers on the host, a predefined list of unregistered
and inactive servers appear (see image above). Only use this option if you
need a placeholder OPC server (since these servers cannot be activated).
If you do want to use a registered and active OPC server, then install and
configure the OPC server or select a different host.
OPC Server Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
5-8
8 Do one of the following:
a) If a list of servers display, then select one of the OPC servers
from the list. If you want it to be active by default, leave the
Default Active State checkbox checked.
b) If a list of predefined servers display (see image above), then
select one from the list.
9 Click Next. Review the properties of the new OPC server, then click
Finish.
Deleting an OPC Server
Use the instructions below to delete an OPC server from AppCenter.
This does not delete the OPC server from the machine on which it is
installed. It merely removes it from your data collection system. You
can delete an OPC server that is being used by one or more active
assets; if you do, the assets will be inactivated automatically.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the OPC Server Configuration task module using
the instructions in Opening the OPC Server Configuration Module
on page 5-5.
Set up an OPC server using the instructions in Adding an OPC
Server on page 5-5.
Procedure
1 Select the Object Library in the Plant Hierarchy frame.
2 Right-click an OPC server in the grid and select Delete.
A confirmation dialog opens.
3 Click OK.
Note: If you clear the checkmark (making the OPC server inactive), a generic
predefined list of OPC server types display.
Note: Servers in this predefined list cannot be made active. They are generic and can
be registered later if necessary.
Note: You can also add an OPC server by editing directly in the grid. In the last row of
the grid (it has a new page icon at the left side), double-click in the Server
Name column and enter the name, then edit in the Host Name, OPC Server
Type, and Active columns. To edit other properties you have to view the OPC
server Properties page.
OPC Server Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
5-9
Viewing and Editing OPC Server
Properties
Use the instructions below to view and edit the properties of an OPC
server that you have added to the AppCenter. You can edit some of the
properties in the grid; you can edit other properties through the
Properties dialog box.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the OPC Server Configuration task module using
the instructions in Opening the OPC Server Configuration Module
on page 5-5.
Add an OPC server using the instructions in Adding an OPC Server
on page 5-5.
Procedure
1 In the Plant Hierarchy frame, select the Object Library.
2 Do one of the following:
a) Click in the grid under the appropriate column to edit the
properties that are visible there.
b) To edit other properties, do one of the following:
Select the OPC server in the grid, then click Properties on
the toolbar.
Right-click an OPC server in the grid and choose
Properties.
The Properties dialog box opens. In this dialog box you can edit
most of the OPC server properties. You cannot edit the Server
Program ID; it is read-only.
OPC Server Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
5-10
Figure 5-3 OPC Server General Properties
3 Select the General tab if you want to view or change the name,
host name, Server Type, description, or active status of the OPC
server.
4 Select the Monitoring tab if you want to change the OPC server
monitoring parameters. For more information, see OPC Server
Monitoring on page 5-2.
Note: The Server Class ID field is read-only. If you are configuring live incidents in
VPWeb, you will need to copy and paste the Class ID from here into the Item
Properties dialog box.
OPC Server Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
5-11
Figure 5-4 OPC Server Monitoring Properties
Testing the OPC Server Connection
Use the instructions below to test the connection to an OPC server.
This ensures that the network connectivity is present and that you
have configured the OPC server correctly.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the OPC Server Configuration task module using
the instructions in Opening the OPC Server Configuration Module
on page 5-5.
Set up an OPC server using the instructions in Adding an OPC
Server on page 5-5.
Procedure
1 In the Plant Hierarchy frame, select the Object Library, and
then select an OPC server in the grid.
2 Do one of the following:
a) Select the OPC server in the grid, then click the Test
Connection button on the toolbar.
b) Right-click the OPC server and select Test Connection.
If the test is successful, a dialog box appears showing the details of
the OPC server connection. If the test is unsuccessful, a message
appears saying that the OPC server is not connected.
OPC Server Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
5-12
Figure 5-5 A successful OPC server connection test
Assigning an OPC Server to a Group or
Asset
Use the instructions below to assign an OPC server to a group or asset.
You can add the same OPC server to all the assets in a group if you
assign it to the group itself. If you do this, you can change it for
individual assets later.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the OPC Server Configuration task module using
the instructions in Opening the OPC Server Configuration Module
on page 5-5.
Set up an OPC server using the instructions in Adding an OPC
Server on page 5-5.
Procedure
1 In the Plant Hierarchy frame, expand the hierarchy so that you
can see the group or asset to which you want to assign the OPC
server, but do not select it.
2 Select the Object Library.
The grid refreshes to display the presently configured OPC servers.
3 In the grid, click and then drag the icon next to the OPC server that
you want to assign to a group or asset, into the Plant Hierarchy
frame and drop it on the group or asset.
OPC Server Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
5-13
Changing the OPC Server Used by a
Group or Asset
Use the instructions below to change the OPC server that is used by a
group or asset. You can do this in two ways: by dragging an OPC
server from the grid and dropping it on a group or asset, or by editing
the groups or assets properties. Before you do this you must stop
VPCollector.
Prerequisites
Before doing this you need to have done or read the following:
On the computer hosting the VPCollector assigned to the asset,
stop the VPCollector service. To do this, right-click the Activplant
desktray icon, then choose VPCollector > Stop.
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the OPC Server Configuration task module using
the instructions in Opening the OPC Server Configuration Module
on page 5-5.
Procedure
1 Do one of the following:
a) To change the OPC server used by a single asset, select the
asset in the Plant Hierarchy frame, then click in the Server
Name column in the grid and select a new OPC server.
b) To change the OPC server for several assets in the same group,
select the group in the Plant Hierarchy frame, then change the
server for each asset by clicking in the Server Name column in
the grid and selecting a different OPC server.
c) To change the OPC server for all the assets under a group,
expand the plant hierarchy so that you can see the group, then
select the Object Library. In the grid, click on the icon to the
left of the OPC server, then drag it and drop it on the group in
the plant hierarchy.
2 Restart the VPCollector service on the VPCollector machine
assigned to the asset. To do this, right-click the Activplant desktray
icon and choose VPCollector > Start.
OPC Server Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
5-14
The OPC Server Configuration Module
The OPC Server Configuration module is similar to other AppCenter
modules, with the Plant Hierarchy frame and the grid displayed. In the
Plant Hierarchy frame you will see the hierarchy and the Object Library
on page i-ix There is no secondary frame.
To create or delete OPC servers, or to edit most properties, you have
to select the Object Library. If you want to see which OPC server is
collecting information from a group or asset, select the parent of the
group or asset in the Plant Hierarchy frame; the grid displays the
name of the OPC server. You can change the OPC server for a group or
asset, but you cannot edit other properties of the OPC server here.
Visual Cues in the OPC Server Configuration
Grid
The grid in the OPC Server Configuration module displays a colored
icon at the left side of each row. The colors used in the icon vary
depending on the use of the OPC server. To see the status of an OPC
server, hover your mouse pointer over it to see a tool-tip.
When you are editing in the grid, a pencil icon appears. This indicates
that your changes have not been saved. It reverts to one of the other
icons when the changes have been saved.
Table 5-2 Icons used in the OPC Server Configuration module
Icon Colors Meaning
Grey and red Only visible when the Object Library is selected. This means
that the OPC server is not active and has not been assigned to
any assets.
Blue and red Only visible when the Object Library is selected. This means
that the OPC server is active but has not been assigned to any
assets.
Blue and green Only visible when the Object Library is selected. This means
that the OPC server is active and is being used by one or more
assets.
Blue Only visible when a parent is selected in the plant hierarchy.
This means that an OPC server has been assigned to the
group and is inherited by the child assets. Note the arrow
pointing down.
Blue Only visible when a child object is selected in the plant
hierarchy. This means that an OPC server has been assigned
to the parent and is inherited by the child. Note the shortcut
arrow.
Grey Only seen when you click on a plant hierarchy object that has
no OPC server assigned to it. Note the small question mark.
Note: If you hover your mouse pointer over an icon, a tool-tip appears describing its
meaning. If the OPC server is active and in use, the tool-tip also tells you how
many active assets are using it.
CDC Factory 7.1
ActivEssentials Administration Guide
6-1
VPCollector Configuration
VPCollector Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
6-2
Introduction to VPCollector Configuration
As part of the configuration of your ActivEssentials data collection
system you have to identify the host machines on which the collection
engine (VPCollector) is installed. Because ActivEssentials can be a
distributed system, you can install VPCollector on one or more servers,
depending on your needs and the scale of your data collection system.
You must do these installations before you can use the Collector
Configuration module. For more information about VPCollector
installation, see the System Configuration Guide (System
Configuration Guide.pdf) in the ActivEssentials installation package.
AppCenter has a special module called Collector Configuration in
which you identify the VPCollector hosts. Later, when you have defined
your plant hierarchy, you use this module also to link each asset to a
specific VPCollector so that data collection can commence; the data for
each asset is collected by the VPCollector assigned to the asset.
This chapter covers the following topics:
The Collector Configuration Module on page 6-2
Creating and Editing VPCollectors on page 6-4
Applying VPCollector Instances to Assets on page 6-8
Starting, Stopping, and Refreshing VPCollector on page 6-12
The Collector Configuration Module
The Collector Configuration module is where you identify the machines
that are running VPCollector. You have to add these VPCollector
instances to your data collection system so that ActivEssentials knows
which collectors are present. As you build your plant hierarchy you will
identify which collector is gathering data from the different assets.
This section covers the following topics:
Opening the Collector Configuration Module on page 6-2
Description of the Collector Configuration Module on page 6-3
Opening the Collector Configuration
Module
Use the instructions below to access the Collector Configuration
module of the AppCenter. In this module you can define the instances
of VPCollector that you are using to collect data. You can also define
which instance of VPCollector an asset or group of assets will use.
Note: Information on VPCollector behavior, error messages, refreshing, clustering,
and VPCollector heartbeat is in the System Configuration Guide (System
Configuration Guide.pdf), which is in the ActivEssentials installation package.
VPCollector Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
6-3
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
Read Description of the Collector Configuration Module on page
6-3.
1 In the taskbar, click the System category button.
The taskbar displays icons for the System task modules.
2 In the taskbar, click the Collector Configuration icon.
The Collection Configuration task module opens.
Description of the Collector Configuration
Module
The Collector Configuration module includes the following elements:
The toolbar. There are several buttons on the toolbar. The number
and type of buttons available varies depending on whether you
select the Object Library or a plant hierarchy item in the Plant
Hierarchy frame.
The Plant Hierarchy frame. This contains the expandable tree of
plants, groups, and assets. It also contains the Object Library in
which you define global elements that you can use elsewhere. For
further information on the plant hierarchy, see Plant Hierarchy on
page 1-14.
The grid. When the Object Library is selected in the Plant
Hierarchy frame, the grid displays the list of VPCollectors that have
been defined (if any). If a group or asset is selected instead, the
grid displays the collector(s) that have been assigned to that group
or asset. You can edit some properties of the collectors directly in
the grid.
In the Collector Configuration module you can create new VPCollector
items, edit VPCollector items, and assign items to plant hierarchy
objects such as groups or assets.
Note: If you want to view VPCollector information for an asset, select the parent
group in the Plant Hierarchy frame. The collector information for each asset in
the group appears in the grid. If you want to define or edit instances of
VPCollector, select the Object Library in the Plant Hierarchy frame.
VPCollector Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
6-4
Creating and Editing VPCollectors
When you select the Object Library in the Plant Hierarchy frame, the
grid displays a list of VPCollector instances that have been defined (if
any). While the Object Library is selected you can create, delete, or
edit VPCollector instances. You should have installed VPCollector on at
least one server before you do this.
This section covers the following topics:
Creating a VPCollector Instance on page 6-4
Viewing and Editing VPCollector Properties on page 6-6
Deleting a VPCollector on page 6-7
Caching Accumulator Values on page 6-7
Creating a VPCollector Instance
Use the instructions below to create a new instance of VPCollector.
When you do this, you are actually identifying to the system a host
computer on which VPCollector is installed. This VPCollector then
becomes available for use by assets in your system.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Collector Configuration task module using
the instructions in Opening the Collector Configuration Module on
page 6-2.
Read Caching Accumulator Values on page 6-7.
Procedure
1 In the Plant Hierarchy frame, select the Object Library.
If any VPCollector instances have already been defined, they
appear in the grid.
2 Right-click in the grid and select New.
The Add New VPCollector wizard starts.
3 Click Next to move past the welcome page.
The Name and Description page of the wizard opens.
4 Do both of the following:
a) In the Collector Name field, type a unique name (up to 50
characters) for the VPCollector instance.
b) If you wish, click in the Description field and type a
description (up to 255 characters).
5 Click Next.
The Host Machine wizard page opens.
VPCollector Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
6-5
Figure 6-1 The Host Machine wizard page
6 Do one of the following:
a) In the Host name or IP address field, type the name of the
computer on which the VPCollector is installed, or
b) Click the ellipsis button and browse to the host name, select
the host computer, and then click OK to return to the wizard.
7 If you want to cache accumulator values so that they are
recoverable in case of an interruption in data collection, ensure
that the Enable data cache for accumulators checkbox is
checked, and enter a duration (in minutes) for the cache. For more
information, see Caching Accumulator Values on page 6-7.
8 If you want the VPCollector to be active, ensure that the Active
checkbox is checked.
9 Click Next.
The Summary wizard page opens.
10 Review the VPCollector definition and click Finish to save it.
VPCollector Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
6-6
Viewing and Editing VPCollector
Properties
Use the instructions below to view and edit the properties of a
VPCollector instance. You can edit some properties directly in the grid
in the Collector Configuration module, but other properties must be
edited through the Properties dialog box.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Collector Configuration task module using
the instructions in Opening the Collector Configuration Module on
page 6-2.
Procedure
1 In the Plant Hierarchy frame, select the Object Library.
If any VPCollector instances have already been defined, they
appear in the grid.
2 Right-click a VPCollector in the grid and select Properties.
Figure 6-2 VPCollector Properties dialog box
Note: As well as the methods described here, you can edit some of the VPCollector
properties by clicking or double-clicking in the grid.
VPCollector Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
6-7
3 Edit the properties (name, host name, etc.) in the Properties
dialog box.
4 To edit the Host Name, do one of the following:
a) Type the name in the Host name or IP address field, or
b) Click the ellipsis button to the right of the Host name or IP
Address field, and navigate to the host computer. Select the
host computer and click OK.
5 Click OK to save any changes.
Deleting a VPCollector
Use the instructions below to delete a VPCollector instance from your
data collection system. When you do this, you do not delete it from its
host computer; you merely remove all reference to it from
ActivEssentials.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Collector Configuration task module using
the instructions in Opening the Collector Configuration Module on
page 6-2.
Procedure
1 In the Plant Hierarchy frame, select the Object Library.
If any VPCollector instances have already been defined, they
appear in the grid.
2 Right-click a VPCollector instance in the grid and select Delete.
A confirmation dialog box opens.
3 Click OK.
Caching Accumulator Values
Sometimes data collection may be interrupted for a short time. This
will occur, for example, if VPCollector is stopped or refreshed. Strictly
speaking, it is the asset that is refreshed. Refreshing takes the asset
off-line for a few seconds.
Note: If the Active checkbox is greyed out in the Properties dialog box, it is because
the VPCollector is running and is used for one or more assets, and you cannot
inactivate it here.
Note: You cannot delete a VPCollector if it is running and is used for one or more
assets. You can stop VPCollector through the Activplant desktray on the
computer where it is running.
VPCollector Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
6-8
You have the option to cache accumulator values so that VPCollector
can still read the previous value if the data items go offline, for
example when refreshing an asset. This option is set for each instance
of VPCollector when you define it, and it applies to any solicited
accumulator that this instance of VPCollector will collect. The cache
duration should therefore be just less than the smallest likely roll-over
time.
Example
You have a counter that is increasing rapidly, reaching the roll-over
value of 32 000 approximately every five minutes. You set the
accumulator cache value to 4 minutes. VPCollector is shut down for a
short time. If the interruption lasted less than 4 minutes, when
VPCollector restarts it uses the cached (previous) value to calculate
the value for its current reading, and the value posted by VPCollector
will be accurate. If the interruption lasted more than 4 minutes,
VPCollector will not know how many roll-overs have occurred, and the
calculated value on restart will not use the cache value. The value
stored may or may not be correct.
Applying VPCollector Instances to Assets
In a large installation it is important to try to balance the load by using
multiple instances of VPCollector. The Collector Configuration module
of AppCenter allows you to assign instances of VPCollector to different
assets. In most cases it is best to use the VPCollector instance that is
closest to those assets, but this is not essential.
This section covers the following topics:
Assigning a VPCollector to a Group or Asset on page 6-8
Viewing the Properties of a VPCollector Used by an Asset on page
6-9
Accessing the Activplant Control Panel on page 6-13
Assigning a VPCollector to a Group or
Asset
Use the instructions below to assign a VPCollector instance to one or
more assets. You can add a VPCollector to a plant, a group, or an
asset. When you add it to a plant or group, the VPCollector is
automatically added to all the items belonging to the plant or group.
VPCollector Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
6-9
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Collector Configuration task module using
the instructions in Opening the Collector Configuration Module on
page 6-2.
Define at least one VPCollector instance. See Creating a
VPCollector Instance on page 6-4 for more information.
Procedure
1 In the Plant Hierarchy frame, expand the hierarchy until you can
see the group or asset to which you need to add the VPCollector,
but do not select it.
2 In the Plant Hierarchy frame, select the Object Library.
If any VPCollector instances have already been defined, they
appear in the grid.
3 In the grid, determine which VPCollector instance you need to use.
4 Click the colored icon to the left of the VPCollector name and drag
it over to and drop it on the group or asset in the Plant Hierarchy
frame.
Viewing the Properties of a VPCollector
Used by an Asset
Use the instructions below to view the properties of a VPCollector
assigned to an asset.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Collector Configuration task module using
the instructions in Opening the Collector Configuration Module on
page 6-2.
Note: If you drop the VPCollector on a plant or group, all the assets belonging to the
plant or group will use the same collector. If the plant or group were previously
associated with another VPCollector, the application of the new VPCollector
breaks that old association.
VPCollector Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
6-10
Procedure
1 In the Plant Hierarchy frame, expand the hierarchy to the point
where you can see the asset and select it.
The instance of VPCollector used by the asset appears in the grid.
2 Right-click the VPCollector and select Properties.
Figure 6-3 The properties dialog box for an instance of VPCollector
Changing the VPCollector Used by an
Asset
Use the instructions below to change the VPCollector instance that an
asset uses. You can do this in several ways: by drag-and-drop, or
through the assets property pages, or by editing in the grid. If you
want to change the collector for all the assets in a plant or group, use
the Collector Configuration module.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Collector Configuration task module using
the instructions in Opening the Collector Configuration Module on
page 6-2.
Note: The dialog box summarizes the properties of the instance of VPCollector
applied to the asset. The only change you can make is to change the instance
of VPCollector the asset uses.
VPCollector Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
6-11
Procedure
1 In the Plant Hierarchy frame, expand the hierarchy so that you
can see the plant, group, or asset whose collector you wish to
change, but do not select it.
2 In the Plant Hierarchy frame, select the Object Library.
The previously defined instances of VPCollector appear in the grid.
3 In the grid, click the colored icon to the left of the VPCollector
name you want to use and drag and drop it onto the group or asset
in the Plant Hierarchy frame.
Note: If you drop the VPCollector on a plant or group, all the assets belonging to the
plant or group will use the same collector.
Note: You can also change the VPCollector through the Plant Management module.
In this module, select the group or asset, then click in the VPCollector column
in the grid and choose a different one. Alternatively, open the Properties dialog
box for the group or asset and change the VPCollector there.
VPCollector Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
6-12
Starting, Stopping, and Refreshing VPCollector
Whenever you make changes in the data collection system,
VPCollector has to be informed of the changes so that it can continue
collecting both the old and the new data parameters. This is known as
refreshing VPCollector. Some of the changes that you make in
AppCenter do not require you to refer to VPCollector. Other changes
trigger an automatic refreshing of VPCollector, while still others require
you to refresh VPCollector manually. See When to Refresh VPCollector
on page 6-17.
For some changes you can refresh VPCollector when working at the
asset level. To do this, go to the Collector Configuration module,
navigate to the asset on which you are working, right-click the asset in
the grid, and choose Refresh VPCollector. This refreshes only the
asset. (You cannot refresh VPCollector at the plant or group level; the
reason for this is that refreshing always takes data offline for a couple
of seconds, and the extent of refreshing should be restricted as far as
possible.)
For more extensive changes you must stop and restart VPCollector
through the Activplant Control Panel. This affects the whole data
collection system, so it is not something that you want to do
frequently. For more information on the effects of stopping and
restarting VPCollector, see Effects of Stopping or Refreshing
VPCollector on page 6-15.
Note: Strictly speaking, it is the asset that is refreshed when you choose Refresh
VPCollector. Refreshing effectively informs VPCollector of the changes made
on the asset.
Warning! Whenever you have to shut down a computer that hosts VPCollector
(whether a primary collector or a backup), you should always stop
VPCollector (through the Activplant control panel) before shutting down the
computer. This will allow ActivEssentials to close any open incidents and
identifiers, and will also avoid complications with backup collectors.
VPCollector Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
6-13
This section covers the following topics:
Accessing the Activplant Control Panel on page 6-13
Starting and Stopping VPCollector on page 6-14
Effects of Stopping or Refreshing VPCollector on page 6-15
Changes That Cannot be Made if VPCollector is Running on page
6-17
When to Refresh VPCollector on page 6-17
What Happens When You Make Changes on page 6-19
Limitations to the Use of VPCollector on page 6-20
Accessing the Activplant Control Panel
Use the instructions below to access the Activplant control panel in
order to control the operation of VPCollector.
Prerequisites
Before doing this you need to have done or read the following:
Read Effects of Stopping or Refreshing VPCollector on page 6-15.
1 Locate the Activplant icon in the notification area of the Windows
taskbar.
2 Right-click the on the icon and choose Control Panel.
The Activplant Control Panel opens.
Note: This procedure takes place on the computer that hosts VPCollector.
VPCollector Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
6-14
Figure 6-4 The control panel dialog box, showing the VPCollector event log
3 In the left side of the control panel, expand the tree hierarchy by
clicking the plus signs.
4 Select a service (VPCollector or VPQManager) for further
operations.
Starting and Stopping VPCollector
Use the instructions below to start and stop VPCollector. Before you
stop VPCollector you should consider the effects on data collection.
These effects are listed inEffects of Stopping or Refreshing VPCollector
on page 6-15 below.
Warning! If you start VPCollector by mistake and want to stop it immediately, wait at
least 10 seconds before stopping it. This allows time for all the
configuration to load and avoids problems the next time you start it.
Note: This procedure takes place on the computer that hosts VPCollector.
VPCollector Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
6-15
Prerequisites
Before doing this you need to have done or read the following:
Open the Activplant control panel using the instructions in
Accessing the Activplant Control Panel on page 6-13.
Read the following:
Effects of Stopping or Refreshing VPCollector on page 6-15
Changes That Cannot be Made if VPCollector is Running on
page 6-17
When to Refresh VPCollector on page 6-17
Procedure
1 Expand the tree hierarchy on the left side of the control panel, and
select VPCollector.
2 If VPCollector is stopped, you will see a green button on the control
panel toolbar. To start VPCollector, click the green arrow.
3 If VPCollector is running, you will see a red button on the control
panel toolbar. To stop VPCollector, click the red button.
4 When the button changes color, close the control panel by clicking
the Close button at top right.
Effects of Stopping or Refreshing
VPCollector
When VPCollector stops or is refreshed it affects the collection of data.
This is true whether the stop is intentional (done through the control
panel) or unintentional (for example, a VPCollector failure).
If the database is down for any reason, then upon start-up,
VPCollector works off of the last known configuration from the
database. The last known configuration is stored locally in a file.
When the database comes back online, VPCollector reloads the latest
configuration from database and saves it locally for future use.
You can only refresh VPCollector on one asset at a time. It usually
takes about 2 seconds to refresh, but may be more or less depending
on network traffic.
If you refresh an asset when the database is not available (such as a
time-out), VPCollector will continue collecting data based on the last
good configuration. In ActivEssentials it is possible to create an active
asset that has no data items configured and therefore does not exist
within VPCollector.
Stopping VPCollector has more serious consequences than refreshing,
because it affects all the assets that are sending data to that
VPCollector.
The table below lists the consequences of stopping or refreshing
VPCollector.
VPCollector Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
6-16
Table 6-1 Effects of starting or stopping VPCollector
Collected Data Item Condition Effect of stopping VPCollector
Solicited
accumulators
Caching is enabled and VPCollector is restarted
before the cache period expires.
No effect at all.
Caching is enabled but VPCollector is not
restarted before the cache period expires.
Data values are suspect because
there is no way of knowing how
many roll-overs have occurred. The
distribution of the numbers over the
time period may be inaccurate, with
zero values for some time intervals.
Unsolicited
accumulators
All conditions If the trigger is on, the value of
unsolicited accumulators remains as
it was.
Incidents All open incidents are closed if
VPCollector is stopped.
Incident value does not change while
VPCollector is stopped. Merge Values is set, and
the Allowed Gap is not exceeded.
Incident records are merged.
Incident value does not change while
VPCollector is stopped. Merge Values is not set;
or it is set but the Allowed Gap is exceeded.
Incident records are not merged.
Incident value changes before VPCollector is
restarted.
Incident data is marked as Uncertain
Quality because the incidents are
closed when VPCollector stops.
Identifiers All open identifiers are closed if
VPCollector is stopped, and are
marked as Uncertain Quality.
Identifier value does not change while
VPCollector is stopped. Merge Values is set, and
the Allowed Gap is not exceeded.
Identifier records are merged.
Identifier value does not change while
VPCollector is stopped. Merge Values is not set;
or it is set but the Allowed Gap is exceeded.
Identifier records are not merged.
Identifier value changes before VPCollector is
restarted.
Identifier data is marked as
Uncertain Quality because the
identifiers are closed when
VPCollector stops.
Triggered Events All conditions. If the trigger is on when the asset is
refreshed, an extra record will be
created in the database. If you view
an event variable and select Record
Count as the aggregation, the
number will be one extra, but the
item value is not affected.
Sampled Events All conditions. The sample start time will be
rescheduled based on the moment
of refreshing. This will only affect the
refreshed asset.
All data types Important: Some OPC servers may send an initial zero (0) value when VPCollector is
restarted or refreshed. The zero value may trigger a bogus incident or identifier.
VPCollector Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
6-17
Changes That Cannot be Made if
VPCollector is Running
If VPCollector is running there are a number of tasks that cannot be
performed. In order to perform any of the following tasks, you must
first stop VPCollector. You can restart it after completing the task.
If VPCollector is running, do not do any of the following without first
stopping it:
Change the registry information. This includes changing the
database name and the database host.
Change the system time of the VPCollector server or the database
server.
Change the Host Name or IP Number of an assets VPCollector or
OPC server while the asset is active. If the asset is inactive then
you can make the necessary changes without cause for concern.
Change the Solicited Collection property of an accumulator item
when VPCollector is collecting this item.
Delete a category if items in the category are being used.
Change the category of a global definition if items in the category
are being used.
Delete a global definition if items belonging to the definition are
being used.
Delete an OPC server in the OPC Servers module if it is being used
by any asset that has a running VPCollector.
Delete a VPCollector while it is running.
When to Refresh VPCollector
When you are making changes to the tree hierarchy, some things will
take effect immediately while others will require that you refresh the
VPCollector. Refreshing VPCollector causes a short gap in data
Warning! Do not make any of the changes listed below without first stopping
VPCollector.
Warning! Do not shut down the VPCollector host without first stopping VPCollector.
This will allow ActivEssentials to handle open incidents and identifiers.
Warning! If you start VPCollector by mistake and want to stop it immediately, wait at
least 10 seconds before stopping it. This allows time for all the
configuration to load and avoids problems the next time you start it.
VPCollector Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
6-18
collection, so if you are performing tasks that will require refreshing
you should do all the tasks at once and refresh only when they are all
completed.
Manual Refresh
You are allowed to make the following changes while VPCollector is
running you will not encounter any error messages. However, these
changes will not take effect until VPCollector is refreshed. In these
cases, after making the changes you must refresh VPCollector for the
changes to take effect.
Activate or inactivate any item (accumulators, incidents,
identifiers, or variables).
Change the multiplier, trigger, OPC address, or OPC Item of an
accumulator item.
Change whether the event is triggered or sampled.
Change the trigger value or expression of an event.
Change the trigger value or expression of incidents.
Change the historical data collection parameter for an event (that
is, whether the event data will be saved in the database).
Change the roll-over value for an asset. See the note below.
Automatic Refresh
In some cases, there are changes that you can make while VPCollector
is running that will take effect immediately. VPCollector is
automatically refreshed, and you do not have to refresh it manually,
when you perform any of the following tasks:
Inactivate a group or an asset. All assets belonging to the group
will be deleted from VPCollector.
Activate a group or an asset. All assets that belong to the group
will be added to VPCollector.
Delete a group or an asset. All assets that belong to the group will
be deleted from VPCollector.
Note: You can change the roll-over value for an asset, and the setting will take
precedence over the roll-over values for any accumulators applied to the asset.
This means that all accumulators applied to the asset will have the same
roll-over value.
VPCollector Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
6-19
No Need to Refresh
The following changes are accepted automatically. There is no need to
manually refresh VPCollector and there is no automatic refresh
function.
Change the multiplier and offset value on a variable item.
Change the unit or format of an item (accumulators, incidents,
identifiers, or variables).
Change a unique definition to a global definition. The new global
definition must use the original category or <All> category.
Change the category of a global definition to <All> category.
What Happens When You Make Changes
Every change that you make in AppCenter administrator tools has an
effect on the data collection process. For example, when you refresh
VPCollector you lose the data that would be collected during the time it
takes VPCollector to be refreshed (usually only a few seconds). The
consequences of several common changes are detailed below.
Note: When you change a unique definition, you may have to restart VPWeb in order
for the change to take effect.
Table 6-2 Actions and consequences of changes in AppCenter
Action Consequences
Deleting a category or global
definition
All items of this category are deleted. All
historical data for the items is deleted from
the database.
Deleting an item All definitions using the item (e.g.
calculations, data links to production
objects) are deleted. All historical data for
the item is deleted from the database.
Deleting an asset or branch of a
group
All item configuration associated with the
asset or branch is deleted. All historical
data for the asset or branch is deleted from
the database.
Inactivating an asset or group Data collection ceases for the asset or
group. Historical data is not deleted. Any
open incidents or identifiers are closed.
VPCollector Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
6-20
If the Database is Unavailable
If you refresh an asset while the database is unavailable (either
because of network connectivity or problems with the database
computer), it impacts your data collection system. VPCollector
continues collecting data based on the last good configuration. The
changes will not take effect until the asset is refreshed again with a
good database connection.
Limitations to the Use of VPCollector
There are a number of limitations to the way VPCollector can be used
to collect data, primarily concerning the number of data items that can
be collected at any one time. Although the limits stated below restrict
the performance of any one installation of VPCollector, you can install
as many instances of VPCollector as needed to complete the
configuration of ActivEssentials.
The limitations to use are:
The maximum assets per OPC Server is 1 000.
The maximum number of accumulators per VPCollector is 10 000.
Tests have shown that having more than 10 000 accumulators
adversely affects the performance of VPCollector.
Alphanumeric variables and identifier values must be less than 80
characters.
Each VPCollector can have up to 5 208 event variables that are
sampled at the same moment.
Changing the category of a global
definition (accumulators and
incidents) from one category to
another (but not to <All>)
Items using the global definition will belong
to the new category. Historical data
belonging to the items will change
category.
Changing the category of a global
variable definition from one
category to another (but not to
<All>)
The variable is detached from the event
with which it was associated. The event
variable item is deleted. Historical data for
the event variable is deleted from the
database.
Deleting a VPCollector All historical date associated with the
VPCollector is immediately marked in the
database for removal. Actual removal does
not take place until the next garbage
collection job runs in the database.
Table 6-2 Actions and consequences of changes in AppCenter (Continued)
Action Consequences
Note: When deleting an asset, all the historical data associated with the asset is
immediately marked for removal from the database when the garbage
collection job runs, which usually occurs everyday. If you delete an asset by
mistake, disable the garbage collection job to give yourself an opportunity to
recover the data.
VPCollector Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
6-21
Each VPCollector can collect up to 65 536 separate event variables.
Each VPCollector can have up to 65 536 triggered events.
Accumulator update rate must be less than 24 hours.
Each instance of VPCollector can handle up to 65 536 incidents.
Incident priority value must be less than 32 768.
The maximum roll-over value you can use with VPCollector is
21 000 000. For information on setting the maximum, see the
System Configuration Guide (System Configuration Guide.pdf),
which is in the ActivEssentials installation package.
Note: If you have variables that are sampled in multiples of 5 seconds (for example,
5 seconds, 15 seconds, and 25 seconds), there will be times when they all
coincide. You must take this into account when calculating the number of
variables that may be sampled simultaneously. The same is also true of
variables that are sampled in multiples of some other number.
CDC Factory 7.1
ActivEssentials Administration Guide
7-1
Data Collection Configuration
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-2
Introduction to Data Collection Configuration
One of the largest tasks in configuring your data collection system is to
create all the data items that will be collected. You perform this task in
the Data Collection Configuration module of the AppCenter.
In the planning stages of your implementation you should have
identified all the data items that you need. In the Data Collection
Configuration module you can create global data items, and you can
apply these to individual assets. You can also create data items that
are specific to an individual asset.
When you create global items you dont need the OPC item address
(the IP address of the computer on which the OPC server is installed),
but when you apply a global item to a specific asset you must enter
the OPC item address.
Also included in the Data Collection Configuration module is the ability
to export and import configuration items so that you do not need to
create them again and again.
This chapter covers the following topics:
The Data Collection Configuration Module Interface on page 7-3
Categories, Collection Methods, and ActivEssentials on page 7-12
Creating Global Accumulators, Incidents, and Variables on page
7-19
Incident Sub-Categories on page 7-30
Defining Global Identifiers on page 7-42
Defining Accumulators, Incidents, and Identifiers on an Asset on
page 7-70
Events in ActivEssentials on page 7-95
Triggered Sample Events on page 7-100
Defining Event Data Items on an Asset on page 7-110
Asset States on page 7-132
Filtering Data by Means of Expressions on page 7-143
Exporting and Importing on page 7-150
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-3
The Data Collection Configuration Module
Interface
The Data Collection Configuration module is where you build and
maintain all of the data items used in the collection of data in your
plant. Each of the five Activplant data collection methods is applied
through the module; it is where you define how the data is collected
and assign the data collection items to the groups and assets.
This section covers the following topics:
Opening the Data Collection Configuration Module on page 7-3
Printing from the Data Collection Configuration Module on page 7-3
The Data Collection Configuration Grid on page 7-4
Saving Time in Configuring Data Items on page 7-11
Opening the Data Collection Configuration
Module
Use the instructions below to open the Data Collection Configuration
module of AppCenter. In this module you define the categories for data
items, and the data items themselves. You also use this module to add
data items to assets, and to define the various states that can occur on
an asset.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
Read The Data Collection Configuration Grid on page 7-4.
Procedure
1 In the taskbar, click the Configuration category button.
The taskbar refreshes to display icons for the task modules in the
Configuration category.
2 In the taskbar, click the Data Collection Configuration icon.
The grid refreshes to display the Data Collection Configuration
interface.
Printing from the Data Collection
Configuration Module
Use the instructions below to print the data displayed in the Data
Collection Configuration module. You can print whatever you can see
in the grid, where the data displayed depends on the selection you
make in the Plant Hierarchy, the Collection Configuration, or the Global
Collection Configuration frames.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-4
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Data Collection Configuration task
module using the instructions in Opening the Data Collection
Configuration Module on page 7-3.
Procedure
1 In any of the Plant Hierarchy, Collection Configuration, or
Global Collection Configuration frames, expand the hierarchy to
a point where you can see the item you need.
The Collection Configuration and Global Collection Configuration
frames appear in the secondary frame area.
2 Select the item.
The items that you want to print appear in the grid.
3 Click the Print button on the toolbar.
4 Select from the printers available to your computer and click Print.
The Data Collection Configuration Grid
The grid in Data Collection Configuration module displays all of the
items used for collecting production data. The grid has several
configurations, and the data displayed depends on the selections in the
Plant Hierarchy frame (plant, group, or asset items, or the Object
Library), and the various options in the secondary frame (Collection
Configuration, Global Collection Configuration, etc.). The
following figure shows a typical view in the Data Collection
Configuration module.
Note: The frame that appears is determined by your selection in the Plant Hierarchy
frame. Selecting a plant item (plant, group, or asset) opens the Collection
Configuration frame; selecting the Object Library opens the Global Collection
Configuration frame.
Note: The printed document will contain only the items that appeared in the grid. No
other elements of the AppCenter interface will appear in the document.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-5
Figure 7-1 The Data Collection Configuration window
Data Configuration Through the Object Library
The Object Library provides access to the global data collection
configuration. When you select the Object Library, the secondary
frame shows two options: Global Collection Configuration and
Incident Configuration. You can switch between the two by clicking
the appropriate category button.
The Global Collection Configuration frame is your starting point
in defining all of the collection categories that use the
Accumulators, Events, Incidents, Identifiers, and Asset States
collection methods.
The Incident Configuration frame allows you to define incident
sub-categories and incident sub-category items. These items are
not essential for data collection, but allow you to sub-classify
incidents such as faults and alarms.
You can define, modify, or delete any of the global collection
configuration definitions through the Global Collection
Configuration frame. The following figure gives a summary of the
operations and the data visible in the Data Collection Configuration
module, when viewed at the global level (through the Object
Library).
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-6
Figure 7-2 Summary of data available when the Object Library is selected
Data Configuration Through the Plant Hierarchy
Selecting the plant, a group, or an asset, causes the Collection
Configuration (secondary) frame to open. The items displayed in this
secondary frame relate to the object selected in the Plant Hierarchy
frame. These items represent the collection categories as a whole, the
individual collection categories, and the asset states.
Selecting the Collection Categories item causes the grid to
display all of the categories that have been applied to the plant,
group, or asset. The grid indicates the name of the category, the
collection method, and other configuration data. You can only
Global Collection
Configuration frame
Incident
Configuration frame
Plant Hierarchy
Plant
|____Group
|____Asset
Object Library
Grid
Selecting an item in the Global Collection
Configuration frame gives the following:
Collection categories All of the collection
categories are defined here under one or
other of the collection methods.
Accumulators You define all of the data
items here that work as counters, such as the
number of completed items, or a measure of
elapsed time.
Incidents All of the incident descriptions are
defined here. Incidents measure the duration
of machine conditions such as faulted or
jammed. An asset state may report the
condition of a machine, but an incident
reports the length of time the machine was in
that condition.
Identifiers You define all of the identifiers
here for recording the durations of
identifiable spans of time during production.
You can record when items such as batches,
part numbers, or shifts were current during
production.
Variables Variables are the values present
in the PLCs when an event occurs. Activplant
defines events in two distinctive ways: time
intervals and trigger values. For example,
readings could be taken every 5 minutes, or
the readings could be taken only when
another value changes.
Asset States You can define the various
states that can exist on an asset, such as
running, faulted, stopped, starved, jammed,
backed up, etc., and record when these
changes of state occurred. Changes in asset
state form the basis of other collected data,
such as incidents.
Selecting an incident sub-category or an incident
sub-category item in the Incident Configuration
frame allows you to add additional properties to
incidents. These items are not essential to the
data collection process, but can provide you with
further information.
NOTE: Items defined at
the global level do not
collect data, they only
act as the framework
for data collection when
the items are applied to
groups and assets.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-7
assign categories to an asset that have already been defined under
the various collection methods, and then only oncean asset
cannot have two categories with the same name.
The Collection Configuration frame displays all the collection
categories that have been applied to the plant, group, or asset,
grouped by collection method. Selecting one or other of the
category items causes the grid to refresh to display the data items
applied. You can then add, modify, or delete items. The structure of
the display of data items can differ between collection categories.
Accumulators, Identifiers, and Incidents. The structure of
each of these kinds of category is the same. At the global level,
you define categories under one or other of these collection
methods, and then apply them to the plant, group, or asset.
You then define global data items under these categories, and
apply them locally.
Variables. An event may be sampled at a regular interval, or
when a change occurs at another PLC address. You define the
event and the variables that will be collected when the event
occurs. Variable data can be either numeric or alphanumeric.
They have subordinate properties that you can access through
expanding the tree. Selecting different items in the tree causes
the grid to display the data items at the various levels.
Asset States. Asset states are all globally defined, so you
must include all of the possible conditions that could exist for
any asset. When applying the asset states locally, you add only
those that apply to the selected group or asset.
The following figure gives a summary of the operations and the data
visible in the Data Collection Configuration module, when viewed at
the local level (plant, group, or asset).
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-8
Figure 7-3 Summary of data available when plant, group, or asset is selected
Data Collection Defined in ActivApplications
Under the ActivApplications item in the Plant Hierarchy frame are the
asset templates that have been defined for use in your ActivEssentials
installation. Asset templates contain model data collection
configuration to fit with the needs of specific applications. The
applications can be ActivApplications you purchased from CDC Factory,
or they could be applications you develop yourself.
In Data Collection Configuration, you treat the template items, which
appear at the third level down as you expand the ActivApplications
tree, as if they are assets. You can create any of the data collection
Collection Configuration
frame
Collection Categories*
|___Accumulator Category 1
|___Accumulator Category 2
|___Incident Category 1
|___Incident Category 2
|___Identifier Category 1
|___Identifier Category 2
|___Variable Category 1
|___Variable Category 2
Asset States
* Collection category names can be
anything you wish, but within a col-
lection method each name must be
unique.
Plant Hierarchy frame
Plant
|____Group
|____Asset
Object Library
Grid
Selecting an item in the Collection
Configuration frame gives the following:
Collection Categories You see in the
grid all of the categories defined for
use with the asset. For each category,
the grid recognizes the collection
method used, by the icon on the left
and the description in the Method
column. Each of the methods may
occur more than once.
Accumulators Under the Collection
Categories item there may be several
accumulator categories. When you
select one, you see all of the
accumulator data items defined for use
with the group/asset in that category.
Incidents Under the Collection
Categories item there may be several
incident categories. When you select
one, you see all of the incident data
items defined for use with the group/
asset in that category.
Identifiers Under the Collection
Categories item there may be several
identifier categories. When you select
one, you see all of the identifier data
items defined for use with the group/
asset in that category.
Variables Under the Collection
Categories item there may be several
variable categories. Variable categories
contain event items and numeric and
alphanumeric variables. You can
expand and then select items in the
tree under the category item to see
differing data items in the grid.
Asset States Asset states are not
collection categories, but definitions of
conditions that can exist on an asset.
Selecting the Asset States item allows
you to view or modify these defined
states.
NOTE: You can add as many
collection categories as have
been defined under each
collection method. When you
select a collection category in
the Collection Category
frame, you see all of the data
items Activplant will collect
under the selected category.
You can then add, delete, or
edit the items applied to the
group or asset.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-9
configuration that you might create for an asset and apply it to a
template. You cannot create templates in the Data Collection
Configuration module, you can do this in the Plant Configuration
module. Although you can apply configuration to the templates in the
same way as you can to assets, templates do not collect data.
If the applications and templates are a part of an imported application,
you should not change any aspect of the configuration without
understanding how this affects data collection as it relates to the
purpose of the application. In a practical sense, you should only make
changes to a template item if absolutely necessary.
Icons Used in the Main Grid
Each collection category and its respective data items are represented
in Data Collection Configuration through the use of icons. With the
exception of Variables, the icon used to represent the collection
category is also used to represent the data items. For example, an
incident definition has the same icon as an incident category. Variables
rely on Event definitions, for which several icons are used.
These icons appear in the grid and the Collection Configuration
(secondary) frame. They provide an easy way to recognize the kind of
data being represented; slight variations to the icons indicate the
status of the item. The icons that appear in the Global Collection
Configuration frame are very similar, but they do not have the
variations that occur at the local level.
Greyed-out icons. A greyed-out icon means that a particular data
item is inactive. For example, the lights in the traffic signals for
Asset States are only illuminated if the asset state is active.
Background color. The background color may indicate that an
item has been defined locally, rather than through the Object
Library. For example, an incident data item defined at the local
level has a yellow background.
Overlaid letters and numbers. Icons may have a letter or
number overlaid to indicate a special condition. For example, the
icon for a Retro Stop enabled incident category has a red R
superimposed on the lower left corner.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-10
Table 7-1 Icons used in the grid
Icon Description
Collection categories Appears beside each of the defined collection categories if
you select the Object Library in the Plant Hierarchy frame,
and the Collection Categories item in the Global Collection
Configuration frame. All categories have the same icon at
this level.
Accumulator categories
and data items
Appears adjacent to each accumulator collection category
item and accumulator data item that appears in the grid.
The icon represents accumulators at both the global and
local levels.
Incident categories and
data items
Appears adjacent to each incident category item or each
incident data item. This icon represents incident
categories and incident definitions at the local and global
levels, and incident sub-categories and incident
sub-category items if you select an item in the Incident
Configuration (secondary) frame.
Identifier categories
and data items
Appears adjacent to each identifier collection category
item and identifier data item that appears in the grid. The
icon represents identifiers at both the global and local
levels.
Variable categories Appears beside all variable categories defined for use with
an asset.
Event item Appears beside all Event data items at both global and
local levels.
Variable (Alphanumeric) Appears at the local level to indicate that an Event is
alphanumeric. Note the red letter A.
Variable (Numeric) Appears at the local level to indicate that an Event is
numeric. Note the blue number 1.
Asset States and data
item
Appears in the grid at both the global and local levels.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-11
Saving Time in Configuring Data Items
Configuring data items is one of the more detailed tasks that you have
to perform in AppCenter. You can save time in several ways, such as:
When you are creating global data items, consider copying and
pasting items, then editing only the details that differ.
You can import data items from applications such as from Excel, or
from a text file. Detailed information on importing and exporting
from/to Excel is available from Activplant Support.
Create all the global items first. These are the ones that you will
use over and over again in different assets.
Dont create many assets. Create one template asset first, and
configure the data items for it, as well as the other data types that
are not mentioned in this chapter (such as calculations, see
Formulas, Calculation Templates, and Calculations on page 8-2
beginning). Then copy and paste this asset to different parts of the
plant hierarchy. If you do this you only have to edit a few details,
such as the memory addresses, for each copy.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-12
Categories, Collection Methods, and
ActivEssentials
Before you define the data items that will be collected by
ActivEssentials, you have to create the global categories into which the
data items will be grouped. These are defined at the global level and
reused in various assets.
ActivEssentials uses several different methods to collect data items.
These are referred to as collection methods. Each data item category
that you create uses one collection method. The methods are
described in more detail in this section.
You also need to define the asset states that you will collect. Typical
states are Running, Faulted, Idle, etc.
This section covers the following topics:
Creating a Collection Category on page 7-12
Copying Categories Between Assets on page 7-14
Viewing and Editing Category Properties on page 7-15
Deleting a Data Collection Category on page 7-16
ActivEssentials Collection Methods on page 7-17
Merging Incidents and Identifiers on page 7-17
Creating a Collection Category
Use the instructions below to create a new collection category for data
items. You must create collection categories before creating data
items.
Categories are global items that will be reused in different assets.
They are your link to the collection methods that ActivEssentials uses
to collect the data items that belong to each category. When you
create categories you can give them any name you want, but you
cannot have two categories with the same name and collection
method.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Data Collection Configuration task
module using the instructions in Opening the Data Collection
Configuration Module on page 7-3.
Read ActivEssentials Collection Methods on page 7-17.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-13
Procedure
1 In the Plant Hierarchy frame, select the Object Library.
The Global Collection Configuration frame opens in the secondary
frame.
2 In the Global Collection Configuration frame, select the
Collection Categories icon.
The grid displays any categories that have been previously defined.
3 Click the New button on the toolbar.
The Add New Collection Category wizard starts.
4 Click Next to move past the welcome page.
The Name and Description page of the wizard opens.
5 On the Name and Description page, do both of the following:
a) In the Name field, type a name for the category (up to 50
characters, spaces are allowed), and
b) In the Description field, if desired, type a description (up to 255
characters).
6 Click Next.
The Collection Category Properties page of the wizard opens.
Figure 7-4 The Collection Category Properties page of the wizard
7 Click the drop-down arrow beside the Collection Method field and
select the collection method that this category will use.
8 If you are collecting data using VPCollector (as is usually the case),
choose VPCollector in the Collection Engine field; otherwise
choose Other.
Note: The following are illegal characters that you cannot use when creating names
in ActivEssentials: . ( ). For more information, see Illegal Characters on page
1-17.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-14
9 If you chose anything other than Incident as the collection method,
go to Step 11.
10 If you chose Incident as the collection method, do the following:
a) Check the appropriate checkboxes if you want the items in this
category to be editable and/or viewable in VPWeb.
b) If you want to allow merging or duplicate incidents, check the
Merge identical incidents checkbox and enter a value
(seconds) for the Allowed Gap. See Merging Incidents and
Identifiers on page 7-17 for more information about these
options.
c) If you want to enable acknowledgment of incidents in this
category, check the Acknowledgment required checkbox.
11 If you want the category to be active, select the Active checkbox.
12 Click Next.
The final page of the wizard opens.
13 Review the definition and then click Finish.
Copying Categories Between Assets
Use the instructions below to copy collection categories from one asset
to another. This is useful if you want to avoid configuring categories for
several different assets. Define the categories on one asset, then copy
them to other assets. (To save even more time, define a single asset
completely, then copy the asset itself.)
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Data Collection Configuration task
module using the instructions in Opening the Data Collection
Configuration Module on page 7-3.
Procedure
1 In the Plant Hierarchy frame, expand the hierarchy and then
select the asset whose category you need to copy.
2 In the Data Collection Configuration frame, click the Collection
Categories entry.
The grid displays the categories belonging to the asset.
3 Right-click the category in the grid and select Copy.
4 In the Plant Hierarchy frame, navigate to the asset to which you
want to copy the category, and select it.
5 In the Data Collection Configuration frame, select the
Collection Categories option.
6 Right-click in the grid and select Paste.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-15
7 Edit the details of the copied category as necessary.
Viewing and Editing Category Properties
Use the instructions below to view or edit the properties of a data
collection category. You can edit some properties of a category by
clicking in the grid and editing there. For other properties you have to
open the Properties dialog box.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Data Collection Configuration task
module using the instructions in Opening the Data Collection
Configuration Module on page 7-3.
Read ActivEssentials Collection Methods on page 7-17.
Procedure
1 In the Plant Hierarchy frame, select the Object Library.
The Global Collection Configuration frame opens in the
secondary frame area.
2 In the Global Collection Configuration frame, click the
Collection Categories icon.
The grid displays any categories that have been previously defined.
3 Right-click the category in the grid and select Properties.
Figure 7-5 Collection category Properties dialog box
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-16
4 In the Properties dialog box, make the desired changes and then
click OK.
Deleting a Data Collection Category
Use the instructions below to delete a data collection category.
Prerequisites
Before doing this you need to have done or read the following:Before
starting this you need to have done the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Data Collection Configuration task
module using the instructions in Opening the Data Collection
Configuration Module on page 7-3.
Procedure
1 In the Plant Hierarchy frame, select the Object Library.
The Global Collection Configuration frame opens in the secondary
frame area.
2 In the Global Collection Configuration frame, select the
Collection Categories icon.
The grid displays any categories that have been previously defined.
3 Right-click the category in the grid and select Delete.
A confirmation dialog box opens.
4 Click OK.
Warning! When you delete a category, all the data items that belong to the category
are also deleted, along with all historical data belonging to those items.
Consider whether you should inactivate the category instead of deleting it.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-17
ActivEssentials Collection Methods
ActivEssentials uses five collection methods to collect data. These
methods cover all the data types that you can collect. The collection
methods are:
Accumulators. These are items that increment over time, such as
counters and timers.
Asset States. These are the current state of the assetfor
example, Running, Faulted, Idle, etc.
Events. These are items that are collected as a snapshot value,
and are commonly used to create graphs against timefor
example, temperature, pressure, cycle time, etc.
Identifiers. These are items that identify parts in relation to a
period of time. Typical identifiers are: Serial Number, Batch
Number, etc.
Incidents. These items have a start time and an end time, and
therefore they have a duration. This method is typically used to
collect faults, warnings, etc.
Every data item that you collect will use one (and only one) of these
methods. It is important to understand that many items could use
more than one method, and the choice of method is something that
you have to determine before you begin configuring the data items.
Merging Incidents and Identifiers
When an incident (such as a fault) begins, or an identifier value
changes, VPCollector records the incident type or identifier value along
with the start time, and creates a new database record. When the
incident closes, or the identifier value changes again, the record is
closed.
Sometimes there may be an interruption in data collectionfor
example, if connectivity is lost or VPCollector is refreshed. In this case
the database closes the incident or identifier record. When connectivity
is restored, if the incident is still open, or the identifier value is still the
same as before, there may be consecutive database records for the
same incident or identifier. These records may well have different
timestamps, depending on the way the OPC server handles this
situation. In practice, different OPC servers (and even different
versions of the same OPC server) handle interruption to data collection
differently.
To avoid storage of two or more records where there should only be
one, you can use the Merge Identical Incidents/Merge Values and
Allowed Gap parameters when creating an incident category or when
creating an individual identifier (note that these parameters are the
Note: For detailed information about ActivEssentials collection methods, see the
System Configuration Guide (System Configuration Guide.pdf), which is in
your ActivEssentials installation package.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-18
same for both, but the location is different). This option is not available
for other types of category. For identifiers, only non-unique identifiers
can be merged.
The Merge and Allowed Gap parameters act together.
The Allowed Gap is the allowed difference (in seconds) between the
end of the first record and the beginning of the second record. If
the difference is less than the allowed gap the records will be
merged. If the difference is more than the allowed gap the records
will not be merged.
The Merge Identical Incidents checkbox (for identifiers it is
called Merge Values) determines whether consecutive records with
the same value will ever be merged into one. If the option is not
selected, records will not be merged.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-19
Creating Global Accumulators, Incidents, and
Variables
Many data items are collected by several assets throughout the data
collection system. So instead of defining the same item over and over
for different assets, you define data items on a global level and then
apply them to the relevant assets. You can define an item on a specific
asset instead of defining it at the global level, but such a local item is
only available to that one asset.
You create data items in accordance with the collection method
(Accumulators, Incidents, Events, or Identifiers) that the item will use.
The process is similar for each collection method. You have to decide
which data category the data item will belong to; categories are
previously defined and have a collection method assigned to them.
For more information on collection methods, see ActivEssentials
Collection Methods on page 7-17. For information on data collection
categories, see Creating a Collection Category on page 7-12.
Identifier definition is covered in Defining Global Identifiers on page
7-42 beginning.
This section covers the following topics:
Resetting VPServer on page 7-19
Creating a Global Accumulator Item on page 7-20
Creating a Global Incident Item on page 7-22
Creating a Global Event Variable Item on page 7-25
Viewing and Editing Accumulator, Incident, and Variable Properties
on page 7-27
Deleting Global Data Items on page 7-28
Resetting VPServer
Use the instructions below to reset VPServer. The VPServer application
provides a means of exposing the data collected by ActivEssentials to
both third-party applications and the Activplant Real-Time Logic Engine
(RTLE). If you are not using your data in this way, you do not need to
Note: Data item names must be unique within a category; you cannot have two items
with the same name in the same category. For accumulators and identifiers
you can use a name only once. For incidents and event variables you can use
the same name in different categories.
Note: There are limits to the number of data items that you can define: (i) You can
define a maximum of 10 000 accumulators per VPCollector. If you need more
than this, use more than one instance of VPCollector. (ii) An individual asset
can have up to 1125 event variables defined. Exceeding this amount places too
great a demand on VPCollector.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-20
perform this task. You need to reset VPServer only if you have made
changes to the configuration of the assets in your plant hierarchy, in
either the Data Collection Configuration or Calculations task modules.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
Procedure
1 In the Plant Hierarchy frame, select the top level item in the tree
(your plant).
The Reset VPServer button on the toolbar becomes enabled.
2 Click the Reset VPServer button.
Figure 7-6 The confirmation dialog box
3 Click OK.
Figure 7-7 Confirmation of reset message
Creating a Global Accumulator Item
Use the instructions below to create a global accumulator data item
that you can use with any asset.
Note: When you reset VPServer, you interrupt the flow of data to any clients. This
does not cause any data loss, but it does delay the presentation of data in
client applications. Resetting VPServer is global as it causes a reload of the
entire plant configuration. For this reason, you should reset VPServer only after
completing all configuration changes.
Note: After completing this task, you might need to reset VPServer. See Resetting
VPServer on page 7-19 for more information.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-21
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Data Collection Configuration task
module using the instructions in Opening the Data Collection
Configuration Module on page 7-3.
Created a data category that uses the Accumulator method using
the instructions in Creating a Collection Category on page 7-12.
Procedure
1 In the Plant Hierarchy frame, select the Object Library.
2 In the Global Collection Configuration frame, select the
Accumulators button.
3 On the toolbar, click the New button.
The Add New Accumulator Definition wizard starts.
4 Click Next to move past the welcome page.
Figure 7-8 New Accumulator Definition wizard
5 Type a unique name (up to 50 characters) for the data item, and, if
desired, type a description (up to 255 characters).
6 Click Next.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-22
Figure 7-9 The Accumulator Definition Properties page of the wizard
7 Do each of the following:
a) Click the down-arrow by the Accumulator Type field and
select either Counters or Timers.
b) Click the down-arrow by the Collection Category field and
select a category from the list.
c) If you want the data item to be active, ensure the Active
checkbox is checked.
8 Click Next.
The final page of the wizard opens.
9 Review the definition and click Finish.
Creating a Global Incident Item
Use the instructions below to create a global incident data item that
you can use with any asset.
Note: After completing this task, you might need to reset VPServer. See Resetting
VPServer on page 7-19 for more information.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-23
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Data Collection Configuration task
module using the instructions in Opening the Data Collection
Configuration Module on page 7-3.
Created one or more data categories that use the Incidents
method using the instructions in Creating a Collection Category on
page 7-12.
Procedure
1 In the Plant Hierarchy frame, select the Object Library.
2 In the Global Collection Configuration frame, select the
Incidents button.
3 On the toolbar, click the New button.
The Add New Incident Definition wizard starts.
4 Click Next to move past the welcome page.
Figure 7-10 The Add New Incident Definition wizard
5 Type a unique name (up to 50 characters) for the data item, and, if
desired, type a code (up to 50 characters).
Note: Do not use the pipe (|) or ampersand (&) characters in the names of incident
descriptions, as these prevent incidents from appearing in Detailed View.
These restrictions are in addition to the Illegal Characters on page 1-17 listed.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-24
Figure 7-11 Incident definition collection categories
6 Click Next.
The Incident Definition Properties page of the wizard opens.
7 Click the down-arrow by the Collection Category field and select
a category from the list.
8 If the new item is to be the Retro Stop incident definition, select
the Set as Retro Stop incident checkbox.
Figure 7-12 Incident Definition Properties wizard with Retro Stop checkbox
Note: You can only set one incident definition as the Retro Stop incident. If you try to
create a second Retro Stop incident you will receive an error from the
database, even if the incident definition is inactive.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-25
9 If you want the data item to be active, ensure the Active checkbox
is checked.
10 Click Next.
The final page of the wizard opens.
11 Review the definition and click Finish.
Creating a Global Event Variable Item
Use the instructions below to create a global event variable data item
that you can use with any asset. Event variables can be either numeric
or alphanumeric.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Data Collection Configuration task
module using the instructions in Opening the Data Collection
Configuration Module on page 7-3.
Created one or more data categories that use the Events method
using the instructions in Creating a Collection Category on page
7-12.
Procedure
1 In the Plant Hierarchy frame, select the Object Library.
2 In the Global Collection Configuration frame, select the Variables
button.
3 On the toolbar, click the New button.
The Add New Variable Definition wizard starts.
4 Click Next to move past the welcome page.
Note: After completing this task, you might need to reset VPServer. See Resetting
VPServer on page 7-19 for more information.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-26
Figure 7-13 The Name and Description page of the wizard
5 Type a unique name (up to 50 characters) for the data item, and, if
desired, a description (up to 255 characters).
6 Click Next.
The Variable Definition Properties page of the wizard opens.
Figure 7-14 The Variable Definition Properties wizard page
7 Do each of the following:
a) Click the down-arrow by the Variable Type field and choose
either numeric or alphanumeric.
Note: Do not use the word Quality as a variable name. This can cause a conflict as
your OPC server might reserve the name for its use. If you do, VPWeb might
not display related data because it would be unable to present a column called
Quality in Detailed View.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-27
b) Click the down-arrow by the Collection Category field and
choose the category to which the item will belong.
c) If you want the data item to be active, ensure the Active
checkbox is checked.
8 Click Next.
The final page of the wizard opens.
9 Review the definition and click Finish.
Viewing and Editing Accumulator,
Incident, and Variable Properties
Use the instructions below to view or edit the properties of a data item
belonging to the Accumulators, Incidents, or Event Variable type. You
can edit some properties of an item by clicking in the grid and editing
there. For other properties you have to open the Properties dialog
box.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Data Collection Configuration task
module using the instructions in Opening the Data Collection
Configuration Module on page 7-3.
Procedure
1 In the Plant Hierarchy frame, select the Object Library.
2 In the Global Collection Configuration frame (depending on
which you need to view), click the Accumulators, Incidents, or
Variables icon.
The grid refreshes to display the data items that have been
previously defined.
3 Right-click on the data item in the grid and select Properties.
Note: After completing this task, you might need to reset VPServer. See Resetting
VPServer on page 7-19 for more information.
Warning! If the item you need to edit is a global variable definition, you should not
change the type. The Type drop-down list gives you the option to change
the variable type from numeric to alphanumeric, or vice versa. However, if
you do this all variable items that use the definition are deleted without
warning.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-28
Figure 7-15 Viewing global data item properties
4 In the Properties dialog box, make the desired changes, then click
OK.
Deleting Global Data Items
Use the instructions below to delete a global data item. Before you do
this, read the caution below.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Data Collection Configuration task
module using the instructions in Opening the Data Collection
Configuration Module on page 7-3.
Created a global data item. See Creating a Global Accumulator
Item on page 7-20, Creating a Global Incident Item on page 7-22,
or Creating a Global Event Variable Item on page 7-25.
Warning! When you delete a data item, all other definitions that refer to the data item
are also deleted, along with all historical data for the item. Consider
whether you should inactivate the item instead of deleting it.
Note: After completing this task, you might need to reset VPServer. See Resetting
VPServer on page 7-19 for more information.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-29
Procedure
1 In the Plant Hierarchy frame, select the Object Library.
2 In the Global Collection Configuration frame (depending on
which you need to view), click the Accumulators, Incidents, or
Variables icon.
The grid refreshes to display the data items that have been
previously defined.
3 Right-click the data item in the grid and select Delete.
A confirmation dialog box opens.
4 Click OK.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-30
Incident Sub-Categories
ActivEssentials allows you to assign your incidents to sub-categories,
allowing greater refinement in the treatment and display of incident
codes. For example, you can classify incidents into those that originate
from specific devices, then in VPWeb you can restrict your display to
incidents that originate from a particular device.
To use this functionality you have to define incident sub-categories,
and items that belong to each sub-category. You then link the incident
codes to the sub-categories and items.
This section covers the following topics:
Creating an Incident Sub-Category on page 7-30
Viewing and Editing Sub-Category Properties on page 7-31
Copying an Incident Sub-Category on page 7-32
Deleting an Incident Sub-Category on page 7-33
Creating an Incident Sub-Category Item on page 7-33
Viewing and Editing Sub-Category Item Properties on page 7-34
Creating an Incident Sub-Category Item on page 7-33
Deleting an Incident Sub-Category Item on page 7-36
Assigning Sub-Categories to Incident Categories on page 7-36
Linking the Incident Sub-Category at the Asset Level on page 7-38
How Incident Sub-Categories Work on page 7-40
Creating an Incident Sub-Category
Use the instructions below to create an incident sub-category.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Data Collection Configuration task
module using the instructions in Opening the Data Collection
Configuration Module on page 7-3.
Created an incident category using the instructions in Creating a
Global Incident Item on page 7-22.
Read How Incident Sub-Categories Work on page 7-40.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-31
Procedure
1 In the Plant Hierarchy frame, select the Object Library.
2 In the secondary frame area, click the Incident Configuration
category button.
3 In the Incident Configuration frame, click the Sub-Categories
icon.
The grid displays any sub-categories that you have defined
already.
4 On the New row in the grid, do each of the following:
a) Double-click in the cell in the Name column and type a name
for the sub-category, and
b) Double-click in the cell in the Description column and type a
description.
5 Click anywhere in the grid to save the new sub-category.
Viewing and Editing Sub-Category
Properties
Use the instructions below to view or edit the properties of an incident
sub-category. You can also edit directly in the grid by clicking or
double-clicking there.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Data Collection Configuration task
module using the instructions in Opening the Data Collection
Configuration Module on page 7-3.
Created an incident sub-category using the instructions in Creating
an Incident Sub-Category on page 7-30.
Note: There is no wizard for sub-categories because they only have two properties.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-32
Procedure
1 In the Plant Hierarchy frame, select the Object Library.
2 In the secondary frame area, click the Incident Configuration
category button.
3 Click the Sub-Categories icon in the Incident Configuration
frame.
The grid displays any sub-categories that you have defined
already.
4 Do the following, as needed:
a) If you want to change the name of the sub-category,
double-click on the name in the grid, and edit directly.
b) If you want to change the sub-category description,
double-click on the description in the grid, and edit directly.
5 Click anywhere in the grid to save your changes.
Copying an Incident Sub-Category
Use the instructions below to copy an incident sub-category. You can
copy the sub-category to the same grid.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Data Collection Configuration task
module using the instructions in Opening the Data Collection
Configuration Module on page 7-3.
Created an incident sub-category using the instructions in Creating
an Incident Sub-Category on page 7-30.
Procedure
1 In the Plant Hierarchy frame, select the Object Library.
2 In the secondary frame area, click the Incident Configuration
category button.
3 Click the Sub-Categories icon in the Incident Configuration
frame.
The grid displays any sub-categories that you have defined
already.
4 Right-click on the sub-category in the grid and select Copy.
5 Right-click anywhere in the grid and select Paste.
Note: When you paste the copy, the name of the new item is the same as the original
name, and prefixed with the term Copy of. You can edit the name by
double-clicking on it and editing it directly.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-33
Deleting an Incident Sub-Category
Use the instructions below to delete an incident sub-category.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Data Collection Configuration task
module using the instructions in Opening the Data Collection
Configuration Module on page 7-3.
Created an incident sub-category using the instructions in Creating
an Incident Sub-Category on page 7-30.
Procedure
1 In the Plant Hierarchy frame, select the Object Library.
2 In the secondary frame area, click the Incident Configuration
category button.
3 Click the Sub-Categories icon in the Incident Configuration
frame.
The grid displays any sub-categories that you have defined
already.
4 Right-click the sub-category in the grid and select Delete.
Figure 7-16 Confirmation message
5 Click OK.
Creating an Incident Sub-Category Item
Use the instructions below to create an incident sub-category item.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Data Collection Configuration task
module using the instructions in Opening the Data Collection
Configuration Module on page 7-3.
Created an incident sub-category using the instructions in Creating
an Incident Sub-Category on page 7-30.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-34
Procedure
1 In the Plant Hierarchy frame, select the Object Library.
2 In the secondary frame area, click the Incident Configuration
category button.
3 Click the Sub-Category Items icon in the Incident
Configuration frame.
The grid displays any sub-category items that you have defined
already.
4 On the New row in the grid, do each of the following:
a) Double-click in the cell in the Name column and type a name
for the sub-category, and
b) Click in the cell in Sub-Category column, then click the
down-arrow that appears and choose the sub-category to which
the item should belong.
c) Double-click in the cell in the Description column and type a
description.
5 Click anywhere else in the grid to save your changes.
Viewing and Editing Sub-Category Item
Properties
Use the instructions below to view or edit the properties of an incident
sub-category item. You can also edit directly in the grid by clicking or
double-clicking there.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Data Collection Configuration task
module using the instructions in Opening the Data Collection
Configuration Module on page 7-3.
Created an incident sub-category item using the instructions in
Creating an Incident Sub-Category Item on page 7-33.
Procedure
1 In the Plant Hierarchy frame, select the Object Library.
2 In the secondary frame area, click the Incident Configuration
category button.
Note: There is no wizard for sub-categories because they only have three properties.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-35
3 Click the Sub-Category Items icon in the Incident
Configuration frame.
The grid displays any sub-category items that you have defined
already.
4 Do the following, as needed:
a) If you want to edit the name of sub-category item, double-click
the name in the grid, and edit directly.
b) If you want change the sub-category associated with a
sub-category item, click in the Sub-Category column, click the
down-arrow and choose a new sub-category to which the item
will belong.
c) If desired, double-click in the Description column to edit or
add a description.
5 Click anywhere else in the grid to save your changes.
Copying an Incident Sub-Category Item
Use the instructions below to copy an incident sub-category item. You
can copy the sub-category item within the same grid.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Data Collection Configuration task
module using the instructions in Opening the Data Collection
Configuration Module on page 7-3.
Created an incident sub-category item using the instructions in
Creating an Incident Sub-Category Item on page 7-33.
Procedure
1 In the Plant Hierarchy frame, select the Object Library.
2 In the secondary frame area, click the Incident Configuration
category button.
3 Click the Sub-Category Items icon in the Incident
Configuration frame.
The grid displays any sub-category items that you have defined
already.
4 Right-click on the sub-category item in the grid and select Copy.
5 Right-click anywhere in the grid and select Paste.
Note: There are only three properties associated with an incident sub-category item
and all of them are visible "in the grid. If you want to edit the properties, you
can do so directly in the grid.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-36
Deleting an Incident Sub-Category Item
Use the instructions below to delete an incident sub-category item.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Data Collection Configuration task
module using the instructions in Opening the Data Collection
Configuration Module on page 7-3.
Created an incident sub-category item using the instructions in
Creating an Incident Sub-Category Item on page 7-33.
Procedure
1 In the Plant Hierarchy frame, select the Object Library.
2 In the secondary frame area, click the Incident Configuration
category button.
3 Click the Sub-Category Items icon in the Incident
Configuration frame.
The grid displays any sub-category items that you have defined
already.
4 Right-click on the sub-category item in the grid and select Delete.
Figure 7-17 Confirmation message-box
5 Click OK.
Assigning Sub-Categories to Incident
Categories
Use the instructions below to create a link between incident
sub-categories and incident categories.
For example, if you want to filter faults according to the devices from
which they come, you enable this by linking the Faults data collection
category with the Devices sub-category. You can link as many
categories and sub-categories as you want, and the sub-categories will
Note: When you paste the copy, the name of the new item is the same as the original
name, and prefixed with the term Copy of. You can edit the name by
double-clicking on it and editing it directly.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-37
then be available for filtering in VPWeb. After you have done this you
must also link individual incident descriptions to the sub-category at
the asset level. (see Linking the Incident Sub-Category at the Asset
Level on page 7-38.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Data Collection Configuration task
module using the instructions in Opening the Data Collection
Configuration Module on page 7-3.
Created an incident sub-category item using the instructions in
Creating an Incident Sub-Category Item on page 7-33.
Procedure
1 In the Plant Hierarchy frame, select the Object Library.
2 In the secondary frame area, click the Global Collection
Configuration category button.
3 In the Global Collection Configuration frame, click the
Collection Categories button.
The grid displays the categories that you have already created.
4 In the grid, right-click on the incident category to which you need
to assign sub category and select Properties.
Figure 7-18 The Incident Properties dialog box
5 In the Properties dialog box, click the Links tab.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-38
6 On the Links page, do each of the following
a) On a new row select the checkbox in the Make Link column.
b) Click the cell in the Sub-Category column, then click the
down-arrow that appears and select the incident sub-category
from the drop-down list.
c) Ensure the Active checkbox is selected.
7 Click OK to save the link.
Linking the Incident Sub-Category at the
Asset Level
Use the instructions below to link an incident at the asset level with an
incident sub-category.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Data Collection Configuration task
module using the instructions in Opening the Data Collection
Configuration Module on page 7-3.
Create an incident sub-category item using the instructions in
Creating an Incident Sub-Category Item on page 7-33.
Procedure
1 In the Plant Hierarchy frame, navigate to and select the asset
which you need to add a sub-category.
2 In the Collection Configuration frame, expand the Collection
Categories folder until you can see the incident category that
requires a link, and select it.
The incidents belonging to the category are displayed in the grid.
3 In the grid, right-click on the incident description, and choose
Properties.
Note: If you remove the checkmark from the Make Link checkbox, you will discard
the link altogether.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-39
Figure 7-19 Selecting an incident for linking at the asset level
Figure 7-20 The Properties dialog box
4 In the Properties dialog box, click the Links tab.
5 On the Links page, do each of the following:
a) Select the checkbox to make the link active.
b) Click the cell in the Category column, click the down-arrow
that appears, and then select an incident sub-category from
the drop-down list.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-40
Figure 7-21 Selecting the incident sub-category
c) Click the cell in the Item column, click the down-arrow that
appears, and then select an item from the drop-down list.
The incident description is now linked to the incident sub-cate-
gory on this asset.
6 Click OK.
How Incident Sub-Categories Work
As part of the data collection configuration you will have created one
or more categories of incidents, such as a Faults category or an Alarms
category. You can also create sub-categories of incidents in the
Incident Configuration module. When you create a sub-category, you
should also add sub-category items to it, as sub-categories have no
purpose without sub-category items.
Example
In your data collection system you have hundreds of incident data
items, each one with a description. You know that some of the
incidents are related to particular devices; for example, some faults
originate from Pump A.
You create a sub-category called Devices, and a sub-category item
Pump A. You also create further sub-category items for other pumps,
valves, motors, etc.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-41
Incident Sub-Category Links
In order for incident sub-categories to have any use, they need to be
linked to both an incident sub-category item, such as a pump, and to
an incident category. They must also be linked on the asset level so
that incidents that occur on the asset are assigned to the desired
sub-category.
Incident sub-categories represent a finer definition of incident
categories, as they relate to a class of incidents at a lower level than
the global definitions normally defined in ActivEssentials.
Incident sub-categories sit in between the global definition of an
incident and the sub-category items where incidents occur. For further
information on the creation and use of incident sub-category links, see
Assigning Sub-Categories to Incident Categories on page 7-36.
Note: You can use incident sub-categories in the real-time data viewer in Layout View
of VPWeb. The viewer allows you to specify the sub-category for which you
want to view the incidents. If you wanted, you could create a different viewer for
each sub-category and assign a different color to each viewer, depending on
which sub-category generated the incident. See the VPWeb User Guide,
which is located in the installation package.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-42
Defining Global Identifiers
Identifiers are items that define identifiable periods during production
when, for example, a Batch Number or Serial Number was currently in
process. As such, they have a time dimension because they relate to a
particular time when the plant or line was producing the identified
parts. Data collected about these identifiable periods use the
Identifiers collection method, which you define in much the same way
as accumulators, incidents, and variables. However, identifiers have
some extra properties, so they require further explanation.
Non-unique identifiers can contain a variety of attributes: those
assigned during the initial definition of the identifier, others that form
part of the extended properties, and yet others that provide identifier
values. Unique identifiers contain just those assigned during their
initial defintion, and then only a limited subset of what is available to a
non-unique identifier. This documentation provides information about
each the attributes you might encounter as you fully define both
unique and non-unique identifiers.
This section covers the following topics:
Attributes Defined When Creating a New Identifier Definition on
page 7-43
Identifier Values and Auto-Insert on page 7-44
Attributes Defined as a part of an Extended Property on page 7-45
Attributes Defined as Identifier Values on page 7-48
Viewing and Using Identifier Properties on page 7-51
Creating a Global Identifier on page 7-52
Viewing and Editing Identifier Definitions on page 7-54
Creating and Editing Identifier Extended Properties on page 7-55
Creating Identifier Values on page 7-58
Viewing and Editing Identifier Values on page 7-65
Creating New Identifier Values from Existing Values on page 7-66
Copying the Extended Properties of One Identifier Value to Another
on page 7-68
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-43
Attributes Defined When Creating a New
Identifier Definition
In most instances, to create a new non-unique identifier you run the
Add New Identifier Definition wizard. As you use the wizard, you
encounter the following:
Name. This is the name you assign to the identifier. As such, the
name should be indicative of its purpose.
Description. While not required, you can provide a description of
the purpose of the identifier.
Identifier type. The options are Unique and Non-unique.
Non-unique is the default option, but if you choose Unique, only
Active of the following options applies.
Collection categories. You have the choice of using All of the
identifier collection categories, or selecting a particular identifier
collection category from a drop-down list.
Unknown value. This option is designed to cover circumstances
when the PLC is unable to provide the required identifier value. For
such instances, the PLC should be programmed to return a
particular value, which you assign as the Unknown value.
Enable automatic insertion of values. Where the PLC can
return identifier values, this option allows for their automatic
insertion into the database. Before enabling this option, you should
consider the range of values the PLC could return and whether all
of these values are of concern when collecting such data. If some
values are likely to be invalid, disable this option and then define
as identifier values all values that are legitimate.
Merge identical values. If the PLC returns the same identifier
value two or more times in sequence, the question becomes;
should these instances be merged to create one instance? Select
this option if you want to merge identical values.
For more information, see Merging Incidents and Identifiers on
page 7-17.
Allowed gap. If identical values should be merged, this provides a
maximum interval between the instances. If the instances exceed
the gap, they are treated separately.
Active. Selecting this option ensures that the identifier definition is
available for use.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-44
Figure 7-22 The Identifier Definition Properties page
Identifier Values and Auto-Insert
Identifiers have values that change from time to time. For example, a
Part Number identifier may have values such as 00033, 20243, etc.
There are two ways to create identifier values: you can create them
yourself, or you can allow ActivEssentials to create them by using the
Auto-Insert option.
Non-unique identifiers have a property called Enable automatic
insertion of values (Auto-Insert). If you choose the Auto-Insert
option, all values for the identifier coming from the PLC are
automatically added to the database and are visible in VPWeb. If you
do not choose this option, when an identifier value changes the
database looks up the new value in a lookup table (this is the table of
values that you create manually). If the value exists in the lookup
tablein other words, you have already created the value yourself
the value is inserted in the database; if it does not exist, the previous
identifier value is terminated but the current value is not stored and
does not appear in VPWeb.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-45
Attributes Defined as a part of an
Extended Property
When creating or editing identifier extended properties, you can
choose from several property types, and then assign additional
attributes that are appropriate to that type. You can add as many
extended properties, of any type, as you need.
Name. This is the name of the extended property.
Description. If necessary, enter a description of the purpose of
the extended property.
Type. The extended property type controls what kind of additional
attributes you can assign to the property, so you must choose this
before assigning any of the subsequent attributes.
Boolean. The Boolean property type allows you to require a
TRUE or FALSE response from users in VPWeb. Once selected,
you can only define a Default value (TRUE or FALSE), which the
user can change.
Currency. If your extended property is to relate to monetary
measures, such materials costs, you can set a currency unit
and a format to use in the measure.
Tip: If you need to use a currency symbol, set it up in the
Units sub-module of the Sytem Settings module.
Date-Time. Use this option if the extended property should be
assigned by time defined parameters.
Editable Single Selection. This option allows a user to select
from a predefined list of options, but if the options do not cover
the situation, the user can edit the list by adding a new option.
When selecting this type of extended property, you must
compile the list of predefined options.
Numeric. This extended property type allows for the handling
of identifier values that are numeric, such as all numeric serial
numbers.
Single Selection. The Single Selection type works in almost
the same way as the Editable Single Selection type, except that
the user is not able to edit the predefined list. As you prepare
the list, try to cover all eventualities.
Text. This type allows users to enter text. The maximum
allowable number of characters is 255.
Text Area. This type works in the same way as the Text type,
except that it allows the user more room type characters.
However, the maximum allowable number of characters is the
same as the Text type, at 255.
Unit. If using the Currency or Numeric extended property types,
you can nominate the unit of measurement. To assign a unit, you
need to ensure that the measure has been defined in
ActivEssentials. You do this in the Units sub-task of the System
Settings module.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-46
For more information, see Units of Measurement and Number Formats
on page 2-11.
Format. The Format option takes its focus from the selected
extended property type, as formatting options may or may not be
available, and can vary in instances where they are allowed.
Formatting options are available in the following:
Boolean. The one option is True/False, which is used in
conjunction with a default value set to one or other condition.
Currency. You can use a variety of numbering formats that
vary the display of the values by the number of places of
decimal, up to five.
Date-Time. You can use any of many formatting options to
describe the date and time, such as day-month-year,
month-day-year, and year-month-day, and compound these
options with a variety of time of day formats.
Numeric. The numeric formatting options are the same as
those available to the Currency type.
Min value. The Min value option can be used in conjunction with
the Max value option, where they describe a range of observed
values. Their use is available with the following:
Currency. The value describes a minimum value.
Date-Time. The value is a start date and time.
Numeric. The value describes a minimum value.
Max value. The Max value is used in conjunction with the Min
value to define the upper end of the range, and is used with the
same extended property types: Currency, Date-Time, and Numeric.
Note: There is no need to assign both minimum and maximum values, as the range
could be open-ended at one or other ends of the scale. By defining both, you
define an absolute scale, whereas by defining one or the other, you are
defining a limit at only one end of the scale.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-47
Max length. This is used for both the Text and Text Area extended
property types. There is an absolute limit of 255 characters for
both types, but you can set a lower limit if necessary.
Default value. The Default value option is available to all the
extended property types. Some of the property types require you
to set a default, but others do not. However, the nature of these
values must match the kind of property.
Boolean. You must set a default condition of either TRUE or
FALSE.
Currency. You can set a numeric value, but if you have set a
minimum and/or maximum value, the default value must be
valid within these specifications.
Date-Time. The default value must be a calendar date and
time, but if you have set a minimum (start time) and/or
maximum (end time) value, the default value must be valid
within these specifications.
Editable Single Selection. Without editing, the default value
is the first entry you create when defining the list, so you must
deliberately select another item if you need it to be the default.
Numeric. The default value for this property type is defined in
the same way as the Currency type. If you choose to set a
default, it must be valid within the range of any minimum and
maximum values you choose to define.
Single Selection. The default value for this property is set in
the same way as that for an Editable Single Selection. Without
editing, the default value is the first entry you create when
defining the list, so you must deliberately select the item if you
need another item in the list.
Text. If you choose to set a default value, you can type a text
string into the Default value field. Users can then change this
text if necessary.
Text Area. The default value option works in exactly the same
way as it does for the Text type.
Timesensitive. By selecting this checkbox, you indicate that the
extended property is time sensitive, i.e., the value is only valid at a
particular point in time. This attribute is available to all extended
property types.
Active. By selecting this checkbox, you enable the extended
property for use with the identifier item.
You define the extended properties in the Extended Properties dialog
box, which youcan access by identifying the Non-unique identifier in
the grid, and selecting the cell in the Extended Properties column on
the same row to reveal an ellipsis button. Click the ellipsis button to
open the Extended Properties dialog box for the non-unique
identifier.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-48
Figure 7-23 The Extended Properties dialog box
Identifiers are either unique (they occur only once), or non-unique.
Non-unique identifiers have three sets of characteristics: those that
are included in the definition of the identifier, the extended properties
discussed here, and Identifier Values. Unique identifiers have just the
characteristics that form a part of the initial definition of the identifier.
The extended properties you define for non-unique identifiers are
available for use in VPWeb, where users can, if the extended property
has been defined appropriately, edit the default values.
Once defined, extended properties provide the opportunity to broaden
the context to where globally defined identifier items are defined and
used at the local level. These extended properties are available to
users in VPWeb, where they can amend the default properties, if
necessary, using the options you provide when creating the extended
properties.
Attributes Defined as Identifier Values
In order to present information from identifiers in VPWeb in a
meaningful way, you can assign a set of values that manage how their
data are displayed. An identifier allows you to distinguish between
various phases during production, such as a change in the kind of
product being manufactured. In this instance, a change from Product 1
to Product 2 would cause a change in the identifier value, which you
can use to direct VPWeb to display identifier information in different
ways.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-49
You assign identifier values by opening the Identifier Values dialog box
from the grid. In the dialog box, you can assign the following in the
dialog box grid:
Figure 7-24 The Identifer Values dialog box
Value. This is the name of the value that comes from the PLC. You
should create a list of the values that could come from the PLC
Title. If required, you can assign an alias for the value name,
which is then used in VPWeb as an alternative name for the value.
Auto-Title. If you select the Auto-Title option, VPWeb displays the
value name. You cannot also assign a Title; choosing to auto-title
removes a previously assigned title, and vice versa.
Color. When an instance of the value appears in VPWeb, it is
denoted by the color you choose.
Auto-Color. If you select this option, the database chooses the
color to denote the value. If you have chosen a color, this option
then cancels that choice.
Extended Properties. The extended properties are those that you
previously defined for the identifier. However, as there could be
many identifier values, you can assign the options within the
extended properties differently to each value. This gives you
options to treat the different values in separate ways.
Managing Extended Properties with Identifier
Values
If you have two or more identifier values defined against an identifier,
you might need to assign the extended properties to each differently.
The definitions of the extended properties include default values, but
with some extended property types, you can define alternative values.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-50
When defining identifier values, you can edit the way the default
values defined in the extended properties are assigned when particular
values are encountered.
You can reassign the default values in the Extended Property Values
dialog box, which you can access from the Identifier Values dialog box
by first clicking in a cell in the Extended Properties column, and then
clicking the ellipsis button.
Figure 7-25 The Extended Property Values dialog box
The Extended Property Values dialog box shows each of the extended
properties that have been defined for the identifier. Initailly, the grid
shows the default value for the property, but by clicking in the
appropriate cell, you can then edit the value to be used. The values
you assign remain constant until such time that you need to change
them, unless the extended property is time-sensitive.
Managing Time Sensitive Extended Properties
It is possible to build in time-sensitivity into extended properties,
which allows you to develop schemes that change the values defined
in an extended property. This allows, for example, for a (default) value
to be available most of the time, but for that value to change to
something else at specific times and for a specified duration. For
example, a Boolean type extended property could be set to turn FALSE
at predefined times and to return to its TRUE conditions at other
times. Similary, a numeric extended property might change from its
default value to something different for specified time spans.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-51
Figure 7-26 Examples of the Time-sensitive Property Values dialog box
Viewing and Using Identifier Properties
Identifier extended properties and values are viewable in VPWeb, if
defined appropriately. Here is a summary of the rules governing their
display:
Inactive identifiers and/or properties do not appear at all in VPWeb.
If you define an alias for the identifier value, the alias appears in
VPWeb instead of the name.
You cannot edit property values in VPWeb.
Numeric properties and their values are visible in the Production,
Layout, and Detailed views of VPWeb, but not in Trend View.
You can view numeric properties in any of the aggregated forms
available in Production View of VPWeb.
Alphanumeric properties and their values are visible in the Layout
and Detailed views of VPWeb.
You can use numeric identifier properties when creating
calculations.
For more information about the VPWeb views, see the CDC Factory
VPWeb User Guide, which is located in your ActivEssentials installation
package.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-52
Creating a Global Identifier
Use the instructions below to create a global identifier definition in
AppCenter.
Identifiers can be unique or non-unique. A unique identifier is one that
is only used once, such as a serial number. A non-unique identifier is
one that may be used many times, such as a model number.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Data Collection Configuration task module
using the instructions in Opening the Data Collection Configuration
Module on page 7-3.
Read the following:
Merging Incidents and Identifiers on page 7-17
Attributes Defined When Creating a New Identifier Definition on
page 7-43
Procedure
1 In the Plant Hierarchy frame, select the Object Library.
2 In the secondary frame area, click the Global Collection
Configuration category button.
3 In the Global Collection Configuration frame, select the
Identifiers icon.
The list of previously defined identifiers appears in the grid.
4 On the toolbar, click the New button.
The Add New Identifier Definition wizard starts.
5 Click Next to move past the welcome page.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-53
Figure 7-27 The New Identifier Definition wizard
6 Type a unique name (up to 50 characters) for the identifier, and, if
desired, a description (up to 255 characters).
7 Click Next.
Figure 7-28 The Identifier Definition Properties page of the wizard
8 Click the down-arrow by the Identifier Type field and choose
either Unique or Non-unique. Similarly, choose a category from the
Collection Category list.
9 In the Unknown Value field, type the value recorded in the PLC
that means that the identifier value is unknown.
10 If you want the values for this identifier to be automatically
inserted in the database, check the Enable automatic insertion
of values checkbox.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-54
11 If you want records that show identical identifier values to be
merged, select the Merge Identical Values checkbox, and enter
a number (in seconds) for the maximum Allowed Gap between
records in the Allowed Gap field.
12 If you want the identifier to be active, ensure that the Active
checkbox is checked.
13 Click Next.
The final page of the wizard opens.
14 Review the definition, then click Finish to save it.
Viewing and Editing Identifier Definitions
Use the instructions below to view and edit identifier definitions that
you have created.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Data Collection Configuration task
module using the instructions in Opening the Data Collection
Configuration Module on page 7-3.
Created an identifier using the instructions in Creating a Global
Identifier on page 7-52.
Procedure
1 In the Plant Hierarchy frame, select the Object Library.
2 In the secondary frame area, click the Global Collection
Configuration category button.
3 In the Global Collection Configuration frame, select the
Identifiers icon.
The list of previously defined identifiers appears in the grid. Note
that only 30 identifiers appear on one page of the grid.
4 Right-click on the identifier in the grid and select Properties.
Note: This instructional topic refers only to the parameters you set when you defined
the identifier, not to the properties and values that are available in the
Extended Properties and Identifier Values columns.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-55
Figure 7-29 The Identifier Properties dialog box
5 Make the desired changes in the properties, then click OK.
Creating and Editing Identifier Extended
Properties
Use the instructions below to create or edit identifier extended
properties.
Prerequisites
Before doing this you need to have read or done the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Data Collection Configuration task
module using the instructions in Opening the Data Collection
Configuration Module on page 7-3.
Created a global identifier using the instructions in Creating a
Global Identifier on page 7-52.
Read Attributes Defined as a part of an Extended Property on page
7-45.
Note: You can also edit identifier definitions directly in the grid. Click or double-click in
the appropriate column of the grid, and make the desired changes. The
changes will be saved when you click outside the row that you were editing.
Note: When creating a global identifier, the wizard does not ask for extended
properties information.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-56
Procedure
1 In the Plant Hierarchy frame, select the Object Library.
2 In the secondary frame area, click the Global Collection
Configuration category button.
3 In the Global Collection Configuration frame, select the
Identifiers icon.
The list of previously defined identifiers appears in the grid.
4 Click the Extended Properties cell of the same row to reveal the
ellipsis button, then click the ellipsis button.
Figure 7-30 The Extended Properties editor
5 Select the new row in the Extended Properties frame.
6 Click in the Name field and type a suitable name for the extended
property.
Note: Any previously defined extended properties appear in the Extended
Properties section. In the dialog box you can create new extended properties,
or edit or delete any existing extended properties.
Note: If you do not select the new row, any changes you make then apply to the
selected extended property.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-57
7 If neceassry. click in the Description text box and type a
description of the purpose of the extended property.
8 In the Type field, click the down-arrow and select the type of
extended property you need to create from the drop-down list.
Setting up Boolean extended property types
a) In the Default value field, click the down-arrow and select the
default (either True or False).
Setting up Currency or Numeric extended property types
a) To set a currency or measurement unit, click the down-arrow to
open the Unit drop-down list and select the unit you need to
use.
b) To format the number, click the down-arrow to open the
Format drop-down list and select the formatting option you
need.
c) If you need to set a minimum value, click in the Min value field
and type the required value.
d) If you need to set a maximum value, click in the Max value
field and type the required value.
e) Click in the Default value field and type a value that is within
any specified minimum and maximum values.
Setting up Date-Time extended property types
a) To set the formatting for the date and time, click the
down-arrow to open the Format drop-down list and select the
formatting option you need.
b) To set a start time, click the ellipsis button to the right of the
Min value field and select a date and time in the time picker.
c) To set a end time, click the ellipsis button to the right of the
Max value field and select a date and time in the time picker.
d) If required, set a default date and time by clicking the Edit
button to the right of the Default value field and select a date
and time in the time picker that is valid within any selected
start and end times.
Setting up Single Selection or Editable Single Selection extended property
types
To set up a Single Selection or Editable Single Selection type extended
property, do the following:
a) Click the Edit button to the right of the Default value field.
An editor opens where you can define your list.
Note: The steps in the remainder of this procedure depend on the kind of extended
property you chose.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-58
Figure 7-31 The (Editable) Single Selaection list editor
b) In the Add this option field, type the first list option and then
click Add.
The item appears in the Options area.
c) Add two or more list options to complete the list.
d) If you need to change the Default value selection, click the
down-arrow and select the item you need.
Setting up Text or Text Area extended property types
To set up a Text or Text Area type extended property, do the following:
a) If required, click in the Default value field and type the the
message or comment that should appear by default.
b) In the Max number of characters spinbox, set the maximum
number of characters a user can type.
9 If the extended property should be valid at specific times only,
select the Time sensitive checkbox.
10 If the extended property is for immediate use, click the Active
checkbox.
Creating Identifier Values
Use the instructions below to create values for an identifier. This
applies only to non-unique identifiers, and is optional.
Note: ActivEssentials uses the first item you add to the list as the Default value, but
you can change this later, if necessary.
Note: The highest number you can set is 255.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-59
If you chose the Auto-insert option when creating an identifier, the
values of the identifier coming from the PLC will automatically be
passed to the database. If you did not choose Auto-insert, then you
can define values using the method given here. However, the value
names you create must match those that the PLC can provide. You can
also create an alias for identifiers if you wish.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Data Collection Configuration task
module using the instructions in Opening the Data Collection
Configuration Module on page 7-3.
Created a global identifier using the instructions in Creating a
Global Identifier on page 7-52.
Created identifier extended properties using the instructions in
Viewing and Editing Identifier Definitions on page 7-54.
Procedure
1 In the Plant Hierarchy frame, select the Object Library.
2 In the secondary frame area, click the Global Collection
Configuration category button.
3 In the Global Collection Configuration frame, select the
Identifiers icon.
The list of previously defined identifiers appears in the grid.
4 Click in the Identifier Values cell of the same row to reveal the
ellipsis button. An ellipsis button appears.
5 Click the ellipsis button.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-60
Figure 7-32 The Identifier Values editor
6 Double-click in the cell in the Value column and then type the
name of the value (up to 255 characters).
The name must match a value coming from the PLC.
7 If you need to use an alias for the value as it appears in VPWeb,
type an alternative name in the Title cell.
8 If necessary, choose a color by which to recognize instances of the
identifier value in VPWeb by clicking in the cell in the Color
column, and then clicking the ellipsis button to open the Color
picker.
9 Click in the Extended Properties cell to reveal the ellipsis button,
and then click the ellipsis button.
Note: The Title and Auto-Title options are mutually exclusive; you can use only one
or the other. If you use the Auto-Title option, the name in the Value column
appears in VPWeb.
Note: The Color and Auto-Color options are mutaully exclusive; when you select
one you cancel the other.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-61
Figure 7-33 The Extended Property Values editor
When first defined, a new extended property value contains all of
the extended properties of the identifier, including all of the default
value settings. As each identifier value represents a different value
in the PLC, you might need to change how the default settings
apply to individual values.
The way you edit the values is determined by the extended
property type and whether the value is time-sensitive or not. For
some time-insensitive values, you can either double-click and edit
directly in the grid or click to reveal a drop-down list where you can
select an alternative; and for other time-insensitive values and all
time-sensitive values, you can click to reveal an ellipsis button,
which when clicked allows you to open another editor. The
checkboxes in the Time-Sensitive column indicate the status of
each value.
Editing Time-Insensitive values
To edit values, locate the row in the grid for the value you need to edit,
and make your changes in the cell in the Value column.
a) For Boolean type values, click in the cell, and then click the
down-arrow to select the Boolean value you need.
b) For Currency and Numeric type values, double click in the cell
and edit the value to what you need.
The new value must be valid within any minimum and maxi-
mum values you have defined for the extended property.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-62
c) For Date-Time type values, click in the cell and then click the
ellipsis button to open a time picker where you can set a date
and time.
d) For (Editable) Single Selection type values, click in the cell,
click the down-arrow that appears, and select a new default
value.
e) For Text and Text Area type values, double-click in the cell and
then edit the text to what you need.
Editing Time-Sensitive values
To edit values, locate the row in the grid for the value you need to edit,
and make your changes through the cell in the Value column. To do
this, click in the cell and then click the ellipsis button that appears and
wait for the Time-Sensitive Property Values dialog box to open.
The Time-Sensitive Property Values dialog box allows you to
change the value at assigned times, so you can create a scheme using
start and end times. This allows you create a schedule for when the
values should change.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-63
Figure 7-34 Examples of the Time-sensitive Property Values dialog box
a) For Boolean type values, do the following:
Click in the cell in the Value column on the new row. A
drop-down arrow appears.
Click the down-arrow and select the Boolean condition you
need.
Click in the cell in the Start Time column, and when the
ellipsis button appears, click it to open a time picker where
you can set a start time for the Boolean condition.
The start time appears, but the end time is left open.
If you need to define an end time, set that through the End
Time column cell.
Click on anther row to save your changes. If you defined an
end time, another value appears that indicates that the
default value should restart at the same time as the defined
end time.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-64
b) For Currency and Numeric type values, do the following:
Double-click in the cell in Value column on the new row and
edit the value to what you need.
Click in the cell in the Start Time column, and when the
ellipsis button appears, click it to open a time picker where
you can set a start time for the new value.
The start time appears, but the end time is left open.
If you need to define an end time, set that through the End
Time column cell.
Click on anther row to save your changes. If you defined an
end time, another value appears that indicates that the
default value should restart at the same time as the defined
end time.
c) For Date-Time type values, do the following:
Click in the cell in the Value column on the new row.
An ellipsis button appears.
Click the ellipsis button to open a date and time picker.
Click in the cell in the Start Time column, and when the
ellipsis button appears, click it to open a time picker where
you can set a start time for the Date-Time value.
The start time appears, but the end time is left open.
If you need to define an end time, set that through the End
Time column cell.
Click on anther row to save your changes.
d) For (Editable) Single Selection type values, do the following:
Click in the cell in the Value column on the new row.
An down-arrow appears.
Select a new value from the drop-down list.
Click in the cell in the Start Time column, and when the
ellipsis button appears, click it to open a time picker where
you can set a start time for the the single selection value.
The start time appears, but the end time is left open.
If you need to define an end time, set that through the End
Time column cell. Click on anther row to save your changes.
e) For Text and Text Area type values, do the following:
Double-click in the cell in the Value column on the new
row.
The cell becomes editable.
Type a new text message to appear when needed.
Click in the cell in the Start Time column, and when the
ellipsis button appears, click it to open a time picker where
you can set a start time for the the appearance of the text.
The start time appears, but the end time is left open.
If you need to define an end time, set that through the End
Time column cell.
Click on anther row to save your changes.
10 Click OK on each of the open dialog boxes.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-65
Viewing and Editing Identifier Values
Use the instructions below to view and edit identifier values.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Data Collection Configuration task
module using the instructions in Opening the Data Collection
Configuration Module on page 7-3.
Created a global identifier using the instructions in Creating a
Global Identifier on page 7-52.
Created identifier extended properties using the instructions in
Creating and Editing Identifier Extended Properties on page 7-55.
Procedure
1 In the Plant Hierarchy frame, select the Object Library.
2 In the secondary frame area, click the Global Collection
Configuration category button.
3 In the Global Collection Configuration frame, select the
Identifiers icon.
The list of previously defined identifiers appears in the grid.
4 Click in the Identifier Values cell of the same row to reveal the
ellipsis button.
An ellipsis button appears.
5 Click the ellipsis button.
Figure 7-35 The Identifier Values editor
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-66
6 Change the following, as needed, for each of the values listed:
Double-click in the cell in the Value column, and then edit the
Value name.
The name you create must match with a name that comes from
the PLC.
If necessary, create an alias for the Value name by
double-clicking in the cell in the Title column.
If you create an alias, this clears the checkbox in the cell in the
Auto-Title column, as VPWeb can only display the Value name
or the alias (Title).
If necessary, select a color to use for identifying the value in
VPWeb. To do this, you must clear the checkbox in the
Auto-Color cell, click in the cell in the Color column, click the
elipsis button that appears, and select a color in the Color
picker.
By selecting the Auto-Color checkbox, you override any
previous color choice you might have made.
To change how ActivEssentials applies the extended property
values, click in the Extended Properies cell, and then click
the ellipsis button that appears.
When the Extended Property Values dialog box opens, you
can click in the Value column cells to reveal either a
down-arrow to open a drop-down list (time in-sensitive values),
or an ellipsis button to open the Time-sensitive property
Values dialog box (time sensitive values), where you can
define times when the value is valid.
Creating New Identifier Values from
Existing Values
Use the instructions below to create a new identifier values from an
existing value. When you copy a value to create a new value, the only
aspects of the original value are the extended properties as defined in
the source configuration.
Note: The Identifier Values dialog box exposes the configuration of each of the
identifier values assigned to the identifier.
Note: The copying process does not copy the Title and Color.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-67
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Data Collection Configuration task
module using the instructions in Opening the Data Collection
Configuration Module on page 7-3.
Created a global identifier using the instructions in Creating a
Global Identifier on page 7-52.
Created identifier extended properties using the instructions in
Creating and Editing Identifier Extended Properties on page 7-55.
Procedure
1 In the Plant Hierarchy frame, select the Object Library.
2 In the secondary frame area, click the Global Collection
Configuration category button.
3 In the Global Collection Configuration frame, select the
Identifiers icon.
The list of previously defined identifiers appears in the grid.
4 Click in the Identifier Values cell of the same row to reveal the
ellipsis button.
An ellipsis button appears.
5 Click the ellipsis button.
Figure 7-36 The Identifier Values editor
6 Right-click on the value you need to duplicate and select Copy.
7 On the new row at the bottom of the grid, right-click and select
Paste.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-68
Figure 7-37 The New row
A new value appears in the grid with a name prefixed with the term
Copy of in front of the original value name.
8 Double-click on the Value name and then edit the name to match a
name that comes the PLC.
Copying the Extended Properties of One
Identifier Value to Another
Use the instructions below to copy the extended properties of one
identifier value to another.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Data Collection Configuration task
module using the instructions in Opening the Data Collection
Configuration Module on page 7-3.
Created a global identifier using the instructions in Creating a
Global Identifier on page 7-52.
Created identifier extended properties using the instructions in
Creating and Editing Identifier Extended Properties on page 7-55.
Created identifier extended properties using the instructions in
Creating Identifier Values on page 7-58.
Procedure
1 In the Plant Hierarchy frame, select the Object Library.
2 In the secondary frame area, click the Global Collection
Configuration category button.
3 In the Global Collection Configuration frame, select the
Identifiers icon.
The list of previously defined identifiers appears in the grid.
4 Click in the Identifier Values cell of the same row to reveal the
ellipsis button.
An ellipsis button appears.
5 Click the ellipsis button.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-69
Figure 7-38 The Identifier Values editor
6 Right-click on the value you need to duplicate and select Copy.
7 Right-click on the value where you need the copied properties and
select Paste Properties.
A Confirm Action dialog box opens that indicates that the
property values will be reassigned.
8 Click OK.
The extended properties, as applied at the source value are now
applied to the destination vale
9 Click OK to close the Identifier Values dialog box.
Note: When you select Copy, you are copying the configuration of the extended
properties, as applied to the Value.
Note: If you need to check, select the cell in the Extended Properties column, and
then click the ellipsis button that appears. When the Extended Properties
dialog box opens, you can examine the configuration there.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-70
Defining Accumulators, Incidents, and Identifiers
on an Asset
When you define the data items that ActivEssentials will collect at an
asset, you can either use global items or local items. Global items are
available to any asset, whereas local items apply only to an individual
asset. For information on defining items at the global level.
For more information, see Defining Accumulators, Incidents, and
Identifiers on an Asset on page 7-70 and Defining Global Identifiers on
page 7-42.
Global items are available for use in any asset. When you add them to
an asset you may have to define particular properties for them. Local
items can only be used for the asset on which they are defined.
This section covers the following topics:
Refreshing VPCollector on page 7-71
Adding a Non-Incident Category to an Asset on page 7-71
Adding an Incident Category to an Asset on page 7-73
Creating Links Between Identifiers and Accumulators on page 7-79
Creating Links Between Identifiers and Accumulators on page 7-79
Adding an Incident Item to an Asset on page 7-81
Adding an Identifier Item to an Asset on page 7-85
Viewing and Editing Data Item Definitions on an Asset on page
7-89
Deleting a Data Item From an Asset on page 7-91
Copying Data Items Within an Asset on page 7-91
Copying Data Items Between Assets on page 7-92
Global and Local Data Items on page 7-93
Global and Local Data Items on page 7-93
Linking Identifiers and Accumulators on page 7-94
Note: When working on an asset, many of your changes will not be transmitted to
VPCollector unless you refresh VPCollector. You can do this by clicking the
Refresh Activplant Collector button on the toolbar (see Refreshing
VPCollector on page 7-71 for more information). But be aware that refreshing
takes the asset off-line for a couple of seconds, so you may lose data each
time you refresh. Because of this, it is best to make all your changes and then
refresh just once. For the same reason, you cannot refresh VPCollector on a
higher level of the plant hierarchy, because that would take all the child assets
off-line. For more information on the consequences of refreshing VPCollector,
see Effects of Stopping or Refreshing VPCollector on page 6-15.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-71
Refreshing VPCollector
Use the instructions below to refresh VPCollector. After making
configuration changes to an asset, you must refresh within VPCollector
the configuration it holds for the asset.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Data Collection Configuration task
module using the instructions in Opening the Data Collection
Configuration Module on page 7-3.
Made configuration changes to an asset.
Procedure
1 In the Plant Hierarchy frame, navigate to and select the asset
whose configuration you need to refresh.
2 Click the Refresh VPCollector button on the toolbar.
A confirmation dialog box opens.
Figure 7-39 The confirmation dialog box
3 Click OK.
Adding a Non-Incident Category to an
Asset
Use the instructions below to add a non-incident data collection
category to an asset.
Note: Refreshing takes VPCollector off-line, so do not do this unless necessary.
Make all necessary configuration changes first before refreshing. Do not
refresh VPCollector at the group level as this stops data collection from all
assets within the group. If you have made changes to a number of assets,
select them individually in the Plant Hierarchy and refresh them one-by-one.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-72
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Data Collection Configuration task
module using the instructions in Opening the Data Collection
Configuration Module on page 7-3.
Created at least one category using the instructions in Creating a
Collection Category on page 7-12.
Determined if you need extra properties associated with the
incident. See Adding an Incident Category to an Asset on page
7-73.
Procedure
1 In the Plant Hierarchy frame, expand the hierarchy and then
select the asset to which you need to add the category.
2 In the Collection Configuration frame, select Collection
Categories.
The grid displays any categories that have already been added to
the asset.
3 On the toolbar, click the New button.
The Add Collection Category to Asset wizard starts.
4 Click Next to move past the welcome page.
Figure 7-40 The Add Collection Category to Asset wizard
5 Click the down-arrow by the Name field and select a non-incident
category from the list.
The list shows all categories that have not already been added to
the asset.
6 Click Next.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-73
Figure 7-41 The Collection Category Properties page of the wizard
7 Ensure that the Active box is checked, and click Next.
The final page of the wizard opens.
8 Review the definition, then click Finish to save it. (If you want to
add another category, ensure that the Run this wizard again
checkbox is checked.)
Adding an Incident Category to an Asset
Use the instructions below to add an incident category to an asset.
Incident categories have a few extra properties, so they are described
here in more detail.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Data Collection Configuration task
module using the instructions in Opening the Data Collection
Configuration Module on page 7-3.
Created at least one category using the instructions in Creating a
Collection Category on page 7-12.
Determined if you need extra properties associated with the
incident. See Adding an Incident Category to an Asset on page
7-73.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-74
Procedure
1 In the Plant Hierarchy frame, expand the hierarchy and then
select the asset to which you need to add the category.
2 In the Collection Configuration frame, select Collection
Categories.
The grid displays any categories that have already been added to
the asset.
3 On the toolbar, click the New button.
The Add Collection Category to Asset wizard starts.
4 Click Next to move past the welcome page.
Figure 7-42 The Add Collection Category to Asset wizard
5 Click the down-arrow by the Name field and select a incident
category from the list.
The list shows all categories that have not already been added to
the asset.
6 Do one of the following:
a) If you do not wish to enable acknowledgment of incidents
belonging to this category, leave the Acknowledgment
required checkbox unchecked, or
b) To enable acknowledgment of incidents belonging to this
category, do the following:
Check the Acknowledgment required checkbox. If you
want to write the acknowledgment back to the PLC, also
select the Send to PLC checkbox.
If you want to write back to the PLC, enter the details of the
acknowledgment destination address in the OPC server
name, Access path, and OPC item fields. In the Value
field, enter the value that should be added to the PLC table.
7 Click Next.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-75
Figure 7-43 The Collection Category Properties page
8 In the Collection Category Properties page, select among the
checkboxes as follows:
a) If you want the members of this category to be viewable or
editable in VPWeb or other modules, select the Operator
viewable and/or Operator editable checkboxes.
b) If you want priorities to be enabled for incidents belonging to
this category, select the Priorities enabled checkbox. For
more information on incident priorities, see Incident Priorities
on page 7-149.
c) If you need to set this incident category as Retro Stop, select
the Set as Retro Stop incident category checkbox. See the
chapter Retroactive Incident Editing on page 15-1, for more
information.
d) If you want incident data to be added to the database instead
of only displayed in real time, select the Collect historical
data checkbox.
9 Ensure the Active box is checked, and click Next.
The final page of wizard opens.
10 Review the definition and click Finish to save it.
Adding an Accumulator Data Item to an
Asset
Use the instructions below to add an accumulator data item to an
asset.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-76
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Data Collection Configuration task
module using the instructions in Opening the Data Collection
Configuration Module on page 7-3.
Created at least one global category and at least one accumulator
data item using the instructions in Creating a Collection Category
on page 7-12 and Creating a Global Accumulator Item on page
7-20. You should also have added an accumulator category to an
asset.
Procedure
1 In the Plant Hierarchy frame, expand the hierarchy and then
select the asset to which you want to add the data item.
2 In the Collection Configuration frame, expand Collection
Categories until you can see the accumulator category, then
select it.
The grid displays any accumulators that have already been added
to the asset.
3 On the toolbar, click the New button.
The Add Accumulator Item to Asset wizard starts.
4 Click Next to move past the welcome page.
Figure 7-44 The Add Accumulator Item to Asset wizard
5 Do one of the following:
a) To create a new item, leave the New item checkbox checked
and go to Step 6.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-77
b) To use a previously defined global item, clear the New item
checkbox, then click the ellipsis button by the Name field.
Figure 7-45 The Global Definition Items dialog box
c) In the dialog box, select one of the previously defined global
accumulators, and then click OK.
6 Click Next.
The Accumulator Item Properties page of the wizard opens.
Figure 7-46 The Accumulator Item Properties wizard page
Note: You can only use a previously-defined global accumulator once per asset. This
is true of accumulators and identifiers. Incidents and event variables, on the
other hand, can be used in more than one category on the same asset.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-78
7 Do each of the following:
a) For new items, in the Name field, type a unique name for the
accumulator (up to 50 characters).
b) For new items, in the Type field, click the down-arrow and
choose an accumulator type.
c) In the Access path field, type the path to the OPC item.
d) In the OPC item field, type the OPC item name.
e) If you do not know the access path, click the ellipsis button to
the right of the OPC item field.
The OPC Items Browser opens, which displays a network
hierarchy.
Figure 7-47 Finding an OPC item
f) In the OPC Items Browser, navigate to and select the OPC
item you need to use, and then click OK.
The browser closes and the access path and OPC item appear in
the OPC item field.
8 Click Next.
Note: If you have chosen to use a pre-defined category, the Name and Type fields
are greyed out, you cannot edit the contents.
Note: If you wish, you can type both the access path and the OPC item into the OPC
item field, and leave the Access Path field blank.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-79
Figure 7-48 Accumulator Item Properties wizard page
9 On the Accumulator Item Properties page, you can define an
expression for filtering data collection. The default expression of
x=* means that all values will be collected. If you want VPCollector
to collect the data at regular intervals, clear this field and check the
Solicited checkbox. For more information about expressions, see
Filtering Data by Means of Expressions on page 7-143.
10 Choose a multiplier for the data. This determines what will display
in VPWeb. For example, if the data is collected in seconds and you
want to display the value in minutes, enter 0.0166 (1 60).
11 Choose units and a data format.
12 If desired, enter a note in the Note field (up to 255 characters).
Ensure that the Active checkbox is checked.
13 Click Next.
The final page of the wizard opens.
14 Review the definition, and click Finish to save it.
Creating Links Between Identifiers and
Accumulators
Use the instructions below to link an accumulator definition with one or
more identifier items. The link resolves a potential inaccuracy in
displaying accumulator data by an identifier.
Note: As a best practice, the update rate for linked identifiers should be at least 30
seconds, and no less than 5 seconds. There is no upper limit to the update
rate.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-80
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Data Collection Configuration task
module using the instructions in Opening the Data Collection
Configuration Module on page 7-3.
Created an accumulator item using the instructions in Linking
Identifiers and Accumulators on page 7-94.
Created an identifier using the instructions in Creating a Global
Identifier on page 7-52.
The reasons for linking in Linking Identifiers and Accumulators on
page 7-94.
Procedure
1 In the Plant Hierarchy frame, expand the hierarchy, then select
the asset to which you want to add the data item.
2 In the Collection Configuration frame, expand Collection
Categories until you can see the accumulator category, then
select it.
The grid displays any accumulators that have already been added
to the asset.
3 Locate the accumulator data item that you want to link. Click in the
Identifier Links column, then click the ellipsis button to open the
AccumulatorIdentifier Links editor.
Figure 7-49 The Accumulator-Identifier Links editor
4 Click in the Name column of the New row, then click the ellipsis
button.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-81
Figure 7-50 Linking accumulators and identifiers
5 In the Global Definition Items list, select an identifier, then click
OK.
Adding an Incident Item to an Asset
Use the instructions below to add an incident data item to an asset.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Data Collection Configuration task
module using the instructions in Opening the Data Collection
Configuration Module on page 7-3.
Created an global category using the instructions in Creating a
Collection Category on page 7-12.
Created an incident data item using the instructions in Creating a
Global Incident Item on page 7-22.
Added an incident category to the asset using the instructions in
Adding an Incident Category to an Asset on page 7-73.
Procedure
1 In the Plant Hierarchy frame, expand the hierarchy, then select
the asset to which you want to add the data item.
2 In the Collection Configuration frame, expand the Collection
Categories option until you can see the incident category, then
select it.
The grid displays any incidents that have already been added to
the asset.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-82
3 On the toolbar, click the New button.
The Add Incident Item to Asset wizard starts.
4 Click Next to move past the welcome page.
Figure 7-51 The Name page of the Add Incident Item to Asset wizard
5 Do one of the following:
a) To create a new item, leave the New item checkbox selected
and go to Step 6.
b) To use a previously defined global item, clear the New item
checkbox, then click the ellipsis button to the right of the
Name field.
Figure 7-52 The Global Definition Items dialog box
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-83
c) In the Global Definitions Items dialog box, select one of the
previously defined global incidents, and then click OK.
6 Click Next.
Figure 7-53 The Incident Item Properties wizard page
7 Do each of the following:
a) For new items, in the Name field, type a unique name for the
accumulator (up to 50 characters).
b) In the Access path field, type the path to the OPC item.
c) In the OPC item field, type the OPC item name.
d) If you do not know the access path, click the ellipsis button to
the right of the OPC item field.
The OPC Items Browser opens, which displays a network hier-
archy.
Note: If you wish, you can type both the access path and the OPC item into the OPC
item field, and leave the Access Path field blank.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-84
Figure 7-54 Finding an OPC item
e) In the OPC Items Browser, navigate to and select the OPC
item you need to use, and then click OK.
The browser closes and the access path and OPC item appear in
the OPC item field.
8 Click Next.
Figure 7-55 Incident properties
9 On the Incident Item Properties wizard page, you can define an
expression for filtering data collection. The default expression of
x=* means that all values will be collected. For more information
about expressions, see Filtering Data by Means of Expressions on
page 7-143.
10 If incidents are programmed to NOT be mutually exclusive, you can
set a priority for the incident (1 = Highest) in the Priority field. If
your incidents are programmed to be mutually exclusive, ignore
this field.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-85
11 Ensure that the Active checkbox is checked.
12 Click Next.
The final page of the wizard opens.
13 Review the definition, and click Finish to save it.
Adding an Identifier Item to an Asset
Use the instructions below to add an identifier data item to an asset.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Data Collection Configuration task
module using the instructions in Opening the Data Collection
Configuration Module on page 7-3.
Created an global identifier category using the instructions in
Creating a Global Identifier on page 7-52.
Created an identifier data item using the instructions in Creating a
Global Incident Item on page 7-22.
Added an identifier item to the asset using the instructions in
Adding an Identifier Item to an Asset on page 7-85.
Procedure
1 In the Plant Hierarchy frame, expand the hierarchy, then select
the asset to which you want to add the data item.
2 In the Collection Configuration frame, expand the Collection
Categories option until you can see the identifier category, then
select it.
The grid displays any identifiers that have already been added to
the asset.
3 On the toolbar, click the New button.
The Add Identifier Item to Asset wizard starts.
4 Click Next to move past the welcome page.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-86
Figure 7-56 The Name page of the Add Identifier Item to Asset wizard
5 Do one of the following:
a) To create a new item, leave the New item checkbox selected
and go to Step 6.
b) To use a previously defined global item, clear the New item
checkbox, then click the ellipsis button by the Name field.
Figure 7-57 The Global Definition Items dialog box
c) In the Global Definition Items dialog box, select one of the
previously defined global identifiers, and then click OK.
6 Click Next.
The Identifier Item Properties page of the wizard opens. If you are
using a pre-defined category, the Name and Type fields are greyed
out and you cannot edit the contents.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-87
Figure 7-58 The Identifier Item Properties wizard page
7 Do each of the following:
a) For new items, in the Name field, type a unique name for the
identifier (up to 50 characters).
b) For new items, in the Type field, click the down-arrow and
choose an identifier type.
c) If you want the database to save identifier values, check the
Enable automatic insertion of values checkbox.
d) If you want identifier data to be stored in the database, select
the Collect historical data checkbox.
8 Click Next.
A second Identifier Item Properties page in the wizard opens.
Note: You can only use a previously-defined global identifier once per asset. This is
true of accumulators and identifiers. Incidents and event variables, on the other
hand, can be used in more than one category on the same asset.
Note: The Enable automatic insertion of values option only applies to
Non-unique identifiers.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-88
Figure 7-59 The second Identifier Item Properties page
9 Do the following:
a) In the Access path field, type the path to the OPC item.
b) In the OPC item field, type the OPC item name.
c) If you do not know the access path, click the ellipsis button to
the right of the OPC item field.
The OPC Items Browser opens, which displays a network
hierarchy.
Figure 7-60 Finding an OPC item
Note: If you wish, you can type both the access path and the OPC item into the OPC
item field, and leave the Access path field blank.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-89
d) In the OPC Items Browser, navigate to and select the OPC
item you need to use, and then click OK.
The browser closes and the access path and OPC item appear in
the OPC item field.
e) Ensure that the Active checkbox is checked.
10 Click Next.
The final page of the wizard opens.
11 Review the definition, and click Finish to save it.
Viewing and Editing Data Item Definitions
on an Asset
Use the instructions below to view or edit the properties of data items
that have been added to an asset.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Data Collection Configuration task
module using the instructions in Opening the Data Collection
Configuration Module on page 7-3.
Create a data item and add it to an asset.
Procedure
1 In the Plant Hierarchy frame, navigate to the asset whose data
items you want to view, and select the asset.
2 In the Collection Configuration frame, navigate to the
appropriate collection category and select it.
The grid displays the data items belonging to this category that
have been assigned to the asset.
3 Right-click on the data item in the grid and select Properties.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-90
Figure 7-61 The data item Properties dialog box
4 In the Properties dialog box you can make several changes. If you
want to change the data item, click the ellipsis button by the Name
field and select from the list that opens. Use the arrow keys at the
top right to navigate to the desired page (the items are sorted in
alphabetical order).
Figure 7-62 The list of available data items
5 When done, click OK to close the Properties dialog box.
Note: You can also edit definitions directly in the grid. Click or double-click in the
appropriate column and edit. Your changes will be saved when you click
outside the row that you have been editing.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-91
Deleting a Data Item From an Asset
Use the instructions below to delete a data item from an asset.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Data Collection Configuration task
module using the instructions in Opening the Data Collection
Configuration Module on page 7-3.
Added a data item to an asset.
Procedure
1 In the Plant Hierarchy frame, navigate to the asset whose data
items you want to view, and select the asset.
2 In the Collection Configuration frame, navigate to the
appropriate collection category and select it.
The grid displays the data items belonging to this category that
have been assigned to the asset.
3 Right-click on the data item in the grid and select Delete.
A confirmation dialog box opens.
4 Click OK.
Copying Data Items Within an Asset
Use the instructions below to copy data items within an asset. This is
useful if you want to avoid individually configuring similar items.
Define the item once, then copy it.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Data Collection Configuration task
module using the instructions in Opening the Data Collection
Configuration Module on page 7-3.
Created a data item.
Procedure
1 In the Plant Hierarchy frame, navigate to the asset whose data
items you want to copy, and select the asset.
2 In the Collection Configuration frame, navigate to the
appropriate collection category and select it.
The grid displays the data items belonging to this category that
have been assigned to the asset.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-92
3 Right-click on the data item in the grid and select Copy.
4 Do one of the following:
a) If you need to make a copy in a different category, in the
Collection Configuration frame, navigate down through the
Collection Categories tree and select the new category, and
then click the Paste button on the toolbar.
b) If you need to create the copy in the same category as the
original, right-click elsewhere in the grid and select Paste.
The copy of the data item appears with the name Copy of
(original name).
5 Edit the details of the copy (such as the OPC item) as necessary.
Copying Data Items Between Assets
Use the instructions below to copy data items from one asset to
another. This is useful if you want to avoid configuring items for
several different assets. Define the items on one asset, then copy
them to other assets. (To save even more time, define a single asset
completely, then copy the asset itself.)
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Data Collection Configuration task
module using the instructions in Opening the Data Collection
Configuration Module on page 7-3.
Procedure
1 In the Plant Hierarchy frame, navigate to the asset whose data
items you want to copy, and select the asset.
2 In the Collection Configuration frame, navigate to the
appropriate collection category and select it.
The grid displays the data items belonging to this category that
have been assigned to the asset.
3 Right-click on the data item in the grid and select Copy.
4 In the Plant Hierarchy frame, navigate to the asset to which you
want to copy the state, and select it.
5 In the Collection Configuration frame, select the Collection
Categories option and navigate to the category to which you want
to add the data item, then select it.
6 Right-click anywhere in the grid and select Paste.
7 Edit the details of the data item (such as the OPC item) as
necessary.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-93
Categories, Items, and Assets
Data items that are to be collected by ActivEssentials are organized
into categories depending on the collection method (Accumulators,
Incidents, Events, or Identifiers) that they use. The categories are
created on the global level and you can then apply them to as many
assets as you want.
When defining the data items that an asset will collect, the first step is
to add one or more categories to the asset. Then select each category
and add the data items within each category. You cannot add a data
item without placing it in a category.
You should first have created one or more categories and one or more
data items on the global level. This part of the configuration is quite
labor-intensive, so we recommend that you do as much of the
configuration as possible on one asset, then copy and paste the asset
to different parts of your hierarchy. If you do this, you will only have to
change the OPC item addresses and a few other things, rather than
repeating the whole process many times.
Another way to save time in configuring data items is to export them
to Microsoft Excel, then edit them and import them back.
Related topics
See the following related topics:
For information on creating categories, see Creating a Collection
Category on page 7-12.
For information about exporting and importing, see Exporting and
Importing on page 7-150.
Global and Local Data Items on page 7-93
Linking Identifiers and Accumulators on page 7-94
Global and Local Data Items
When you add a data item to an asset, you have the option of using a
global item that was previously defined, or of creating a new data item
that is local to the asset. This option applies to Accumulators,
Incidents, Events, and Identifiers, but not to Asset States, which are
always global. You make this choice in the data item wizard.
On the first real page of the wizard (after the welcome page), there
is a New item checkbox. If this is checked, the item you create will be
a new item that is unique to the asset. This is a local item. If you clear
this checkbox, you can select from a list of global items that have
already been defined.
If items are defined locally, the icon used to represent the kind of data
item (the icon to the left of the name of the item in the grid) has a
yellow background. For more information on the variances in these
icons, see Icons Used in the Main Grid on page 7-9.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-94
Linking Identifiers and Accumulators
In Production View of VPWeb you can view identifier changes as a
time-line. The colored time-line shows when an identifier changed, but
even with a 5-minute time interval you cannot tell exactly what the
values were at the moment of change. The solution is to view data by
identifier in Production View. In this view, shown in the following
figure, identifier changes are represented by columns. The identifier
value is shown in the column header (5 in this case) and the i icon
indicates that the data is grouped by identifier.
Figure 7-63 Grouping data by identifier in Production View of VPWeb
However, database records for accumulators are inserted in the
database only every five minutes. If an identifier changed in the
middle of a five-minute period between record insertions, there is no
way of knowing what the accumulator value was at the moment of
identifier change. The degree of inaccuracy depends on the number of
parts produced.
The solution to this inaccuracy is to link accumulators and identifiers
so that an extra accumulator record is created when the identifier
value changes. This extra record ensures that the data displayed in
Production View is completely accurate.
Because the creation of an extra record uses up system resources, you
have to choose the identifiers that you want to link to an accumulator,
rather than linking all identifiers. This restriction eases the load on the
system.
For information on how to link identifiers and accumulators, see
Creating Links Between Identifiers and Accumulators on page 7-79.
Note: As a best practice, the update rate for linked identifiers should be at least 30
seconds, and no less than 5 seconds. There is no upper limit to the update
rate.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-95
Events in ActivEssentials
Events are snapshots of values that are captured at a particular time.
They are often used to collect process variables such as temperature,
pressure, torque, etc., but they may also be used to collect other types
of data such as machine cycle times.
This section describes the different types of events that you can
define. For detailed information about Triggered Sample events, which
are more complex than the other types, see Triggered Sample Events
on page 7-100.
This section covers the following topics:
The Types of Events on page 7-95
Steps Involved in Defining Events on page 7-97
Event Acknowledgment on page 7-97
Trigger Expressions for Events on page 7-98
Sampled Events and Daylight Saving Time on page 7-100
The Types of Events
Events are snapshots of values taken at a particular point in time. An
event is really a container for one or more event variables associated
with it. Whenever the event fires, VPCollector collects the values of all
the variables that are associated with it. A variable can be a process
variable such as a temperature, or it can be some other type of data
read from the PLC. Event variables may be numeric or alphanumeric,
and you can associate both types with a single event.
Events sampling occurs in several ways:
The sampling may occur at a predetermined interval, in which case
the sample rate is defined in MI Admin (the minimum interval is 5
seconds). This is referred to as a Sample Time event. Sample
Time events continue to be collected indefinitely.
Sampling may be triggered only when a separate trigger variable
changes. When the trigger fires, the associated event variable is
sampled once. This is known as a Value Change event.
A Triggered Sample event is a combination of a Sample Time
event and a Value Change event. It uses a separate trigger in the
same way as a Value Change event, but sampling continues only
until the trigger reverts to Off, or until a predefined period of time
elapses. Instead of sampling for ever, the Triggered Sample event
restricts the sampling just to the times that you are interested in.
An OPC Real-Time event is a data item that is sampled
continuously in real-time and is not stored in the database.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-96
Sample Time Events
A Sample Time event is an event type in which the associated
variable(s) is collected at a predefined sampling rate. The minimum
sampling frequency is 5 seconds; the maximum sampling time is 6 000
seconds (100 minutes).
This type of event is used when you want to monitor the variables
continuously and indefinitely. Sampling continues at the defined rate
for everat least, until you deactivate the event or the event category.
This may result in accumulation of large numbers of records, so you
may want to consider using a Triggered Sample event instead.
Value Change Events
A Value Change event is sampled when a separate trigger item
reaches a particular value. The trigger item is a separate OPC data
item, and it has an expression that is evaluated to fire the trigger. You
can use any data item as a trigger so long as its expression can be
evaluated to True or False.
For example, a simple trigger could be a Boolean data item that has a
value of 1 or 0. You could set the trigger expression to x=1, and then
whenever the Boolean is True the event fires and the variables are
collected.
Alternatively, you could use a numeric trigger using the expression
x>10, meaning that the expression will evaluate to True as soon as the
trigger value exceeds 10. As soon as this occurs, the associated event
variables are sampled once and a database record is created. If the
trigger value changes to another number above 10, the event fires
again. If it falls to 10 or less, and then goes up over 10 again, the
trigger fires again and the variables are collected again.
OPC Real-Time Events
An OPC Real-Time event is an event in which the associated variable(s)
is collected in real-time only, and not stored in the database. There is
no sampling rate or trigger. The variables are simply passed
continuously to the client. You can display such data in real-time in
VPWeb.
Triggered Sample Events
A Triggered Sample event combines the features of Sample Time and
Value Change events. A separate trigger item has an expression that
fires the trigger when it evaluates to True. Sampling of the associated
variable(s) then begins and continues either until the trigger reverts to
False or until some predefined period expires.
Unlike a Sample Time event, a Triggered Sample event is collected
only when you want it to be. You define the conditions when it will be
sampled, and how frequently.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-97
Unlike a Value Change event, if the trigger value changes to another
valid (True) value, a new record is not created. If the trigger goes off
and then on again, a new record is created. If you wish you can have
records created over a particular period of time after the trigger fires
(a duration).
For more information on Triggered Sample events, and how database
records are created under different conditions, see Overview of
Triggered Sample Events on page 7-101, and the topics that follow
from it.
Steps Involved in Defining Events
When defining events you have to complete the following steps:
1 Define one or more event categories and add them to the
appropriate assets.
2 On each asset, define the event that will be collected. When you do
this, you choose whether you want to define a Sample Time, Value
Change, Triggered Sample, or OPC Real-Time event.
3 For each event, define the variables that will be collected. The
variables can be numeric or alphanumeric, and you can define as
many as you wish for each event. All the variables are collected
whenever the event fires.
4 If you are defining a Value Change or a Triggered Sample event,
you define which OPC data item will act as the trigger that fires
sampling of the variables.
5 For Value Change events (only) you can define whether you wish to
have ActivEssentials write to another OPC data item address
whenever the trigger fires. For example, you may want to count
the number of times a temperature exceeds 100. This is referred
to as event acknowledgment. For more information, see Event
Acknowledgment on page 7-97.
Event Acknowledgment
With Value Change events you have the option to define whether the
firing of the trigger writes a value to a separate OPC data item. You
could use this if you wanted to record the number of times a trigger
fires, for instance.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-98
The process of acknowledging an event is shown in the figure to the
right. When the trigger goes On, it prompts VPCollector to collect the
variable item (there may be more than one) and store the record in
the database. VPCollector afterwards writes to the acknowledgment
item in the PLC.
1 The trigger goes On.
2 VPCollector reads the value of the variable(s).
3 VPCollector passes the event data package to VPQManager for
storage in the database.
4 VPCollector writes to the acknowledgment item in the PLC.
Trigger Expressions for Events
You can use an expression for the trigger value so that when it
evaluates to True the collection of the variable value begins. The
trigger expression is in the format x=(expression). For examples, see
Examples of Trigger Expressions and Filters on page 7-99. The trigger
item supports any OPC data type, including Numeric, Alphanumeric,
and Boolean, as well as the Boolean operators AND and OR.
Note: The acknowledgment is independent of the event data package. Even if the
acknowledgment fails for some reason, the event data package is still passed
to the database.
Note: If you use an asterisk (*) in the trigger expression, do not use a VBScript
conversion function such as CInt(). If you do, VPCollector will return trigger
expression errors to the event log.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-99
Data Types and VBScript Functions
The following rules apply for different data types:
Short and Long data types do not need a conversion function. For
example, they could be x=*, x=55, or x>45.
The Word (BCD) data type requires the CInt(x) conversion
function, unless the trigger uses an asterisk. In that case the
trigger value does not need conversion (x=*). The C(Int) function
converts a data value to an integer.
The Double Word (LBCD) data type requires use of the CDbl(x)
function. However, if the trigger or filter is * you must not use this
function. In that case the trigger value does not need conversion
(x=*). This function converts double words to an integer value.
The String data type does not require a VBScript function to collect
the data.
The Floating Point data type is usually used for numeric event
variables such as temperature or pressure. No VBScript function is
required to convert the data.
The Boolean data type does not require a VBScript function to
collect the data. VPCollector can use a trigger value of 1 or 0.
The Byte data type does not require a VBScript function.
The Char data type requires that CInt(x) be used when using the
data type for collecting numeric data. No VBScript function is
required if it is used to collect an alphanumeric variable.
Examples of Trigger Expressions and Filters
Note: For a Boolean data type the trigger expression MUST use x=1 or x=0.
Table 7-2 Examples of trigger expressions and filters
Expression Use
x=* Collects all data, whether numeric or
alphanumeric.
x=(any number) Collects data only when the specific value is
present.
x>45 Collects data only when the value is greater
than 45 (not 45).
x<45 Collects data only when the value is less than
45 (not 45).
x>2 and x<10 Collects data only when x=3,4,5,6,7,8, or 9.
x=2 or x=3 or x=5 or x=15 Collects data only when x=2,3,5, or 15.
x<>2 and x<>3 and x<>5 and
x<>15
Collects data when x is NOT 2,3,5, or 15.
x=ABC (Alphanumeric) Collects data when x=ABC
(only). ABC must be in exactly that order.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-100
Sampled Events and Daylight Saving Time
An annual Daylight Saving time change should have no effect on
sampled events; they are collected along with other data types. If the
time change is a roll-back, the duplicate hours data is stored in
separate database tables as described in Daylight Saving Time in
ActivEssentials on page 2-15.
In many cases the roll-back time repeats the hour between 1:00:00
a.m. and 2:00:00 a.m. The first hours data is moved to the separate
database tables, and new records are created for 1:00:00 and so on
(the second hour). A sampled event with a 30-second sample time
should therefore be sampled at 1:59:00, 1:59:30 and again at
1:00:00 (when the time change has occurred).
On occasion the time-stamp for the repeated 1:00:00 sampling is
slightly earlyfor example, it may be 12:59:25. This is due to an issue
in the Microsoft function library that generates the time-stamp. If it
does occur, the next sampling would have a time-stamp of 12:59:30;
but because a record with this time-stamp already exists in the
database, it is discarded.
This occurs very infrequently, but it may mean the loss of a sample
record. This can occur with Sample Time and Triggered Sample events.
Triggered Sample Events
There are many different options and ways in which you can gather
from Triggered Sample events. This section describes the event
gathering options.
This section covers the following topics:
Overview of Triggered Sample Events on page 7-101
Triggered Sampled EventsModes of Collection on page 7-102
Collection of Database Records Without a Sampling Duration on
page 7-103
Collection of Database Records Using a Sampling Duration on page
7-106
Limitations of Triggered Sample Events on page 7-109
x=ABC% (Alphanumeric) Collects data when the value
contains ABC, with or without other content,
and regardless of where it occurs.
x!=ABC (Alphanumeric) Collects any value except ABC.
ABC must in exactly that order.
x!=ABC% (Alphanumeric) Will not collect any value that
has ABC as part of it, regardless of where it
occurs. ABC must be in exactly that order.
Table 7-2 Examples of trigger expressions and filters (Continued)
Expression Use
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-101
Overview of Triggered Sample Events
A Triggered Sample event combines features of a Value Change event
(collected when a trigger fires) and a Sample Time event (collected at
a predefined interval). Often you do not need to collect a sampled
variable all the time; you only want to collect it at certain times. With a
Triggered Sample event you can specify when sampling starts and
stops.
The difference between a Sample Time event and a Triggered Sample
event is as follows:
A Sample Time event is collected continuously at a predefined
sample ratefor example, every 5 secondsand continues for
ever.
A Triggered Sample event begins to be collected only when the
trigger fires. It then is sampled at a predefined sample rate.
When a Triggered Sample event starts to collect, it continues until
either (i) the trigger switches off (if no duration is defined) or (ii) a
predefined period elapses (if a duration is defined). When either of
these conditions is met collection stops until the trigger fires again.
Because an ordinary Sample Time event never stops being collected at
the predefined sample interval, it may cause accumulation of a large
number of unnecessary database records. The triggered sampled
event limits the amount of data that is collected.
Like ordinary Value Change events, a triggered sampled event uses a
trigger expression such as x>10. When the expression evaluates to
True the trigger is on and collection commences.
The Trigger Item
The trigger item is an OPC memory location whose value is used in the
trigger expression. If the trigger expression evaluates to True, the
collection engine begins sampling the variable values at the predefined
sample interval.
If the trigger item tag (either the Item ID or the access path) is
invalid, the triggered sampled event will not collect data until the tag is
corrected. After correcting the tag you must refresh the asset from the
MI Admin interface.
If the trigger item value is flagged as Bad Quality for some reason, the
event will not be triggered.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-102
Variable Values and Data Quality
The following rules apply to the variable values for Triggered Sample
events:
Event data is not collected while the trigger is off, unless a duration
is in force (see Triggered Sampled EventsModes of Collection on
page 7-102 for information on using a duration).
Event variable values requested in VPWeb display a value of 0 with
Bad Quality in Production View if the trigger is off.
If the connection between the OPC server and the PLC is broken
while the trigger is on, sampling stops. Sampling resumes:
when the connection is restored if a duration was in force and it
has not expired when the reconnection occurs; or
after reconnection, when the trigger next fires.
If the OPC server provides a value with Bad Quality, the last good
value is used in VPWeb and the quality is marked as uncertain.
If the trigger is on and the collector is successfully reading values
the values will be logged with Good Quality.
Triggered Sampled EventsModes of
Collection
Triggered sampled events offer two alternative modes of collection.
You can choose to collect data only while the trigger is on, or collect
data for a defined period after the trigger fires, regardless of whether
the trigger reverts to Off.
Collecting While the Trigger is On
In this scenario you choose to collect the data only while the trigger
expression evaluates to True. When the trigger changes back to a
value that evaluates to False, collection stops. For examples of this
mode of collection, see Collection of Database Records Without a
Sampling Duration on page 7-103.
Example
You may want to start sampling a temperature as soon as it exceeds
100, and continue sampling all the time it is above 100. When it falls
below 100 you want sampling to stop.
Collecting for a Defined Period of Time
(Duration)
In this scenario you choose a duration for sampling. When the trigger
changes to True, the period commences, and sampling takes place
until the period expires. Even if the trigger later changes to False,
sampling still continues until the end of the period. For examples of
database record collection using this method, see Collection of
Database Records Without a Sampling Duration on page 7-103.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-103
Example
You may want to start sampling a temperature when it reaches 100,
and continue sampling it for 5 minutes even if it starts to decline after
only a minute.
Collection of Database Records Without a
Sampling Duration
The following diagrams show the collection of database records for
Triggered Sample events in which a duration of sampling is not
specifiedin other words, database records will be created only while
the trigger is on. The diagrams assume a sample rate of 5 seconds.
The Basic Triggered Sample Event
A basic Triggered Sample event is shown in the diagram below.
Figure 7-64 The basic Triggered Sample event
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-104
Note the following:
A database record is created as soon as the trigger fires. In
practice, it is created when the trigger item is checked and found
to be true. There is a slight delay (no more than 23 seconds) after
the trigger fires.
The second record is created as soon as the system clock reaches
the next multiple of 5 secondsfor example, 1:06:05.
Further records are created at the predefined sample time until the
trigger goes off. The sample times are taken from the system
clock.
The last record is the one taken at the last sample time prior to the
trigger value changing to off.
No record is created when the trigger switches off.
As long as the trigger expression evaluates to True, a change in its
value has no effect on database record creation. Thus if the trigger
expression is x>10 and the value reaches 11, the event is
triggered. A further change to 12 or more does not trigger it again,
but a change to 10 or 9 will bring the event to a close.
Each database record includes the current trigger value, not just
the initial value that triggered the event. So a change from 11 to
12 will be reflected in the database records.
Rapid Trigger Changes
The diagrams below show what happens when the trigger changes
quickly. Three scenarios are represented. If it changes to Off before
the first multiple of 5 seconds is reached on the system clock, the only
record created is when the trigger fired (see the upper diagram). We
recommend that the trigger should not change more frequently than 2
seconds.
A. The trigger fires but goes off before the system clock reaches
the first multiple of 5 seconds. In this case the only record is the
one created when the trigger fires.
B. The trigger fires and stays on until after the system clock
reaches the first multiple of 5 seconds. In this case two records are
usually created. One is created when the trigger fires, and usually
one at the multiple of 5 seconds; but sometimes the 23 second
delay associated with the first record may mean the second one is
not created.
Example
If the trigger fires at 1:06:01, and the lag time is 2 seconds, a record
will be created at 1:06:03 and another one at 1:06:05.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-105
On the other hand, if the trigger fires at 1:06:04, the first record is
time-stamped at 1:06:06. If the trigger goes off at 1:06:09 no further
record will be created.
C. The trigger, having been on for a while, goes off and then comes
quickly on again, before the next multiple of 5 seconds is reached.
In this case records are created when:
The trigger first comes on.
The system clock reaches a multiple of 5 seconds.
The trigger comes on again.
Figure 7-65 Database records collected when the trigger changes quickly
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-106
Collection of Database Records Using a
Sampling Duration
When defining Triggered Sample events you have the option to specify
a period during which sampling will continue. If you do this, the
following will happen:
When the trigger fires, a database record is created.
The system begins counting the specified duration from the time
the trigger fires, creating database records at every multiple of 5
seconds on the system clock (assuming the sample rate is set to 5
seconds).
Database record creation continues until the specified duration
expires, even if the trigger reverts to False in the meantime. In
other words, the duration takes precedence over the trigger value.
If the trigger remains True after the expiry of the specified
duration, no more records are collected until the trigger fires again.
Again, the duration takes precedence over the trigger value.
A Basic Triggered Sample Event Using a
Duration
When you specify a duration for sampling, database records are only
collected during the specified period, even if the trigger remains True
afterwards.
Figure 7-66 Database records collected using a duration
Note the following in this method of collecting:
A record is created when the trigger fires.
Successive records are created when each multiple of 5 seconds is
reached on the system clock.
The last record is the one collected at the 5-second multiple prior
to expiry of the duration, even if the trigger remains True.
No record is created when the duration expires.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-107
Other Duration Scenarios
Other duration scenarios are shown in the figures below. Note the
following:
Once the duration period has started, record collection will
continue until it expires, even if the trigger reverts to False in the
meantime.
The duration takes precedence over any trigger changes that occur
while it is still in effect. Note that in B below the change from False
to True during the first duration has no effect, but the one after the
expiry of the duration begins a new event.
Figure 7-67 Other scenarios using a duration
The figure below shows what happens when you use a trigger
expression such as x>10 or x<10. In scenario C the trigger value
starts at 0, then changes to 12, initiating sampling for the duration
of 15 minutes. The trigger stays at 12 until after the duration
expires, and then changes to a new True value, say 16. This
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-108
initiates a new event. Note that even though the trigger was still
True after the duration expired, it did not initiate a new event until
it changed to a new True value.
In scenario D the trigger value changes to a new True value while
the duration is still in force. This has no effect, and the sampling
stops as soon as the duration expires. It will not start again until
either (i) the trigger value changes to a new True value, or (ii) the
trigger value falls below 10 and then rises above it again.
Figure 7-68 Triggers and durations using > or < comparison and a duration
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-109
Limitations of Triggered Sample Events
The following limitations apply to Triggered Sample events:
You can only use one trigger item for a Triggered Sampled event. If
you want to use a more complex expression as a trigger, you could
use an OPC bridge such as the Activplant Real-Time Logic Engine.
This would gather a number of possible trigger scenarios into one
trigger item.
Acknowledgment of the variable value is not available.
The actual trigger value as used in the event is not available as a
data item in VPWeb. But there is nothing to stop you using the
same OPC data item as a data item that you can drag and drop into
VPWeb. The trigger value is stored in the database within the
database record for the event.
The minimum sample period is every 5 seconds. The maximum is
6 000 seconds.
The minimum duration is 5 seconds. There is no maximum for the
duration.
The trigger item should not change value more than once every
two seconds.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-110
Defining Event Data Items on an Asset
Event data items are rather more complex than accumulators,
incidents, or identifiers. They consist of the event itself, and the
variables that are collected when the event occurs.
This section covers the following topics:
Creating a Sample Time Event on page 7-110
Creating a Value Change Event on page 7-112
Creating an OPC Real-Time Event on page 7-116
Creating a Triggered Sample Event Without a Duration on page
7-118
Creating a Triggered Sample Event That Uses a Duration on page
7-121
Creating a Numeric Event Variable for an Asset on page 7-123
Creating an Alphanumeric Variable for an Asset on page 7-126
Viewing and Editing Data Item Definitions on an Asset on page
7-89
Numeric and Alphanumeric Event Variables on page 7-130
Creating a Sample Time Event
Use the instructions below to create a Sample Time event for an asset.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Data Collection Configuration task
module using the instructions in Opening the Data Collection
Configuration Module on page 7-3.
Defined one event data collection category and added it to an asset
using the instructions in Adding a Non-Incident Category to an
Asset on page 7-71.
Procedure
1 In the Plant Hierarchy frame, navigate to the asset whose data
items you want to copy, and select the asset.
2 In the Collection Configuration frame, navigate to the
appropriate event collection category and select it.
The grid displays any events that have already been added.
Note: Event data items have an option called OPC real time item. Be sure to switch
this option on if you want to display event data in a gauge control in Layout
View. Gauge controls display only real-time data.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-111
3 On the toolbar, click the New button.
The Add Event Item to Asset wizard starts.
4 Click Next to move past the welcome page.
The Name and Description page of the wizard opens.
Figure 7-69 The Name and Description page of the Add Event Item to Asset wizard
5 Type a name (up to 50 characters) for the event, and, if desired, a
description (up to 255 characters).
6 Click Next.
Figure 7-70 Event Properties wizard page
7 In the Event Properties page, click the down-arrow by the Trigger
type field and choose Sample Time, then enter a sample interval
(seconds) in the Sample time field. The minimum value is 5
seconds and the maximum 6000 seconds.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-112
8 If you want the event to monitor real-time data from this event,
check the OPC real-time item checkbox. If you want readings to
be saved in the database (rather than only available as real-time
items), ensure the Collect historical data checkbox is checked.
Note that acknowledgment is not an option for sampled events.
9 Click Next.
Figure 7-71 The Event Trigger and Other Properties wizard page
10 Do the following:
a) On the Event Trigger and Other Properties wizard page,
type a note about the event (up to 255 characters) if desired.
b) Ensure the Active checkbox is checked.
11 Click Next.
The final page of the wizard opens.
12 Review the definition, then click Finish to save it.
Creating a Value Change Event
Use the instructions below to create a Value Change event for an
asset.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Data Collection Configuration task
module using the instructions in Opening the Data Collection
Configuration Module on page 7-3.
Define one event data collection category and added it to the
asset. See Adding a Non-Incident Category to an Asset on page
7-71 for information on how to do this.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-113
Procedure
1 In the Plant Hierarchy frame, navigate to the asset to which you
need add a value change event, and select it.
2 In the Collection Configuration frame, navigate to the
appropriate event collection category and select it.
The grid displays any events that have already been added.
3 On the toolbar, click the New button.
The Add Event Item to Asset wizard starts.
4 Click Next to move past the welcome page.
Figure 7-72 The Name and Description page of the Add Event Item to Asset wizard
5 Type a name (up to 50 characters) for the event, and, if desired, a
description (up to 255 characters). Click Next.
6 Click Next.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-114
Figure 7-73 Creating a value-triggered event
7 In the Event Properties page, click the down-arrow by the Trigger
type field and choose Value Change. If you want to use a filter
expression other than the default of x=*, enter it in the Trigger
value field. For information about expressions, see Trigger
Expressions for Events on page 7-98 and Filtering Data by Means
of Expressions on page 7-143.
8 If you want this event to monitor real-time data, check the OPC
real-time item checkbox. If you want to store the data in the
database, check the Collect historical data checkbox.
9 Do one of the following:
a) If you do not want ActivEssentials to acknowledge events of
this type, ensure the Acknowledge events of this type
checkbox is cleared, and proceed to Step 10.
b) If you want ActivEssentials to acknowledge events of this type,
check the Acknowledge events of this type box, then enter
the acknowledgment access path and the Acknowledgment OPC
item address to which the acknowledgment should be sent. If
you dont know the address, click the ellipsis button by the
OPC item field and browse to the OPC item, then select it and
click OK. Then ensure that the Active checkbox for
acknowledgements is checked.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-115
Figure 7-74 Selecting an OPC server item for the acknowledgment
10 In the wizard, click Next.
Figure 7-75 The Event Trigger and Other Properties wizard page
11 Type the access path and the OPC item address for the event. If
desired, type a note about the event (up to 255 characters).
Note: If you wish, you can type both the access path and the OPC item into the OPC
item field, and leave the Access Path field blank.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-116
a) If you do not know the access path, click the ellipsis button
beside the OPC item field, then navigate to and select the OPC
item you need to use then click OK.
The OPC Items Browser opens, which displays a network hier-
archy.
b) Ensure that the Active checkbox is checked.
12 Click OK.
13 Click Next.
The final page of the wizard opens.
14 Review the definition, then click Finish to save it.
Creating an OPC Real-Time Event
Use the instructions below to create an OPC real-time event.
ActivEssentials does not store OPC real-time events in the database,
but displays them in real-time only. Asset States are OPC real-time
events, but you can also define your own real-time events. Since there
is no trigger for an OPC real-time event, you do not need to add a filter
expression.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Data Collection Configuration task
module using the instructions in Opening the Data Collection
Configuration Module on page 7-3.
Procedure
1 In the Plant Hierarchy frame, navigate to the asset to which you
need add an OPC real-time event, and select it.
2 In the Collection Configuration frame, navigate to the
appropriate event collection category and select it.
The grid displays any events that have already been added.
3 On the toolbar, click the New button.
The Add Event Item to Asset wizard starts.
4 Click Next to move past the welcome page.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-117
Figure 7-76 The Name and Description page of the Add Event Item to Asset wizard
5 Type a name (up to 50 characters) for the event, and, if desired, a
description (up to 255 characters).
6 Click Next.
Figure 7-77 Creating an OPC Real Time event
7 On the Event Properties page, click the down-arrow by the Trigger
type field and choose OPC Real Time.
The other options in the page are disabled. Acknowledgment is not
available for OPC real-time events.
8 Click Next.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-118
Figure 7-78 The Event Trigger and Other Properties page
9 If desired, type a note about the event (up to 255 characters).
Ensure the Active checkbox is checked.
10 Click Next.
The final page of the wizard opens.
11 Review the definition, then click Finish to save it.
Creating a Triggered Sample Event
Without a Duration
Use the instructions below to create a Triggered Sample event that
does not have a duration assigned.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Data Collection Configuration task
module using the instructions in Opening the Data Collection
Configuration Module on page 7-3.
Created at least one event category and assigned it to the asset
using the instructions in Adding a Non-Incident Category to an
Asset on page 7-71.
Read Triggered Sample Events on page 7-100 and Triggered
Sampled EventsModes of Collection on page 7-102.
Note: The Access Path and OPC item fields are shaded when creating OPC
real-time events.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-119
Procedure
1 In the Plant Hierarchy frame, navigate to and select the asset to
which you want to add the data item.
2 In the Collection Configuration frame, expand the Collection
Categories option until you can see the event category to which
you want to add the event, then select it.
The grid displays any events that have already been added.
3 On the toolbar, click the New button.
The Add Event Item to Asset wizard starts.
4 Click Next to move past the welcome page.
Figure 7-79 The Name and Description page of the wizard
5 Type a name (up to 50 characters) for the event, and, if desired, a
description (up to 255 characters).
6 Click Next.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-120
Figure 7-80 Creating a Triggered Sample event
7 In the Event Properties page, click the down-arrow by the Trigger
type field and choose Triggered Sample.
Acknowledgment is not available for Triggered Sample events.
8 In the Trigger value field, type a trigger expression such as x>100.
For information on trigger expressions, see Trigger Expressions for
Events on page 7-98.
9 Type a sampling frequency (in seconds) in the Sample time field.
The minimum is 5 seconds and the maximum is 6000 seconds.
10 Leave the Limit Triggered Sample Duration checkbox
unchecked. If you want to collect historical data for this event,
ensure the Collect historical data checkbox is checked.
11 Click Next.
Figure 7-81 The Event Trigger and Other Properties wizard page
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-121
12 Type the access path and the OPC item address for the event. If
desired, type a note about the event (up to 255 characters).
a) If you do not know the access path, click the ellipsis button
beside the OPC item field, then navigate to and select the OPC
item you need to use then click OK.
The OPC Items Browser opens, which displays a network hier-
archy.
b) Ensure that the Active checkbox is checked.
13 Click Next.
The final page of the wizard opens.
14 Review the definition and click Finish.
Creating a Triggered Sample Event That
Uses a Duration
Use the instructions below to create a Triggered Sample event that
controls the sampling time.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Data Collection Configuration task
module using the instructions in Opening the Data Collection
Configuration Module on page 7-3.
Created at least one event category and assigned it to the asset
using the instructions in Adding a Non-Incident Category to an
Asset on page 7-71.
Read Triggered Sample Events on page 7-100 and Triggered
Sampled EventsModes of Collection on page 7-102.
Procedure
1 In the Plant Hierarchy frame, navigate to and select the asset to
which you want to add the data item.
2 In the Collection Configuration frame, expand the Collection
Categories option until you can see the event category to which
you want to add the event, then select it.
The grid displays any events that have already been added.
3 On the toolbar, click the New button.
The Add Event Item to Asset wizard starts.
4 Click Next to move past the welcome page.
Note: If you wish, you can type both the access path and the OPC item into the OPC
item field, and leave the Access Path field blank.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-122
Figure 7-82 The Name and Description page of the wizard
5 Type a name (up to 50 characters) for the event, and, if desired, a
description (up to 255 characters).
6 Click Next.
Figure 7-83 Creating a Triggered Sample event
7 In the Event Properties page, click the down-arrow by the Trigger
type field and choose Triggered Sample.
Acknowledgment is not available for OPC real-time events.
8 In the Trigger value field, type a trigger expression such as x>100.
For information on trigger expressions, see Trigger Expressions for
Events on page 7-98.
9 Type a sampling frequency (in seconds) in the Sample time field.
The minimum is 5 seconds and the maximum is 6000 seconds.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-123
10 If unchecked, select the Limit Triggered Sample Duration
checkbox and enter a value (seconds) in the field.
The minimum duration is 5 seconds; there is no maximum.
11 If you want to collect historical data for this event, ensure the
Collect historical data checkbox is selected.
12 Click Next.
Figure 7-84 The Event Trigger and Other Properties wizard page
13 Type the access path and the OPC item address for the event. If
desired, type a note about the event (up to 255 characters).
a) If you do not know the access path, click the ellipsis button
beside the OPC item field, then navigate to and select the OPC
item you need to use then click OK.
The OPC Items Browser opens, which displays a network hier-
archy.
b) Ensure that the Active checkbox is checked.
14 Click Next.
The final page of the wizard opens.
15 Review the definition and click Finish.
Creating a Numeric Event Variable for an
Asset
Use the instructions below to create a numeric event variable.
Note: If you wish, you can type both the access path and the OPC item into the OPC
item field, and leave the Access Path field blank.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-124
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Data Collection Configuration task
module using the instructions in Opening the Data Collection
Configuration Module on page 7-3.
Read about the numeric event options that are available inNumeric
and Alphanumeric Event Variables on page 7-130.
Created at least one event category and at least one event, and
added them to the asset.
Procedure
1 In the Plant Hierarchy frame, navigate to the asset to which you
need add the data item, and select it.
2 In the Collection Configuration frame, expand the Collection
Categories option until you can see the event category, and then
expand the category by clicking on the + sign, then select the
Numerics item below it.
The grid displays any numeric variables that have already been
added.
3 On the toolbar, click the New button.
The Add Numeric Variable to Asset wizard starts.
4 Click Next to move past the welcome page.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-125
Figure 7-85 The Name and Description wizard page
5 Do one of the following:
a) To create a new item, ensure the New item checkbox is
checked.
b) To use a previously defined global item, clear the New item
checkbox, then click the ellipsis button by the Name field to
open the Global Definition Items list, and choose one of the
global variables that have been defined, then click OK.
6 Click Next.
The Numeric Variable Properties page of the wizard opens.
7 If you are defining a new item and left the New item checkbox
checked in the previous page, type the name for the variable (up to
50 characters). If you chose a global variable in the previous page,
the Name field here is shaded.
8 Type the access path and the OPC item address for the event. If
desired, type a note about the event (up to 255 characters).
a) If you do not know the access path, click the ellipsis button
beside the OPC item field, then navigate to and select the OPC
item you need to use then click OK.
The OPC Items Browser opens, which displays a network
hierarchy.
b) Ensure that the Active checkbox is checked.
The browser closes and the access path and OPC item appear in
the OPC item field.
9 On the wizard page, enter values for the Multiplier, Offset, Filter,
and Lo, LoLo, Hi, and HiHi values. For more information about
Note: If you wish, you can type both the access path and the OPC item into the OPC
item field, and leave the Access Path field blank.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-126
these properties, see Numeric and Alphanumeric Event Variables
on page 7-130.
10 Click Next.
The Numeric Variable Item Properties page of the wizard opens.
Figure 7-86 The Numeric Variable Item Properties wizard page
11 Select units of measurement and a format for the data. If you are
using a paging system and want extreme values of the variable to
fire an alert, check the Alerts enabled checkbox.
12 If desired, type a note about the variable (up to 255 characters).
Ensure that the Active checkbox is checked.
13 Click Next.
The final page of the wizard opens.
14 Review the definition, then click Finish to save it.
Creating an Alphanumeric Variable for an
Asset
Use the instructions below to create an alphanumeric event variable.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Data Collection Configuration task
module using the instructions in Opening the Data Collection
Configuration Module on page 7-3.
Read about the alphanumeric event options that are available in
Numeric and Alphanumeric Event Variables on page 7-130.
Created at least one event category and at least one event, and
added them to the asset.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-127
Procedure
1 In the Plant Hierarchy frame, navigate to the asset to which you
need add the data item, and select it.
2 In the Collection Configuration frame, expand the Collection
Categories option until you can see the event category. Expand
the category by clicking on the + sign, then select the
Alphanumerics item below it.
The grid displays any alphanumeric variables that have already
been added.
3 On the toolbar, click the New button.
The Add Alphanumeric Variable to Asset wizard starts.
4 Click Next to move past the welcome page.
Figure 7-87 The Name and Description wizard page
5 Do one of the following:
a) To create a new item, ensure the New item checkbox is
checked, then click Next.
b) To use a previously defined global item, clear the New item
checkbox, then click the ellipsis button by the Name field to
open the Global Definitions Items list, choose one of the global
variables that have been defined, then click OK followed by
Next.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-128
6 If you left the New item checkbox checked in the previous page,
type the name for the variable (up to 50 characters). If you chose a
global variable in the previous page, the Name field here will be
greyed.
7 For the Access path and OPC item fields, do the following:
a) In the Access path field, type the path to the OPC item.
b) In the OPC item field, type the OPC item name.
c) If you do not know the access path, click the ellipsis button to
the right of the OPC item field.
The OPC Items Browser opens, which displays a network
hierarchy.
Figure 7-88 Finding an OPC item
d) In the OPC Items Browser, navigate to and select the OPC
item you need to use, and then click OK.
The browser closes and the access path and OPC item appear in
the OPC item field.
8 When all information is complete, click Next.
Note: If you wish, you can type both the access path and the OPC item into the OPC
item field, and leave the Access Path field blank.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-129
Figure 7-89 The Alphanumeric Variable Properties wizard page
9 If you wish to filter data using an expression, type the expression
in the Filter field. For more information about expressions, see
Filtering Data by Means of Expressions on page 7-143. You may
also type a note about the variable (up to 255 characters) in the
Note field.
10 Ensure the Active checkbox is checked.
11 Click Next.
The final page of the wizard opens.
12 Review the definition, then click Finish to save it.
Viewing and Editing Event Data Item
Definitions on an Asset
Use the instructions below to view or edit the properties of data items
that have been added to an asset.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Data Collection Configuration task
module using the instructions in Opening the Data Collection
Configuration Module on page 7-3.
Added a data item to an asset.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-130
Procedure
1 In the Plant Hierarchy frame, navigate to the asset whose data
items you need to view, and select it.
2 In the Collection Configuration frame, navigate to the
appropriate event collection category and select it.
The grid displays the data items belonging to this event category
that have been assigned to the asset.
3 Right-click on the data item in the grid and select Properties.
Figure 7-90 The event Properties dialog box
The Properties dialog box varies slightly according to the type of
event that you are viewing.
4 In the Properties dialog box, make the desired changes, then click
OK.
Numeric and Alphanumeric Event
Variables
An event variable can be numeric or alphanumeric. Numeric variables
have the following properties that you will need to supply when
defining them in the Add Numeric Variable to Asset wizard:
Note: You can also edit definitions directly in the grid. Click or double-click in the
appropriate column and edit. Your changes will be saved when you click
outside the row that you have been editing.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-131
Alphanumeric variables do not have most of the properties listed
above for numeric variables.
Table 7-3 Properties of numeric variables
Property Explanation
Multiplier Enter a multiplier that will convert the units actually read from
the PLC to the units you wish to display in VPWeb. For
example, a pressure may be read in lb./sq.ft. but you want to
display it in kiloPascals.
Offset This optional field allows you to add or subtract a number from
the value sampled. For example, when converting from Celsius
to Fahrenheit you must add 32 degrees, so you would type +32
in this field. Note that the offset can only be applied after the
multiplier, so you cannot convert from Fahrenheit to Celsius in
the same way; you would have to use a calculation instead.
Filter Enter the expression that you want to use to filter data
collection. The default x=* means that all values will be
collected. For more information, see Filtering Data by Means of
Expressions on page 7-143.
LoLo, Lo, Hi, HiHi These are threshold values that are used in some controls in
Layout View or Trend View of VPWeb. They represent the low
danger value; the low warning value; the high warning
value; and the high danger value, respectively.
Unit The units in which the variable is measured and displayed.
Format The numeric format, such as 0.00, etc.
Note (Optional) Type notes about the variable here (up to 255
characters).
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-132
Asset States
Assets in the plant can experience several different states, such as
Running, Faulted, Stopped, etc. In the Data Collection Configuration
module of AppCenter you create and name the states that are used
throughout the entire plant, and you assign to each state a color that
displays in VPWeb. On the asset level (see Adding Asset States to an
Asset on page 7-137), you apply the states to specific assets.
Asset states also have a priority ranking. These are used to determine
which state gets recorded in the database if more than one occurs at
the same time. For example, if an asset becomes Jammed, its state
changes to Jammed; then the operator pushes the E-stop button and
the asset is now also Faulted. If the ON and OFF bits in the PLC are
not mutually exclusive, the two states exist at the same time in the
PLC but only the state with the higher priority (i.e. the lower number)
will be recorded. If the two states have the same priority ranking, then
the one that occurred first will be reported.
If the bits in the PLC are mutually exclusive, the priority of states is
irrelevant because only one state will exist at any moment.
This section covers the following topics:
Creating an Asset State on page 7-132
Viewing and Editing Asset State Properties on page 7-135
Copying Asset States Within the Same Asset on page 7-136
Deleting Asset States on page 7-136
Adding Asset States to an Asset on page 7-137
Copying Asset States Between Assets on page 7-140
Deleting an Asset State From an Asset on page 7-141
Priorities in Asset States on page 7-142
Creating an Asset State
Use the instructions below to create a global asset state that you can
apply to all assets in your data collection system. Asset states are
always global; you cannot create any local states.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Data Collection Configuration task
module using the instructions in Opening the Data Collection
Configuration Module on page 7-3.
Read Priorities in Asset States on page 7-142.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-133
Procedure
1 In the Plant Hierarchy frame, select the Object Library.
2 In the Global Collection Configuration frame, click the Asset
States icon.
The grid displays any asset states that have already been defined.
3 On the toolbar, click the New button.
The Add New Asset State Definition wizard starts.
4 Click Next to proceed past the welcome page.
Figure 7-91 The New Asset State Definition wizard
5 Type a name (up to 50 characters), and, if desired, a description
(up to 255 characters). Click Next.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-134
Figure 7-92 Asset State properties
6 In the Default Priority box, type a number for the default priority
for this state (1 = Highest). This is the default priority; it can be
changed when you add this state to an asset.
7 Click the ellipsis button by the Color field. Choose a color for the
state from the palette that opens, and click OK. This is the color
that will display for the state in VPWeb.
8 Back in the wizard, ensure that the Active checkbox is checked if
you want the state to be active.
9 Click Next.
The final page of the wizard opens.
10 Review the definition, then click Finish to save it.
Related topics
See the following related topics:
Priorities in Asset States on page 7-142
Viewing and Editing Asset State Properties on page 7-135
Copying Asset States Within the Same Asset on page 7-136
Deleting Asset States on page 7-136
Adding Asset States to an Asset on page 7-137
Copying Asset States Between Assets on page 7-140
Deleting an Asset State From an Asset on page 7-141
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-135
Viewing and Editing Asset State
Properties
Use the instructions below to view or edit the properties of asset
states. You can edit some properties of an item by clicking in the grid
and editing there. For other properties you have to open the
Properties dialog box.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Data Collection Configuration task
module using the instructions in Opening the Data Collection
Configuration Module on page 7-3.
Created an asset state using the instructions in Creating an Asset
State on page 7-132.
Read Priorities in Asset States on page 7-142.
Procedure
1 In the Plant Hierarchy frame, select the Object Library.
2 In the Global Collection Configuration frame, click the Asset
States icon.
The grid displays any asset states that have already been defined.
3 Right-click on the state in the grid and select Properties.
Figure 7-93 Viewing asset state properties
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-136
4 In the Properties dialog box, make the desired changes, then click
OK.
Copying Asset States Within the Same
Asset
Use the instructions below to copy an asset state. This is useful if you
want to avoid individually configuring asset states; you can just edit
the properties of the copy.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Data Collection Configuration task
module using the instructions in Opening the Data Collection
Configuration Module on page 7-3.
Created an asset state using the instructions in Creating an Asset
State on page 7-132.
Procedure
1 In the Plant Hierarchy frame, select the Object Library.
2 In the Global Collection Configuration frame, click the Asset
States icon.
The grid displays any asset states that have already been defined.
3 Right-click on the state in the grid and select Copy.
4 Right-click in the grid and select Paste.
The new state is copied with the name Copy of (original name).
You can then edit the properties of the copy.
Deleting Asset States
Use the instructions below to delete an asset state.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Data Collection Configuration task
module using the instructions in Opening the Data Collection
Configuration Module on page 7-3.
Created an asset state using the instructions in Creating an Asset
State on page 7-132.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-137
Procedure
1 In the Plant Hierarchy frame, select the Object Library.
2 In the Global Collection Configuration frame, click the Asset
States icon.
The grid displays any asset states that have already been defined.
3 Right-click on the state in the grid and select Delete.
A confirmation dialog box opens.
4 Click OK.
Adding Asset States to an Asset
Use the instructions below to add an asset state to an asset.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Data Collection Configuration task
module using the instructions in Opening the Data Collection
Configuration Module on page 7-3.
Created an asset state using the instructions in Creating an Asset
State on page 7-132.
Procedure
1 In the Plant Hierarchy frame, expand the hierarchy, then select
the asset to which you want to add the asset state.
2 In the Collection Configuration frame, select the Asset States
option.
The grid displays any states that have been added to the asset
already.
3 On the toolbar, click the New button.
The Add Asset State to Asset wizard starts.
4 Click Next to move past the welcome page.
Note: To save time, create a single asset first and add the data items and asset
states to it. Then copy and paste the asset to other parts of the plant hierarchy.
Then you only need to change the data item addresses.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-138
Figure 7-94 The Name wizard page
5 Do one of the following:
a) To create a new state, ensure the New item checkbox is
checked.
b) To select a previously defined state, do the following:
Clear the New item checkbox, and then click the ellipsis
button to the right of the Name field.
Figure 7-95 The Global Definition Items dialog box
Select a global item and click OK.
6 Click Next.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-139
Figure 7-96 The Asset State Properties wizard page
7 If you are creating a new item, enter the name in the Name field.
8 For the Access path and OPC item fields, do the following:
a) In the Access path field, type the path to the OPC item.
b) In the OPC item field, type the OPC item name.
c) If you do not know the access path, click the ellipsis button to
the right of the OPC item field.
The OPC Items Browser opens, which displays a network
hierarchy.
Figure 7-97 Finding an OPC item
Note: If you wish, you can type both the access path and the OPC item into the OPC
item field, and leave the Access Path field blank.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-140
d) In the OPC Items Browser, navigate to and select the OPC
item you need to use, and then click OK.
The browser closes and the access path and OPC item appear in
the OPC item field.
9 Enter a number for the trigger value. This is the value in the PLC
that will activate the state. Note that you cannot use an expression
here; you must just enter an integer value.
10 If asset states are not programmed to be mutually exclusive in the
PLC, enter a value for the priority for this state in the Priority field.
If states are programmed to be mutually exclusive, the value in
this field is irrelevant, so you can leave it at the default value. For
more information on priorities, see Priorities in Asset States on
page 7-142.
11 Click the ellipsis button by the Color field and choose a color for
the state. Click OK.
12 Click Next.
The final page of the wizard opens.
13 Review the definition, then click Finish to save it.
Copying Asset States Between Assets
Use the instructions below to copy an asset state from one asset to
another. This is useful if you want to avoid configuring asset states for
several different assets. Define the states on one asset, then copy
them to other assets. (To save even more time, define a single asset
completely, then copy the asset itself.)
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Data Collection Configuration task
module using the instructions in Opening the Data Collection
Configuration Module on page 7-3.
Created an asset using the instructions in Creating an Asset State
on page 7-132.
Note: If the trigger is a Boolean value, some OPC servers require that you use -1
instead of 1 to describe the true value. VPFoundation does not convert
Boolean values of -1 to 1, but VPCollector does.
Note: If you want to add another state to the asset, select the Run this wizard again
checkbox before you click Finish.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-141
Procedure
1 In the Plant Hierarchy frame, navigate to and select the asset
whose state you want to copy.
2 In the Collection Configuration frame, select the Asset States
option.
The grid displays any states that have been added to the asset
already.
3 Right-click on the state in the grid and select Copy.
4 In the Plant Hierarchy frame, navigate to and select the asset to
which you want to copy the state, and select it.
Ensure that the Asset States option is selected in the Collection
Configuration frame, and that the grid displays the states for this
asset.
5 Right-click in the grid and select Paste.
Deleting an Asset State From an Asset
Use the instructions below to delete an asset state from an asset.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Data Collection Configuration task
module using the instructions in Opening the Data Collection
Configuration Module on page 7-3.
Created an asset state using the instructions in Creating an Asset
State on page 7-132.
Assigned an asset state to an asset using the instructions in Adding
Asset States to an Asset on page 7-137.
Procedure
1 In the Plant Hierarchy frame, navigate to and select the asset
whose state you want to delete.
2 In the Collection Configuration frame, select the Asset States
option.
The grid displays any states that have been added to the asset
already.
3 Right-click on the data item in the grid and select Delete.
A confirmation dialog box opens.
4 Click OK.
Note: You cannot copy an asset state to another asset if the same asset state already
exists.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-142
Priorities in Asset States
Asset States have a priority ranking. The priority determines which
state gets recorded in the database if more than one occurs at the
same time.
Example
An asset becomes jammed, and its state changes from Running to
Jammed. The operator pushes the E-stop button, and the asset is now
also Faulted. The ON and OFF bits in the PLC are not mutually
exclusive, so the two states exist at the same time in the PLC. The
state with the higher priority ranking is recorded in the database. If
the two states have the same priority ranking, the one that occurred
first is recorded in the database.
If the bits in the PLC are mutually exclusive, only one state will exist at
a time, and the priority is therefore irrelevant.
By default, all asset states have a priority of 1 (the highest). You can
change this priority when you add the state to an asset.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-143
Filtering Data by Means of Expressions
ActivEssentials allows you to filter data as it is collected by using a
filtering expression. The expression controls the conditions under
which VPCollector will record the value of the data item. The
advantage of this is that you can limit the amount of redundant data
collected.
This section covers the following topics:
Using Expressions to Filter Data on page 7-143
Valid Expressions for Filtering Data on page 7-143
Rollover Values on page 7-145
Expressions for Accumulators on page 7-145
Expressions for Events on page 7-147
Expressions for incidents on page 7-149
Using Expressions to Filter Data
ActivEssentials gives you the option to filter the recording of
accumulators, events, or incidents by use of expressions. This option
is available when you create the data items at the local (asset) level.
The data item wizards contain a Trigger or a Filter column in which you
can type an expression that will set the conditions under which
VPCollector records the value of the item.
1 If you are interested only in readings within a certain range, you
can use an expression that sets the upper and lower limits of the
range.
2 If you want to exclude certain values so that they are not recorded,
you can use an expression that excludes these values.
3 If the trigger is a boolean (ON/OFF) value, you can set it to record
when the value is either 1 or 0, using x=1 or x=0.
Note that expressions do not apply to real-time data because real-time
data comes directly from the OPC server. They also do not apply to
asset states because states are never filtered; they are simply
triggered by a value in the PLC.
Valid Expressions for Filtering Data
Expressions used to filter collection of data items are based on
Microsoft VBScript

. For full information about expressions in

VBScript, consult a standard text. The table below lists the expressions
supported by VPCollector.
Note: You monitor a temperature but you are only interested in those times when it
exceeds a certain level. If you add the expression x > 100 to the temperature
data item, VPCollector will only record the value when the temperature
exceeds 100.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-144
1
You can also use other valid VBScript mathematical functions, such as Tan,
Cotan, Exp, Log, Randomize, Rnd, Sin, Cosin, Sqr, etc.
Table 7-4 Valid expressions for filtering data items
Type of expression Valid format Invalid format/comments
Concrete value x=3
1
1. You can use x or X (lower or upper case), or x(X); but in string values, you
must not use x(X).
Do not use for PLC float values (see
below under Special Cases).
Any value x=* No spaces allowed.
Greater than x>45
Less than x<45
Between certain
values
2<x and x<11 Gives a range of 3 to 10. Do not omit
and.
Not between
certain values
x<3 or x>10 Excludes values of 3 to 10. Do not
omit or.
Alternate values x=2 or x=3 or x=5 No commas; do not omit or.
Excluded values x<>2 and x<>3 and
x<>15
No commas; do not omit and.
Convert decimal,
Word or DWord to
integer
CInt(x)=100 See Data Types and VBScript
Functions on page 7-99.
Not equal x<>9 Can be used for numeric or
alphanumeric expressions
Equal to a string x=abc No spaces allowed before or after
abc.
Includes a string x=abc% The value is recorded whenever it
includes abc.
Anything except
empty
x!= Collects any value except NULL.
Not equal to a
string
x!=abc The value is recorded unless it is
abc.
Does not include a
string
x!=abc% The value is recorded unless it
includes abc.
Note: In many cases a VBScript function is needed to convert the data type of the
value from the OPC server. There are many different data types that can be
configured in the OPC server. See Data Types and VBScript Functions on page
7-99.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-145
Special Cases
If the value is a boolean, use x=1 or x=0.
To record any value, use x=*.
The only acceptable wildcard is % (not ?). Note: This means that
you cannot use the % sign to handle percentages or as part of an
actual string.
If you use an invalid expression, VPCollector will post a message to
the event log. You can view the event log in the Activplant control
panel.
If your expression compares a decimal value in the PLC rather than
an integer, you must either convert the decimal to an integer using
CInt(x)=, or use a comparator (< or >). Different OPC servers use
different number formats for float values.
Comparing a Negative Number
Do not use a WORD or DWORD when comparing a negative number.
For example, if you use an expression x>-4 you really want to record
values of -3, -2, -1, 0, 1, 2, etc. In this case use a SHORT or a LONG.
Overlapping Expressions
Overlap of expressions occurs when two conditions are true at the
same time. For example, if you use the expression x>7 or x=9, and
the actual value is 9, both conditions are true. While overlap does not
usually present a processing problem, it results in unnecessary
transactions and places unnecessary load on the system.
Rollover Values
Rollover values are used with solicited accumulators that are collected
through VPCollector. You can define rollover values in three ways, and
each has a different purpose.
There is a system-wide maximum that you can set through VPTray.
The absolute maximum is 21 000 000, while the default is 210 000.
This acts as a global parameter as it controls how rollover values
are assigned elsewhere in the configuration.
You can also set a default rollover value for an asset so that any
accumulator data item you add adopts this as the rollover value to
use. The default value is 32 000. You can set any number up to the
global limit of 210000.
Finally, you can override the asset rollover value when you add
accumulator data items. See Rollover ValuesAn Overview on
page 3-17 for more information.
Expressions for Accumulators
Accumulators are data items that are timed or counted. There are two
methods to collect accumulators: measure in the PLC, or measure with
VPCollector. Each method has advantages and disadvantages.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-146
If an accumulator is to be collected directly in the PLC, the logic for the
timers or counters must be programmed into the PLC. The timer or
counter increments to a pre-set rollover value and then resets to zero.
For example, if the current value in the PLC register is 5 000, the
rollover value is 32 000, and the previous value was 30 000,
ActivEssentials will recognize the difference as 7 000.
The advantage of having this free wheeling counter/timer in the PLC
is that the accumulator data is collected independently of any time
identifier and is not associated with any time frame. This allows the
user to view data by hour, shift, or production run by aggregating all
the records for the desired time period. The disadvantage is that you
cannot use expressions to filter the collection of data.
Solicited and Unsolicited Collection
When VPCollector actively reads the value from the PLC at a regular,
predefined interval, this is termed solicited collection. You cannot use
expressions with solicited collection because the reading is not
triggered by anything other than the time interval.
The advantage of solicited collection is that VPCollector can recover
values that are missed in the event of network disconnection, or if
VPCollector is shut down and restarted within the predefined cache
data period.
Unsolicited collection occurs when VPCollector reads the value from
the PLC in response to a separate change in the PLC. This trigger
value is defined in the data item editor of MI Admin. The
disadvantages of this method are:
VPCollector cannot recover missing data in the event of network
disconnection; and
Unsolicited collection is less accurate than solicited collection,
because it is part of software and must compete for resources.
Although unsolicited collection of accumulators is not recommended, it
does have the advantage that you can use expressions with it.
Record Generation for Accumulators
You can use all the types of expression listed in Valid Expressions for
Filtering Data on page 7-143 to filter accumulators.
In the case of counters, an accumulator record is created every time
the trigger value changes to a value that is within the range specified
by the expression.
Note: The default maximum for a rollover value is 210 000. You can change this
maximum to as much as 21 000 000. For instructions on doing this, see the
System Configuration Guide (System Configuration Guide.pdf), which is in
the ActivEssentials installation package.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-147
In the case of a timer, the timer continues to increment as long as the
trigger value is true. When the value changes to something outside the
trigger range, the timer stops. It restarts when the value changes back
to something inside the trigger range.
Expressions for Events
Events are snapshots of values taken at a particular point in time.
They have one or more variables associated with them that are
measured when the event fires. The variables may be numeric or
alphanumeric. Measurement occurs in the PLC. Typical event data
items are process variables or machine cycle times. VPCollector
records the time stamp of the OPC server for event data.
Events can be sampled in the following ways:
At a predetermined interval, in which case the sample rate is
defined in MI Admin (Sample Time events).
When a separate trigger variable changes, in which case the
sample point is set within the PLC (Value Change events). In this
case the variables are sampled only once when the trigger fires.
As Triggered Sample events, which are sampled (usually) more
than once, beginning when the trigger fires. For information on
Triggered Sample events, see Triggered Sample Events on page
7-100.
As an OPC real-time data item (OPC real-time events).
For more detailed information on the event types, see Events in
ActivEssentials on page 7-95.
There are two levels of filtering available for events. You can apply a
filter to the event and/or to the event variable.
If you apply a filter expression to the event, none of the variables
within the type will be collected unless the type-level expression
evaluates to True.
If you apply a filter expression to the variable, the value will only
be collected if both the variable-level expression and any type-level
expression evaluate to True. If the type filter is x=*, the collection
depends only on the variable-level filter.
Filtering Value Change Events
A Value Change event can be triggered by a numeric variable or a
string. All the expression types listed in Valid Expressions for Filtering
Data on page 7-143 can be used for Value Change events. Once
triggered, they are not triggered again until the value changes to a
different valid value.
Warning! You have a triggered counter that uses the expression x>2 and x<10. The
counter value changes to 7, and a record is created. It then changes to 4,
and another record is created. It then changes to 12, and no record is
created. Finally, it changes to 6, and another record is created.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-148
Example of filtering value change events
The event trigger is x>5. The PLC value changes to 6 and this triggers
the collection. If the value remains at 6 there will be no more data
collection. If it changes to 7, collection is triggered again.
The variables within the event are collected whenever the event filter
is True and their own filter also evaluates to True. If the variable filter
is x=* their values will always be collected if the type filter is True.
The value that triggers the event can be written back to the PLC as a
form of data acknowledgement. This value can either be numeric or a
string.
Filtering Triggered Sample Events
For information on filtering Triggered Sample events, see Trigger
Expressions for Events on page 7-98.
Event Variables
Filtering event variables allows you to collect data only when the value
is within the range of the expression. If the value does not pass the
filter no record is inserted. Filtering is a very good way to limit
database load by only storing data that is relevant to the users.
Event variables are only collected when the event filter is True. When
the event is triggered all associated event variables are evaluated, and
if they pass their individual filters they are collected and stored.
Numeric Variables
Numeric variables can use all of the expression types listed in Valid
Expressions for Filtering Data on page 7-143, with the following
exceptions:
x=*
x=abc%
x!=abc
x!=abc%
Alphanumeric Variables
Alphanumeric variables can use only the following expressions:
x=*
x=abc%
x!=abc
x!=abc%
Note that the expression x(X)=abc is not valid, and the percentage sign
(%) is not a legal string character.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-149
Expressions for incidents
Incidents are data items that involve a switch between an ON state
and an OFF state. An incident therefore has a start time, an end time
and a duration. For example, a fault incident begins to be measured
when the relevant bit or word value changes, and it stops being
measured when the bit changes back.
Incidents can be triggered using any of the expressions listed in Valid
Expressions for Filtering Data on page 7-143. When VPCollector sees a
valid trigger value in the PLC, it opens the associated incident. The
incident will not close until the trigger value returns to a non-trigger
value.
An incident will not close if the trigger changes from one valid trigger
value to another valid trigger value. Rather than close the incident and
reopen the same incident, VPCollector keeps the incident open.
Incident Priorities
You can use incident priorities to control how ActivEssentials displays
incidents. If you assign a priority of 1 to all incidents, there can be only
one open incident at a timeif a new incident occurs it is ignored until
the first incident closes.
If you assign different incident priorities, ActivEssentials overrides a
lower priority incident when a higher priority incident occurs. For
example, if a priority 3 incident is already open when a priority 2
incident occurs, ActivEssentials closes the priority 3 incident
(regardless of the state of the PLC) and opens the priority 2 incident.
When the priority 2 incident closes in the PLC it closes in
ActivEssentials. Now if the priority 3 incident is still true in the PLC,
ActivEssentials opens another incident for the priority 3 incident.
If you want to be able to see all incidents regardless of priority, you
should disable priorities on the incident category. ActivEssentials will
then display all the incidents that are open at the same time.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-150
Exporting and Importing
You can export the configuration of the collection categories associated
with any asset in the plant, the configuration of the data items
associated with individual collection categories, and the configuration
of the globally defined collection categories. When you export the
data, you do not export the individual data items, such as individual
accumulators and incidents, just how the collection categories were
defined.
Data exported in this way can be used to build new assets, modify the
data collection configuration of an asset, or make global changes to
the plant. While you can achieve the same results by copying and
pasting among the assets and/or collection categories in the plant, and
then modifying the configuration as needed, you can save time by
using the export and import functions in Data Collection Configuration.
Exporting and importing uses Comma-Separated Values (.csv) files,
which you can view and edit in Microsoft Excel.
This section covers the following topics:
Exporting the Data Collection Configuration for an Asset on page
7-151
Exporting the Asset State Configuration for an Asset on page 7-152
Exporting Data Collection Configuration from the Object Library on
page 7-154
Importing to Create New Data Collection Categories on page 7-155
Importing New Data Items into a Collection Category on page
7-158
Importing New Data Items at the Asset Level on page 7-162
Importing New Asset States for Individual Assets on page 7-166
Operational and Security Considerations on page 7-168
Data Available for Export at the Asset Data Collection Level on
page 7-169
Data Available for Export at the Global Collection Level on page
7-170
Building the Plant Configuration Using Excel on page 7-172
Note: From the Plant Hierarchy frame you can only export configuration data at the
asset level. From the Object Library you can export the configuration data for
items at any level.
Note: Exporting and importing is a fairly complex procedure. CDC Factory has some
Technical Notes that deal with this subject in detail. We also have a Mass
Configuration Tool which enables rapid configuration of large numbers of
assets. Please contact Activplant Support for details.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-151
Exporting the Data Collection
Configuration for an Asset
Use the instructions below to export the data collection configuration
for an asset. The export function can only create Comma Separated
Values (.csv) files, but you can view these in Microsoft Excel. If you
need to make alterations to the configuration, you can do so in Excel
without having to use the MI Admin interface. You must have Excel
installed on your computer if you need to view or modify the data.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Data Collection Configuration task
module using the instructions in Opening the Data Collection
Configuration Module on page 7-3.
Created configuration for data collection. See ActivEssentials
Collection Methods on page 7-17for more information.
Read the following:
Data Available for Export at the Asset Data Collection Level on
page 7-169
Data Available for Export at the Global Collection Level on page
7-170
Building the Plant Configuration Using Excel on page 7-172
Procedure
1 In the Plant Hierarchy frame, navigate to and select the asset
whose data collection configuration you need to export.
The Collection Categories frame refreshes to display the collection
categories defined against the asset.
2 Select any item in the Collection Categories frame (the grid),
and click the Export button on the toolbar.
Note: Any commas used in items names are stripped out when the file is exported.
The system uses the comma to separate items of data. When you import you
should check the names and replace any commas if necessary.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-152
Figure 7-98 The File Download dialog box
3 Do one of the following:
a) If you want to save the exported data, click the Save button.
b) If you want to immediately view the data, click the Open
button.
Exporting the Asset State Configuration
for an Asset
Use the instructions below to export the asset state configuration for
an asset. The export function can only create Comma Separated
Values (.csv) files, but you can view these in Microsoft Excel. If you
need to make alterations to the configuration, you can do so in Excel
without having to use the MI Admin interface. You must have Excel
installed on your computer if you need to view or modify the data.
Note: The File Download dialog box may warn you of security risks associated with
handling files in .csv format. As you know the source of the file, you can safely
either open or save.
Note: If you need to view the data, Microsoft Excel must be installed on the computer
where you are working. If not, save the file in a location where it can be opened
from another computer with Excel. If Excel is installed and you cannot open the
file, your security settings may not allow opening files. If so, save the file locally
and open it using Excel.
Note: After exporting the configuration, you can edit it in Excel and apply the changes
to another asset.
Note: If you have used commas in any names of items, the commas will be stripped
out when you export. This is because the system uses the comma to separate
items of data. When you reimport you should check the names and replace any
commas if necessary.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-153
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Data Collection Configuration task
module using the instructions in Opening the Data Collection
Configuration Module on page 7-3.
Created asset states for the asset that you want to export using
the instructions in Creating an Asset State on page 7-132.
Read Data Available for Export at the Asset Data Collection Level
on page 7-169.
Procedure
1 In the Plant Hierarchy frame, navigate to and select the asset
whose asset state configuration you need to export.
2 Select the Asset States item in the Collection Configuration
frame.
The grid refreshes to display the asset states for the asset.
3 Select any item in the grid, and click the Export button on the
toolbar.
Figure 7-99 The File Download dialog box
4 Do one of the following:
a) If you want to save the exported data, click the Save button.
b) If you want to immediately view the data, click the Open
button.
Note: The File Download dialog box may warn you of security risks associated with
handling files in .csv format. As you know the source of the file, you can safely
either open or save.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-154
Exporting Data Collection Configuration
from the Object Library
Use the instructions below to export the data collection configuration
for Object Library items. The export function can only create Comma
Separated Values (.csv) files, but you can view these in Microsoft
Excel. If you need to make alterations to the configuration, you can do
so in Excel without having to use the MI Admin interface. You must
have Excel installed on your computer if you need to view or modify
the data.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Data Collection Configuration task
module using the instructions in Opening the Data Collection
Configuration Module on page 7-3.
Created a global data collection configuration. For more
information see Creating Global Accumulators, Incidents, and
Variables on page 7-19.
Read the following:
Data Available for Export at the Global Collection Level on page
7-170
Building the Plant Configuration Using Excel on page 7-172
Procedure
1 In the Plant Hierarchy frame, select the Object Library.
The Global Collection Configuration frame opens.
2 Do one of the following:
a) If you need to export the configuration data for the entire
plant, click the Collection Categories button.
Note: If you need to view the data, Microsoft Excel must be installed on the computer
where you are working. If not, save the file in a location where it can be opened
from another computer with Excel. If Excel is installed and you cannot open the
file, your security settings may be preventing it. If so, save the file locally and
open it using Excel.
Note: You have to save each of the files because the web-based version of Excel can
only open one file at a time. When you save the files, use meaningful names.
Note: The data available for export when the Collection Categories button is
selected differs from that available when you select an individual collection
category. See Data Available for Export at the Global Collection Level on page
7-170 for more information.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-155
b) If you need to export the configuration data for a particular
collection category, click the appropriate category button.
The grid refreshes to display either all of the collection categories,
or the collection definitions for the selected category.
3 Click the Export button on the toolbar.
Figure 7-100 The File Download dialog box
4 Do one of the following:
a) If you want to save the exported data, click the Save button.
b) If you want to immediately view the data, click the Open
button.
Importing to Create New Data Collection
Categories
Use the instructions below to create new data collection categories
using Microsoft Excel, and then import these into ActivEssentials.
Note: The File Download dialog box may warn you of security risks associated with
handling files in .csv format. As you know the source of the file, you can safely
either open or save.
Note: If you need to view the data, Microsoft Excel must be installed on the computer
where you are working. If not, choose to save the file in a location where it can
be opened from another computer with Excel. If Excel is installed and you
cannot open the file, your security settings may be preventing it. If so, save the
file locally and open it using Excel.
Note: After exporting the configuration, you can edit this in Excel and apply the
changes to the global configuration.
Note: Asset states are handled differently, so if you need to create new asset states
for an asset, see Importing New Asset States for Individual Assets on page
7-166.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-156
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Data Collection Configuration task
module using the instructions in Opening the Data Collection
Configuration Module on page 7-3.
Exported the data collection configuration for the entire plant. See
Exporting Data Collection Configuration from the Object Library on
page 7-154 for more information.
Read Building the Plant Configuration Using Excel on page 7-172.
Procedure
1 With the exported configuration open in Excel, for each of the new
collection categories you need to create, copy the contents of an
existing row to a blank row and edit this new row to reflect your
needs.
2 On the new rows, change the name value in the Name column to
something unique for that column.
3 For each of the new rows, change the numeric value in the
CollectionMethodID column to fit the following scheme:
a) Incidents = 1
b) Accumulators = 2
c) Variables = 3
d) Identifiers = 4
4 Save the file.
5 Return to the Data Collection Configuration module of
ActivEssentials, and click the Import button on the toolbar.
The Import Data Wizard starts.
6 Click Next to move past the Welcome page.
Note: When copying an existing row, look for rows that already contain very similar
information to what you need.
Note: If the name is not unique when you try to import the new data collection
configuration information, the import operation will fail without providing an
error message.
Note: Do not change any other data in the spreadsheet.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-157
Figure 7-101 The Select File page of the wizard
7 Click the Browse button.
Figure 7-102 The Choose file dialog box
8 Browse to and select the .csv file you saved.
9 Click Open.
10 Click the Import button.
The wizard page confirms the action by displaying the message
Uploading File. When finished, the final page of the wizard opens.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-158
Figure 7-103 The final page of the wizard
11 Check the details on the final page, and click Finish.
Importing New Data Items into a Collection
Category
Use the instructions below to import data collection configuration
information from a Comma Separated Values (.csv) file, for individual
collection categories. When you import configuration data, the import
function will not delete existing items, nor offer error messages if it
has been unable to import items. If you need to add data items for
more than one collection category, you will need to repeat this
procedure for each.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Data Collection Configuration task
module using the instructions in Opening the Data Collection
Configuration Module on page 7-3.
Export the data collection configuration for the entire plant. See
Exporting Data Collection Configuration from the Object Library on
page 7-154 for more information.
Note: Any commas used in items names are stripped out when the file is exported.
The system uses the comma to separate items of data. When you import you
should check the names and replace any commas if necessary.
Note: You should examine the existing configuration to ensure there are no naming
conflicts. Where conflicts occur, these items will not be imported and you will
not receive any error messages.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-159
Procedure
1 With the exported configuration open in Excel, for each of the new
collection categories you need to create, copy the contents of an
existing row to a blank row and edit this new row to reflect your
needs.
Figure 7-104 VPID column in the generated .csv file
2 On each of the new rows, delete the contents of the cells in the
VPID column.
A new VPID is assigned by the system when you import the asset
state configuration.
3 Save the .csv file.
4 With the Data Collection Configuration module open, in the
Plant Hierarchy frame, select the Object Library.
The Global Collection Configuration frame opens.
5 In the Global Collection Configuration frame, select the
appropriate collection category.
6 Select any item in the grid.
7 Click the Import button on the toolbar.
The Import Data Wizard opens.
8 Click Next to move past the Welcome page.
Note: When copying an existing row, look for rows that already contain very similar
information to what you need.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-160
Figure 7-105 The Select File page of the wizard
9 Click Browse.
Figure 7-106 The Choose file dialog box
10 In the Choose file dialog box, navigate to the location of the .csv
file containing the configuration data and select it.
11 Click Open.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-161
Figure 7-107 The wizard confirming the upload of the file
12 Click Import.
The wizard page confirms the action by displaying the message
Uploading File. When finished, the final page of the wizard opens.
13 On the final page of the wizard, click Finish.
Figure 7-108 The final page of the wizard
Note: If you need to run the wizard again to import additional configuration data,
ensure the Run this wizard again checkbox is checked.
Note: Any commas used in items names are stripped out when the file is exported.
The system uses the comma to separate items of data. When you import you
should check the names and replace any commas if necessary.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-162
Importing New Data Items at the Asset
Level
Use the instructions below to edit and then import new data items
from a Comma Separated Values (.csv) file, at the asset level. When
you import configuration data, the import function will not delete
existing items, nor offer error messages if it has been unable to import
items.
Creating new data collection items using the import method requires
several major steps:
Exporting the configuration of an asset to an Asset .csv file.
Exporting the global data collection parameters for each of the
collection categories to individual Category .csv files.
Inserting new rows for the new data items in the Asset .csv file.
Copying data from the Category .csv files to the Asset .csv file.
Importing the new data from the Asset .csv file.
This procedure allows you to set up one asset. If you need to set up
many assets using the first asset as a model, you can copy and paste
the asset to as many locations as needed in the Plant Management
module of MI Admin. For each of these new assets, you should then
export the data collection configuration for editing in Excel. The
following procedure also covers this scenario.
In Steps 2 and 4.b of the following procedure you must first delete
data in the cells in the Definition ID column and later paste new data
in these cells. The term Definition ID is used generically here
because the name of the column differs with each of the four data
collection methods as follows:
Accumulator = AccDefinitionID
Incidents = IncidentDefinitionID
Identifiers = IdentifierDefinitionID
Variables = VariableID
Note: You cannot import the data collection information for all of the collection
categories at the same time; you must deal with each in a separate import
operation.
Note: You should examine the existing configuration to ensure there are no naming
conflicts. Where conflicts occur, these items will not be imported and you will
not receive an error message.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-163
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Data Collection Configuration task
module using the instructions in Opening the Data Collection
Configuration Module on page 7-3.
Exported the data collection configuration for an asset using the
instructions in Exporting the Data Collection Configuration for an
Asset on page 7-151. This the Asset .csv file.
Exported the data collection configuration for each of the individual
collection categories using the instructions in Exporting Data
Collection Configuration from the Object Library on page 7-154.
These are the Category .csv files.
Procedure
1 Open the Asset .csv file in Excel and create as many new rows as
are needed by copying and pasting existing rows of the appropriate
type.
2 On the newly created rows, delete any values in the VPID,
Definition ID, and Name columns.
3 Using the same collection category used for the new rows in the
Asset .csv file, open the appropriate Category .csv file.
4 For each global item in the Category .csv file that you need to
apply at the local level, do both of the following:
a) Copy the contents of the VPID cell to the clipboard.
b) Open the Asset .csv file, and paste the clipboard contents into
the Definition ID cell on a new row.
5 In the other columns, make any needed edits.
6 Save the Asset .csv file.
Note: Copy rows for only one data collection category at a time.
Note: In the following step, you will need to copy data from a Category .csv file to the
Asset .csv file. As the layout of the individual cells in the two spreadsheets
could be different, you may have to copy each of the cells separately.
Note: There are several other columns in the Asset .csv file that will contain
information that you may need to edit, for example. the Access Path, OPC Item
ID, and Trigger.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-164
7 With the Data Collection Configuration module open, in the
Plant Hierarchy frame, navigate to and select the asset that
requires the configuration data.
The Collection Categories frame refreshes to display the
collection categories (if any) defined for the asset.
8 Click the Import button on the toolbar.
The Import Data Wizard opens.
9 Click Next to move past the Welcome page.
Figure 7-109 The Import page of the wizard
10 Click the Browse button.
Figure 7-110 The Choose file dialog box
11 In the Choose file dialog box, navigate to the location of the Asset
.csv file containing the configuration data, select it, and click Open.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-165
Figure 7-111 The wizard confirming the upload of the file
12 Click the Import button.
The wizard page confirms the action by displaying the message
Uploading File. When finished, the final page of the wizard opens.
13 On the final page of the wizard, click Finish.
Figure 7-112 The final page of the wizard
14 Repeat Steps 1 to 13 for each of the collection categories.
Note: Any commas used in items names are stripped out when the file is exported.
The system uses the comma to separate items of data. When you import you
should check the names and replace any commas if necessary.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-166
Importing New Asset States for Individual
Assets
Use the instructions below to create new asset states for individual
assets.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Data Collection Configuration task
module using the instructions in Opening the Data Collection
Configuration Module on page 7-3.
Export the asset state configuration with the required asset states
using the instructions in Exporting the Asset State Configuration
for an Asset on page 7-152.
Procedure
1 Open in Excel the .csv file with the required asset states.
2 Delete all entries in the VPID column.
A new VPID is assigned by ActivEssentials when you import the
asset state configuration.
3 Save the Asset .csv file.
4 With the Data Collection Configuration module open, in the
Plant Hierarchy frame navigate to and select the asset that
requires the asset state configuration data.
The Collection Categories frame refreshes to display the collection
categories (if any) defined for the asset.
5 Select the Asset States item in the Collection Configuration
frame.
The grid refreshes to display the already defined asset states (if
any) for the asset.
6 Select any item in the grid, and click the Import button on the
toolbar.
The Import Data Wizard opens.
7 Click Next to move past the Welcome page.
Note: If you need to import the configuration for additional collection categories, you
can use the same Asset .csv file. When importing, if the detail on any row is
exactly the same as already exists in the database, the row is skipped.
Note: If there are asset states in the .csv file that are not required, you can delete
these rows. However, if the rows duplicate what is already there, there is no
need to delete them.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-167
Figure 7-113 The Import page of the wizard
8 Click Browse.
Figure 7-114 The Choose file dialog box
9 In the Choose file dialog box, navigate to the location of the .csv
file containing the configuration data and select it.
10 Click Open.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-168
Figure 7-115 The wizard confirming the upload of the file
11 Click Import.
The wizard page confirms the action by displaying the message
Uploading File. When finished, the final page of the wizard opens.
12 On the final page of the wizard, click Finish.
Figure 7-116 The final page of the wizard
Operational and Security Considerations
Before using the export-import functions in ActivEssentials, there are a
number of restrictions you should consider.
Note: Any commas used in items names are stripped out when the file is exported.
The system uses the comma to separate items of data. When you import you
should check the names and replace any commas if necessary.)
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-169
Cross-Database Import/Export
The export-import operations in ActivEssentials have been designed to
work within only one database. You cannot export information from
one plant and import it into another because of resources, rather than
restrictions caused by any technical barrier.
Security Considerations
The export-import function provides a powerful tool to help reduce
implementation time. It must, however, be used with care because the
process exposes parts of the data model that if changed would result
in incorrect data.
Time Taken to Export and Import Data
Exporting and importing large amounts of data takes time. Testing has
revealed that any export or import operation involving more than 500
rows can take more than a minute, while 1000 rows or more can take
over three minutes. These tests were performed using a database of
over 1.8 GB, with 150 assets and over 50 data items collected per
asset. The times required for any particular set of data are difficult to
predict because of network conditions and the performance (processor
speed, hard disk performance, amount of RAM, etc.) of the computers
involved.
Retro Stop and the Use of Export-Import
While it is possible to change many aspects of an ActivEssentials
installation by exporting the configuration to Excel, making the
required changes, and then importing the modified configuration, this
can lead to errors with Retro Stop. You should make all changes to the
Retro Stop incident through the Data Collection Configuration module.
Data Available for Export at the Asset Data
Collection Level
To export the collection configuration data at the asset level, you need
to select the asset and then select an item in the Collection
Configuration (secondary) frame. The data you can export differs
with each selection in the frame. There are two principal items:
Collection Categories and Asset States.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-170
You can expand the Collection Categories item to gain access to the
each of the categories defined for use with the asset. The categories
are generated at the global level but assigned to the asset at the local
level through either the tools in MI Admin or the export-import
functions.
Data Available for Export at the Global
Collection Level
The ActivEssentials data collection system has two distinct hierarchical
structures: one for the collection methods, and another for the asset
states. For initial data collection there are four methods:
Accumulators
Incidents
Identifiers
Variables (Events)
Under these collection methods, you can define as many collection
categories as you wish, and then under these you can define the data
items. Under Asset States, you do not define collection categories, just
the states. See the following figure for a comparison of the logical
structure for the two methods.
Table 7-5 Data available for export through the Collection Configuration frame
Collection Configuration
frame selection
Data available
1
1. All of the available data can be exported for use with other assets
Collection Categories
item
When selected, you have access to the configuration data
for all of the collection categories defined for use with the
asset. If you expand the Collection Categories item the list
of items is the same as the items displayed in the grid.
Individual collection
category items
If you expand the Collection categories item, you can then
select the individual collection category items. When
selected, you have access to the data items defined for
use with the asset under the selected collection category.
Asset States item When selected, you have access to the configuration data
for all of the asset states defined for use with the asset.
There are no categories, just the asset states.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-171
Figure 7-117 Logical structure of the collection methods compared to the asset states method
If you select the Object Library item in the Plant Hierarchy frame,
you have access to the global data collection methods. From here you
can export the global collection configuration data, but the kind of data
is determined by your selection in the Global Collection
Configuration frame. The frame includes six buttons, each of which
gives access to collection configuration data, which falls into three
categories:
Global Collection Categories. If you click the Collection
Categories button, you have access to the initial configuration
data for all of the collection categories under all of the collection
Collection Methods
Accumulators
Sample Structure
Collection Categories
Event Variables
Identifiers
Incidents
Counts
Timers
Incident Category 1
Incident Category 2
Identifier Category 1
Identifier Category 2
Event 1
Event 2
Data Items
Good Parts
Bad Parts
Blocked
Changeover
Incident 1
Incident 2
Incident 3
Incident 4
Model A
Model B
Job A
Job B
Numeric 1
Numeric 2
Alphanumeric A
Alphanumeric B
Asset States Method
Asset States Faulted
Running
Blocked
Starved
Asset State Definitions
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-172
methods. The data includes the assignment of the collection
method, and the source for the data they collect. This data does
not include the collection category definitions.
Individual Collection Categories. If you click any of the
collection method buttons (Accumulators, Incidents, Identifiers,
and Variables), you have access to all of the collection category
definitions used by all of the collection categories defined under the
selected collection method. This configuration data is at a lower
level than that accessed by the Collection Categories button.
Asset States. The logical structure of the asset states method
differs from the other collection methods because you do not
define categories. When you click the Asset States button you have
access to all of the asset state definitions defined in your
installation of ActivEssentials. You can export this data, but the
data is more suitably exported at the asset level if being used to
build new assets.
For a detailed explanation of the differences, see the System
Configuration Guide (System Configuration Guide.pdf) included in the
ActivEssentials installation package.
Building the Plant Configuration Using
Excel
You can reproduce the organizational structure of your entire plant
using the tools in ActivEssentials, but you can complete the task much
more efficiently if you use a combination of ActivEssentials and
Microsoft Excel. Depending on your selections in the Plant Hierarchy
frame (individual asset or Object Library), and the secondary frame,
the data exported is suitable for creating new data collection
categories, new definitions, or for setting up the data collection
parameters for new assets.
Figure 7-118 Data exported to Excel
In practice, it is best not to edit any of the original rows, but to copy
and paste to create new rows and then edit these.
Note: When editing the exported data you should be aware that some columns can
be edited without any problem, but others are more sensitive and could result
in creation of a completely new entry, or the import could fail. Detailed
information on editing exported configuration data is available from Activplant
Support.
Data Collection Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
7-173
When first using the export-import functions, you may find it easier to
work with just a few rows at a time. When creating new items, you do
so by generating new rows in the spreadsheet and then editing the
details in the appropriate cells. Try entering a maximum of ten rows at
a time until you are familiar with the process.
CDC Factory 7.1
ActivEssentials Administration Guide
8-1
Calculations
Calculations
CDC Factory 7.1
ActivEssentials Administration Guide
8-2
Introduction to Calculations
Sometimes you want to display data items that are not raw data but
are calculated from other parameters. For example, you may want to
add the production counts from several lines and display the value as a
single data item in VPWeb. Or you may want to calculate and display
an OEE item. The Calculations module of AppCenter allows you to
create formulas and calculations that you can use in any part of your
data collection system.
As with other AppCenter modules, you can create formulas and
calculation templates that are available for reuse in any asset, or you
can create individual calculations that are specific to an asset.
This chapter covers the following topics:
Formulas, Calculation Templates, and Calculations on page 8-2
Types of Calculations on page 8-10
Creating and Editing Formulas on page 8-13
Creating and Editing Calculation Templates on page 8-25
Creating and Editing Calculations on page 8-36
Derived Items on page 8-50
Formulas, Calculation Templates, and
Calculations
ActivEssentials reduces the amount of work involved in defining
calculations by use of building blocks that you create on a global level
and reuse at different points in the plant hierarchy.
This section covers the following topics:
Opening the Calculations Module on page 8-2
The Process of Defining Calculations on page 8-3
Where to Use Calculations on page 8-5
The Calculation Building Blocks on page 8-6
Opening the Calculations Module
Use the instructions below to open the Calculations task module of
MI Admin. This module is used to create formulas, calculation
templates, and calculations, and to apply the calculations to plant
hierarchy items.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
Calculations
CDC Factory 7.1
ActivEssentials Administration Guide
8-3
Procedure
1 In the taskbar, click the Configuration category button.
The taskbar refreshes to display icons for the task modules in the
Configuration category.
2 In the taskbar, click the Calculations icon.
The grid displays formulas or calculations that have been defined
previously. The Plant Hierarchy frame displays the plant hierarchy and
the Object Library.
The Process of Defining Calculations
There are three basic stages in defining calculations, though it is not
essential to complete all three parts of the processyou can start at
different points in the process and get to the same end.
The first stage is to create one or more formulas using the various
building blocks. Formulas are fragments of calculations that you can
use over and over again.
Then you create a calculation template, which can contain one or more
of the formulas you defined.
Finally, you add the calculation to a plant, group, or asset in the plant
hierarchy.
At any stage in the process you can create a new calculation using the
basic building blocks (variables, constants, operators, etc.).
Warning! AppCenter does not stop you from creating calculations that make no
sense. Think through what you need, and check your syntax, when you
create calculations.
Calculations
CDC Factory 7.1
ActivEssentials Administration Guide
8-4
Figure 8-1 The process of defining calculations
Here are some definitions of terms used in defining calculations. For
more information about these, see The Calculation Building Blocks on
page 8-6.
Formula. A formula is a pre-assembled fragment of a calculation,
consisting of a number of basic building blocks arranged together.
Use formulas to save typing common fragments over and over
again.
Constant. A constant is a numeric value that does not change over
time. It may be:
A number entered through the keyboard (for example, the
number 2);
A numeric property of a plant hierarchy object such as a group
or asset;
The value of a data item taken over a period of time. For
example, you may have a 2-hour span displayed in VPWeb. If
you include a constant in your calculation and assign Production
Count to that constant, VPWeb uses the total production count
Math functions
AbsoluLe, 1an, Cos,
kadians, Log, Pi,
Square kooL, eLc.
Operators
AddiLion (+)
SubLracLion (-)
Division (})
MulLiplicaLion (*)
ase functions
AcLivplanL funcLions
ser-defined fornulas
Constants
Keyboard inpuL
ExLended properLies
VariabIes
DaLa iLens
Create a formuIa
[var1]+Sqrt([var2})+[const1]+([var4]/[var5])/100
[var1]-[var2]/2
[var1{Total Cycles}.{Aggregation:SUM}.{Default Value:P}]-[var2{Reject Parts}.{Aggregation:SUM}.{Default Value:P}]/2
1. Add DaLa lLens, AggregaLions, and DefaulL values
2. Add niLs of MeasurenenL and DaLa lornaL
Create a gIobaI CaIcuIation TempIate
Create a CaIcuIation
SelecL a group or asseL, Lhen use Lhe New CalculaLion
wizard Lo build a new fornula
or use a calculaLion LenplaLe
Calculations
CDC Factory 7.1
ActivEssentials Administration Guide
8-5
in the 2-hour time span as the value of the constant. If your
time-span is three hours, the constant becomes the production
count over the three hours, and so on.
Mathematical Function. A standard function such as Square Root,
Log
10
, Exponent, Round, etc.
Calculation Template. A calculation template is a complete
calculation, with the following items defined for each parameter in
it:
the collected data item represented by the parameter
the aggregation method that will be used (for example, Sum or
Average)
a default value, such as Previous, for times when there is no
database record available
units of measurement, such as Pieces, Seconds, etc.
a data format, such as 0 or 0.00
Aggregation Method. This is the form in which the data is used; for
example, it may be a Sum, Average, Standard Deviation, etc.
Default Value. This is the value that will be used in the calculation if
a database record does not exist for a particular time. You can
choose between several options. Perhaps the most obvious option
is Previous, in which case the calculation uses the value of the
previous database record.
Where to Use Calculations
You can use calculations at any level of the plant hierarchy, from the
plant level to the asset level. For example, you may want to
summarize the production data for the whole plant by creating a
calculation that involves data from all the groups. Alternatively, you
may summarize data from the assets in a group using a group-level
calculation; or you can use a calculation on the asset level.
Before you create individual calculations it is a good idea to create the
building blocksthe formulas and calculation templatesthat you can
use over and over again.
Calculations Defined in ActivApplications
Under the ActivApplications item in the Plant Hierarchy frame are the
asset templates that have been defined for use in your ActivEssentials
installation, which can include calculations. Asset templates contain
model data collection configuration to fit with the needs of specific
applications. The applications can be ActivApplications you purchased
from CDC Factory, or they could be applications you develop yourself.
Note: Be careful when using default values that may be zero. If you multiply by 0 the
result will be 0; if you divide by zero, you might receive an error or no result.
Calculations
CDC Factory 7.1
ActivEssentials Administration Guide
8-6
In the Calculations module, you treat the template items, which
appear at the third level down as you expand the ActivApplications
tree, as if they are assets. You can create calculations for these
templates in the same way as you might create for an asset. You
cannot create templates in the Calculations module, you can do this in
the Plant Configuration module. Although you can apply configuration
to the templates in the same way as you can to assets, templates do
not collect data.
If the applications and templates are a part of an imported application,
you should not change any aspect of the configuration without
understanding how this affects data collection as it relates to the
purpose of the application. In a practical sense, you should only make
changes to a template item if absolutely necessary.
The Calculation Building Blocks
In defining calculations there are several building blocks that you will
use.
The basic building blocks
The basic building blocks of calculations are constants, variables,
operators, standard functions, and ActivEssentials functions.
Constants ([const1], [const2], etc.). A constant is a numeric value
that does not change over time. It may be a number entered
through the keyboard. Or it may be a numeric property associated
with a plant hierarchy item. Finally, it may be the value of a data
item taken over the time span displayed in VPWeb.
Example
1 Using a numeric property as a constant:
You could define a numeric property for a production line, called
Line Speed, and give it a value of 35. This could be used as a
constant in efficiency calculations. You could change this value
later, but the change would be applied to all historical data. The
reason for this is because the constant has no time element, and
therefore no knowledge of when you made the change.
2 Using a data item as a constant:
You could define a calculation that uses Production Count as a
constant. In VPWeb, the value of the constant will be the value of
the production count for the time period displayed, according to
the aggregation method in use in Production View. If Production
View uses Average as the aggregation method, the calculation will
also use Average for the constantthat is, the average over the
VPWeb time frame. If you change the time frame in Production
View, the value of the constant will (probably) change; likewise, if
you change the aggregation method, the constant value will
change.
Calculations
CDC Factory 7.1
ActivEssentials Administration Guide
8-7
Variables ([var1], [var2], etc.). A variable is a value that may
change. It can be any data item that you want to use, such as a
production count, total time, etc.
Operators. These are the common mathematical operators
+ (addition), - (subtraction), / (division), or * (multiplication).
Time-based calculations also use the operators AND, OR, and NOT.
Standard Functions. The standard functions are as follows:
Note: A limitation of SQL Server means that you should not use more than about 20
constants and/or variables in a calculation. The system will not prompt you
about this.
Calculations
CDC Factory 7.1
ActivEssentials Administration Guide
8-8
ActivEssentials Basic Functions. The following ActivEssentials
functions are available:
Available minutes. This parameter is the number of available
minutes included in the time interval chosen in VPWeb. The
value is derived from the shift definitions in which you define
whether shift periods are productive or not.
Time frame. This is the time frame in VPWeb represented by
the data that is currently displayed. Note: it is not the time
frame defined in the VPWeb time picker. Often the two time
frames are the same, but if the time picker time frame results
in too much data being requested, VPWeb truncates the time
frame. It is the truncated time frame that is used in the
calculation.
Time interval. This is the time interval chosen in VPWebfor
example, in Production View or Trend View.
User-defined functions. Any formula that you define in which
the Base Function checkbox is selected also becomes available
as an ActivEssentials function, and you can use it in defining
other formulas and calculations.
Table 8-1 Standard functions in the Calculations module
Function Menu Option Editor Comment
Absolute Abs Abs([var1]) Always positive.
Abs(-10) = 10.
Cosine Cos Cos([var1]) The default unit of
measure is radians.
Degrees Degrees Degrees([var1])
Exponent Exp Exp([var1]) The result is e
var1
.
Logarithm Log Log([var1[) Base 10
Pi (p) Pi PI 3.142
Power (index) Pow Pow([var1],[var2]) If var1=2 and var2=3,
the result is 2
3
.
Radians Radians Radians([var1]) Converts values in
degrees to radians.
Round Round Round([var1],[var2
])
var1 is the value, var2 is
the number of decimal
places. If var1=5.325 and
var2=1, the result is 5.3.
When rounding, 14 are
rounded down and 59
are rounded up.
Sine Sin Sin([var1]) The default unit of
measure is radians.
Square Root Sqrt Sqrt([var1]) If var1=49 then the
answer is 7
Tangent Tan Tan([var1]) The default unit of
measure is radians.
Calculations
CDC Factory 7.1
ActivEssentials Administration Guide
8-9
The Intermediate Building Blocks
You use the basic building blocks to create the intermediate building
blocks for formulas. These are:
Formulas. A formula is a pre-assembled fragment of a calculation,
consisting of a number of basic building blocks arranged together.
Use formulas to save typing common fragments over and over
again.
Calculation templates. A calculation template is a complete, global
calculation that can be used over and over again in different
assets. The variables and constants are replaced with real data
items, and the template also has data aggregations, default
values, numerical formats, and units of measurement defined.
Example
The formula [var1][var2]/100, when expanded into a calculation
template, may become:
[var1{Total Cycles}{Aggregation:SUM}{Default Value:P}]
[var2{Reject Count}{Aggregation:SUM}{Default Value:P}]/100
Each variable has a data item, an aggregation method, and a default
value. The example uses the SUM aggregation and the Previous Value
as a default. Finally, you choose the units of measurement and the
data format (for example, 0.00).
Constants do not have aggregations or default values.
Note: For example, [var1]-[var2] is a simple formula. You can store this and use
it in any calculation that includes this particular piece of syntax.
Calculations
CDC Factory 7.1
ActivEssentials Administration Guide
8-10
Types of Calculations
ActivEssentials offers three basic types of calculations: numeric and
alphanumeric, and time-based. Together, these provide an extremely
flexible means of presenting complex data items, or filtering data
according to criteria that you define.
These types of calculations share many common features:
They are all created using the same wizard, and they all use the
same editors.
The building blocks are the same, but some of the building blocks
used for numeric calculations are not available for the other types.
In all cases you can create formulas, calculation templates, and
individual calculations.
This section covers the following topics:
Numeric Calculations on page 8-10
Alphanumeric Calculations on page 8-10
Time-Based Calculations on page 8-11
Numeric Calculations
Numeric calculations are the simplest and most obvious type of
calculation. They consist only of numeric values, and they return a
numeric value as their result. These calculations use mathematical
operators (addition, multiplication, etc.). An example of a numeric
calculation would be an Overall Equipment Efficiency (OEE) calculation
which uses various counters and timers, along with percentages, to
produce its final, numeric result.
The calculation may include data items from more than one asset. For
example, a numeric calculation at the production line (group) level
could add the production counts from all the assets in the line.
Alphanumeric Calculations
Alphanumeric calculations combine stringsthat is, alphanumeric
textto create their result, which is always a string. These are
particularly useful for manipulating data that is not in string form in
the PLC, or when the PLC has very limited space for strings.
For example, in the PLC there may be three data items, A, B, and C.
By creating an alphanumeric calculation you can combine these into a
single value, ABC, and store or display that instead of the separate
values.
Warning! When defining numeric calculations, pay close attention to the use of
brackets that control the sequence of operations. For example, ([var1]/
[var2])+[var3] is not the same as [var1]/([var2]+[var3]).
Calculations
CDC Factory 7.1
ActivEssentials Administration Guide
8-11
The process of running strings together in this way is called
concatenation, and the operator is always +.
Example
In an automotive plant, you are interested in the relationship between
a model number and the ID of the die used to create a part. You have
two identifiers defined: ModelNumber and DieID. Both of these have
sets of values which are strings. You can view the information for the
two identifiers as two time-lines in VPWeb.
You can also create an alphanumeric calculation that concatenates
these two identifiers into a single value, ModelNumber+DieID. In
VPWeb this appears as a single time-line showing the Model Number
and the Die ID.
Time-Based Calculations
Time-based calculations allow you to create your own identifiers which
you can use to filter data. Instead of concatenation, they use the AND,
OR, and NOT operators. A time-based calculation is sometimes
referred to as a derived identifier.
The AND operator means that both the variables are true.
The OR operator means that either of the variables can be true.
The NOT operator inverts the variable; for example, NOT [var1]
means that the condition is true if the value is not equal to [var1].
Typical examples of time-based calculations are:
[var1] AND [var2]
[var1] OR [var2]
[var1] AND NOT [var2]
[var1] OR NOT [var2]
NOT [var2]
The examples above use only variables, but you can also use
constants in time-based calculations. The calculation returns a result
when the terms of the calculation are satisfied. The result is displayed
as a time-line in VPWeb.
Example
You have two identifiers, ModelNumber and Shift. You create a
time-based calculation that has the format [ModelNumber] AND
[Shift1]. You use this calculation to display the period within a shift
when a particular ModelNumber was being produced.
Warning! When defining time-based calculations, pay close attention to the use of
brackets that control the sequence of operations. For example, ([var1] AND
[var2]) OR [var3] is not the same as [var1] AND ([var2] OR [var3]).
Calculations
CDC Factory 7.1
ActivEssentials Administration Guide
8-12
Merging Records in Time-Based Calculations
With time-based calculations that use the OR operand you can choose
to merge database records that are created when either of the
conditions is true. See the example below.
Shift 1 runs from 0900 to 1700. Between 0900 and 1300 a machine
was producing parts with Serial Number 001. From 1300 to 1850 it
was producing parts with Serial Number 002. You create three
calculations that include the shift and the Serial Number:
1 The calculation [shift1] AND [SN001] produces a single record that
spans the time between 0900 and 1300that is, the time when
both the variables were true.
2 The calculation [shift1] OR [SN001] produces two records. The first
record spans the time between 0900 and 1300 (when both
variables were true), and the second record spans the time
between 1300 and 1700 (when only the shift variable was true).
You can choose to merge these two records so that they appear as
only one record (from 0900 to 1700) in VPWeb.
3 The third calculation has the format [shift1] AND NOT [SN001].
This yields only one record spanning the time between 1300 and
1700.
Calculations
CDC Factory 7.1
ActivEssentials Administration Guide
8-13
Creating and Editing Formulas
A formula is a fragment of a calculation that can be used over and over
again when building calculations. The formula can be as large or as
small as you wish. Formulas are global items, so you can use them
anywhere in the plant hierarchy.
This section covers the following topics:
Resetting VPServer on page 8-13
Creating a Numeric Formula on page 8-14
Creating an Alphanumeric Formula on page 8-16
Creating a Time-Based Formula on page 8-17
Viewing and Editing Properties of Formulas on page 8-19
Copying a Formula on page 8-20
Deleting a Formula on page 8-21
Introduction to Formulas on page 8-21
Using the Formula Editor on page 8-22
Resetting VPServer
Use the instructions below to reset VPServer. The VPServer application
provides a means of exposing the data collected by ActivEssentials to
both third-party applications and the Activplant Real-Time Logic Engine
(RTLE). If you are not using your data in this way, you do not need to
perform this task. You need to reset VPServer only if you have made
changes to the configuration of the assets in your plant hierarchy, in
either the Data Collection Configuration or Calculations task modules.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
Procedure
1 In the Plant Hierarchy frame, select the top level item in the tree
(your plant).
The Reset VPServer button on the toolbar becomes enabled.
2 Click the Reset VPServer button.
Note: When you reset VPServer, you interrupt the flow of data to any clients. This
does not cause any loss of data, but it does delay the presentation of data in
client applications. The reset VPServer action is global as it causes a reload of
the entire plant configuration. For this reason, you should reset VPServer only
after completing all configuration changes.
Calculations
CDC Factory 7.1
ActivEssentials Administration Guide
8-14
Figure 8-2 The confirmation dialog box
3 Click OK.
Figure 8-3 Confirmation of reset message
Creating a Numeric Formula
Use the instructions below to create a numeric formula. A formula
need not have a viable use by itself; it may only make sense when it
becomes part of a calculation template or calculation.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Calculations task module using the
instructions in Opening the Calculations Module on page 8-2.
Using the Formula Editor on page 8-22.
Procedure
1 In the Plant Hierarchy frame, select the Object Library.
The Global Items frame opens with two icons, Formulas and
Calculation Templates.
2 In the Global Items frame, select the Formulas icon.
The grid displays any formulas that have already been defined.
3 Right-click in the grid and select New.
The Add New Formula wizard starts.
4 Click Next to proceed past the welcome page.
Calculations
CDC Factory 7.1
ActivEssentials Administration Guide
8-15
Figure 8-4 The Formula Properties and Definition page of the wizard
5 Do the following:
a) In the Name field, type a name (up to 50 characters) for the
formula.
b) If you want the formula to be active, select the Active
checkbox.
c) If you want this formula to be available as an ActivEssentials
base function, select the Activplant Basic Function
checkbox.
6 Ensure that the Numeric option is selected, then click Edit.
Figure 8-5 The Build a Formula dialog box
Calculations
CDC Factory 7.1
ActivEssentials Administration Guide
8-16
7 Edit the formula as described in Using the Formula Editor on page
8-22. When you have finished editing the formula, click Validate.
If an error is detected, fix the formula and validate again until
validation is successful.
8 Click OK to close the formula editor, then click Next.
The final page of the wizard opens.
9 Review the formula definition, then click Finish to save it.
Creating an Alphanumeric Formula
Use the instructions below to create an alphanumeric formula.
Alphanumeric formulas combine values into a string, and are
especially useful for data items in which the value is not available as a
string in the PLC.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Calculations task module using the
instructions in Opening the Calculations Module on page 8-2.
Using the Formula Editor on page 8-22.
Procedure
1 In the Plant Hierarchy frame, select the Object Library.
The Global Items frame opens with two icons, Formulas and
Calculation Templates.
2 In the Global Items frame, select the Formulas icon.
The grid displays any formulas that have already been defined.
3 Right-click in the grid and select New.
The Add New Formula wizard starts.
4 Click Next to proceed past the welcome page.
Note: You dont really need to click Validate. The formula will be automatically
evaluated when you click OK to close the editor.
Calculations
CDC Factory 7.1
ActivEssentials Administration Guide
8-17
Figure 8-6 The Formula Properties and Definition page of the wizard
5 Do the following:
a) In the Name field, type a name (up to 50 characters) for the
formula.
b) If you want the formula to be active, select the Active
checkbox.
c) If you want this formula to be available as an ActivEssentials
base function, select the ActivEssentials Basic Function
checkbox.
6 Ensure that the Alphanumeric option is selected, then click the
Edit button.
7 Edit the formula as described in Using the Formula Editor on page
8-22. Note that the mathematical operators are not available when
creating alphanumeric formulas. When you have finished editing
the formula, click Validate. If an error is detected, fix the formula
and validate again until validation is successful.
8 Click OK to close the formula editor, then click Next.
The final page of the wizard opens.
9 Review the formula definition, then click Finish to save it.
Creating a Time-Based Formula
Use the instructions below to create a time-based formula. Time-based
calculations allow you to create your own identifiers which you can use
to filter data. They use the AND, OR, and NOT operators, as in [var1]
AND [var2], [var1] OR [var2], or [var1] AND NOT [var2].
Note: You dont really need to click Validate. The formula will be automatically
evaluated when you click OK to close the editor.
Calculations
CDC Factory 7.1
ActivEssentials Administration Guide
8-18
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Calculations task module using the
instructions in Opening the Calculations Module on page 8-2.
Using the Formula Editor on page 8-22.
Procedure
1 In the Plant Hierarchy frame, select the Object Library.
The Global Items frame opens with two icons, Formulas and
Calculation Templates.
2 In the Global Items frame, select the Formulas icon.
The grid displays any formulas that have already been defined.
3 Right-click in the grid and select New.
The Add New Formula wizard starts.
4 Click Next to proceed past the welcome page.
Figure 8-7 The Formula Properties and Definition page of the wizard
5 Do the following:
a) In the Name field, type a name (up to 50 characters) for the
formula.
b) If you want the formula to be active, select the Active
checkbox.
c) If you want this formula to be available as an ActivEssentials
base function, select the ActivEssentials Basic Function
checkbox.
Calculations
CDC Factory 7.1
ActivEssentials Administration Guide
8-19
6 Ensure that the Time-based option is selected, then click the Edit
button.
7 Edit the formula as described in Using the Formula Editor on page
8-22. Note that the only options in the Numbers and Operations
section of the editor are the AND, OR, and NOT operands.
8 When you have finished editing the formula, click Validate. If an
error is detected, fix the formula and validate again until validation
is successful.
9 Click OK to close the formula editor, then click Next.
The final page of the wizard opens.
10 Review the formula definition, then click Finish to save it.
Viewing and Editing Properties of
Formulas
Use the instructions below to view and edit the properties of a formula.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Calculations task module using the
instructions in Opening the Calculations Module on page 8-2.
Procedure
1 In the Plant Hierarchy frame, select the Object Library.
The Global Items frame opens with two icons, Formulas and
Calculation Templates.
2 In the Global Items frame, select the Formulas icon.
The grid displays any formulas that have already been defined.
3 Right-click the formula in the grid and choose Properties.The
Properties dialog box opens.
Note: You dont really need to click Validate. The formula will be automatically
validated when you click OK to close the editor.
Calculations
CDC Factory 7.1
ActivEssentials Administration Guide
8-20
Figure 8-8 Calculations properties dialog box
4 View or edit the properties as desired. If you want to edit the
formula itself, click the ellipsis button by the Definition field to
open the formula editor, and edit it as described in Using the
Formula Editor on page 8-22.
Copying a Formula
Use the instructions below to copy a formula within the Object Library.
When you paste a copy, the new formula is named Copy of (original
name).
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Calculations task module using the
instructions in Opening the Calculations Module on page 8-2.
Procedure
1 In the Plant Hierarchy frame, select the Object Library.
The Global Items frame opens with two icons, Formulas and
Calculation Templates.
2 In the Global Items frame, select the Formulas icon.
The grid displays any formulas that have already been defined.
Note: You can edit the name of a formula, or change the Active state, by editing
directly in the grid, without opening the Properties dialog box.
Calculations
CDC Factory 7.1
ActivEssentials Administration Guide
8-21
3 Right-click on the formula in the grid and select Copy.
4 Right-click anywhere in the grid and select Paste.
Deleting a Formula
Use the instructions below to delete a formula.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Calculations task module using the
instructions in Opening the Calculations Module on page 8-2.
Created a calculation formula using one of the following
instructions: Creating a Numeric Formula on page 8-14, Creating
an Alphanumeric Formula on page 8-16, or Creating a Time-Based
Formula on page 8-17.
Procedure
1 In the Plant Hierarchy frame, select the Object Library.
The Global Items frame opens with two icons, Formulas and
Calculation Templates.
2 In the Global Items frame, select the Formulas icon.
The grid displays any formulas that have already been defined.
3 Right-click on the formula in the grid and select Delete.
A confirmation dialog box opens.
4 Click OK.
Introduction to Formulas
A formula is a generic building block that can be used over and over
again in creating calculations. It saves you typing if you create
formulas as the intermediate building blocks for your calculations. A
formula is really a fragment of a calculation, and need not make any
sense on its own.
Each formula consists of the basic building blocks described in The
Calculation Building Blocks on page 8-6that is, it is a collection of
constants, variables, operators, mathematical functions, and
ActivEssentials functions, in any combination. It may also contain
brackets and numeric content.
A formula contains placeholders for data items, instead of the data
items themselves. For example, a simple formula could be
[var1]+[var2]/2. In this case, [var1] and [var2] are variables that
each represent a data item. When you create the formula you do not
say which data items each parameter represents; you do that when
you create a calculation template or individual calculation.
Calculations
CDC Factory 7.1
ActivEssentials Administration Guide
8-22
Formulas can be numeric, alphanumeric or time-based. For
information on these types, see Types of Calculations on page 8-10.
Using the Formula Editor
The formula editor is used to create and edit formulas and
calculations. The editor has two modes; the appearance of the editor is
the same in both modes, but it behaves differently.
In Block mode you can only add or edit items as blocks. For
example, you can remove [var1] but you cannot edit it to read
[var2]. You can add operators (+, , etc.) and brackets.
In Free Editing mode you can add, remove, or edit every character
in the formula definition.
Figure 8-9 The formula editor
Some items in the editor become available or unavailable, depending
on the type of formula that you are definingthat is, Numeric,
Alphanumeric, or Time-based.
Warning! A limitation of SQL Server means that you should not use more than about
20 constants and/or variables in a calculation. The system will not prompt
you about this.
Note: There is a 500-character limit in the formula editor. You cannot add more than
this number of characters.
Calculations
CDC Factory 7.1
ActivEssentials Administration Guide
8-23
Using the Editor
To switch between Block mode and Free Editing mode, check or
uncheck the Free Editing checkbox. In Free Editing mode you can
edit anywhere in the formula. To return to Block mode, uncheck the
checkbox. When you do so, the system parses the formula and
converts the components to blocks; if the formula is not valid, an error
message alerts you to the fact.
On the left side of the editor are the following buttons:
Parameters. Click this button and select either a constant or a
variable. Choose Constant if the parameter represents a number or
a numeric property of a group or asset. The editor displays
[const1]. Choose Variable if the parameter represents a data item.
The editor displays [var1].
Mathematical Functions. Click this button and select an option
from the list of functions that appears. For details of the functions,
see The Calculation Building Blocks on page 8-6.
ActivEssentials Basic Functions. Click this button and select
one of the built-in functions. Also displayed in this list are any
active formulas that you defined earlier and marked as
ActivEssentials basic functions (that is, they only appear if the
Active checkbox was checked in the formula wizard).
Numbers and Operations. Clicking this button opens the
number-pad in which you can choose the items you want to add to
the formula.The AND, OR, and NOT options are only available for
time-based formulas. You can also enter numbers and operators
through your keyboard.
The other functions available in this editor are:
Delete. This button deletes the part of the formula definition that
is currently highlighted. You can also use the Delete key on your
keyboard.
Validate. This button parses the formula to ensure that it makes
sensethat is, that opening brackets have corresponding closing
brackets, etc.
Note: You can use keyboard keys to enter mathematical operators and to move
around in the formula. Try using Backspace, Home, End, and arrow keys. You
can also use Delete.
Note: When you are using a numeric property of an identifier, you must use a
constant as your parameter.
Warning! A limitation of SQL Server means that you should not use more than about
20 constants and/or variables in a calculation. The system will not prompt
you about this.
Calculations
CDC Factory 7.1
ActivEssentials Administration Guide
8-24
Keyboard Shortcuts in the Formula Editor
There are a few keyboard shortcuts you can use in the formula editor:
Note: Note that a formula may be valid but still not be exactly what you intended. Pay
particular attention to the placement of brackets in the formula. For example,
[var1]+([var2]/2) is different from ([var1]+[var2])/2.
Table 8-2 Keyboard shortcuts in the formula editor
Keyboard shortcut Use to enter...
Shift+7 And
! <> (not equal)
Shift+\ Or
Calculations
CDC Factory 7.1
ActivEssentials Administration Guide
8-25
Creating and Editing Calculation Templates
A calculation template is a complete calculation. Whereas in a formula
you use expressions such as [var1], [const1], etc., in a calculation
template you assign actual data items to each expression. So instead
of [var1]-[var2] you would have [Production Count]-[Reject Count].
You also have to assign an aggregation method (such as SUM or
AVERAGE) to each data item.
This section covers the following topics:
Creating a Calculation Template on page 8-25
Viewing and Editing Properties of Calculation Templates on page
8-30
Copying a Calculation Template on page 8-31
Deleting a Calculation Template on page 8-32
Data Aggregation Methods on page 8-32
Default Values in Calculations on page 8-33
Creating a Calculation Template
Use the instructions below to create a calculation template in
AppCenter. The template is a global item that you can assign to any
plant hierarchy object. When creating a calculation template, you have
to add specific data items, data aggregation methods, default values,
units of measurement, and a numeric format.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Calculations task module using the
instructions in Opening the Calculations Module on page 8-2.
Created at least one calculation formula using one of the following
instructions: Creating a Numeric Formula on page 8-14, Creating
an Alphanumeric Formula on page 8-16, or Creating a Time-Based
Formula on page 8-17.
Read the following:
Data Aggregation Methods on page 8-32
Default Values in Calculations on page 8-33
Warning! A limitation of SQL Server means that you should not use more than about
20 constants and/or variables in a calculation. The system will not prompt
you about this.
Calculations
CDC Factory 7.1
ActivEssentials Administration Guide
8-26
Procedure
1 In the Plant Hierarchy frame, select the Object Library.
The Global Items frame opens with two icons, Formulas and
Calculation Templates.
2 In the Global Items frame, click the Calculation Templates
icon.
The grid displays any calculation templates that have already been
defined.
3 Right-click in the grid and select New.
The Add New Calculation Template wizard opens.
4 Click Next to move past the welcome page.
The Calculation Template Creation page opens.
Figure 8-10 New Calculation Template wizard
5 Do one of the following:
a) If you want to create a new calculation template, select the
Create new option, or
b) If you want to use an existing formula as a basis for the
calculation template, select the Create from formula option,
click the down-arrow and choose a formula from the list.
Calculations
CDC Factory 7.1
ActivEssentials Administration Guide
8-27
Figure 8-11 Creating a formula from an existing template
6 Click Next.
Figure 8-12 The Calculation Template Properties and Definition page of the wizard
7 Type a name (up to 50 characters) for the template, and choose a
type (Numeric, Alphanumeric, or Time-based).
8 Do one of the following:
a) If you are creating a new calculation, click Edit.
b) If you are using a formula as a basis, review the definition in
the Formula box (this is read-only); if you need to edit it, click
Edit.
9 Edit the calculation as described in Using the Formula Editor on
page 8-22. When done, return to the wizard and click Next.
Calculations
CDC Factory 7.1
ActivEssentials Administration Guide
8-28
Figure 8-13 The Define the Calculation page of the wizard
10 Click Edit.
The Data Item Allocation editor opens. In this editor you assign
data items and other parameters to each expression in the
calculation template.
Figure 8-14 Data Item Allocation editor
Calculations
CDC Factory 7.1
ActivEssentials Administration Guide
8-29
11 For each row (variable or constant) in the middle part of the editor,
do the following (note that the options are more limited for
constants than for variables):
a) Click anywhere in the row for the variable or constant to which
you want to assign a data item.
b) If you are defining a calculation for a plant or group, click in the
Plant Hierarchy section, then navigate to the group or asset
whose data item you want to use in the calculation.
c) In the Data Items section, navigate to the data item that will
be assigned to the variable or constant. Click Select.
d) Click in the Aggregation column and choose a data
aggregation method. For more information, see Data
Aggregation Methods on page 8-32.
e) Click in the Default Value column and choose a default value
for time intervals at which there is no database record for the
variable. For information about the options, see Default Values
in Calculations on page 8-33.
12 When you have assigned the appropriate parameters to all the
expressions in the calculation, click OK to exit the editor.
13 Click Next.
The Units and Data Format page of the wizard opens.
14 Choose units of measurement and a numeric format for the results
of the calculation.
Figure 8-15 Choosing units and number format
15 If you want the calculation to be active, ensure that the Active
checkbox is checked. If you have not assigned data items to all the
variables or constants in the template, the Active checkbox is
greyed and you cannot activate the template.
Calculations
CDC Factory 7.1
ActivEssentials Administration Guide
8-30
16 Click Next.
The final page of the wizard opens.
17 Review the calculation definition, then click Finish to save it.
Viewing and Editing Properties of
Calculation Templates
Use the instructions below to view and edit the properties of a
calculation template.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Calculations task module using the
instructions in Opening the Calculations Module on page 8-2.
Created a calculation formula using one of the following
instructions:
Creating a Numeric Formula on page 8-14
Creating an Alphanumeric Formula on page 8-16
Creating a Time-Based Formula on page 8-17
Read the following:
Data Aggregation Methods on page 8-32
Default Values in Calculations on page 8-33
Procedure
1 In the Plant Hierarchy frame, select the Object Library.
The Global Items frame opens with two icons, Formulas and
Calculation Templates.
2 In the Global Items frame, click the Calculation Templates
icon.
The grid displays any calculation templates that have already been
defined.
3 Right-click on the template in the grid and select Properties.
Calculations
CDC Factory 7.1
ActivEssentials Administration Guide
8-31
Figure 8-16 The calculation template Properties dialog box
4 View or edit the properties as desired. If you want to edit the
calculation template itself, click the ellipsis button by the
Definition field to open the formula editor, and edit it as described
in Using the Formula Editor on page 8-22.
5 When finished, click OK.
Copying a Calculation Template
Use the instructions below to copy a calculation template within the
Object Library. When you paste a copy, the new formula is named
Copy of (original name).
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Calculations task module using the
instructions in Opening the Calculations Module on page 8-2.
Procedure
1 In the Plant Hierarchy frame, select the Object Library.
The Global Items frame opens with two icons, Formulas and
Calculation Templates.
Note: You can edit several properties of a calculation template by editing directly in
the grid, without opening the Properties dialog box, but you cannot edit the
definition this way.
Calculations
CDC Factory 7.1
ActivEssentials Administration Guide
8-32
2 In the Global Items frame, click the Calculation Templates
icon.
The grid displays any calculation templates that have already been
defined.
3 Right-click on the calculation template in the grid and select Copy.
4 Right-click anywhere in the grid and select Paste.
Deleting a Calculation Template
Use the instructions below to delete a calculation template from the
Object Library.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Calculations task module using the
instructions in Opening the Calculations Module on page 8-2.
Procedure
1 In the Plant Hierarchy frame, select the Object Library.
The Global Items frame opens with two icons, Formulas and
Calculation Templates.
2 In the Global Items frame, click the Calculation Templates
icon.
The grid displays any calculation templates that have already been
defined.
3 Right-click on the calculation template in the grid and choose
Delete.
A confirmation dialog box opens.
4 Click OK.
Data Aggregation Methods
An aggregation method is a format for displaying values, such as Total,
Average, etc. You can use several different aggregate types.
Table 8-3 Aggregate types
Aggregate type What it does
SUM The total for the data item over the time interval used in the
viewing application.
AVERAGE Averages the values for every database record over the selected
time interval. ActivEssentials database records are inserted every
five minutes. For example, if you have a 10-minute interval with
a total count of 40 pieces, the average will be 20 (i.e. 40 10/5).
MAX The highest value of a database record within the chosen time
interval.
Calculations
CDC Factory 7.1
ActivEssentials Administration Guide
8-33
Default Values in Calculations
When you create a calculation or calculation template, you have to
assign real data items to the constants and variables that you used
to create the calculation or template. When you assign data items, you
also have to give a default value for the item. The reason for this is
that a calculation may contain data items that are recorded at different
time intervals.
Example
A temperature is recorded every 5 minutes, while a pressure is
recorded every 12 minutes. Both items are in the same calculation, so
there are gaps in the record where one reading exists but the other
does not. Only the temperature reading is available at 5 and 10
minutes, while only the pressure reading is available at 12 minutes.
Both readings are available at 60 minutes.
MIN The lowest value of a database record within the chosen time
interval.
STDEV The Standard Deviation of the database records making up the
time interval.
VAR The Variance of the database records making up the time
interval.
COUNT The number of database records in the selected time interval.
FIRST The value of the first database record in the time interval.
LAST The value of the last database record in the time interval.
Table 8-3 Aggregate types
Aggregate type What it does
Warning! Some data item/aggregation method combinations do not make sense. For
example, you probably would not use a SUM aggregate for temperatures.
Also, beware of using an Average aggregate for items that are already
averaged (which will give a misleading result).
Calculations
CDC Factory 7.1
ActivEssentials Administration Guide
8-34
Figure 8-17 Setting a default value for times when no record exists
From the example above, it is clear that if you use a 5-minute time
interval in VPWeb you will always have a value for the temperature,
but in most cases there will be no corresponding record for the
pressure. ActivEssentials needs to insert a value where no actual
record exists. The following options are available:
Previous. If you choose this option the calculation will use the
value of the most recent database record as the default value.
Interpolated. If you choose this option, the system assesses the
previous value and the next value, and calculates a likely value on
the basis of them. Note that if you use this option, the result of the
calculation will not be available in VPWeb for the latest time
interval, because it needs the next value in order to calculate the
present value.
(User defined). You can enter a default value of your own by
double-clicking in the Default Value cell and typing a value
(whether numeric or alphanumeric).
Note: For calculated items to appear properly in both VPWeb and Insight for Excel
reports, all records that are a part of a calculation must occur during the defined
time frame. Should a calculated item be required in VPWeb when records are
missing, VPFoundation displays a value of zero if there is not a default value
assigned. However, should the same calculation for the same defined period
appear in an Insight for Excel report, a hyphen (-) appears in the appropriate
cell. Although the calculation is the same, VPFoundation and Insight for Excel
handle the result differently.
Calculations
CDC Factory 7.1
ActivEssentials Administration Guide
8-35
(No value). If you do not choose any option the calculation will be
nullified wherever there is no database record, so no result will
display.
Note: Be careful when using default values that may be zero. If you multiply by zero
the result will be zero; if you divide by zero, there will be no result at all. Also, a
zero could be ambiguous, for if any records are missing from the calculation
and no default value has been assigned, VPFoundation resorts to its own
default value, which is also zero.
Calculations
CDC Factory 7.1
ActivEssentials Administration Guide
8-36
Creating and Editing Calculations
Formulas and calculation templates are global itemsthat is, they are
created in the Object Library. However, you can only use calculation
templates at the asset level to create calculations, whereas you can
use formulas in calculations at all levels of the plant hierarchy.
This section covers the following topics:
Creating a New Calculation on page 8-36
Creating a Calculation Using a Calculation Template on page 8-39
Creating a Calculation Using a Formula on page 8-41
Viewing and Editing Properties of Calculations on page 8-44
Copying a Calculation on page 8-46
Deleting a Calculation on page 8-46
Creating Calculations on page 8-47
Problems with Calculations on page 8-47
Creating a New Calculation
Use the instructions below to create a new calculation for a plant,
group, or asset.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Calculations task module using the
instructions in Opening the Calculations Module on page 8-2.
Read the following:
Creating Calculations on page 8-47
Problems with Calculations on page 8-47
Procedure
1 In the Plant Hierarchy frame, expand the hierarchy until you can
see the object wo which you want to add a calculation, then select
it.
The grid displays any calculations that have already been assigned
to this object.
2 In the Local Items frame, click the Calculations icon.
The grid displays any calculations that have already been defined.
3 Right-click in the grid and select New.
The Add New Calculation wizard starts.
4 Click Next to move past the welcome page.
The Calculation Item Creation page of the wizard opens.
Calculations
CDC Factory 7.1
ActivEssentials Administration Guide
8-37
5 Select the Create new option.
Figure 8-18 Creating a new calculation
6 Click Next.
Figure 8-19 Choosing a calculation type
7 Type a name for the calculation (up to 50 characters) and choose
between Numeric and Alphanumeric, and Time-based.
8 Click Edit.
Calculations
CDC Factory 7.1
ActivEssentials Administration Guide
8-38
Figure 8-20 The Build a Formula dialog box
9 Create the formula as described in Using the Formula Editor on
page 8-22, then click OK to return to the wizard.
10 Click Next.
The Define the Calculation page of the wizard opens.
11 Click Edit to open the Data Item Allocation editor.
The Data Item Allocation editor opens. In this editor you assign
data items and other parameters to each expression in the
calculation template.
Calculations
CDC Factory 7.1
ActivEssentials Administration Guide
8-39
Figure 8-21 Data Item Allocation editor
12 Assign parameters to each expression as described in Copying a
Calculation Template on page 8-31. When done, click OK to return
to the wizard.
13 Click Next.
The Units and Data Format page of the wizard opens.
14 Choose units of measurement and a data format for the results of
the calculation.
15 Click Next.
The final page of the wizard opens.
16 Review the calculation, then click Finish to save it.
Creating a Calculation Using a Calculation
Template
Use the instructions below to create a calculation for an asset by using
a predefined calculation template. If you use this method you cannot
edit the calculation; you must have a template that meets your needs.
Note: You can only use this method to create a calculation on an asset; it is not
available for higher levels of the plant hierarchy.
Calculations
CDC Factory 7.1
ActivEssentials Administration Guide
8-40
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Calculations task module using the
instructions in Opening the Calculations Module on page 8-2.
Read the following:
Creating Calculations on page 8-47
Problems with Calculations on page 8-47
Create a calculation template using the instructions in Creating a
Calculation Template on page 8-25.
Ensure that the data items specified in the template actually exist
for the chosen asset.
Procedure
1 In the Plant Hierarchy frame, expand the hierarchy until you can
see the asset to which you want to add a calculation, and select it.
The grid displays any calculations that have already been assigned
to this object.
2 In the Local Items frame, click the Calculations icon.
The grid displays any calculations that have already been defined.
3 Right-click in the grid and select New.
The Add New Calculation wizard opens.
4 Click Next to move past the welcome page.
The Calculation Item Creation page of the wizard opens.
5 Select the Create from calculation template option, then click
the down-arrow and select the template you need to use.
Figure 8-22 Creating a calculation from a template
Calculations
CDC Factory 7.1
ActivEssentials Administration Guide
8-41
6 Click Next.
The final page of the wizard opens.
7 Review the calculation, then click Finish to save it.
Creating a Calculation Using a Formula
Use the instructions below to create a calculation for a plant, group, or
asset, using a predefined formula. If you use this method you can edit
the formula as much as you want.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Calculations task module using the
instructions in Opening the Calculations Module on page 8-2.
Read the following:
Creating Calculations on page 8-47
Problems with Calculations on page 8-47
You must specify which data items and other parameters the
calculation will use, as described in Creating a Calculation
Template on page 8-25.
Procedure
1 In the Plant Hierarchy frame, expand the hierarchy until you can
see the asset to which you want to add a calculation, and select it.
The grid displays any calculations that have already been assigned
to this object.
2 In the Local Items frame, click the Calculations icon.
The grid displays any calculations that have already been defined.
3 Right-click in the grid and select New.
The Add New Calculation wizard starts.
4 Click Next to move past the welcome page.
The Calculation Item Creation page of the wizard opens.
5 Select the Create from formula option, then click the down-arrow
and select the for mula you want to use.
Calculations
CDC Factory 7.1
ActivEssentials Administration Guide
8-42
Figure 8-23 Creating a calculation from a formula
6 Click Next.
Figure 8-24 The Calculation Item Properties and Definition page of the wizard
7 In the Name field, type a name (up to 50 characters) for the
calculation.
8 Click Edit.
Note: If you change the formula type the existing definition will be erased.
Calculations
CDC Factory 7.1
ActivEssentials Administration Guide
8-43
Figure 8-25 The Build a Formula dialog box
9 Edit the calculation in the formula editor as described in Using the
Formula Editor on page 8-22. When done, click OK to return to the
wizard.
10 Click Next.
The Define the Calculation page of the wizard opens.
11 Click Edit to open the Data Item Allocation editor.
The Data Item Allocation editor opens. In this editor you assign
data items and other parameters to each expression in the
calculation template.
Calculations
CDC Factory 7.1
ActivEssentials Administration Guide
8-44
Figure 8-26 Data Item Allocation editor
12 Define the parameters for each expression in the calculation, as
described in Creating a Calculation Template on page 8-25, and
then click OK to return to the wizard.
13 Click Next.
The Units and Data Format page of the wizard opens.
14 Choose units of measurement and a data format for the results of
the calculation.
15 Click Next.
The final page of the wizard opens.
16 Review the calculation, then click Finish to save it.
Viewing and Editing Properties of
Calculations
Use the instructions below to view and edit the properties of a
calculation.
Calculations
CDC Factory 7.1
ActivEssentials Administration Guide
8-45
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Calculations task module using the
instructions in Opening the Calculations Module on page 8-2.
Read Problems with Calculations on page 8-47.
Procedure
1 In the Plant Hierarchy frame, expand the hierarchy until you can
see the item that contains the calculation, and select it.
The grid displays calculations that have been assigned to the plant
hierarchy item.
2 In the Local Items frame, click the Calculations icon.
The grid displays any calculations that have already been defined.
3 Right-click on the calculation in the grid and select Properties.
Figure 8-27 The calculations Properties dialog box
4 View or edit the properties as desired. If you want to edit the
calculation itself, click the ellipsis button by the Definition field to
open the formula editor, and edit it as described in Using the
Formula Editor on page 8-22.
Note: You can edit several properties of a calculation by editing directly in the grid,
without opening the Properties dialog box, but you cannot edit the definition
this way.
Calculations
CDC Factory 7.1
ActivEssentials Administration Guide
8-46
Copying a Calculation
Use the instructions below to copy a calculation at the asset level. You
can copy the calculation to the same asset or to a different asset in the
plant hierarchy. When you paste a copy to the same asset, the new
calculation is named Copy of (original name).
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Calculations task module using the
instructions in Opening the Calculations Module on page 8-2.
Created a calculation using one of the following instructions:
Creating a New Calculation on page 8-36, Creating a Calculation
Using a Calculation Template on page 8-39, or Creating a
Calculation Using a Formula on page 8-41.
Procedure
1 In the Plant Hierarchy frame, navigate to and select the asset
whose calculation you want to copy.
The Local Items frame opens with two buttons, Calculations and
Derived Items.
2 In the Local Items frame, click the Calculations icon.
The grid displays any calculations that have already been defined.
3 Right-click on the calculation in the grid and select Copy.
4 Do one of the following:
a) If you want to copy the calculation to a different asset, navigate
to the asset and then right-click in the grid and select Paste.
b) If you want to copy the calculation to the same asset,
right-click in the grid and choose Paste.
Deleting a Calculation
Use the instructions below to delete a calculation from a plant, group,
or asset.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Calculations task module using the
instructions in Opening the Calculations Module on page 8-2.
Created a calculation using one of the following instructions:
Creating a New Calculation on page 8-36, Creating a Calculation
Using a Calculation Template on page 8-39, or Creating a
Calculation Using a Formula on page 8-41.
Calculations
CDC Factory 7.1
ActivEssentials Administration Guide
8-47
Procedure
1 In the Plant Hierarchy frame, expand the hierarchy until you can
see the item to which you want to delete a calculation, and select
it.
The grid displays calculations that have been assigned to the plant
hierarchy item.
2 In the Local Items frame, click the Calculations icon.
The grid displays any calculations that have already been defined.
3 Right-click on the calculation in the grid and select Delete.
A confirmation dialog box opens.
4 Click OK.
Creating Calculations
In the Calculations module of AppCenter you assign calculations to
items in the plant hierarchy. Plants, groups, and assets can each have
their own calculations. When creating calculations for a plant, group,
or asset, you first select the plant, group, or asset, then use the Add
New Calculation wizard to add the calculation to it.
You can create a new calculation, from one or more formulas, or based
on a calculation template.
New, in which you define all the parameters of the calculation at
the time when you create it.
From a calculation template, in which you replace the placeholder
parameters with real items that exist on the asset. See Creating a
Calculation Template on page 8-25.
From a formula. In this case you use a formula as the basis of the
calculation and modify it as required.
Problems with Calculations
Sometimes calculations that you have defined either do not appear as
choices in VPWeb or give false values of zero. This section lists some of
the common errors that may cause these problems.
Note: When you assign the calculation to a plant hierarchy object you have to ensure
that its parameters are appropriate for that object. Most importantly, you must
ensure that the data items that you have defined actually exist on the
designated asset(s).
Calculations
CDC Factory 7.1
ActivEssentials Administration Guide
8-48
Create a Valid Calculation
The first things to check are:
Check any formulas that are used in the calculation or calculation
template. Formulas may not be complete in themselves, but they
should be syntactically correct as far as possible.
In the formula editor, use the Validate button to check for syntax
errors.
Pay attention to the parts of a formula, calculation template, or
calculation where formula fragments are used. Are the joins
between these and the rest of the item correct? Are there issues
with brackets, for example?
Check the brackets in the formula. Are they paired? Are they
nested in the correct order? Do they reflect the proper order of
operations?
Check the order of operations in the formula using the BEDMAS
principle. The BEDMAS principle describes the order in which
calculations are made, that is, Brackets, Exponents, Division,
Multiplication, Addition, and Subtraction.
Check the data items used in a calculation. Do the items exist on
the group or asset? This is especially an issue if you have copied
and pasted the calculation. Make sure you update the data items
after pasting.
Note: There is a 500-character limit, including spaces, in the formula editor. You
cannot enter more than this number of characters.
Calculations
CDC Factory 7.1
ActivEssentials Administration Guide
8-49
Other Causes of Error
Here are some other causes of error with calculations. In some cases
these errors will result in false values of 0 in VPWeb. In other cases the
calculation will not appear at all in VPWeb.
No data within the time interval. If there is no data within the
time interval chosen in VPWeb, the calculation will result in 0, even
if all other factors are correct. Use a larger time interval, or check
that data really exists.
Invalid data item. If a data item used in a calculation does not
exist on the group or asset, the calculation will not appear in
VPWeb.
Inactive data item. You cannot add an inactive data item to a
new calculation, but it is possible to inactivate the data item
afterwards. If a calculation contains a data item that has been
inactivated, the following things will occur:
The calculation will work normally for the period that the item
was active.
If the item has a default value in the calculation, it will use the
default value with good quality. However, if the inactive data
item is the only item in the calculation, it will return 0 with bad
quality.
If the item does not have a default value, the calculation will
return a value of 0 with bad quality. The calculation works as
normal.
Calculation name changed. If you change the name of a
calculation, the calculation will not appear in VPWeb until you stop
and re-start VPWeb on all clients.
Default value set to zero. Data items that use default values of 0
may cause problems. If you divide by 0 the calculation will either
not appear or will return 0. If you multiply by 0 the calculation will
return 0.
Calculations
CDC Factory 7.1
ActivEssentials Administration Guide
8-50
Derived Items
Derived items are real-time data items that are derived from
historical data items. They allow you to view the historical data item in
an up-to-the-minute context. For example, you can define a real-time
(derived) item that monitors a production count by the current shift. If
you wanted, you could use the derived item as a basis for an alarm, so
that if the production count falls below a certain level the alarm is
triggered. You can define derived items from events, accumulators,
and identifiers defined from shifts or shift periods, and you can view
them in the real-time data item viewer in Layout View of VPWeb.
This section covers the following topics:
Creating a Derived Item on page 8-50
Viewing and Editing Properties of Derived Items on page 8-54
Copying Derived Items on page 8-55
Deleting a Derived Item on page 8-56
How Derived Items are Built on page 8-56
Creating a Derived Item
Use the instructions below to create a derived item for a group or
asset. You can display the derived item in the Real-Time Data Viewer
in Layout View of VPWeb.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Calculations task module using the
instructions in Opening the Calculations Module on page 8-2.
Read How Derived Items are Built on page 8-56.
Warning! If you define a derived item using an accumulator, the data displayed may
be up to 5 minutes old. Accumulator data is collected as historical data, so
cannot be processed in real-time. The data is cached by VPCollector, a
process that requires a delay, but it is available shortly afterwards.
Note: Derived items are unrelated to derived identifiers, which is another name for
time-based calculations. For information on time-based calculations, see
Time-Based Calculations on page 8-11.
Calculations
CDC Factory 7.1
ActivEssentials Administration Guide
8-51
Procedure
1 In the Plant Hierarchy frame, navigate to and select the
hierarchy item (group or asset) for which you want to create the
derived item.
2 In the Local Items frame, click the Derived Items icon.
The grid displays any derived items that you have already created
for the group or asset.
3 Right-click in the grid and select New.
The Add New Derived Item wizard starts.
4 Click Next to move past the welcome page.
5 The General Information page of the wizard opens.
Figure 8-28 The General Information page of the wizard
6 Type a name for the derived item (up to 50 characters), and, if you
wish, a description (up to 255 characters).
7 Click Next.
Calculations
CDC Factory 7.1
ActivEssentials Administration Guide
8-52
Figure 8-29 The Detailed Information wizard page
8 Do the following:
a) Click the ellipsis button by the Base Item field to open the
Select a Base Item dialog box.
Figure 8-30 The Select a Base Item dialog box
b) On the left side of the dialog box, expand the plant hierarchy
and select an asset. On the right side, expand the data
categories and select the data item you want to use as a base
item. Click OK.
Note: If you select an asset in the Plant Hierarchy frame before you start the wizard,
the asset will already be selected in the left window of the Select a Base Item
dialog box.
Calculations
CDC Factory 7.1
ActivEssentials Administration Guide
8-53
c) Click the down-arrow by the Aggregation field and choose an
aggregation from the list.
d) Click the ellipsis button by the Time Frame field. (This is the
total time frame for the derived item, not the read frequency.)
Figure 8-31 The Time Frame dialog box
e) Select Current shift, or By time interval and set the time
interval and click OK.
f) Click the ellipsis button by the Read frequency field.The Read
Frequency dialog box opens.
Figure 8-32 The Read Frequency dialog box
g) In the Read Frequency dialog box, choose from the read
frequency options, and then click OK.
Calculations
CDC Factory 7.1
ActivEssentials Administration Guide
8-54
9 Click Next.
The Detailed Information Continued page of the wizard opens.
Figure 8-33 Choosing a number and format
10 Choose units and a number format (you dont need these if the
base item is alphanumeric, but you do need the units if the base
item is numeric), and ensure that the Active checkbox is checked.
11 Click Next.
The final page of the wizard opens.
12 Review the definition, then click Finish to save it.
Viewing and Editing Properties of Derived
Items
Use the instructions below to view or edit the properties of a derived
item. You can edit many of the properties by clicking or double-clicking
in the grid; others are available through the Properties dialog box.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Calculations task module using the
instructions in Opening the Calculations Module on page 8-2.
Read How Derived Items are Built on page 8-56.
Note: There is a delay of up to five minutes before derived items based on
accumulator items are available in VPWeb. This is because the derived item
waits for the insertion of a database record, which occurs every five minutes.
Calculations
CDC Factory 7.1
ActivEssentials Administration Guide
8-55
Procedure
1 In the Plant Hierarchy frame, navigate to and select the
hierarchy item (group or asset) whose derived item you want to
view or edit.
2 In the Local Items frame, click the Derived Items icon.
The grid displays any derived items that you have already created
for the group or asset.
3 Right-click on the item in the grid and select Properties.
Figure 8-34 The derived items Properties dialog box
4 Click the General, Details 1, and Details 2 tabs and view or edit
the properties as desired.
5 When finished, click OK.
Copying Derived Items
Use the instructions below to copy a derived item. You can then paste
the copy either to the same asset or to a different asset in the plant
hierarchy.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Calculations task module using the
instructions in Opening the Calculations Module on page 8-2.
Calculations
CDC Factory 7.1
ActivEssentials Administration Guide
8-56
Procedure
1 In the Plant Hierarchy frame, navigate to and select the
hierarchy item (group or asset) whose derived item you need to
copy.
2 In the Local Items frame, click the Derived Items icon.
The grid displays any derived items that you have already created
for the group or asset.
3 Right-click on the item in the grid and select Copy.
4 Navigate to the destination, then right-click in the grid and select
Paste).
Deleting a Derived Item
Use the instructions below to delete a derived item from a group or
asset.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Calculations task module using the
instructions in Opening the Calculations Module on page 8-2.
Procedure
1 In the Plant Hierarchy frame, navigate to and select the
hierarchy item (group or asset) whose derived item you need to
delete.
2 In the Local Items frame, click the Derived Items icon.
The grid displays any derived items that you have already created
for the group or asset.
3 Right-click an item in the grid and choose Delete.
A confirmation dialog box opens.
4 Click OK.
How Derived Items are Built
A derived item is a real-time data item that is based on an existing
data item. It is used to monitor the base item in real-time and in
relation to a time frame. For example, you can monitor a specific fault
so as to know how many times it has occurred in the current shift. This
derived item would update every time the fault occurs, and post the
new count.
Derived items belong to groups or assets, and you must define them
on the groups or assets for which they will be used. You can copy and
paste them from one asset to another.
Calculations
CDC Factory 7.1
ActivEssentials Administration Guide
8-57
You can use derived items in Trend View of VPWeb and in the
Real-Time Data Viewer control in Layout View of VPWeb. Using this
control you can set a color change when the derived item value
exceeds a certain level; or you can cause the control to flash red (or
whatever color you want!).
A derived item includes the following elements:
The base item, such as a production count, event variable, etc.
An aggregation method, such as Sum, Average, Count, etc.
The time frame
The frequency at which the item should be read
The Base Item
The base item can be either a numeric item or an alphanumeric item.
It can be any of the following:
An accumulator
A numeric event variable
An alphanumeric event variable
A shift
A shift period
These items display in the wizard pages when you are creating the
derived item. You can pick the one you want to use as a base item.
The Aggregation Method
The aggregation method defines how the value of the base item is to
be handled for real-time display. For numeric items, it can be any of
the aggregation methods available in AppCenterthat is, Sum,
Average, Count, First, Last. Maximum, Minimum, Standard Deviation,
and Variance. For alphanumeric items, it can be Count, First, or Last.
For example, if you wanted to create a derived item based on a
production count, you may well want to use the Sum aggregation
method so that the current production count (measured over the
appropriate time frame) is available. If you were monitoring fault
codes you could use the Count aggregation method. If you were
monitoring an event variable such as a temperature, you may want to
use the Maximum aggregation method; and so on.
Note: For information on setting up the real-time data viewer, see the VPWeb User
Guide, which is located in the ActivEssentials installation package.
Calculations
CDC Factory 7.1
ActivEssentials Administration Guide
8-58
The Time Frame
The options for the time frame are:
From a defined period ago to now. For example, you may want
to set the time frame to the last two hours. The end time in this
case is always now, so the start time is rolling forward.
From the beginning of the current shift to now. As soon as
the shift changes, the monitoring item resets to the beginning.
The Reading Frequency
This property defines the rate of update of the derived item. The
options are:
By a predefined time interval (in seconds)
By value change of the base item. In this case the derived item is
updated whenever the base item value changes (useful for
accumulator items such as counters)
Whenever a new database record is created (useful for incident
items such as faults or alarms, or for identifiers or event variables)
Example
1 You want to monitor the production count from the beginning of the
shift and send a notification if it falls below a certain value. In this
case you create a derived item based on the Production Count
accumulator item. You set the aggregation method to Sum and the
time frame to from the beginning of the current shift. You also set
the checking frequency to every 30 seconds.
2 You want to notify a supervisor if a temperature exceeds 250
Celsius. You create a derived item based on the temperature
variable, using the Maximum aggregation method. You set the time
frame to from the beginning of the current shift and the checking
frequency to every minute.
CDC Factory 7.1
ActivEssentials Administration Guide
9-1
Shift Configuration
Shift Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
9-2
Introduction to Shift Configuration
Shift configuration is an important part of configuring your data
collection system. Often your key performance indicators (KPIs) are
based on shift performance, and you also frequently want to create
reports that are based on shift information. Quite apart from reporting
functions, you often want to use VPWeb to display data in relation to
production shifts.
Many users of ActivEssentials have complex shift arrangements that
involve different schedules for different days of the week, or even
schedules that rotate over a period of weeks or months. You can
define and refine your shift information and align your manufacturing
data with it.
This chapter covers the following topics:
Shift Configuration in ActivEssentials on page 9-3
Shift Periods on page 9-7
Shift Definitions and Shift Structures on page 9-13
Shift Schedule Types and Shift Schedules on page 9-26
Using Shift Schedules in the Plant Hierarchy on page 9-40
Introduction to Shift Editing on page 9-53
Accessing the Production Shift Editor on page 9-54
Getting Started on page 9-57
Daily Schedule Changes on page 9-67
Reapplying Shifts on page 9-76
Assigning Temporary Shift Plans on page 9-80
Editing a Shift on page 9-84
Creating and Modifying Shifts on page 9-88
Creating and Modifying Shift Periods on page 9-94
Reports on page 9-97
The Shift Audit Log on page 9-102
Temporary Shift Plans on page 9-106
Shift Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
9-3
Shift Configuration in ActivEssentials
Shift information acts as an overlay to your manufacturing data,
allowing you to link data to individual shifts or even periods within a
shift. This allows you to relate your key performance indicators (KPIs)
to shift information and to create reports that break down the data in
relation to shifts.
In order to create shifts and shift schedules you first have to create
the building blocks in the Object Library, then assemble them into
schedules.
The smallest unit that you create is the shift period. This is a fragment
of a shift; it may be an hour, or a break period, or whatever else you
want it to be. The shift period is the smallest unit into which
production data can be broken down for reporting purposes. Shift
periods can be productive (times of normal production) or
non-productive (such as break periods).
The basic building block is the shift. Shifts are assembled from shift
periods, and the length of the shift is determined by the combination
of shift periods that constitute it.
When you have created and structured the shifts, you assemble them
into daily schedules, multi-day (for example, weekly) schedules, and
shift rotation plans. Rotation plans belong to plants, groups, or assets
in the plant hierarchy.
You can also edit historical shift data. For example, if yesterday was
very hot and a heat break was granted, you can go into the historical
shift data for yesterday and add the non-productive break, so that
your manufacturing data takes the break into account.
This section covers the following topics:
Accessing the Shift Configuration Module on page 9-3
Overview of Shift Configuration on page 9-4
Accessing the Shift Configuration Module
Use the instructions below to access the Shift Configuration module of
AppCenter. You perform all shift configuration and editing in this
module.
Note: There are some illegal characters that you cannot use when creating names in
ActivEssentials. They are: . ( ). For more information, see Illegal Characters
on page 1-17 .
Shift Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
9-4
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
Read Overview of Shift Configuration on page 9-4.
Procedure
1 In the taskbar, click the Configuration category button.
The taskbar refreshes to display icons for the task modules in the
Configuration category.
2 Select the Shift Configuration button on the taskbar.
A new Shift Configuration frame opens below the Plant Hierarchy.
This frame contains buttons that you will use to create shift
schedules.
Overview of Shift Configuration
Shift scheduling consists of several levels. You create each of these
levels in the Shift Configuration portion of AppCenter. The levels, in
order of the amount of time represented by each, are:
Shift periods. These are subdivisions of a shift. They may be any
length from five minutes to 24 hours. You can divide a shift into as
many periods as you want. For example, you may have a shift
called Shift 1 consisting of eight 1-hour periods. However, it is
quite likely that your shift is more complex, and includes
non-productive periods such as breaks. Each shift period has a
name and a color; the color displays in VPWeb.
Shift structures.
1
These are assemblies of shift periods that can be
used in different shifts. For example, a structure called Normal
may consist of the shift periods Hour 1, Hour 2, Hour 3, Lunch,
Hour 4, Hour 5, Hour 6, and Hour 7. When you create the shift
structure you assign a length to each period, so the structure itself
has a total duration.
Shifts. These are portions of the day, often 8 hours long or so. Each
shift has a name and a color that displays when you analyze data
by shift. The shift does not have a length until you assign a shift
structure to it, because the length is defined by the structure. You
1. There is no Shift Structures button in the Shift Configuration frame. You create
the structure while defining shifts.
Shift Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
9-5
then add shifts to a day, and when you do this you give the shift a
start time (the end time is automatically determined by the length
of the shift structure you assigned).
Shift Schedule Types. These are sets of daily schedules in which
each daily schedule contains one or more shifts (or it may contain
no shifts at all). For example, you may have Shifts 1, 2, and 3 in
force Monday to Friday, but only Shift 1 on Saturday and no shifts
on Sunday. A schedule type can cover a period of up to a month.
Shift Schedules. This is the end result of shift definition. A schedule
consists of one or more schedule types arranged in sequence. The
sequence repeats itself. Many manufacturers have only one
schedule type in the shift schedule, which repeats itself indefinitely.
Others have more a complex shift rotation plan containing several
schedule types, with the whole plan repeating itself every few
weeks.
When you define shifts, you have to create a bank of items at all four
levels of the structure, then assemble them together to create the
next level. The final result is a series of shift schedules that accurately
reflect the day-to-day work schedules of your enterprise. All these
items are created in the Object Library of AppCenter.
When you have created the schedules you select the groups or assets
in your enterprise, and apply the schedules to them. When that is
done, historical shift data collection can begin.
The Process of Shift Configuration
The process of defining a shift schedule is as follows (see the following
figure):
Figure 9-1 The process of shift configuration
1 First, you define some shift periods. These dont have a length at
this point. You only give them a name and color, and state whether
each is a productive/non-productive period and a standard/
non-standard period.
2 Next, you create a shift. You give it a name and a color, but not a
length. In the process, you create a shift structure consisting of
several shift periods. At this stage you state how long each period
Period 1
Period 2
Period 3
Define shift periods
Nane, Color, SLandard7, ProducLive7
Define shifts
Assign Nane and Color only
Choose which sLrucLure
Lo apply Lo Lhe shifL
Period 1
Period 2
Period 3
Add sLandard periods
Lo shifL sLrucLure
Create one or more
shift structures
Assign a nane
Assign a lengLh Lo
each period
1he sLrucLure has a
LoLal duraLion
1he shifL lengLh depends on
Lhe sLrucLure LhaL is assigned
Create a shift
scheduIe type
Daily
Weekly
MonLhly
Assign shifts
to each day
Choose the start
time for each shift
Day 1 ShifL 1
ShifL 2
ShifL 3
Day 2 ShifL 1
ShifL 2
ShifL 3
Day 3 ShifL 4
ShifL 5
ShifL
Schedule 1
Schedule 2
Schedule 3
AssembIe scheduIe
types to create
a shift scheduIe
AppIy the shift
scheduIe to assets
Shift Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
9-6
will be within this structure, so the structure itself has a duration
that is the sum of the periods. You then assign this structure to the
shift. The shift then gets its duration from the structure you
assigned.
3 If you want, you can define other shift structures for the same
shift. Or you can define new shifts that either have new structures
or reuse the existing structures. You can create as many
combinations as you need. For example, Shift 1 on a Monday may
have a different structure from Shift 1 on a Saturday.
4 You then create a shift schedule type. This is a cycle of any number
of days up to a month. For each day, you define which shifts are to
be used, and what the start time for each shift will be. The end
time of the shift is determined by the shift structure, so you dont
need to explicitly say what it is.
5 Finally, you assemble the shift schedule types into a full shift
schedule. You do this by adding schedule types and determining
the order in which they will occur.
6 All the preceding steps are performed in the Object Library. Now
that you have created a shift schedule, you go to the group or
asset in the plant hierarchy and apply the schedule to it. At this
point all your manufacturing data from the group or asset can be
related to the shift definitions.
Shift Configuration Defined in ActivApplications
Under the ActivApplications item in the Plant Hierarchy frame are the
asset templates that have been defined for use in your ActivEssentials
installation. Asset templates contain model shift configuration to fit
with the needs of specific applications. The applications can be
ActivApplications you purchased from CDC Factory, or they could be
applications you develop yourself.
In Shift Configuration, you treat the template items, which appear at
the third level down as you expand the ActivApplications tree, as if
they are assets. You can develop any aspect of shift configuration that
you might create for an asset and apply it to a template. You cannot
create templates in the Data Collection Configuration module, you can
do this in the Plant Configuration module. Although you can apply
configuration to the templates in the same way as you can to assets,
templates do not collect data.
If the applications and templates are a part of an imported application,
you should not change any aspect of the configuration without
understanding how this affects data collection as it relates to the
purpose of the application. In a practical sense, you should only make
changes to a template item if absolutely necessary.
Shift Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
9-7
Shift Periods
Shift periods are periods of time that you assemble together to form a
shift. They may be an hour long, or 20 minutes, or whatever period
you want to define (up to 24 hours). You must create one or more shift
periods before you can create a shift. When you have defined some
shift periods you can assemble the periods in different combinations to
form a shift.
You create all the shift period definitions in the Object Library.
This section covers the following topics:
Defining a New Shift Period on page 9-7
Editing Shift Periods on page 9-8
Copying and Pasting a Shift Period on page 9-9
Deleting a Shift Period on page 9-10
Overview of Shift Periods on page 9-11
Defining a New Shift Period
Use the instructions below to define a new shift period. Once you have
defined the shift period it becomes available for use in the structure of
any shift. Shift periods can be productive or non-productive, and
standard or non-standard. A standard period does not extend the shift
length, whereas a non-standard period does. Note that when you first
define a shift period you do not say how long it will be; you do that
when you add the shift period to a shift structure.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Shift Configuration task module using the
instructions in Accessing the Shift Configuration Module on page
9-3.
Read Overview of Shift Periods on page 9-11.
Procedure
1 In the Plant Hierarchy frame, select the Object Library.
The Shift Configuration frame opens in the secondary frame area.
2 Click the Shift Periods icon in the Shift Configuration frame.
The list of existing shift periods displays in the grid.
3 Click the New button on the toolbar.
The Add New Shift Period wizard starts.
4 Click Next to move past the welcome page.
The General Information page of the wizard opens.
Shift Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
9-8
Figure 9-2 Adding a new shift period
5 Click in the Name field and type a unique name (up to 50
characters) for the new shift period. If desired, enter a description
also (up to 255 characters).
6 Click the ellipsis button by the Color field, and select a color from
the Color dialog box. Click OK to return to the wizard.
7 If the new shift period will be a productive period (that is, work is
performed in it), ensure the Productive period checkbox is
checked. If it will be non-productive (for example, a lunch break),
clear the checkbox.
8 If the shift period will be a standard period (that is, it will not be
used only to extend the normal shift length on a temporary basis),
ensure the Standard period checkbox is checked. If the shift
period is non-standard (that is, it causes extension of the shift),
clear this checkbox.
9 Click Next.
The final page of the wizard opens.
10 Review the new configuration and click Finish to save.
Editing Shift Periods
Use the instructions below to edit the properties of a shift period.
When you do this, the changes are carried through to all the places
where the shift period is in use. Some changes cannot be made if the
shift period is used in one or more shift structures.
Shift Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
9-9
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Shift Configuration task module using the
instructions in Accessing the Shift Configuration Module on page
9-3.
Read Overview of Shift Periods on page 9-11.
Procedure
1 In the Plant Hierarchy frame, select the Object Library.
The Shift Configuration frame opens in the secondary frame area.
2 Click the Shift Periods icon in the Shift Configuration frame.
The list of existing shift periods displays in the grid.
3 Right-click on the shift period in the grid and select Properties.
Figure 9-3 Shift Period Properties dialog box
4 In the Properties dialog box, make the changes that you want,
then click OK.
Copying and Pasting a Shift Period
Use the instructions below to to copy a shift period. Once you have
copied and pasted the shift period, you can then edit the shift period
properties.
Note: You cannot change the Standard property if the shift period is used in any shift
definitions. You can change the Productive property.
Shift Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
9-10
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Shift Configuration task module using the
instructions in Accessing the Shift Configuration Module on page
9-3.
Read Overview of Shift Periods on page 9-11.
Procedure
1 In the Plant Hierarchy frame, select the Object Library.
The Shift Configuration frame opens in the secondary frame area.
2 Click the Shift Periods icon in the Shift Configuration frame.
The list of existing shift periods displays in the grid.
3 Right-click on the shift period in the grid and select Copy.
4 Right-click in the grid and select Paste.
Deleting a Shift Period
Use the instructions below to delete a shift period. You can only delete
a shift period if it is not used in any shift structure definitions. You
cannot delete the two non-standard periods that are included in the
system.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Shift Configuration task module using the
instructions in Accessing the Shift Configuration Module on page
9-3.
Read Standard and Non-standard Periods on page 9-11.
Procedure
1 In the Plant Hierarchy frame, select the Object Library.
The Shift Configuration frame opens in the secondary frame area.
2 Click the Shift Periods icon in the Shift Configuration frame.
The list of existing shift periods displays in the grid.
3 Right-click on the shift period in the grid and select Delete.
A confirmation dialog box opens.
Note: When you copy and paste a shift period, the new shift period is an exact copy
of the original except that the name is now prefixed with the term Copy of.
Use the instructions in Editing Shift Periods on page 9-8 to edit the name or
other properties.
Shift Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
9-11
4 Click OK.
Overview of Shift Periods
Shift periods are subdivisions of shifts. They allow you to analyze
manufacturing data to a finer level than the shift only. When you
define a shift you add shift periods one to another in order to assemble
the whole shift. A shift is nothing more than a collection of shift
periods.
First you have to define each unique shift period for use in your shifts.
Once you have defined the shift period you can use it over and over
again in shift definitions. A shift period can be any length between one
minute and 24 hours.
Productive and Non-Productive Periods
A shift period can be a productive shift period or a non-productive shift
period. A productive period is one in which manufacturing is going on.
A period such as a lunch break would be defined as non-productive.
This allows you to filter out non-productive periods when you are
analyzing data later on. Note that even non-productive time has to be
defined as a shift period; you cannot just ignore it.
Standard and Non-standard Periods
A shift period can be a standard shift period or a non-standard shift
period. A Standard period is a normal part of a shift, whereas a
non-standard period extends the length of the shift temporarily.
Non-standard periods are used in unusual situations where you want
to extend the shift for some reason. For example, Hour 2 would
probably be defined as a Standard period, but Overrun may be defined
as a non-standard period that extends the shift. You can create your
own non-standard shift periods if you wish.
The data collection system contains two ready-made, non-standard
shift periods which are specifically designed for extending the shift,
called Extended_Period_Before_Shift and
Extended_Period_After_Shift. You can change these names if you
wish. To do so, right-click the period in the grid and choose
Properties, then change the name. These system shift periods are
used only for extending a shift, and they may be productive or
non-productive. You cannot add these periods to a shift structure; they
are only used for creating a temporary shift schedule.
Note: When you define a new shift period you do not give it a length. You assign a
length to it later, when you make the period a part of a shift structure.
Shift Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
9-12
Shift Structures
A shift structure is an assembly of shift periods that together form the
shift. For example, Shift 1 may have a structure consisting of the
periods Hour 1, Hour 2, Hour 3, and so on. A given shift can have one
of several available structures, so that Mondays Shift 1 may be
different from Saturdays Shift 1. You dont need to create a Monday
Shift 1 and a Saturday Shift 1just use Shift 1 and add a different
structure for Saturday.
A shift structure must contain at least one Standard shift period; it
cannot contain just a non-standard shift period (they are used only for
temporary shifts). It can contain Productive or non-productive periods.
Once you create a shift structure you can use it over and over again in
different shifts.
Shift Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
9-13
Shift Definitions and Shift Structures
A shift definition is basically a name and description for a shift that is
in use in your manufacturing facility. For example, you may have shifts
called Shift 1, Night Shift, etc. You have to create a definition for each
of the shifts that you use.
When you define the shift you do not give it a length. Instead, you
create a shift structure, which is a collection of shift periods, and
assign the shift structure to the shift. Shifts can have more than one
shift structure, so Shift 1 may have one structure on Monday and a
different structure on Saturday.
Once you have defined shift periods, shift structures, and the shifts
themselves, you are ready to assemble these into a daily, weekly, or
monthly shift schedule. It is at that point that you decide when the
shift will start.
This section covers the following topics:
Creating a New Shift Definition on page 9-13
Defining a Shift Structure on page 9-14
Defining a Shift Structure When Creating a Shift on page 9-18
Defining a Structure for an Existing Shift on page 9-20
Removing a Shift Structure from a Shift on page 9-21
Editing Shift Definitions on page 9-22
Copying and Pasting a Shift on page 9-23
Deleting a Shift Definition on page 9-24
Understanding Shift Structures on page 9-25
Creating a New Shift Definition
Use the instructions below to create a new shift definition.
When creating the shift, you give it a name and then assign a shift
structure to it. The duration of the shift is determined by the structure
that you assign, and is the sum of the periods in the structure. When
you have created the shift, you can use it over and over again as part
of a daily shift schedule.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Shift Configuration task module using the
instructions in Accessing the Shift Configuration Module on page
9-3.
Read Understanding Shift Structures on page 9-25.
Shift Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
9-14
Procedure
1 In the Plant Hierarchy frame, select the Object Library.
The Shift Configuration frame opens in the secondary frame area.
2 Click the Shifts icon in the Shift Configuration frame.
A list of previously defined shifts appears in the details grid.
3 Select the New button on the toolbar.
The Add New Shift Wizard starts.
4 Click Next to move past the welcome page.
Figure 9-4 The General Information wizard page
5 Type a name (up to 50 characters) and, if desired, a description
(up to 255 characters) for the new shift.
6 Click the Color button to open the Color dialog box, then select a
color and click OK.
The shift will appear in VPWeb as a bar with this color.
7 Click Next.
8 Create a shift structure as described in Defining a Shift Structure
on page 9-14, then click Finish.
The new shift appears in the grid.
Defining a Shift Structure
Use the instructions below to define a shift structure when creating a
new shift definition or editing an existing shift definition.
Shift Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
9-15
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Shift Configuration task module using the
instructions in Accessing the Shift Configuration Module on page
9-3.
Read Understanding Shift Structures on page 9-25.
Procedure
1 In the Plant Hierarchy frame, select the Object Library.
The Shift Configuration frame opens in the secondary frame area.
2 Click the Shifts icon in the Shift Configuration frame.
A list of previously defined shifts appears in the details grid.
3 Select the New button on the toolbar.
The Add New Shift Wizard starts.
4 Click Next to move past the welcome page.
Figure 9-5 The General Information wizard page
5 If you are creating a new shift definition, proceed to the Create
Shift Structure(s) page of the Add New Shift wizard. This page
shows the list of structures for the shift.
Shift Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
9-16
Figure 9-6 The Create Shift Structure(s) wizard page
6 If you are editing an existing shift, right-click the shift and choose
Properties, then click the Open Editor button in the shift
Properties dialog box.
Figure 9-7 The Shift Properties dialog box
7 Double-click in the Name column and type a unique name for the
shift period structure. The name can be up to 50 characters long.
8 Click in the Structure column, then click the ellipsis button to open
the Structure Editor.
Shift Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
9-17
Figure 9-8 Opening the Shifts Editor
9 Click the down-arrow by the Available Shift Periods list-box, and
select a shift period in the list.
If you wish you can define a new shift period from this point by
clicking the New button and completing the Add New Shift Period
wizard. See Defining a New Shift Period on page 9-7 for
instructions.
Figure 9-9 Shift Structure Editor
10 Edit the number of minutes in the period by typing in the Duration
(min) field. The duration can be anything from one minute to 1 440
minutes (24 hours). Click the Add button.
The shift period is added to the list-box at the right. This list shows
the periods that are included in the shift structure.
11 Continue adding shift periods to the shift as described above, until
the structure is complete.
Shift Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
9-18
Figure 9-10 Shift periods added to a shift structure
12 To remove a period from the list of those added, select it and click
Remove.
13 To change the order of periods in the list, select a period and move
it up or down by clicking the up- or down-arrow buttons to the right
of the list.
14 Click OK when the periods have been added to the structure, then
Finish (or Next, if you are creating a new shift).
15 Click Finish to save the structure.
Defining a Shift Structure When Creating a
Shift
Use the instructions below to define a shift structure when creating a
new shift.
A shift structure is a means of dividing a shift into shift periods, each
with a defined length. You can define more than one structure for each
shift, but before you add the shift to a daily schedule you have to
choose one of the structures that have been defined and add it to the
shift definition. For information on creating shift periods, see Defining
a New Shift Period on page 9-7.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Shift Configuration task module using the
instructions in Accessing the Shift Configuration Module on page
9-3.
Read Understanding Shift Structures on page 9-25.
Shift Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
9-19
Procedure
1 In the Plant Hierarchy frame, select the Object Library.
The Shift Configuration frame opens in the secondary frame area.
2 Click the Shifts icon in the Shift Configuration frame.
A list of previously defined shifts appears in the details grid.
3 Select the New button on the toolbar.
The Add New Shift Wizard starts.
4 Click Next to move past the welcome page.
Figure 9-11 The General Information wizard page
5 Do the following:
a) In the Name field, type a name (up to 50 characters) for the
new shift.
b) If required, in the Description field, type a description (up to
255 characters) of the new shift.
c) Click the ellipsis button to the right of the Color field, and
choose a color to represent the shift when it appears in VPWeb.
6 Click Next.
The Create Shift Structure(s) page of the wizard opens.
7 Double-click in the Name column and type a unique name for the
shift period structure. The name can be up to 50 characters long.
8 In the Structure column, click once, then click the ellipsis button
to open the structure editor.
You use this editor to select and edit the shift periods that form the
shift structure.
9 Follow the instructions given in Defining a Shift Structure on page
9-14, beginning at Step 9.
Shift Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
9-20
Defining a Structure for an Existing Shift
Use the instructions below to define a shift structure for an existing
shift. Each shift can have more than one structure. When you want to
use a shift later, you will have to choose which structure to use for it.
The structure you use will determine the length of the shift.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Shift Configuration task module using the
instructions in Accessing the Shift Configuration Module on page
9-3.
Read Understanding Shift Structures on page 9-25.
Procedure
1 In the Plant Hierarchy frame, select the Object Library.
The Shift Configuration frame opens in the secondary frame area.
2 Click the Shifts icon in the Shift Configuration frame.
A list of previously defined shifts appears in the details grid.
3 Right-click on the shift in the grid and select Properties.
A properties dialog box opens.
4 Click the Open Editor button.
Figure 9-12 The Shift Properties dialog box
The Create Shift Structure(s) dialog box opens.
Shift Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
9-21
Figure 9-13 The Create Shift Structure(s) dialog box
5 Double-click in the Name column and edit the name, then click in
the Structure column and click the ellipsis button to open the
Create Shift Structure(s) editor.
6 Follow the instructions given in Defining a Shift Structure on page
9-14 to add shift periods to the structure. When done, click Finish.
7 Click OK to close the Properties dialog box.
Removing a Shift Structure from a Shift
Use the instructions below to remove a shift structure from a shift.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Shift Configuration task module using the
instructions in Accessing the Shift Configuration Module on page
9-3.
Procedure
1 In the Plant Hierarchy frame, select the Object Library.
The Shift Configuration frame opens in the secondary frame area.
2 Click the Shifts icon in the Shift Configuration frame.
A list of previously defined shifts appears in the details grid.
3 Right-click on the shift in the grid and select Properties.
A properties dialog box opens.
4 Click Open Editor.
Shift Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
9-22
Figure 9-14 The Shift Properties dialog box
The Create Shift Structure(s) dialog box opens.
Figure 9-15 The Create Shift Structure(s) dialog box
5 On the row in the grid for the shift structure you need to disable,
select the checkbox in the Remove column, and then click Finish.
6 Click OK to close the Properties dialog box.
Editing Shift Definitions
Use the instructions below to edit the properties of a shift definition. If
you do this, the changes will carry through to all places where the shift
definition is in use.
Shift Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
9-23
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Shift Configuration task module using the
instructions in Accessing the Shift Configuration Module on page
9-3.
Read Understanding Shift Structures on page 9-25.
Procedure
1 In the Plant Hierarchy frame, select the Object Library.
The Shift Configuration frame opens in the secondary frame area.
2 Click the Shifts icon in the Shift Configuration frame.
A list of previously defined shifts appears in the details grid.
3 Right-click the shift in the grid and choose Properties.
A properties dialog box opens.
4 In the Properties dialog box, make the changes that you want. If
you want to edit the shift structure, click the Open Editor button
and follow the instructions given in Defining a Shift Structure on
page 9-14.
5 Click OK to close the editor, then OK again to close the Properties
dialog box.
A message box prompts you asking whether you want to reassign
historical data. If you choose Yes, the historical data will be
assigned to the new shift definition. If you choose No, it will remain
with the shifts as they were before your changes.
Copying and Pasting a Shift
Use the instructions below to to copy a shift. Once you have copied
and pasted the shift, you can then edit the shift properties.
Warning! If you change the name of a shift, any cached reports that use the old shift
name will be marked as expired and deleted.
Note: You can also edit some properties of a shift directly in the grid. Click or
double-click in the appropriate column. You cannot edit the shift structure in the
grid.
Shift Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
9-24
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Shift Configuration task module using the
instructions in Accessing the Shift Configuration Module on page
9-3.
Read Understanding Shift Structures on page 9-25.
Procedure
1 In the Plant Hierarchy frame, select the Object Library.
The Shift Configuration frame opens in the secondary frame area.
2 Click the Shifts icon in the Shift Configuration frame.
A list of previously defined shifts appears in the details grid.
3 Right-click on the shift in the grid and select Copy.
4 Right-click in the grid and select Paste.
Deleting a Shift Definition
Use the instructions below to delete a shift definition. When you do
this, all the shift structures for the definition will also be deleted, and
the shift will be removed from any shift schedule type and shift
schedule in which it is used. Cached reports that use the shift will be
marked as expired and deleted.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Shift Configuration task module using the
instructions in Accessing the Shift Configuration Module on page
9-3.
Procedure
1 In the Plant Hierarchy frame, select the Object Library.
The Shift Configuration frame opens in the secondary frame area.
2 Click the Shifts icon in the Shift Configuration frame.
A list of previously defined shifts appears in the details grid.
3 Right-click a shift in the grid and choose Delete.
A confirmation dialog box opens.
Note: When you copy and paste a shift, the new shift is an exact copy of the original
except that the name is now prefixed with the term Copy of. Use the
instructions in Editing Shift Definitions on page 9-22 to adjust the properties to
your needs.
Shift Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
9-25
4 Click OK.
Understanding Shift Structures
A shift structure is a collection of shift periods that are added together
to cover a given period of time. You assemble a shift structure by
selecting shift periods, giving each period a length (in minutes), and
determining the order in which the periods follow one another. When
you have assembled the periods together, the structure itself has a
length that is the sum of all the period lengths.
You can use non-productive periods, such as a lunch break, as part of
the structure, but you cannot use non-standard periods. Non-standard
periods are only used to create temporary shift structures.
Before you create a shift structure you must:
Define some shift periods, and
Create a shift definition, giving it a name and color.
After you create the shift structure you must:
Save the structure so that it can be used over and over again, and
Assign the structure to one or more shifts.
In practice, you usually create a shift structure while you are in the
process of creating a shift definition.
Note: Note that the structure is very specific. It includes the names of the included
shift periods, the order in which they follow one another, and the length of each
period. You may create a second structure with the same periods in the same
order as a previous structure, but if any of the lengths is different it constitutes a
new structure.
Shift Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
9-26
Shift Schedule Types and Shift Schedules
When you have created shift periods, shift structures, and shift
definitions, you are ready to assemble the shifts into daily schedules.
There are two stages to this process. First, you create one or more
shift schedule typescollections of days containing shifts (some days
may contain no shifts). The schedule type may cover a period of a
week, for example. Then you assemble your predefined schedule types
into a full shift schedule that may cover any period from a few days to
several months.
This section covers the following topics:
Creating a Shift Schedule Type on page 9-26
Editing a Shift Schedule Type on page 9-29
Deleting a Shift Schedule Type on page 9-31
Viewing the Shifts in a Shift Schedule Type on page 9-31
Creating a Shift Schedule on page 9-33
Editing a Shift Schedule on page 9-35
Deleting a Shift Schedule on page 9-36
Overview of Shift Schedule Types and Shift Schedules on page
9-37
The Shift Schedule Type on page 9-37
The Shift Schedule on page 9-38
Creating a Shift Schedule Type
Use the instructions below to create a shift schedule type spanning a
number of days, up to a month.
In doing this, you first define the number of days, then you add shifts
to each day and define the time each shift starts. You should first have
created some shift definitions and structures.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Shift Configuration task module using the
instructions in Accessing the Shift Configuration Module on page
9-3.
Read the following:
Overview of Shift Schedule Types and Shift Schedules on page
9-37
The Shift Schedule Type on page 9-37
Defined shifts using the instructions in Defining a Shift Structure
on page 9-14.
Shift Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
9-27
Procedure
1 In the Plant Hierarchy frame, select the Object Library.
The Shift Configuration frame opens in the secondary frame area.
2 Click the Shift Schedule Types icon in the Shift Configuration
frame.
A list of previously defined shift schedule types (if any) appears in
the grid.
3 Click the New button on the toolbar.
The Add New Shift Schedule Type wizard starts.
4 Click Next to move past the welcome screen.
Figure 9-16 Add New Shift Schedule Type wizard
5 Do the following:
a) Enter a name (up to 50 characters) for the schedule type, and
a description if desired.
b) Choose a Type option: by day, by week, or by month. If you
choose by day, enter the number of days to be covered, up to
a maximum of 31.
Shift Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
9-28
Figure 9-17 The Create Daily Schedule(s) dialog box
6 Click Next.
The Create Daily Schedules page of the wizard opens.
7 Click in the Daily Schedule column for the first day, then click the
ellipsis button.
The Shift Editor opens, showing the shift definitions that are
available, as well as a graphical representation of the day.
Figure 9-18 Creating a daily schedule
8 Click in the Shift Name column and select a shift from the list,
then click in the Shift Structure column and select a structure
Shift Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
9-29
from the list. (The Duration column fills in according to the length
of the shift structure that you chose.)
9 Click Apply to add the shift to the day.
The shift appears as a bar in the graphical part of the dialog box.
10 Click in the Start Time column and type the start time for the
shift.
11 If your first shift starts the previous day (for example, at 23:00),
click in the First Shift column to place a checkmark there.
12 Repeat the process to add further shifts to the day, then click OK.
13 To remove a shift from the day, select the shift and click the
Remove button. To create a new shift definition for use in the day,
click New to initiate the Add New Shift wizard.
14 Repeat the process for each day of the schedule type, then click
Next, then Finish.
Editing a Shift Schedule Type
Use the instructions below to view or edit the properties of a shift
schedule type. You can change the name, description, and length of
the schedule type. You can also add or remove shifts from days in the
schedule type. If the schedule type is in use in a rotation plan, you
cannot delete the last shift from it; there has to be at least one shift
for one day in the schedule type.
Note: Shifts do not need to follow each other directly. You can have a gap between
them if you wish, but they cannot overlap.
Note: You can copy a daily schedule to another day. In the Create Daily Schedule(s)
dialog box, right-click a day and choose Copy, then right-click on another day
and choose Paste. The shift definitions will be copied from one day to the
other.
Shift Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
9-30
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Shift Configuration task module using the
instructions in Accessing the Shift Configuration Module on page
9-3.
Read the following:
Overview of Shift Schedule Types and Shift Schedules on page
9-37
The Shift Schedule Type on page 9-37
Procedure
1 In the Plant Hierarchy frame, select the Object Library.
The Shift Configuration frame opens in the secondary frame area.
2 Click the Shift Schedule Types icon in the Shift Configuration
frame.
A list of previously defined shift schedule types (if any) appears in
the grid.
3 Right-click a schedule type in the grid and choose Properties.A
properties dialog box opens.
Figure 9-19 Shift Schedule Type properties dialog box
4 Change the properties if desired. If you want to change the shifts
that have been added to the schedule type, click the Open Editor
button and make the changes.
Shift Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
9-31
5 Click OK to save your changes.
Deleting a Shift Schedule Type
Use the instructions below to delete a shift schedule type.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Shift Configuration task module using the
instructions in Accessing the Shift Configuration Module on page
9-3.
Procedure
1 In the Plant Hierarchy frame, select the Object Library.
The Shift Configuration frame opens in the secondary frame area.
2 Click the Shift Schedule Types icon in the Shift Configuration
frame.
A list of previously defined shift schedule types (if any) appears in
the grid.
3 Right-click on a schedule type in the grid and select Delete.
A confirmation dialog box opens.
4 Click OK.
Viewing the Shifts in a Shift Schedule Type
Use the instructions below to view the shifts in a schedule type in a
graphical view. This gives you a quick look at the shift arrangements
for the schedule type.
Note: If you change the number of days in the schedule type, any historical data that
has been collected using this schedule type will be regenerated using the new
properties.
Note: You can view or edit some properties of a shift schedule type directly in the
grid. Click or double-click in the appropriate column and edit.
Note: If you delete a shift schedule type that has been used to collect data, all the
historical data that has been collected under that schedule type will be deleted
from the database.
Shift Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
9-32
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Shift Configuration task module using the
instructions in Accessing the Shift Configuration Module on page
9-3.
Read the following:
Overview of Shift Schedule Types and Shift Schedules on page
9-37
The Shift Schedule Type on page 9-37
Created a shift schedule type using the instructions in Creating a
Shift Schedule Type on page 9-26.
Procedure
1 In the Plant Hierarchy frame, select the Object Library.
The Shift Configuration frame opens in the secondary frame area.
2 Click the Shift Schedule Types icon in the Shift Configuration
frame.
A list of previously defined shift schedule types (if any) appears in
the grid.
3 Right-click on a schedule type in the grid and select Properties.
Figure 9-20 Shift Schedule Type Properties dialog box
4 Click the Open Editor button to open the Create Daily
Schedule(s) dialog box.
Shift Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
9-33
5 Click the Graphical View button to open the graphical view.
Figure 9-21 Graphical view of shifts in a schedule type
6 To align the time scale with the first shift of the day, click in the
Align Start Times checkbox.
Creating a Shift Schedule
Use the instructions below to create a shift schedule that you can
apply to assets in your data collection system. The shift schedule
contains one or more shift schedule types. They must be arranged in
the order in which they will come into force.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Shift Configuration task module using the
instructions in Accessing the Shift Configuration Module on page
9-3.
Read the following:
Overview of Shift Schedule Types and Shift Schedules on page
9-37
The Shift Schedule Type on page 9-37
Created a shift schedule type using the instructions in Creating a
Shift Schedule Type on page 9-26.
Note: The Align Start Times checkbox is not functional if the first shift of the day has
a start time during the previous day. For example, a shift that runs from 23:00
until the 07:00 the following day.
Shift Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
9-34
Procedure
1 In the Plant Hierarchy frame, select the Object Library.
The Shift Configuration frame opens in the secondary frame area.
2 Click the Shift Schedules icon in the Shift Configuration frame.
A list of previously defined shift schedule types (if any) appears in
the grid.
3 Click the New button on the toolbar.
The Add New Shift Schedule wizard starts.
4 Click Next to move past the welcome page.
Figure 9-22 The General Information wizard page
5 Type a name (up to 50 characters) and, if you wish, a description
(up to 255 characters) for the shift schedule.
6 Click Next.
Shift Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
9-35
Figure 9-23 The Add Shift Schedule Types wizard page
7 Do each of the following:
a) Click the down-arrow to the right of the Available Shift
Schedules Types field, and select the kind of schedule type
you want to add (by day, by week, or by month).
b) In the left pane, select a schedule type from the list of available
schedule types, and then click Add to add it to the schedule.
You cannot add a schedule type more than once.
c) Repeat the last step to add further schedule types if desired.
d) To sort the schedule types in the list on the right, select an
added schedule type, then click the up or down-arrows to move
it.
8 When done, click Finish to save the schedule.
Editing a Shift Schedule
Use the instructions below to view and edit the properties of a shift
schedule. You can edit the schedule even if it is being used to collect
data.
Note: If the schedule type you need does not exist, click the New button to initiate the
Add New Shift Schedule Type wizard, then create the schedule type. When
you complete that wizard you will be returned to the Add New Shift Schedule
wizard and the new schedule type will be available.
Note: The shift definition process is complete when you have created a shift
schedule. You can go through the process again to create different shift
schedules if necessary. Before you can use a shift schedule, you have to add it
to one or more assets. For information on how to do this, see Using Shift
Schedules in the Plant Hierarchy on page 9-40.
Shift Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
9-36
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Shift Configuration task module using the
instructions in Accessing the Shift Configuration Module on page
9-3.
Read the following:
Overview of Shift Schedule Types and Shift Schedules on page
9-37
The Shift Schedule Type on page 9-37
Created a shift schedule using the instructions in Creating a Shift
Schedule on page 9-33.
Procedure
1 In the Plant Hierarchy frame, select the Object Library.
The Shift Configuration frame opens in the secondary frame area.
2 Click the Shift Schedules icon in the Shift Configuration frame.
A list of previously defined shift schedule types (if any) appears in
the grid.
3 Right-click on a schedule in the grid and select Properties.
A properties dialog box opens.
4 Edit the name and description if desired. To edit other properties,
click the Open Editor button.
5 In the Add Shift Schedule Type(s) editor, add or remove schedule
types as required, then click OK.
Deleting a Shift Schedule
Use the instructions below to delete a shift schedule.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Shift Configuration task module using the
instructions in Accessing the Shift Configuration Module on page
9-3.
Created a shift schedule using the instructions in Creating a Shift
Schedule on page 9-33.
Warning! If you delete a shift schedule that has been used to collect data, all the
historical data that has been collected under that schedule will be deleted
from the database.
Shift Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
9-37
Procedure
1 In the Plant Hierarchy frame, select the Object Library.
The Shift Configuration frame opens in the secondary frame area.
2 Click the Shift Schedules icon in the Shift Configuration frame.
A list of previously defined shift schedule types (if any) appears in
the grid.
3 Right-click on a schedule in the grid and select Delete.
A confirmation dialog box opens.
4 Click OK.
Overview of Shift Schedule Types and
Shift Schedules
Some manufacturing facilities use only one schedule type. In other
words, they operate a shift schedule that repeats itself with no
variations. It may be a weekly schedule, for example.
Other facilities use a rolling set of schedule types, and the set repeats
itself. For example, they may operate a week of 24-hour days,
followed by a week of 16-hour days, then revert to the week of
24-hour days.
ActivEssentials accommodates simple or complex shift schedules by
providing two levels of configuration: the shift schedule type and the
shift schedule. A schedule type is a set of up to 31 days, each of which
has a shift arrangement defined (which may be no shifts at all). A shift
schedule is a set of one or more schedule types which are arranged in
sequence.
The Shift Schedule Type
This is a series of daysup to a montheach of which contains zero or
more shifts. When defining a shift schedule type you need to identify
the sets of days that repeat throughout the year, and define a schedule
type for each set. You can make these as simple or as complex as you
like.
When you define a shift schedule type you choose one of the following
options:
By Day. This option allows you to define the number of days in the
schedule type, up to a maximum of 31 days. This is the option to
use if your schedule consists of a number of days that all have the
same shift arrangement, and that arrangement repeats itself.
Shift Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
9-38
Example
You create a daily schedule type containing five days. Each day has
three shifts, and the shifts are the same on all the days. They start
and end at the same times on each day. The first day of the schedule
type is called Day 1, and it can fall on any day of the week.
By week. A weekly schedule type consists of one week of seven
days. Each day in the week can be different, but the weekly
schedule repeats itself.
Example
Your weekly schedule runs from Monday to Sunday. On Monday to
Friday there are three shifts per day; on Saturday and Sunday there
are no shifts. You choose Monday as the first day for the schedule
type.
By month. A monthly schedule contains up to 31 days, each of
which can have a different arrangement of shifts. The schedule
begins again on the first of each month, even if the previous month
had only 28, 29, or 30 days.
Example
Your maintenance schedule demands that certain work is done on the
first day of each month, whatever day of the week that is. You create a
monthly schedule to accommodate this arrangement.
When defining schedule types, you need to consider special cases,
such as weeks that contain a statutory holiday, or times when the
plant is retooling, etc.
Note that a daily schedule type does not depend on any particular day
of the week. The days are simply numbered, and the system does not
care which day of the week is Day 1. This reflects the actual practice in
many facilities, where staff on a 5-day cycle will start each cycle on a
different day of the week. A weekly schedule type, on the other hand,
gives the correct names to the days of the week.
When you assemble the full schedule and assign it to an asset you will
decide on which date the schedule will begin.
The Shift Schedule
This is the final stage in defining shifts. It is a collection of one or more
schedule types. When you create the schedule, you decide which
schedule types to include and the order that they should follow.
Example
Your manufacturing facility has a different shift schedule in the
summer. You create two schedule types: Normal and Summer. Then
you create a full shift schedule in which Normal is followed by Summer.
You define the dates of the switch to Summer and the switch back to
Normal.
Shift Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
9-39
This is a simple example. In practice, you will probably have a more
complex schedule to accommodate public holidays, etc.
If your shift arrangements are simple and you have the same schedule
all year round (which is unlikely because of statutory holidays), you
simply create a schedule that contains one schedule type.
Shift Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
9-40
Using Shift Schedules in the Plant Hierarchy
When you have created one or more shift schedules you need to apply
them to the assets in your plant. This is done using the shift rotation
plan, which determines the start date and time of each schedule.
This section covers the following topics:
Adding a Shift Schedule to Groups and Assets on page 9-40
Editing the Rotation Plan on page 9-43
Overwriting Historical Data for a Rotation Plan on page 9-45
Removing a Schedule from the Rotation Plan on page 9-46
Using Shift Schedules in Groups and Assets on page 9-47
Relationships Between Group and Asset Schedules on page 9-48
When you Delete a Shift Schedule From a Rotation Plan on page
9-49
When You Add an Aset to a Group on page 9-49
When You Edit or Delete the Rotation Plan for an Asset on page
9-50
Viewing Shift Rotation Plans in the Grid on page 9-50
Overlapping Shift Schedules on page 9-51
Adding a Shift Schedule to Groups and
Assets
Use the instructions below to add a shift schedule to groups or assets
in the plant hierarchy. You can add as many schedules as you want to
a group or assets, with each one to come into force at a given date
and time. You should previously have created one or more shift
schedules; if you have not, go to Shift Configuration in ActivEssentials
on page 9-3 and work through the steps to create a shift schedule.
Note: You need the appropriate security privileges to assign shift schedules to the
plant hierarchy. The Shift Global Definition Management role does not include
these privileges. The System Administrator role includes these privileges, or
you can assign them to a user who has access to the plant hierarchy object in
question. However, if you do this, the user has access to the whole
configuration of the plant hierarchy object, not just the shifts. See Security in
AppCenter on page 10-1 for more information.
Shift Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
9-41
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Shift Configuration task module using the
instructions in Accessing the Shift Configuration Module on page
9-3.
Created a shift schedule using the instructions in Creating a Shift
Schedule on page 9-33.
Have the appropriate security privileges to assign shift schedules
to the plant hierarchy. See Security in AppCenter on page 10-1 for
more information.
Read the following:
Using Shift Schedules in Groups and Assets on page 9-47
Relationships Between Group and Asset Schedules on page
9-48
When You Add an Aset to a Group on page 9-49
Viewing Shift Rotation Plans in the Grid on page 9-50
Overlapping Shift Schedules on page 9-51
Procedure
1 In the Plant Hierarchy frame, select the Object Library.
The Shift Configuration frame opens in the secondary frame area.
2 Click the Shift Schedules icon in the Shift Configuration frame.
A list of previously defined shift schedule types appears in the grid.
3 In the Plant Hierarchy frame, expand the hierarchy until you can
see the hierarchy item (plant, group, or asset) to which you need
to add the shift schedule but do not select it.
4 With the Object Library still selected, click and drag the icon for
the schedule you need to add from the grid to the Plant Hierarchy
item.
Figure 9-24 Dragging a shift schedule to an plant hierarchy item
The Create a Rotation Plan dialog box opens. This dialog box
shows the schedules that already exist on the plant, group, or
asset. It also shows the details of the schedule that you are
adding.
Shift Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
9-42
Figure 9-25 The Rotation Plan dialog box
5 In the Properties of (Schedule name) area, do the following:
a) Click in the Starting Schedule Type column and select the
schedule type that should start the schedule. The schedule
consists of one or more schedule types, any of which can be set
to start the schedule.
b) Click in the Starting Day column and choose the day number
of the schedule type (for example, Day 1) on which the
schedule should start. The list may show the days of the week
or numbered days, depending on how the schedule type that
you chose in the previous step is set up.
c) Click in the Start Time column and choose a start date and
time. You have the option to set an absolute time, or to start
the schedule at the start time of the first shift in the schedule.
Shift Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
9-43
d) Click in the End Time column and choose the end time. You
have the option to set an absolute end time, or to end the
schedule at the end time of the last shift in the schedule.
6 Click OK to apply the rotation plan.
Editing the Rotation Plan
Use the instructions below to view and edit the properties of the
rotation plan for a plant, group, or asset. You can only edit the rotation
plan by modifying the schedules that are part of the plan. When you
do this you have to reassign the historical shift data to the new
rotation plan.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Shift Configuration task module using the
instructions in Accessing the Shift Configuration Module on page
9-3.
Created a rotation plan using the instructions in Adding a Shift
Schedule to Groups and Assets on page 9-40.
Read the following:
When You Edit or Delete the Rotation Plan for an Asset on page
9-50
Viewing Shift Rotation Plans in the Grid on page 9-50
Procedure
1 In the Plant Hierarchy frame, select the plant, group, or asset
with a rotation plan you must edit.
The Historical Data Management frame opens in the secondary
frame area.
Note: If you chose a day of the week (for example, Monday) in the previous step, be
sure to choose a Monday in the calendar too, otherwise you will receive an
error message.
Shift Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
9-44
2 In the Historical Data Management frame, click the Rotation
Plans icon.
The grid displays the rotation plan for the plant, group, or asset. It
consists of a list of the schedules that make up the rotation plan.
3 Right-click on a schedule in the grid and select Properties. A
properties dialog box opens.
Figure 9-26 Rotation Plan Properties dialog box
4 Edit the properties of the schedule as desired. You can substitute
another schedule, change the starting schedule type, the day, and
the start and end dates and times.
5 When finished, click OK.
The Additional Options dialog box opens.
Note: Check the options carefully to determine which should apply to your situation.
Shift Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
9-45
Figure 9-27 The Additional Options dialog box
6 In the Additional Options dialog box, check the options that you
want to apply to the modified rotation plan.
7 Click OK twice.
Overwriting Historical Data for a Rotation
Plan
Use the instructions below to overwrite historical shift data for a single
rotation plan. You will need to do this whenever you make changes to
a rotation plan that covers only a specific period of time. In this case
you do not want to overwrite all the historical data, only the data for
that period. Because this operation may involve a lot of database
records, it is scheduled as a job in the database.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Shift Configuration task module using the
instructions in Accessing the Shift Configuration Module on page
9-3.
Created a rotation plan using the instructions in Adding a Shift
Schedule to Groups and Assets on page 9-40.
Read the following:
When You Edit or Delete the Rotation Plan for an Asset on page
9-50
Viewing Shift Rotation Plans in the Grid on page 9-50
Note: Usually you will want to select at least the first two options here, so that your
changes can take effect. If you also check the Overwrite historical data box,
the changes you make will be applied to all the historical data in the database.
Shift Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
9-46
Procedure
1 In the Plant Hierarchy frame, select the plant, group, or asset
whose data you want to overwrite.
The Historical Data Management frame opens in the secondary
frame area.
2 In the Historical Data Management frame, click the Rotation
Plans icon.
The grid displays the rotation plan for the plant, group, or asset. It
consists of a list of the schedules that make up the rotation plan.
3 Make changes to the rotation plans by editing within the grid or
opening the Properties dialog box as described in Editing the
Rotation Plan on page 9-43.
4 In the grid, right-click the rotation plan and choose Recreate
Shifts.
A message appears asking whether you want to overwrite the
historical data for the time period covered by the rotation plan.
5 Click OK.
A message appears saying that the job has been scheduled in the
database.
Removing a Schedule from the Rotation
Plan
Use the instructions below to remove a shift schedule from the rotation
plan for a plant, group, or asset in the plant hierarchy.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Shift Configuration task module using the
instructions in Accessing the Shift Configuration Module on page
9-3.
Created a rotation plan using the instructions in Adding a Shift
Schedule to Groups and Assets on page 9-40.
Read the following:
When You Edit or Delete the Rotation Plan for an Asset on page
9-50
Viewing Shift Rotation Plans in the Grid on page 9-50
Note: If you need to check the status of the job in the database, you can do this from
the database server. Open the SQL Server Management Studio. Expand the
tree in the left pane as follows: <server root> SQL Server Agent Jobs.
At this point you can access the Activity Monitor to observe the status of all
jobs.
Shift Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
9-47
Procedure
1 In the Plant Hierarchy frame, select the plant, group, or asset
with a schedule in its rotation plan you need to remove.
The Historical Data Management frame opens in the secondary
frame area.
2 In the Historical Data Management frame, click the Rotation
Plans icon.
The grid displays the rotation plan for the plant, group, or asset. It
consists of a list of the schedules that make up the rotation plan.
3 Right-click on a schedule in the grid and select Delete.
A confirmation dialog box opens.
4 Click OK.
5 If desired, recreate the historical shift data for this rotation plan by
right-clicking on the group and choosing Recreate Shifts.
Using Shift Schedules in Groups and
Assets
When you have created one or more shift schedules, you can begin to
assign shift schedules to the assets in your plant. You can assign the
same schedule to the whole plant, or to a group, or to an individual
asset. If you assign it to a plant or group, all the assets belonging to
the plant or group inherit the schedule.
When you add a schedule to a group or asset you create a shift
rotation plan. This is a sequence of shift schedules, with start and end
dates and times. It says, Run this schedule, starting on this date,
finishing on this date. Then run this other schedule. You can modify
the rotation plan by adding or removing schedules, or by changing
dates. The rotation plan may contain only one schedule, which would
repeat itself indefinitely.
A group or asset only has one active rotation plan in force at any time.
The rotation plan may actually belong to that group or asset, or it may
be inherited from a parent group.
When you assign a shift schedule to a group or asset, the Create
Rotation Plan dialog box appears.
Note: You need the appropriate security privileges to assign shift schedules to the
plant hierarchy. The Shift Global Definition Management role does not include
these privileges. The System Administrator role includes these privileges, or
you can assign them to a user who has access to the plant hierarchy object in
question. However, if you do this, the user has access to the whole
configuration of the plant hierarchy object, not just the shifts. See Security in
AppCenter on page 10-1 for more information.
Shift Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
9-48
Figure 9-28 The Rotation Plan dialog box
This dialog box:
Lists the shift schedules that have already been applied to the
group or asset, if any.
Shows the properties of the schedule that you are adding, and
allows you to define just how and when it will come into force.
Allows you to set other properties of the shift schedule.
The shift rotation plan is made up of all the shift schedules, in order,
that have been added to the plan. Each shift schedule is given a start
time and an end time, and the start and end times cannot overlap. If
the last schedule in the plan has no end time it lasts for ever (that is,
until another schedule is added).
Relationships Between Group and Asset
Schedules
When you assign a shift schedule to a group, all the assets below the
group assume the same shift rotation plan. If some of these assets
already have a rotation plan of their own, these will end at the start
time of the group schedule and the group schedule takes over.
Shift Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
9-49
When you add a rotation plan to a group or asset, you have the option
to make it editable on each of the descendants. The consequences of
this are as follows:
If you choose this option, the system automatically demotes the
group rotation plan to the child level, so that each childs schedule
is independent. Changes made on one child do not affect other
children of the group, and the group schedule per se ceases to
exist.
If you do not select this option, the schedule remains a group
property and all the children will adhere to it. The only exception is
that a child can have schedules that run before the start time of
the first schedule in the group rotation plan; but as soon as the
group rotation plan starts it takes over.
When you Delete a Shift Schedule From a
Rotation Plan
You can delete a shift schedule from a rotation plan. If you do so, you
have the following options:
If there is no gap between the end time of the previous schedule
and the start time of the deleted schedule, you can extend the
previous schedule forwards so that it includes the deleted
schedule.
If there is no gap between the end time of the deleted schedule
and the start time of the next schedule, you can extend the start
time of the next schedule backwards so that it includes the deleted
time.
If you extend the previous or next schedule as described above, the
historical data will be reassigned to the extended schedule.
When You Add an Aset to a Group
If a group does not have its own rotation plan, all the assets in the
group will have their own rotation plan which may vary from asset to
asset. When you add a new asset to this group, you have to create a
rotation plan for the new asset.
Warning! If you do not choose one of these optionsthat is, you leave a gap where
the deleted schedule used to bethe historical data for the deleted
schedule will be deleted from the database.
Shift Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
9-50
Quite often you will want to add an assetwhether by creating,
copying, moving, or importingto a group that already has a rotation
plan of its own. When you do so, the shift schedule used by the new
asset depends on the method you use to create the new asset.
If you create a new asset, the new asset automatically assumes
the schedule that was assigned to the parent group.
If you copy or import an asset from elsewhere, any schedule
attached to the copied or imported asset is deleted and it assumes
the schedule of the parent group.
If you move an asset from one group to another, and it already has
its own schedule that overlaps the group schedule, the asset
assumes the schedule of the group.
When You Edit or Delete the Rotation Plan
for an Asset
If an asset uses the rotation plan of its parent group, and you want to
edit the rotation plan for the asset, the following options apply:
If your changes do not cause an overlap between the assets
rotation plan and the groups rotation plan, any schedule of the
assets that starts before the first schedule of the group rotation
plan is retained, but when the group schedule begins it takes over.
If your changes do cause an overlap between the assets rotation
plan and the groups rotation plan, you have two options:
Retain the assets individual schedule. This means that not all
the assets in the group now share the groups schedule, so the
system automatically demotes the group schedule and assigns
it to the remaining child assets individually. The group schedule
per se ceases to exist.
Retain the group schedule.
Viewing Shift Rotation Plans in the Grid
When you select a group or asset in the plant hierarchy and choose
Rotation Plans in the Historical Data Management frame, the grid
displays the schedules that make up the rotation plans associated with
the group or asset. As well as any schedules belonging to the group or
asset, it also displays schedules assigned to parents and children of
the group or asset.
Note that the Owner Name column shows the owner of the schedule.
Black type indicates that the selected group or asset is the owner;
grey type indicates that the schedule belongs to a parent or child
Note: The same applies when you edit or delete the rotation plan for a higher level in
the plant hierarchy. Changes to a higher level item affect that items children.
Shift Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
9-51
object in the hierarchy. The other columns show the start and end
dates and times of the rotation plans. If a rotation plan has no end
time it will continue indefinitely.
Figure 9-29 List of Rotation Plans
Schedules that are inherited from a parent have a different icon
from schedules that belong to the selected group or asset .
Overlapping Shift Schedules
When you add a shift schedule to the shift rotation plan for an asset,
you must specify a start and end time for the schedule. In principle,
this new schedule takes effect immediately if the current time is
between the start and end times of the schedule.
But what if the new schedule overlaps an existing schedule? In this
case you have the option to overwrite the existing schedule with the
new one. If you do not choose this option, an error message appears
and you must define a new start time that does not overlap with the
existing schedule.
If you do choose this option, the new schedule will overwrite the
overlapping part of the existing schedule, and the start or end times of
the overlapped schedule will be changed. If the new schedule falls
within the duration of the existing schedule, the existing schedule is
split into two parts: one before, and one after, the new schedule.
Historical data that is affected by the new shift schedule is reassigned
to the new schedule.
Example
Asset 1 has the a shift schedule defined for it, consisting of schedules
A, B, and D. Schedule A runs from January 1st to May 20th; schedule
B runs from May 30th to July 20th; and schedule D runs from July
30th to August 31st. Todays date is June 30th.
J
a
n

1
M
a
y

2
0
M
a
y

3
0
J
u
l
y

2
0
J
u
l
y

3
0
A
u
g

3
1
A B D
J
u
n
e

3
0

(
t
o
d
a
y
)
Shift Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
9-52
You insert an extra schedule, schedule C, into the rotation plan. The
effect of your change varies depending on where schedule C starts and
ends, as shown below. In each case the historical data is assigned to
the new schedule.
1 Schedule C runs from January 1st to June 10th. In this case,
schedule A is completely replaced, schedule Bs start time moves to
June 10th, and data between January 1st and June 10th is
reassigned.
2 Schedule C runs from January 15th to June 10th. In this case,
schedule A ends on January 15th and schedule Bs start time is
moved to June 10th. Historical data between January 15th and
June 10th is reassigned.
3 Schedule C runs from January 15th to May 25th. In this case,
schedule A ends on January 15th, schedules B and D are
unaffected, and the data between January 15th and May 25th is
reassigned.
4 Schedule C runs from June 10th to August 5th. In this case,
schedule A is unaffected, schedule B ends on June 10th, and
schedule D starts on August 5th. Since todays date is June 30th,
only the data between June 10th and today is reassigned (future
data does not need to be reassigned).
J
a
n

1
J
u
l
y

2
0
J
u
l
y

3
0
A
u
g

3
1
J
u
n
e

1
0
C B D
J
u
n
e

3
0

(
t
o
d
a
y
)
Reassigned data
A
J
a
n

1
5
J
a
n

1
J
u
l
y

2
0
J
u
l
y

3
0
A
u
g

3
1
J
u
n
e

1
0
C B D
J
u
n
e

3
0

(
t
o
d
a
y
)
Reassigned data
Reassigned data
M
a
y

3
0
M
a
y

2
5
A
J
a
n

1
5
J
a
n

1
J
u
l
y

2
0
J
u
l
y

3
0
A
u
g

3
1
C B D
J
u
n
e

3
0

(
t
o
d
a
y
)
J
u
n
e

1
0
J
a
n

1
M
a
y

2
0
M
a
y

3
0
A
u
g

3
1
A B D
J
u
n
e

3
0

(
t
o
d
a
y
)
A
u
g

5
C
Reassigned data
Shift Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
9-53
5 Schedule C runs from January 15th to April 1st. In this case,
schedule A is split into two parts, and only the data for schedule C
is reassigned.
Similarly, if you modify the start or end time of a schedule, the
historical data will be reassigned.
Introduction to Shift Editing
Sometimes you might want to change the shift arrangement for a day
in the past. For example, yesterday was a very hot day and a heat
break period was granted. Now you want to add the heat break to the
shift data for yesterday so that you can include it in (or exclude it
from) efficiency calculations. When you edit historical shift data for a
daily shift arrangement, the historical data for that day is reassigned
to the new shift definitions. Options include inserting or removing
shifts or shift periods, changing start and end times, etc.
This chapter covers the following topics:
Accessing the Production Shift Editor within MI Admin on page
9-55
Getting Started on page 9-57
Daily Schedule Changes on page 9-67
Reapplying Shifts on page 9-76
Assigning Temporary Shift Plans on page 9-80
Editing a Shift on page 9-84
Creating and Modifying Shifts on page 9-88
Creating and Modifying Shift Periods on page 9-94
Reports on page 9-97
M
a
y

2
0
M
a
y

3
0
A A
J
a
n

1
5
J
a
n

1
J
u
l
y

2
0
J
u
l
y

3
0
A
u
g

3
1
C B D
J
u
n
e

3
0

(
t
o
d
a
y
)
A
p
r
i
l

1
Reassigned data
Shift Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
9-54
Accessing the Production Shift Editor
This section describes how to access Shift Editing functions, either
through MI Admin or through the Production Shift Editor. If you require
access to the Shift Editor but do not have it, contact your
Administrator.
This section covers the following topics:
Security Governing Access to the Production Shift Editor on page
9-54
Accessing the Production Shift Editor within MI Admin on page
9-55
Logging on to the Production Shift Editor on page 9-55
Security Governing Access to the
Production Shift Editor
Users who need to access to the Production Shift Editor, can do so in
three ways:
Access is available through the Shift Configuration module in
MI Admin, where users can select the Shift Editing button in the
Historical Data Management frame.
Access is available through Root Cause Assignment application,
where users can access the editor from the taskbar.
Access can also be made available through a shortcut link, which
directly accesses the Production Shift Editor.
Each of these access options is subject to a security mechanism,
where only those users with the properly assigned roles can have
access. In the Shift Configuration module and Root Cause Assignment,
access is controlled by the users name and password. If users try to
access the editor through the shortcut link, they must also provide a
user name and password.
Access levels also vary with the user role, so some users are able to
make configuration changes, whereas others may only view data. The
following table details the standard roles that come with
ActivEssentials that have permissions related to the Production Shift
Editor.
Table 9-1 Roles and the permissions granted
Role Names Launch
Application
Edit Shift Data Modify Shift
Configuration
View Reports
System
Administrators
Yes Yes Yes Yes
Shift
Administrators
Yes Yes Yes
Shift Editors Yes Yes
Shift Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
9-55
Accessing the Production Shift Editor
within MI Admin
Use the instructions below to access the shift editing functions from
within the Shift Configuration task module of MI Admin.
Prerequisites
Before you start you need to have done or read the following:
Logged on to AppCenter using the instructions in Logging onto MI
Admin on page 1-4.
Procedure
1 In MI Admin, click Shift Configuration.
2 From the Historical Data Management frame, click Shift Editing.
The Production Shift Editor displays.
Logging on to the Production Shift Editor
Use the instructions below to log on to edit shift information. If you
have access to MI Admin, but not the Production Shift Editor, then you
are able to edit shifts through MI Admin.
Prerequisites
Before you start you need to have done or read the following:
Obtained from your administrator the URL, username, and
password required to log onto the Production Shift Editor.
Report
Administrators
Yes
VPWeb Power
Users
Yes
Report Users Yes
Table 9-1 Roles and the permissions granted
Role Names Launch
Application
Edit Shift Data Modify Shift
Configuration
View Reports
Note: You have to be a member of the System Administrator, Shift Global Definition
Administrator, or Shift Editor roles to access the Shift Editor, but Shift Editors
cannot modify shift configuration. Members of the Report Administrator,
VPWeb Power User, and Report User roles must also be members of at least
the Shift Editor role to access the shift reports.
Note: You have to be a member of the System Administrator, Shift Global Definition
Administrator, or Shift Editor roles to access the Shift Editor, but Shift Editors
cannot modify shift configuration. Members of the Report Administrator,
VPWeb Power User, and Report User roles can access the shift reports.
Shift Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
9-56
Procedure
1 Enter the address for the Production Shift Editor.
The Production Shift Editor log on page opens.
Figure 9-30 The Production Shift Editor Log On dialog box
2 Enter your user name and password in the appropriate fields and
click Log On.
The Production Shift Editor module displays.
Figure 9-31 The Production Shift Editor
Shift Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
9-57
Getting Started
Dynamic and changing production demands mean production changes
that affect line output and scheduling. You might find that you need to
edit or modify shift schedules on a regular, but random basis. The Shift
Editing task module in the Shift Configuration module provides an
efficient interface for making shift changes. You can make shift
changes for one day, a week, or apply it to several weeks at a time.
This section covers the following topics:
Shift Editing Groups on page 9-57
Creating a Shift Editing Group on page 9-58
Editing a Shift Group on page 9-59
Deleting a Shift Group on page 9-60
Selecting a Shift Editing Group and Date on page 9-61
Overview of Shifts on page 9-62
Using the Production Shift Editor on page 9-62
Shift Editing Options on page 9-64
Working in the Grid on page 9-65
Switching Between Shift Configuration and the Production Shift
Editor on page 9-65
Shift Editing Groups
Shift editing groups are a means of assembling lists of assets where
you are likely to make common shift structure and timing
modifications. Planned shifts and shift periods can change as
production demands and other eventualities force changes on
production lines, so the shift editing features of ActivEssentials enable
to you to keep your production data aligned with your production shift
records.
When assembling shift editing groups, you select assets by selecting
the shift owner, which can be individual assets or a parent group. If
the shift owner is a group, the editor does not allow you to view the
assets within the group. However, if you have access to the Shift
Configuration module, you can see the assets there.
When assembling a shift editing group, you need to gather together all
the shift owners that typically function together when aligned with
production shifts. This means that if the structure of your shifts or shift
periods change, you can maintain the alignment of the historical
production data for all of the shift owners involved with the
restructured shifts.
Note: You can only add an asset to one shift editing group. If you try to do this, the
database returns an error.
Shift Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
9-58
When editing, you can add or drop assets from a shift restructuring
without permanently changing the membership in the shift editing
groups. This flexibility allows users to easily make shift changes
without needing to make many detailed, narrowly-focused changes at
the asset level.
User Access to Shift Owners
In the general way, users are only able to interact with the shift
owners to which they have been granted access. However, when
creating shift editing groups, all users are able to view all shift owners,
except those that are already a part of other shift editing groups.
Although users can view all available shift owners, the ActivEssentials
security prevents users from successfully adding shift owners, to which
they have no rights, to a shift editing group.
Creating a Shift Editing Group
Use the instructions below to create or modify a shift editing group.
Although the Shift Editing Groups appear in the left pane of the
Production Shifts Editor, you can only perform this task when the Daily
Schedules, Shifts, and Reports tabs are open. The Shift Editing Groups
interface is disabled when you are viewing the Shift Definitions tab, as
the configuration there is global.
Prerequisites
Before you start you need to do the following:
Access the Production Shift Editor using the instructions in
Accessing the Production Shift Editor within MI Admin on page
9-55.
Read Shift Editing Groups on page 9-57 for an understanding of
the purpose of Shift Editing groups.
Procedure
1 Click the ellipsis button to the right of the Shift Editing Groups
drop-down list.
The Configure Shift Editing Groups dialog box opens, where you
can add a new group to the list.
Shift Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
9-59
Figure 9-32 Shift Editing Group Editor
2 Click in the Group name field and type a name for the new group.
3 Select the checkboxes in the Rotation Plan Owners box to
choose the assets you want to include in the shift editing group.
4 Click Save Change.
5 Click OK.
Editing a Shift Group
Use the instructions below to edit a a shift group.
Prerequisites
Before you start you need to do the following:
Access the Production Shift Editor using the instructions in
Accessing the Production Shift Editor within MI Admin on page
9-55.
Read Shift Editing Groups on page 9-57 for an understanding of
the purpose of Shift Editing groups.
Procedure
1 Click the ellipsis button to the right of the Shift Editing Groups
field.
The Configure Shift Editing Groups dialog box opens showing
information for the current shift editing group.
2 If necessary, click the down-arrow to the right of the Group name
field and select the group you need to edit.
The asset tree in the Rotation Plan Owners pane refreshes to show
the scope of the current group.
Shift Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
9-60
Figure 9-33 The Configure Shift Editing Groups dialog box
3 Select or clear the checkboxes to create the shift editing group that
now fits your needs.
4 Click the Save Change button.
Deleting a Shift Group
Use the instructions below to delete a a shift group.
Prerequisites
Before you start you need to do the following:
Access the Production Shift Editor using the instructions in
Accessing the Production Shift Editor within MI Admin on page
9-55.
Read Shift Editing Groups on page 9-57 for an understanding of
the purpose of Shift Editing groups.
Procedure
1 Click the ellipsis button to the right of the Shift Editing Groups
field.
The Configure Shift Editing Groups dialog box opens showing
information for the current shift editing group.
Note: You can also edit the name of the group by clicking in the Group name field and
editing the text as needed.
Shift Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
9-61
2 If necessary, click the down-arrow to the right of the Group name
field and select the group you need to delete.
The tree in the Rotation Plan Owners pane refreshes to show the
scope of the current group.
Figure 9-34 The Configure Shift Editing Groups dialog box
3 Click the Delete button to the right of the Shift Editing Group
name.
The Production Shift Editor asks for confirmation.
4 Click OK.
Selecting a Shift Editing Group and Date
Use the instructions below to select a shift editing group and date.
Before you can edit a shift that occurred in the past, you select the
shift and the date in the left pane of the Production Shift Editor.
Prerequisites
Before doing this you need to do and read the following:
Access the Production Shift Editor using the instructions in
Accessing the Production Shift Editor within MI Admin on page
9-55.
If you need to create a new shift editing group, see Creating a Shift
Editing Group on page 9-58 for more information.
Procedure
1 Select a pre-defined grouping of assets and groups from the Shift
Editing Groups drop-down list.
2 Using the calendar, select the date for the shift(s) that you want to
edit.
Shift Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
9-62
A message pops up with get data information.
3 Click Get Data.
The screen clears to display the most recent information.
Overview of Shifts
Editing shifts may require changing several shift components, however
you may only be able to change certain items depending on the role
privileges you have. The following shift components can be edited in
the Production Shift Editor:
Shift periods. These are subdivisions of a shift. They may be any
length from one minutes to 24 hours. You can divide a shift into as
many periods as you want. These periods are classified as
productive (that is, when work is done), and non-productive
(breaks, lunch, etc.).
Shift structures. These are assemblies of shift periods that can
be used in shifts. For example, a structure called Day may
consist of the shift periods Hour 1, Hour 2, Hour 3, Lunch, Hour 4,
Hour 5, Hour 6, and Hour 7. When you create the shift structure
you assign a length to each period, so the structure itself has a
total duration.
Shifts. These are assembled from shift structures, but a shift can
use several different shift structures to suit various needs. A shift
named Day Shift, could use different shift structures on different
days of the week, to fit with differing scheduling needs. Each shift
has a name and a color that displays when you analyze data by
shift.
Daily Shift Schedules. A schedule consists of one or more
schedule types arranged in sequence. When being edited, it is the
schedule that existed for the day in question
Using the Production Shift Editor
The Production Shift Editor is similar to using other modules in
AppCenter, however there are a few differences as follows:
You can perform all shift editing tasks within the task sub-module.
Note: You can also perform the same shift editing tasks from within Root Cause
Assignment.
Shift Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
9-63
Shift editing is done on one screen, rather than in a wizard.
You can save your changes to a specific shift for a day, or choose a
schedule (one or more days) to which the shift applies.
The Preview pane is not editable; it updates when you make
changes in the grid.
Shift editing can occur for multiple assets and days at one time.
All shift editing is done within the Production Shift Editor screen. The
following figure shows the basic layout of the shift editor.
Legend
Scope selection. This is where you select the shift and date to
which your editing will apply. Note that you can also create or
modify shifts.
Editor tabs. Shift Editing and the reporting functions.
Tasks. You can perform tasks within each of the tabs.
Task screen. In these screens you can create, edit, or customize
shift information. Many of these tasks have a preview section that
displays the shift selections you make.
Recognizing Where Changes Have Occurred
In both the Edit Daily Schedules and Edit Shifts screens there appears
a table with a column that lists the Shift Structures used. The names
that appear in the column may indicate that the structure has
Changed. This reference appears when ever the structure has been
Shift Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
9-64
altered for the selected date. However, the Changed reference can
be ambiguous, as once you make a change, the reference remains
even if you restore the configuration to original configuration.
Shift Editing Options
The ActivEssentials shift editing functions allow you to change the
historical shift data for a single day or a range of dates. When editing
historical shift data, there are several options you can use:
Editing daily schedules, shifts and shift periods, including changing
the shift period, or the shift duration, the start and end time, or
deleting a shift.
Edit a shift or shift period. Using the Production Shift Editor, you
can also create a new shift period, but note that this is a global
change and does not apply to historical data.
Rules Applied in Shift Editing
When you edit shifts and shift periods you will find that the following
rules are applied:
Shifts and shift periods must start and end with whole minutes. For
example, a shift period cannot start at 01:15:15; it must be
01:15:00. The editors that you use enforce this rule by greying out
the seconds.
The end time must always be later than the start time. Again, this
is enforced in the editors.
A shift period must fall within the bounds (start time and end time)
of the shift to which it belongs. If you try to set a start or end time
that exceeds the shift structure, you get an error message.
When you edit the start time of a shift, the Production Shift Editor
moves the entire shift forwards or backwards, but the leaves the
duration as it was.
When you edit the duration of a shift period the system will
automatically adjust the start time of the next period to
compensate. If the period you edit is the last one in the shift, the
system will accept the change but will also change the duration of
the previous period so that the shift time is completely covered.
Note: If you are planning to edit shift data as well as shift periods, be sure to edit the
shift data first. If you edit the shift period data first, then edit the shift data, you
might lose the changes you made to the shift period data.
Shift Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
9-65
Working in the Grid
Most of the shift editing tasks require selecting specific shift elements,
such as shifts, shift periods, schedules, etc. On the screen of each
editing task, most items can be edited within the grid. Clicking in a
specific row in the grid may display drop-downs or spin-boxes where
you can make changes. See the following figure for a sample grid.
Figure 9-35 Editing in the grid
Displaying All or Just Non-Productive Time in
the Grid
In the Shift Periods grid, you can choose to view all shift periods or
just those that relate to non-productive time. If this option is available,
you will see a link above the Option column to All Shift Periods or
Non-Productive Only. Clicking on this link will toggle between the
two options and change the time periods displayed in the grid.
Switching Between Shift Configuration
and the Production Shift Editor
Assuming users are able to log on to the MI Admin interface, and are
then able to access the Production Shift Editor, there are several
shortcuts to other task sub-modules within the Shift Configuration task
module.
In addition to the standard buttons on the AppCenter toolbar, the
following buttons are available regardless of where you are in the
Production Shift Editor.
Note: If you open the Production Shift Editor by either using the direct Log On
method or through Root Cause Assignment, you do not have access to the
other task sub-modules in the Shift Configuration module. You must log on to
MI Admin first to have full access.
Shift Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
9-66
To access the Production Shift Editor from the Shift Configuration
module, select any item in the Plant Hierarchy frame except the
ActivApplications and Object Library items, and then click the
Shift Editing icon in the Historical Data Management frame.
Table 9-2 Buttons that access task sub-modules in Shift Configuration
Name and button What it does
Global Shift
Definitions
Opens the Shift Schedules task sub-module in Shift
Configuration, where you can create, modify, and delete
schedules.
Rotation Plans Opens the Rotation Plans task sub-module in Shift
Configuration, where you can assign a set of repeating
schedules to groups and assets
Audit Logs Opens the Audit Logs task sub-module in Shift Configuration,
where you review information about any changes in shift
configuration.
Temporary Shift
Plans
Opens the Temporary Shift Plans task sub-module in Shift
Configuration, where you can assign a temporary shift
assignment to a group or asset.
Shift Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
9-67
Daily Schedule Changes
If you need to change part of a schedule (that is, a shift, or a shift
structure) because a shift, or several shifts did not follow the regular
schedule, you can do this within the Daily Schedules tab.
This section covers the following topics:
Changing the Shift Time on page 9-67
Inserting a Shift Period on page 9-69
Editing a Daily Schedule on page 9-71
Shift Editing in the Grid on page 9-74
Changing the Shift Time
Use the instructions below to change the shift start time, end time, or
duration. You can only extend the start or end time if there is some
unscheduled time that is, a gap between the previous shift and the
one that you want to change.
Prerequisites
Before doing this you need to do or read the following:
If necessary, open the Production Shift Editor using the instructions
in Accessing the Production Shift Editor within MI Admin on page
9-55.
Select the group and date that contains the schedule that needs to
be changed. See Selecting a Shift Editing Group and Date on page
9-61.
Procedure
1 If necessary, select the Daily Schedules tab.
2 Click Edit Daily Schedules.
The Edit Daily Schedule screen displays with the list of schedules
associated with your selection in the Shift Editing Group drop-down
list.
3 In the grid, click in the row for the schedule that you want to edit.
The shifts for that schedule display in the second grid.
4 In the Select a shift to edit grid, do one or more of the following:
a) In the Start Time column, modify the start time.
b) In the End Time column, modify the end time.
c) In the Duration column, change the duration.
Note: If necessary, you can make more than one change to the shift(s) before saving.
Shift Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
9-68
5 Select one of the following buttons to save your changes:
a) Click the Save button to save your changes to the date you
selected, or
b) Click the Save to button to save your changes to more than
one date. When the Select Dates dialog box opens, do the
following:
In the from and to fields, select the range of dates you
need. The dialog box refreshes to show a listing of all the
days that fall in the range, with the checkboxes for all these
dates pre-selected.
If you do not need to apply the changes to every date in the
listing, clear the checkboxes next to those dates.
Figure 9-36 The Select Dates dialog box
Note: If you change any of the shift timing options such that the shift would overlap
with the preceding or succeeding shifts, the Save and Save to buttons
remain disabled. If you select another shift, the database returns an error
message.
Note: After making changes, you can test the validity of your changes by clicking
within another row in the grid. This action causes a validation check. If the
validation fails, the database returns an error message. If the validation is
successful, the grid refreshes, but you must still save the changes.
Note: In the next step, you save your changes. However, if you have many changes
and need to review the changes you are about to save, click Details on the
Confirmation dialog box to see a summary.
Shift Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
9-69
Figure 9-37 The Confirmation dialog box when viewing the details
6 Click Yes to save your changes.
Inserting a Shift Period
Use the instructions below to insert a shift where there is a schedule
gap, or a time that does not have a shift assigned to it.
Prerequisites
Before doing this you need to do or read the following:
If necessary, open the Production Shift Editor using the instructions
in Accessing the Production Shift Editor within MI Admin on page
9-55.
Select the group and date that contains the schedule that needs to
be changed. See Selecting a Shift Editing Group and Date on page
9-61.
Procedure
1 If necessary, select the Daily Schedules tab.
2 Click Edit Daily Schedules.
The Edit Daily Schedule screen displays with the list of schedules
associated with your selection in the Shift Editing Group drop-down
list.
3 In the grid, select the schedule with the shift to which you need to
add a shift.
The Select a shift to edit portion of the grid refreshes to display
the shifts in the schedule, and the Preview pane opens to show
which shifts occur during the course of the day.
Shift Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
9-70
Legend
Identified gap
Insert Shift button
4 Click the Insert Shift button.
The Insert Shift dialog box opens and lists any identifiable gaps in
the schedule.
Figure 9-38 The Insert Shift dialog box
5 On the row that shows the gap you need to fill, click in the Shift
cell. A down-arrow appears.
Note: If there is a gap between the scheduling of two shifts, you can add another shift
in the gap.
Shift Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
9-71
Figure 9-39 Selecting a shift
6 Select the shift you need to use.
If you select a shift whose normal duration is greater than the gap,
you have to Click Yes truncate the shift.
7 Click in the Shift Structure cell.
A down-arrow appears.
8 Click the down-arrow and select the shift structure you need to
use.
If you select a shift structure whose duration is greater than the
gap, you have the opportunity to truncate the structure.
9 Click Save.
The Select a shift to edit grid and the Preview pane refresh to
show the new shift.
10 If the inserted shift did not completely fill the gap, change the End
time in the Select a shift to edit grid.
Editing a Daily Schedule
Use the instructions below to edit a shift schedule.
Note: When you click OK, the database conducts a validation check. If the change is
valid, the editor closes and the grid refreshes, but if the validation fails, the
database returns an error, and the editor remains open.
Shift Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
9-72
Prerequisites
Before doing this, you need to read or do the following:
If necessary, open the Production Shift Editor using the instructions
in Accessing the Production Shift Editor within MI Admin on page
9-55.
Select the group and date that contains the schedule that you need
to change. See Getting Started on page 9-57.
Read Changing the Shift Time on page 9-67 for more information
about how to change shift times.
Read Inserting a Shift Period on page 9-69 for more information
about creating new shift periods.
Procedure
1 If necessary, select the Daily Schedules tab.
2 Click the Edit Daily Schedules link.
The Edit Daily Schedule screen displays with the list of schedules
associated with your selection in the Shift Editing Group drop-down
list.
3 Click the row for the schedule that you want to edit.
The shifts for that schedule display in the second grid.
4 In the Select a shift to edit grid, do any of the following:
To remove a shift, select the checkbox to left of the Shift Name.
The row is then disabled.
To modify a shift period within a shift, select the row and then
click the ellipsis button to left of the Shift Name to open the
Remove or Insert Shift Periods dialog box.
Shift Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
9-73
Figure 9-40 The Remove or Insert Shift Periods dialog box
Then do one of the following:
Remove a shift by selecting the checkbox beside the shift
period you want to remove.
Click the Insert Shift Period link to insert a new shift
period.
To change the shift name, select the cell in Shift Name
column, then click the drop-down arrow and select a different
shift. Note that this does not change the shift periods in the
shift.
To change the shift structure, select the shift row and then click
down-arrow in the Shift Structure column and select a
different shift structure.
This changes all of the shift periods to those defined in the shift
structure.
To change the shift timings, edit the Start or End times, or
modify the Duration.
5 When you have finished, select one of the following buttons to save
your changes:
a) Click Save to save your changes to the date you selected, or
Shift Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
9-74
b) Click the Save to button to save your changes to more than
one date. When the Select Dates dialog box opens, do the
following:
In the from and to fields, select the range of dates you
need. The dialog box refreshes to show a listing of all the
days that fall in the range, with the checkboxes for all these
dates pre-selected.
If you do not need to apply the changes to every date in the
listing, clear the checkboxes next to those dates.
Figure 9-41 The Select Dates dialog box
6 Click OK to save your changes.
Shift Editing in the Grid
After you have selected a schedule with the correct owner that
contains the shifts that you want to edit, the Shift grid beneath it
refreshes to display the shifts within that schedule.
In some grids, you will see the option to view all shift periods or
non-productive time only. Grids with this option have a link on the
right side that can be toggled to filter the view.
You can make the following changes to shifts in the grid (see the figure
below). The changes are listed here in the order they appear in the
grid.
Shift Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
9-75
Legend
Delete a shift
Insert or remove one or more shift period
Select a different shift name
Select a different shift structure
Change the start time, end time, or shift duration
The grid is dynamic; changes in one column can affect other columns.
For more information on shift editing within this grid, see the following
tasks: Changing the Shift Time on page 9-67, and Inserting a Shift
Period on page 9-69.
Shift Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
9-76
Reapplying Shifts
The Reapply Shifts page is where you can remove any adjustments to
a rotation plan. When you edit the shifts and shift periods, you also
edit all of the historical data that applies to the time periods, so data
that related to particular phases of production is reassigned to
different shifts or shift periods. If you need to revert to the originally
scheduled shifts and shift periods, you can do so by reapplying the
shifts.
Figure 9-42 The Re-apply Shifts screen
This section covers the following topics:
Reapplying Shifts to a Schedule on page 9-76
Reapplying Shifts to a Schedule
Use the instructions below to reinstate original shifts (that is, shifts
without modifications or changes). Note that if you select this option,
you lose any changes that you made to shifts on the date that you
selected.
Prerequisites
Before doing this you need to do or read the following:
If necessary, open the Production Shift Editor using the instructions
in Accessing the Production Shift Editor within MI Admin on page
9-55.
Select the group and date that contains the schedule that needs to
be changed. See Selecting a Shift Editing Group and Date on page
9-61.
Note: To conduct actions on the Reapply Shifts page, users must have at least Shift
Global Definition Administrator rights. If users do have sufficient privileges, the
Reapply Shifts page is not available.
Shift Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
9-77
Procedure
1 If the Daily Schedules tab is not active, click the Daily
Schedules tab.
2 Click the Reapply Shifts link.
The Reapply Shifts screen opens and displays a list of available
rotation plans.
3 In the Reapply Shifts screen, select the checkboxes for the
rotation plans that you need to restore.
The View Details button at the bottom right corner becomes
enabled.
4 If you need to see what the reapplied rotation plan will look like,
click the View Details button.
The database then returns a report that details the configuration of
the shift definition.
Note: To view the report, users must be members of at least the Report Usersrole.
Shift Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
9-78
5 Select one of the following buttons to save your changes:
a) Click the Apply button to save your changes to the date you
selected, or
b) Click the Apply to button to save your changes to more than
one date. When the Select Dates dialog box opens, do the
following:
In the from and to fields, select the range of dates you
need. The dialog box refreshes to show a listing of all the
days that fall in the range, with the checkboxes for all these
dates pre-selected.
If you do not need to apply the changes to every date in the
listing, clear the checkboxes next to those dates.
Figure 9-43 The Select Dates dialog box
6 Click OK.
A confirmation dialog box opens that states that the reapply action
will remove any shift scheduling changes you have made. The
dialog box also gives you an opportunity to review what rotation
plans are being restored.
Note: An example of a Shift Schedule report
Shift Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
9-79
Figure 9-44 The Confirmation dialog box
7 Click Yes.
The database returns a message that states that the update will
occur in five minutes.
Shift Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
9-80
Assigning Temporary Shift Plans
A temporary shift plan is a short-term adjustment to upcoming shifts.
If you recognize that your planned shift scheduling is going to have to
change, but only for a short period of time, you can make changes to
the future scheduling. When you do this, you are changing the shifts
for just the shift editing groups you select, or to specific assets within
a shift editing group. Once you create a temporary shift plan, and it
comes into effect, you can still edit the historical data related to the
shifts in the same way you would with normally scheduled shifts.
Figure 9-45 The Temporary Shift Plans screen in Daily Schedules
This section covers the following topics:
Temporary Shift Plans on page 9-80
Creating a Temporary Shift Plan on page 9-81
Stopping a Temporary Shift Plan on page 9-82
Deleting a Temporary Shift Plan on page 9-83
Temporary Shift Plans
Most of the tasks you can perform in the Production Shift Editor relate
to adjusting historical shift information. However, if you know that
your upcoming scheduling must change, but for a limited amount of
time, you can create a Temporary Shift Plan that will account for
abnormal scheduling needs. For example, if evening production will
not run next month on Fridays, you may want to create a temporary
shift plan for that month.
Temporary shift plans have the following characteristics:
They apply to individual groups or assets in the plant hierarchy.
You cannot create global temporary plans.
The temporary plan acts as an overlay to the existing shift rotation
plan. When the temporary plan is finished, the group or asset
resumes its original rotation plan.
You can only define a temporary shift plan for upcoming
production; temporary shift plans do not affect historical shift data.
A temporary shift plan does not have to contain any shifts, which
then allows you to account for times when normal production was
cancelled.
Shift Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
9-81
Creating a Temporary Shift Plan
Use the instructions below to create a temporary shift plan for a future
date.
Prerequisites
Before doing this you need to do or read the following:
If necessary, open the Production Shift Editor using the instructions
in Accessing the Production Shift Editor within MI Admin on page
9-55.
Select the shift editing group whose future scheduling you need to
change.
For a better understanding of the purpose of temporary shift plans,
read Temporary Shift Plans on page 9-106.
Procedure
1 If necessary, select the Daily Schedules tab.
2 Click the Temporary Shift Plans link.
The screen refreshes to show the Temporary Shift Plans page.
3 Click in the Temporary Shift Plans grid to activate the grid.
4 Do the following in the grid:
a) Select the date range for the temporary shift plan in the From
and To fields.
You can select a date range by either clicking the up- and
down-arrows, or by clicking in the year, month, or date field
and entering a new date. The earliest date is the following day.
b) Select a start time for the shift plan to take affect.
You can enter a time frame using the up- and down-arrows, or
by entering the hour and minutes that you want the shift plan
to start.
c) Select the Productive checkbox if the shift plan will be
productive time.
d) Select a shift from the Shift drop-down list.
e) Select a shift structure from the Shift Structure drop-down
list.
Note: As the screen refreshes, the calendar portion of the interface becomes
disabled. This is because the calendar is designed for setting a date in the
past; you can set the required future dates in the grid.
Note: If you leave the Productive checkbox unselected, the cells in the Shift and
Shift Structure columns are disabled. You cannot assign a shift or shift
structure to a non-productive period. Any previously planned shifts in the date
range are removed.
Shift Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
9-82
f) Click the ellipsis button inside the Change Reason cell to add
a reason for the temporary shift plan, and click OK when done.
You do not need to complete the Change Reason field, but this
provides extra information about the reason for the temporary
shift plan.
g) Click the down-arrow in the Owner column and select the shift
plan owner.
5 Click Save when you have finished the temporary shift plan.
A confirmation box displays. You can view the details of your
changes through the Details drop-down box.
Figure 9-46 The confirmation dialog box with details showing
6 Click Yes.
Stopping a Temporary Shift Plan
If you need to cancel a temporary shift plan after it has commenced,
but before it has finished, you need to stop it first. To do this, you have
to stop the plan in the Temporary Shift Plans task sub-module in
Shift Configuration.
To access the temporary shift plans configuration, click the
Temporary Shift Plans button on the Production Shift Editor toolbar,
or click the Shift Configuration icon in the AppCenter taskbar and
navigate to the Temporary Shift Plans module from there. In the list
of temporary shift plans, find the shift plan you need to stop, and then
clear the checkbox in the Active column.
Note: You can only add one temporary shift plan at a time. If you need to add more,
save the plan and start another. Each temporary shift plan appears in the
Temporary Shift Plans grid.
Note: To stop a temporary shift plan in the Shift Configuration module, users need
administrative privileges at the affected level in the Plant Hierarchy.
Shift Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
9-83
Deleting a Temporary Shift Plan
Use the instructions below to delete a temporary shift plan from a
group or asset. You cannot delete a temporary shift plan that is
already in force on the group or asset; you must first stop it. After you
delete a temporary shift plan, the database restores the original
rotation plan for the affected time/date range.
Prerequisites
Before doing this you need to do or read the following:
If necessary, open the Production Shift Editor using the instructions
in Accessing the Production Shift Editor within MI Admin on page
9-55.
Select the shift editing group whose temporary shift plan you need
to delete.
If the temporary shift plan is running now, see Stopping a
Temporary Shift Plan on page 9-82 for information about how to
stop it before proceeding with this task.
Procedure
1 If necessary, select the Daily Schedules tab.
2 Click the Temporary Shift Plans link.
The screen refreshes to show the Temporary Shift Plans page.
3 In the Temporary Shift Plans grid, on the row for the temporary
shift plan, select the checkbox and then click the Save button.
A confirmation dialog box opens.
Figure 9-47 The confirmation dialog box
4 Click Yes.
Note: As the screen refreshes, the calendar portion of the interface becomes
disabled. This is because the calendar is designed for setting a date in the
past; you can set the required future dates in the grid.
Shift Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
9-84
Editing a Shift
In the Edit Shifts tab you can edit shift periods by productive or
non-productive time. When you select a shift, you will see the shift
period arrangement and the rotation owners of that shift.
This section covers the following topics:
Inserting a Shift Period on page 9-69
Editing Shift Periods on page 9-86
Deleting a Shift Period on page 9-87
Figure 9-48 The Edit Shifts screen
Inserting a Shift Period
Use the instructions below to insert either a productive or
non-productive shift period into an existing shift.
Shift Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
9-85
Prerequisites
Before you start you need to do or read the following:
If necessary, open the Production Shift Editor using the instructions
in Accessing the Production Shift Editor within MI Admin on page
9-55.
Selected the group and date that contains the shift that you want
to edit. See Selecting a Shift Editing Group and Date on page 9-61
for more information.
Selected a shift using the instructions in Editing Shift Periods on
page 9-8.
Procedure
1 If necessary, select the Shifts tab.
2 Click the Edit Shifts link.
The Edit Daily Schedule screen displays with the list of schedules
associated with your selection in the Shift Editing Group drop-down
list.
3 In the grid, select the shift to which you need to add a shift period.
The second grid then displays the shift periods.
4 Click the Insert Shift Period link.
The Insert Shift Period editor opens.
Figure 9-49 Insert Shift Period Editor
5 Click in the grid and select the shift period that you want to add
from the drop-down list.
The grid updates with the start time and end time for the entire
shift.
6 Modify the Start Time and End Time if applicable.
7 Click in the cell in the Duration column.
The cell then displays the duration of the shift period and the
Options group-box becomes active.
Shift Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
9-86
8 Click OK.
The Insert Shift Period Editor closes.
Editing Shift Periods
Use the instructions below to edit a shift period, including deleting the
shift, changing the start or end time, or inserting another shift period.
Prerequisites
Before you start you need to do or read the following:
If necessary, open the Production Shift Editor using the instructions
in Accessing the Production Shift Editor within MI Admin on page
9-55.
Select the group and date that contains the shift that you want to
edit. See Selecting a Shift Editing Group and Date on page 9-61 for
more information.
For more information about adding shift periods, read Inserting a
Shift Period on page 9-69.
Procedure
1 If necessary, select the Shifts tab.
2 Click the Edit Shifts link.
3 In the grid, click on the shift that contains the shift period you want
to edit.
The shift periods for that shift appear in the second grid.
4 Do one of the following:
a) Select the checkbox to delete the shift period.
The row in the grid is greyed out.
b) Select the Shift Period drop-down box to change the shift
period.
c) Select the Start Time, End Time, or Duration and use the
up- or down-arrows to adjust the time.
Adjusting one of the times will adjust the time in the other two
columns.
5 Click the Insert Shift Period link to insert a shift period.
Note: You can choose to view all shift periods or just non-productive periods by
toggling the All Shift Periods/Non-Productive Only link at the top of the grid.
Note: You cannot adjust the start time for the first shift period or the end time of the
last shift period, as these would affect the overall duration of a shift. If
necessary, change the start and end times of the shift.
Shift Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
9-87
6 If you want to save the changes as a new structure, click the Save
Structure link, and then give the new structure a name.
7 Do one of the following to save your changes:
a) Click Save to save your changes to the date you selected, or
b) Click Save to to save your changes to more than one date.
When the Select Dates dialog box opens, do the following:
Use the up- or down-arrows beside the dates to select a
date range and select a date from the calendar that
appears, or
Select the date year, month, or day that you want to change
and enter the new date, and finally
Click OK to save your changes.
Deleting a Shift Period
Use the instructions below to delete a shift period.
1 If necessary, select the Shifts tab.
2 Click the Edit Shifts link.
3 In the grid, click on the shift that contains the shift period you need
to delete.
The shift periods for that shift appear in the second grid.
4 On the row in the grid for the shift period, select the checkbox
The row in the grid becomes disabled.
5 Click Save.
Figure 9-50 The confirmation dialog box
Note: If you added, modified, or deleted any of the shift periods, you can save the
changed shift period structure for future use with the selected shift editing
group. This allows you to save the structure for reuse if required.
Note: You can choose to view all shift periods or just non-productive periods by
toggling the All Shift Periods/Non-Productive Only link at the top of the grid.
Shift Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
9-88
If you try to select another row in the grid without clicking the Save
button, the same message appears asking you to confirm the deletion.
Creating and Modifying Shifts
On the Shift Definitions tab you can create or modify a shifts or shift
periods. You should note that the options to select a shift editing group
are disabled on the tab, as you are creating global definitions that are
available throughput the plant hierarchy. It is also possible to do this
through the main Shift Configuration module, from the Object Library.
Figure 9-51 The Create/Modify Shift Period screen
This section covers the following topics:
Overview of Shift Creation Using the Production Shift Editor on
page 9-89
Creating a Shift on page 9-89
Modifying a Shift on page 9-90
Deleting a Shift on page 9-92
Shift Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
9-89
Overview of Shift Creation Using the
Production Shift Editor
When you build a shift using the Production Shift Editor, you do it in
the following order:
Assign a name, color, and description to the shift.
Assign a structure name to the shift. At this point you only assign a
name to the structure; the duration will be added when you create
shift periods and assign durations.
Add shift periods to fill the structure, and assign a duration to the
period. These are periods that already exist in the system. You can
add as many periods as you want.
If necessary, add other structures with differing shift periods to
account for periodic changes in how a shift should be run. The
overall duration of these separate structures can vary, and you can
add as many structures as you want.
Creating a Shift
Use the instructions below to create a shift. Once created, this shift
will be available for use in any shift configuration.
Prerequisites
Before you do this you need to have read or done the following:
If necessary, open the Production Shift Editor using the instructions
in Accessing the Production Shift Editor within MI Admin on page
9-55.
Select a shift editing group and date using the instructions in
Selecting a Shift Editing Group and Date on page 9-61.
Procedure
1 If necessary, select the Shift Definitions tab,
2 Click the Create/Modify Shift link.
3 In the Name field, enter a name for the shift.
4 Select a color for the shift by clicking the ellipsis button and
selecting a color from the Color box.
5 In the Description field, type a description of the purpose the
shift. This is optional.
6 In the Set/Modify shift structures grid, double-click in the
Structure Name column and type a name for the Shift Structure,
and then click anywhere outside the cell to save the name.
A pointing hand symbol appears indicating that you should move to
the Shift Periods section of the grid.
Shift Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
9-90
Figure 9-52 Pointing hand symbol
7 In the Details grid, click in the Shift Period column and select a
period from the drop-down list.
8 To edit the shift period duration, click in the cell in the Duration
column and edit as needed.
9 Continue to add shift periods until the shift structure is complete.
10 If necessary, add more shift structures to the shift.
11 Once the shift is built, click Save.
Modifying a Shift
Use the instructions below to modify an existing shift. In the
Production Shift Editor, users are able to modify any aspect of a shift.
Note: If you recognize, after saving the name, that the name is wrong, you cannot
edit the name in the field. Instead, highlight the row and click the Remove
button that is below. You can then start again.
Note: The Duration column displays the duration for that shift period, which by default
is 60 minutes. This also adds to the overall duration of the shift structure.
Note: If you add a period and recognize that it is inappropriate, select the row and
then click the Remove button that is below.
Note: As you build the structure, a graphical representation of the shift structure
appears in the Preview pane, and the total duration of the shift appears in the
grid next the shift structure name.
Note: Only one shift structure is used at a time, so you can build structures for
different production needs.
Shift Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
9-91
Prerequisites
Before you do this you should do or read the following:
If necessary, open the Production Shift Editor using the instructions
in Accessing the Production Shift Editor within MI Admin on page
9-55.
Select a shift editing group and date using the instructions in
Selecting a Shift Editing Group and Date on page 9-61.
Procedure
1 If necessary, select the Shift Definitions tab,
2 Click the Create/Modify Shift link.
3 Select the shift that you want to edit from the Name drop-down
field.
The color and description (if any) appear in the appropriate fields.
4 Do the following as applicable:
a) Click in the Name field and edit the name of the shift.
b) Click the Delete button.
You can only delete the shift if it is not currently in use.
c) Click in the Structure Name column to edit the structure
name.
d) Click in the Shift Period column to change the shift period.
The Duration in the shift structure updates.
5 To remove a structure or a shift period, click the Remove button
beneath the applicable grid.
The structure or shift period leaves the grid. If you remove a shift
period, the Duration updates appropriately.
6 When you are finished, click Save.
Figure 9-53 Confirmation dialog box.
7 Choose one of the following options:
a) To re-assign shift data to the new shift definition, select
Re-assign historical data.
Shift Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
9-92
b) To leave historical data assigned to the previous shift definition,
select Do not change historical data.
8 Click OK.
Deleting a Shift
Use the instructions below to delete an existing shift.
Prerequisites
Before you do this you should do or read the following:
If necessary, open the Production Shift Editor using the instructions
in Accessing the Production Shift Editor within MI Admin on page
9-55.
Select a shift editing group and date using the instructions in
Selecting a Shift Editing Group and Date on page 9-61.
Procedure
1 If necessary, select the Shift Definitions tab,
2 Click the Create/Modify Shift link.
3 Select the shift that you want to edit from the Name drop-down
field.
The color and description (if any) appear in the appropriate fields.
4 Click the Delete button.
Figure 9-54 Confirmation dialog box.
5 Choose one of the following options:
a) To re-assign shift data to the new shift definition, select
Re-assign historical data.
b) To leave historical data assigned to the previous shift definition,
select Do not change historical data.
Note: You can only delete the shift if it is not currently in use.
Shift Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
9-93
6 Click OK.
7 When you are finished, click Save.
Shift Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
9-94
Creating and Modifying Shift Periods
In the Production Shift Editor, when you create or modify shift periods,
you are modifying shift configuration at the global level, so the plant
hierarchy and calendar frames are disabled. Any new shifts or shift
periods are available to all assets, and any changes you make affect
any assets that used the shift or shift period definitions you modify.
Figure 9-55 The Create/Modify Shift Period screen
This section covers the following topics:
About Shift Periods on page 9-94
Creating a Shift Period on page 9-95
Modifying a Shift Period on page 9-95
Deleting a Shift Period on page 9-96
About Shift Periods
Once you have defined the shift period it becomes available for use in
the structure of any shift. Shift periods can be productive or
non-productive. Note that when you define a shift period on the
Create/Modify Shift Period screen, you do not say how long it will be;
you do that when you add the shift period to a shift structure.
Shift periods are subdivisions of shifts. They allow you to analyze
manufacturing data to a finer level than the shift only. When you
define a shift you add shift periods one to another in order to assemble
the whole shift. A shift is nothing more than a collection of shift
periods.
Shift Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
9-95
First you have to define each unique shift period for use in your shifts.
Once you have defined the shift period you can use it over and over
again in shift definitions. A shift period can be any length between one
minute and 24 hours.
Creating a Shift Period
Use the instructions below to create a global shift period. If you have
access to MI Admin, this shift period will be available in the Object
Library in the Shift Configuration module.
Prerequisites
Before doing this you should do or read the following:
If necessary, open the Production Shift Editor using the instructions
in Accessing the Production Shift Editor within MI Admin on page
9-55.
Read About Shift Periods on page 9-94 for more information about
shift periods.
Procedure
1 If necessary, select the Shift Definitions tab,
2 Click the Create/Modify Shift Period link.
3 Type the name of the new shift period in the Name field.
4 Select a color for the shift period by clicking the ellipsis button and
choosing a color from the Color box.
5 Choose one of the following:
a) Select the Productive radio button if the shift period will be
productive time.
b) Select the Non-Productive radio button if the shift period will
be non-productive time.
6 Click Save to save the new shift period definition.
Modifying a Shift Period
Use the instructions below to modify or delete an existing shift period.
Prerequisites
Before doing this you should do or read the following:
If necessary, open the Production Shift Editor using the instructions
in Accessing the Production Shift Editor within MI Admin on page
9-55.
Read About Shift Periods on page 9-94 for more information about
shift periods.
Shift Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
9-96
Procedure
1 If necessary, select the Shift Definitions tab,
2 Click the Create/Modify Shift Period link.
The color for the shift displays.
3 Click the drop-down arrow beside the Name field to select the shift
period.
4 To modify the period, do the following, as needed:
a) Click in the Name field and edit the name of the shift period.
b) Click the ellipsis button beside the Color field to change the
color.
c) Select the Productive or Non-Productive radio button to
change the type of shift period.
5 Click Save to save the shift period changes.
Deleting a Shift Period
Use the instructions below to delete a shift period.
Prerequisites
Before doing this you should do or read the following:
If necessary, open the Production Shift Editor using the instructions in
Accessing the Production Shift Editor within MI Admin on page 9-55.
Procedure
1 If necessary, select the Shift Definitions tab.
2 Click the Create/Modify Shift Period link.
The color for the shift displays.
3 Click the drop-down arrow beside the Name field to select the shift
period.
4 To delete the shift period, click the Delete button. A Confirmation
dialog box opens.
Figure 9-56 The Confirmation dialog box
Shift Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
9-97
5 Choose one of the following options:
a) To reassign shift period data, select Reassign historical data.
b) To leave historical data assigned to the previous shift period,
select Do not change historical data.
6 Click Yes.
Reports
You can generate reports for current shift information and shift
changes that youve made, as well as shift changes that you have
scheduled for the future. These reports are similar to VPWeb reports,
however they are not linked and cannot be viewed in VPWeb; they can
only be viewed through the Production Shift Editor.
To view the Production Shift Editor reports, users need to be members
of at least the Report Users role. The Reports tab does not appear in
the in the shift editor if the user does not have sufficient privileges.
The availability and content of the reports are subject to any selections
in the Shift Editing Groups frame. With the exception of the Shift
Schedule report, which deals with global configuration, users must
select one of more shift owners in the Shift Editing Groups frame to
view any of the other reports.
This section covers the following topics:
Generating a Report on page 9-97
About Shift Editing Reports on page 9-98
Generating a Report
Use the instructions below to generate one of the shift reports.
1 Select the shift editing group and date for the report that you want
to view.
2 Click on the Reports tab.
The Reports screen appears.
Shift Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
9-98
Figure 9-57 The Reports tab
3 Click on the report that you want to view.
The report then opens in a new window.
About Shift Editing Reports
The Production Shift Editor reports relate to the usage of shift
schedules, shift definitions, etc. in relationship to the groups and
assets in your plant. The reports do not provide any functionality,
except to summarize the shift data in a form that allows you to view
information without having to access the various areas of the Shift
Configuration module.
Note: The page lists the reports that are available with a brief description of their
purpose. However, if you have not selected any assets in the Shift Editing
Groups frame, the only report that it available is the Shift Schedule report.
Each of the other reports needs the context of the selected assets.
Note: With some of the reports, a dialog box opens first where you can select
parameters that control the report content.
Shift Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
9-99
The Reports
The Production Shift Editor gives you access to several report types,
each of which you can access by first selecting a Shift Editing group,
and then by clicking the Report Type name.
Daily Schedule. This report provides historical data about shifts,
schedules, shift structures, and shift periods were applied to the
selected shift scheduling group for the selected date.
Figure 9-58 An example of a Daily Scheduling Report
Edit Log. This report provides details about any changes that
occurred in the shift configuration over a specified date range. The
detail in the report is governed by the user role.
When requesting the report, the user is presented with a dialog
box that asks for the range of dates to appear in the report.
However, if the user is a member of the System Administrator or
Shift Global Definition Administrator roles, two additional options
appear on the dialog box that allow the user to seek details in the
report for all assets, and all users. If the user does not select either
of the options, the report focusses only on the shift owners
selected in the Shift Editing Groups frame.
Shift Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
9-100
Figure 9-59 The administrator and other user dialog boxes
Shift Schedule. This report allows you to select a particular shift
schedule and receive a report that details how the schedule was
applied during the span of the schedule. In the report, you see the
shift structures, and productive and non-productive time.
Shift Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
9-101
Figure 9-60 An example of a Shift Schedule Report
Temporary Shift Plans. This report details the use of any
Temporary Shift Plans that are either underway or are still yet to
occur. If a user needs to view records of completed temporary shift
plans, this information is available in the Temporary Shift Plans
sub-task module in the Shift Configuration module.
Shift Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
9-102
The Shift Audit Log
Whenever you edit shift information the changes are recorded, along
with your user name and the time when the changes were made. You
can view this information in the Audit Log. The audit log records all
changes made to shift information, by any user, as such the
information is very detailed and potentially useful in troubleshooting
scenarios. However, for System and Shift Global Definitions
administrators, it is possible to obtain detailed reports from the Shift
Editor. See Reports on page 9-97 for more information.
This section covers the following topics:
Viewing Changes in the Shift Audit Log on page 9-102
Example of Saving Changes in the Audit Log on page 9-103
Viewing Changes in the Shift Audit Log
Use the instructions below to view changes that have been made to
shift data. The changes are displayed in the Shift Audit Log.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Shift Configuration task module using the
instructions in Accessing the Shift Configuration Module on page
9-3.
Read Example of Saving Changes in the Audit Log on page 9-103.
Procedure
1 In the Plant Hierarchy frame, navigate to and select the group or
asset that you are interested in.
2 In the Historical Data Management frame, click the Audit Logs
button.
The grid displays a list of changes made to the historical shift data.
By default, it displays changes made to data belonging to the last
week. You can change the time frame if you wish.
3 To change the time frame, click the Calendar button on the
toolbar. You can either click and type new values, or click the
ellipsis buttons to open a calendar from which you can pick a date.
A dialog box opens that displays the currently selected start and
end dates. Set the start and end dates.
Shift Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
9-103
Figure 9-61 Changing a time frame
4 Click OK to set the time frame.
The data in the grid changes to reflect the new time frame, and all
entries are sorted by their start times/dates.
Example of Saving Changes in the Audit
Log
The Audit Log keeps a record of the changes made to historical shift
data. Along with the original and new values, it records the name of
the operator who made the changes, and the date and time at which
the changes were made. By default, the Audit Log records changes for
data belonging to the last week, but you can change the time frame.
In this example, we will delete a shift period from a shift, then view
the record of the change in the Audit Log.
1 We first choose the asset in the Plant Hierarchy frame, and click
the Shift Editing button in the Historical Data Management
frame.
Figure 9-62 Opening the Edit Daily Shifts dialog box
2 In the Edit Daily Shifts dialog box we set the date to July 9th
2003. We then click on the colored bar for Shift A, then in the lower
part of the dialog box we click on Hour 1, then right-click and
choose Delete, and choose Yes in the confirmation message box.
Note: To see changes to shift periods, be sure to check the Include shift period
changes checkbox at the bottom of the grid area.
Shift Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
9-104
Figure 9-63 Deleting the shift period
The shift period is removed from the structure for Shift A.
3 We now go back to the Historical Data Management frame and click
the Audit Logs button to open the audit log in the grid. By default,
the log covers changes made to data from the last seven days
(note: not changes made in the last seven days).
4 With the Audit Log displayed, we click the Calendar button on the
toolbar, and set the time frame to the period from July 1st 2003 to
July 15th 2003. This is because the data that we changed was from
July 9th.
Figure 9-64 Setting the time frame
5 At the bottom of the audit log grid we check the box for shift period
changes (it is not checked by default).
Shift Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
9-105
Figure 9-65 Including shift period changes
The information about the change now appears in the grid.
Figure 9-66 New shift data in the grid
Shift Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
9-106
Temporary Shift Plans
There may be times when you need to create a shift plan that is for
temporary usefor example, when some special event is taking place.
ActivEssentials allows you to do this within the Shift Configuration
module. Temporary shift plans can only be in the future, so there is no
question of having to update historical shift data.
This section covers the following topics:
Creating a Temporary Shift Plan on page 9-106
Editing a Temporary Shift Plan on page 9-108
Stopping a Temporary Shift Plan on page 9-109
Deleting a Temporary Plan on page 9-109
Temporary Shift Plans on page 9-110
Creating a Temporary Shift Plan
Use the instructions below to create a temporary shift plan for a group
or asset in your plant hierarchy. The temporary plan can only be
future, not in the past. Before you can create such a plan you should
have created the shift periods and shifts that will be used in the
temporary plan.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Shift Configuration task module using the
instructions in Accessing the Shift Configuration Module on page
9-3.
Read Temporary Shift Plans on page 9-110.
Procedure
1 In the Plant Hierarchy frame, navigate to and select the group or
asset for which you need to create the temporary plan.
2 In the Historical Data Management frame, click the Temporary
Shift Plans button.
The grid shows any temporary plans that have been defined for the
group or asset.
3 Click the New button on the toolbar.
The Add New Temporary Shift Plan wizard starts.
4 Click Next to move past the welcome page.
Shift Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
9-107
Figure 9-67 The General Information wizard page
5 Do each of the following:
a) Click the ellipsis button by the From field and choose a date for
the start of the temporary plan.
b) Click the ellipsis button by the To field and choose a date for
the end of the temporary plan.
c) Click in the Schedule Change Reason field and type a reason
(up to 255 characters) for the temporary plan.
6 Click Next.
Figure 9-68 The Details page in the wizard
7 Do each of the following:
a) Enter the start time and end time for the temporary plan.
Shift Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
9-108
b) If the time span either started during the previous day or will
end during the following day, select the appropriate option.
c) Click the down-arrow by the Shift field and choose a shift from
the list.
d) Click the down-arrow by the Structure field and choose a shift
structure from the list.
8 Click Next.
The final page of the wizard opens.
9 Review the definition, then click Finish to save it.
Editing a Temporary Shift Plan
Use the instructions below to edit a temporary shift plan for a group or
asset. If the temporary plan is already in force and the end date is less
than one day in the future, you can only change the end time and the
Change Reason; you cannot change any other properties. The end
date can only be changed if the date is more than one day in the
future.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Shift Configuration task module using the
instructions in Accessing the Shift Configuration Module on page
9-3.
Read Temporary Shift Plans on page 9-110.
Procedure
1 In the Plant Hierarchy frame, navigate to and select the group or
asset whose temporary plan you want to edit.
2 In the Historical Data Management frame, click the Temporary
Shift Plans button.
The grid shows any temporary plans that have been defined for the
group or asset.
3 Right-click on the plan in the grid and select Properties.
A properties dialog box opens.
4 Edit the properties you wish to change, then click OK to save the
changes.
Note: You can also edit some properties of the temporary plan directly in the grid.
Click or double-click in the appropriate column and make your changes. When
you click outside the grid row the changes will be saved automatically.
Shift Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
9-109
Stopping a Temporary Shift Plan
Use the instructions below to stop a temporary shift plan on a group or
asset. This only applies to a plan that is currently in force (active). You
must stop the plan before you can delete it. When you stop a
temporary plan, the group or asset reverts to its original shift rotation
plan.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Shift Configuration task module using the
instructions in Accessing the Shift Configuration Module on page
9-3.
Read Temporary Shift Plans on page 9-110.
Procedure
1 In the Plant Hierarchy frame, navigate to and select the group or
asset whose temporary plan you want to stop.
2 In the Historical Data Management frame, click the Temporary
Shift Plans button.
The grid shows any temporary plans that have been defined for the
group or asset.
3 In the grid, select the plan that you want to stop. It will have a
checkmark in the Active column of the grid.
4 Click the Stop button on the toolbar.
A confirmation dialog box opens.
5 Click OK.
Deleting a Temporary Plan
Use the instructions below to delete a temporary shift plan from a
group or asset in the plant hierarchy. You cannot delete a temporary
shift plan that is already in force on the group or asset; you must first
stop it. See Stopping a Temporary Shift Plan on page 9-82.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Shift Configuration task module using the
instructions in Accessing the Shift Configuration Module on page
9-3.
Read Temporary Shift Plans on page 9-110.
Shift Configuration
CDC Factory 7.1
ActivEssentials Administration Guide
9-110
Procedure
1 In the Plant Hierarchy frame, navigate to and select the group or
asset whose temporary plan you need to delete.
2 In the Historical Data Management frame, click the Temporary
Shift Plans button.
The grid shows any temporary plans that have been defined for the
group or asset.
3 Right-click on the plan in the grid and select Delete.
Temporary Shift Plans
There may be times when you need to create a shift plan that is for
temporary usefor example, when some special event is taking place.
You can do this within the Shift Configuration module.
Here are some characteristics of temporary shift plans:
Temporary shift plans apply to individual groups or assets in the
plant hierarchy. You cannot create global temporary plans.
If the group or asset already has a shift rotation plan (as is usually
the case), the temporary shift plan acts as an overlay. When the
temporary plan is finished, the group or asset reverts to its original
rotation plan.
You can only define a temporary shift plan using a future time, so
such a plan has no effect on historical shift data.
CDC Factory 7.1
ActivEssentials Administration Guide
10-1
Security in AppCenter
Security in AppCenter
CDC Factory 7.1
ActivEssentials Administration Guide
10-2
Introduction to Security in AppCenter
AppCenter includes its own security module, which is called Security
Configuration. This module allows you to define user privileges, roles,
and users. You probably do not want to give all users access to all
areas of ActivEssentials, or even to the whole plant hierarchy, so with
the tools in Security Configuration you can define user roles and their
associated privileges, and then assign individual users to the roles.
This chapter covers the following topics:
The ActivEssentials Security Model on page 10-2
Creating Roles and Users on page 10-14
Setting up Network Users on page 10-30
Setting Privileges in the Plant Hierarchy on page 10-39
Changing and Removing Roles, Users, and Privileges on page
10-44
The ActivEssentials Security Model
The ActivEssentials security model consists of three entities:
Privileges
Roles
Users
By using these three entities you can create new users, assign them to
specific roles (to which are linked sets of privileges), and control the
privileges that they are allowed in different parts of the plant
hierarchy.
This section covers the following topics:
ActivEssentials Privileges on page 10-3
ActivEssentials Roles on page 10-4
The Default Role on page 10-6
ActivEssentials Users on page 10-8
The Guest User Account on page 10-9
How the Security Model Works on page 10-9
Granting, Denying, and Revoking Privileges on page 10-10
What Happens When a User Logs On on page 10-11
Access to ActivApplications on page 10-12
Access to the Production Shift Editor on page 10-13
Note: The Security module also comes into play when you are creating definitions in
the Root Cause Analysis module. For information on changes you must make
in Security in regard to Root Cause Analysis, see the Root Cause Analysis
User Guide, which is in the ActivEssentials installation package.
Security in AppCenter
CDC Factory 7.1
ActivEssentials Administration Guide
10-3
ActivEssentials Privileges
Privileges allow you to control the actions that a user can perform
within ActivEssentials. By assigning a privilege to a user you allow the
user to perform that action. The basic privileges are:
Read, Update (edit), Delete, or Insert configuration items. These
allow an administrator to configure the data collection system
using the configuration functions in MI Admin. They would typically
be given to a limited number of people who are responsible for
designing the system.
Read, Update (edit), Delete, or Insert data. These allow a user to
view, edit, delete, or add manufacturing datathat is, to modify
the data produced by the data collection system. Typically these
modifications would be made in VPWeb or other modules.
Import, Export items. These privileges allow a user to use any of
the import/export functions available in AppCenter, including
import/export of assets, data items, other definitions, or of the
whole configuration of ActivEssentials. Import/export can be from
or to other applications, including spreadsheets, databases, etc.
Note that when these privileges are granted they override any
limitations imposed by other privileges, but only so far as they
relate to import/export.
Create and Print reports in the Reports Administration module of
AppCenter.
A privilege is either granted or denied, so for an individual user each
privilege is really ON or OFF. Within ActivEssentials the privileges are
therefore set by bits in a data word consisting of 64 bits, although
ActivEssentials uses only the bits that occur in the first 32. The bits
corresponding to each privilege are shown in the following table.
Table 10-1 ActivEssentials privileges
Bit
1
Privilege type Privilege
0 Configuration Read Configuration
1 Update Configuration
2 Delete Configuration
3 Insert/Create Configuration
4
2
Import Configuration
5
2
Export Configuration
6 Reserved Unused
7 Data/Content Read Data or Content
8 Update Data or Content
9 Delete Data or Content
10 Insert/Create Data or Content
11 Reserved Unused
12 Unused
13 Unused
Security in AppCenter
CDC Factory 7.1
ActivEssentials Administration Guide
10-4
1
All bits in the range 3263 are reserved and do not appear in the table
2
All bits in the range 3263 are reserved and do not appear in the table.
Reserved bits are available for user-defined privileges. These are not
implemented in ActivEssentials and require a separate security add-in.
ActivEssentials Roles
Roles allow you to collect users into single units to which you apply
sets of privileges. When you apply a set of privileges to a role, all the
users within that role receive the same privileges. You can still edit the
privileges granted to an individual user. You can create as many roles
as you like, to represent the different jobs performed by staff. A user
can belong to any number of roles.
14 Execution Launch/Load
15 Start/Execute
16 Stop/Cancel
17 Pause
18 Schedule
19 Reserved Unused
20
2
Data/Content Import Data or Content
21 Export Data or Content
22 Reserved Unused
23 Unused
24 Unused
25 Unused
26 Data/Content Send Data or Content to ActivEssentials users
27 Reserved Unused
28 Data/Content Deliver Data or Content
29 Publish Data or Content
30 Reserved Unused
31 Unused
Table 10-1 ActivEssentials privileges
Bit
1
Privilege type Privilege
Security in AppCenter
CDC Factory 7.1
ActivEssentials Administration Guide
10-5
Predefined Roles
ActivEssentials contains some predefined roles which exist already in
the database. They are as follows:
Table 10-2 Predefined roles
Role Privileges
System Administrators Members of this role have complete access to all
ActivEssentials configuration, data, and system
management.
Public Users All users are members of this role, which by default
grants only the Read Configuration privilege at any
point in the Plant Hierarchy. It is possible to
customize the privileges granted to the role. You
cannot remove a user from this role.
VPWeb Administrator Role Members of this role can log onto VPWeb as a Default
User and configure default views for all other users of
VPWeb.
Report Delivery Role Members of this role can read schedules and deliver
reports. The Report Delivery Service must be run
under this role.
Advanced VPWeb Users Members of this role can define and save their own
views in VPWeb.
1
Members of this role can change values on OPC
servers through HMI Controls in Layout View.
Data Readers Members of this role can read all data in
ActivEssentials.
FactoryViewer Administrator Members of this role can create slide shows and
assign them to Players in the FactoryViewer
Administration module. These users can also use and
save any VPWeb Views that they created.
Data Collection Global
Definition Administrators
Members of this role can administer data categories
and data items in the Data Collection Configuration
module.
RTLE Configuration
Administrators
Members of this role can manage RTLE
configurations.
Application Template
Developers
Members of this role can manage the development of
applications and templates.
Application Template Users Members of this role can manage the use of
applications and templates.
Shift Global Definition
Administrators
Members of this role can browse and define shifts,
shift periods, shift schedules, and schedule types
(note that it does not include shift rotation plans,
which require access to the plant hierarchy).
Shift Editors Members of this role can use the Shift Editor
application to manage historical shift data.
Security Administrators Members of this role can browse and define roles and
users, assign users to roles, and assign privileges to
roles or users and to plant hierarchy objects.
Note: Only members of the System Administrator
role can add other users to the System Administrator
role.
Security in AppCenter
CDC Factory 7.1
ActivEssentials Administration Guide
10-6
The Default Role
There is always one role in ActivEssentials that is designated as the
Default Role. By default, this is the Public Role, which grants its
members Read Configuration privileges only. You can designate
another role as the default role if you wish (except for the System
Administrator role and the Advanced VPWeb User role). If you do
change the default role, all new users will then have the privileges
associated with the new default role. Changing the role that is
designated as the default has no effect on the privileges granted to
existing users.
2
Members of this role can administer the Root Cause
Analysis functions and manipulate RCA data.
RCA Setting Users Members of this role cannot change configuration of
Root Cause Analysis, but can view and edit incidents
and assign reason codes, comments, etc.
RCA Users Members of this role can view data in Root Cause
View.
Data Management
Administrators
Members of this role can manage the archiving,
restoration, and summarization of plant data.
3
Members of this role have full access to the reporting
system, including the Report Viewer and the Reports
Administration module of MI Admin.
Report Power Users Members of this role have all the privileges of the
Report User role, and can create templates, subscribe
to scheduled reports, manage report deliveries, and
send reports to others. They can also create their
own report folders.
Report Users Members of this role can view existing reports and
use templates to create and view reports.
Insight for Excel Users Members of this role can use the Insight for Excel
add-in.
Query Builder Users Members of this role can use the Query Builder to
create datasets for report generation.
Note: This role appears only if you have installed the
Activplant Integration Toolkit.
1. HMI Controls and their security is a feature that can be installed with
ActivEssentials. For installation information, see the CDC Factory System
Configuration Guide. For more information about implementing security for
HMI Controls, see the CDC Factory VPWeb User Guide.
2. For information about security in Root Cause Analysis, see the CDC Factory
Root Cause Analysis User Guide.
3. For more information about the roles needed in APRS, see the Report
Administration on page 14-1.
Table 10-2 Predefined roles
Role Privileges
Security in AppCenter
CDC Factory 7.1
ActivEssentials Administration Guide
10-7
Example
If you plan to add a number of new users to a specific role, you can
use a designation of this role as the default role as a shortcut. When a
role is designated as the default, all new users become members of
the default role as well as becoming members of the Public Users role.
These new users then receive the privileges associated with the role
without you having to specifically assign them to the role.
When you create a new user (or when an undefined user belonging to
a network group logs in), the user automatically belongs to the Public
Role. If you have changed the default role to something other than
Public Role, they will also be a member of the default role. They
receive the privileges associated with the Public Role plus the default
role. Afterwards, you can:
Leave the user in the default role and add him/her to other roles if
you wish;
Remove the user from the default role (if the Public Role is no
longer the default role) so that he/she belongs only to the Public
role;
Add the user to another role and remove him/her from the default
role.
To see which role is the default role, open the Security Configuration
module and select the Object Library. If you rest your mouse pointer
over the icons in the grid a tool-tip shows which is the default role; it is
indicated by a icon.
Note: You cannot remove a user from the Public Role. This role by default has only
Read Configuration privileges, however, you can modify the privileges
associated with the Public Role.
Warning! Be careful when you grant or deny privileges to the default role. Remember
that every user in your system has access to the default role privileges,
unless you specifically remove them. In the same way, if you deny certain
privileges, they are denied for all the members of the default role unless
you specifically grant them.
Security in AppCenter
CDC Factory 7.1
ActivEssentials Administration Guide
10-8
ActivEssentials Users
A user can be any person or group of people. There are three types of
users:
System Users. These are the predefined users, and are described
in Predefined Users on page 10-8.
Standard Users. A Standard User is one created in the Security
Configuration module. They require a user name and a password.
The password must be 6 to 20 characters and is case-sensitive.
Trusted Users. These are network users that are imported into
ActivEssentials. These users do not require a user name and
password, since this information is taken from their domain
account. Consequently, these users passwords cannot be changed,
nor can their account be disabled.
Predefined Users
ActivEssentials has several pre-defined user roles. The properties
assigned to these users are locked, so, with the exception of the
password, you cannot change them.
$ReportDeliveryServer$. This user is not for use by individual
users of ActivEssentials, but is designed to allow access by the
Report Delivery Service to the ActivEssentials database.
$ReportURLAccessUser$. This user is not for use by individual
users of ActivEssentials, but is designed to allow URL access to
reports.
Administrator. This user belongs to the System Administrator
system role. The user name is Administrator (without the quotes)
and the password is Administrator. The password is case-sensitive
and must be changed upon first use.
Guest. This user can only belong to the Public Users role, and so
only has the privileges associated with the role. The password for
this user is Guest and is case-sensitive.
Users and User Names
When you define a Standard User you must assign a user name. This
can be any valid alphanumeric name, up to 50 characters.
You can also add the full name of the user. This is not required. In fact,
you may sometimes want to have a whole group of people using the
same user name.
Note: There are a number of illegal characters you cannot use when creating names
in ActivEssentials. They are: . ( ) For more information, see Illegal
Characters on page 1-17.
Security in AppCenter
CDC Factory 7.1
ActivEssentials Administration Guide
10-9
User Account Expiry
The other property that you define when creating a user is the expiry.
This is the number of days for which the account will be active. It is
measured in units of 24 hours from the time that you create the user
account. For example, a user account created on December 2nd at
10:04:30. and given a Valid Days value of 1, will expire at 10:04:30
on December 3rd. Note that network (trusted) user accounts do not
have an account expiry, since this account is directly linked to their
network account.
The default value is 0, which means that the account will never expire.
The Guest User Account
The Guest user account is a virtual user account. In a new installation
of ActivEssentials, the Guest user is a member of the Public User role,
which is also acts as the default role for all users. You cannot remove
the Guest user from this role, but you can assign the user to other
roles as well as the Public User role.
How the Security Model Works
The ActivEssentials database keeps a record of the privileges assigned
to each user by calculating the value of the privilege wordthe net
result of the interaction between role privileges and user privileges as
they are assigned at different levels of the plant hierarchy. It is
important to understand how these interact.
Role privileges. These are privileges that are associated with a
particular role. What these privileges are may vary from group to
group in the plant hierarchy. So the privileges for an Operator role
may be different on group A and group B. Every user that belongs
to the role potentially has the privileges that go with the role, but
they may be modified by individual user privileges. Users can
belong to several roles, and the privileges assigned to them are
additive.
User privileges. Each user can have specific privileges that may
modify the privileges that they inherit from the role(s) to which
they belong.
The privileges assigned to a role or user on a higher level of the plant
hierarchy cascade down to the lower levels of the hierarchy. They can
be modified on any descendant at the wish of the administrator. So, for
example, the General User role may have a certain set of privileges for
group A, but that set may be slightly modified on group As
descendants.
Warning! Be careful with the Guest user account. Everyone who signs in as a guest
user will receive the privileges associated with the role to which the Guest
user belongs. You should ensure that those privileges are no more than is
necessary.
Security in AppCenter
CDC Factory 7.1
ActivEssentials Administration Guide
10-10
Granting, Denying, and Revoking
Privileges
There are three types of actions that you can perform for security
purposes: granting, denying, and revoking.
Granting. Granting a user rights to an action on a plant hierarchy
object gives them access to the action at the plant hierarchy
object.
Denying. Denying a user rights to an action on a plant hierarchy
object means that they cannot perform the action on the plant
hierarchy object. If you explicitly deny a user access to an action,
that denial overrides the granting of the privilege in any role to
which the user belongs.
Revoking. A revoked privilege is neither granted nor denied. A
privilege that is granted on a higher level of the hierarchy can be
revoked at a lower level. Denials can also be revoked, so that a
privilege denied on a higher level can be granted on a lower level.
Extended Example
The table below demonstrates how the database calculates the
privilege word. The table shows a simple plant hierarchy and a set of
privileges that belong to a typical role, called Operator. There are four
privileges available: Read, Update, Insert, and Delete. The Operator
role is added to the Body Shop group, with the privileges 1100that
is, Read and Update (1 = ON; 0 = OFF).
Table 10-3 Operator role privileges and the plant hierarchy
Plant Hierarchy Granted Extra
Granted
Revoke
d
Result Explanation
R
e
a
d
U
p
d
a
t
e
I
n
s
e
r
t
D
e
l
e
t
e
R
e
a
d
U
p
d
a
t
e
I
n
s
e
r
t
D
e
l
e
t
e
R
e
a
d
U
p
d
a
t
e
I
n
s
e
r
t
D
e
l
e
t
e
R
e
a
d
U
p
d
a
t
e
I
n
s
e
r
t
D
e
l
e
t
e
ActivEssentials
Body Shop 1 1 0 0 Role privileges for
the Body Shop
group.
Painting
Line
0 0 1 0 0 1 0 0 1 0 1 0 Insert added to
parent set; Update
revoked.
Statio
n 1
0 0 0 1 1 0 1 1 Delete added to
parent set.
Security in AppCenter
CDC Factory 7.1
ActivEssentials Administration Guide
10-11
With no further intervention, all the descendants of the Body Shop
(the Painting Line and Station 1) would have the same privileges for
the Operator role, because they are inherited. But in the example
above, the administrator has made two changes at the Painting Line
level:
Granted Insert. This brings the privileges of the Operator role on
the Painting Line to 1110that is, Read, Update, Insertbut this is
modified by the next change.
Revoked Update. This brings the privileges of the Operator role on
the Painting Line to 1010that is, Read, Insert. This is the final
result of the changes for the Painting Line.
Station 1 is a descendant of the Body Shop and of the Painting Line.
The Operator role on Station 1 inherits the privileges that exist for the
role on the Painting Line (1010); but the administrator has also
granted the Delete privilege on Station 1. The Operator role on the
Painting Line therefore has the privileges 1011that is, Read, Insert,
Delete.
What Happens When a User Logs On
When a user logs on to ActivEssentials the database calculates the
privileges assigned to the user. This calculation is based on the roles to
which the user belongs and the privileges that are set for that user.
When the user tries to access a plant hierarchy object, the system
decides whether the user has access (and what actions the user can
perform) according to the decision tree shown in the following figure.
This figure shows the privilege check for object O.
Security in AppCenter
CDC Factory 7.1
ActivEssentials Administration Guide
10-12
Figure 10-1 System checks for privilege P on a plant hierarchy object O
If the privilege exists on object O itself, and it has not been
revoked, then the system follows the Approval Path.
If the privilege does not exist on object O, the system follows the
Inheritance Path. It recursively checks all the levels of ancestors
for O, until the privilege is found on an ancestor (that is, it is
inheritable). If it has not been revoked, then the Approval Path
becomes valid. If no ancestor has the privilege, access is denied.
Access to ActivApplications
In several of the MI Admin task modules, there is an ActivApplications
item in the Plant Hierarchy frame which stores certain types of
templates. The following table lists the modules in which the
ActivApplications item appears, and the user roles that have access to
these items.
YES YES YES
NO
NO
NO
Is bit P ON
(value = 1)?
Is privilege P
granted to A?
Approved
Denied
Denied
Check privilege bit P for user A on object O
YES
NO
Read O's parent object X
Is O in
the privilege
profile for
A?
X exists
Set O = X
Approval path
Inheritance Path
Table 10-4 User role access to ActivApplications
MI Admin task module User role
Plant Management
System Administrators
Application Template Developers
Application Template Users
Extended Properties
System Administrators
Application Template Developers
Application Template Users
Security in AppCenter
CDC Factory 7.1
ActivEssentials Administration Guide
10-13
Access to the Production Shift Editor
The Production Shift Editor can be accessed in three different ways:
Through the Shift Configuration module in MI Admin, where users
can select the Shift Editing button in the Historical Data
Management frame.
Through the Root Cause Assignment application, where users can
access the editor from the taskbar.
Through a shortcut link, which directly accesses the Production
Shift Editor.
Only users with the properly assigned roles can access the Production
Shift Editor. In the Shift Configuration module and Root Cause
Assignment, access is controlled by the users name and password. If
users try to access the editor through the shortcut link, they must also
provide a user name and password.
Access levels also vary with the user role, so some users are able to
make configuration changes, whereas others may only view data. The
following table lists the standard roles in ActivEssentials that have
Production Shift Editor permissions.
Data Collection Configuration
System Administrators
Application Template Developers
Application Template Users
Calculations
System Administrators
Application Template Developers
Application Template Users
Shift Configuration
System Administrators
Application Template Developers
Application Template Users
Table 10-4 User role access to ActivApplications
MI Admin task module User role
Table 10-5 Roles and the permissions granted
Role Names Launch
Application
Edit Shift Data Modify Shift
Configuration
View
Reports
System
Administrators
Yes Yes Yes Yes
Shift
Administrators
Yes Yes Yes
Shift Editors Yes Yes
Report
Administrators
Yes
VPWeb Power
Users
Yes
Report Users Yes
Security in AppCenter
CDC Factory 7.1
ActivEssentials Administration Guide
10-14
Creating Roles and Users
The first stage in setting up security is to create the roles and users for
your system. A user may be an individual person, or the user name
may be shared among a group of people. For example, you may want
to define a Public user that anyone can use. A role is a collection of
users who all have the same privileges.
For more information, see ActivEssentials Roles on page 10-4 and
ActivEssentials Users on page 10-8.
This section covers the following topics:
Opening the Security Configuration Module on page 10-14
Creating a Role on page 10-15
Creating a User on page 10-16
Assigning a User to a Role on page 10-18
Assigning a Role to a User on page 10-20
Changing a Users Password on page 10-21
Changing the Default Role on page 10-22
Deleting Users on page 10-23
Deleting Roles on page 10-24
Editing the Properties of a User on page 10-24
Editing the Properties of a Role on page 10-27
Opening the Security Configuration
Module
Use the instructions below to open the AppCenter Security Manager in
which you define the roles and users of your system.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
Read the topics in The ActivEssentials Security Model on page
10-2.
Procedure
1 In the taskbar, click the System category button.
The taskbar refreshes to display the task sub-modules in the
System category.
Note: There are a number of illegal characters you cannot use when creating names
in ActivEssentials. They are: ' " . ( ). For more information, see Illegal
Characters on page 1-17.
Security in AppCenter
CDC Factory 7.1
ActivEssentials Administration Guide
10-15
2 Click the Security Configuration icon.
Creating a Role
Use the instructions below to create a new role in AppCenter. Later,
you can assign privileges to the role which are shared by all its
members.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Security Configuration module of AppCenter
as described in Opening the Security Configuration Module on page
10-14.
Read ActivEssentials Roles on page 10-4 for an understanding of
what roles come with ActivEssentials.
Procedure
1 In the Plant Hierarchy frame, select the Object Library.
The Security Configuration frame opens below the Plant Hierarchy.
This frame contains buttons for Roles and Users.
2 In the Security Configuration frame, click the Roles icon.
The grid displays any roles that have been previously defined.
3 Click the New button on the toolbar.
The Add New Role wizard starts.
4 Click Next to move past the welcome page.
Figure 10-2 The Name and Description page
5 Type a name for the role (up to 50 characters) and, if desired, a
description of the purpose of the role (up to 255 characters).
Security in AppCenter
CDC Factory 7.1
ActivEssentials Administration Guide
10-16
6 Click Next.
The final page of the wizard opens.
7 Review the definition, then click Finish.
The new role appears in the grid.
Creating a User
Use the instructions below to create a new user in AppCenter. When
you create a user you must assign a password also, and decide how
many days the user account will be active. The expiry time for the user
account is measured in units of 24 hours from the time that you create
the user.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Security Configuration module of AppCenter
as described in Opening the Security Configuration Module on page
10-14.
Read ActivEssentials Users on page 10-8 for the types of users that
come with ActivEssentials.
Procedure
1 In the Plant Hierarchy frame, select the Object Library.
The Security Configuration frame opens below the Tree Hierarchy.
This frame contains buttons for Roles and Users.
2 In the Security Configuration frame, click the Users icon.
The grid displays any users that have been previously defined.
3 Click the New button on the toolbar.
The Add New User wizard starts.
4 Click Next to move past the welcome page.
Security in AppCenter
CDC Factory 7.1
ActivEssentials Administration Guide
10-17
Figure 10-3 The Name and Description page
5 Click in the User name field and type a User Name for the user (up
to 50 characters).
This is required, and can be any name that you wish to give.
6 If necessary, click in the Full name field and type the users name
(up to 50 characters).
7 If desired, click in the Description field and type a description (up
to 255 characters).
8 Click Next.
Figure 10-4 User password details
Security in AppCenter
CDC Factory 7.1
ActivEssentials Administration Guide
10-18
9 Type a password for the user. The password must be 6 to 20
characters, and is case-sensitive. It must be different from the user
name.
10 In the Valid days field, type the number of days after which the
user account will expire. If you leave this value at 0, the account
will never expire.
The units are 24 hours from the time that you create the user.
11 Click the ellipsis button by the Access Level field. In the browse
window, select the point in the plant hierarchy where the VPWeb
user will have access, then click OK to return to the wizard.
Figure 10-5 Assigning a root level to the user
12 If you want the user account to be active, ensure the Account
enabled checkbox is checked.
13 If the user is someone who should receive e-mail notifications,
such as reports, click in the E-mail address field and type the
users e-mail address.
14 Click Next.
The final page of the wizard opens.
15 Review the definition, then click Finish to save the user.
Assigning a User to a Role
Use the instructions below to assign a user to a role. Note that this has
the same effect as assigning a role to a user. You can assign the same
user to any number of different roles. When you assign a user to a
Note: When you give a user access at a point in the Plant Hierarchy, this does not
grant any kind of privilege. This only acts as a pointer to where views in VPWeb
will open.
Security in AppCenter
CDC Factory 7.1
ActivEssentials Administration Guide
10-19
role, the user receives the privileges that belong to the role (though
the privileges can be overridden at other levels of the security
process).
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Security Configuration module of AppCenter
as described in Opening the Security Configuration Module on page
10-14.
Created one or more roles and at least one user. For information on
how to do this, see Creating a Role on page 10-15 and Creating a
User on page 10-16.
Procedure
1 In the Plant Hierarchy frame, select the Object Library.
2 In the Security Configuration frame, click the Roles icon.
The grid displays any roles that have been previously defined.
3 In the grid, locate the role to which you want to add the user. Click
in the Users Assigned column, then click the ellipsis button that
appears.
Figure 10-6 The Roles dialog box
4 Select the user on the left side of the dialog box, then click the Add
button to add the user to the role. You can add as many users as
you want. To remove a user, select the user on the right side of the
box and click the Remove button.
5 Click OK.
Security in AppCenter
CDC Factory 7.1
ActivEssentials Administration Guide
10-20
Assigning a Role to a User
Use the instructions below to assign a role to a user. Note that this has
the same effect as assigning a user to a role. You can assign the same
role to any number of different users. When you assign a role to a
user, the user receives the privileges that belong to the role (though
the privileges can be overridden at other levels of the security
process).
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Security Configuration module of AppCenter
as described in Opening the Security Configuration Module on page
10-14.
Create one or more roles and at least one user. For information on
how to do this, see Creating a Role on page 10-15 and Creating a
User on page 10-16.
Procedure
1 In the Plant Hierarchy frame, select the Object Library.
2 In the Security Configuration frame, click the Users icon.
The grid displays any users that have been previously defined.
Figure 10-7 Security Configuration: Users in the grid
3 In the grid, locate the user that you want to add to the role. Click in
the Roles Assigned column, then click the ellipsis button that
appears.
The Roles dialog box opens.
4 Select the role on the left side of the dialog box, then click Add to
add the role to the user. You can add as many roles as you want.
Note: You can also add a user to a role by opening the role Properties dialog box
and clicking the Users Assigned button. This opens the Users dialog box as
described above.
Security in AppCenter
CDC Factory 7.1
ActivEssentials Administration Guide
10-21
Figure 10-8 The Roles dialog box
5 Click OK.
Changing a Users Password
Use the instructions below to change the password for a user in the
Security Configuration task module.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Security Configuration module of AppCenter
as described in Opening the Security Configuration Module on page
10-14.
Read Editing the Properties of a User on page 10-24.
Note: You can also add a role to a user by opening the user Properties dialog box
and clicking the Roles Assigned button. This opens the Roles dialog box as
described above.
Note: Only members of the Security Administrators and System Administrators roles
can change passwords in the Security Configuration module (users can
change their own passwords on the AppCenter login page). You cannot change
passwords for trusted (network) users; these passwords must be changed
where they were initially set up.
Security in AppCenter
CDC Factory 7.1
ActivEssentials Administration Guide
10-22
Procedure
1 In the Plant Hierarchy frame, select the Object Library.
2 In the Security Configuration frame, click the Users icon.
The grid displays any users that have been previously defined.
3 Right-click on the entry for the user in the grid and select Change
Password.
The Set New Password dialog box opens.
4 Type the new password (6 to 20 characters, case-sensitive), and
confirm it in the Confirm password field, then click OK.
Figure 10-9 The Set New Password dialog box
Changing the Default Role
Use the instructions below to change the default role to something
other than Public Role. When you do this, all new users will receive the
privileges accorded to the role that you choose. The Guest user
account is originally a member of the Public Role, and will remain so
even if you change the default role. You can see which role is the
default role by hovering your mouse pointer over the icons at the left
side of the grid. The default role has a icon.
Warning! Be careful with the default role, because all new users that you add will
have the privileges associated with this role until you specifically change
them. New users will also be members of the Public Users role; if you
change the default role to something other than the Public Users role, new
user privileges will be the sum of the default role and the Public Users role.
Security in AppCenter
CDC Factory 7.1
ActivEssentials Administration Guide
10-23
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Security Configuration module of AppCenter
as described in Opening the Security Configuration Module on page
10-14.
Read The Default Role on page 10-6.
Procedure
1 In the Plant Hierarchy frame, select the Object Library.
2 In the Security Configuration frame, click the Roles icon.
The grid displays any roles that have been previously defined.
3 In the grid, locate the role that you want to set as the default role.
4 Right-click the entry for role in the grid and select Set as Default
Role.
Deleting Users
Use the instructions below to delete a user. When you delete a user in
the Security Configuration module, the user is automatically removed
from any plant hierarchy objects to which they have been assigned.
Deleting a user has different effects, depending on the type of user:
ActivEssentials user. The user and all associated roles, saved
layouts and reports are deleted. Even if you create the same user
account, these items are no longer available.
Trusted (network) user. If the network group to which they
belong is still active, then the user can log in. Any roles, saved
layouts and reports are still available.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Security Configuration module of AppCenter
as described in Opening the Security Configuration Module on page
10-14.
Created users using the instructions in Creating a User on page
10-16 or Importing Network Users on page 10-33.
Note: If you think a users information may be required at a later date, consider
disabling the user account, rather than deleting it. See Editing the Properties of
a User on page 10-24.
Security in AppCenter
CDC Factory 7.1
ActivEssentials Administration Guide
10-24
Procedure
1 In the Plant Hierarchy frame, select the Object Library.
2 In the Security Configuration frame, click the Users icon.
The grid displays the users that have been previously defined.
3 Right-click on the entry for the user you need to remove and select
Delete.
A confirmation dialog box opens.
4 Click OK.
Deleting Roles
Use the instructions below to delete a role.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Security Configuration module of AppCenter
as described in Opening the Security Configuration Module on page
10-14.
Procedure
1 In the Plant Hierarchy frame, select the Object Library.
2 In the Security Configuration frame, click the Roles icon.
The grid displays the roles that have been previously defined.
3 On the row in the grid for the role you need to delete, click the cell
in the Users Assigned column.
An ellipsis button appears.
4 Click the ellipsis button.
The Users dialog box opens.
5 For each user that appears in the right pane, select the user name
and click the Remove button.
6 When you have removed all users assigned to the role, click OK.
7 Right-click on the entry for the role in the grid and choose Delete.
A confirmation dialog box opens.
8 Click OK.
Editing the Properties of a User
Use the instructions below to view or edit the properties of roles or
users. The AppCenter grid displays some of the properties, but you
can view other properties only by opening the properties dialog box.
Through the properties dialog box you can also assign roles to users or
users to roles.
Security in AppCenter
CDC Factory 7.1
ActivEssentials Administration Guide
10-25
Prerequisites
Before doing this you need to have done the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Security Configuration module of AppCenter
as described in Opening the Security Configuration Module on page
10-14.
If necessary, open the Users grid by selecting the Object Library
in the Plant Hierarchy frame, and then clicking the Users icon
the Security Configuration frame.
Open the properties dialog box by right-clicking on the user in the
grid and selecting Properties.
Figure 10-10 The properties dialog box for a user
Procedure
To change the name or the description of the user, do the following:
1 To change the name of the user, click in the User name field and
edit the text.
There is a limit of 50 characters in the field, so you might have to
abbreviate the name.
2 To edit or provide the real name of a user, click in the Full name
field and edit the text.
Note: You can only edit the properties for users that you define.
Security in AppCenter
CDC Factory 7.1
ActivEssentials Administration Guide
10-26
3 To edit the description, click in the Description field and edit the
text.
To change the point in the Plant Hierarchy to which the user has
access, do the following:
1 Click the ellipsis button to the right of the Access level field.
The Plant Hierarchy Browser opens.
Figure 10-11 The Plant Hierarchy Browser
2 In the Plant Hierarchy frame, select the point at which the user
should have access the plant structure.
3 Click OK.
To modify the roles assigned to a user, do the following:
1 Click Roles Assigned.
The Roles editor opens with the already assigned roles appearing in
the right pane.
Note: Although you might select a level below the plant, if you view the users
assigned at the plant level, the user does appear there. This is because all
users belong to the Public Users (default) role, which gives all users the Read
Configuration privilege throughout the plant structure. The roles you assign to
the user and the privileges that accompany those roles only come into effect at
the level you assign the user.
Security in AppCenter
CDC Factory 7.1
ActivEssentials Administration Guide
10-27
Figure 10-12 The Roles editor
2 Do both of the following, as needed:
a) To assign a new role, select it in the left pane and click the Add
button.
b) To remove an already assigned role, select it in the right pane
and click the Remove button.
3 When finished, click OK.
You can also include the following details for the user:
1 If the user is someone who operators should contact, type their
e-mail address in the E-mail address field.
2 To set a limit on the time a user can work with ActivEssentials, type
the number of days in the Valid days field.
The default is Unlimited.
3 To ensure that the user can work with ActivEssentials, select the
Account enabled checkbox, at the bottom of the Roles editor.
You can also do this in the grid by selecting the checkbox in the
Enabled column.
Editing the Properties of a Role
Use the instructions below to edit the properties of a role.
Note: You can only edit the properties for roles that you define.
Security in AppCenter
CDC Factory 7.1
ActivEssentials Administration Guide
10-28
Prerequisites
Before do this you need to have done the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Security Configuration module of AppCenter
as described in Opening the Security Configuration Module on page
10-14.
If necessary, open the Roles grid by selecting the Object Library
in the Plant Hierarchy frame, and then clicking the Roles icon
the Security Configuration frame.
Open the properties dialog box by right-clicking on the role in the
grid and selecting Properties.
Figure 10-13 The properties dialog box for a role
Procedure
To rename a role or edit its description do the following:
To rename the role, click in the Name field and edit the text.
To change the description, click in the Description field and edit
the text.
To change the list of users who are assigned to the role, do the
following:
1 Click the Users Assigned button.
The Roles Editor opens.
Security in AppCenter
CDC Factory 7.1
ActivEssentials Administration Guide
10-29
Figure 10-14 The Roles editor
2 Do the following:
a) For each user you need to add to the role, select the user in the
left pane and click the Add button.
b) For each user you need to remove from the role, select the user
in the right pane and click the Remove button.
3 When finished, click OK.
Security in AppCenter
CDC Factory 7.1
ActivEssentials Administration Guide
10-30
Setting up Network Users
Instead of creating a user within MI Admin and assigning security to
that user, System Administrators and Security Administrators can add
network users and assign specific roles and privileges to them. These
users can be imported once you provide the domain and network
group to which they belong. Once these users are imported, they are
classified as trusted users. For more information on this, refer to
ActivEssentials Users on page 10-8.
This section covers the following topics:
Adding Network Domains on page 10-30
Adding Network Groups on page 10-31
Importing Network Users on page 10-33
Viewing and Editing Network Group Properties on page 10-36
Deleting a Network Group on page 10-38
Adding Network Domains
Use the following instructions to identify network domains that have
access to Activplant and that contain users to whom you want to grant
permissions. You add network domains by entering the location of the
directory service in the grid.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Security Configuration module of AppCenter
as described in Opening the Security Configuration Module on page
10-14.
Procedure
1 In the Plant Hierarchy frame, select the Object Library.
2 In the Network Configuration frame, click the Network
Domains icon.
The grid displays any network domains that have been previously
defined.
3 Using the grid, enter the following information for the network
domain:
a) Double-click in the Domain column and type a name for the
domain.
This can be any name, since the URL will point to the domain
location. However, for ease of use, you might want to use the
actual domain name.
Security in AppCenter
CDC Factory 7.1
ActivEssentials Administration Guide
10-31
b) Double-click in the URL column and type the location of the
directory service in the following format: LDAP://
domainname.com. Click the ellipsis button in the row to verify
that the URL is correct.
A box appears, confirming or not the URL location.
c) Double-click in the Description column to add a description for
the domain (optional).
d) Check the Active box to activate this domain in the Security
module.
If it is not active, you will not be able to add network groups
that belong to the domain.
Adding Network Groups
Use the instructions below to add a network group that belongs to a
configured network domain. You add network groups by finding a
group within a domain and then entering network details in the grid.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Security Configuration module of AppCenter
as described in Opening the Security Configuration Module on page
10-14.
Added the domain from which you want to import the network
users. See Adding Network Domains on page 10-30.
Procedure
1 In the Plant Hierarchy frame, select the Object Library.
2 In the Network Configuration frame, click the Network Groups
icon.
The grid displays any network groups that have been previously
added.
3 Click the down-arrow in the Domain column to select the Domain
from which you want to import the network group.
4 Click the ellipsis button in the Group Name column.
Note: Once a network group is added, any user within that group can log into
ActivEssentials. These users will have the default role and access, unless
otherwise specified. However, if an existing ActivEssentials user and a network
user have the same name, there is potential for that network user to overwrite
the existing user. See Handling User Name Duplication on page 10-35.
Security in AppCenter
CDC Factory 7.1
ActivEssentials Administration Guide
10-32
Figure 10-15 Select a Network Group dialog box
5 Select the group by doing one of the following:
a) If there are many groups within the domain, then select an
option from the drop-down list, type in part or all of the name
and click Find.
b) Scroll through the group names to find the ones that you want
and select it.
6 Click OK when you are finished selecting the network users.
The group displays in the grid.
7 Click in the Access Level column, then click the ellipsis button in
the row.
The Plant Hierarchy browser opens.
8 In the Plant Hierarchy frame, select the plant or group that the
group has permission to view, and click OK.
For more information, see Viewing and Editing Network Group
Properties on page 10-36 and Privileges and the Plant Hierarchy on
page 10-41 if specific users within the group require other access
or security.
9 Click in the Roles Assigned column, then click the ellipsis button
in the row.
The Assign Activplant Roles box opens.
10 Select the role for the network group, and click Add to add it to the
Assigned roles. Click OK when finished.
11 Check the Active box to activate the network group and
permissions for that group.
Security in AppCenter
CDC Factory 7.1
ActivEssentials Administration Guide
10-33
Importing Network Users
Use the instructions below to import users that belong to a defined
network group. You might choose to import all users in a network
group, or just a few users to whom you want to assign specific roles
and access. Importing is meant as a one-time process, since once
users are imported and assigned privileges, they become an
ActivEssentials user that can then be modified or assigned other
privileges like any other user. You can always import new users from
an existing network group.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Security Configuration module of AppCenter
as described in Opening the Security Configuration Module on page
10-14.
Created and defined network group using the instructions found in
Adding Network Groups on page 10-31.
Procedure
1 In the Plant Hierarchy frame, select the Object Library.
2 In the Network Configuration frame, click the Network Groups
icon.
The grid displays any network groups that have been previously
defined.
3 Select the network group that contains the users that you want to
import.
4 Right-click and select Import Network Users.
Security in AppCenter
CDC Factory 7.1
ActivEssentials Administration Guide
10-34
Figure 10-16 Import Network Users box
5 Choose the users that you want to import by doing one of the
following:
a) If there are many users in the group, then select an option
from the drop-down list to find the name. Type part or all of the
name and click Find.
b) Scroll through the users to find the one(s) that you want and
click the checkbox to select it.
6 If you do not want the default role, assign the roles to the users as
follows:
a) Uncheck the Use the default roles box, and click Edit Roles.
The Assign Activplant Roles page opens.
b) Select the roles that you want for this network group or user,
and click Add. When finished, click OK to close the Roles page.
7 If you do not want the default access level, assign the plant
hierarchy level to the users as follows:
a) Uncheck the Use the default access box, and click the ellipsis
button beside the field. The Plant Hierarchy browser opens.
b) Expand the plant hierarchy and select the group or asset to
which the user(s) will have access. When finished, click OK to
close the Plant Hierarchy browser.
Security in AppCenter
CDC Factory 7.1
ActivEssentials Administration Guide
10-35
8 Review your definition, and click OK when finished.
Handling User Name Duplication
Use the instructions below to handle the potential for user name
duplication between ActivEssentials users and network users. If a
network user and an ActivEssentials user have the same user name,
there is potential to overwrite the ActivEssentials user. By default, a
network user with an identical user name will not be able to log in.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
Open the System Configuration module as described in Opening
the System Settings Module on page 2-2.
Created Activplant users using the instructions in Creating a User
on page 10-16.
Added network users using the instructions in Importing Network
Users on page 10-33.
Procedure
1 In the secondary frame of the System Settings module, click the
System Properties icon.
The grid displays the system properties for your ActivEssentials
installation.
2 Locate the Overwrite Activplant User by Network User system
setting.
3 Double-click in the Value column to change the value.
If you change this value to 1, then a network user can always log
in, even it there is an existing user with that user name.
Viewing and Editing Network Domains
Use the instructions below to view and edit domain network
properties.
Note: Network (trusted) users will need to enter their domain and user name to log
into AppCenter.
Security in AppCenter
CDC Factory 7.1
ActivEssentials Administration Guide
10-36
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Security Configuration module of AppCenter
as described in Opening the Security Configuration Module on page
10-14.
Added a network domain to the Security module using the
instructions in Adding Network Domains on page 10-30.
Procedure
1 In the Plant Hierarchy frame, select the Object Library.
2 In the Network Configuration frame, click the Network
Domains icon.
The grid displays any network domains that have been previously
defined.
3 In the grid, select the domain whose properties you want to view.
Right-click and select Properties.
The Properties box dialog box opens.
4 Do each of the following as required:
a) Click in the Domain name field and type a new name.
b) Type a new URL for the directory service and click the
checkmark to verify the location.
c) Type a Description for the domain.
d) Check or uncheck the Active box to activate or deactivate the
domain.
Viewing and Editing Network Group
Properties
Use the instructions below to view or edit the properties of a network
group. By default, a network group and its users belong to the default
role (public users) with default access (the root of the plant). You can
change the groups access level and roles upon import, or update
access by editing the properties of the network group. To change the
access level and roles for a specific network user, see Editing the
Properties of a User on page 10-24.
Note: If you deactivate the domain, you will not be able to add network groups (or
users) that belong to the domain.
Security in AppCenter
CDC Factory 7.1
ActivEssentials Administration Guide
10-37
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Security Configuration module of AppCenter
as described in Opening the Security Configuration Module on page
10-14.
Added a network group to the Security module using the
instructions in Adding Network Groups on page 10-31.
Procedure
1 In the Plant Hierarchy frame, select the Object Library.
2 In the Network Configuration frame, click the Network Groups
icon.
The grid displays any network groups that have been previously
defined.
3 In the grid, right-click on the network group that you want to view
or edit and choose Properties.
The Properties dialog box opens.
Figure 10-17 Network properties dialog box
4 To change the access level assigned to the network group, do the
following:
a) Click the ellipsis button beside the Access level field.
The Plant Hierarchy browser window opens.
b) Browse to the location in the plant hierarchy that will be the
new access level, and click OK.
Security in AppCenter
CDC Factory 7.1
ActivEssentials Administration Guide
10-38
5 To change the roles assigned, do the following:
a) Click Roles Assigned.
The Assign Activplant Roles page opens.
b) Add or remove roles to the group by selecting the role from the
appropriate box and clicking Add or Remove. Click OK to close
the Roles page.
6 Click OK when you have finished reviewing the properties.
Deleting a Network Group
Use the instructions below to delete a network group from AppCenter.
This function only removes the network group from the Security
Configuration module; any previously imported users that are within
this network group will remain.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Security Configuration module of AppCenter
as described in Opening the Security Configuration Module on page
10-14.
Added a network group to the Security module using the
instructions in Adding Network Groups on page 10-31.
Procedure
1 In the Plant Hierarchy frame, select the Object Library.
2 In the Network Configuration frame, click the Network Groups
icon.
The grid displays any network groups that have been previously
defined.
3 In the grid, right-click on the select the network group that you
want to remove and select Delete.
A message appears asking if you want to delete the group.
4 Click OK.
The network group is removed from the grid.
Security in AppCenter
CDC Factory 7.1
ActivEssentials Administration Guide
10-39
Setting Privileges in the Plant Hierarchy
You probably do not want most of your users to have access to all the
areas and machines in your plant; more likely, you want to limit them
to certain areas, and to performing certain actions within those areas.
The ActivEssentials security system allows you to control the privileges
of roles and users at any point in the plant hierarchy. Each object
(plant, group, or asset) in the plant hierarchy has roles and users
assigned to it, and these determine what users can do at each point.
For more information about the plant hierarchy, see The Plant
Hierarchy Concept on page 3-3.
This section covers the following topics:
Assigning a Role to a Plant Hierarchy Object on page 10-39
Controlling User Access in the Plant Hierarchy on page 10-41
Privileges and the Plant Hierarchy on page 10-41
Assigning a Role to a Plant Hierarchy
Object
Use the instructions below to add a role to a plant hierarchy item (a
plant, group, or asset). If you add the role to an item that has child
items, the role is automatically applied to them also. If you want the
role to have access to the whole data collection system, apply it to the
top level of the plant hierarchy, the plant.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Security Configuration module as described
in Opening the Security Configuration Module on page 10-14.
Read How the Security Model Works on page 10-9.
Read Controlling User Access in the Plant Hierarchy on page 10-41.
Read Privileges and the Plant Hierarchy on page 10-41.
Procedure
1 In the Plant Hierarchy frame, navigate to and select the plant,
group, or asset to which you need to add the role.
2 Above the column headers, if necessary, select the Assigned Role
Privileges option.
The grid refreshes to display the roles that have already been
assigned.
Note: When you add a role to a plant hierarchy object, all the users belonging to the
role are automatically added. It saves time to add users to roles.
Security in AppCenter
CDC Factory 7.1
ActivEssentials Administration Guide
10-40
3 Right-click on any row in the grid, and select Assign Role.
The Assign Role to Hierarchy wizard opens.
4 Click Next to move past the welcome page.
Figure 10-18 The Role and Privileges wizard page
5 Click the down-arrow by the Roles field and select a role from the
list, then click the Privileges button.
The Edit Privileges dialog box opens, which lists all the available
privileges.
Figure 10-19 The Edit Privileges dialog box
6 In the Granted column, select the checkboxes for each privilege
that you need to grant to the role for the selected group or asset,
and then click OK.
7 Click Next.
The final page of the wizard opens.
Security in AppCenter
CDC Factory 7.1
ActivEssentials Administration Guide
10-41
8 Click Finish.
The newly added role appears in the grid.
Controlling User Access in the Plant
Hierarchy
When you select a plant hierarchy item, you can view entries for each
of the users who are able to work at that point in the plant, but from
this view you are not able to directly control which users have access.
Access is determined in two ways: namely, a user has to be assigned
to a role that in turn has been assigned for use with the plant, group,
or asset, and the user must have been granted access to the plant
hierarchy at the same level or at an ancestor level.
To control user access, you can do one of several things:
Disabling the user account. For a user to have access anywhere
in the Plant Hierarchy, the users account must be enabled. If you
need to temporarily disable an account, you can do this from the
Object Library. When you disable the account, the user still
appears in views from the Plant Hierarchy in the Security
Configuration task module, but the user would not be able to log
on.
Deleting the user account. You can delete a user account if it is
no longer needed. You do this from the Object Library of the
Security Configuration module, at which point all references to it
are removed from the Plant Hierarchy and the user cannot log on.
Reassigning the user in the Plant Hierarchy. Users only have
access to the Plant Hierarchy from the point where they are
assigned and at any descendant levels. You can change the point of
assignment, but you cannot completely remove a user from any
point in the Plant Hierarchy because all users are members of the
Public Users (default) role, which grants the Read Configuration
privilege throughout the plant. Changing the point of assignment
will set a limit to where the user can operate with whatever other
privileges a user might have.
Removing role assignment. A user must be assigned to a role,
and the role must be assigned to at least one point in the Plant
Hierarchy before the user can have access. If you remove the user
from all the roles to which they have been assigned (the user must
remain a member of the Public Users role), the user can then log
on only with the Read Configuration privilege.
Privileges and the Plant Hierarchy
You probably do not want most of your users to have access to all the
areas and machines in your plant; more likely, you want to limit them
to certain areas, and to performing certain actions within those areas.
In the Security Configuration module of AppCenter you can define the
roles and users that have access to different parts of the plant.
Security in AppCenter
CDC Factory 7.1
ActivEssentials Administration Guide
10-42
When you create roles and users you define nothing as regards the
privileges that they have. You define those privileges within the plant
hierarchy, by associating roles with plants, groups, and assets. You do
not assign users within the plant hierarchy, you only assign roles.
If you want the privileges assigned to a role to apply to all the groups
and assets in the plant, add the role to the plant. If you want the role
to apply to all the assets in a group, add the role to the group.
Because each plant hierarchy object inherits roles from its parent, you
automatically add the role to all the descendants of whichever plant or
group you choose. In other words, you choose a branch of the plant
hierarchy and add the role to it. Assets have no descendants, so if you
add a role to an asset it belongs only to the asset.
The following list highlights things you should consider when assigning
privileges:
Privileges. Both users and roles can be assigned privileges.
Roles and users. When assigning privileges to roles and users,
this occurs after selecting the plant, a group, or an asset in the
plant hierarchy. The privileges assigned apply at the selected level
and any descendant levels, but it is possible to override the
privileges (add or deny) at a lower level.
Users inherits privileges. As users also inherit the privileges
assigned to the roles to which they belong, users can have greater
privileges than the roles to which they are assigned.
Users in multiple roles. If a user is assigned to more than one
role, they acquire all of the privileges that are collectively available
to all of their roles.
Users and the Plant Hierarchy. Users are not assigned to plant
hierarchy items; they become associated by the roles to which
they belong. When a role is added at any level in the plant
hierarchy, they bring with them their users.
Users and the Public Users role (default role). All users
belong to the Public Users role, which, by default, is assigned at
least the Read Configuration privilege. The Public Users role is a
system role, and is assigned to all levels in the plant hierarchy, so
all users have at least the Public Users role privileges at every level
in the plant hierarchy.
System Roles and System Users
The Security Configuration module has some built-in roles and users
that are already assigned to certain parts of the hierarchy and to
particular tasks. For example, the whole hierarchy shares a System
Administrator role. You cannot edit these system roles and users.
Note: Before you can define privileges for groups and assets you must create any
roles you need beyond those provided as system roles. For information on how
to do this, see Creating Roles and Users on page 10-14.
Security in AppCenter
CDC Factory 7.1
ActivEssentials Administration Guide
10-43
You can see which are the system roles and users. Select a group or
asset in the plant hierarchy. To see the assigned roles, select the
Assigned Role Privileges option at the top of the grid, or to see the
users associated with assigned roles, select the Assigned User
Privileges option. If the role or user is system defined, an image of a
lock is superimposed over the icon to the left of the user of role name.
System Roles and the Plant Hierarchy
An ActivEssentials installation contains several system roles, which
you can view through the Object Library, but only a few of these roles
have application within the Plant Hierarchy. The ActivEssentials
database retains sole control over the system roles and assigns only
those in the Plant Hierarchy that have relevance there. For example,
roles that are purely administrative and deal only with global
configuration do not need access to the Plant Hierarchy. For this
reason, when assigning a role in the Plant Hierarchy, only unassigned,
user defined roles appear as an option.
Security in AppCenter
CDC Factory 7.1
ActivEssentials Administration Guide
10-44
Changing and Removing Roles, Users, and
Privileges
Within the plant hierarchy, objects inherit the roles, users, and
privileges that exist on their parent objects. This means that changes
made on a parent object affect the descendants too.
This section covers the following topics:
Changing the Privileges Assigned to a User on page 10-44
Changing the Privileges Assigned to a Role on page 10-46
The Principle of Inheritance on page 10-48
Rules for Changes on page 10-50
Inheritance of Granted Privileges on page 10-51
Inheritance of Denied Privileges on page 10-52
Interaction Between Role Privileges and User Privileges on page
10-53
Users with Overlapping Roles on page 10-54
Removing a Role From a Parent Group1 on page 10-54
Removing a Role From a Parent Group2 on page 10-55
Changing the Privileges Assigned to a
User
Use the instructions below to change the privileges given to a user at
any level of the plant hierarchy. When you make a change on a plant
or group that has descendants, the change will also apply to all the
descendants as well. You can either grant extra privileges, or revoke
ones that have been granted at a higher level in the hierarchy.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Security Configuration module of AppCenter
as described in Opening the Security Configuration Module on page
10-14.
Read about privileges in Granting, Denying, and Revoking
Privileges on page 10-10.
Procedure
1 In the Plant Hierarchy frame, navigate to and select the plant,
group, or asset to which the user has been assigned.
2 If necessary, at the top of the grid select the Assigned User
Privileges option.
The grid displays the users assigned to the object.
Security in AppCenter
CDC Factory 7.1
ActivEssentials Administration Guide
10-45
Figure 10-20 The Assigned User Privileges option
3 For the user whose privileges you need to change, click the cell in
the Privilege column, and then click the ellipsis button that
appears.
The User Privileges dialog box opens with details of the privileges
already assigned to the user.
Figure 10-21 The User Privileges dialog box
4 Click the Edit button.
In this dialog box, granted privileges show a checked checkbox,
while denied privileges are not checked.
Security in AppCenter
CDC Factory 7.1
ActivEssentials Administration Guide
10-46
Figure 10-22 The Edit Privileges dialog box
5 Do the following, as needed.
a) For privileges you need to grant, select the checkbox in the
Granted column.
b) For privileges you now need to deny, select the checkbox in the
Denied column.
6 When finished, click OK to both open dialog boxes.
Changing the Privileges Assigned to a
Role
Use the instructions below to change the privileges given to a role or
user at any level of the plant hierarchy. When you make a change on a
plant or group that has descendants, the change will also apply to all
the descendants as well. You can either grant extra privileges, or
revoke ones that have been granted at a higher level in the hierarchy.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Security Configuration module of AppCenter
as described in Opening the Security Configuration Module on page
10-14.
Read about privileges in Granting, Denying, and Revoking
Privileges on page 10-10.
Security in AppCenter
CDC Factory 7.1
ActivEssentials Administration Guide
10-47
Procedure
1 n the Plant Hierarchy frame, navigate to and select the plant,
group, or asset to which the role has been assigned.
2 If necessary, at the top of the grid select the Assigned Role
Privileges option.
The grid displays the roles assigned to the object.
Figure 10-23 The Assigned Role Privileges option
3 For the role whose privileges you need to change, click the cell in
the Privilege column, and then click the ellipsis button that
appears.
Figure 10-24 The User Privileges dialog box
4 Click the Edit button.
In this dialog box, granted privileges show a checked checkbox,
while denied privileges are not checked.
Security in AppCenter
CDC Factory 7.1
ActivEssentials Administration Guide
10-48
Figure 10-25 The Edit Privileges dialog box
5 Do the following, as needed.
a) For privileges you need to grant, select the checkbox in the
Granted column.
b) For privileges you now need to deny, select the checkbox in the
Denied column.
6 When finished, click OK to both open dialog boxes.
The Principle of Inheritance
The principle of inheritance applies both to roles and users on the one
hand, and to levels in the plant hierarchy on the other.
Inheritance Between Roles and Users
A user who belongs to a role inherits the privileges assigned to that
role at any particular point in the plant hierarchy. The privileges can,
however, be modified for individual users; privileges that are denied in
the role can be granted, and privileges that are granted in the role can
be revoked.
Inheritance in the Plant Hierarchy
If you make changes to a privilege set on a plant or group that has
descendants, the principle of inheritance makes the changes cascade
down to each child of the plant or group. This rule applies wherever
Note: Both granted privileges and denied privileges are inherited in the ways
described here.
Security in AppCenter
CDC Factory 7.1
ActivEssentials Administration Guide
10-49
you are in the plant hierarchy. At the asset level (the lowest level of
the hierarchy), the privileges are a composite of all the assignments
and changes that were made on the ancestors of those assets.
The principle of inheritance for plant hierarchy objects is shown in the
following table. In this case, a single role is added to the
ActivEssentials (plant) level, then changes are made at lower levels of
the hierarchy.
With no further intervention, all the descendants of the Body Shop
(the Painting Line and Station 1) would have the same privileges for
the Operator role, because they are inherited. But in the example
above, the administrator has made two changes at the Painting Line
level:
Granted Insert. This brings the privileges of the Operator role on
the Painting Line to 1110that is, Read, Update, Insertbut this is
modified by the next change.
Revoked Update. This brings the privileges of the Operator role on
the Painting Line to 1010that is, Read, Insert. This is the final
result of the changes for the Painting Line.
Station 1 is a descendant of the Body Shop and of the Painting Line.
The Operator role on Station 1 inherits the privileges that exist for the
role on the Painting Line (1010); but the administrator has also
granted the Delete privilege on Station 1. The Operator role on the
Painting Line therefore has the privileges 1011that is, Read, Insert,
Delete.
This is a simple scenario. For more complicated scenarios, see the
following topics.
Table 10-6 Inheritance of privileges in the plant hierarchy
Plant Hierarchy Grante
d
Extra
Grante
d
Revoke
d
Result Explanation
R
e
a
d
U
p
d
a
t
e
I
n
s
e
r
t
D
e
l
e
t
e
R
e
a
d
U
p
d
a
t
e
I
n
s
e
r
t
D
e
l
e
t
e
R
e
a
d
U
p
d
a
t
e
I
n
s
e
r
t
D
e
l
e
t
e
R
e
a
d
U
p
d
a
t
e
I
n
s
e
r
t
D
e
l
e
t
e
ActivEssentials
(plant)
1 1 0 0 Role privileges for
the whole plant.
Body Shop 1 1 0 0 Privileges inherited
from the plant.
Painting
Line
0 0 1 0 0 1 0 0 1 0 1 0 Insert added to
parent set; Update
revoked.
Statio
n 1
0 0 0 1 1 0 1 1 Delete added to
parent set.
Security in AppCenter
CDC Factory 7.1
ActivEssentials Administration Guide
10-50
Rules for Changes
Here is a brief summary of the rules that apply when you change
privileges for roles or users. In most cases you are referred to a
scenario that demonstrates the rule.
1 Adding a role to a plant hierarchy object automatically adds all the
users that belong to that role, and each user has the privileges
accorded by the role. See Inheritance of Granted Privileges on
page 10-51.
2 Both the granting and the denying of privileges are inherited. A
privilege that is granted on a higher level is granted on a lower
level. A privilege that is denied on a higher level is denied on the
lower level. See Inheritance of Denied Privileges on page 10-52.
3 The privileges in force for a role at a lower level of the plant
hierarchy are a combination of the assignments and changes made
at higher levels, and any changes made on the lower level itself.
See Inheritance of Granted Privileges on page 10-51.
4 A users privileges at any point in the plant hierarchy are the sum
of the privileges and denials accorded by the role to which he/she
belongs, in combination with any user privileges granted or denied
at the same or higher levels of the hierarchy. See Interaction
Between Role Privileges and User Privileges on page 10-53.
5 If a user belongs to more than one role, the privileges assigned to
the user are the sum of all the privileges in the roles. See Users
with Overlapping Roles on page 10-54.
6 A user inherits privileges from the role to which he/she belongs. If
the role privileges have been modified on a higher level, the users
privileges are also modified accordingly. See Interaction Between
Role Privileges and User Privileges on page 10-53.
7 Deleting a role from a plant hierarchy object automatically removes
all the users that belong to the role, so long as no extra privileges
have been granted to the users.
8 If privileges have been granted to a user that are extra to the role
privileges, deleting the role will not result in deletion of the user.
See Interaction Between Role Privileges and User Privileges on
page 10-53.
9 If you delete a role from a group that has descendants, it will not
be deleted from any descendants on which extra privileges have
been granted; it will remain on those descendants. See Removing a
Role From a Parent Group1 on page 10-54.
10 If you delete a role from a group that has descendants, it will also
be deleted from all those descendants which do not have extra
privileges granted within the role. See Removing a Role From a
Parent Group2 on page 10-55.
Security in AppCenter
CDC Factory 7.1
ActivEssentials Administration Guide
10-51
Inheritance of Granted Privileges
The following examples use a sample plant hierarchy containing five
levels; two roles (Role1 and Role2); and two users (User1 and User2).
User1 is a member of Role1 only; User2 is a member of Role1 and
Role2.
At first, the hierarchy only has the system roles and users assigned.
The next step is to assign Role1 to Parent Group. When doing this, we
click the Privileges button in the wizard and assign privileges 1 and 5
to Role 1. This automatically assigns it to all the descendants of Parent
Group.
Note that when you assign the role to a plant hierarchy object, the grid
shows the role and the users that belong to itin this case, both User1
and User2.
All the descendants of Role1 receive Role 1, and in each case Role1
users have the same privileges. The figure shows the grid for Asset
Level, but the same appears for Level 2, Level 3, and Level 4.
Table 10-7 Users and their roles in the examples
User Rol
e1
Role
2
Use
r1
X
Use
r2
X X
Security in AppCenter
CDC Factory 7.1
ActivEssentials Administration Guide
10-52
Now we edit the privileges for Role1 on Level 2. Because this is a
descendant of Parent Group, Role1 at present has privileges 1 and 5
on this group. On Level 2 we add privileges 2 and 4. Note that in the
Granted column, the privileges that are inherited from Parent Group
are checked and greyed.
Now Parent Group has privileges 1 and 5, but all the descendants of
Level2 (and Level2 itself) have privileges 1, 2, 4, and 5. Note that for
Level 2s descendants, all these are inherited privileges, so the boxes
are again greyed.
Inheritance of Denied Privileges
Privileges that are denied to a role or user on a higher level object are
also denied on a descendant. However, they can be granted on the
descendant. If they are, the levels below that inherit the granted
privileges also.
To illustrate this, we assign Role1 to Parent Group, with privileges 1, 2,
3, 4, and 5. Then on Level 2 we deny privilege 3.
We now check Level 3 and find that Role1 on this object (and all the
other descendants of Level2) has privileges 1, 2, 4, and 5. Note also
that you can grant the denied privilege again on Level 3, by clicking in
the Granted checkbox for this privilege.
Security in AppCenter
CDC Factory 7.1
ActivEssentials Administration Guide
10-53
Interaction Between Role Privileges and
User Privileges
In this scenario, we give a user certain privileges on a lower level of
the plant hierarchy, then superimpose role privileges on a higher level.
First, we assign User1 to the lowest level of the hierarchy, giving him
privileges 1 and 5 only.
Next, we assign Role1 (which includes User1) to the top level, and
grant privileges 2, 3, and 4.
We now check User1s privileges on the Asset Level and find that they
are 1, 2, 3, 4, and 5. Some of these (1 and 5) are User 1s personal
privileges, granted at this level, while others are derived from the role
to which User1 belongs.
The converse of this rule also applies. If you add privileges to a user at
a lower level, then remove the role from the upper level, only the
extra privileges that you added remain. The following example
illustrates this.
First, we add Role1 to Parent Group with privileges 1 and 5 only. Then,
on the lowest level, we edit User1s privileges, adding 2, 3, and 4.
User1 now has all five privileges on the Asset Level. Two of them are
inherited from Parent Group.
We now delete Role1 from Parent Group and check User1s privileges
again on Asset Level. User1 still remains on Asset Level because of the
extra privileges, but privileges 1 and 5 (which were inherited from
Role1) have now been removed.
Security in AppCenter
CDC Factory 7.1
ActivEssentials Administration Guide
10-54
Users with Overlapping Roles
In this scenario we look at the effect of denying privileges for a user
that has overlapping roles. The user User2 belongs to two roles, Role1
and Role2.
First, we add Role1 to Parent Group, with privileges 1, 2, 3, 4, and 5.
Then we add Role2 to Parent Group with privileges 2, 3, and 4.
Because User2 belongs to both roles, he has the privileges 1, 2, 3, 4,
and 5, and they overlap within the two roles.
On Level 2 we now edit User2s privileges, denying User 2 privileges 2,
3, and 4. This effectively removes the privileges associated with Role2.
Note that we are editing the users privileges, not the roles. A check
on User2s privileges at Level2 (and all its descendants) shows that
User 2 has only privileges 1 and 5.
Now we remove Role1 from the Parent Group. This potentially removes
all five privileges from User1. But Role2 still remains (with privileges 2,
3, and 4). A check of User2s privileges reveals that he now has no
active privileges. Privileges 2, 3, and 4 remain, but they are still
denied. The denials have been retained, and can be revoked at any
time by removing the checkmarks in the Deny column.
Removing a Role From a Parent Group1
This section follows from the previous section. In that section, Parent
Group had Role1 assigned to it with privileges 1 and 5. Level 2 also
had privileges 2 and 4 assigned to Role1, so it and its descendants had
privileges 1, 2, 4, and 5. In other words, the descendants of Parent
Group had extra privileges granted.
What happens if we now delete Role1 from Parent Group? What
happens to the privileges on Level2 and its descendants?
Security in AppCenter
CDC Factory 7.1
ActivEssentials Administration Guide
10-55
Because Role1 on Level 2 had extra privileges granted (in this case 2
and 4), deleting Role1 from Parent Group removes only the inherited
privileges, i.e. 1 and 5. So a check of Level 2 reveals that Role1 still
exists on this group, but the privileges assigned are restricted to those
that were specifically granted to it.
On the other hand, if we now delete Role1 from Level 2, it is
automatically deleted from all its descendants, because they have no
privileges that are extra to those of Level 2.
Removing a Role From a Parent Group2
In this section we take the reverse situation from that described in
Removing a Role From a Parent Group1 on page 10-54. In that
situation, descendants of Parent Group had extra privileges granted.
In the present example, we see what happens if the descendants of
Parent Group have fewer privileges because some of them have been
denied.
First, we assign Role1 to the Parent Group as before, but we give it
privileges 1, 2, 3, 4, and 5. We now edit the privileges that Role1 has
on the Level 2 group, denying 2 and 4. Note that on Level 2 all the
Granted privileges are checked and greyed, because they are inherited
from Parent Group.
A check on any of the descendants of Level 2 now shows that Role1
has only privileges 1, 3, and 5, and they are all inherited. This is
because these objects inherit the Granted privileges from Parent
Group and the denials (2 and 4) from Level 2.
Note: Role1 continues to be assigned to Level2 and its descendants because there
were extra privileges assigned on those groups. If Role1 had fewer privileges
there than on Parent Group, there would be no point in maintaining Role1 on
Level2, and it would be deleted there also.
Security in AppCenter
CDC Factory 7.1
ActivEssentials Administration Guide
10-56
If we now delete Role1 from Parent Group, it is also deleted from all
the descendants. This is because there were no extra privileges
granted on the lower groups; all the changes were denials. In fact, it
was not possible to grant any extra privileges on the lower groups
because Parent Group already had all the privileges granted.
Improving Access to LDAP/Active Directory
To improve access to domain and sub-domain resources, do the
following:
Connect to a Remote Domain
Improve Performance for Larger Networks
Connecting to a Remote Domain
To authenticate users, ActivEssentials requires access to a remote
domain. Do the following to enable ActivEssentials to access the
remote domain:
1 Browse to C:\Program Files\Activplant
Corporation\Activplant\Services\Administration and open
AdministrationWinService.exe.config using a text editor.
2 Modify the following Appsettings parameters:
a) LDAPUser The LDAP\Windows user account used for
authentication.
b) LDAPPassword The password of the LDAPUser.
3 Save AdministrationWinService.exe.config.
4 Restart ActivEssentials services in the following order:
a) Activplant Security Service
b) Activplant Administration Service
Improving Performance for Larger
Networks
Companies with larger networks may experience slower response
times due to the large number of LDAP/network groups. To limit the
number of returned LDAP/network groups, do the following:
1 Browse to C:\Program Files\Activplant
Corporation\Activplant\Services\Administration and open
AdministrationWinService.exe.config using a text editor.
2 Modify the following Appsettings parameters:
a) LDAPBrowseGroupLimit By default, this parameter returns
1000 groups. Change this value to return more or less groups.
b) DisableFindAllLDAPBrowse Prevents ActivEssentials from
retrieving network groups, until a filter is defined. By default,
this is set to False.
3 Save AdministrationWinService.exe.config.
Security in AppCenter
CDC Factory 7.1
ActivEssentials Administration Guide
10-57
4 Restart ActivEssentials services in the following order:
a) Activplant Security Service
b) Activplant Administration Service
CDC Factory 7.1
ActivEssentials Administration Guide
11-1
Extended Properties of Groups and Assets
Extended Properties of Groups and Assets
CDC Factory 7.1
ActivEssentials Administration Guide
11-2
Introduction to Extended Properties of Groups
and Assets
In the Extended Properties module of AppCenter you can create
properties of plants, groups, or assets. These properties are viewable
in VPWeb. You can also define extended properties for asset
templates. Extended properties allow you to associate files, links, and
other features with individual plant hierarchy items. Defining these
properties is optional; they are not required for the operation of your
data collection system, but they enhance the system in many ways.
This chapter covers the following topics:
The Extended Properties Module on page 11-2
Using Extended Properties in the Plant Hierarchy on page 11-5
The Extended Properties Module
The Extended Properties module has an interface that is very similar to
most of the other modules in MI Admin. Users are able to work with
groups and assets, and asset templates, where they can define the
extended properties.
This chapter covers the following topics:
The Interface on page 11-2
Data Collection Defined in ActivApplications on page 11-3
The Interface
The interface is laid out in a very similar manner to many of the other
modules in MI Admin: here you can create extended properties and
assign them to plant hierarchy items or asset templates. Any
configuration you can create at any group or asset, you can also do
with the templates that appear under the ActivApplication item in the
Plant Hierarchy frame.
Note: These are extended properties; they are not the same as the properties of
plants, groups, or assets that you give to them when you define them in the
Plant Management module.
Extended Properties of Groups and Assets
CDC Factory 7.1
ActivEssentials Administration Guide
11-3
Legend
Toolbar. The toolbar contains the standard MI Admin toolbar
buttons, and those that are appropriate for the operation of the
Extended Properties module.
Taskbar. The taskbar contains links to the other modules in MI
Admin.
Plant hierarchy. The plant hierarchy is a graphical representation of
the organizational structure of your plant, and includes the
organizational groupings and assets in the plant.
ActivApplications. Below the ActivApplications item is a listing of
the defined applications that run within your ActivEssentials
installation, and below these are the asset templates that are used
to configure and maintain your assets.
Grid. The grid contains a listing of any defined extended properties
for the item selected in the Plant Hierarchy frame.
Data Collection Defined in
ActivApplications
Under the ActivApplications item in the Plant Hierarchy frame are the
asset templates that have been defined for use in your ActivEssentials
installation. Asset templates contain model data collection
configuration for specific applications. The applications can be
ActivApplications you purchased from CDC Factory, or they could be
applications you develop yourself.
In the Extended Properties module, you treat the template items,
which appear at the third level down as you expand the
ActivApplications tree, as if they are assets. You can create extended
properties just as you might for an asset and apply it to a template.
These templates can only be created in the Plant Configuration
module. Although you can apply extended properties to the templates
in the same way as you can to assets, templates do not collect data.
Extended Properties of Groups and Assets
CDC Factory 7.1
ActivEssentials Administration Guide
11-4
If the applications and templates are a part of an imported application,
you should not change any aspect of the configuration without
understanding how this affects data collection as it relates to the
purpose of the application. You should only make changes to a
template item if absolutely necessary.
Extended Properties of Groups and Assets
CDC Factory 7.1
ActivEssentials Administration Guide
11-5
Using Extended Properties in the Plant Hierarchy
You can create extended properties and apply them to any item in the
plant hierarchy, from the plant down to the asset level.
This section covers the following topics:
Opening the Extended Properties Module on page 11-5
Creating Extended Properties for a Plant or Group on page 11-5
Creating Extended Properties for Assets on page 11-7
Editing Extended Properties of Plants, Groups, or Assets on page
11-10
Copying an Extended Property on page 11-11
Deleting an Extended Property of a Plant, Group, or Asset on page
11-12
Types of Extended Properties on page 11-12
Opening the Extended Properties Module
Use the instructions below to open the Extended Properties module of
AppCenter. In this module you can create or modify properties of
plants, groups, or assets in your data collection system.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
Read Types of Extended Properties on page 11-12.
Procedure
1 In the taskbar, click the System category button.
The taskbar refreshes to display the task modules in the System
category.
2 In the taskbar, click the Extended Properties icon.
The Extended Properties module displays the plant hierarchy and
any properties that have been defined for the selected plant,
group, or asset. There is no Object Library in this module.
Creating Extended Properties for a Plant
or Group
Use the instructions below to create extended properties for a plant or
group.
Note: This procedure does not allow you to create extended properties on assets.
For more information on this, see Creating Extended Properties for Assets on
page 11-7.
Extended Properties of Groups and Assets
CDC Factory 7.1
ActivEssentials Administration Guide
11-6
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Extended Properties task module using the
instructions in Opening the Extended Properties Module on page
11-5.
Read Types of Extended Properties on page 11-12.
Procedure
1 In the Plant Hierarchy frame, navigate to and select the plant or
group to which you need to add extended properties.
The grid displays any properties that have already been defined.
2 Do one of the following:
a) Click the New button on the toolbar, or
b) Right-click in the grid and choose New.
The Add New Extended PropertiesGroup wizard starts.
3 Click Next to move past the welcome page.
Figure 11-1 The Name and Description page of the wizard
4 Enter a name (up to 50 characters) and, if desired, a description
(up to 255 characters) for the property.
5 Click Next.
The Property Type and Value page of the wizard opens.
6 Click the down-arrow by the Property type field and choose the
property type that you want to create.
Extended Properties of Groups and Assets
CDC Factory 7.1
ActivEssentials Administration Guide
11-7
Figure 11-2 The Property Type and Value wizard page
7 Follow the instructions below for the type of property that you are
creating.
a) To create a Text property, choose Text and type the text in the
Property value field.
b) To create a File property, choose File, then click the ellipsis
button by the Property value field. Navigate to the desired file
and click Open.
c) To create a Web Link address, choose Web link and type the
address in the Property value field. Use the web address
without any preceding protocol, e.g. www.activplant.com.
d) To create an E-mail link, choose E-mail address and type the
address in the Property value field. Use the format
[email protected], without any preceding protocol.
e) To create a Color property, choose Color and click the ellipsis
button by the Property value field. Choose a color from the
Color dialog box, then click OK.
f) To create a Number property, choose Number and enter the
number in the Property value field.
8 Click Next.
The final page of the wizard opens.
9 Review the new property, then click Finish to save it.
Creating Extended Properties for Assets
Use the instructions below to create extended properties for an asset.
Note: Sometimes the information for the new property is misaligned in the grid. Click
the Refresh button (or press F5) to align it correctly.
Extended Properties of Groups and Assets
CDC Factory 7.1
ActivEssentials Administration Guide
11-8
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Extended Properties task module using the
instructions in Opening the Extended Properties Module on page
11-5.
Read Types of Extended Properties on page 11-12.
Procedure
1 In the Plant Hierarchy frame, navigate to and select the asset to
which you need to add extended properties.
The grid displays any properties that have already been defined.
2 Do one of the following:
a) Click the New button on the toolbar, or
b) Right-click in the grid and choose New.
The Add New Extended PropertiesAsset wizard starts.
3 Click Next to move past the welcome page.
Figure 11-3 The Name and Description page of the wizard
4 Enter a name (up to 50 characters) and, if desired, a description
(up to 255 characters) for the property.
5 Click Next.
The Property Type and Value page of the wizard opens.
6 Click the down-arrow by the Property type field and choose the
property type that you want to create.
Extended Properties of Groups and Assets
CDC Factory 7.1
ActivEssentials Administration Guide
11-9
Figure 11-4 The Property Type and Value wizard page
7 Follow the instructions below for the type of property that you are
creating.
a) To create a Text property, choose Text and type the text in the
Property value field.
b) To create a File property, choose File, then click the ellipsis
button by the Property value field. Navigate to the desired file
and click Open.
c) To create a Web Link address, choose Web link and type the
address in the Property value field. Use the web address
without any preceding protocol, e.g. www.activplant.com.
d) To create an E-mail link, choose E-mail address and type the
address in the Property value field. Use the format
[email protected], without any preceding protocol.
e) To create a Color property, choose Color and click the ellipsis
button by the Property value field. Choose a color from the
Color dialog box, then click OK.
f) To create a Number property, choose Number and enter the
number in the Property value field.
8 Click Next.
The final page of the wizard opens.
9 Review the new property, then click Finish to save it.
Note: Sometimes the information for the new property is misaligned in the grid. Click
the Refresh button (or press F5) to align it correctly.
Extended Properties of Groups and Assets
CDC Factory 7.1
ActivEssentials Administration Guide
11-10
Editing Extended Properties of Plants,
Groups, or Assets
Use the instructions below to view and edit the extended properties
that have been defined for plants, groups, or assets in the plant
hierarchy. You can also edit properties directly in the grid. Click or
double-click in the grid and enter the information.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Extended Properties task module using the
instructions in Opening the Extended Properties Module on page
11-5.
Read Types of Extended Properties on page 11-12.
Procedure
1 In the Plant Hierarchy frame, navigate to and select the plant,
group, or asset for which you need to edit the extended properties.
The grid displays any properties that have already been defined.
2 Right-click on a property in the grid and select Properties.
A properties dialog box opens.
3 Edit the properties as desired.
Note: If you change Property type the options change in the dialog box. For
information on the types of properties you can choose, see Types of Extended
Properties on page 11-12. For information on how to define different kinds of
properties, see Creating Extended Properties for a Plant or Group on page
11-5.
Extended Properties of Groups and Assets
CDC Factory 7.1
ActivEssentials Administration Guide
11-11
4 When finished, click OK.
Copying an Extended Property
Use the instructions below to copy an extended property. You can copy
the property to a different part of the plant hierarchy, or to the same
place in the hierarchy. If you copy to a plant or group, you have the
option to add the property to all the plants or groups descendants as
well.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Extended Properties task module using the
instructions in Opening the Extended Properties Module on page
11-5.
Procedure
1 In the Plant Hierarchy frame, navigate to and select the plant,
group, or asset whose extended properties you need to copy.
The grid displays any properties that have already been defined.
2 Right-click on the property and select Copy.
Note: The Properties dialog box
Extended Properties of Groups and Assets
CDC Factory 7.1
ActivEssentials Administration Guide
11-12
3 Navigate to and select the plant, group, or asset to which you want
to paste the property. If you are copying to the same object from
which you copied, click in the grid.
4 Right-click in the grid and choose Paste.
Deleting an Extended Property of a Plant,
Group, or Asset
Use the instructions below to delete an extended property of a plant,
group, or asset.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Extended Properties task module using the
instructions in Opening the Extended Properties Module on page
11-5.
Procedure
1 In the Plant Hierarchy frame, navigate to and select the plant,
group, or asset whose extended properties you need to delete.
The grid displays any properties that have already been defined.
2 Right-click a property in the grid and select Delete.
A confirmation dialog box opens.
3 Click OK.
Types of Extended Properties
The following types of extended properties can be added to any group
or asset in the plant hierarchy. For more information about defining
them, see Creating Extended Properties for Assets on page 11-7.
Text. Enter any text that you want to be viewable in VPWeb.
File. This option informs VPWeb users of the location of the file.
They cannot open it using VPWeb, but they can use the appropriate
application on their computer (if it is installed) to open it. If the
Extended Properties of Groups and Assets
CDC Factory 7.1
ActivEssentials Administration Guide
11-13
administrator has set the AppCenter options to allow
non-AppCenter documents to display in AppCenter, users may be
able to view the file in AppCenter.
Web link. This creates a hyperlink to a web page on your intranet
or on the Internet. A VPWeb user can navigate to the page by
clicking the link.
E-mail address. You can specify an e-mail link so that when the
VPWeb user clicks it, their e-mail application creates a message
addressed to the address that you specified.
Color. This property places a swatch of the color in VPWeb. It can
be used, for example, to remind a VPWeb user of the color of the
batch being produced.
Number. You can use this property to indicate a serial number for a
machine, etc.
CDC Factory 7.1
ActivEssentials Administration Guide
12-1
Schedules and Real-time Triggers
Schedules and Real-time Triggers
CDC Factory 7.1
ActivEssentials Administration Guide
12-2
Introduction to Schedules and Real-Time
Triggers
ActivEssentials includes scheduling options and real-time triggers for
initiating tasks. Schedules provide a vehicle for running, at a particular
time, any number of previously defined tasks, whereas real-time
triggers provide a reactive way of initiating tasks at the moment a
Boolean expression turns TRUE. Both methods initiate tasks, but one
runs tasks predictably whereas the other can start tasks at any time.
For schedules, there are two kinds you can create: those that operate
within the ActivEssentials database, and those that run as jobs in SQL
Server. While the interface for defining both kinds of schedule is the
same, the module you access determines which kind of schedule you
create. In the Schedules & Real-time Triggers task module, you deal
only with schedules that run within the ActivEssentials database.
Schedules that perform archive and purge activities are defined in the
Data Management task module; these schedules are run as jobs in
SQL Server. For more information about the Data Management
schedules, see The Archive and Purge Jobs on page 13-44.
For real-time triggers, you create expressions that focus on specified
real-time data items. Real-time triggers require ActivEssentials to
constantly monitor the real-time data items; at the moment a data
item value equates to the defined value in the Boolean expression, the
task begins.
This chapter covers the following topics:
The Interface on page 12-2
Scheduling ActivEssentials Tasks on page 12-9
Creating Schedules on page 12-13
Defining and Maintaining Trigger Items on page 12-21
Maintaining Schedule Configuration on page 12-17
The Interface
The Schedules & Real-time Triggers module consists of two views: one
for the defined schedules and the other for the real-time triggers. The
interface takes its focus from your selection in the Object Library
frame.
This section covers the following topics:
Opening the Schedules & Real-Time Triggers Module on page 12-3
Updating Changes in Schedules & Real-Time Triggers on page 12-3
The Schedules & Real-Time Triggers Interface on page 12-3
The Icons in the Grid on page 12-5
Toolbar Buttons and Context Menu Items on page 12-6
Schedules and Real-time Triggers
CDC Factory 7.1
ActivEssentials Administration Guide
12-3
Opening the Schedules & Real-Time
Triggers Module
Use the instructions below to open the Schedules & Real-time Triggers
task module.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
Read the following:
The Schedules & Real-Time Triggers Interface on page 12-3
Schedule Structures on page 12-9
Questions to Ask When Creating a Schedule on page 12-11
Examples of Schedules on page 12-11
Procedure
1 In the taskbar, click the System category button.
The taskbar refreshes to display icons for the task modules in the
System category.
2 In the taskbar, click the Schedule & Real-time Triggers icon.
The Schedule & Real-time Triggers interface opens.
Updating Changes in Schedules &
Real-Time Triggers
When you make changes in Schedules & Real-time Triggers, you must
update the underlying scheduling service. Upon starting, the
scheduling service reads its configuration, but does not automatically
reload this configuration at any automated interval. In order to load
any changes you make in Schedules & Real-time Triggers, you must
update the service by clicking the Update Delivery Service button on
the toolbar.
The Schedules & Real-Time Triggers
Interface
Schedules & Real-time Triggers is a task module within MI Admin, and
has a layout that is very similar to other task modules. Within this
module you can create and maintain schedules that handle many
activities in ActivEssentials, and create real-time triggers that you can
use to initiate tasks. See the image below for more information about
the layout of the interface.
Schedules and Real-time Triggers
CDC Factory 7.1
ActivEssentials Administration Guide
12-4
Schedules and Real-time Triggers
CDC Factory 7.1
ActivEssentials Administration Guide
12-5
Legend
Schedule and Real-Time Triggers icon. Click this to open the task
module.
Object Library. This contains the Schedules and Real-time Triggers
categories. There is no representation of the plant hierarchy in
Schedules & Real-time Triggers.
New button. Click this to start the either the New Schedule or New
Real-time Trigger wizards.
Properties button on the toolbar; use this to view or modify the
properties of the selected schedule or real-time trigger.
Row icons. The icons in this column indicate the kind of schedule
(by time or by production shift), or Real-time Trigger (can be
generated from a template), and indicate if the item is active or
not.
Name. The name of the schedule or real-time triggerit must be
unique.
Data Item column. If you select a cell, you can open a dialog box
that allows you to browse to and select the data item used in the
trigger.
Trigger Definition column. If you select a cell, you can then open a
dialog box where you can define the trigger. Triggers are Boolean
expressions, so they must equate to either TRUE or FALSE.
Minimum Duration column. This defines the minimum period that a
trigger must be in a TRUE condition before the trigger turns ON.
Delay column. This defines the wait period before the triggered
action appears.
Active column. The checkboxes in this column let you enable or
disable the selected schedule or real-time trigger.
Schedule Type column. The schedule type is the frequency
definition type for the selected schedule (daily, weekly, or
monthly). You can change this by selecting a cell and then clicking
the down-arrow to reveal a drop-down list.
Schedule Option column. If you select a cell, you can then open a
dialog box where you can edit various aspects of the schedule
frequency.
The Icons in the Grid
The icons in the grid let you know what kind of schedule (the schedule
category) or real-time trigger is represented in the grid, and its
present status.
Schedules and Real-time Triggers
CDC Factory 7.1
ActivEssentials Administration Guide
12-6
Toolbar Buttons and Context Menu Items
You can access the actions available in Schedule and Real-time
Triggers through the toolbar buttons and context menu items. The
toolbar contains the complete set of actions, but you can also access
most of the commonly needed actions from the right-click context
menu. The Schedule and Real-time Triggers toolbar and typical context
menus appear in the following figure:
Table 12-1 Icons used in the grid
Icon Description
Active By Time schedule The schedule is active and one that runs at
specified dates and times.
Inactive By Time schedule The schedule is inactive, but if activated would
run at specified dates and times.
Active Real-time Trigger The trigger is active and available for use.
Inactive Real-time Trigger The trigger is deactivated, and so is unavailable
for use.
Active Template-defined
Real-time Trigger
The trigger is active and available for use.
Template-defined triggers
1
work only with the
trigger definition that was created with the
original trigger.
1. Template triggers do not appear anywhere in the Schedules & Real-time
Triggers interface. You cannot edit their configuration or delete them from
ActivEssentials.
Inactive Template-defined
Real-time Trigger
The trigger is deactivated, and so is unavailable
for use.
New Row You can define a new schedule by clicking or
double-clicking in each of the cells and entering
the required information. You can use this
method instead of using the Add New Schedule
wizard.
Schedules and Real-time Triggers
CDC Factory 7.1
ActivEssentials Administration Guide
12-7
Figure 12-1 Toolbar and context menu items
Table 12-2 The Schedules & Real-time Triggers toolbar buttons and context
menu items
Toolbar buttons
and context
menu items
Description Context menu?
New Button Depending on where you are interface, this
button initiates either the Add New Schedule or
Add New Real-time Trigger wizard.
Yes
Copy button This button lets you copy the selected schedule
or real-time trigger.
Yes
Paste button This button lets you paste into the grid the
configuration of a schedule or real-time trigger.
When you do this, the newly pasted schedule is
the same as the original, except for the name;
the term Copy of is added to the original
schedule name.
Yes, but only
if there is
something to
paste.
Delete button This button allows you to delete an existing
schedule or real-time trigger.
Yes
Find button This button opens the Find tab on the Find/
Replace dialog box. You can type a string and
then search through all of the cells in the Name
column for the search term. The search finds
the first row in which the string occurs, but you
can click the Find Next button to move to the
next occurrence.
No
Replace button Use this button to open the Replace tab on the
Find/Replace dialog box, where you can search
for a string and replace it with another.
No
Schedules and Real-time Triggers
CDC Factory 7.1
ActivEssentials Administration Guide
12-8
Update Delivery
Service button
This button initiates a refresh for any changes
to both the schedules and real-time triggers.
After clicking the button, the database confirms
the actions or provides a reason if the action
fails. The button is not item specific, so you do
not need to select a particular row in the grid
before clicking the button.
No
Properties
button
This button opens a properties dialog box for
the selected item in the grid (schedule or
real-time trigger). Within the dialog box, you
can change many of the properties. You can also
make these changes through the grid.
Yes
Save as
Template
This appears as a context menu item against
only those new real-time triggers that were
created, or ones that are a copy of another new
real-time trigger. Triggers that were created
from a template do not have this option.
Yes
Table 12-2 The Schedules & Real-time Triggers toolbar buttons and context
menu items
Toolbar buttons
and context
menu items
Description Context menu?
Note: Most of the actions you can access from the toolbar, but you can also access
most of them by right-clicking on a schedule or trigger and choosing a menu
item. To simplify the procedures that follow, most procedures use the right-click
menu option, unless the toolbar button is the only option.
Schedules and Real-time Triggers
CDC Factory 7.1
ActivEssentials Administration Guide
12-9
Scheduling ActivEssentials Tasks
The schedules you create in the Schedules & Real-time Triggers task
module specify when often repeated tasks, such as report generation
and data archiving, can occur. Schedules specify when defined tasks
can run; they do not define the actual task. When you define a task,
you then attach it (in most instances
1
) to any existing schedule that
runs at the frequency needed for the task. However, a schedule can
handle any number of tasks.
Requesting any activity demands resources of the database server, so
schedules provide a means of getting the database to perform these
activities when there is a reduced demand for its services, such as late
at night or over weekends.
This section covers the following topics:
The Schedules & Real-Time Triggers Interface on page 12-3
Schedule Structures on page 12-9
The Schedule Types on page 12-10
Questions to Ask When Creating a Schedule on page 12-11
Examples of Schedules on page 12-11
Schedule Structures
Schedules are used in ActivEssentials for report generation; data
management tasks such as archiving, purging, and restoring data; and
other tasks. The features and methods are common to all areas. You
can run your schedules based on days, weeks, or months. Any one
schedule can include several instances of when a task takes place, and
could also include any number of other defined tasks. The schedule
types are as follows:
A schedule consists of the following elements:
A time-based framework. This identifies the frequency structure,
which is based on a specified number days, weeks, or months.
A recurrence pattern. This determines the occurrence of the
schedule. For example, you might want an instance of the schedule
to run every two days, or on the third Monday of the month.
A frequency pattern. This determines how many instances there is
of activity within the schedule. For example, you may want the
schedule to operate only once on a given day, or you may want it
to run every hour on that day.
1. When setting up tasks, the process can include the creation of a new schedule.
Note: Daily, Weekly, and Monthly do not mean every day/week/month. They
mean that the schedule is based on days, weeks, or months. A daily schedule
may run every third day; a weekly schedule may run on the Monday and Friday
of every third week.
Schedules and Real-time Triggers
CDC Factory 7.1
ActivEssentials Administration Guide
12-10
The Schedule Types
You can assign one of several different schedule types to a schedule.
These schedule types let you run your schedules daily, weekly, or
monthly. Any one schedule can include several instances of archiving
or purging. The schedule types are as follows:
Daily. In a Daily schedule, the interval between each occurrence of
the schedule is measured in days; this does not mean that it runs
every day. The cycle for a daily schedule could be every 14 days,
but the schedule could run several times within this cycle.
Weekly. In a Weekly schedule, the interval between each
occurrence of the schedule is measured in weeks, but it need not
run every week. A weekly schedule could run every 4th week on
the Monday and Thursday that follow the start date, and then
every six hours on those days.
Monthly. In a Monthly schedule, the interval between each
occurrence of the schedule is measured in months; this does not
mean it runs every month. A monthly schedule could start on the
15th day of every third month, but then run every four hours that
day.
Scheduling Options
When creating a schedule, you have several options that relate to
when a schedule should run.
Daily Schedules
In a Daily schedule, the interval between each occurrence of the
schedule is measured in days; this does not mean that it runs every
day. The cycle for a daily schedule could be every 14 days, but the
schedule could run several times within the 14 days.
Weekly Schedules
In a Weekly schedule, the interval between each occurrence of the
schedule is measured in weeks, but it need not run every week. A
weekly schedule could run on the Monday and Thursday of every forth
week that follows the start date, and then every six hours on those
days.
Schedules and Real-time Triggers
CDC Factory 7.1
ActivEssentials Administration Guide
12-11
Monthly Schedules
In a Monthly schedule, the interval between each occurrence of the
schedule is measured in months; this does not mean it runs every
month. A monthly schedule could start on the 15th day of every third
month, but then run every four hours that day. Note that in a monthly
schedule you can choose a date, or choose the first Wednesday, etc.
Questions to Ask When Creating a
Schedule
When creating a schedule you should ask yourself the following
questions:
What is the overall cycle of a schedule (measured in days, weeks,
or months)?
Should it run at a regular interval, regardless of weekday or date?
When the schedule is triggered, how many times should it run? (In
most cases the answer will be only once.)
The table below addresses some of these questions.
Examples of Schedules
This section presents some examples of schedules:
ExampleDaily Schedule
Requirement: The schedule must run at midnight each day, every day.
Schedule category: By Time
Schedule type: Daily
Recurrence pattern: Every 1 day(s)
Frequency pattern: Occurs once at 00:00:00
Table 12-3 Calendar-based schedules
Requirement for the Schedule Method to Use
Run at a regular interval, regardless of the date or day of
the week
Daily schedule
Run on certain day(s) of the weekevery week or every
few weeks
Weekly schedule
Run on a certain date in the monthevery month or every
few months
Monthly schedule
Run on a certain day in the month (for example, the first
Monday)every month or every few months
Monthly schedule
Schedules and Real-time Triggers
CDC Factory 7.1
ActivEssentials Administration Guide
12-12
ExampleLast Weeks Production Report Schedule
Requirement: The schedule must run every Monday at 06:00.
Schedule category: By Time
Schedule type: Weekly
Recurrence pattern: Every 1 week(s) on Monday
Frequency pattern: Occurs once at 06:00:00
ExampleLast Months Production Report Schedule
Requirement: The schedule must run on the first day of the month at
06:00.
Schedule category: By Time
Schedule type: Monthly
Recurrence pattern: Day 1 of every 1 month(s)
Frequency pattern: Occurs once at 06:00:00
Note: Notice that in all the examples given there is no time frame specified for the
task (report, archive, etc.) that will be performed. A schedule does not include
the time frame for a task. In the case of a report, the report time frame is
determined by the report template, not by the schedule. In other words, the
schedule is a container that manages the tasks to which it has been assigned,
it does not manage the scope of the tasks it runs.
Schedules and Real-time Triggers
CDC Factory 7.1
ActivEssentials Administration Guide
12-13
Creating Schedules
You can create schedules in the Schedules & Real-time Triggers task
module, but you can also create schedules in the task modules that
need the services of a schedule. The schedules you create in
Schedules & Real-time Triggers go into a pool of schedules that are
available in the task modules that need them, such as Data
Management or Reports Administration. Users of these other modules
can opt to use one of these ready-made schedules, or create a new
one from the module in which they are working.
This section covers the following topics:
Creating a Schedule on page 12-13
Creating New Schedules from Existing Schedules on page 12-15
Creating a Schedule
Use the instructions below to set up a schedule that uses a calendar
definition of time. The schedules you create here are available in other
task modules where scheduled activity is needed.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Schedules & Real-time Triggers task module
using the instructions in Opening the Schedules & Real-Time
Triggers Module on page 12-3.
Read Updating Changes in Schedules & Real-Time Triggers on page
12-3.
Procedure
1 On the toolbar, click the New button.
The Add New Schedule wizard starts.
2 Click Next to move past the Welcome page.
Schedules and Real-time Triggers
CDC Factory 7.1
ActivEssentials Administration Guide
12-14
Figure 12-2 The Schedule Configuration and Options page of the wizard.
3 Do each of the following:
a) In the Name field, type a unique name for the schedule.
b) Click the down-arrow by the Schedule type field and select
the kind of schedule you need to use.
4 Click the Schedule Options button.
The Schedule Options dialog box opens.
5 Do one of the following:
a) To set up a Daily schedule, in the Recurrence pattern
groupbox, click in the Every day(s) field, and use the
up- or down-arrows to set the interval between each instance
of the schedule.
b) To set up a Weekly schedule, do each of the following:
Click in the Every week(s) field, and use the up- or
down-arrows to set the interval between each instance of
the schedule.
In the checkboxes below, select the days during the
scheduled week when the schedule should occur.
c) To set up a Monthly schedule, do each of the following:
To choose a particular date, first select the top radio button,
then use the up- or down-arrows in the Day field to select a
day in the month, and then and use the up- or down-arrows
to select an interval in months.
To specify the day in the month, select the second radio
button, then use the drop-down list items to describe the
day, and use the up- or down-arrows to select an interval in
months.
Schedules and Real-time Triggers
CDC Factory 7.1
ActivEssentials Administration Guide
12-15
In the Frequency pattern groupbox, select either to run the schedule
once on the day, or construct a pattern for multiple instances on the
day(s).
Figure 12-3 The Monthly options for scheduling
6 Click OK.
7 When the Schedule Options dialog box closes, click Next.
The final page of the wizard opens.
8 Check the details on the page and click Finish.
9 On the toolbar, click the Update Delivery Service button.
The confirmation dialog box opens.
10 Click OK.
Creating New Schedules from Existing
Schedules
Use the instructions below to create a new schedule from an existing
schedule that is similar to the one you need. To do this, you make a
copy of an existing schedule and then modify it to fit your needs.
Schedules and Real-time Triggers
CDC Factory 7.1
ActivEssentials Administration Guide
12-16
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Schedules & Real-time Triggers task module
using the instructions in Opening the Schedules & Real-Time
Triggers Module on page 12-3.
Read Updating Changes in Schedules & Real-Time Triggers on page
12-3.
Created a schedule using the instructions in Creating a Schedule
on page 12-13.
Procedure
1 In the grid, right-click on the schedule you need to duplicate and
select Copy.
2 Right-click anywhere in the grid and select Paste.
A new schedule entry appears in the grid.
3 Edit the properties of the schedule to fit your new needs.
4 On the toolbar, click the Update Delivery Service button.
The confirmation dialog box opens.
5 Click OK.
Note: The new schedule is an exact copy of the original, but the name is prefixed by
the term Copy of. Change the name to something more appropriate, and
change any other properties as needed.
Schedules and Real-time Triggers
CDC Factory 7.1
ActivEssentials Administration Guide
12-17
Maintaining Schedule Configuration
Most schedules that you create in Schedules & Real-time Triggers, and
elsewhere in MI Admin, can be viewed, edited, and deleted; or
activated and deactivated. The only exception is the schedules for
archiving and purging data in Data Management; these schedules do
not reside in the ActivEssentials databasethey are handled by stored
procedures in the SQL Server.
This section covers the following topics:
Viewing and Editing Schedule Properties on page 12-17
Deleting Schedules on page 12-19
Activating and Deactivating Schedules on page 12-20
Viewing and Editing Schedule Properties
Use the instructions below to view and edit the properties of a
schedule.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Schedules & Real-time Triggers task module
using the instructions in Opening the Schedules & Real-Time
Triggers Module on page 12-3.
Read Updating Changes in Schedules & Real-Time Triggers on page
12-3.
Schedules and Real-time Triggers
CDC Factory 7.1
ActivEssentials Administration Guide
12-18
Procedure
1 In the grid, right-click on the schedule whose properties you need
to view and select Properties. The Schedule Properties editor
opens.
Figure 12-4 The Schedule Properties editor
2 If you need to change the name of the schedule, click in the Name
field and edit the name.
3 To change the structure of the schedule, do the following:
a) Click the down-arrow by the Schedule Type field, and select
an appropriate type from the drop-down list.
b) Click the Schedule Options button.
The Schedule Options dialog box opens.
4 Do one of the following:
a) To change a Daily schedule, in the Recurrence pattern
groupbox, click in the Every day(s) field, and use the up- or
down-arrows to set the interval between each instance of the
schedule.
b) To change a Weekly schedule, do each of the following:
Click in the Every week(s) field, and use the up- or
down-arrows to set the interval between each instance of
the schedule.
In the checkboxes below, select the days during the
scheduled week when the schedule should occur.
Schedules and Real-time Triggers
CDC Factory 7.1
ActivEssentials Administration Guide
12-19
c) To change a Monthly schedule, do each of the following:
To choose a particular date, first select the top radio button,
then use the up- or down-arrows in the Day field to select a
day in the month, and then and use the up- or down-arrows
to select an interval in months.
To specify the day in the month, select the second radio
button, then use the drop-down list items to describe the
day, and use the up- or down-arrows to select an interval in
months.
In the Frequency pattern groupbox, select either to run the schedule
once on the day, or construct a pattern for multiple instances on the
day(s).
Figure 12-5 The Monthly options for scheduling
5 Click OK.
6 When the Schedule Options dialog box closes, click OK.
7 On the toolbar, click the Update Delivery Service button.
The confirmation dialog box opens.
8 Click OK.
Deleting Schedules
Use the instructions below to delete schedules.
Schedules and Real-time Triggers
CDC Factory 7.1
ActivEssentials Administration Guide
12-20
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Schedules & Real-time Triggers task module
using the instructions in Opening the Schedules & Real-Time
Triggers Module on page 12-3.
Read Updating Changes in Schedules & Real-Time Triggers on page
12-3.
Determine what tasks depend on the schedule that you want to
delete. If you are not sure what dependencies there are, try
deactivating the schedule first. If dependencies exist, you can then
assign a different schedule to these tasks, or reactivate the
schedule.
Procedure
1 In the grid, right-click on the schedule you need to delete, and
select Delete.
A confirmation dialog box opens.
2 Click OK.
3 On the toolbar, click the Update Delivery Service button.
The confirmation dialog box opens.
4 Click OK.
Activating and Deactivating Schedules
Schedules operate only if they are active. By default, when creating
schedules, the active option is preselected. Later on, you may need to
deactivate a schedule because there are no active tasks that need its
services, but you might not want to delete it.
The active/inactive status of a schedule appears can be changed in two
places:
The Active column of the grid. You can change the status by
clearing or selecting the checkbox for a particular schedule.
The Properties dialog box for the schedule, which can be accessed
by right-clicking on the schedule entry in the grid and selecting
Properties. You can change the status by clearing or selecting the
checkbox for a particular schedule.
After making any changes in Schedules & Real-time Triggers, you must
refresh the delivery service by clicking the Update Delivery Service
button on the taskbar.
Note: If you deactivate a schedule, you also deactivate any tasks that depend on its
operation.
Schedules and Real-time Triggers
CDC Factory 7.1
ActivEssentials Administration Guide
12-21
Defining and Maintaining Trigger Items
Triggers use as their basis the real-time data items that already exist
within ActivEssentials. The triggers switch on and off according to the
current value of data items. For example, you can define an event
alarm that starts if the production count for the previous shift was less
than 1250.
Triggers are Boolean values that evaluate to TRUE or FALSE. You can
create complex triggers by combining conditions with the AND, OR,
and NOT operators. For example, you can combine temperature and
part number parameters.
You use triggers to initiate actions within ActivEssentials when
specified conditions exist, such as having the FactoryViewer
application push slides out that indicate an alarm to high-definition
TVs that are located on the plant floor.
This section covers the following topics:
How Triggers are Built on page 12-21
Defining a Trigger on page 12-22
Defining a Trigger Using a Template on page 12-27
Creating a Trigger Template on page 12-26
Defining a Trigger Using a Template on page 12-27
Copying a Real-Time Trigger on page 12-29
Modifying a Real-Time Trigger on page 12-30
Deleting a Real-Time Trigger on page 12-30
How Triggers are Built
You can build a trigger by basing it on a value change in the real-time
item (such as a shift change), or by defining an item value that
represents the TRUE condition.
Triggers are similar to the expressions used in the Calculations module
but have the following differences:
Triggers use comparators such as greater than (>), less than
(<), equal to (=), etc.
Triggers can use the logical operators AND, OR, and NOT.
Triggers can compare the current value(_CurrentValue) to its
previous value(_PreviousValue).
Triggers are Boolean expressions that must evaluate as TRUE to
force the action.
Although you assign data items to each variable in the same way
as you do for calculations, triggers work only with real-time data
items, i.e., identifiers, incidents, event variables, derived items,
shifts, and shift periods.
Schedules and Real-time Triggers
CDC Factory 7.1
ActivEssentials Administration Guide
12-22
Triggers also support several functions that deal with parsing textual
inputs. These string handling functions work to compare a value in the
trigger expression with the string the expression is asked to examine.
If the string matches in the way described by the function, the trigger
evaluates to TRUE.
StartsWith. To be TRUE, the handled string must start with the
trigger value.
EndsWith. To be TRUE, the handled string must end with the
trigger value.
Contains. To be TRUE, the handled string must contain the trigger
value.
When creating the expressions, you can type these directly in the Edit
Trigger Definition dialog box, or use the buttons on the dialog button
to construct the expressions for you. If you do want to type the
expressions, the expressions must be in valid VBScript as otherwise
they will not validate.
You can create complex triggers by combining several different
expressions and using the AND, OR, and NOT operators. As triggers
are Boolean expressions, the design of the entire expression must
always evaluate to either TRUE or FALSE. When you feel you have
completed the expression, there is an option to validate the logic.
However, be aware that a valid expression is just that. A poorly
defined expression can be valid but yet evaluate to TRUE under the
wrong circumstances.
If you need to define a trigger that allows for a range of data to be
exceeded before the trigger turns on or off, you can use the deadband
option to reduce the amount of minor variations that should not
activate the trigger.
Defining a Trigger
Use the instructions below to define a trigger for an event alarm on a
group or asset in the plant hierarchy.
Note: When defining triggers you should do them in pairs, with each pair consisting of
an ON trigger and an OFF trigger. The ON trigger fires the event alarm, while
the OFF trigger cancels it. Usually you can define the OFF trigger as simply
NOT [the ON trigger].
Schedules and Real-time Triggers
CDC Factory 7.1
ActivEssentials Administration Guide
12-23
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Schedules & Real-time Triggers task module
using the instructions in Opening the Schedules & Real-Time
Triggers Module on page 12-3.
Read Updating Changes in Schedules & Real-Time Triggers on page
12-3.
Read How Triggers are Built on page 12-21 for an understanding of
what constitutes a valid expression.
Procedure
1 In the Object Library frame, select the Real-time Triggers item.
The already defined triggers appear in the grid.
2 On the toolbar, click the New button.
The Add New Real-time Trigger wizard starts.
3 Click Next to move past the Welcome page.
The Name and Description page of the wizard opens.
4 Type a name and description for the trigger, and click Next.
Figure 12-6 Trigger definition selection page
5 Select the Create new option.
6 Click Next.
Schedules and Real-time Triggers
CDC Factory 7.1
ActivEssentials Administration Guide
12-24
Figure 12-7 Select Trigger Definition data item
7 Click the ellipsis button beside the Data item field.
Figure 12-8 Select a Data Item page
8 Do each of the following:
a) In the Plant Hierarchy window, select the group or asset that
contains the real-time event you intend to use.
b) In the Available Data Items window, select the real-time
item that you want to use as the trigger.
Once selected, the full path to the data item appears in the
Selected data item field.
Schedules and Real-time Triggers
CDC Factory 7.1
ActivEssentials Administration Guide
12-25
9 To set a variance beyond which the the trigger activates, type a
number in the Deadband field, and then do one of the following:
a) To set a specific number, select Absolute.
b) To set this number as a percent, select Percent.
10 If you need to create or modify the trigger definition, click Edit.
Figure 12-9 The Trigger Definition dialog box
11 Do one of the following:
a) To create a new function, type the function, or use the buttons
on the right to build the expression.
b) To modify an existing function, click anywhere in the trigger
definition field to edit the displayed function as appropriate.
12 Click OK.
You are returned to the Data Item page.
13 If you want the expression to be evaluated when collection starts
(in case triggers or values are in progress), then check the
Evaluate trigger checkbox.
14 Set the minimum duration that the value must remain true before
the trigger starts.
15 If the value needs to be held for a certain period of time before it is
displayed, then enter a time in hours:minutes:seconds in the
Delay field.
16 Click Next.
The last page of the wizard opens.
Note: In the following step you can set a variance around the trigger value (the
Deadband) that allows for acceptable operational variability. The Deadband
limit allows for variances, both plus and minus. However, the Deadband option
is only available for numeric data items.
Schedules and Real-time Triggers
CDC Factory 7.1
ActivEssentials Administration Guide
12-26
17 Review the summary, and if you agree, click Finish.
The new trigger appears in the grid.
18 On the toolbar, click the Update Delivery Service button.
The confirmation dialog box opens.
19 Click OK.
Creating a Trigger Template
Use the instructions below to create a trigger template. When creating
a trigger template you store for future use the parameters that reside
in the trigger. When you apply a template when creating a new trigger,
you adopt all of the parameters of the original trigger.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Schedules & Real-time Triggers task module
using the instructions in Opening the Schedules & Real-Time
Triggers Module on page 12-3.
Created a trigger using the instructions in Defining a Trigger on
page 12-22.
Procedure
1 In the Object Library frame, select the Real-time Triggers item.
The already defined triggers appear in the grid.
2 In the grid, right-click on the trigger you want to use as a template
and select Save As Template.
Figure 12-10 Trigger Template name dialog box
Note: Within the Schedules & Real-time Triggers module there is no interface for
examining the properties of a trigger template, and therefore no way of editing
these properties. Furthermore, as you create a template, you cannot later
remove its configuration from the ActivEssentials database.
Schedules and Real-time Triggers
CDC Factory 7.1
ActivEssentials Administration Guide
12-27
3 In the text box, type the name you want to use for the trigger
template and click OK.
The trigger is now available for use as a template when you are
defining new triggers.
Defining a Trigger Using a Template
Use the instructions below to define a trigger from a template. When
you create a trigger by referencing a template, you have to accept the
definition as it was originally defined.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Schedules & Real-time Triggers task module
using the instructions in Opening the Schedules & Real-Time
Triggers Module on page 12-3.
Read Updating Changes in Schedules & Real-Time Triggers on page
12-3.
Procedure
1 In the Object Library frame, select the Real-time Triggers item.
The already defined triggers appear in the grid.
2 On the toolbar, click the New button.
The Add New Real-time Trigger wizard starts.
3 Click Next to move past the Welcome page.
The Name and Description page of the wizard opens.
4 Type a name and description for the trigger, and click Next.
Schedules and Real-time Triggers
CDC Factory 7.1
ActivEssentials Administration Guide
12-28
Figure 12-11 Trigger definition selection page
5 Select the Create from a trigger template option, and then
select the template from the drop-down list.
6 Click Next.
Figure 12-12 The page where you select the group or asset
7 Click the ellipsis button next to the Group/Asset field.
Note: The trigger definition appears in the Definition box, but it is there for you to
review only. You cannot edit trigger definitions when you create a trigger from a
template.
Schedules and Real-time Triggers
CDC Factory 7.1
ActivEssentials Administration Guide
12-29
Figure 12-13 The Plant Hierarchy Browser
8 Select the group or asset to which you need to apply the template
and then click OK.
The selected group or asset appears in the Group/Asset field.
9 If necessary, select the Active checkbox and then click Next.
The last page of the wizard opens,
10 Review the details of the new trigger and then click Finish.
An entry for the new trigger appears in the grid.
11 On the toolbar, click the Update Delivery Service button.
The confirmation dialog box opens.
12 Click OK.
Copying a Real-Time Trigger
Use the instructions below to make a copy of a real-time trigger. Once
copied, you can modify its configuration to match your needs.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Schedules & Real-time Triggers task module
using the instructions in Opening the Schedules & Real-Time
Triggers Module on page 12-3.
Read Updating Changes in Schedules & Real-Time Triggers on page
12-3.
Read How Triggers are Built on page 12-21 for an understanding of
what constitutes a valid expression.
Schedules and Real-time Triggers
CDC Factory 7.1
ActivEssentials Administration Guide
12-30
Procedure
1 In the Object Library frame, select the Real-time Triggers item.
The already defined triggers appear in the grid.
2 In the grid, right-click on the trigger you need to duplicate and
select Copy.
3 Right-click anywhere in the grid and select Paste.
A new trigger appears in the grid with the original name now
preceded by the term Copy of.
4 On the toolbar, click the Update Delivery Service button.
The confirmation dialog box opens.
5 Click OK.
Modifying a Real-Time Trigger
Use the instructions below to modify an existing real-time trigger.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Schedules & Real-time Triggers task module
using the instructions in Opening the Schedules & Real-Time
Triggers Module on page 12-3.
Read Updating Changes in Schedules & Real-Time Triggers on page
12-3.
Read How Triggers are Built on page 12-21 for an understanding of
what constitutes a valid expression.
Procedure
1 In the Object Library frame, select the Real-time Triggers item.
The already defined triggers appear in the grid.
2 In the grid, right-click on the trigger you need to modify and select
Properties.
The properties dialog box for the trigger opens.
3 Modify the properties as needed and click OK.
Deleting a Real-Time Trigger
Use the instructions below to delete a real-time trigger.
Note: You can also modify the properties in the grid by variously double-clicking to
edit directly, clicking to expose an ellipsis button, or clicking to expose up- or
down-arrows. If you do edit in this way, click elsewhere in the grid to save your
changes.
Schedules and Real-time Triggers
CDC Factory 7.1
ActivEssentials Administration Guide
12-31
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Schedules & Real-time Triggers task module
using the instructions in Opening the Schedules & Real-Time
Triggers Module on page 12-3.
Read Updating Changes in Schedules & Real-Time Triggers on page
12-3.
Procedure
1 In the Object Library frame, select the Real-time Triggers item.
The already defined triggers appear in the grid.
2 In the grid, right-click on the trigger you need to remove and select
Delete.
Confirm Action dialog box opens.
3 Click Yes.
The trigger disappears from the grid.
4 On the toolbar, click the Update Delivery Service button.
The confirmation dialog box opens.
5 Click OK.
CDC Factory 7.1
ActivEssentials Administration Guide
13-1
Data Management
Data Management
CDC Factory 7.1
ActivEssentials Administration Guide
13-2
Introduction to Data Management
As you collect manufacturing data using ActivEssentials, your database
files continue to grow as records are added. As time goes on much of
the data is no longer needed, but you should not destroy it in case you
need to refer to it in the future. ActivEssentials includes the ability to
archive and purge data after a set period of time, and to restore the
data if and when you need it again. You perform these tasks in the
Data Management module of MI Admin.
This chapter covers the following topics:
Backward Compatibility on page 13-2
The Data Management Interface on page 13-2
Data Archiving on page 13-11
Understanding the Properties of Archives and Archive Files on page
13-22
Understanding the Archive and Restore Logs on page 13-26
Initial Configuration of Data Management on page 13-36
Maintaining Configuration in Data Management on page 13-45
Viewing the Logs and Properties on page 13-52
Manual Archiving Operations on page 13-70
Data ManagementSupplementary Information on page 13-90
Backward Compatibility
This database management solution does not support any data you
might have archived from previous versions of the ActivEssentials
database. If you anticipate that already archived data is still required
for use in the database, you must restore it before the database is
upgraded. During the database upgrade, all data in the database is
reconfigured to match the needs of the latest database version. When
the upgrade is complete, you can rearchive the restored data.
The Data Management Interface
The Data Management module in MI Admin gives you access to the
data archive and restore functions within ActivEssentials. The interface
has many characteristics that are familiar to MI Admin users.
This section covers the following topics:
Opening the Data Management Module on page 13-3
Data Archiving Frame on page 13-3
Toolbar Buttons and Context Menu Options on page 13-5
Summary of the Tasks in Data Management on page 13-7
Data Management
CDC Factory 7.1
ActivEssentials Administration Guide
13-3
Opening the Data Management Module
Use the instructions below to open the Data Management module in
MI Admin. In this module you can control the archiving and restoring
of raw manufacturing data. This allows you to control the size of your
manufacturing database.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
Read the following:
Data Archiving Frame on page 13-3
Toolbar Buttons and Context Menu Options on page 13-5
Summary of the Tasks in Data Management on page 13-7
Set up the system environment using the instructions in Setting up
Data Archiving in System Settings on page 13-11.
Procedure
1 In the taskbar, click the Applications category button.
The taskbar refreshes to display icons for the task modules in the
Configuration category.
2 In the taskbar, click the Data Management icon.
The Data Management interface opens.
Data Archiving Frame
Below the Navigation frame in the Data Management module of
MI Admin is the Data Archiving frame, which contains Archive
Configuration, Archive Logs, and Restore Data
Note: If you have not yet chosen a working folder, the database returns an error
message. See Setting the Working Folder and Other Archive Settings on page
13-13 for more informat ion.
Data Management
CDC Factory 7.1
ActivEssentials Administration Guide
13-4
Archive Configuration
Archive Configuration is where you can create, edit, or delete archive
definitions. Once created, the archive definitions run within the
scheduled archiving jobs. Any data that falls within the scope for the
archive definition is archived as the data expires. You cannot define
the same data to appear in two archives.
Figure 13-1 The Archive Configuration view
Archive Logs
In the Archive Logs view you manage the logs of the archiving activity.
Each time an archive definition runs, the database produces an entry
in the Archive Logs view. The archive logs record the transactional
properties of each entry, including the archive definition name, the
data category, the start and end time for archive and/or purging, the
number of rows handled, the present status, etc. The view in the grid
describes the master log; it does not describe the data contained in
the archive.
Figure 13-2 The Archive Logs view
The grid gives you access to the detailed logs, which describe the
archived data by the data types it contains. You can also access the
archived data by groups and assets.
Restore Data
The Restore Data view shows descriptions of any data you choose to
restore to the database: the start and end times for the restore, the
current status, the number of records restored, etc.
Figure 13-3 The Restore Data view
Data Management
CDC Factory 7.1
ActivEssentials Administration Guide
13-5
You can also access detailed information about any restore definition;
you can view the data by data types, and from these records, you can
see information about the groups and assets involved.
Toolbar Buttons and Context Menu
Options
In addition to the toolbar buttons that appear in each of the MI Admin
modules, the following buttons and context menu options are either
specific to Data Management, or have specific meaning within Data
Management. In many instances you can access the functions from
both the toolbar and the context menus. In order to simplify this
guide, the procedures reference the use of the context menu options
only, unless you can only use the toolbar.
Note: The context menus in Data Management list all options regardless of whether
they are valid or not, but if invalid, the options are greyed-out.
Table 13-1 Toolbar buttons and context menu options
Toolbar
buttons/
menu options
Data
Managem
ent view
Option
available on
Purpose within Data Management
Menu Toolb
ar
Archive
Settings
Archive
Configura
tion
Yes Yes Opens the Archive Settings editor.
The editor is accessible from each of
the three Data Management views.
This editor allows you to view or edit
archive settings such as the working
folder, number of groups/assets
archived, and details of the scheduled
archive and/or purge jobs.
Archive
Logs
No Yes
Restore
Data
No Yes
Cancel
Data
Restoring
Restore
data
Yes No Used for cancelling the purge of
previously restored data.
Cancel
Purge
Restored
Data
Restore
data
Yes No Used for cancelling the purge of
previously restored data.
Cancel
Re-archive
Archive
Logs
Yes No Used to cancel an instruction to
re-archive previously archived data.
Cancel
Reprocess
Archive
Restore
data
Yes No Used for cancelling the reprocessing of
previously restored data.
Data Management
CDC Factory 7.1
ActivEssentials Administration Guide
13-6
Code Color
Picker
Archive
Logs and
Restore
Data
No Yes You can select a background color for
the rows in the archive logs or archive
restoration jobs grid to indicate the
status of the logs such as in process,
completed, cancelled, etc. You also
have the option to use or reset the
grid to the default colors.
Delete Archive
Configura
tion
Yes Yes Used to delete any further instances of
an archiving configuration. If used,
clicking the button opens a
confirmation dialog.
Restore
Data
Yes Yes Used to delete rows in the grid that
represent restore definitions.
Delete
Detailed
Log for
Groups/
Assets
Archive
Logs and
Restore
Data
Yes Yes Used to delete the Detailed Log for
Groups/Assets, for the archive job
or restore definition you have selected
in the grid.
Detailed
Log for
Data Types
Archive
Logs
Yes Yes Use to access information about the
archive logsThe button opens the
Detailed Log for Data Types dialog
box.
New Archive
Configura
tion
Yes Yes Use to create a new archive. The
button initiates the Add New Archive
wizard.
Properties Archive
Configura
tion
Yes Yes Opens a dialog box where you can edit
the general and optional properties of
the selected archive definition.
Archive
Logs
Restore
Data
Yes
No
Yes Opens a dialog box where you can
view the properties of an archive or
restore job. The information in the
dialog box summarizes archive logs/
restore data information. You cannot
edit anything in the dialog box.
Purge
Restored
Data
Restore
data
Yes No Used to purge previously restored
data. If data was restored in a
read-only condition, you can remove
the data without having to reprocess
it.
Re-archive Archive
Logs
Yes No Used to re-archive previously archived
data. If the archive instruction was to
archive only, but the data has since
changed in the database, it should be
archived again.
Table 13-1 Toolbar buttons and context menu options
Toolbar
buttons/
menu options
Data
Managem
ent view
Option
available on
Purpose within Data Management
Menu Toolb
ar
Data Management
CDC Factory 7.1
ActivEssentials Administration Guide
13-7
Summary of the Tasks in Data
Management
Many of the tasks can be initiated through the buttons on the toolbars,
but not all buttons exist in all of the views. Some of the tasks are only
accessible from the context menus.
Reprocess
Archive
Restore
data
Yes No Used for reprocessing archived data
that has changed since being
restored. If data is restored so
changes can be made, it should be
reprocessed.
Restore
Data
Archive
Configura
tion
Yes Yes Opens the Add New Restore Job
wizard, from which you can identify
data that the database should restore.
Archive
Logs
Yes Yes
Restore
Data
No Yes
Retry Data
Restoring
Restore
data
Yes No Used to restart a failed data
restoration job.
Show Filter Archive
Logs
No Yes Opens the Archive Logs or Restore
Filter editor, which allows you filter the
entries in the grid. You can filter by
the archive definition name, the
status, and by a range of dates.
Note: The dates cover the time when
archive or restore processing
occurred, not the data collection
dates.
Restore
Logs
Restore
Data
Yes Yes Use to access the Restore
Configuration Status dialog box,
from which you can view details of the
selected restore configuration.
Table 13-1 Toolbar buttons and context menu options
Toolbar
buttons/
menu options
Data
Managem
ent view
Option
available on
Purpose within Data Management
Menu Toolb
ar
Data Management
CDC Factory 7.1
ActivEssentials Administration Guide
13-8
Archive ConfigurationAvailable Tasks
From the grid, the Archive Configuration view allows you to do the
following, primarily through editing in the grid and the use of context
menus:
Create new archive definitions.
Modify the properties of existing archive definitions in the following
ways:
Change the status of archive definitions, by activating or
deactivating as needed.
Change the scope of a definition, by editing the groups and
assets included and the data items (collection categories)
collected from these plant hierarchy items.
Change the data agethe setting that determines how old data
is before ActivEssentials initiates archiving.
Change the processing actionthe combination of archiving
and/or purging that takes place when the data expires.
Delete existing archive definitions.
Create and edit the archive settings.
Create new data restore definitions.
From the toolbar, the Archive Configuration view allows you to:
Create new archive definitions.
Create and edit the archive settings.
Create new data restore definitions.
View and edit the properties of the existing archive definitions in
the following ways:
Change the status of archive definitions, by activating or
deactivating as needed.
Change the scope of a definition, by editing the groups and
assets included and the kinds of data collected from these plant
hierarchy items.
Change the data agethe setting that determines how old data
is before ActivEssentials initiates archiving.
Change the processing actionthe combination of archiving
and/or purging that takes place when the data expires.
Data Management
CDC Factory 7.1
ActivEssentials Administration Guide
13-9
Archive LogsAvailable Tasks
From the grid, the Archive Logs view allows you to do the following
through context menus:
Restore data from the archive files.
View the detailed logsthe logs describe the data by data types, or
by the groups and assets from the which the data was originally
collected.
View the properties of the various archive jobsthis is a summary
of the information that appears in the columns, and saves you
having to scroll the interface to the right to see the information for
any particular archive job.
Re-archive data that has changed since it was first archived. If
changes are made to previously archived data, you should
re-archive the data to keep the archive record in line with the
database. You can also cancel this action, if needed.
Delete the Detailed Log for Groups/Assets. Removing these logs
saves space in the database, but does not prevent you from
restoring data. However, if you do this, the database cannot
conduct asset level validation.
From the Archive Logs toolbar, you can do the following:
Create and edit the archive settings.
Initiate the restoration of data from the archives.
View the detailed logs for the selected instance of an archive
definition.
Delete the detailed log for groups/assets for a selected instance of
an archive definition.
Set background colors for the rows in the grid to indicate various
statuses of the archiving and purging, such as to be archived, in
progress, completed, cancelled, etc.
Filter the data in the view, using the archive definition name, the
archive status, and a processing time range, or any combination of
these.
View the properties of the various archive jobsthis is a summary
of the information that appears in the columns, and saves you
having to scroll the interface to the right to see the information for
any particular archive job.
Data Management
CDC Factory 7.1
ActivEssentials Administration Guide
13-10
Restore DataAvailable Tasks
From the grid in the Restore Data view, using the right-click context
menu, you can perform the following tasks:
View the restore logs for any restore definition, and from these,
view detailed logs for the data types and then the groups/assets.
Reprocess (re-archive) the restored dataif any restored data is
then modified in the database, you should reprocess it to ensure
the archive matches the database. You can also cancel a reprocess
instruction, if needed.
Purge from the database any previously restored data. You can
also cancel a purge instruction, if needed.
Delete the Detailed Log for Groups/Assets for a selected restore
definition.
Retry a data restore definition if it has previously failed. A restore
might fail if the required archive files were not in the defined
location, if the archive file failed validation, or for a number of
other reasons. You can also cancel an instruction to retry a restore
definition. if needed.
View the properties of a restore definition that is either scheduled,
or has already been restored. You can edit some of these
properties if the restore definition is still pending.
Delete the selected restore log.
From the Restore Data toolbar, you can do the following:
Delete a selected restore log.
Create and edit the archive settings.
Restore data from the archive files.
View the restore logs for any restore definition, and from these,
view detailed logs for the data types and then the groups/assets.
Delete the Detailed Log for Groups/Assets for a selected restore
definition.
Set background colors for the rows in the grid to indicate various
statuses of the restore, such as to be restored, in progress,
completed, cancelled, failed.
Filter the data in the view, using the restore configuration name,
the restore status, and a time range, or any combination of these.
View the properties of data that is either scheduled for restoration,
or has already been restored. You can edit some of these
properties if the restore definition is still pending.
Data Management
CDC Factory 7.1
ActivEssentials Administration Guide
13-11
Data Archiving
You can archive your data when it reaches a certain age. For example,
you might want to archive all of your accumulator data (counters and
timers) for a specific station when it is 60 days old. To do this, you
need to create a data archive to define how the database should
process and store this data.
Once set up, most of the archiving activity happens automatically in
the database through scheduled archiving and purging jobsyou only
have to intervene if you need to change your archive configuration, or
if you need to change archived data.
This section covers the following topics:
Setting up Data Archiving in System Settings on page 13-11
Setting the Working Folder and Other Archive Settings on page
13-13
System Settings on page 13-16
How Much Data to Include in an Archive on page 13-16
Options for Data Archiving on page 13-17
Database Performance During a First Archive on page 13-20
Purging as an Archiving Activity on page 13-20
Setting up Data Archiving in System
Settings
Use the instructions below to set each of the Data Management
system archive properties in the System Settings module of
MI Admin.
There are four system settings that affect data archiving. You must set
a Working Folder, otherwise archiving cannot begin. You can accept
the default settings for the three other settings, but this might not
assure database optimization. You can also set the system archive
properties through the Data Management module. For more
information, see Setting the Working Folder and Other Archive
Settings on page 13-13.
Note: If you are using SQL Server 2005 Enterprise or Developer edition and you want
to archive all assets and data categories, you can use table partitioning. See
the chapter Partitioning and Archiving Tables in the CDC Factory System
Configuration Guide for more information. If you want to choose specific assets
and categories to archive, then use this module.
Note: Security for the working folder must be set up so that the SQL Server user
account has Full Control. For database servers that use the Windows Server
2003 operating system, there are special considerations. See Sharing a
working folder in Windows Server 2003 for data archiving in the CDC Factory
System Configuration Guide, which you can find in the ActivEssentials
installation package.
Data Management
CDC Factory 7.1
ActivEssentials Administration Guide
13-12
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the System Settings module using the
instructions in Opening the System Settings Module on page 2-2.
Procedure
1 In the System Settings frame, click the System Properties icon.
The system properties display in the grid.
Figure 13-4 Data Management system properties
2 On the Working Folder for Data Archive row, click in the Value
column and then click the ellipsis button that appears.
The AppCenter Shared Folder Browser opens. If previously defined,
the currently selected working folder is noted as the Current
location.
Figure 13-5 The AppCenter Shared Folders Browser
3 Browse to and select the folder you want to use, then click OK.
Data Management
CDC Factory 7.1
ActivEssentials Administration Guide
13-13
4 If you need to change any of the default settings, do the following,
as needed:
a) Double-click the Value cell on the Number of Assets or
Groups to Archive and Purge row, and change the number
of assets and groups.
b) Double-click the Value cell on the Number of Assets or
Groups to Restore row, and change the number of assets and
groups.
c) Double-click the Value cell on the Weeks to Keep Archive
and Restore Detailed Logs row, and change the number of
weeks.
The default is 0, which means unlimited.
Setting the Working Folder and Other
Archive Settings
Use the instructions below to establish the system settings that control
the way the Data Management module of MI Admin works.
These instructions allow you to make these settings in the Data
Management module, but you can also access the settings in the
System Settings module. See Setting up Data Archiving in System
Settings on page 13-11 for alternative instructions. There are four
system settings that affect data archiving. You must set a Working
Folder, otherwise archiving cannot begin. You can accept the default
settings for the three other settings, but other settings may optimize
your database performance.
If you have enabled table partitioning, you can still use Data
Management to archive partitioned tables. See Partitioning and
Archiving Tables in the System Configuration Guide (System
Configuration Guide.pdf) for more information.
Note: For more information about the values for the number of assets to archive and
purge, and the number to restore, see Basic Process Data Unit.
Note: While removing the Detailed Logs for Groups/Assets does not prevent you
from restoring the data later, it does prevent asset level validation.
Note: You can access the system archive settings from any of the three views in Data
Management.
Data Management
CDC Factory 7.1
ActivEssentials Administration Guide
13-14
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Data Management task module using the
instructions in Opening the Data Management Module on page
13-3.
Read Basic Process Time Unit on page 13-91 and Basic Process
Data Unit on page 13-91 to optimize database activity when these
jobs run.
Procedure
1 Click the Archive Settings button on the toolbar.
The Archive Settings dialog box opens.
2 Click the System Archive Settings tab, if not already selected.
Figure 13-6 The System Archive Settings tab
3 To the right of the Working Folder for Data Archive field, click
the ellipsis button.
The AppCenter Shared Folder Browser opens. If previously defined,
the currently selected working folder is noted as the Current
location.
Data Management
CDC Factory 7.1
ActivEssentials Administration Guide
13-15
Figure 13-7 The AppCenter Shared Files Browser
4 Browse to and select the folder you want to use, then click OK.
5 If you need to change the default settings, do the following, as
needed:
a) Click in the Number of Assets or Groups to Archive and
Purge field, and change the number of assets and groups.
b) Click in the Number of Assets or Groups to Restore field,
and change the number of assets and groups.
c) Click in the Weeks to Keep Archive and Restore Detailed
Logs field, and change the number of weeks.
The default is 0, which means unlimited.
Note: For archiving, purging, and restoring, a group is counted as just one unit. For
more information about the values for the number of assets to archive and
purge, and the number to restore, see Basic Process Data Unit.
Note: This setting refers to the Detailed Log for Groups/Assets. You should never
remove the Detailed Log for Data Types, since you cannot restore data without
it. If you use any setting other than the default, the database will eventually
delete the Detailed Logs for Groups/Assets. This does not prevent you from
restoring the data later, but it does prevent asset level validation.
Data Management
CDC Factory 7.1
ActivEssentials Administration Guide
13-16
System Settings
There are four system settings that control the archiving environment:
Defining the archive folder. You must specify the location you
will use for storing the archive files. When you do this, you should
consider the following:
You must specify an Archive folder for the data archive files.
ActivEssentials stores the archive files in this folder, but you
can move the archive files elsewhere later if you wish. For
information on how to specify a working folder, see Setting up
Data Archiving in System Settings on page 13-11.
Setting the number of groups/assets to archive and purge.
This setting controls how many groups and/or assets can be
involved in each archiving and purging job. There is a default
setting, but you should set this to optimize database performance
for your computing environment.
Setting the number of groups/assets to restore. This setting
controls how many groups and/or assets can be involved in each
execution of a restore definition. There is a default setting, but you
should set this to optimize database performance for your
computing environment.
Setting how long to keep detailed logs. This setting controls
how many weeks the database should keep the Detailed Log for
Groups/Assets for archiving and restoring activity. These logs
consume space in the database, but might not be needed for long
after the activity that produced them.
How Much Data to Include in an Archive
All archiving activity must be initiated by an archive definition, but it is
up to you to decide what strategy you will use for archiving your data.
You cannot archive all of your data with one archive definition; archive
definitions must use a data category, such as a collection method, as
the basis for any archiving activity. So, as a minimum, you will need
one archive definition for each of the data categories you need to
archive. There is no obligation to archive all of your data.
You can use just one archive definition for each data category or you
may prefer to break your archives into smaller chunks. You can use
specific data items and archive all data collected from all groups/
assets that use these items, or archive all data for all data items that
refer to particular groups/assets. It is also possible to combine these
methods by archiving just the data for particular data items on
particular groups and assets. From this you will see that you can
create archives that have a very specific focus, or they can have a very
broad scope.
Data Management
CDC Factory 7.1
ActivEssentials Administration Guide
13-17
The following are some points to consider:
You can create a single archive to handle more than one data item.
However, you cannot create more than one archive for the same
data.
The parameters for an archive are as follows:
The collection categories and data items within the data
category to be archived
The age of the data before it is archived
The action that should be performed (archive only, archive and
purge, or purge only)
The date for the earliest data in the archive
The groups and/or assets from which the data was collected
For more information on these, see Options for Data Archiving on
page 13-17.
When you have created one or more archive definitions, SQL Server
will run the definitions within the scheduled archive jobs. Archive
schedules can run on a daily, weekly, or monthly basis, but archiving
cannot commence until all of the data within the archiving scope has
expired.
Options for Data Archiving
To archive data you have to create an archive definition in the Data
Management module of MI Admin. Archive definitions are sets of
instructions to the ActivEssentials database about how to perform the
archiving tasks. When you create the archive definition, you have to
supply the following information:
The data category from which the data should be archived.
Selecting the data category also defines the data types that are
included in the definition. Although the data types are not
identified specifically, they are a part of the data category. See
Data Types on page 13-18 for more information.
The data items to include (the default is to include all collection
categories and data items within the selected data category,
including inactive items).
The groups/assets to include (the default is to include the entire
plant, including inactive items).
The data age, i.e. the age after which all raw data covered by the
definition is considered to have expired and is then subject to an
archiving action.
The archiving action that should be performed: to archive only, to
archive and purge, or to purge only.
The oldest date for archived datadata prior to this is not archived
and may, optionally, be removed from the database. By default,
the database will archive all data, unless an oldest date is
provided.
More information about these options follows.
Data Management
CDC Factory 7.1
ActivEssentials Administration Guide
13-18
Data Types
Data is principally archived by data types, which are classes of data
that the database stores for each of the data categories. The set of
data types differs from one category to anotherthey contain specific
pieces of the data category, but they might also refer to such things as
data quality. For example, if you choose to archive the Accumulator
data category, you will have 2 archive files for the Accumulator data
types: Accumulators and Accumulator quality (this can be viewed
through the Detailed Log for Data Types only). Note that you
cannot select or change data typesthis is just a method of archiving
data from each data category. You can, however, define the scope of
an archive by data items (see Data Items on page 13-18) and the
plant hierarchy items included (see Groups and/or Assets on page
13-18).
For a list of the data types in each data category, see Abbreviated
Names for Data Types on page 13-94.
Data Items
Archive definitions include a data item scope, which can be as broad or
narrow as required. You can archive data based on the collection
method (a very broad definition), or use particular data items within a
collection category (a much narrower definition). You can define a
scope down to the item level for accumulators, events, and identifiers,
but only down to the collection category for incidents.
These data items provide the kind of data you want to archive. For
example, you could choose to archive the data category accumulators,
but select to archive only the cycle time data item.
Groups and/or Assets
The archive you create can be for specific groups or assets. By default,
an archive definition includes all groups and assets in the plant
hierarchyyou must determine for which groups/assets you want data
categories or items to be archived.
What Does the Scope Include?
By default an archive definition includes all the data types under the
selected data category, and all groups and assets in the plant. If you
need an archive definition to deviate from the default, you can define
as narrow a scope as is needed. Since the default scope is global, it
might have no relevance to other aspects of the scope. For example,
you may choose to archive particular data items from the global list,
but then choose to archive data for assets from which these data items
were not collected. In this case, the database provides an error
message.
Data Management
CDC Factory 7.1
ActivEssentials Administration Guide
13-19
The global nature of the scope also extends to inactive plant hierarchy
items, and inactive collection categories and data items. When a scope
includes inactive items, the database can still archive and purge these,
but once all of the data has expired, there can be no further
processing. However, if items are reactivated, processing can restart.
Age Before Expiry
All data in the database has a useful life time, but beyond that there
might be no need to have it instantly available. As a part of the archive
definition, you must set an age in days at which the data expires.
When the data has expired, the database marks it for the next
archiving and/or purging jobs. The age before expiry has to be equal
to or greater than seven days, but there is no maximum age.
Archiving Actions
There are three actions that you can apply to an archiving definition.
They are:
Archive. In this case ActivEssentials copies the data to a separate
archive file, leaving the original data in the database.
Archive and Purge. In this case the data is marked first for
archiving. When the next archive job runs, ActivEssentials archives
the data, then removes it from the database. You can restore the
data from the archive if you ever need it.
Purge. In this case the data will be purged (removed) from the
database without any backup procedureyou cannot retrieve it.
Use this option only if you are sure that you will never need the
data again.
Oldest Date in Archive
This is the date of the earliest data in the archive. If you have not
previously defined any archiving activity, you may have data in your
database that is old enough that it is of no further use, so you might
want to remove it from the database. Alternatively, in setting up your
data collection system you might have accumulated some dummy
data over a period of several days or weeks. This data is not part of
your real manufacturing data, so you might not want to archive it. To
prevent the archiving of data that is too old does not have real
manufacturing importance, you can specify the oldest date for to
archive meaningful data.
Example
You begin setting up your system on January 15th, creating data
categories, security privileges, etc. Over the next month you create
quite a lot of dummy data as a result of different configuration steps.
Your system is finally ready to start collecting real data on February
21st. When you create an archive definition, you set February 21st as
the oldest date for data archiving, and allow the database to archive
everything since that time.
Data Management
CDC Factory 7.1
ActivEssentials Administration Guide
13-20
The oldest date for archiving must be earlier than todays date minus
the time before the data expires. For example, if todays date is March
31st 2006 and the data is set to expire after 60 days, the oldest date
for archiving must be earlier than January 30th 2006. If you attempt
to set it to a more recent date, the database returns an error
message.
You can change the oldest date for archiving at any time if archiving
has not begun.
Database Performance During a First
Archive
If you set the database to archive data that is older than a certain
point, and previous archives have not been made, the database starts
with the oldest data and will continue archiving it, in batches of seven
days, until it catches up. During this time the database will also start
archiving the most recently expired data from the same dataset,
increasing processing load, and thereby affecting database
performance.
Example
If you set the database to archive data that is older than 365 days on
a weekly basis, but there is data as old as 1000 days, the database will
start archiving the very oldest data in batches of seven days, and do
this every day. After the first seven days of archiving, data for the
oldest 49 days (seven weeks) has been archived. At this point the
database also starts archiving the data that has just expired, i.e. data
that is now 366373 days old.
It is important to devise an archiving strategy from the outset of data
collection. The performance of the database computer is governed by
the total amount of processing required at any one time, so you must
balance the needs for adequate archive creation and day-to-day
system performance.
Purging as an Archiving Activity
If you create an archive definition that includes purging (that is, the
action is to either Purge only or Archive and Purge), the data is
marked for removal from the database. It is not actually removed until
a purging job runs. When the purging job runs, all rows marked for
removal are purged at that time, subject to the maximum number of
rows that can be removed in one job (see the note below).
Note: All data is archived in files that represent exactly seven days worth of data,
with the start point being 12:00 A.M. on the Monday of each week. The only
exception is with the very first archive, as the oldest date for archiving might be
something other than a Monday.
Data Management
CDC Factory 7.1
ActivEssentials Administration Guide
13-21
If you change the archive definition during the time between the
archive job and the purging jobthat is, while the data marked for
purging is still in the databasethe new configuration takes effect
immediately. So, for example, if you change an archive definition from
Purge to Archive and Purge, the database will not remove the data
until it has been archived.
Note: There is a setting in the System Settings module that determines the maximum
number of database rows that can be removed in a single job (see System
Settings on page 2-1), which, by default, is set at one million. Purging jobs that
exceed this number are split to run on successive days. For example, if 2.5
million rows must be removed, the database purges one million on the first day,
one million on the second day, and the remainder on the third day.
Data Management
CDC Factory 7.1
ActivEssentials Administration Guide
13-22
Understanding the Properties of Archives and
Archive Files
Before ActivEssentials can start any archiving activity, you must define
the data required and what actions the database must perform when
archiving occurs. The word archiving is used loosely here, as the
instructions to the database do not have to include the creation of an
archiveyou can set the database to simply purge any expired data.
The database keeps track of its archiving activity, even if the data has
been purged. You can view the process in the archive master logs. If
archive files were created, you can also interpret the content of the
files from the automatically generated file names.
This section covers the following topics:
What to Expect When Creating Archive Definitions on page 13-23
The Properties of Archive Files on page 13-24
Archive Configuration Best Practices on page 13-25
Note: Before you can set up any archiving you must choose a working folder for the
archive files. See Setting up Data Archiving in System Settings on page 13-11
for information on how to do this.
Data Management
CDC Factory 7.1
ActivEssentials Administration Guide
13-23
What to Expect When Creating Archive
Definitions
Archive definitions are created in the Add New Archive wizard. For
more detailed information about the archiving options, see Options for
Data Archiving on page 13-17. When creating a new definition, you
need to consider the following:
Archive Name. Must be unique, and no more than 255
characters.
Data category. The kind of data to include in an archive, such as
the data collected using a particular collection method. For all data
categories you can specify the collection categories, but for some,
you can also specify individual data items.
Processing action. This is the instruction to the database about
what it should do with the data. There are three options:
Purge only. Delete the data defined in the scope from the
database without making an archive copy. All record of the data
is lost.
Archive and Purge. Archive the data defined in the scope,
and delete it from the database once the archiving is complete.
Archive only. Make an archive copy of the data, but to then
leave the data in the database.
Active. This causes the archive definition to have immediate
effect. If a definition is de-activated, archiving stops, but can be
restarted. Data designated for archiving in an inactive definition
cannot be added to another definition.
Verify. Upon completing an archiving task, the database can verify
that the data in an archive is identical to the original by restoring
the data to a temporary table in the database and comparing it to
the original. If the restored data passes the verification tests, the
temporary data is removed. The original data is then also removed
if the archiving instruction was to archive and purge.
Data Age (Days). This is the maximum age of the data before the
database marks it for processing. This date must be equal to or
greater than seven days, as data is archived in units of one week
(see Basic Process Time Unit on page 13-91 for more information).
Data that expired during one week can be archived during the
following week.
Earliest date for archived data. When preparing an archive
definition, you must set a date for the oldest data in your archive
definition. Data before this date is not processed, but you must
indicate whether this older data should remain in the database or
Data Management
CDC Factory 7.1
ActivEssentials Administration Guide
13-24
be removed. The database can purge data that is older than this
date, even if the archive definition states that the action is archive
only.
Scope definition. The default is to archive all data that was
collected using the data category, but you can limit this scope as
follows:
Groups/Assets Scope. You can select all groups and assets,
and then deselect those whose data you do not need to
archive. You can also approach this from the other direction, by
deselecting all groups and assets and then reselecting those
whose data you need to archive. Use the method which is
easiest for you.
Data Items Scope. You can select all data collection
categories, and then deselect categories you do not need to
archive. Alternatively, you can select just the categories you
need. When you select a data collection category, you are
selecting all of the data items that it contains. You can also
open a category and select the data items you need to archive.
You can combine these methods to produce highly focused
archives.
The Properties of Archive Files
When archiving, the ActivEssentials database automatically generates
files that contain just the data defined in an archive definition. These
files are your database backup, so it is important to safeguard these.
In managing your archives, you should consider the following:
When the ActivEssentials database automatically generates the
archive files, it stores them in the working folder you define
through either the Data Management module, or through the
ActivEssentials System Properties.
You can move files from the working folder to a safe location
elsewhere (for example, to off-site storage). If you do so, when
you want to restore data you will have to provide the path to the
source folder. The default location is the working folder, but you
can restore data from any location that is accessible across the
network, including, for example, a CD-ROM drive. Before restoring,
ensure that appropriate share privileges have been granted.
Archive file names are generated automatically by the
ActivEssentials database. You must not change the file names. The
generated file names contain information about the content of the
files. If you change the file names, SQL Server has to open each of
the files to examine the contents before it can begin the
Data Management
CDC Factory 7.1
ActivEssentials Administration Guide
13-25
restorationa process that can significantly slow down a restore
job. For information about automatically generated file names, see
The Archive Files on page 13-92.
If you choose to compress your archive files for storage (for
example, in a zip file), you will have to unzip them to a folder if you
want to restore data later on. SQL Server cannot read inside
compressed files.
ActivEssentials keeps a record of all archiving, purging, and
restoring jobs so that there is detailed information about this
activity. For more information, see the following:
Understanding the Archive and Restore Logs on page 13-26
Viewing the Archive Master Logs on page 13-57
The archive files are prepared in a proprietary binary format that
makes it very difficult to read the content. As a further safeguard,
there is no header information in the files, so the archived raw data
has no context outside of the database.
When archiving, you have an option to verify the integrity of the
just archived data. Upon completing an archive, the database
immediately restores the data to a temporary database table and
compares the restored data to the original. Files that do not pass
this test are discarded, and the data is archived again.
During archiving, the database keeps a log of the activity for each
archive file. This log contains information about the file, including
the number of records, the file size and date, etc. When restoring,
you can have the database verify that a file is in the same
condition as when it was originally prepared. The data in files that
does not pass this test is not restored.
For more information about the archive files, see The Archive Files on
page 13-92.
Archive Configuration Best Practices
When setting up your archiving solutions, you should consider the
following to create relevant archives and optimize database
performance while processing:
It is better to set the focus of an archive definition to a data
category than to a plant hierarchy item. If some of the data items
within a category do not apply, you can easily exclude them.
Always set a date for the oldest data to include in the archive, even
if all of the data is valid production data.
While you can change the archive action (archive only, archive and
purge, or purge only) for an archive definition, it is best not to do
this once processing has started.
Define your archive definitions according to business needs, not
database performance.
Data Management
CDC Factory 7.1
ActivEssentials Administration Guide
13-26
Understanding the Archive and Restore Logs
The logs detail all of the archive and restore activity; they do not
contain the actual data, but information about when archiving,
purging, and restoring took place. Depending on the kind of log, the
information in logs could contain the date range for the archived/
restored data, the action the database had to perform when handling
each archive definition (purge only, archive and purge, or archive
only), the present status of any archiving/restoring activity, etc. The
log entries detail each instance of all archive definitions and restore
definitions, both those performed through a schedule and those
initiated manually.
Master logs give a global view of the archiving activity; detailed logs
provide specific information about the data categories and groups/
assets that were archived.
This section covers the following topics:
The Properties of Archive Files on page 13-24
Understanding the Archive Detailed Logs on page 13-29
Understanding the Restore Data Logs on page 13-32
Managing the Archive Logs on page 13-35
The Properties of the Archive Master Log
The master log is the global record of all the archiving activity. The
detail in this log is limited to the transactional side of the archiving
activity: the date range, the archiving instruction (purge only, etc.),
the archive status, etc. There is no detailed information about the data
being archived in the log.
Data Management
CDC Factory 7.1
ActivEssentials Administration Guide
13-27
You can view the properties in two ways: through the Archive Logs
grid, or through a properties dialog box for an individual archiving
instance. The Archive Logs provide details of each archiving job in the
grid layout:
Archive Name. The name used to identify the archive definition.
Data Category. The type of data that exists in the archive.
Data Start Time. This is the start date and time (always 12:00
A.M. on a Monday) of a weekly archive span. The archive includes
data captured at the start time and in the following seven days.
Data End Time. Each archive captures the data for exactly seven
days, so the end date is the same as for the next Start Time.
Processing Action. This is the instruction to archive only, archive
and purge, or purge only when the archive definition runs.
Changing the Processing Action does not affect previously archived
data or a job that is presently underway.
Status. This is the current condition of the archiving job, which
can be any of the following:
To be archived. The archiving is scheduled but has not yet
started.
Archive in progress. The database has started to archive the
data.
Archive completed. The database has completed the
archiving for the job for the specified week.
Archive cancelled. A user has cancelled the archiving job. The
database does not purge any data even if the archive definition
called for the data to be removed from the database after
archiving.
To be purged. The data has been marked for purging but the
purge has not yet started.
Purge in progress. The database has started to purge the
data.
Purge completed. The database has finished purging the
data.
Purge cancelled. A user has cancelled the purging job. If a
purging job is cancelled, the database stops immediately.
Already deleted data cannot be recovered unless it was
previously archived.
You can view the status of any archive and/or purge job in the
Archive Logs view of Data Management. For more information, see
Viewing the Archive Master Logs on page 13-57.
Archive Progress (%). The percentage of the archiving job that
the database has completed. This can relate to various archive
status conditions: 0% equates to To be Archived, >0% and
<100% equates to Archive in Progress, and 100% equates to
Archive Complete.
Archived Rows. This is the number of rows archived from the
database during the archiving job. If an archive is in progress, the
number in the column is the number of rows archived to that point.
Data Management
CDC Factory 7.1
ActivEssentials Administration Guide
13-28
Since the number of rows could vary with each archiving job, the
number should not be used as a measure of archiving progress.
Purge Progress (%). The percentage of the purging job that the
database has completed. Assuming that the archive job includes an
instruction to purge, this number can relate to various archive
status conditions: 0% equates to To be Purged, >0% and <100%
equates to Purge in Progress, and 100% equates to Purge
Complete.
Purged Rows. This is the number of rows purged from the
database during an purging job. If a purge is in progress, the
number in the column is the number of rows purged to that point.
If the data had been previously archived, the total number of rows
appears in the Archived Rows column. The purged rows could
then be compared with archived rows to view progress.
Start Archiving Time. This is the time at which the archiving job
started. Archiving jobs depend on the archive schedules in SQL
Server, so the start date might occur some time after the data
expires.
Finish Archiving Time. This is the time at which an archiving job
completed handling the data in the archive definition.
Start Purging Time. If data is to be purged and the job has
started, this is the time at which it started.
Start Purging Time. This is the time at which the database
started purging the data in the archive definition. Purging jobs are
subject to the purge schedules in SQL Server, but can only run
after any required archiving activity has completed.
Note: An indication that the number of archived rows is zero could be ambiguous. If
there is no data to archive, a completed job would have zero rows.
Note: An indication that the number of purged rows is zero could be ambiguous. If
there is no data to purge or if the archive definition did not include an instruction
to purge, a completed job would have zero rows.
Note: If an archive definition is purge only, the start time is Not Applicable.
Note: If an archive definition does not call for data to be purged from the database,
the start time is Not Applicable.
Data Management
CDC Factory 7.1
ActivEssentials Administration Guide
13-29
Finish Purging Time. This is the time at which a purging job
completed handling the data in the archive definition.
Daylight Saving Time. This is an indicator of whether the
archived data includes any data captured during the changeover
period when Daylight Saving Time ends.
Data Verification. This property indicates the data verification
status of the archived data.
Passed Verification
Failed Verification. The archive job remains in progress until a
later archiving attempt passes verification.
No data to verify
Created by. This identifies the user who initiated a manual action.
Error Message. This identifies the time and the detail of any error
message returned if an archiving job fails. If the job is later run
successfully, the message is over-written.
Understanding the Archive Detailed Logs
From the archive logs, you can view the detailed information for a log
by right-clicking and selecting the Detailed Log for Data Types from
the context menu.
The Detailed Log for Data Types shows detailed information
about the data types within the data categories that you defined
for archiving. The data types log shows the archiving activity from
its data type origin, not from where the data was physically
collected.
When the Detailed Log for Data Types is open, you can view
right-click and view the Detailed Log for Groups/Assets. This
subordinate log displays data only for the selected data type in the
Detailed Log for Data Types. You cannot edit anything in either of
the logs.
Properties in the Archive Detailed Log for Data
Types
For each instance of an archive definition, the database prepares a
detailed log that includes information about the data types included in
the archive file. The information appears in the Detailed Log for
Data Types, and is visible through the Archive Logs module of Data
Management.
Note: While the master log summarizes the archiving activity, it does not provide
information about the data in the archive. To view specific details about the
archives, you need to view the Detailed Log for Data Types, or the Detailed Log
for Groups/Assets.
Data Management
CDC Factory 7.1
ActivEssentials Administration Guide
13-30
To view the log, you select an instance of the archive definition in the
grid, and then click the Detailed Log for Data Types button on the
toolbar. When the log opens, the grid displays the status of various
aspects of when the archive definition ran. The grid has the following
columns:
Data Type Name. This is the name of the data type. The naming
and variety of data types differs with each data category, but for
each instance of an archive job that involves a particular data
category, the number of rows in the log is the same.
File Name. When archiving, the database uses a naming
convention for the archive files it creates. See The Archive Files on
page 13-92 for more information about file names. There is
separate file for each Description.
File Size (bytes). This is the size of the archive file, which is
important to the data verification process.
Archive Status. This is the status of the data in the selected
archive definition:
To be Archived
Archive in Progress
Archive
Archived Rows. This is the number of rows from the database
that have been archived. If the archive is in progress, the number
of archive rows is the number archived so far.
Purge Status. This is the status of the data in an archive
definition marked for purging.
To be Purged
Purge in Progress
Purge completed
N/Ano data to purge
Purged Rows. This is the number of records that have been
removed from the database. If the purge is in progress, this is the
number purged so far.
Note: You can also view detailed logs for restore definitions, but the range of data is
different. See Understanding the Restore Data Logs on page 13-32 for more
information.
Note: If an execution of an archive definition is cancelled, the database does not
generate the detailed log.
Note: If the archive action is to archive only, the Purge Status column does not
appear in the Detailed Log for Data Types dialog box.
Data Management
CDC Factory 7.1
ActivEssentials Administration Guide
13-31
Properties in the archive Detailed Log for
Groups/Assets
The Detailed Log for Groups/Assets shows archiving information
about the groups/assets that have been archived in each definition.
For example, if the archive includes data from five assets, there are 5
entries in the log.
You can view the Detailed Log for Groups/Assets from the Archive
Logs view of Data Management. You select an instance of the archive
definition in the grid, and then click the Detailed Log for Data Types
button on the toolbar. When the dialog box opens, right-click on one of
the entries and select Detailed Log for Groups/Assets. A new
dialog box displays one row for each asset. Within the dialog box is a
grid that is organized into the following columns:
Group/Asset Name. This is the asset name, including the path
down through the plant hierarchythere is one row for each asset
in the scope. The number of rows is determined by the scope of the
archive definition and the number assets from which data was
collected using the selected data type.
Archive Status. This is the status of the data for the group/asset.
In the interface the status is reported as follows:
To be Archived
Archive in Progress
Archive Completed
Archive Cancelled
N/Ano data to archive
Archived Rows. This is the number of rows for the group/asset
that have been archived. If the archive is in progress, this is the
number archived so far..
Purged Status. This indicates whether the data for the groups/
assets has been purged. In the interface the status is recorded as
follows:
To be Purged
Purge in Progress
Purge Completed
Purge Cancelled
N/Ano data to purge
Purged Rows. This is the number of rows from the database that
have been purged. If the purge is in progress, this is the number
purged so far.
Note: If the archive action is to archive only, the Purge Rows column does not appear
in the Detailed Log for Data Types dialog box.
Data Management
CDC Factory 7.1
ActivEssentials Administration Guide
13-32
Understanding the Restore Data Logs
In the Restore Data view in Data Management you can initiate the
restoration of data from the archives. The initial view is of all of the
scheduled restore definitions.
From the grid, you can access a series of nested dialog boxes that
show the restored data from different perspectives. You access each
dialog box either from the an entry in grid or from an open dialog box,
where the focus of the presented information is taken from the parent
view.
1 From a restore definition entry in the Restore Data grid you open
the Restore Logs dialog box, where you can view entries for each
week that occurred during the span of time defined in the restore
definition.
2 From a week in the Restore Logs dialog box you open the
Detailed Log for Data Types dialog box, where you can view
entries for each of the data types that exist in the data category
involved in the selected week.
3 From a data type entry in the Detailed Log for Data Types you
open the Detailed Log for Groups/Assets, where you can view
entries for each asset whose historical data involved the selected
data type.
At each level in this hierarchy, you can view the status of the data
involved in the restore definition, including the number of rows
restored, the overall progress, etc. Each of the subordinate dialog
boxes presents information in columns that is pertinent to the item
selected in the parent view of the data.
Data Management
CDC Factory 7.1
ActivEssentials Administration Guide
13-33
Properties Available in Restore Data Grid
The Restore Data view presents information about each restore
definition through a series of columns. Each time you request a restore
definition, a new row is added to the Restore Data grid.
Archive Name. The name of the archive definition used for
archiving the data.
Data Category. The kind of data (data that was collected using a
particular collection method) that is contained in the archive.
Data Start Time. The start date and time for the data in the
restore definition.
Data End Time. The end date and time for the data in the restore
definition.
Restore Schedule. The time at which the data is scheduled for
restoration.
Finish Time. The time at which the restoration job finished.
Status. The status of the restore definition, which can be any of
the following:
To be Restored
Restore in Progress
Restore Completed
Restore Cancelled
Restore Failed
Read Only. The condition of the data when restored, which can be
either of the following:
Yes. The data is or has been restored in a read-only condition.
You cannot make change this historical data. You should purge
this data once you have finished viewing it.
No. The data will be or has been restored in a writeable
condition. This means you can change the data if needed, but it
should then be reprocessed.
Re-archive Status. If data has been restored in a writeable
condition, this notes the status of the reprocess job, if scheduled.
Created Time. The date and time the restoration was requested.
Note: If the original data was archived using an Archive Only instruction, the data
remains writeable in the database. In this instance, if you apply the Read Only
attribute when restoring data, it has no effect.
Note: If data is restored in a writeable condition, and the data start and end times do
not coincide with the archive weeks, the archive files for all weeks involved in
the restoration are restored in their entirety.
Data Management
CDC Factory 7.1
ActivEssentials Administration Guide
13-34
Properties in the Restore Logs
The Restore Logs contain one entry for each week of archiving
involved in the restore definition.
Data Start Time. This is the start date and time of the range of
data in the restore definition. If more than one week is involved,
this date is different on each row.
Data End Time. This is the end date and time of the range of data
in the restore definition. If more than one week is involved, this
date is different on each row.
Status. This is the status of the restore definition. The status
notations are the same as seen in the Restore Data grid.
Restore Progress. This is the degree to which the restore is
complete, expressed as a percentage, for the week of data being
restored. If the restore definition involves more than one week, the
Restore Progress might vary for each week.
Restored Rows. For each week involved in the restore definition,
the number of restored rows to the database is recorded. If the job
is incomplete, this is the number of rows restored so far.
Re-archive Status. If data has been restored in a writeable
condition, this notes the status of the re-archive job, if scheduled.
Re-archive Progress. For each week in the restore definition, this
is the degree to which, expressed as a percentage, re-archiving
has occurred.
Error Message. If errors occur during the restore process, the
database provides a message that identifies the problem.
Properties in the Restore Detailed Log for Data
Types
Data is primarily archived and restored by the data types of the
individual data categories. For each restore definition, and for each
week in the restore definition, you can view the restore status for each
of the data types.
Note: If the restore definition involves more than week, you might see varying
statuses if the overall restore definition is still in progress. Some weeks maybe
complete, but others might still be awaiting restoration.
Note: You can also view detailed logs for archive jobs, but the range of data is
different. See Understanding the Archive Detailed Logs on page 13-29 for more
information.
Data Management
CDC Factory 7.1
ActivEssentials Administration Guide
13-35
Data Type Name. This is the name of the data type. The naming
and variety of the data types differs with each data category, but
for each instance of a restore definition that involves a particular
data category, the number of rows in the log is the same.
Restore Status. This the status of the restore definition for each
data type. Although all the data types for a particular data
category appear in the log, there may be instances where data of
that kind was not collected, and so cannot be restored.
Restored Rows. This is the number of rows restored to the
database for each data type. If the job is incomplete, this is the
number of rows restored so far.
Properties Available in the Restore Detailed Log
for Groups/Assets
When restoring data, you can view the progress of a restore definition
by groups and assets. The range of groups and assets you can view is
determined by the data type you select. Therefore, the various data
types might yield a differing set of groups and assets, depending on
the kinds of data collected at the group/asset level.
Group/Asset Name. This is the name of the asset, including its
path.
Restore Status. This is the status of the restore definition for the
selected asset.
Restored Rows. This is the number of rows restored to the
database for each of the assets. If the job is incomplete, this is the
number of rows restored so far.
Managing the Archive Logs
The Archive Logs module within Data Management displays a grid with
a separate column for almost all of the data recorded in the master
logs for each archiving activity. You can also view the detail logs for
the data types and the groups and/or assets.
To manage the number of log entries, the database provides options
for controlling log sizes, so you can:
Remove the detailed logs for the groups and assets that refer to a
period prior to a defined date. The master and detail data type logs
are retained. Archived files can still be restored, but without asset
level validation.
Set a schedule for removing all log entries before a certain time
(for example, last month, 2 months ago, etc.).
Data Management
CDC Factory 7.1
ActivEssentials Administration Guide
13-36
Initial Configuration of Data Management
The initial configuration allows you specify the data you need to
archive, and when the database should go about this task. Once you
have set up the archiving configuration, the process is automatic.
This section covers the following topics:
Creating a New Archive Definition on page 13-36
Creating an Archive or Purge Schedule on page 13-40
The Schedule Types on page 13-44
The Archive and Purge Jobs on page 13-44
Creating a New Archive Definition
Use the instructions below to create a new data archive definition. You
must create at least one archive definition before any archiving can
occur. Once created, the ActivEssentials database starts running the
definition within the scheduled archive jobs.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Data Management task module using the
instructions in Opening the Data Management Module on page
13-3.
If necessary, set up the environment variables using the
instructions in Setting the Working Folder and Other Archive
Settings on page 13-13.
Read What to Expect When Creating Archive Definitions on page
13-23.
Procedure
1 In the Data Archiving frame, click the Archive Configuration
icon.
The grid refreshes to display all of the data archiving jobs you have
already defined.
2 Click the New button on the toolbar.
The Add New Archive wizard starts.
3 Click Next to move past the welcome page.
Data Management
CDC Factory 7.1
ActivEssentials Administration Guide
13-37
Figure 13-8 The Archive Configuration page of the wizard
4 Do each of the following:
a) In the Archive Name text box, type a name for the archive.
The name has to be unique and no more than 255 characters.
b) In the Data category field, click the down-arrow and select a
data category type.
c) In the Processing action field, click the down-arrow and
choose the appropriate processing action.
d) If the archive definition should take immediate effect, select
the Active checkbox.
e) If you need the database to check that the archived data is a
true copy of the original, select the Verify checkbox.
5 Click Next.
Note: While there are no restrictions to the characters you can use in an archive
name, you should avoid the use of commas because these affect the filtering
options in the Archive Logs and Restore Data grids.
Data Management
CDC Factory 7.1
ActivEssentials Administration Guide
13-38
Figure 13-9 The Life Time and Oldest Date for Archiving page
6 In the Archive Date Range groupbox, do the following:
a) In the Data Age spin box, set an age in days for the data after
which it is considered to have expired and is then subject to the
processing instruction.
b) To the right of the Start processing data field, click the
ellipsis button and select a date and time from which archiving
should begin.
c) If you want data that is older than the start date to be
removed, select the Delete data prior checkbox.
7 In the Scope Definition groupbox, do one of the following:
a) If you want to archive all of the data for all groups and assets,
ensure the Include all checkbox is selected and finish the
definition.
b) If you need to redefine the scope, clear the Include all
checkbox and click Scope.
Note: During the initial set up of ActivEssentials you might have collected dummy
data that you do not need to archive. If so, you can set a date at which
archiving should begin and delete data that is older than this.
Note: By default, the archive definition includes all groups and assets in the plant,
and all data items collected under the specified data category. You can change
the scope of the definition by identifying specific groups and/or assets, and
data items (collection categories).
Data Management
CDC Factory 7.1
ActivEssentials Administration Guide
13-39
Figure 13-10 The Archive Configuration Scope editor
8 Click the Groups/Assets Scope tab, then click Add.
Figure 13-11 The Groups/Assets Selector
9 In the Groups/Assets Selector, select the combination of groups
and assets you need to add to the archive definition, and then click
OK.
The selected groups/assets appear in the grid of the Archive
Configuration Scope editor.
10 Click the Data Item Scope tab, then click Add.
Data Management
CDC Factory 7.1
ActivEssentials Administration Guide
13-40
Figure 13-12 The Data Item Selector
11 In the treeview, expand the data category and select the
checkboxes to obtain the specific data categories and data items
that you want to archive.
12 Click OK to accept the data items scope.
13 Click OK on the Archive Configuration Scope editor.
The editor closes.
14 Click Next on the Life Time and Oldest Date for Archiving page
of the wizard.
The final page of the wizard opens.
15 Review your settings, and then click Finish.
Creating an Archive or Purge Schedule
Use the instructions below to set up times for archiving and purging.
You can create a schedule from any of the three views within the Data
Management task module.
Note: For some data categories, you can only select from the collection categories,
but for others, you can select data items.
Note: On the Scope Selection dialog box, you can verify your scope by clicking
Scope Validation. If valid, the database confirms.
Note: You can have up to three schedules for both archiving and purging jobs.
Data Management
CDC Factory 7.1
ActivEssentials Administration Guide
13-41
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Data Management task module using the
instructions in Opening the Data Management Module on page
13-3.
If necessary, set up the environment variables using the
instructions in Setting the Working Folder and Other Archive
Settings on page 13-13.
Read The Schedule Types on page 13-44.
Procedure
1 Click Archive Settings on the toolbar.
The Archive Settings dialog box opens.
2 Do one of the following:
a) To create a new archive schedule, select the Archive
Schedules tab.
b) To create a new purge schedule, select the Purge Schedules
tab.
Figure 13-13 The Archive Schedules tab
3 Click Add.
The Add New Schedule wizard starts.
4 Click Next to move past the Welcome page.
Note: The interface on both tabs is identical, but the schedules created for archiving
and purging appear only on their respective tabs. The process for creating both
kinds of schedules is the same.
Data Management
CDC Factory 7.1
ActivEssentials Administration Guide
13-42
Figure 13-14 The Schedule Configuration and Options page of the wizard.
5 Do both of the following:
a) In the Name field, type a unique name for the schedule.
b) Click the down-arrow to the right of the Schedule type field
and select the kind of schedule you need to use.
6 Click Schedule Options.
The Schedule Options dialog box opens.
7 Do one of the following in the Recurrence pattern groupbox:
a) For a Daily schedule, click in the Every day(s) field, and use
the up- or down-arrows to set the interval between each
instance of the schedule.
b) To set up a Weekly schedule type, do the following:
Click in the Every week(s) field, and use the up- or
down-arrows to set the interval between each instance of
the schedule.
In the checkboxes below, select the days during the
scheduled week when archiving should occur.
c) To set up a Monthly schedule type, do the one of the following:
To choose a particular date, first select the top radio button,
then use the up- or down-arrows in the Day field to select a
day in the month, then use the up- or down-arrows to
select an interval in months.
To choose a day in the month, select the second radio
button, then use the drop-down lists to describe the day,
then use the up- or down-arrows to select an interval in
months.
Data Management
CDC Factory 7.1
ActivEssentials Administration Guide
13-43
Figure 13-15 The Monthly options for scheduling
8 In the Frequency pattern groupbox, select either to run the
schedule once on the day(s), or construct a pattern for multiple
instances on the day(s).
9 Click OK.
10 When the Schedule Options dialog box closes, click Next.
The final page of the Add New Schedule wizard opens.
11 Check the details on the page and click Finish.
12 When the Add New Schedule wizard closes, click OK on the
Archive Settings dialog box.
Data Management
CDC Factory 7.1
ActivEssentials Administration Guide
13-44
The Schedule Types
You can assign one of several different schedule types to a schedule.
These schedule types let you run your schedules daily, weekly, or
monthly. Any one schedule can include several instances of archiving
or purging. The schedule types are as follows:
Daily. In a Daily schedule, the interval between each occurrence of
the schedule is measured in days; this does not mean that it runs
every day. The cycle for a daily schedule could be every 14 days,
but the schedule could run several times within this cycle.
Weekly. In a Weekly schedule, the interval between each
occurrence of the schedule is measured in weeks, but it need not
run every week. A weekly schedule could run every 4th week on
the Monday and Thursday that follow the start date, and then
every six hours on those days.
Monthly. In a Monthly schedule, the interval between each
occurrence of the schedule is measured in months; this does not
mean it runs every month. A monthly schedule could start on the
15th day of every third month, but then run every four hours that
day.
The Archive and Purge Jobs
Archiving and purging occur as a result of jobs that run in SQL Server,
but you can make changes to the scheduling through the Data
Management interface. You can modify, delete, or define up to three
instances of archiving or purging schedules.
Database Performance and Schedules
A system property defines the number of assets to include in each
archiving and purging jobthis is the BPDU (Basic Process Data Unit).
Archiving and purging activity can affect database performance, so the
BPDU controls how much data is included in each execution. See Basic
Process Data Unit on page 13-91 for more information about how to
relate the number of executions to the number of assets. When setting
up archiving and purging, you can control the number of executions
during a particular period.
Data Management
CDC Factory 7.1
ActivEssentials Administration Guide
13-45
Maintaining Configuration in Data Management
From time to time, you might need to modify the way ActivEssentials
archives the data you collect during your production activities. Most of
the archiving activity is automatic, but you can change the archiving
parameters and other settings if you need.
This section covers the following topics:
Editing the System Archive Settings on page 13-45
Modifying Archive and Purge Schedules on page 13-46
Deleting Archive and Purge Schedules on page 13-49
Deleting Archive Definitions on page 13-50
Editing the System Archive Settings
Use the instructions below to edit the System Archive settings.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Data Management task module using the
instructions in Opening the Data Management Module on page
13-3.
Set archive settings using the instructions in Setting the Working
Folder and Other Archive Settings on page 13-13.
1 Click the Archive Settings button on the toolbar.
The Archive Settings dialog box opens.
2 Click the System Archive Settings tab, if not already selected.
Figure 13-16 The System Archive Settings tab
Data Management
CDC Factory 7.1
ActivEssentials Administration Guide
13-46
3 If you need to change the working folder, click the ellipsis button by
the Working Folder for Data Archive field.
The AppCenter Shared Folder Browser opens. The currently
selected working folder is noted as the Current location.
Figure 13-17 The AppCenter Shared Files Browser
4 Browse to and select a new folder and then click OK.
5 Do each of the following, as needed:
a) Click in the Number of Assets or Groups to Archive and
Purge field, and change the number of assets and groups.
b) Click in the Number of Assets or Groups to Restore field,
and change the number of assets and groups.
c) Click in the Weeks to Keep Archive and Restore Detailed
Logs field, and change the number of weeks.
The default is 0, which means unlimited.
6 Click OK.
Modifying Archive and Purge Schedules
Use the instructions below to modify the schedules for archiving and
purging.
Note: For more information about the values for the number of assets to archive and
purge, and the number to restore, see Basic Process Data Unit on page 13-91.
Note: This setting affects only the Detailed Log for Groups/Assets. If you use any
setting other than the default, the database will eventually delete the log. This
does not prevent you from restoring the data later, but it does prevent asset
level validation.
Data Management
CDC Factory 7.1
ActivEssentials Administration Guide
13-47
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Data Management task module using the
instructions in Opening the Data Management Module on page
13-3.
Read The Schedule Types on page 13-44.
Procedure
1 Click the Archive Settings button on the toolbar.
The Archive Settings dialog box opens.
2 Do one of the following:
a) To modify archiving schedules, select the Archive Schedules
tab.
b) To modify purging schedules, select the Purge schedules tab.
Figure 13-18 The Archive Schedules tab
3 In the grid, select the schedule you need to alter, and click Modify.
Note: The process for modifying both kinds of schedules is the same.
Data Management
CDC Factory 7.1
ActivEssentials Administration Guide
13-48
Figure 13-19 The Schedule Properties editor
4 If you need to change the name of the archive or purge schedule,
click in the Name field and edit the name.
5 If you need to change the structure of the schedule, do the
following:
a) Click the down-arrow to the right of the Schedule Type field,
and select an appropriate type from the drop-down list.
b) Click the Schedule Options button.
The Schedule Options dialog box opens.
6 Do one of the following in the Recurrence pattern groupbox:
a) To modify a Daily schedule, click in the Every day(s) field,
and use the up- or down-arrows to set the interval between
each instance of the schedule.
b) To modify a Weekly schedule type, do the following:
Click in the Every week(s) field, and use the up- or
down-arrows to set the interval between each instance of
the schedule.
In the checkboxes below, select the days during the
scheduled week when archiving should occur.
Note: The Schedule Options dialog box allows you to specify patterns for when the
schedule should run. All of the schedule types let you specify the time(s) during
the day a schedule should run (the Frequency pattern), but the various
schedule types offer different structures for the day(s) on which the archiving
runs.
Data Management
CDC Factory 7.1
ActivEssentials Administration Guide
13-49
c) To modify a Monthly schedule type, do the one of the
following:
To choose a particular date, first select the top radio button,
then use the up- or down-arrows in the Day field to select a
day in the month, then use the up- or down-arrows to
select an interval in months.
To choose a day in the month, select the second radio
button, then use the drop-down lists to describe the day,
then use the up- or down-arrows to select an interval in
months.
Figure 13-20 The Monthly options for scheduling
7 In the Frequency pattern groupbox, select either to run the
schedule once on the day, or construct a pattern for multiple
instances on that day.
8 Click OK.
9 When the Schedule Options dialog box closes, click OK.
Deleting Archive and Purge Schedules
Use the instructions below to delete an archive or purge schedule.
When you delete a schedule, you are removing a set of instances of
when archiving or purging can occur, but this does not prevent these
activities from occurring.
Note: You must leave at least one schedule for both archiving and purging. The
database will return an error if you try to delete all schedules.
Data Management
CDC Factory 7.1
ActivEssentials Administration Guide
13-50
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Data Management task module using the
instructions in Opening the Data Management Module on page
13-3.
Procedure
1 Do one of the following:
a) To delete an archiving schedule, select the Archive Schedules
tab, or
b) To delete a purging schedule, select the Purge schedules tab.
Figure 13-21 The Archive Schedules tab
2 In the grid, select the schedule you need to remove, then click the
Delete button.
Figure 13-22 The Confirm Action dialog box
3 Click OK on each of the two open dialog boxes.
Deleting Archive Definitions
Use the instructions below to delete an archive definition.
Data Management
CDC Factory 7.1
ActivEssentials Administration Guide
13-51
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Data Management task module using the
instructions in Opening the Data Management Module on page
13-3.
Created an archive definition using the instructions in Creating a
New Archive Definition on page 13-36.
Procedure
1 In the Data Archiving frame, click the Archive Configuration
icon.
The grid refreshes to display all of the archive definitions you have
already configured.
2 In the grid, right-click on the definition you need to remove, and
select Delete.
A confirmation message displays.
3 Click OK.
Note: If you delete an archive definition, you make it impossible to restore data that
the database processed using the definition. When you remove a definition,
you also remove the master and other log entries that refer to the use of the
definition, so any archived data no longer has any context.
Data Management
CDC Factory 7.1
ActivEssentials Administration Guide
13-52
Viewing the Logs and Properties
In the Data Management module there are several places where you
can view, and in some instances edit, the properties and configuration
of your archiving, purging, and data restoration activities.
This section covers the following topics:
Viewing and Editing the Archive Definition Properties on page
13-52
Viewing the Archive Master Logs on page 13-57
Filtering the Archive Logs Grid on page 13-58
Viewing the Archive Detailed Logs on page 13-60
Viewing and Editing the Properties of a Restore Definition on page
13-61
Viewing the Restore Logs and Detailed Logs on page 13-66
Filtering the Restore Data Grid on page 13-68
Viewing and Editing the Archive Definition
Properties
Use the instructions below to view and edit the properties of an
archive definition. You can see many of the archive definition
properties in the grid. If you need to see all of them, you can view
them in a dialog box.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Data Management task module using the
instructions in Opening the Data Management Module on page
13-3.
Created an archive definition using the instructions in Creating a
New Archive Definition on page 13-36.
Procedure
1 In the Data Archiving frame, click the Archive Configuration
icon.
Figure 13-23 The Archive Configuration grid
Data Management
CDC Factory 7.1
ActivEssentials Administration Guide
13-53
2 Right-click on the archive definition whose properties you need to
view, and select Properties.
Figure 13-24 The General tab of the Archive Configuration Properties editor
3 On the General tab, you can edit the following:
a) Click in the Archive Name text box and edit the name of the
archive definition.
b) Click the down-arrow to the right of the Processing Action
field and select a new action.
c) In the Processing Properties groupbox, select or clear the
Active and Verify check boxes.
Data Management
CDC Factory 7.1
ActivEssentials Administration Guide
13-54
Figure 13-25 The Data tab of the Archive Configuration Properties editor
4 On the Data tab, in the Archive Date Range groupbox, you can
edit the following:
a) Click in the Data Age field and then click the up- or
down-arrows to adjust the age at which the data should expire.
b) Click the ellipsis button and set a new start date, and if
necessary, change the Delete data prior checkbox.
5 If you need to change the current scope of the archive definition,
do one of the following:
a) If the present definition has reduced the default scope and you
now want to archive all of the data for all groups and assets,
reselect the Include all checkbox and go to Step 13.
b) If you need to redefine the present scope, clear the Include all
checkbox and click the Scope button.
Note: If archiving has not yet started, you can edit the Start processing data from
date and the instruction to Delete data prior to this date. Once processing
has started, the database disables these options.
Data Management
CDC Factory 7.1
ActivEssentials Administration Guide
13-55
Figure 13-26 The Archive Configuration Scope Editor
6 When the Archive Configuration Scope editor opens, click the
Groups/Assets Scope tab:
7 If you need to modify the present scope, do one or both of the
following:
a) If you need to remove groups and assets from a previously
modified scope, select the appropriate row and click Remove.
Repeat as needed.
b) If you need to modify a default scope or add to a previously
modified scope, click Add.
Note: If the scope was modified from the default, the selected groups and assets
appear on the tab. However, if all groups and assets are included, the dialog
box is empty.
Data Management
CDC Factory 7.1
ActivEssentials Administration Guide
13-56
Figure 13-27 The Groups/Assets Selector
8 In the Groups/Assets Selector, select the groups and assets you
need to add to the archive definition, and then click OK.
The selected groups and assets appear in the grid of the Archive
Configuration Scope editor.
9 If you need to modify the scope of the data collected from the
groups and assets, select the Data Items Scope tab, and do one
or both of the following:
a) If you need to remove data items from a previously modified
scope, select the appropriate row and click the Remove
button. Repeat as needed.
b) If you need to modify a default scope or add to a previously
modified scope, click Add.
Note: Previously selected group and asset selections do not appear in the tree.
Data Management
CDC Factory 7.1
ActivEssentials Administration Guide
13-57
Figure 13-28 The Data Items Selection dialog box
10 In the treeview, expand the data category and select the
checkboxes to obtain the combination of collection categories
whose data you need to archive.
11 Click OK to accept the data item scope.
12 Click OK on the Archive Configuration Scope editor.
The editor closes.
13 Click OK on the properties dialog box.
Viewing the Archive Master Logs
Use the instructions below to view a master log entry for archiving
activity. You cannot edit any of the information provided. The master
log displays only the information that pertains to the selected entry in
the grid.
Note: Previously selected items do not appear in the tree.
Note: On the Archive Configuration Scope editor, you can verify your scope by
clicking the Scope Validation button. If valid, the database confirms, but if
invalid, you get a message that describes the problem.
Note: You can view most of the properties in the grid by scrolling the window to the
right. However, if you need to see all of the properties for a particular instance
of archiving activity, use the following instructions.
Data Management
CDC Factory 7.1
ActivEssentials Administration Guide
13-58
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Data Management task module using the
instructions in Opening the Data Management Module on page
13-3.
Read The Properties of the Archive Master Log on page 13-26.
Created an archive definition using the instructions in Creating a
New Archive Definition on page 13-36.
Procedure
1 In the Data Archiving frame, click the Archive Logs icon.
The grid refreshes to display the archive Master log entries
2 In the grid, right-click the master log entry and select Properties.
Figure 13-29 The Archive Logs Properties dialog box
3 Click Close.
Filtering the Archive Logs Grid
Use the instructions below to filter the data in the master logs, in the
Archive Logs view. The current filter conditions appear on the row
above the column headers.
Data Management
CDC Factory 7.1
ActivEssentials Administration Guide
13-59
Figure 13-30 An example of currently selected filters
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Data Management task module using the
instructions in Opening the Data Management Module.
Created at least one archive definition using the instructions in
Creating a New Archive Definition on page 13-36.
Procedure
1 In the Data Archiving frame, click the Archive Logs icon.
The grid refreshes to display the archive Master log entries
2 Click Show Filter on the toolbar.
Figure 13-31 The Archive Logs Filter selector
3 Do each of the following, as needed:
a) Click the down-arrow by the Archive Name field, and select
the archive name whose master logs you need to view.
b) Click the down-arrow by the Archive Status field, and select
the various options.
c) In the Archive processing groupbox, set a time range.
Note: This is not the original data collection date range, but the range of dates (times)
during which the data was archived (processed). Archiving jobs that start or
end outside these times but otherwise overlap with the range are included.
Data Management
CDC Factory 7.1
ActivEssentials Administration Guide
13-60
4 Click OK.
Viewing the Archive Detailed Logs
Use the instructions below to view the archive Detailed Logs. In
addition to the master logs, the database keeps a detailed record of
any data it has archived. Two detailed logs are kept: one that shows
the archive by data type, and the other that shows the archive by
groups/assets. You cannot edit any of the information you see in either
of the two logs.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Data Management task module using the
instructions in Opening the Data Management Module on page
13-3.
Read Understanding the Archive Detailed Logs on page 13-29.
Created at least one archive definition using the instructions in
Creating a New Archive Definition on page 13-36.
Procedure
1 In the Data Archiving frame, click the Archive Logs icon.
The grid refreshes to display the archive master log entries.
2 In the grid, right-click on the master archive log entry whose
detailed log you need to view, and select Detailed Log for Data
Types.
Figure 13-32 The Detailed Log for Data Types dialog box
Note: Each of the rows in the Detailed Log for Data Types displays information about
the data types in the data category of the selected archive definition (the
Archive Name). For each of these data types, you can view a detailed log of the
assets from which the data was originally collected.
Data Management
CDC Factory 7.1
ActivEssentials Administration Guide
13-61
3 Right-click on a row in the dialog box grid, and select Detailed Log
for Groups/Assets from the context menu.
The Detailed Log for Groups/Assets dialog box opens with details of
the assets for the selected data type.
Figure 13-33 The Detailed Log for Groups/Assets dialog box
4 When you finished viewing the logs, click Close on each.
Viewing and Editing the Properties of a
Restore Definition
Use the instructions below to view and edit the configuration of a
restore definition.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Data Management task module using the
instructions in Opening the Data Management Module on page
13-3.
Created at least one restore definition using the instructions in
Restoring Data from the Archives on page 13-70.
Procedure
1 In the Data Archiving frame, click the Restore Data icon.
The grid refreshes to display the status of the restore definitions.
2 Right-click on the job whose properties you need to view, and
select Properties.
The Restore Data Properties editor opens.
Data Management
CDC Factory 7.1
ActivEssentials Administration Guide
13-62
Figure 13-34 The Data tab of the Restore Data properties
3 In the Time Range groupbox, edit the data start and end times
within the date range in the selected archive files.
4 Click the down-arrow by the Restore Mode field to change the
restore method.
5 Do one of the following:
a) If you want to restore all of the data for all groups and assets,
reselect the Include all checkbox is selected and go to Step
12.
b) If you need to redefine the present scope, clear the Include all
checkbox and click the Scope button.
Note: You can change the various properties on each of the tabs if the restore
definition has yet to start. If the restoration has already taken place, the
information on the tabs is read-only.
Note: The default for the Scope Definition is to restore all of the originally archived
data.
Note: The groups and assets in the present scope appear in the grid. However, if the
previous scope included all groups and assets, the grid is empty.
Data Management
CDC Factory 7.1
ActivEssentials Administration Guide
13-63
6 Click the Groups/Assets Scope tab, and do the following as
needed:
a) If you need to remove items from the scope, select the item in
the grid and click Remove. Repeat as needed.
b) If you need to add to the scope, click Add.
Figure 13-35 The Groups/Assets Selector
Note: The Archive Configuration Scope editor
Data Management
CDC Factory 7.1
ActivEssentials Administration Guide
13-64
7 In the Groups/Assets Selector, select the groups and assets you
need to add to the restore definition, and then click OK.
The selected groups/assets appear in the grid of the Archive
Configuration Scope editor.
8 Click the Data Item Scope tab.
9 Do the following, as needed.
a) If you need to remove items from the scope, select the item in
the grid and click Remove.
b) If you need to add to the scope, click Add.
Any previously selected groups and assets do not appear in the
selector, so you can only select new items. For some data categories,
you can only select from the collection categories, but for others, you
can select data items.
Figure 13-36 The Data Item Selector
10 In the treeview, expand the data category and select the collection
categories/data items whose data you need to add to the restore
definition, and then click OK.
Note: Any previously selected groups and assets do not appear in the selector, so
you can only select new items.
Note: The data items (collection categories) in the present scope appear in the grid.
However, if the previous scope included all data items, the grid is empty.
Data Management
CDC Factory 7.1
ActivEssentials Administration Guide
13-65
11 Click OK on the Archive Configuration Scope editor.
The editor closes.
12 Click the Source tab.
The source tab contains the path to the archive files that contain the
data involved in the restore definition. You should not change this
unless you know the location has changed. You can test to see if the
location is correct by clicking Verify Source button. The database
then checks the archive files stored there to see if they contain the
data needed for the restore.
Figure 13-37 The Source tab of the Restore Data Properties editor
13 In the Data Restore Validation groupbox, change the data
validation method, if needed. Click the Schedule tab.
Note: On the Archive Configuration Scope editor, you can verify your scope by
clicking the Scope Validation button. If valid, the database confirms, but if
invalid, you get a message that describes the problem.
Data Management
CDC Factory 7.1
ActivEssentials Administration Guide
13-66
Figure 13-38 The Schedule tab of the Restore Data Properties editor
14 Do one of the following:
a) To edit the specific time at which the job should run, select the
Run at the following time option, and edit the time.
b) To run an existing schedule, select the Run using the
following schedule option, and select a schedule from the
drop-down list.
c) To define a new schedule, select the Run using the following
schedule option and then click the New Run Schedule
button. Follow the steps for Creating an Archive or Purge
Schedule on page 13-40.
15 To view information about the user who initially requested the
restore job, and for information about the present status of the job,
click the Others tab.
16 When finished viewing/editing the restore definition properties,
click OK.
Viewing the Restore Logs and Detailed
Logs
Use the instructions below to view the restore logs and detailed logs
for data restoration.
Restored data might come from archives that span several weeks.
Since data is archived by the week, the database keeps a log for each
of the affected archive files. From these logs you can view the detailed
Note: The information on this tab is read only.
Data Management
CDC Factory 7.1
ActivEssentials Administration Guide
13-67
logs for the data types; from the data types logs you can view the
detailed groups/assets logs. You cannot edit any information in the
logs.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Data Management task module using the
instructions in Opening the Data Management Module on page
13-3.
For more information about the logs, read the following:
Properties in the Restore Logs on page 13-34
Properties in the Restore Detailed Log for Data Types on page
13-34
Properties Available in the Restore Detailed Log for Groups/
Assets on page 13-35
Procedure
1 In the Data Archiving frame, click the Restore Data icon.
The grid refreshes to display the restore definition log entries.
2 In the grid, right-click on the restore definition log entry whose
detailed log you need to view, and select Restore Logs.
Figure 13-39 The Restore Logs dialog box
3 Right-click the restore definition entry whose detailed logs you
need to view, and select Detailed Logs for Data Types.
Note: Each of the rows in the Restore Logs dialog box displays information about the
archive files (one week of data). From each of these log entries, you can view a
detailed log by the data types in the selected week of the restore definition.
Data Management
CDC Factory 7.1
ActivEssentials Administration Guide
13-68
Figure 13-40 The Detailed Log for Data Types dialog box
4 Right-click on a row in the dialog box grid, and select Detailed Log
for Groups/Assets from the context menu.
The Detailed Log for Groups/Assets dialog box opens with details of
the assets for the selected data type.
Figure 13-41 The Detailed Log for Groups/Assets dialog box
5 Click Close on each of the three open dialog boxes.
Filtering the Restore Data Grid
Use the instructions below to filter the restore definition entries in
Restore Data. The applied filters appear in the row above the column
headers.
Note: Each of the rows in the Detailed Log for Data Types dialog box displays
information about the data types in the selected restore definition. For each of
these data types, you can view a detailed log of the assets from which the data
was originally collected. However, if the detailed logs have been deleted, this
option is disabled.
Data Management
CDC Factory 7.1
ActivEssentials Administration Guide
13-69
An example of currently applied filters
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Data Management task module using the
instructions in Opening the Data Management Module on page
13-3.
Created at least one restore definition using the instructions in
Restoring Data from the Archives on page 13-70.
Procedure
1 In the Data Archiving frame, click the Restore Data icon.
The grid refreshes to display the restore Master log entries
2 Click the Show Filter button on the toolbar.
Figure 13-42 The Restore Data Filter selector
3 Do each of the following, as needed:
a) Click the down-arrow by the Archive Name field, and select
the archive name whose restore master logs you need to view.
b) Click the down-arrow by the Restore Status field, and select
from the various options.
c) In the Restore configuration groupbox, set a time range.
Note: This is not the original data collection date range, but the range of dates (times)
during which the data was being restored (processed). Restorations that start
or end outside these times but otherwise overlap with the range are included.
Data Management
CDC Factory 7.1
ActivEssentials Administration Guide
13-70
4 Click OK.
Manual Archiving Operations
The Data Management module of MI Admin allows you to automate
many of the day-to-day archiving activities, but there are still a
number of tasks you may need to perform on an as needed basis.
This section covers the following topics:
Restoring Data from the Archives on page 13-70
Reprocessing Archived Data on page 13-77
Restoring Data from the Archives on page 13-70
Retrying a Failed Restore Definition on page 13-75
Cancelling a Restore Definition on page 13-76
Deleting a Restore Definition on page 13-77
Reprocessing Archived Data on page 13-77
Cancelling the Reprocess of Restored Data on page 13-78
Purging Restored Data on page 13-79
Cancelling the Purge Restored Data on page 13-80
Re-archiving Previously Archived Data on page 13-80
Cancelling a Re-Archive Instruction on page 13-81
Deleting the Detailed Log for Groups/Assets on page 13-82
What to Expect When Restoring Data on page 13-83
Limitations to Manual Tasks on page 13-85
Restoring Data from the Archives
Use the instructions below to restore data from the archives. You can
do this from any of the three Data Management views. The process in
each of the three views varies only slightly. The interfaces and
methods may differ, but you can still define identical restore
definitions.
Data Management
CDC Factory 7.1
ActivEssentials Administration Guide
13-71
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Data Management task module using the
instructions in Opening the Data Management Module on page
13-3.
Read the following:
What to Expect When Restoring Data on page 13-83
Restore Definition Scheduling on page 13-84
Limitations to Manual Tasks on page 13-85
Status of Archive Only Data on page 13-100 with reference
to Step 6.
Procedure
1 In the Data Archiving frame, click any of the three icons.
The grid refreshes.
2 Do one of the following:
a) If you are in the Archive Configuration view, right-click the
archive definition from which you need to restore data, and
select Restore Data.
b) If you are in the Archive Logs view, right-click an instance of
the archive definition from which you need to restore data, and
select Restore Data.
The archive logs display all archive definitions. If there is no
archived data in the selected instance, the Restore Data option
is disabled.
c) If you are in the Restore Data view, click the Restore Data
button on the toolbar.
The Add New Restore Job wizard starts.
3 Click Next to move past the Welcome page.
Data Management
CDC Factory 7.1
ActivEssentials Administration Guide
13-72
Figure 13-43 The Select Archive Name page of the wizard
4 If you started in the Restore Data view, click the down-arrow by
the Archive name field, and select the archive definition from
which you need to restore data.
5 In the Time Range groupbox, set start and end times for the data
you need to restore.
6 If you need to edit the restored data, clear the Restore data as
read only checkbox.
7 Click the down-arrow by the Restore mode field, and select the
appropriate method.
8 Do one of the following:
a) If you need to restore all of the data from the archive, ensure
the Include all checkbox is selected and go to Step 12.
b) If you need to reduce the restore definition from the default
scope, clear the Include all checkbox and click Scope.
Data Management
CDC Factory 7.1
ActivEssentials Administration Guide
13-73
Figure 13-44 The Restore Configuration Scope Editor
9 Click Add.
Figure 13-45 The Groups/Assets Selector
10 In the Groups/Assets Selector, select the combination of groups
and assets you need to add to the restore definition, and then click
OK.
The selected groups and assets appear in the grid of the Scope
Selection dialog box.
11 Click OK on the Restore Configuration Scope editor.
The editor closes.
12 Click Next.
Data Management
CDC Factory 7.1
ActivEssentials Administration Guide
13-74
Figure 13-46 The Source and Validation page of the wizard
13 To determine if the data is in the default location, click Verify
Source.
The database searches and confirms or not the presence of the
data.
14 If the search fails, click the ellipsis button by the Source folder
field.
Figure 13-47 The Shared Folder Browser
15 Browse to and select the present storage location, then click OK.
16 In the Data restore validation groupbox, select an appropriate
validation option.
Note: The wizard page provides the default location for storing the archive files (the
Source folder). If the data is not there, you must choose the current storage
location.
Data Management
CDC Factory 7.1
ActivEssentials Administration Guide
13-75
17 Click Next.
Figure 13-48 The Restore data schedule page of the wizard
18 Do one of the following:
a) To run the schedule at a particular time, ensure the Run at the
following time option is selected, use the up-and
down-arrows to define a time.
b) To run an existing schedule, select the Run using the
following schedule option, click the drop-down arrow, select
a schedule from the list.
c) To define a new schedule, select the Run using the following
schedule option and then click the New Run Schedule
button. See Creating an Archive or Purge Schedule on page
13-40 for the steps to create a new schedule for the restore
definition.
19 Check that the details are correct and then click Finish.
Retrying a Failed Restore Definition
Use the instructions below to manually retry a failed restore definition.
Figure 13-49 An example of a failed restore definition
Note: For information about the data validation options, see Data Validation on page
13-85.
Data Management
CDC Factory 7.1
ActivEssentials Administration Guide
13-76
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Data Management task module using the
instructions in Opening the Data Management Module on page
13-3.
Read the following:
What to Expect When Restoring Data on page 13-83
Limitations to Manual Tasks on page 13-85
Procedure
1 Right-click on the failed restore definition in the grid, and select
Retry Data Restoring.
A confirmation message displays.
2 Click OK.
Cancelling a Restore Definition
Use the instructions below to cancel a data restoration job in the
Restore Data view.
Figure 13-50 An example of a pending restore definition
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Data Management task module using the
instructions in Opening the Data Management Module on page
13-3.
Read the following:
What to Expect When Restoring Data on page 13-83
Limitations to Manual Tasks on page 13-85
Procedure
1 Right-click on the job that is waiting to be restored, and select
Cancel Data Restoring.
The data confirmation message displays.
2 Click OK.
Data Management
CDC Factory 7.1
ActivEssentials Administration Guide
13-77
Deleting a Restore Definition
Use the instructions below to delete a restore definition from the
Restore Data view grid. Note that you can only delete a restore
definition if the actions required are complete, and the removal does
not prevent any subsequent actions.
Figure 13-51 The status entries for the data restoration
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Data Management task module using the
instructions in Opening the Data Management Module on page
13-3.
Read the following:
What to Expect When Restoring Data on page 13-83
Limitations to Manual Tasks on page 13-85
Procedure
1 Right-click the restore definition you need to delete, and select
Delete.
A confirmation message displays.
2 Click OK.
Reprocessing Archived Data
Use the instructions below to archive and purge data that had
previously been restored. If the restored data is in a writeable
condition and changes have occurred, you will need to update this
data in the archives. When the data is reprocessed, it is archived and
purged in accordance with the original archive definition.
Note: Look at the entries in the Status, Read Only, and Re-archive Status columns
to check the overall status of the restore definition. For example, if the restored
data is restored in a writeable condition, you cannot delete the job until the data
is reprocessed. Other actions in the grid may change your option to delete.
Data Management
CDC Factory 7.1
ActivEssentials Administration Guide
13-78
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Data Management task module using the
instructions in Opening the Data Management Module on page
13-3.
Restored data using the instructions in Restoring Data from the
Archives on page 13-70.
Procedure
1 In the Data Archiving frame, click the Restore Data icon.
The grid refreshes to display the status of the restore definitions.
Figure 13-52 Example of an completed restore definition
2 Right-click on the job that you need to reprocess, and select
Re-process Archive.
A confirmation message displays.
3 Click OK.
Cancelling the Reprocess of Restored
Data
Use the instructions below to cancel the reprocess of restored data.
After opting to reprocess data, you might find that you still need to
make changes.
Figure 13-53 Example of a reprocess restore definition that is now awaiting re-archiving
Note: If the Read Only status is No, and you have changed the data after it is
restored to the database, you should reprocess it.
Data Management
CDC Factory 7.1
ActivEssentials Administration Guide
13-79
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Data Management task module using the
instructions in Opening the Data Management Module on page
13-3.
Scheduled a reprocess of restored data using the instructions
Reprocessing Archived Data on page 13-77.
Procedure
1 Right-click on the job waiting for re-archiving, and select Cancel
Reprocess Archive.
A confirmation message displays.
2 Click OK.
The grid refreshes, and the Re-archive status changes to To be
Archived.
Purging Restored Data
Use the instructions below to purge data that has previously been
restored in a read-only condition. Restored data is not included in
archive definitions, as the instances of the definitions that would
normally purge the data have already run.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Data Management task module using the
instructions in Opening the Data Management Module on page
13-3.
Restored data using the instructions in Restoring Data from the
Archives on page 13-70.
Procedure
1 In the Data Archiving frame, click the Restore Data icon.
The grid refreshes to display the status of the restore definitions.
Figure 13-54 Example of a completed Read Only restore definition
Data Management
CDC Factory 7.1
ActivEssentials Administration Guide
13-80
2 Right-click on the job that you need to purge, and select Purge
Restored Data.
A confirmation message displays.
3 Click OK.
The grid refreshes, and the Re-archive status changes to To be
Purged.
Cancelling the Purge Restored Data
Use the instructions below to cancel the manual purge of data that had
previously been restored.
Figure 13-55 Example of an completed Read Only restore definition waiting to be purged
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Data Management task module using the
instructions in Opening the Data Management Module on page
13-3.
Restored data using the instructions in Restoring Data from the
Archives on page 13-70.
Procedure
1 Right-click on the job that you need to purge, and select Cancel
Purge Restored Data.
A confirmation message displays.
2 Click OK.
The grid refreshes, and the Re-archive status changes to Purge
Cancelled.
Re-archiving Previously Archived Data
Use the instructions below to re-archive data that previously had been
archived. If you made changes to data after archiving it, you need to
re-archive it. This procedure refers to data that was not purged as a
part of the archive definition.
Note: If the Read Only status is Yes and you have finished with it, you should
purge it.
Data Management
CDC Factory 7.1
ActivEssentials Administration Guide
13-81
Prerequisites
Before doing this you need to have done or read the following:
If necessary, open the Data Management task module using the
instructions in Opening the Data Management Module on page
13-3.
Restored data from the archives using the instructions in Restoring
Data from the Archives on page 13-70, and made changes to the
data after archiving.
Procedure
1 In the Data Archiving frame, click the Archive Logs icon.
The grid refreshes to display the archive master log entries.
2 Right-click the instance of the archive definition from which you
need to re-archive data, and select Re-archive.
A confirmation message displays.
3 Click OK.
The grid refreshes, and the Status changes to To be Archived.
Cancelling a Re-Archive Instruction
Use the instructions below to cancel an instruction to re-archive data.
Data that might have been scheduled for re-archiving might now need
further changes before updating the archives.
Figure 13-56 Data scheduled for archiving
Prerequisites
Before doing this you need to have done or read the following:
If necessary, open the Data Management task module using the
instructions in Opening the Data Management Module on page
13-3.
Scheduled restored data for re-archiving using the instructions in
Re-archiving Previously Archived Data on page 13-80.
Note: You do not need to re-archive data that has been restored as Read Only,
unless you restored data that was originally archived using an Archive Only
instruction. Archive only data remains writeable in the database, so a restore
definition with a read only attribute does not disable the ability to edit the data.
If you do edit restored archive only data, you should re-archive it. See Status of
Archive Only Data on page 13-100 for more information.
Data Management
CDC Factory 7.1
ActivEssentials Administration Guide
13-82
Procedure
1 Right-click the instance of the archive definition where you need to
cancel the re-archive instruction, and select Cancel Re-archive.
A confirmation message displays.
2 Click OK.
The grid refreshes, and the Status changes to Archive
Cancelled.
Deleting the Detailed Log for Groups/
Assets
Use the instructions below to delete the Detailed Log for Groups/
Assets. The log contains information about the groups and assets used
in archive and restore activity. You might wish to remove these logs to
save disk space, but if you do, the database cannot conduct asset level
validation when restoring data. You can delete the logs in both the
Archive Logs and Restore Data views.
The option to delete a log may be disabled if:
The logs have already been deleted, or
There was no data to process during the selected archive or restore
period, or
If data has been restored, the contents of the archive file were not
entirely restored.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, open the Data Management task module using the
instructions in Opening the Data Management Module on page
13-3.
Created archive or restore definition using the instructions in
Creating a New Archive Definition on page 13-36 or Restoring Data
from the Archives on page 13-70.
Procedure
1 In the Data Archiving frame, click either the Archive Logs icon
or Restore Data icon.
The grid refreshes.
2 Do whichever of the following is appropriate:
a) In Archive Logs, right-click an instance of an archive definition,
and select Delete Detailed Log for Groups/Assets.
Note: You can set the database to remove all group/asset detailed logs when they
reach a certain age. See Setting the Working Folder and Other Archive
Settings on page 13-13 for more information.
Data Management
CDC Factory 7.1
ActivEssentials Administration Guide
13-83
b) In Restore Data, right-click a restore definition, and select
Delete Detailed Log for Groups/Assets.
A confirmation message displays.
3 Click OK.
What to Expect When Restoring Data
When defining a restoration job, the following properties are required:
Archive name. The name of the archive definition used when the
data was originally archived.
Read-only. This describes whether the restored data should be
read-only, or available for modification.
Restore mode. The rule used by the database when comparing
existing database information to that in the archives. For more
information, see Data Restore Mode Options on page 13-88.
Start and end time. The time span for the data that must be
restored. Although data is archived by the week, any date range
can be used for restoration. However, if the data is restored in a
writeable condition, the database restores data in its entirety for all
weeks that fall within or overlap with the specified time range.
When the data is to be restored as read-only, only data within the
time range is restored.
Scope. By default, the database will restore all data for all groups
and assets that were involved in the original archive. You can
reduce the scope if needed.
Archive file location. The location where the archive files are
stored.
Data validation. The options available for validating the data
during a restore job. For more information, see Data Validation on
page 13-85.
Scheduled restore time. You can opt to restore data almost
immediately, use an existing schedule, or define a new schedule
for the purpose. For more information, see Restore Definition
Scheduling on page 13-84.
Data Management
CDC Factory 7.1
ActivEssentials Administration Guide
13-84
Data Restoration Set Up
It is possible to initiate a restoration job in three ways:
From Archive Configuration. You can select the archive definition
from which to restore data and sets start and end dates for the
range of data. You can also change the scope of the restore
definition, but only within the scope of the originally archived data.
From Archive Logs. Using an instance of an archive definition,
you can select from the logs any date range within the range of the
already archived data. You can also change the scope of the
restore definition, but only within the scope of the originally
archived data.
From Restore Data. Create a new restore definition, choose the
archive definition, the date range, and a scope from within the
scope of the original archive.
When restoring, the data that is actually restored depends on whether
the data is read-only data or modifiable. If you require writeable data
for modification, the database will restore the data by complete
BPTUs, even if this means restoring more data than is requested. If
you just need read-only data, the database restores only the
requested date range.
Restore Definition Scheduling
It is possible to schedule a restore definition in two ways:
Run the restore at a specific time. This is the preferred method
if all of the data resides in one BPTU (one week), but the scheduled
time must be at least 10 minutes ahead of the request time. When
using this method, the restore definition is completed in just one
execution.
Run the restore as a part of a predefined schedule. This is the
preferred method if you request data from more than one week
(one BPTU). You can assign an existing schedule, or define a new
restore schedule specifically for the job. When using this method,
the restore definition will require more than one execution. If an
execution fails, the database tries again the next time that the
schedule runs.
Note: The methods for defining the restore definitions differ slightly from one view to
the other, but all of these methods allow the restoration of the same data.
Note: When a restoration job is requested, the database performs two validation
checks. The database ensures that all of the required archive files exist in the
nominated archive folder, and that the size of each of these files conforms to
the record in the archive logs. If either of these checks fails, the database
cancels the restore.
Data Management
CDC Factory 7.1
ActivEssentials Administration Guide
13-85
Data Validation
While there is an initial check of the validity of the data in the archives
when a restore definition is scheduled, the same checks occur when
the job is run. If the data passes this initial validation, it is copied to a
temporary location and the database conducts additional checks:
The database checks the timestamp for each record in the file to
confirm that the records refer to the requested time span. If the
records fail this test, the database returns an error and aborts the
restore definition.
The database checks the number of records in the temporary
storage to confirm that the number matches that in the archive
log. If the number of records differs, the database returns an error
and aborts the restore definition.
For each asset in the restore definition, the database compares the
checksum with that recorded in the archive log.
For each asset in the restore definition, the database checks that
the number of records matches the number in the archive log.
Verification Options
The verification options described above are subject to the following
conditions:
Do not validate. Data is restored without verification.
Validate and continue if validation fails. Data is verified during
restoration, but if it fails the restore definition continues.
Validate and stop if validation fails. Data is verified during
restoration, but if it fails the restore definition stops. Should this
occur, the database returns an error stating that the data has been
altered since archiving.
Limitations to Manual Tasks
You can re-archive and reprocess data, however these actions are
limited to maintain the integrity of the current and archived data.
Note: If a restore definition will be a part of a schedule, but the timings for the
schedule change, the restore definition still runs, but at the new time.
Note: The database only checks the assets selected for the restore definitionthere
is no verification of any other data.
Note: If the logs that recorded the initial archiving have been deleted through the log
management options, you can still restore the data but there can be no
extensive verification.
Data Management
CDC Factory 7.1
ActivEssentials Administration Guide
13-86
Re-Archiving vs. Reprocessing
You must manually initiate any re-archive or reprocess actions. Both
actions involve archiving data from the database, but the data has a
different status:
Re-archive: data that was archived in an archive only job.
Reprocess: data that was archived in an archive only or archive
and purge job.
Manual Actions
Re-archive. You can only re-archive data that was originally
processed using an archive only instruction. If you edit already
archived data in VPWeb, a message advises you to re-archive the
data.
Re-process Archive. You can only reprocess data that has been
restored to the database in a writeable condition. When being
reprocessed, you must use the original archive definition.
Purge Restored Data. You can manually purge data that has
been restored to the database in read-only condition. Since the
database does not allow changes to this data you do not need to
reprocess it.
Cancel Re-archive. If a re-archive instruction is pending or
underway, a user can cancel this action.
Cancel Re-process Archive. You can cancel a reprocess
instruction as follows:
If the restored data was archive only, you can cancel at any
time before the reprocess is complete.
If the restored data was archive and purge, you can only
cancel if the purge is still pending.
Cancel Purge Restored Data. If read-only restored data is
scheduled for purging, you can cancel the action at any time before
the purge begins.
Data Management
CDC Factory 7.1
ActivEssentials Administration Guide
13-87
Active Restorations
A restore definition remains active after all the data has been restored
to the database. This applies to both read-only and writeable
restorations. A restore definition becomes inactive under the following
conditions:
If a restore definition is cancelled before data restoration starts.
If a restore definition is cancelled after a restore job has started for
data that was originally archived using an archive only
instruction.
If a restore definition is cancelled without opting to Purge restore
data after a restore job has started for data that was originally
archived using an Archive and Purge instruction.
If data that has been restored in a writeable condition is then
marked for reprocessing. The inactive status becomes effective as
soon as the reprocessing is scheduled.
If the restored data is read-only and the original archive definition
included the archive only instruction.
If the restored data is read only and the original archive definition
included an Archive and Purge instruction. The restore definition
becomes inactive as soon as the restored data is removed from the
database.
Under any other conditions, restore definitions remain active with the
following restrictions:
You cannot delete the Detailed Log for Groups and Assets.
You cannot have more than one active restore definition that
involve the same archived data.
If already restored data is scheduled for re-archiving, you cannot
create a new restore definition that involves the same data.
Manual Data Editing Violations
To maintain the integrity of your data, the database controls how
manual data editing can occur. See the following for the rules the
database imposes:
Purge only data. If the action upon the expiry of the data is to
Purge only, and the purge job is running, you cannot edit the
expired data. If you try, you receive an error that states that the
data has already been purged.
Archive only data. If the action upon the expiry of the data is to
Archive only, you can change the expired datayou can delete,
modify, or insert data, but you will receive a message that the data
Data Management
CDC Factory 7.1
ActivEssentials Administration Guide
13-88
is no longer synchronized with the archive. The database gives the
name of the archive definition and the range of dates involved, and
the data must be re-archived.
You cannot edit data that has been restored or is scheduled for
restoration. The error messages given will vary with the following
conditions:
If data is scheduled for restoration or if the restore job is
incomplete.
If the restored data is read-only.
If the restored data is writeable, but reprocessing is either
scheduled or underway.
Archive and purge data. If data is subject to an archive and
purge instruction, you cannot edit the data once processing has
started.
For archive and purge data that is scheduled for restoration, you
cannot manually edit in these situations:
If data is scheduled for restoration or if the restore job is
incomplete.
If the restored data is read-only.
If the restored data is writeable, but reprocessing is either
scheduled or underway.
Data Restore Mode Options
For data that was processed using an archive only instruction, you
can compare the data in the archives with the data in the database.
The following options apply:
Append data. The database checks to see if the stored data
differs from the archive. If it does, the different archive records are
added to the stored records.
Overwrite data. The archive records overwrite the stored records,
if they differ.
Cleanup and then restore data. If there are records in the
database that do not exist in the archive, the new records are
removed and the archive records overwrite the existing records if
they differ.
Note: It is possible to edit restored data if it is in a writeable condition, but only if you
have not scheduled it for reprocessing.
Note: It is possible to edit restored data if it is in a writeable condition, but only if you
have not scheduled it for reprocessing.
Data Management
CDC Factory 7.1
ActivEssentials Administration Guide
13-89
Changes and Cancellations of Scheduled
Restorations
You can change a cancel or restore job, but there are limitations, as
follows:
The configuration of a restoration job can be changed, but no later
than 5 minutes before it is scheduled to start.
A restoration job can be cancelled, but no later than 5 minutes
before it is scheduled to start.
If restoring data for a multi-week period by using a predefined
multi-execution schedule, you can change the end time of the date
range if the data for the week has not yet been processed.
However, these changes must occur no later than 5 minutes before
the execution that processes the week in which the previously
configured end time occurs.
Restore Definitions
The database only allows you to delete restore definitions under the
following circumstances:
The restore job has not started.
The restore definition is inactive.
Purge Restored Data Option
If a restore definition is cancelled, the Purge Restored Data option is
enabled under the following conditions:
The restore status is In Progress or Failed.
Some of the data has been restored,
The original instruction was to archive and purge.
Table 13-2 Summary of database restore options and their results in the
database
Restore Mode Record in
database
Record in file Restore results
Overwrite Yes Yes Update database
No Yes Insert in database
Yes No Keep in database
Append data Yes Yes Keep in database
No Yes Insert in database
Yes No Keep in database
Data Management
CDC Factory 7.1
ActivEssentials Administration Guide
13-90
Data ManagementSupplementary Information
This supplementary information is primarily intended for
administrators of the ActivEssentials database.
In order to archive, purge, and restore your data, the ActivEssentials
database works within a structure that is designed to securely manage
your data in a way that does not affect your ongoing data collection
requirements.
This section covers the following topics:
How the Database Handles Data Archiving and Purging on page
13-90
Effects of Plant Hierarchy Reorganization on page 13-99
Effects of Changing Archive Definitions on page 13-100
Status of Archive Only Data on page 13-100
Security on page 13-103
Relationship to Other Data Management Activities on page 13-101
How the Database Handles Data Archiving
and Purging
During the process of archiving and purging the data that accumulates
in the database, it is important that each action is managed efficiently.
Archiving and purging can demand much of the resources of your
database computer, so you need to balance the needs of on-going
database activity and your need to secure your historical data.
Data Archiving and Purging
Managing the flow of data during archiving and purging operations is
mainly automatic, but there are some considerations. In an active
manufacturing environment, there is a constant stream of data for
storage in the database. As soon as the data is stored, it starts to age.
The rate at which you must archive and purge this aging data must
match, on average, the rate at which it accumulates.
As a part of defining your archive definitions, you must set a maximum
age for your data before the database will mark the data for
processing. ActivEssentials archives and purges data in units of one
week, with Monday to Sunday as the defined week. This is called the
Basic Process Time Unit (BPTU). When data expires, the database can
process it during the next scheduled archive and/or purge jobs.
Data Management
CDC Factory 7.1
ActivEssentials Administration Guide
13-91
Basic Process Time Unit
To manage archiving and purging, the database uses a Basic Process
Time Unit (BPTU), which describes the span of time for data recorded
in the database that is included in each archive job. The BPTU is set by
you, and is derived from a number of factors:
The data captured during the term of a BPTU is stored in one
archive file. If the time span is too long, the archive file might be
very large, but if the time span is short, the database may need to
produce many small archive files.
The term of a BPTU can lead to delays in processing expired data.
For example, if data is set to expire after six months, but the BPTU
is one month, archiving cannot occur until all of the data in the
BPTU has expired. In this instance, archiving could not occur until
the end of the seventh month. A long BPTU means that your
database size is larger, so you would need extra hard drive space.
With a longer BPTU, there are increases in processing efficiency,
but only for the creation of archive files and any purging activity.
A long BPTU can cause increased computing activity (disk I/O and
CPU cycles) that might affect normal database activity.
All of the data gathered during a BPTU is stored in one file, so if the
BPTU is long, and you must restore data, the restoration time
might be lengthy and affect normal database activity.
Basic Process Data Unit
To help control how much work the database computer must do to
archive a BPTU of data, the data is split into Basic Process Data Units
(BPDUs). While a BPTU is stored in one file, the file does not have to
be compiled in one execution. A BPDU is defined by the number of
items that must be processed during one execution of an archive or
purge job for any one archive definition. ActivEssentials uses assets as
the basic process data unit. All of the data in a BPDU must fall within
the term of the BPTU.
Determining the Required Number of BPDUs
To calculate the number of BPDUs required, you must divide the total
number of assets that are in an archive definition by the number of
archive executions the database can perform in a week. The resulting
number is then rounded up to the next integer.
By default, the database will execute archiving activities once a day
(except Saturday and Sunday) at 2:00 A.M., so the number of BPDUs
is the number of assets divided by five and then rounded up. For new
database archiving activity, especially for ActivEssentials installations
that have been in use for some time, it may be necessary to increase
the number of daily executions until the archiving and purging are up
to date. The number of daily executions is managed by the archive and
purge schedules that you define in Data Management. If the BPDU is
left at 0, the database will automatically optimize the archiving
activity by processing the smallest number of assets at a time.
Data Management
CDC Factory 7.1
ActivEssentials Administration Guide
13-92
Database storage requirements are based on the life expectancy of the
data, plus the time needed to fully age and archive the oldest BPTU.
For example, if the life expectancy is 13 weeks, archiving cannot start
until all of the data in the BPTU is at least thirteen weeks old, i.e. the
Monday of the 15th week. By this time, the oldest data is 14 weeks
old. If the archive and purge schedules are processed each day, some
of the data might be fully 15 weeks old before it is archived and/or
purged. Your active database storage requirements, in this instance,
must be sufficient to store 15 weeks of data. See Archiving and
Purging as Data Ages on page 13-96 for more information.
Archive and Purge Job Schedules
The Data Management system settings allow changing the timing of
archiving and purging activity. Having this flexibility means that users
can adjust the processing load on the database computer to balance
archiving activity with ongoing data collection and the various requests
from web clients to the database.
Data Archiving
To archive your data, you need to define a folder where your archive
files are stored. You can use a mapped network drive on the local
computer or a shared folder on a remote computer.
The Archive Files
When the ActivEssentials database saves your archive files, it handles
the naming for you. The ActivEssentials database uses a naming
scheme that contains information about the contents of the file.
Archive file names take the form:
Sservername_Ddataname_Iarchivename_Tdate_AarchiveID_Vdatab
aseversion.apd
1
Sservername. This is the name of the database server.
Ddataname. This is an abbreviated name for the data type stored
in the archive file. All data is archived by data types, with each
data category having its own set of data types. See Abbreviated
1. The letters in bold and underscores in the file name are common in all archive file
names. The italic items describe the contents.
Data Management
CDC Factory 7.1
ActivEssentials Administration Guide
13-93
Names for Data Types on page 13-94 for more information about
the data names. Data for just one data type exists in any one
archive file.
Iarchivename. This is the archive configuration ID, which identifies
in the database the archive definition used to create the archive.
The ID is a number, which increments by one with each archive
definition you create. If you delete a definition, the ID number is
retired.
Tdate. This is the start date, i.e. the Monday, of the week for the
archived data in the file.
AarchiveID. This indicates the instance of the use of the archive
definition. Each time the archive definition is run, this increments
by one.
Vdatabaseversion. This is the version of the ActivEssentials
database from which the data was archived. This information is
important as the current database needs to know what version of
the database was used to create the archive if restoration is
needed.
Example
This is an example of a real archive file name:
SAPQA0355L1A4_Da_I3_T20050803_A1_V1.apd
Data Management
CDC Factory 7.1
ActivEssentials Administration Guide
13-94
Abbreviated Names for Data Types
To help identify the kind data that is stored in an archive file, the
database uses abbreviated names for each of the data types in the
archive file names.
Accumulator data types:
a. Accumulators
aq. Accumulator quality
Events data types:
e. Events
eq. Event quality
env. Event variables
eav. Event alphanumeric variables
Identifier data types:
id. Identifiers
idq. Identifier quality
Incident data types:
in. Incidents
inq. Incident quality
inr. Incident reason codes
inc. Incident comments
ina. Incident acknowledgments
inp. Incident category properties
inl. Incident reason links
Rules for Handling Archive Files
When storing the archive files, you must bear the following in mind:
You must not change the names of any of the archive files. The
name is important, as it describes to SQL Server what is in the
files. If you change the name, SQL Server might not be able to
restore the data to the ActivEssentials database.
Do not edit the content of the files. Editing the files might corrupt
the formatting, so the ActivEssentials database might no longer be
able to read the data.
The total number of characters in the path (folder name and file
name) cannot exceed 255. If this limit is exceeded, the database
returns an error.
The SQL Server service running account must have full control
privileges for the folder where the archive files are stored.
Automatic Processing
When a new archive definition is activated, and the archive action is to
either archive and purge or archive only, the archiving activity will
start almost immediately. The database starts handling the oldest
expired data at the next scheduled opportunity and continues on a
day-by-day basis until any backlog is cleared.
Data Management
CDC Factory 7.1
ActivEssentials Administration Guide
13-95
Archive definitions are processed in the order of the ID associated with
the BPTU. For each archive definition, the data for the predefined
number of assets, the BPDU, is processed according to the ID for each
asset. SQL Server keeps a detailed record of all the transactions in its
database logs.
Manual Processing
Archiving activity that is manually initiated is still handled
automatically by the archive definition. As the ActivEssentials database
starts an archiving or purging job, it checks to see if there are any
manual archiving activities associated with the definition. If so, the job
handles these first, and then archives any newly expired data. There
are three situations where manual archiving is required:
If data has been restored to the database and has been edited, it
must then be returned to the archives.
If when the data was originally archived the action had been to
archive only, the data remains in the database. If this data is then
edited, it is no longer synchronized with the data in the archive.
Manual archiving allows the data to be synchronized.
If data is restored to the database, but no changes are made, it
can then be removed from the database when no longer required.
Archived Data Verification
If the archive definition includes an instruction to verify the integrity of
the archived data, the ActivEssentials database immediately restores
the archived data to a temporary location for comparison with the
original. If the database cannot successfully restore the data, it is
marked as failed. Once restored, the database compares the record
number and checksum for each asset.
If the restored data passes all verification checks, the archive process
is complete. If the restore process fails, or if the subsequent checks
fail, the data is again marked for archiving.
Data Purging
If the archiving definition includes an instruction to either purge only
or archive and purge, the database purges these records when the
next purge job runs. The database removes the records in the order
determined by the ID for the BPTU. For each data table in the archive
definition, the database purges the data by BPDU and then by the ID
for the assets.
Note: It is possible to cancel any manual archiving action, even if the job is already
underway. If you do cancel, the database keeps a record in its logs.
Note: It is possible to cancel a purging task that is initiated manually. The task is
terminated immediately, but the data cannot be restored automatically. Only
previously archived data can be restored.
Data Management
CDC Factory 7.1
ActivEssentials Administration Guide
13-96
Archiving and Purging as Data Ages
Below are a series of illustrations that depict the process used to
archive and purge data as it ages. The assumption with these
illustrations is that an archive definition calls for both archive and
purge actions, but the process is essentially similar with an archive
only or a purge only instruction.
Each of the illustrations is based on several assumptions:
Default archive and purge schedules. The archive and purge
jobs run Monday to Friday.
Data age before expiry. All of the data is set to expire at ten
days. This means, for example, that data that is captured on
February 2nd is eligible for archiving ten days later on February
12th, but this data cannot be archived until all of the data for the
week in which it was captured is also ten days old.
Number of assets. Within the archive definition is the groups/
assets scope, which defines the number of assets for which the
collected data must be archived and/or purged.
Basic Processing Data Unit. The BPDU defines the number of
assets the database will process at a time. For the illustrations, it is
assumed that the total number of assets to be processed divided
by the number assets to be processed at a time, requires one
execution on three consecutive days. See Basic Process Data Unit
for more information.
Data is Collected
The stream of data ActivEssentials collects is stored in batches of
exactly one weekstarting at 12:00 A.M. on each Monday morning.
Archive definitions include parameters that state how old data must be
(the expiry time) before it is marked for a processing action, the data
categories, and the groups and assets that are in the scope.
All the data that is to be included in an archive definition must have
reached, or moved beyond its expiry date. When the youngest data
(that collected on a Sunday) has expired, the data can then be
archived. At this point, the data collected on the previous Monday is
seven days beyond its expiry date.
In Figure 13-57 below, the data collected during the week ending 1/9/
2006 is seen to age. The archive definition states that the data must
be ten days old before it expires, but as data is archived in one week
batches, archiving cannot begin until all of the data for that week is
ten days old. Data collected on the Monday (1/2/2006) is 17 days
before archiving can begin.
Data Management
CDC Factory 7.1
ActivEssentials Administration Guide
13-97
Figure 13-57 Data is captured and ages to the point where it has expired
Archiving Begins
Upon the expiry of the youngest data in the week, the database can
begin the archiving process. The data is archived using asset IDs, so
all the data for one asset is archived before moving onto the next
asset. The archive definition includes a parameter that governs how
many assets the database will process in one execution, with
executions typically occurring once a day.
In the following figure, the database archives the data over a period of
three days. The archive definition includes a schedule to use for
archiving. The archiving and purging jobs must complete during the
seven days following the expiry of the youngest data, so the database
must schedule the necessary activity within the seven day period. In
practice, all archiving and purging activity occurs within a Monday to
Friday time frame, but this span is independent of the span of
archiving and purging jobs. A job that cannot start until a Wednesday
must be complete by the following Tuesday to prevent a backlog.
1/2/2006 1/30/2006
1/9/2006
One week's worth of data collected
1/2/2006 1/30/2006
1/2/2006 1/30/2006
1/12/2006
Oldest data is 10 days old, but youngest data
is only 3 days old archiving cannot begin
1/19/2006
Youngest data 10 days old archiving can begin
Oldest data 17 days old
Data Management
CDC Factory 7.1
ActivEssentials Administration Guide
13-98
Figure 13-58 Data for the week is archived over a three day period beginning 1/19/2006
Purging Begins
When the database has completed all archiving activity for the week of
data that has most recently expired, it can then begin the purging that
is required. Purging removes the data from the database, so once the
job is complete you cannot access the data without first restoring it.
The purging activity can only occur once the archiving activity has
completed. In the following figure, the database purges the data over
a period of three days, beginning on the 1/22/2006.
Figure 13-59 Data for the week is purged over a three day period beginning 1/22/2006
1/21/2006
Archiving for all data on all assets is completed
1/19/2006
Data for first third of the assets is archived
1/2/2006 1/30/2006
1/2/2006 1/30/2006
1/2/2006 1/30/2006
1/20/2006
Data for the second third of the assets is archived
1/22/2006
Data for first third of the assets is purged
1/2/2006 1/30/2006
1/24/2006
Purging for all data on all assets is completed
1/2/2006 1/30/2006
1/23/2006
Data for the second third of the assets is purged
1/2/2006 1/30/2006
Data Management
CDC Factory 7.1
ActivEssentials Administration Guide
13-99
Since the processing order within a purging job is based on asset IDs,
the database purges all of the data for one asset before moving onto
the next. The purging job must complete within a week of the expiry of
the youngest data.
Effects of Plant Hierarchy Reorganization
You can define individual assets to archive, or you can use groups
(departments, lines, etc.). Any archiving is based on the plant
hierarchy configurations that exist when the archiving takes place.
However, if you need to reorganize your plant structure and then need
to restore data, the only data you can restore is that which still fits the
new structure.
Figure 13-60 Reorganizing the Plant Hierarchy
The above figure illustrates the movement in the plant hierarchy of
Line06 from under Area01 to Area02. If an archive definition has
a scope that only includes Area01, data for Line06 is included in
that definition as part of the object scope. If you need to restore data
for Line06 after moving it under Area02, the database cannot
accept the data as there is no place for it in current plant hierarchy
structure.
What to Do If You Need to Reorganize the Plant
Hierarchy
If you need to reorganize your plant hierarchy, you should do the
following:
Before making any changes, restore from the archives any data
that applies to the plant hierarchy items you need to move. You
need to restore the data in a writeable condition since parts of it
must be altered when it is moved. Since restore definitions use as
their basis the data categories, you must find all categories that
contain the data for the items you need to move.
After making the plant hierarchy changes, re-archive the restored
data.
Note: Data that has been marked for purging is accessible right up until the time just
before it is removed. Once data has been removed, requests in VPWeb will
yield no results.
Data Management
CDC Factory 7.1
ActivEssentials Administration Guide
13-100
Avoiding the Need to Restore and Re-Archive
To avoid the need to restore and then re-archive data when you need
to reorganize your plant hierarchy, consider the following:
When you create archive definitions you do not have to define a
scope that specifically includes items in your plant hierarchy. The
primary archiving scope is defined by data categories. If you do not
define a group/asset scope, the archives include data from every
asset in the plant from which you collect data for the selected data
category. If you then need to restore data, it restores the data
category, not the assets from which you collected the data.
If you must use groups in your scope, you might be able to avoid
restoring and re-archiving the data if you move items so that they
remain within the scope. In Figure 13-60 on page 99, Line06 is
moved from under Area01 to Area02. If, however, the line had
been moved to a location that was still within the scope defined by
Area01, there would be no need to restore and re-archive.
Effects of Changing Archive Definitions
Through the Data Management task module you can change the scope
of your archive definitions at any time. However, if you do this you
might find that you get ambiguous results if you need to restore and
then re-archive data. When you archive data, the source of the data is
a part of the archive. If you change the scope of an archive definition,
this does not change the scope of any previously archived data.
If, for example, you move the archiving of the data from a particular
asset from one archive definition to another, data for this asset would
reside in two archives. If you need to restore data for the asset for a
period that crosses over the time when the archive definitions were
changed, you must restore data from both definitions. Re-archiving
the data does not fix the problem, as the configuration at the time of
the original archiving persists.
Status of Archive Only Data
When you archive your data using the Archive Only option, the data
remains in the database in a form that still allows users to edit it.
However, if you restore data that was archived using the archive only
instruction, you have the option to restore this data as Read Only.
The read only option seems to indicate that users will then be unable
change the restored data, but this has no effect when the data already
exists in the database in a writeable form.
Should you restore archive only data, the restore definition
immediately becomes inactive, so there is no need to re-archive it.
This also means that you can restore this data as often as needed, but
as the data remains writeable, you should be prepared to re-archive it
if changes occur.
Data Management
CDC Factory 7.1
ActivEssentials Administration Guide
13-101
Relationship to Other Data Management
Activities
All archiving activity may coincide with other data management
activities, such as additional archiving, data swapping, etc. Be aware
of these items when determining the BPDU and archiving frequency.
Swapping Data During DST Rollback Period
Typically, 1 hour after DST (Daylight Saving Time) ends, the time
stamps on the collected data duplicate those for the data collected in
the previous hour. ActivEssentials handles these duplicate data
periods so that they can be seen separately. However, the data for
these successive periods can never be seen together.
Users can choose to swap these sets of DST data for viewing in the
context of the production data that precedes or succeeds the time
change period. The data for whichever hour is swapped-out at the time
of archiving is neither archived nor purged, it always remains in the
database, even if the action upon expiry is to archive, or archive and
purge. This swapped out data is stored in a separate data table.
When the data for the week in which DST ends has expired, the data is
processed according to the archive definition. Once completed, you
should disable the option to swap the data, as the alternative data is
no longer in the database.
For more information about the handling of DST data, see Using the
Daylight Saving Functions on page 2-21.
Manual Data Editing
Configuration changes in the various modules of MI Admin and
through edits in VPWeb can affect data that is scheduled for an archive
and/or purge action. If these actions have already occurred, the
Data Management
CDC Factory 7.1
ActivEssentials Administration Guide
13-102
database applies rules to maintain the integrity of the stored and
archived data. Below is a listing of the database responses to manual
data editing and configuration changes:
If the action upon the expiry of data includes a purge instruction,
users cannot change the data after it has been purged. If there is
an attempt to insert such data, the database returns an error that
data for this period has already been purged.
If the expired data is set for archiving only, and there is no active
restore scheduled, a user can edit the data in the database. Should
this occur, the database returns a message indicating that the user
must refresh the archive, as the current database no longer
matches the archive.
While in an active restore time frame, the following conditions can
apply:
If the restore status is to be restored or in progress, the
database prevents manual editing. If a user attempts to edit
data for the affected period, the database returns an error
message that states that data for the period is scheduled for
restoration.
If data has already been restored, but is set to read-only, no
manual editing is allowed. This might mean the original
archiving instructions for the data in the restore definition may
Data Management
CDC Factory 7.1
ActivEssentials Administration Guide
13-103
include data that was archive only, and other data that was
archive and purge. The database returns an error stating that
data for the period is read-only.
If data has already been restored and does not have a
read-only attribute, but the data is set for reprocessing (or if
this action was cancelled), you will not be able to edit it. The
database returns an error.
If the processing instruction is archive and purge, but the restore
definition is not active, the user cannot insert, modify, or remove
data. The database returns an error.
If the archiving instruction is archive and purge, the following
conditions can apply:
If the restore status is to be restored or in progress, no
manual editing is permitted. If a user attempts to edit data for
the affected period, the database returns an error message
that states that data for the period is scheduled for restoration.
If data has already been restored, but is set to read-only, the
user cannot insert, modify, or remove data. The database
returns an error.
If data has already been restored and does not have a
read-only attribute, a user can edit this data only if
reprocessing has not yet started. If reprocessing has started,
the database returns an error that states that the data has
been restored for reprocessing, and is not available for editing.
If groups and assets are deleted, the database handles them as a
lazy delete. The database records for these remains until a
garbage collection job cleans up.
Unarchived data for lazy deleted groups and assets is not
processed, regardless of the actions in the archive definition.
Archived data for deleted groups and assets cannot be
restored, even if you recreate them.
If collection categories or data items are deleted, their data is
handled as a lazy delete. The data for these items remains in the
database until a garbage collection job runs.
Unarchived data for lazy deleted items is neither archived nor
purged when archive definitions run that reference the groups
and assets.
Archived data for deleted collection categories and data items
cannot be restored, even if you recreate them.
Security
There are several methods for keeping your data safe, including a
predefined user role and security applied to archived files.
Data Management
CDC Factory 7.1
ActivEssentials Administration Guide
13-104
Privilege Control
To ensure that data in the database is secure for archiving activities,
there is a predefined role. This role is global, meaning that a user
assigned to this role has access to the entire databasethere is no
support for creating roles with limited access. Only users belonging to
this role can:
Perform archiving and restoring activities.
Manually archive, purge, and restore data.
Explore and manage the database logs.
Security for Archived Data
The data you archive is outside the control of SQL Server, and
therefore beyond the control of ActivEssentials security. The following
additional measures provide data security:
Make sure that only SQL Server has full control over the working
folder.
SQL Server saves the archive files in a proprietary binary format
that makes the data difficult to manually edit.
SQL Server does not record the column headers in the archive
files, which makes it difficult to understand the meaning of the
archived data.
If you copy the archive files to CDs or backup tapes, make sure the
storage location is secure.
When archiving data, use the validation option to ensure that the
archived data is the same as the original. Data that does not pass
this test should be re-archived.
When restoring data, use the validation option to ensure that the
restored data has not been changed while out of the database.
Data that does not pass this test should not be restored.
Note: The validation options do not prevent the data from being modified while out of
the database, but they do let you know if changes have occurred.
CDC Factory 7.1
ActivEssentials Administration Guide
14-1
Report Administration
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-2
Introduction to Reports Administration
In Reports Administration you determine the types of reports that you
want to be able to create, how and where to store them, and how to
distribute them.
Some of these activities require interaction with ActivEssentials users
and roles. For example, you will give users the right to access certain
folders, and distribute reports to certain users but not to others.
This chapter covers the following topics:
Getting Started in Reports Administration on page 14-2
Folders and Users on page 14-13
Report Contents on page 14-17
Distribution of Reports on page 14-24
Configuring Folders on page 14-29
Configuring Report Content on page 14-40
Configuring Delivery Options on page 14-75
Maintaining Folders and Content on page 14-88
Maintaining Report Content on page 14-96
Maintaining Report Scheduling and Delivery on page 14-124
Database Rules for Cleaning up Reports on page 14-139
Report Generation and a Users Folder Limits on page 14-141
Getting Started in Reports Administration
This section gives an overview of the administrator tasks required to
set up the ActivEssentials reporting system.
This section covers the following topics:
Opening the Reports Administration Module on page 14-3
The Reports Administration Window on page 14-4
What You Will Do in Reports Administration on page 14-6
How the Parts Fit Together on page 14-7
How Much Hard Drive Space Do I Need? on page 14-10
Reports Administration and the Report Viewer on page 14-11
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-3
Opening the Reports Administration
Module
Use the instructions below to access the Reports Administration
module of MI Admin. In this module you administer the Activplant
reporting system.
Prerequisites
Before doing this you need to have done or read the following:
Obtain a user account (user name and password) that gives you
report administration privileges.
Obtain the URL for the server hosting VPFoundation, so that you
can log on to MI Admin.
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
Read the following:
What You Will Do in Reports Administration on page 14-6
How the Parts Fit Together on page 14-7
How Much Hard Drive Space Do I Need? on page 14-10
Reports Administration and the Report Viewer on page 14-11
Procedure
1 In the taskbar, click the Applications category button.
The taskbar refreshes to display icons for the task modules in the
Applications category.
2 In the taskbar, click the Reports Administration icon.
The grid refreshes to display the Reports Administration interface.
Note: There is no Plant Hierarchy in Reports Administration. Instead, the Object
Library appears in either the Navigation or Categories frame, and the
secondary frame has three category button options. Your selection in the
Navigation/Categories frame and the selected category button in the
secondary frame determines the contents of the grid.
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-4
Figure 14-1 The Reports Administration window
3 In the secondary frame, click one of the category buttons to access
report content, folders, or delivery functions of the Reports
Administration functions. The options are Content, Folders, and
Delivery.
The Reports Administration Window
The Reports Administration window contains the following areas:
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-5
Legend:
The MI Admin taskbar. Allows you to switch between the MI Admin
modules.
The MI Admin toolbar
The Navigation/Categories frame. When you select an object in this
frame, its immediate child objects appear in the grid.
Category buttons (Folders selected). The Content, Folders, and
Delivery categories contain tasks that change in the secondary
frame.
The secondary frame (System Folders selected). Contains icons for
the various tasks in Report Administration.
The grid (system folders shown). Shows a list of items that belong
to the select object in the Navigation/Categories frame. Once items
are shown in the grid, you can right-click on an object to view its
context menu.
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-6
What You Will Do in Reports
Administration
In Reports Administration, you set up report structure, content, and
schedules as follows:
Folder management. You create a structure of folders that will
contain reports. Some of these folders are already present (system
folders), but you have to create folders that will be shared by
certain users (shared folders). Users can also create their own
personal folders through the Report Viewer of VPWeb.
Report content management. You define report servers that
host the reporting service, then create categories of reports, and
styles that allow the data to be presented in different ways. You
also create report templates that can be used to create reports
later.
Report delivery. This area controls scheduled reports, and the
ways in which they are distributed to the people who need to see
them.
The management of these items are further refined by the following
tasks.
Define One or More Report Servers
A report server is a machine on which the Reporting Service is
installed. It is also the machine that stores the reports that are
created. You have to allocate space on this machine so that users can
store reports.
Create Report Categories and Styles
A report category is a container for report styles the same report
server and report provider. Report providers are predefined by the
system; you do not need to define them, only to select one. The choice
of report provider determines the format of the data when it comes
from the report server, but your choice of stylesheet determines the
presentation of the data.
Styles control the presentation and formatting of the report. The data
is tagged in XML, which is then transformed by an XSL stylesheet into
an HTML file. The Activplant reporting system includes some
ready-made styles (XSL files). If you wish, you can also create your
own. If you want to create your own, use the provided stylesheets as
templates, as they contain the structures you must follow. In Reports
Administration you will create report categories and link them to the
styles that you want to use.
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-7
Administer Report Creation and Delivery
This involves creating report templates that will then be available for
users to create reports. You can also attach schedules to the reports to
automate report generation, which delivers the reports to selected
users or to a shared folder.
You must also create report distributions to allow the automatic
delivery of scheduled reports by e-mail to recipients inside the
company, and/or delivery to a network folder. An e-mail message
contains only a link to a report, so the report server must save these
reports in a location that is available from outside your network.
Create and Administer Report Folders
These are the folders in which you and other users will store reports.
They include system folders, public (shared) folders, and personal
folders. Users create their personal folders using the Report Viewer of
VPWeb, but you need to be able to access them too.
Reports Administration uses the security information from the Security
Administration module of MI Admin to populate lists of users when you
are granting users access to certain reports, or setting/changing the
amount of storage space they have available.
How the Parts Fit Together
This section gives a broad overview of the Activplant reporting
systemwhat the various pieces of it are, and how they fit together.
Some of the pieces are interrelated and have to be created and
assembled in a certain order.
The primary components are:
Content. This includes the pieces that are necessary to create a
report.
Folders. This includes the system, shared, and personal report
folders in which reports can be stored.
Delivery. This includes report schedules and delivery options.
These components are the category buttons above or below the
secondary frame in the Reports Administration module.
The Content Task Category
The main components of Content are shown in the diagram on the
right. The parts that you must create are shown in bold type. They
are: Report Servers, Categories, Styles, and Templates.
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-8
Report Providers are already built into the reporting system. For more
information on the report providers, see Report ProvidersWhich is
Best for You? on page 14-18.
Report servers are the computers that host a reporting service.
Templates use information in the ActivEssentials system: the plant
hierarchy, production shifts, etc. Report templates can also include
identifiers such as Batch Number or Model Number to specify a time
frame.
When you create a template, you save it in a shared folder so that
users can use it to generate their own reports. Users can also create
templates and save them for reuse.
The Folders Task Category
The report folders are shown in the diagram on the right. They are
closely linked to ActivEssentials roles and users, which are defined in
the Security Administration task module.
System folders exist already within the system; they are virtual folders
for administering report folders. Only administrators can access the
system folders, although users see versions of these that contain
reports intended for them in their own Inbox folder, Subscription
folder, etc.
My Inbox
My
Subscriptions
System Folders
Personal Folders
Shared
Folders
Activplant
Users
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-9
Users have several report folders available to them in the Report
Viewer. They have an Inbox, a My Recent Reports folder, and a My
Subscriptions folder. They also have access to Shared folders, but only
if you give them access. In addition, users can create their own
Personal folders for storing reports.
The only folders that you as an administrator will create in Reports
Administration are the Shared folders.
The Delivery Task Category
Report Delivery is used to generate reports automatically and to send
them to users. The components of Report Delivery are shown in the
diagram on the right.
The parts that you must create are as follows:
Schedules define a time interval and frequency for report
generation and distribution. They can be based on a defined time
frame.
A Scheduled Report is generated automatically and sent to one or
more users, or to a shared folder. If you send it to users, it goes
into their Inbox. If you send it to a shared folder, it is available to
all users who have access to the folder. Scheduled reports are only
distributed internally. As an administrator, you can make a
scheduled report available for subscription. A user can subscribe to
the report and have it delivered to their My Subscriptions folder
every time it is generated.
A Report Distribution offers different delivery options from a
scheduled report. You can e-mail it to internal users, or send it a
network folder or an FTP site on the Internet.
Putting it all together
The categories described above form the reporting system, as shown
in the following figure:
Schedule
Scheduled
Report
Report
Distribution
Production
Shifts
Plant
Hierarchy
other
activplant
functions
Network
Folder
E-Mail
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-10
Figure 14-2 The components and their interactions
Note the following interactions:
Once you have chosen a report server, you select a category, style,
and report template. Once your report template is created, you can
schedule a report and/or distribute it.
Users can use templates to create reports in the Report Viewer.
Users can choose report styles in the Report Viewer to view the
report data in different ways.
End users access Folders through the Report Viewer. As an
administrator, you can set size limits, create shared folders, and
define access privileges for users. You can also empty the contents
of shared or personal folders if necessary.
How Much Hard Drive Space Do I Need?
Before you begin administering reports for your users you need to
determine how much storage space they need. In Reports
Administration you can set limits for each user in terms of how much
storage space they have for reports. Report folders are virtual folders
on the report server, so it is the hard drive on this machine that is the
limiting factor. You need to:
Talk to report users and determine which reports are accessed by
multiple users. Such reports are generated once and accessed
many times by different users, so only a single copy is required.
Talk to the power users (who can create and store reports) and
determine how many reports they are each likely to store. These
are the users that will use more space.
Find out how many report creators and storers you will be dealing
with.
Run a few typical reports and look at the size of the XML files
(not the HTML files). To do this, run a report and save it, then look
at the file properties. The default folder (on the computer hosting
Content
Report
Category
Report 8tyle
Report Server
Report Provider
Report
Template
PnooucTioN
SHirTs
PLANT
HiznAncHY
lozNTirizns
8chedule
8cheduled
Report
Report
Distribution
PnooucTioN
SHirTs
PLANT
HiznAncHY
oTHzn
AcTivLANT
ruNcTioNs
DeIivery
Network
FoIder
Printer E-MaiI
My nbox
My
Subscriptions
System Folders
Personal Folders
8hared
Folders
AcTivLANT
Oszns
FoIders
Subscription
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-11
the reporting service) for storing the XML files is C:\Program
Files\ActivplantCorporation\Activplant\Web\ApReporting\R
eports. You can also see the file sizes in the ActivEssentials
database, in the table tblRC_ReportFiles.
Determine the folder size limits that you can realistically impose on
your users. Some users will need more than others.
Users of the Report Viewer have a visual indicator that shows how
much of their storage space is in use.
Reports Administration and the Report
Viewer
The Report Viewer is a VPWeb view that allows users with appropriate
privileges to generate, view, save, print, and subscribe to reports.
Actions taken in Reports Administration affect what is visible, and what
users can do, in the Report Viewer.
The Reports Administration module is for administrators to
control the content, presentation, storage, and distribution
of reports. Other users cannot access the administration module,
and Administrators are only able to view shared folders in the
Report Viewer.
The Report Viewer is for end users to create, view, and
store reports. Report Power Users can also create report
templates and personal folders in the Viewer. Report Users have
access to only one personal folder (My Inbox).
The following table illustrates some of the differences between the
two:
Table 14-1 Differences between Reports Administration and the Report
Viewer of VPWeb
Report Viewer Reports Administration
Used by end users and administrators. Used by administrators only.
The primary means of creating and
viewing reports.
Can be used to create report templates but
not reports. Cannot be used to view
reports.
Accessed through VPWeb. Accessed through MI Admin.
Consists mainly of folders; user tasks
are limited.
Used for complex administrative tasks
which must be performed before users can
create or view reports in the Viewer.
Report Power Users can create and
delete their own personal folders.
Administrators can create shared folders
for the use of one or more users, but
cannot create or delete personal folders.
Users can create and store report
templates. If security privileges allow,
they may create templates that other
users can use.
Administrators can create report templates
that are available to users, and can be
used for scheduling automatic reports.
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-12
Administrator and Non-Administrator Privileges
in the Report Viewer
In Reports Administration, an administrator can use all the functions of
the module. In the Report Viewer, an administrator has administrative
privileges if logged on as a Default User, but otherwise has the same
privileges as a Report Power User. Here are some of the rules
governing administrators, power users, and report users in the Report
Viewer:
Administrators who log on to VPWeb without selecting the Default
User checkbox have the same privileges as a Report Power User,
and as such, they see the same view as any other power users.
He/she then does not have any special administrative privileges in
the Report Viewer.
Administrators who log on to VPWeb as a default user, see shared
folders only, and can create or delete shared folders and templates
(just as in Reports Administration), and any reports they have
saved.
Report Power Users can create personal folders in the Report
Viewer, but they cannot create shared folders. They can also create
personal report templates.
If a user creates a personal folder in the Report Viewer, the
administrator can see the personal folder in Reports
Administration, but cannot see its contents. An administrator
cannot delete personal folders, but can delete any reports they
contain.
Reporting Privileges and User Levels
There are several roles defined in relation to reports. ActivEssentials
users who are not members of the following roles cannot access the
Report Viewer. They are:
Report User. This is the lowest level of privilege. Members of this
role can use templates to create and view reports. They can also
subscribe to and send reports to others.
Report Power User. Members of this role have all the privileges
of the Report User role, but they can also create folders,
templates, and manage report deliveries.
Report Administrator. Members of this role have full access to all
aspects of the reporting system, including the Report Viewer and
the Reports Administration module of MI Admin.
Query Builder User. This special role is for people who will use
the Activplant Query Builder to create the datasets used for APRS
Query Server report categories.
Note: While Report Administrators cannot delete personal folders, if you remove a
user from the list of ActivEssentials users, the database removes the personal
folders as well.
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-13
Folders and Users
Folder administration is one of the three top-level tasks in the Reports
Administration task module. The folders are actually virtual folders on
the computer that hosts the Activplant reporting service (the report
server). Changes made to folders in this module affect what users can
do in the Report Viewer of VPWeb.
Since folders are closely related to what users see in the Report
Viewer, you will work with user permissions as well as folders in this
area of Reports Administration. Before you can perform folder tasks
you must ensure that the users and roles are set up in the Security
Administration module.
This section covers the following topics:
Folder Navigation in Reports Administration on page 14-13
System Folders on page 14-14
Limits to System Folders on page 14-15
Shared Folders on page 14-16
Personal Folders on page 14-16
Folder Navigation in Reports
Administration
To open the Folder navigation views of MI Admin, click the Folders
category button in the secondary frame of the Reports Administration
task module. It may be above or below the secondary frame.
Below the Navigation frame is the secondary frame with several icons:
System Folders, Shared Folders, and Personal Folders. You click
on these icons to access and use these folders.
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-14
The Navigation frame shows the Object Library, and the items shown
below vary according to the button selected in the secondary frame.
If you click the System Folders icon, the Object Library shows
the system folders below it.
If you click the Shared Folders icon, the Object Library shows
the shared folders that have been created.
If you click the Personal Folders icon, the Object Library shows
a list of ActivEssentials users. If you click on a user in the
Navigation frame, the grid displays the personal folders belonging
to that user.
Folders and Users
When you administer report folders you are controlling what reports a
user can see, limiting the amount of storage space they have, and so
on. The Reports Administration module gathers the user information
and allows you to use it to control users report options.
System Folders
When you first open Reports Administration and click the Folders
category button in the secondary frame, the only items that exist are
the System folders. System folders are virtual folders on the machine
hosting the reporting service. They represent the folders that users
see in the Report Viewer, and cannot be modified or deleted.
Note: You cannot add users or add them to different roles in this module. All those
tasks are performed in the Security Administration task module.
Table 14-2 System folders and Report Viewer folders
System Folder Corresponding Report Viewer Folder
All Reports None
Inbox My Inbox. This folder stores links to reports that are sent to
the user by other users.
Main View Main View. The first (top) page of the Report Viewer,
showing the folders. Users can store reports and templates
in this view, and create new folders.
Recent Reports My Recent Reports. This folder contains links to reports
that the user has created recently. Such reports are
automatically saved on the report server for a time, then
deleted when no longer needed.
Subscriptions My Subscriptions. This folder contains links to reports to
which the user wants to subscribe. By subscribing to a
scheduled report, users can ensure that they receive a copy
whenever the report is generated.
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-15
Limits to System Folders
The system folders are virtual folders in which reports and report
templates are stored. Each user has access to these through the
Report Viewer, and for each user they become their own folders. You
should consider the following:
You need to restrict the amount of data that is kept by each user
because:
Large reports, and large numbers of reports, will consume disk
space on the report server.
Large numbers of reports could affect the load times of views in
the Report Viewer.
There are two levels of control available to you:
You can set default limits for all users. Some users will need
more reports than others.
You can set different limits for specific users.
There are also two limits that you can set for report storage:
You can set a limit on the number of reports that a user can
store.
You can limit the amount of disk space a user has available.
How the Limits Work
When you select the System Folders icon and the Object Library, you
see the system folders. The top level is All Reports. Beneath it are the
other system folders: Inbox, Recent Reports, Main View, and
Subscriptions. The table below explains the limits to these folders.
Table 14-3 Folders and their limits
Folder Limits When limits are reached
All Reports This is the overall limit for all
users. This limit represents the
accumulated totals for all other
system folders, plus personal
folders
Inbox Apply to the users Inboxes The user cannot receive any
other reports. Any user who
sends a report to the users
Inbox will be notified that the
report could not be delivered.
Main View Apply to users Main View of the
Reports Viewer. Saved reports
can affect load time.
The user will not be able to
create a report.
Recent
Reports
Apply to users Recent Reports
folders.
When the next report is viewed,
the oldest report is removed
from the view.
Subscriptions Apply to users Subscriptions
folders.
The user cannot create a new
subscription. If an administrator
attempts to push a new
subscription to the user, they
will receive a failure notification.
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-16
Shared Folders
In a new installation of ActivEssentials, there are no shared folders;
you have to create them. If you have upgraded from a previous
version, you may already have shared folders to use. A shared folder
is a folder for reports that more than one person can access. You can
specify who can access the reports in a shared folder.
Personal Folders
Every Report Viewer user has one personal folder called My Reports.
Users with appropriate privileges can create, modify, or delete other
personal folders through the Report Viewer. You cannot create or
delete other users personal folders in Reports Administration.
However, removing or deleting a user name from the Security
Administration module removes a users personal folders.
Personal folders really belong to the user, and they maintain their
folder through the Report Viewer of VPWeb. In Reports Administration
you will only set a limit to the hard drive space that is available to the
user.
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-17
Report Contents
A report is composed of a category, style, template, and a schedule,
with information gathered from a report provider located on a report
server.
This section covers the following topics:
Report Structure on page 14-17
Report Categories on page 14-18
Report ProvidersWhich is Best for You? on page 14-18
Report Styles on page 14-19
Overview of Report Templates on page 14-21
Report Structure
The creation of a report includes the following elements, however
some of them are only specific to certain report definitions.
Report Category. The category specifies the report provider and
server, including the data requested and the type of report as
follows:
The report provider used to provide the data.
The report server which will handle the report request
The report styles that will be available for the reports within the
category.
You can define, edit, or delete report categories within the Reports
Administration module.
Report Provider. The Report Provider is the reporting system that
accesses the database. For example, the Report Provider for a
certain category of reports could be APRS SP-XML, APRS SP, APRS
Query Service, or SQL Server Reporting Services. Report Providers
are predefined; you can edit all of them except for the APRS
SP-XML, but you cannot add new ones. For more information on
report providers, see Report ProvidersWhich is Best for You? on
page 14-18.
Report Server. This is the computer on which the Activplant
reporting service is installed. The report server forms part of the
definition of a report category; when you create a category you
specify the report server that it will use. Every report provider has
one default report server through which the report request is
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-18
routed by default. When you define the server you can choose to
make it the default server for the provider. You can change the
default server later if desired, using the Properties dialog box.
Report Style. The report style provides options to present the
data from different views, offering summaries, averages, detailed
reports, etc. with graphs and charts. Users can choose a report
style to view information from different perspectives.
Report Template. This is a template that can be used to create
different reports with similar properties. You use templates, for
example, when defining a Scheduled Report or a Report
Distribution. Users also use templates to create their own reports.
A template includes the plant hierarchy items (groups or assets)
that must appear in a report, the kind of data that relates to these
plant hierarchy items, and the time frame for the data.
Report Categories
A Report Category includes the data requested, and the type of report
as follows:
The report provider that is used to provide the data
The report server which will handle the report request
The report styles that will be available for the reports within the
category.
You can define, edit, or delete report categories within the Reports
Administration module.
There are two report categories that come with an ActivEssentials
installation which are different to the other pre-defined report
categories.
Incident Reason Code Report. This report category uses the
APRS SP provider, but the parameters it uses are for Root Cause
Analysis reports.
Production View Reports. This report category supports
Production View reports from VPWeb. The configuration of this
report category comes from the APRS PV provider, and is not
available when creating new report categories.
Report ProvidersWhich is Best for You?
Report providers are the means of querying the database for the
information you need presented in a report. The report provider
determines how the query is made, but the provider you choose to use
could also be influenced by the skills of your database administrators.
APRS SP-XML Provider. The source of the configuration is in
stored procedures that come with a new ActivEssentials database.
These stored procedures facilitate the preparation of reports
without the need to develop new stored procedures. All reports are
prepared in XML and transformed using XSL into HTML reports. The
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-19
configuration and parameters of these reports is read-only,
although there are options for report configuration when defining
individual reports and templates.
You might not need any special SQL programming skills if you use
this report provider, as the report categories that come with
ActivEssentials could meet most of your reporting needs. However,
if you choose to edit the stored procedures under which these
reports must run, you need to understand how to export XML
formatted data from the database, and the role of XSL in
transforming the XML.
APRS SP Provider. This provider makes it possible for users to
define their own stored procedures for report generation. The
report categories ActivEssentials provides might not satisfy your
data querying needs, so you can prepare the stored procedures
that access the data you need.
When preparing stored procedures that run under the APRS SP
Provider, there is no need to output specially formatted XML data;
the standardized XML output from SQL Server is sufficient.
Through Reports Administration, you can apply the styles you need
for presentation purposes.
APRS Query Server. To create report categories that require this
provider, you need to create a dataset in the Activplant Query
Builder. This is a separate application that allows you to build
database queries without having to understand SQL programming.
The Activplant Query Builder allows you to prepare your requests
from the ActivEssentials database using the various building
blocks, such as the plant hierarchy, the data collection methods,
categories, and data items, and the many other configurable
elements of an APRS installation. These elements become the
dataset you must reference when creating the report category.
SQL Server Reporting Service. You might choose to use SQL
Server to prepare your reports, where all the requests for data
come from the host application instead of from within the
ActivEssentials database. You can also use the SQL Server
reporting service to request data from third-party data sources. In
each instance, the output from SQL Server is in HTML, where you
can then view it in the Report Viewer.
The report parameters, etc. reside within SQL Server, and are not
part of the overall APRS configuration. Furthermore, you cannot
edit any aspects of the configuration from within APRS.
Report Styles
A report style is an XSL file that interacts with the data returned from
the database. The data is returned from the database as an XML file
that can only be read with difficulty by a human. To make it readable
in the browser, you apply a stylesheet (style) which determines how
the data is presented. Usually the stylesheet transforms the XML data
into HTML for presentation.
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-20
Each report category has one or more styles associated with it. When
creating a new style you have to specify the report category to which it
will belong.
To access report styles, open the Reports Administration module and
click the Content category button in the secondary frame. Then click
the Styles button. The Navigation frame shows the Object Library and
the defined report categories below it. If you select a category, the
styles associated with the category appear in the grid.
Figure 14-3 The report style entries in the grid
The reporting system comes with several predefined report categories,
with predefined styles that you cannot edit. These are marked in the
grid with an icon that shows a lock. You can copy any of these to
duplicate it, then paste it back in the grid to create a new style that
you can edit. Editable styles have an unlocked icon.
Creating a New Report Style
When you create a new report style you must give the name of the
XSL stylesheet that it uses. Creating a new report stylesheet requires
specialist knowledge. You need to know both XSL and HTML, and you
must also be familiar with the XML data structure that is returned from
the database. We recommend that you duplicate and edit an existing
style whenever possible.
When you create the style within Reports Administration, you have to
specify the XSL file that it will use. The XSL styles by default are in the
folder C:\Program
Files\ActivplantCorporation\Activplant\Web\ApReporting\Styles. A
style name can be up to 255 characters.
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-21
Overview of Report Templates
A report template is a set of parameters that are used for creating
reports, either in the Report Viewer or as scheduled reports. They
have several characteristics:
Both administrators and end users can create templates. Users
who have appropriate security privileges can make templates
available to other users, or keep them for their own use.
They are linked to a report category that defines the report
provider and styles that are available to the template. See Report
Categories on page 14-18.
Templates have a number of styles associated with them. These
are the views that the user can use to view a report generated
from the template. One style is defined as the default style for the
template; it is pre-transformed (along with others if you specify
them) for faster rendering in the users browser. See Report Styles
in Scheduled Reports on page 14-25.
A template is associated with groups and/or assets in the plant
hierarchy. It defines the scope of the data that will be presented in
the report.
A template always has a time frame for the data that it will
retrieve. There are several different kinds of time frames.
The template is stored in an Activplant folder. When you create the
template you specify the folder in which it will be stored. If you are
an administrator, you may want to store it in a shared folder, so
that users can use it. An end user may also create a template and
store it in one of their personal folders or (if their security
privileges permit) in a shared folder.
A template can be associated with a schedule for the generation of
scheduled reports. See Schedule Structures on page 14-24.
Time Frames for Report Templates
Report templates have a time frame attached to them that determines
the time frame for the data to be retrieved from the database. There
are several options when defining the time frame for the template.
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-22
Figure 14-4 The Time frame options for a template
Group/Asset selection. This is an optional selection, and only
applies if an identifier item is included in the overall definition. The
Relative Time Frame, Unique Identifier, Adjust the time
frame, and Filter by identifier options could apply to the entire
plant hierarchy, but you can reduce the scope of the report by
selecting a group or asset.
Time frame definitions:
Fixed Time Frame. The current time frame displayed in the
VPWeb time-picker acts as the time frame parameter for the
report.
Relative Time Frame. This allows you to specify a time frame
such as the last three production shifts, the last two weeks, the
last ten instances of a particular identifier, etc.
Unique Identifier. A time frame based on an identifier such as
a batch number or serial number.
Optional identifier filtering methods:
Adjust the time frame by an identifier. The time frame is
adjusted to fit with the start and end times of a particular
identifier.
Filter by identifier. The time frame is modified to fit with the
occurrence(s) of a specific identifier, and other filtering
mechanisms. This filter can give finely defined spans of time.
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-23
Combining Identifier Correction and Filtering
You can combine identifier correction and filtering. This may be used,
for example, when you want to obtain data for time periods when
certain identifier values occurred, or create a birth history report based
on a unique identifier but you do not have information about the time
when the identifier occurred.
Note: Identifier here means any definition of a span of time, and can include the
normal identifier definitions, plus shifts, shift periods, and incidents. The
purpose for including incidents is to use some of their underlying properties,
such as the description or a reason code as a means of extracting data for
reports.
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-24
Distribution of Reports
You can generate a report at a particular time, then have the report
server place the report in a users inbox, or a shared folder. You can
also send reports automatically to one or more users via e-mail or
several other means.
To send an automatically-generated report to a users inbox or a
shared folder, you use a Scheduled Report.
To send automatically-generated reports to a variety of internal
and external destinations, you use a Report Distribution, which are
dependent on a scheduled report.
This section covers the following topics:
Schedule Structures on page 14-24
Scheduled Reports and Report Distributions on page 14-25
Scheduled reports on page 14-25
Report Distributions on page 14-27
Schedule Structures
Schedules are used in ActivEssentials for report generation; data
management tasks such as archiving, purging, and restoring data; and
other tasks. The features and methods are common to all areas. You
can run your schedules based on days, weeks, or months. Any one
schedule can include several instances of when a task takes place, and
could also include any number of other defined tasks. The schedule
types are as follows:
A schedule consists of the following elements:
A time-based framework. This identifies the frequency structure,
which is based on a specified number days, weeks, or months.
A recurrence pattern. This determines the occurrence of the
schedule. For example, you might want an instance of the schedule
to run every two days, or on the third Monday of the month.
A frequency pattern. This determines how many instances there is
of activity within the schedule. For example, you may want the
schedule to operate only once on a given day, or you may want it
to run every hour on that day.
Note: Daily, Weekly, and Monthly do not mean every day/week/month. They
mean that the schedule is based on days, weeks, or months. A daily schedule
may run every third day; a weekly schedule may run on the Monday and Friday
of every third week.
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-25
Scheduled Reports and Report
Distributions
When setting up reports, you can choose to provide users with
scheduled reports that either are placed in their personal folders, or
sent by e-mail to ActivEssentials users or non-ActivEssentials users.
The main differences are:
A Scheduled Report provides ActivEssentials users with reports.
Report Distribution sends these reports to people who do not use
ActivEssentials.
ActivEssentials users can subscribe to a Scheduled Report (if it is
available for subscription), but they cannot subscribe to a
distribution.
Scheduled reports
Scheduled reports allows you to send generated reports to internal
users on a regular basis. The scheduled report consists of:
A report template. This defines the groups and assets, data items,
and the time frame for the report.
A schedule. This defines when and how frequently the report is
generated.
Delivery instructions. These determine where the generated
reports are sent. You can send the reports to the specified users
Inbox, or to selected shared folders.
Report Styles. These are the XSL transformations that will be
carried out when the report is generated. This pre-transformation
happens before the user views the report and allows the report to
be rendered more quickly for the user. For more information, see
Report Styles in Scheduled Reports on page 14-25.
When you create a scheduled report you can set it to be available for
subscription. Any user can then have the report delivered to his/her
My Subscriptions folder in the Report Viewer. If you do not make it
available for subscription, only the users specified in the delivery
instructions will receive it.
Report Styles in Scheduled Reports
Every report has a number of styles associated with it. These allow the
user to view the same data from different perspectives in their
browser. Styles are defined for the report category.
If the report includes a considerable amount of data, it may take some
time to perform a transformation on the fly for presentation on a
users machine. To avoid making the user wait, you can define one or
more styles that will be pre-transformed when the report is
generatedthat is, before the user requests to view the report.
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-26
When you define a scheduled report you can specify which styles
should be pre-transformed, usually the ones most commonly used.
One style is set as the default styleit will always be pre-transformed.
You can change the default style; usually you would want it to be the
one used most often.
Template Suitability
Scheduled reports use a template for gathering information, but it is
possible that individual templates might not be suitable for scheduled
use.
If the OK button on the Report Templates dialog box remains disabled
after you have selected a template, the template is improperly
configured for use with scheduled reports. If this occurs, you can
correct the template by clicking the Edit button and then changing the
configuration as needed. You could receive one of two possible error
messages:
Figure 14-5 Improperly configured template
Group/Asset list. In a scheduled report, the groups and assets
must be pre-defined in the template. A configuration that includes
the option to use the plant hierarchy choice in VPWeb does not
work, since the report is independent of VPWeb.
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-27
Time frame definitions. The span of time must be pre-defined in
the template. You cannot use templates that use the time frame in
the VPWeb time picker as the definition, as scheduled reports are
prepared independent of the use of VPWeb.
Report Distributions
Report distributions enable you to send automatically generated
reports to both internal and external destinations.
Options for Report Distribution
An overview of a report distribution is shown in the following figure:
Figure 14-6 Overview of Report Distribution
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-28
When you create a report distribution you must supply the following
information:
The report template that it will use. The template supplies
information about the groups and/or assets, data items, and time
frame for the report.
The schedule for report generation. This supplies information about
when the report generates and how many times the report should
be generated and distributed.
The Distribution Type. This determines the method of delivery. You
can send the report by e-mail to designated recipients, and/or as a
file to a specified computer or folder.
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-29
Configuring Folders
The Folders task sub-module is where you prepare the structure for
the storage of all of the reports your users need to view. This structure
includes the assignment of storage space and the creation of the
shared folders.
This section covers the following topics:
Determining Realistic Limits for Folder Contents on page 14-29
Setting Default Limits for System Folders on page 14-30
Controlling Report Storage Limits By Role on page 14-31
Controlling Report Storage Limits By User on page 14-33
Creating a New Shared Folder on page 14-34
Creating a New Shared Folder From an Existing Folder on page
14-35
Assigning Users to a Shared Folder on page 14-36
Determining Realistic Limits for Folder
Contents
Use the instructions below to determine the realistic limits for users
report folders. The storage space that you give them will depend on
the number of users, the number of stored reports, and the hard drive
space available.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
Set up roles and users in the Security module of MI Admin. See
Security in AppCenter on page 10-1 for information on doing this.
Set up a report server with adequate hard drive space. See Setting
Up a Report Server on page 14-40 for information on doing this.
Procedure
1 Make a list of reports that are accessed by multiple users.
Reports that are accessed by many people are only stored once.
You only need space for one copy of a report.
Note: Reports that users create or save require space because of the data that is
collected (an XML file), the report file itself (an HTML file), and any files a user
generates when exporting the data to alternative formats, such as Excel
spreadsheets, PDF files, and CSV files. Templates, reports that a user receives
by subscription, a report distribution to a network folder or through e-mail, do
not take up space.
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-30
2 Find out how many people are likely to create and store their own
reports.
These are the people who will need most space.
3 Find out the average number of reports that people are likely to
store.
You can always adjust the amount of space for individual users
later on.
4 Run a few typical reports in the Report Viewer and look at the
size of the XML files (not the HTML files). You can find out the file
sizes as follows:
a) By viewing the tblRC_ReportFiles database table.
b) By looking in the folder C:\Program
Files\CDCFactory\Activplant\Web\ApReporting\Reports.
c) By looking in the Report Viewer and seeing how much space
has been used.
5 Determine the amount of disk space available on the report server
after the report service and any other software applications are
installed.
6 Subtract the space required for commonly-accessed reports, then
divide the remainder by the number of report creators.
This gives you the maximum amount of space you can theoretically
allocate to each user.
7 Set the default folder limits to something less than the result (you
may need to add extra users later).
8 Adjust the limits for individuals if necessary.
Setting Default Limits for System Folders
Use the instructions below to set the default limits (size and number of
reports) for the system report folders (All Reports, Main View, Recent
Reports, Subscriptions, and Inbox). The limits you set will apply to all
users unless you specifically change them for individual users. They
will also apply to any new users who are added to the system later on.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Reports Administration task module using
the instructions in Opening the Reports Administration Module on
page 14-3.
Read Limits to System Folders on page 14-15.
Note: After the generation of a report, you will find both an XML and an HTML file.
You should add the sizes of these files together.
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-31
Procedure
1 In the secondary frame, click the Folders category button.
2 Click the System Folders icon in the secondary frame.
3 In the Navigation frame, select the Object Library, if it is not
already selected.
4 On the row in grid that represents the system folder limit you need
to set, click in the cell in Report/Template. column.
The present limit becomes editable.
5 Click the up- or down-arrows to edit the limit to your needs.
6 Click anywhere outside the cell to save your changes.
Controlling Report Storage Limits By Role
Use the instructions below to control the number of reports a user can
store. You can set global limits for all reports, and/or individual limits
on specific folders.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Reports Administration task module using
the instructions in Opening the Reports Administration Module on
page 14-3.
Read Limits to System Folders on page 14-15.
Procedure
1 In the secondary frame, click the Folders category button.
2 Click the System Folders icon in the secondary frame.
3 In the Navigation frame, select the system folder to which you
need to add limits.
The users that are already assigned are listed in the grid, along
with their present limits and current usage.
4 On the toolbar, click Set Limits.
Note: For details of the default values, and the maximum or minimum that you can
specify, see Limits to System Folders on page 14-15.
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-32
Figure 14-7 The Apply Settings dialog box
5 In the Report/Template limit field, click the up- or down-arrows
to set the limit.
6 In Apply to groupbox, select the Selected roles option and then
click Select Roles.
Figure 14-8 The Available Roles editor
Note: If there are many defined roles, you can view them in two ways. The default
view displays ten roles at a time, and then page through the roles ten at a time,
as illustrated in Figure 14-8. Alternatively, you can view all roles at the same
time and use the scroll bar to locate the roles.
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-33
7 In the editor, select the checkboxes for the roles to which you want
to apply these limits, and then click OK.
8 Click OK to close the properties dialog box.
Controlling Report Storage Limits By User
Use the instructions below to set one or more users system folder
limits. If you change a users limit to something equal to or less than
their current usage, a warning message appears. The user will not be
able to create a report unless they first delete some existing ones.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Reports Administration task module using
the instructions in Opening the Reports Administration Module on
page 14-3.
Read the following:
System Folders on page 14-14
Determining Realistic Limits for Folder Contents on page 14-29
Set up global limits, as described in Setting Default Limits for
System Folders on page 14-30.
Set up a server for reporting, as described in Setting Up a Report
Server on page 14-40.
Procedure
1 In the secondary frame, click the Folders category button.
2 Click the System Folders icon in the secondary frame.
3 In the Navigation frame, select the system folder to which you
need to add limits.
The users that are already assigned are listed in the grid, along
with their present limits and current usage.
4 Do one of the following:
a) If you want to apply the settings to all users, do not make any
selections in the grid and go to Step 5.
b) If you want to apply the limits to one or more users, select
them in the grid.
To select a block of users, click the first, then hold down the
Shift key and click the last. All the ones in between will also be
selected. To select non-contiguous users, hold down the Ctrl
key and click each user.
Note: If you need to change the limits for just one user, you can edit these in the
appropriate cells in the grid.
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-34
5 On the toolbar, click the Set Limits button.
If you did not make a selection in the grid, the Selected users option is
disabled.
Figure 14-9 The Set Limits dialog box
6 In the Report/Template limit field, click the up- or down-arrows
to set the limit.
7 In Apply to groupbox, do one of the following:
a) If you want to apply these limits to all users, click the All users
option.
b) If you want to apply these limits to the users you selected in
the grid, click on the Selected users option.
8 Click OK.
The selected users limits are changed.
Creating a New Shared Folder
Use the instructions below to create a new shared folder. You can
create any number of levels of folders. After creating the folder, you
must assign users to it; these are the users who should have access to
the reports in the folder.
Note: If you reduce a limit so that it is equal to or less than the users current usage, a
message asks if you really want to do this. Sometimes you may want tofor
example, if you want to force a user to delete some old reports.
Note: The name of the shared folder can be up to 50 characters. It must not contain
any of the following characters: . ( ) " ' \ / : * ? < > |
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-35
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Reports Administration task module using
the instructions in Opening the Reports Administration Module on
page 14-3.
Read Shared Folders on page 14-16.
Procedure
1 In the secondary frame, click the Folders category button.
2 In the Folders frame, click the Shared Folders icon.
The grid displays all of the top level shared folders.
3 In the Navigation frame, select the level below which you want to
create the new folder.
You can choose the Object Library itself or any folder below it.
4 Click the New button on the toolbar.
Figure 14-10 The new shared folder dialog box
5 Type the name of the new folder and click OK.
Creating a New Shared Folder From an
Existing Folder
Use the instructions below to create a duplicate copy of a shared
folder.
Note: If you select a folder in the grid instead of in the Navigation frame, and click the
New button, the new folder will be on the same level as the selected folder.
Alternatively, you can type the name of the folder in the New row of the grid.
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-36
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Reports Administration task module using
the instructions in Opening the Reports Administration Module on
page 14-3.
Created a folder using the instructions in Creating a New Shared
Folder on page 14-34.
Read Shared Folders on page 14-16.
Procedure
1 In the secondary frame, click the Folders category button.
2 In the Folders frame, click Shared Folders.
The grid displays all of the top level shared folders.
3 Below the Object Library, navigate to and select the folder you
need to copy.
4 On the toolbar, click the Copy button and then click the Paste
button.
A new row for the folder appears in the grid.
Assigning Users to a Shared Folder
Use the instructions below to assign users to a shared folder. Only
users that you assign will be able to access reports stored in the
shared folder.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Reports Administration task module using
the instructions in Opening the Reports Administration Module on
page 14-3.
Created a folder using the instructions in Creating a New Shared
Folder on page 14-34.
Read Shared Folders on page 14-16.
Note: The new folder is the same in every way as the original, but its name includes
Copy of and will appear in the grid in the Cs. If you use the paste command
from a different page, you might not recognize that the operation was
successful.
Note: The creator of a shared folder is automatically granted access to the folder.
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-37
Procedure
1 In the secondary frame, click the Folders category button.
2 Click the System Folders icon in the secondary frame.
3 In the Navigation frame, select the Object Library.
Entries for the currently defined shared folders appear in the grid.
4 Right-click the shared folder in the grid and select Properties.
Figure 14-11 The properties dialog for shared folders
5 On the properties dialog box, click the Security tab.
The dialog box displays the currently assigned roles and users.
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-38
Figure 14-12 The Security tab of the properties dialog box
6 Click Add.
Note: The Report Administrator and System Administrator roles appear in the list by
default.
Note: The dialog box shows only roles you may have defined after the installation of
the ActivEssentials database. You cannot modify the privileges of the
ActivEssentials pre-defined roles.
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-39
Figure 14-13 The Available Users/Roles dialog box
7 Do one of the following:
a) Select the Role only radio button to see only roles, or
b) Select the Users only radio button to see only users, or
c) Select the Both button to see both roles and users.
8 In the Select column, select the users or roles that you want to
have access to the folder.
9 Click OK when done.
The users and/or roles appear in the Properties dialog box.
10 Click OK to close the Properties dialog box.
Note: A role, in this context, just includes the users who are current members of the
role. If the membership of the role changes (additions and removals), no
changes occur in the list of users who are assigned to the shared folder.
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-40
Configuring Report Content
In the Content task category, you can create links to your report
servers, set up your report categories (some are already defined),
create links to stylesheets, and define your report templates.
This section covers the following topics:
Setting Up a Report Server on page 14-40
Creating New Report Servers From Existing Servers on page 14-42
Creating a Report Category on page 14-43
Creating a New Report Category From an Existing Category on
page 14-48
Linking to a Report Style on page 14-49
Creating a New Report Style From an Existing Style on page 14-50
Creating a Report Template on page 14-51
Choosing Groups and AssetsAPRS SP-XML Report Template on
page 14-54
Choosing a Time FrameAPRS SP-XML Report Template on page
14-55
Choosing Data ItemsAPRS-SP XML Report Template on page
14-59
Enabling Scheduling on page 14-60
Creating an Incident Reason Code Report Template on page 14-64
Structure of Report Content on page 14-67
Creating Legacy ReportsWizards For APRS SP-XML Report
Categories on page 14-67
Setting Up a Report Server
Use the instructions below to register a report server in the APRS
reporting system.
Prerequisites
Before doing this you need to have done or read the following:
Install the appropriate reporting service on a machine on your
network. See How Much Hard Drive Space Do I Need? on page
14-10 for information on the hard drive requirements for this
server.
If the report server is to run the APRS reporting service, you must
install the ActivEssentials Web components as well as the reporting
service.
If necessary, open the Reports Administration task module using
the instructions in Opening the Reports Administration Module on
page 14-3.
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-41
Procedure
1 In the secondary frame, click the Content category button.
2 In the Content frame, click the Servers icon.
3 On the toolbar, click the New button.
The Add New Report Server wizard starts.
4 Click Next to move past the welcome page.
Figure 14-14 The Name, Host Name and Description page of the wizard
5 Do the following, as needed:
a) In the Name field, type a name (up to 50 characters) for the
report server.
b) Click the ellipsis button by the Host Name field. When network
browser opens, navigate to and select the computer that hosts
the reporting service, and then click OK.
c) In the Description field, type a description of the report server
(optional).
6 Click Next.
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-42
Figure 14-15 The Report Server Configuration page of the wizard
7 Click the down-arrow by the Report Server Type field and select
the reporting service from the list.
8 In the Web Service URL field, ensure that the automatically filled
URL for the reporting service is valid.
The URL is in the form http://<hostname>.domain.com/
ApReportingService/ApReporting.asmx.
9 If you want this server to be the default server for the reporting
service that it hosts, check the Default Report Server field.
10 Ensure that the Active checkbox is selected.
11 Click Next.
The final page of the wizard opens.
12 Review the definition and click Finish.
Creating New Report Servers From
Existing Servers
Use the instructions below to make a copy of the configuration an
existing report server. Use this method if the configuration of the
new server is essentially the same as the original.
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-43
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Reports Administration task module using
the instructions in Opening the Reports Administration Module on
page 14-3.
Created a report server using the instructions in Setting Up a
Report Server on page 14-40.
Procedure
1 In the secondary frame, click the Content category button.
2 In the Content frame, click the Servers icon.
The grid displays the report servers that have been defined.
3 Right-click a report server in the grid and choose Copy.
4 Right-click elsewhere in the grid and choose Paste.
A new row for the server appears in the grid.
Creating a Report Category
Use the instructions below to create a new report category.
Prerequisites
Before doing this you need to have done or read the following:
Identify your report servers, as described in Setting Up a Report
Server on page 14-40.
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Reports Administration task module using
the instructions in Opening the Reports Administration Module on
page 14-3.
Read Report Categories on page 14-18, for the components of a
report category.
Read Report ProvidersWhich is Best for You? on page 14-18 for
how the report providers vary.
Procedure
1 In the secondary frame, click the Content category button.
2 In the Content frame, click the Categories icon.
The grid displays the report categories that have been defined.
Note: The new server is the same in every way as the original, but its name includes
Copy of and will appear in the grid in the Cs. If you use the paste command
from a different page, you might not recognize that the operation was
successful.
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-44
3 On the toolbar, click the New button.
The New Report Category wizard opens.
4 Click Next to move past the welcome page.
Figure 14-16 The Name and Description page of the wizard.
5 Do the following, as needed:
a) In the Name field, type a name for the report category (up to
50 characters).
b) In the Description field, type a description of the category
(optional).
6 Click Next.
Figure 14-17 The Define Report Category page of the wizard
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-45
7 Do each of the following:
a) Click the down-arrow by the Report Provider field and select
a provider from the list.
b) Click the down-arrow by the Report Server field and select the
server to use for the report category.
8 Click the Provider Configuration button.
Depending on which report provider you chose, one of three
versions of the Provider Configuration dialog box opens.
Figure 14-18 The Provider Configuration dialog boxes
9 Do one of the following:
a) For APRS SP-XML or APRS SP provider categories: in the
Stored Procedure Name field, type the name of the stored
procedure that contains the configuration, or
b) For APRS Query Server provider categories: click the
down-arrow by the Dataset Name field and select the dataset
that contains the configuration, and then type a description, or
c) For SQL Server Reporting Service provider categories: do the
following:
In the Report parameters section, either choose not to
load the parameters or to load the parameters from an
existing report.
Note: If you choose to not load the parameters, you need to specify these from within
SQL Reporting Services, or if you choose to use an existing report, you must
provide a path to the report, which is available from within SQL Reporting
Services.
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-46
In the Report view toolbar section, select the options you
need when SQL Reporting Services opens.
If you are referencing an existing report, in most instances you
do not need to display the toolbars. However, the option is
there should you need to reconfigure the report.
10 Click OK.
11 On the wizard page, click the Parameters button.
Figure 14-19 The Report Parameter Configuration dialog box
12 In the Parameters List pane, select a parameter. Click the
Refresh Parameter List button to check for any new or available
parameters in the source configuration.
Additional parameters will appear in red in the parameter list.
13 In the Parameter Definition groupbox, do the following:
a) In the Prompt field, type a name as an alias for the parameter.
b) In the Data Type field, click the down-arrow and select the
type from the list.
Note: You cannot browse to and select the appropriate stored procedure, dataset, or
report definition. There is no validation after you complete the configuration, so
you should run a report immediately afterwards to ensure the configuration is
correct.
Note: The list of parameters varies with each provider and supplied provider
configuration. These parameters come from the stored procedures that were
defined for the category by the provider configuration.
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-47
14 In the Data Source field, click the down-arrow and choose one of
the following:
a) If you do not need to define a list of values, select None and go
to Step 17.
b) If you need to define a list of values to select as the default
value, select User-defined list.
15 Click the ellipsis button by the Data Source field.
The Data Source Configuration dialog box opens.
Figure 14-20 The Data Source Configuration dialog box
16 For each value that you need to create, do the following:
a) Double-click in a new cell in the Label column and type a name
for the value, then double-click in the Value column and type a
value.
Note: The data type you choose determines the options in the Parameter Options
groupbox, if any. If fields are active, set the available options.
Note: The Data Source Configuration dialog box lets you create a list of values that
you can use as the default, which can then be changed as necessary.
Note: The values you generate in your list must match the data type. For example, if
the data type is Text, the list items must text strings, or if the data type is
Boolean, the values must 1 or 0.
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-48
b) When finished, click OK.
17 In the Default Value field, do one of the following:
a) If you chose None in the Data Source field and you do need
to create a default value, leave the field blank.
b) If you chose None in the Data Source field, and you need a
default value, then type a value in the field.
c) If you created a User-defined list, click the down-arrow and
select it from the list.
18 If there is a user-defined list and you want users to be able to edit
the list, select the Editable checkbox.
19 If the data type is Text, and there might be multiple values, select
the checkbox and specify a punctuation character to separate the
values.
20 If the parameter does not need a value to function, select the
checkbox, then click OK.
21 Select the Active checkbox, and click Next.
The final page of the wizard opens.
22 Review the definition and then click Finish.
Creating a New Report Category From an
Existing Category
Use the instructions below to create a copy of a report category. Use
this method if the properties of an existing category are similar to the
new category you need. Once you have created the duplicate, you
must edit its properties to match the new category.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Reports Administration task module using
the instructions in Opening the Reports Administration Module on
page 14-3.
Create a report category using the instructions in Creating a Report
Category on page 14-43.
Procedure
1 In the secondary frame, click the Content category button.
2 In the Content frame, click the Categories icon.
The grid displays the report categories that have been defined.
3 Right-click the report category in the grid and select Copy.
4 Right-click anywhere in the grid, and select Paste.
A new row for the category appears in the grid.
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-49
Linking to a Report Style
Use the instructions below to select a predefined report style for a
report category. Report styles control the presentation of the data in
your reports.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Reports Administration task module using
the instructions in Opening the Reports Administration Module on
page 14-3.
Determine the location (path) and name of the stylesheet (.xsl) file
that will control the appearance of reports. These are located on
the report server.
Procedure
1 In the secondary frame, click the Content category button.
2 In the Content frame, click the Styles icon.
3 In the Report Categories frame, select a category under the
Object Library.
The grid displays the report styles that have been defined for the
category.
4 On the toolbar, click the New button.
The Add New Report Style wizard opens.
5 Click Next to move past the welcome page.
Note: The new category is the same in every way as the original, but its name
includes Copy of and will appear in the grid in the Cs. If you use the paste
command from a different page, you might not recognize that the operation
was successful.
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-50
Figure 14-21 The Name and Description page of the wizard
6 Do each of the following:
a) In the Name field, type a unique name of the style (up to 255
characters).
b) In the Description textbox, type a brief description for the
style.
c) In the Transformation field, type the full path to the
stylesheet (.xsl) file or report that controls the output.
d) Select the Active checkbox.
7 Click Next.
The final page of the wizard opens.
8 Click Finish.
Creating a New Report Style From an
Existing Style
Use the instructions below to make a copy of a report style. Use this
method if the existing report style is similar to the report style you
need.
Note: APRS SP-XML, APRS SP, and APRS Query Server providers use an XSL
stylesheet.
Note: You can only duplicating report styles within the same report category.
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-51
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Reports Administration task module using
the instructions in Opening the Reports Administration Module on
page 14-3.
Determine the location (path) and names of the stylesheet (.xsl)
files that control the appearance of reports. These are located on
the report server.
Procedure
1 In the secondary frame, click the Content category button.
2 In the Content frame, click the Styles icon.
3 In the Report Categories frame, select the category that uses the
report style you need to copy.
The grid displays the report styles that have been defined for the
category.
4 Right-click the report style in the grid and select Copy.
5 Right-click anywhere in the grid and select Paste.
A new row for the report style appears in the grid.
Creating a Report Template
Use the instructions below to create the name, scheduling, and
destination for your report template. The following sections describe
additional detailed parameters required for the APRS-SP XML report
category. If you are creating an APRS SP, APRS Query Server, or SQL
reporting service template, follow these steps, then go to Enabling
Scheduling on page 14-60.
Once you have completed the basic structure for the template, you can
provide the data details required in the report.
1 In the secondary frame, click the Content category button.
2 In the Content frame, click the Templates icon.
3 In the Report Categories frame, select the report that needs a
new report template.
The grid displays the templates that have been defined for the
category.
4 On the toolbar, click the New Template button.
The New Report Template wizard opens.
Note: The new report style is the same as the original, but its name includes Copy
of and will appear in the grid in the Cs. If you use the paste command from a
different page, you might not recognize that the operation was successful.
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-52
5 Click Next to move past the welcome page.
Figure 14-22 The Name and Description page of the wizard
6 Do each of the following:
a) In the Name field, type a unique name for the new report
template (up to 50 characters), then test the validity of the new
name by clicking the Validate Name button by the Name
field. A message opens that confirms or not the validity of the
name.
b) In the Description field, type a short description of the
purpose of the new template (optional).
7 Click Next.
Figure 14-23 The Report Template Configuration page of the wizard
8 Click the Parameters button.
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-53
Figure 14-24 The Report Template Parameters dialog box
9 If you are creating an APRS SP-XML report template, go to
Choosing Groups and AssetsAPRS SP-XML Report Template on
page 14-54. If you are creating an APRS SP, APRS Query Server, or
SQL report template, you can modify these parameters by clicking
or double-clicking in the grid and entering another value.
Figure 14-25 Report Parameters for APRS Query Server and SQL reports
10 Select the report style from the Default style drop-down list, then
follow the steps in Enabling Scheduling on page 14-60.
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-54
Choosing Groups and AssetsAPRS
SP-XML Report Template
Use the instructions below to create a report template from an APRS
SP-XML report category. In this report template, you can choose
groups/assets, a time frame, and data items.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Reports Administration task module using
the instructions in Opening the Reports Administration Module on
page 14-3.
Completed the steps for Creating a Report Template on page
14-51.
Procedure
1 Complete steps 19 in Creating a Report Template on page 14-51.
From the Report Template Parameters box on the Group/Asset
list row, click the cell in the Value column, and then click the
ellipsis button that appears.
Figure 14-26 The Group or Asset Selection dialog box
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-55
2 Do Step a or Step bbelow:
a) If you want users to define the groups or assets, select the
User-defined Group/Asset option, and then do one of the
following:
Select Use group/asset selection in VPWeb if the
selection in the Asset window in VPWeb should indicate
what to include, or
Select Dont use option if you want users to choose the
groups/assets in the Report Viewer.
b) If you want to pre-define the group/asset selection, select the
Template-defined option, and do the following:
For each group or asset you want to include, select the item
in the Available Group/Asset pane, and click the button.
If you have selected any groups and need all the
descendent items (groups and assets) to appear in any
reports, select the checkboxes in the Descendent column.
3 Click OK to return to the Report Template Parameters box. Proceed
with Choosing a Time FrameAPRS SP-XML Report Template on
page 14-55.
Choosing a Time FrameAPRS SP-XML
Report Template
Use the instructions below to choose a time frame for an APRS SP-XML
report template.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, open the Reports Administration task module using
the instructions in Opening the Reports Administration Module on
page 14-3.
Completed the steps for Creating a Report Template on page
14-51.
Completed the steps for Choosing Groups and AssetsAPRS
SP-XML Report Template on page 14-54.
Note: When you select the checkboxes in the Descendent column, the report
includes detailed information for the descendent groups and assets. If the
checkboxes are left cleared, the reports provide generic information on the
activity below the selected group.
Note: You should be in the Report Template Parameters dialog box.
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-56
Procedure
1 On the Time frame definitions row, click the cell in the Value
column, and then click the ellipsis button that appears.
Figure 14-27 The Time Frame Definition dialog box
2 Click the ellipsis button by the Group/Asset field, and browse to
and select the group/asset to which the template should refer, and
click OK.
3 Do one of the following:
a) If you want the reports to take the time frame from the VPWeb
time picker, select the Fixed Time Frame option and then go
to Step 5.
b) If you want to use a time frame based on several measures of
time, select the Relative Time Frame option, and go to Step
4.
Note: You do not have to choose a group/asset. If you do, and specify identifiers in
your time frame, the report provides information about identifiers for specific
groups/assets. If you do not select groups/assets, the report provides identifier
information for the whole plant.
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-57
c) If you want to use the span of time when a particular identifier
is current, select the Unique Identifier option, and go to Step
6.
4 Click the ellipsis button for the identifier, then navigate to and
select the time identifier and click OK.
You can narrow your report to include only time frames using the
identifiers in this browser window. You can also set the number of
instances of the identifier in the last spinbox.
a) If you need to include details of a current instance of the
identifier, select the Include Current checkbox, and click the
ellipsis button to the right, select the identifier you want to use,
then click OK.
5 Do one of the following;
a) If there is no need to adjust the time frame by a secondary
identifier, go to Step 9.
b) To adjust the time frame of the report to match with a
secondary identifier, select the Adjust the time frame by
checkbox and click the Edit button.
Figure 14-28 The Time Frame Adjustment dialog box
Note: If you decide to use the Unique Identifier option, the user must provide the full
identifier name when initiating the report. However, if users need to search for
identifiers using a partial name, use the Filter by Identifier option.
Note: If you are creating templates for Birth History or Incident by Identifier reports,
you must use either a Unique Identifier time frame definition, or Filter by
Identifier.
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-58
6 Click the ellipsis button by the Select an identifier field.
Figure 14-29 The AppCenter Identifier Browser
7 Browse to and select the identifier to use, and then click OK.
The identifier name appears in the Select an identifier field, and
the groupboxes in the lower portion of the dialog box become
enabled.
8 Do the following, as needed:
a) If you need to adjust the start time, select the Correct Start
Time To checkbox and choose either to use the start time that
immediately before or after the primary identifier start time.
b) If you need to adjust the end time, select the Correct End
Time To checkbox and choose either to use the start time
immediately before or after the primary identifier end time.
9 Do one of the following:
a) If you do not need to modify the time frames by a secondary
identifier, go to Step 10.
b) To capture only the time frames that occur for a secondary
identifier, during the time frame of the primary identifier, select
the Filter by Identifier checkbox, and then click the Edit
button.
Note: You can choose to modify the start and end times of the report time frame by
aligning these times to either the start or end times of the identifier, if current.
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-59
Figure 14-30 The Filter by an Identifier dialog box
10 In the Filter Expression groupbox, click the ellipsis button by the
Identifier field, then browse to and select the identifier you need
to use, and click OK.
The identifier name appears in the identifier field.
11 In the field below the Identifier, select a comparison method and
search string as follows:
a) In the field to the right, type your search string.
b) Click the down-arrow by the Limit to field, select the
appropriate option, and then specify the number of
occurrences.
12 Select the Include Current checkbox, to include the identifier if it
is current when you run the report.
13 Click OK on both the Filter by an Identifier and Time Frame
Definition dialog boxes.
The Report Parameter Template dialog box displays.
14 Proceed with Choosing Data ItemsAPRS-SP XML Report Template
on page 14-59.
Choosing Data ItemsAPRS-SP XML
Report Template
Use the instructions below to choose data items for the APRS-SP XML
report template.
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-60
Prerequisites
Before doing this you need to have done or read the following:
If necessary, open the Reports Administration task module using
the instructions in Opening the Reports Administration Module on
page 14-3.
Completed the steps for Creating a Report Template on page
14-51.
Completed the steps for Choosing Groups and AssetsAPRS
SP-XML Report Template on page 14-54.
Completed the steps for Choosing a Time FrameAPRS SP-XML
Report Template on page 14-55.
Procedure
1 Complete steps 116 of Choosing a Time FrameAPRS SP-XML
Report Template on page 14-55.
2 You should then be in the Report Template Parameters dialog box.
On the Data items row, click the cell in the Value column, and
then click the ellipsis button that appears.
A report template wizard starts.
3 Select the collection categories to include in the report, and then
click Next.
4 On the next pages, make either single or multiple selections and
click Next.
5 On the last page of the wizard, click Finish.
6 Click OK to close the Report Template Parameters dialog box.
Enabling Scheduling
Use the instructions below to enable a schedule for your report. You
set up the schedule and delivery options in Creating a Scheduled
Report on page 14-75.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, open the Reports Administration task module using
the instructions in Opening the Reports Administration Module on
page 14-3.
Completed all of the steps for Creating a Report Template on page
14-51.
Note: The steps in the wizard vary with your initial selection in the Report Categories
frame. For more information, see Creating Legacy ReportsWizards For
APRS SP-XML Report Categories on page 14-67.
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-61
Procedure
1 Complete steps 19 of creating a report template. If you are
creating an APRS SP-XML report, complete Choosing Groups and
AssetsAPRS SP-XML Report Template on page 14-54, Choosing a
Time FrameAPRS SP-XML Report Template on page 14-55, and
Choosing Data ItemsAPRS-SP XML Report Template on page
14-59.
2 In the Report Template Parameters dialog box, click the
down-arrow by the Default style field and then select the style
you need to use.
3 Click the ellipsis button by the Destinations field.
The Report Template Destinations dialog box opens.
The Report Template Destinations dialog box allows you to specify the
shared folders to which to send the reports, and/or the users who
should receive the reports. Reports in a shared folder are there for
anybody who has access to the folder, whereas reports sent to a user
appear in their My Inbox folder.
Figure 14-31 The Shared Folders tab of the Report Template Destinations dialog box
4 To add a shared folder, do the following:
a) Select the Shared Folders tab and then click the Add button.
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-62
Figure 14-32 Shared Folders browser
b) Browse to and select the folder you need to use and then click
OK.
The selected folders appear in the dialog box.
5 To add a user, do the following:
Select the Users tab and then click the Add button.
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-63
Figure 14-33 The users
a) Do one of the following:
If you need to add all of the users, click the Check All
button.
If you need to add a specific user, select the checkbox
beside their name, and repeat for any other users you need
to add.
b) When complete, click OK.
The selected users appear in the dialog box.
6 On the Report Template Configuration page of the wizard, in
the Report title field, type a name for the reports.
7 Do one of the following:
a) If you do not need reports from the template to run according
to a schedule, go to Step 10.
b) Select the Enable Scheduling checkbox and then click the
Default Schedule button.
Note: If you do not Enable Scheduling, your new template cannot be used with
scheduled reports.
Note: If there are no active schedules, you will receive an error message that
indicates that you must define a schedule before you can complete the
scheduling of a template. You can still complete the configuration of the
template, but you cannot configure anything on the Default Schedule dialog
box. Users will have to initiate reports manually, but you can assign a schedule
later.
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-64
Figure 14-34 The Default Schedule dialog box
8 Click the down-arrow by the Schedule field and select a schedule
to use.
The Description textbox contains a overview of the operation of the
schedule you select. You can use this to decide if you have selected
the right schedule.
9 On the wizard page, check the Enable Auto-refresh checkbox
and use the up- or down-arrows to select the number of minutes
that you want the report to refresh in VPWeb.
10 Select the Active checkbox and then click Next.
The final page of the wizard opens.
11 Review the definition and then click Finish.
Creating an Incident Reason Code Report
Template
Use the instructions below to create an Incident Reason Code report
template. The APRS SP report provider gives the support needed for
the Incident Reason Code report category.
Note: The schedules in the list are triggered to run at specific times according to
daily, weekly, or monthly schedules.
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-65
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Reports Administration task module using
the instructions in Opening the Reports Administration Module on
page 14-3.
Read Overview of Report Templates on page 14-21.
Read Filtering Options in Incident Reason Code Report category on
page 14-72.
Procedure
1 Complete the steps for Creating a Report Template on page 14-51,
Choosing Groups and AssetsAPRS SP-XML Report Template on
page 14-54, and Choosing a Time FrameAPRS SP-XML Report
Template on page 14-55.
2 From the Report Template Parameters dialog box on the Data
items row, click the cell in the Value column, and then click the
ellipsis button that appears.
Figure 14-35 The Data Items dialog box
3 Select an incident category from the drop-down list.
4 In the Criteria groupbox, do each of the following:
a) Click the down-arrow to select the Reason Code level.
b) Set the number of reason codes upon which to base the report.
c) To show the complete asset path in reports, select the Display
the complete asset path in the Asset column checkbox.
d) To show all reason code levels in reports, select the Display all
the levels in the Reason Code column checkbox.
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-66
5 If you need filtering, select the Enable filtering by incident
checkbox and then click the Set Filters button.
Figure 14-36 The Filter by Incident dialog box
6 Do each of the following:
a) Select the filtering option from the Filter By drop-down list.
b) Select an operator to use in the filter expression from the
drop-down list immediately below the Filtering By field
c) The expression appears in the Filter expression textbox.
d) If the expression should include more than one condition, click
either the And or Or button, and go back to Step a above to
build another condition.
7 Click OK to close the Filter by Incident dialog box.
8 Click OK to close the Data Items dialog box.
9 Complete the schedule and delivery setup using the procedure
found in Enabling Scheduling on page 14-60.
Note: The available operators are determined by the filtering option you choose. For
more information about how the filtering works, see Filtering Options in Incident
Reason Code Report category on page 14-72.
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-67
Structure of Report Content
When you create a report, you assemble the structure and style for
the report, the data, and the way it will be generated. Each of these
items build the structure of the reporting system.
Report server. This is the server on which the reporting service is
installed. It is also where the system stores the saved reports for
all users.
Report provider. Providers are predefined. You dont need to do
anything to set these up; you will only pick one when creating the
report type.
Provider configuration. The source of the structure of the
reports. The various report providers have different configuration
sourcesyou need to know where they are located.
Report category. This is a report shell that defines the type of
data the report will contain. It determines the XML data that will be
returned from the database.
Style. This is an XSL file that applies a transformation to XML data
to present the report to the user as HTML. A report category can
use any number of different styles, each working on the same set
of data and applying a different transformation.
Report template. Report templates contain information about the
parameters for the report (this may include groups/assets, a time
frame, and data items). You can create a template from an existing
report.
Creating Legacy ReportsWizards For
APRS SP-XML Report Categories
The APRS SP-XML report categories form a part of the initial
installation of the ActivEssentials database. You initiate the wizards
from either Report Template Parameters dialog box during the
creation of new templates, or from the grid when maintaining the
templates.
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-68
The wizards to create or modify report categories are very similar.
Each of the wizards takes you through the process of gathering all of
the information you need for the reports. The list below summarizes
the information collected:
Accumulator, event, and incident report templates. These
report templates contain the collection category, and may include
data items and identifier information.
Summary report templates for Accumulators, Events, and
Incidents. The summary report templates contain the collection
category, and may include data items and identifier information.
You can specify time frame units, and, if necessary, shift and
productive time information.
Birth History report template. The birth history report
templates collect information about the event variables and the
data items you need in the reports. You can specify triggers for
data items, and include identifier collection categories and
associated data items.
Incident by Identifier report templates. The incident by
identifier report contains the incident category and the time unit
used to separate data.
Using the Accumulator or Accumulator
Summary Data Items Wizard
Use the instructions below to create or modify the data items used in
accumulator and accumulator summary report templates. Start the
wizard.
Figure 14-37 The accumulator collection categories on first page of the wizard
In the left pane, select the accumulator categories you need to include
in the reports and then click the button, then click Next.
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-69
Figure 14-38 The data items for selected collection categories
1 In the left pane, select the data items you need to include in the
reports and then click the button.
2 Do one of the following:
a) If you are using the Accumulator wizard, click Finish.
b) If you are using the Accumulator Summary wizard, select the
time interval to use in the reports, then click Next.
3 If you need shift information in the report, select the Include shift
in report checkbox and then, if required, select the Include
Productive time checkbox to add productive time information in
the report.
4 Click Next.
5 In the left pane, select up to two identifier collection categories and
then click the button, then click Next.
6 In the left pane, select up to two identifier data items and then
click the button.
7 Click Finish.
Using the Event or Event Summary data
items wizard
Use the instructions below to create or modify the data items used in
an Event or Event Summary report template.
1 Start the wizard.
2 In the left pane, select at least one event variable, and then click
the button, then click Next.
Figure 14-39 Selecting the event variables to include in the reports
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-70
3 In the left pane, select at least one event variable, click the
button.
Figure 14-40 Selecting the event variable items to include in the reports
4 Select the time interval for the reports and then click Next.
5 If you need shift information, select the Include shift in report
checkbox. If required, select the Include Productive time
checkbox, and then click Next.
6 In the left pane, select up to two identifier collection categories and
then click the button, then click Next.
7 In the left pane, select up to two identifier data items and then
click the button.
8 Click Finish.
Using the Incident or Incident By Identifier
Data Items Wizard
Use the instructions below to create or modify the data items used in
an incident or incident by identifier report template.
1 Start the wizard.
2 Select the incident category to include in the report and then click
Finish.
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-71
Using the Incident Summary Data Items
Wizard
Use the instructions below to create or modify the data items used in
an incident summary report template.
1 Start the wizard.
In the left pane, select at least one incident category, and then click
the button, then click Next.
Figure 14-41 Selecting the event variables to include in the reports
2 If you need shift information in the report, select the Include shift
in report checkbox. If required, select the Include Productive
time checkbox to add productive time information in the report.
3 Click Next.
4 Select up to two identifier collection categories to include in the
report and then click the button, then click Next.
5 Select up to two identifier data items to include in the report and
then click the button.
6 Click Finish.
Using the Birth History Data Items Wizard
Use the instructions below to Use the instructions below to create or
modify the data items used in birth history report templates.
1 Start the wizard.
In the left pane, select at least one event variable, click the
button, then click Next.
Figure 14-42 Selecting the event variables to include in the reports
2 Select an event variable data item from the drop-down list.
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-72
3 If you want to compare the value with another one, select a
comparison method from the drop-down list.
A new field opens in the lower portion of the wizard page, where
you can type a comparison value.
4 In the Compare to field, type a value.
5 Click Next.
6 Select the identifier collection categories to include in the report
and then click the button, then click Next.
7 Select the identifier data items to include in the report and then
click the button.
8 Click Finish.
Filtering Options in Incident Reason Code
Report category
You can set filtering options for Incident Reason Code Report
categories. If you enable filtering for these templates, you must set
your filters in the Filtering by Incidents dialog box. You can add
incident descriptions, duration, incident names, etc. to provide a
detailed incident report.
In the Filter by Incident dialog box, you initially select one of the
Filtered By options and then create your filter expression for the data
under these headings. Expressions use logical operators to separate
available data from the data you actually need.
Figure 14-43 The Filter by Incident dialog box
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-73
The Filtered By options include data that is alphanumeric and
numeric, so the operators used to filter this data have different logical
roles. After you build one expression, you can use other operators as
conjunctions between two or more expressions to build more complex
searches. The following table displays the operators you can use:
Table 14-4 Operators available in the Filter by Incident dialog box
Operator Works with Notes
AND Works as a conjunction between all
kinds of filtering options.
Allows you to search for
instances where both values
are represented.
OR Works as a conjunction between all
kinds of filtering options.
Allows you to search for
instances where one or the
other value is represented.
LIKE Only available for alphanumeric
searches when filtering by:
Comments
Description
Reason Code
Used for entering strings as the
filtering agent. The results do
not have to exactly equal the
query, but must contain the
submitted string.
=
Alphanumeric. Lets you find
strings that are exactly alike to
the string in the expression.
Numeric. Lets you find numeric
values that are exactly the same
as that provided in the
expression.
Data must equal the value
following the = symbol.
<>
Alphanumeric. Lets you find all
strings that are not the same as
that provided in the expression.
Numeric. Lets you find all
numeric values that are not the
same as the value provided in
the expression.
Data is displayed only if it is not
equal to the value following the
<> operator.
< Less than. Used only for finding
numeric values
Data appears in reports only if
the value is less than the value
following the < operator.
> Greater than. Used only for finding
numeric values
Data appears in reports only if
the value is greater than the
value following the > operator.
<= Less than or equal to. Used only for
finding numeric values.
Data appears in reports only if
the value is less than or equal
to the value following the <=
operator.
>= Greater than or equal to. Used only
for finding numeric values.
Data appears in reports only if
the value is greater than or
equal to the value following the
>= operator.
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-74
LIKE Used only with alphanumeric
strings
Finds alphanumeric strings that
are the same as, or contain the
string provided in the filter
expression.
NOT LIKE Used only with alphanumeric
strings
Finds alphanumeric strings that
do not contain the string
provided in the filter
expression.
( ) Used with LIKE and NOT LIKE. Parentheses are used to contain
the string data in expressions.
Table 14-4 Operators available in the Filter by Incident dialog box
Operator Works with Notes
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-75
Configuring Delivery Options
When you set up delivery options for reports, you specify when the
reports should run, and where they should gowhether to a folder, or
to a distribution list for external distribution.
This section covers the following topics:
Creating a Scheduled Report on page 14-75
Creating a New Scheduled Report From an Existing Report on page
14-79
Creating a Report Distribution on page 14-80
Duplicating an Existing Report Distribution on page 14-86
Creating a Scheduled Report
Use the instructions below to create a scheduled report. This is a
report that is automatically generated and sent to users Inboxes and/
or to shared folders. For more information on scheduled reports, see
Scheduled reports on page 14-25.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Reports Administration task module using
the instructions in Opening the Reports Administration Module on
page 14-3.
Set up your users in the Security Administration module of
MI Admin. See Assigning a User to a Role on page 10-18 or
Assigning a Role to a User on page 10-20 for more information.
Create a new shared folder (see Creating a New Shared Folder on
page 14-34).
Choosing Groups and AssetsAPRS SP-XML Report Template on
page 14-54
Procedure
1 In the secondary frame, click the Delivery button.
2 In the Delivery frame, click the Scheduled Reports icon.
Any scheduled reports that have already been defined are
displayed in the grid.
3 In the Report Categories frame, select the category that should
contain the new scheduled report.
Note: This procedure assumes that you have already set up a report style and a
template. If you have not, then create a report template before creating a
schedule for the template.
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-76
4 Click the New button on the toolbar.
The Add New Scheduled Report wizard starts.
5 Click Next to move past the welcome page.
Figure 14-44 The Name and Description page of the wizard
6 Do the following:
a) Click in the Name field and type a name for the report (up to
50 characters).
b) Click in the Description textbox and type a description of the
report (optional, up to 255 characters).
7 Click Next.
Figure 14-45 The Report Template and Schedule page of the wizard
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-77
8 Click the ellipsis button by the Report Template field and select a
report template.
9 Back in the wizard, click the ellipsis button beside the Schedule
field.
Figure 14-46 The Select a Schedule dialog box
10 Do one of the following:
a) To use an existing schedule, do the following in order:
Click the down-arrow by the Schedule category field and
choose a schedule based on calendar definitions or shifts.
The default options in the fields below change to reflect this
first selection.
Click the down-arrow by the Schedule type field and
choose a structure.
The default option in the fields below change to reflect your
choice.
Click the down-arrow by the Schedule name field and
select an existing schedule.
The Description box displays an overview of the structure of
the schedule you have chosen, so you can check to see if it
fits your needs.
b) To create a new schedule, click the New Schedule button.
Work through the wizard as described in Creating a Schedule
on page 12-13.
11 Click OK when done, then click Next.
Note: If the icon beside the template name has a question mark superimposed,
the template is not configured for use with schedules. (See Editing the General
Report Template Properties on page 14-109 for more information.) You must
enable scheduling before you can proceed.
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-78
Figure 14-47 The Delivery Instructions page of the wizard
12 Click the Edit Delivery Instructions button.
Figure 14-48 The Delivery Instructions dialog box
13 On the Users/Roles tab, click the Add button, select the
checkboxes next to the users and roles, and then click OK. Click
the Folders tab.
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-79
Figure 14-49 The Folders tab with delivery disabled
14 To enable delivery to a folder, select the Enable delivery to
checkbox.
The tree view expands to display the top level folders.
15 Navigate to and select the folder and then click OK.
16 On the wizard page, select the Available for subscription
checkbox if you want users to be able to subscribe to the reports.
17 Select the Active checkbox if you want the report to be
immediately available.
18 Click Next.
The final page of the wizard opens.
19 Review the definition and then click Finish.
Creating a New Scheduled Report From an
Existing Report
Use the instructions below to create a duplicate copy of an existing
scheduled report. Use this method if the scheduled report you need is
similar to the original report.
Note: A role only acts as a shortcut to finding the users who are current members of
the role. If the membership of the role changes (additions and removals), no
changes occur in the list of users who should have access to the scheduled
report.
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-80
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Reports Administration task module using
the instructions in Opening the Reports Administration Module on
page 14-3.
Procedure
1 In the secondary frame, click the Delivery category button.
2 In the Delivery frame, click the Scheduled Reports icon.
Any scheduled reports that have already been defined are
displayed in the grid.
3 In the Report Categories frame, select the category that contains
the scheduled report.
4 Select the scheduled report in the grid, then click the Copy button
on the toolbar.
5 Click the Paste button on the toolbar.
A new row appears in the grid to represent the duplicate scheduled
report.
Creating a Report Distribution
Use the instructions below to create a new report distribution. These
instructions assume that you have already created the report and a
schedule for the report.
Note: You can only create duplicate copies within the same report category.
Note: The new report is the same as the original, but its name includes Copy of and
will appear in the grid in the Cs. If you use the paste command from a different
page, you might not recognize that the operation was successful.
Note: To provide the option to e-mail reports to users, you have to enable this
function in the Delivery Service configuration. For more information, see the
Enabling e-mail functions for reporting in the System Configuration Guide
(System Configuration Guide.pdf), located within the ActivEssentials
installation package.
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-81
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Reports Administration task module using
the instructions in Opening the Reports Administration Module on
page 14-3.
You must set up your users in the Security Administration task
module. For more information, see Creating Roles and Users on
page 10-14.
Create shared folders. See Shared Folders on page 14-16 and
Creating a New Shared Folder on page 14-34.
Create a report template. See the following:
Overview of Report Templates on page 14-21
Choosing Groups and AssetsAPRS SP-XML Report Template
on page 14-54
Create a schedule. See Creating a Scheduled Report on page
14-75.
Procedure
1 In the secondary frame, click the Delivery category button.
2 In the Delivery frame, click the Report Distributions icon.
3 In the Report Categories frame, select the category that should
contain the new report distribution.
Any previously defined distributions appear in the grid.
4 Click the New on the toolbar.
The Add New Distribution wizard starts.
5 Click Next to move past the welcome page.
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-82
Figure 14-50 The Name and Description page of the wizard
6 Do the following:
a) In the Name field, type a name for the new report distribution
(up to 50 characters).
b) In the Description field, type a short description (up to 255
characters) of the purpose of the report distribution (optional).
7 Click Next.
Figure 14-51 The Scheduled Report and Delivery Instructions page
8 Click the down-arrow by the Scheduled report name field and
select a report from the list.
If you need to create a new report, see Creating a Scheduled
Report on page 14-75.
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-83
9 Click the Delivery Instructions button.
Figure 14-52 The Distribution Types page
10 On the empty row in the grid, click the cell in the Distribution
Type column.
A drop-down arrow appears.
11 Select the E-mail type from the list.
12 Click the cell in the Properties column, then click the ellipsis
button.
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-84
Figure 14-53 The e-mail settings dialog box
13 For ActivEssentials users, click the Activplant Users button, and
select the users who should receive the reports.
A dialog box opens with a listing of all ActivEssentials users with an
e-mail address associated with their profile.
14 When finished, click OK.
The users appear in the Recipient List.
15 Click the down-arrow by the Report style field and select a style
from the list.
16 When finished setting up the e-mail recipients, click OK.
17 On the empty row in the grid, click the cell in the Distribution
Type column, and select the File Delivery type from the
drop-down list.
A drop-down arrow appears.
18 Click the cell in the Properties column, and then click the ellipsis
button.
A dialog box opens where you can configure the settings for
delivering the report as a file.
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-85
Figure 14-54 The file delivery settings dialog box
19 Click the Browse button and navigate to and select the folder
where you need to save the reports.
20 In the File name groupbox, do one of the following:
a) To use a specific file name when the report server saves the
report in the folder, select the Define a file name option, or
b) If you want ActivEssentials to name the file for you, select the
Use the file name generated by option.
The file names are always different with this method, but if
viewed through the VPWeb Report Viewer, you always see the
most recent report.
21 Select the checkbox to Overwrite if you want to overwrite the
report. If you want to keep older reports, clear the checkbox.
22 When finished, click OK.
23 On the Delivery Instructions dialog box, click the Retries tab.
Note: This should be a shared folder on your network that is available to all those
who need to view the report. For security reasons, you might want to set
access permissions to this network share.
Note: The previous report is renamed using the following scheme. If the specified
name is Report, and the format is HTML, the older report becomes
Report.X.htm, where X is a number that increments with each newly
renamed file. The file with highest number is the most recently renamed file.
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-86
Figure 14-55 The Retries page
24 If required, select the In case of failure checkbox, and do the
following:
a) Click the up- or down-arrows by the Maximum retries field,
and set the number of attempts.
b) Click the up- or down-arrows by the Wait between retries
field, and set an interval in minutes between each attempt.
25 When finished, click OK to close the Delivery Instructions dialog
box.
26 On the wizard page select the Active checkbox, and click Next.
The final page of the wizard opens.
27 Review the definition and click Finish.
Duplicating an Existing Report
Distribution
Use the instructions below to create a new report distribution by using
an existing distribution as a template. Use this method if the required
report distribution is similar to one that exists.
Note: The Retries page lets you determine a strategy for handling times when report
delivery fails. You can set the number of attempts at delivery and the interval
between each.
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-87
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Reports Administration task module using
the instructions in Opening the Reports Administration Module on
page 14-3.
Procedure
1 In the secondary frame, click the Delivery category button.
2 In the Delivery frame, click the Report Distributions icon.
3 In the Report Categories frame, select the category with the
report distribution you need to duplicate.
Any previously defined distributions appear in the grid.
4 Select the report distribution in the grid, then click the Copy
button on the toolbar.
5 Click the Paste button on the toolbar.
A new row appears in the grid to represent the duplicate report
distribution.
Note: The new report distribution is the same as the original, but its name includes
Copy of and will appear in the grid in the Cs. If you use the paste command
from a different page, you might not recognize that the operation was
successful.
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-88
Maintaining Folders and Content
In Report Viewer, users see the system folders My Inbox, My
Subscriptions, and My Recent Reports, and a single personal folder
called My Reports. Any shared folders that you provide access to can
also be seen in the Main View. Users with appropriate privileges can
also create their own personal folders, and they may be able to store
reports within the Main View itself.
You cannot remove or modify the system folders. You can only adjust
limits for them, either globally, or by user or role. The limits you set
apply to the maximum number of reports that a user can save in each
folder, and the amount of storage space available.
Users are responsible for the contents of their personal folders.
However, as an administrator you can set global and local storage
limits, set report limits, and delete the contents of folders that are too
large.
This section covers the following topics:
Viewing and Editing System Folder Properties on page 14-88
Deleting a Users System Folder Contents on page 14-89
Editing the Properties of Shared Folders on page 14-90
Deleting a Shared Folder on page 14-90
Removing Users From a Shared Folder on page 14-91
Deleting Reports From a Shared Folder on page 14-93
Viewing Properties of Personal Folders on page 14-94
Deleting Reports From Personal Folders on page 14-95
Viewing and Editing System Folder
Properties
Use the instructions below to view and edit system folder properties.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Reports Administration task module using
the instructions in Opening the Reports Administration Module on
page 14-3.
Procedure
1 In the secondary frame, click the Folders category button.
2 Click the System Folders icon in the secondary frame.
3 In the Navigation frame, select the Object Library, if not already
selected.
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-89
4 Select the folder whose details you need to view or edit, right-click
and choose Properties.
The Properties dialog box opens.
5 View and edit the properties as desired, then click OK to close the
dialog box.
Deleting a Users System Folder Contents
Use the instructions below to delete the contents of a system folder.
You can delete the contents of an Inbox, Subscriptions, and Recent
Reports folders.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Reports Administration task module using
the instructions in Opening the Reports Administration Module on
page 14-3.
Procedure
1 In the secondary frame, click the Folders category button.
2 Click the System Folders icon in the secondary frame.
3 In the Navigation frame, select the Inbox, Recent Reports, or
Subscriptions folder.
A list of users appears in the grid.
Figure 14-56 Users in the System folders grid
4 Select the user(s) whose reports you want to delete.
5 When you have selected the user(s), right-click and choose Delete
Reports in Folder.
Note: You can also access the properties dialog by right-clicking on the folder entry
under the Object Library.
Note: You can select a block of users by holding down the Shift key, then clicking the
first and the last in the block. To select non-contiguous users, hold down the
Ctrl key.
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-90
Editing the Properties of Shared Folders
Use the instructions below to edit the properties of a shared folder.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Reports Administration task module using
the instructions in Opening the Reports Administration Module on
page 14-3.
Created a shared folder using the instructions in Creating a New
Shared Folder on page 14-34.
Procedure
1 In the secondary frame, click the Folders category button.
2 In the Folders frame, click the Shared Folders icon.
The Object Library is selected in the Navigation frame and the grid
displays all of the top level shared folders.
3 Navigate to and select the folder you need to view, and then click
the Properties button on the toolbar.
The properties dialog box for shared folder opens.
4 View or edit the properties as required.
5 When done, click OK.
Deleting a Shared Folder
Use the instructions below to delete a shared folder.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Reports Administration task module using
the instructions in Opening the Reports Administration Module on
page 14-3.
Created a shared folder using the instructions in Creating a New
Shared Folder on page 14-34.
Procedure
1 In the secondary frame, click the Folders category button.
2 In the Folders frame, click the Shared Folders icon.
The Object Library is selected in the Navigation frame and the grid
displays all of the top level shared folders.
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-91
3 Navigate to and select the folder you need to delete, and then click
the Delete button on the toolbar.
4 Right-click the shared folder either in the Navigation frame or in
the grid, and choose Delete.
A confirmation message asks whether you want to delete the folder
and all its contents.
5 Click Yes to delete the folder and its contents.
The folder and any subfolders within it are deleted.
Removing Users From a Shared Folder
Use the instructions below to remove a user or a role from a shared
folder, to prevent access to reports in the folder.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Reports Administration task module using
the instructions in Opening the Reports Administration Module on
page 14-3.
Created a shared folder using the instructions in Creating a New
Shared Folder on page 14-34.
Procedure
1 In the secondary frame, click the Folders category button.
2 In the Folders frame, click the Shared Folders icon.
3 In the Navigation frame, select the Object Library.
Entries for the currently defined shared folders appear in the grid.
4 Right-click the shared folder in the grid and choose Properties.
Note: You cannot remove a system role such as Report Administrator or System
Administrator. If you try to do this, you will get an error message.
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-92
Figure 14-57 The properties dialog for shared folders
5 On the properties dialog box, click the Security tab.
Figure 14-58 The Security tab of the properties dialog box
6 In the dialog box, select the role or user you need to remove and
click the Remove button. Repeat as needed.
You can only select one at a time.
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-93
7 When finished, click OK.
Deleting Reports From a Shared Folder
Use the instructions below to delete reports from a shared folder. You
cannot remove reports selectively; you must remove all reports.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Reports Administration task module using
the instructions in Opening the Reports Administration Module on
page 14-3.
Created a shared folder using the instructions in Creating a New
Shared Folder on page 14-34.
Procedure
1 In the secondary frame, click the Folders category button.
2 In the Folders frame, click the Shared Folders icon.
3 In the Navigation frame, select the Object Library.
Entries for the currently defined shared folders appear in the grid.
4 Select the shared folder in the grid whose reports you need to
remove, right-click and choose Delete Reports in Folder.
Figure 14-59 The confirmation dialog box
5 Do one of the following:
a) If you want to delete reports in subfolders as well, select the
Yes. Delete the reports option.
Note: A role, in this context, acts only as a shortcut to finding the users who are
members of the role. Removing a role does not prevent you from adding
individual users.
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-94
b) If want to keep any reports in subfolders, select the Yes, but
do not delete option.
6 Click OK.
Viewing Properties of Personal Folders
Use the instructions below to view the properties of personal folders.
As an administrator you cannot create personal folders in Reports
Administration. You can only view the properties and delete the
contents.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Reports Administration task module using
the instructions in Opening the Reports Administration Module on
page 14-3.
Procedure
1 In the secondary frame, click the Folders category button.
2 In the Folders frame, click the Personal Folders icon.
The Object Library is selected in the Navigation frame, and the
ActivEssentials users appear below it.
3 Select the user whose personal folders you wish to view.
The users name appears in the grid area, and the personal folders
are shown below it.
4 Navigate to and select the personal folder that you need to inspect.
5 Click the Properties button on the toolbar.
A folder properties area appears beside the personal folders list.
The information in this grid is read-only. It changes when you
select different users and/or folders.
Figure 14-60 The personal folder properties area
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-95
Deleting Reports From Personal Folders
Use the instructions below to delete all the reports in a users personal
folders. You would only do this in rare situations, for example if a user
leaves the company.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Reports Administration task module using
the instructions in Opening the Reports Administration Module on
page 14-3.
Procedure
1 In the secondary frame, click the Folders category button.
2 In the Folders frame, click the Personal Folders icon.
The Object Library is selected in the Navigation frame, and the
ActivEssentials users appear below it.
3 Select the user in the Navigation frame.
The grid displays the users name and the personal folders.
Right-click the personal folder and choose Delete Reports in
Folder.
Figure 14-61 The confirmation dialog box
4 Choose the delete option you need, and click OK.
Note: While you can delete the reports in a personal folder, you cannot see what
reports a user has requested, nor can you remove any personal folders.
However, if you remove a user account, you also remove any personal folders.
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-96
Maintaining Report Content
From time to time you might need to edit aspects of how the
Activplant reporting system collects the data presented in reports. You
do this a variety of dialog boxes that you can access from the grid in
the various task sub-modules in the Content task category.
This section covers the following topics:
Viewing and Editing Properties of Report Servers on page 14-96
Deleting a Report Server on page 14-97
Editing the Group/Asset List Parameter on page 14-98
Editing the Time Frame Definitions Parameter on page 14-100
Viewing and Editing Data Items on page 14-105
Editing Report Parameters for APRS SP, APRS Query Server, and
SQL Reporting Services on page 14-107
Changing a Report Template Style on page 14-107
Editing Report Template Destinations on page 14-108
Editing the General Report Template Properties on page 14-109
Creating New Templates From Existing Report Templates on page
14-112
Deleting a Report Template on page 14-113
Deleting all Templates in a Report Category on page 14-114
Viewing and Editing Properties of a Report Category on page
14-115
Deleting a Report Category on page 14-119
Viewing and Editing Properties of Report Styles on page 14-120
Deleting a Report Style on page 14-121
Viewing a Report Template Definition on page 14-122
Maintaining Data Item Configuration for APRS SP, APRS Query
Server, and SQL Reporting Service Report Categories on page
14-122
Maintaining Report Template Properties on page 14-123
Viewing and Editing Properties of Report
Servers
Use the instructions below to view and edit the properties of a report
server.
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-97
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Reports Administration task module using
the instructions in Opening the Reports Administration Module on
page 14-3.
Procedure
1 In the secondary frame, click the Content category button.
2 In the Content frame, click the Servers icon.
The grid displays the report servers that have been defined.
3 Right-click the report server in the grid and choose Properties.
Figure 14-62 The properties dialog box for a report server
4 View or edit the properties as desired, then click OK to close the
dialog box.
Deleting a Report Server
Use the instructions below to delete a report server.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Reports Administration task module using
the instructions in Opening the Reports Administration Module on
page 14-3.
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-98
Procedure
1 In the secondary frame, click the Content category button.
2 In the Content frame, click the Servers icon.
The grid displays the report servers that have been defined.
3 Right-click the report server in the grid and choose Delete.
A confirmation dialog box opens.
4 Click OK.
Editing the Group/Asset List Parameter
Use the instructions below to view and edit templates that include the
Group/Asset list parameter for APRS SP-XML reports.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Reports Administration task module using
the instructions in Opening the Reports Administration Module on
page 14-3.
Read Maintaining Report Template Properties on page 14-123.
Procedure
1 In the secondary frame, click the Content category button.
2 In the Content frame, click the Templates icon.
3 In the Report Categories frame, select the APRS SP-XML report
category with the template you need to view.
The grid displays the templates that have been defined for the
category.
4 On the row in the grid for the template, click in the Parameters
column and then click the ellipsis button.
Note: The instructions that follow assume that you need to edit all aspects of the
configuration. Please skip those that do not apply.
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-99
Figure 14-63 The Report Template Parameters dialog box
5 On the Group/Asset list row, click in the Value column, and then
click the ellipsis button that appears.
Figure 14-64 The Group or Asset Selection dialog box
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-100
6 Do Step a or Step b below:
a) If you want users to choose the groups or assets to include,
select the User-defined Group/Asset option, and then do
one of the following:
Select the Use group/asset selection in VPWeb option if
the selection in the Asset window in VPWeb should indicate
what to include, or
Select the Dont use option if you want users to choose the
groups/assets in the Report Viewer.
b) If you want to define the group/asset selection now, select the
Template-defined option, and do the following:
For each group or asset you want to include, select the item
in the Available Group/Asset pane, and click the
button.
Rows appear for each in the Selected Groups/Assets pane
If you have selected any groups and need all the
descendent items (groups and assets) to appear in any
reports, select the checkboxes in the Descendent column.
If you need to remove groups or assets from the list, select
them in the right pane and click the button.
7 Click OK.
Editing the Time Frame Definitions
Parameter
Use the instructions below to view and edit templates that include the
Time frame definitions parameter for APRS SP-XML reports.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Reports Administration task module using
the instructions in Opening the Reports Administration Module on
page 14-3.
Read Maintaining Report Template Properties on page 14-123.
Procedure
1 In the secondary frame, click the Content category button.
2 In the Content frame, click the Templates icon.
Note: These instructions assume that you need to edit all aspects of the
configuration. Please skip those that do not apply.
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-101
3 In the Report Categories frame, select the APRS SP-XML report
category with the template you need to view.
The grid displays the templates that have been defined for the
category.
4 On the row in the grid for the template, click in the Parameters
column and then click the ellipsis button the appears.
Figure 14-65 The Report Template Parameters dialog box
5 On the Time frame definitions row, click in the Value column,
and then click the ellipsis button that appears.
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-102
Figure 14-66 The Time Frame Definition dialog box
6 If your time definition must include the span of an identifier, click
the ellipsis button by the Use the following group/asset field.
The AppCenter Plant Hierarchy Browser opens.
7 Browse to and select the group/asset to which the template should
refer, and click OK.
8 Do one of the following:
a) If users should be allowed to select the time frame, select the
Fixed Time Frame option, and go to Step 13.
b) If you need the template to define the span of time, go to Step
9.
9 Do one of the following:
Note: If you are modifying a template for either Birth History or Incident by Identifier
reports, you must use either a Unique Identifier time frame definition, or
choose to Filter by Identifier.
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-103
a) If you need to show multiple time frames that coincide with the
span of a recurring identifier, select the Relative Time Frame
option, and go to Step 10.
b) If you need to show the time frame for an identifier that occurs
just once, select Unique Identifier option, and go to Step 11.
10 Click the ellipsis button to the right.
You can refine your report by selecting a time that for you report
that will capture the span of incidents, when a particular identifier
or shift is current, or absolute or calendar time.
11 Navigate to and select the time identifier, and click OK. Then click
the ellipsis button and browse to select the identifier to use.
The relative time frame method also lets you set the number of
instances of the identifier upon which to report.
Figure 14-67 Examples of identifiers and the number of instances
12 If you need to include details of a current instance of the identifier,
select the Include Current checkbox.
13 Do one of the following;
a) If there is no need to adjust the time frame by a secondary
identifier, go to Step 17.
b) To refine the report to match a secondary identifier, select the
Adjust the time frame by checkbox and click the Edit button.
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-104
Figure 14-68 The Time Frame Adjustment dialog box
14 Click the ellipsis button by the Select an identifier field.
The Appcenter Identifier Browser opens.
15 Browse to and select the identifier to use, and then click OK.
The identifier name appears in the Select an identifier field, and
the groupboxes in the lower portion of the dialog box become
enabled.
16 Do the following, as needed:
a) If you need to adjust the start time, select the Correct Start
Time To checkbox and choose either to use the start time that
immediately before or after the primary identifier start time.
b) If you need to adjust the end time, select the Correct End
Time To checkbox and choose either to use the start time
immediately before or after the primary identifier end time.
17 Do one of the following:
a) If you do not need to modify the time frames captured in the
report by a secondary identifier, go to Step 18.
b) To capture in your report just the time frames that occur for a
secondary identifier, during the time frame of the primary
identifier, select the Filter by Identifier checkbox, and then
click the Edit button.
Note: You can choose to modify the start and end times of the report time frame by
aligning these times to either the start or end times of the identifier, if current.
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-105
Figure 14-69 The Filter by an Identifier dialog box
18 In the Filter Expression groupbox, click the ellipsis button by the
Identifier field, then browse to and select the identifier you need
to use and click OK.
The identifier name appears in the Identifier field.
19 Click the down-arrow immediately below the Identifier field, and
select a comparison method.
20 In the field below the Identifier, select a comparison method and
search string as follows:
a) In the field to the right, type your search string.
b) Click the down-arrow by the Limit to field, select the
appropriate option, and then specify the number of
occurrences.
21 Select the Include Current checkbox, to the identifier if it is
current when you run the report.
22 Click OK on both the Filter by an Identifier and Time Frame
Definition dialog boxes.
The Report Parameter Template dialog box displays.
Viewing and Editing Data Items
Use the instructions below to view and edit data items.
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-106
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Reports Administration task module using
the instructions in Opening the Reports Administration Module on
page 14-3.
Read Maintaining Report Template Properties on page 14-123.
Procedure
1 In the secondary frame, click the Content category button.
2 In the Content frame, click the Templates icon.
3 In the Report Categories frame, select the report category that
contains the template you need to view.
The grid displays the templates that have been defined for the
category.
4 On the Data items row, click in the Value column, and then click
the ellipsis button.
A report wizard starts.
5 On the initial page of all wizards, select the collection categories to
include in the report, and then click Next.
6 On the next pages, make either single or multiple selections, as
needed, and then click Next.
7 On the last page of the wizard, click Finish.
8 On the Report Template Parameters dialog box, click OK.
To configure the data items for the report templates you need to run
one or other of several wizards. See Creating Legacy ReportsWizards
For APRS SP-XML Report Categories on page 14-67.
Note: The instructions that follow assume that you need to edit all aspects of the
configuration. Please skip those that do not apply.
Note: The wizard steps vary depending on the report category you chose; the
information and the process varies slightly with each. If you need more
information, see Creating Legacy ReportsWizards For APRS SP-XML
Report Categories on page 14-67.
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-107
Editing Report Parameters for APRS SP,
APRS Query Server, and SQL Reporting
Services
Use the instructions below to view and edit the report parameters for
APRS SP, APRS Query Server, and SQL Reporting Service report
categories.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Reports Administration task module using
the instructions in Opening the Reports Administration Module on
page 14-3.
Read Maintaining Report Template Properties on page 14-123.
Procedure
1 In the secondary frame, click the Content category button.
2 In the Content frame, click the Templates icon.
3 In the Report Categories frame, select the report category that
contains the template you need to view.
The grid displays the templates that have been defined for the
category.
4 On the row in the grid for the template, click in the Parameters
column and then click the ellipsis button.
5 Change the values you need in the cells in the Value column.
6 When you have finished editing the parameters, click OK.
Changing a Report Template Style
Use the instructions below to change a report template style. The style
is the general appearance of a report once produced.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Reports Administration task module using
the instructions in Opening the Reports Administration Module on
page 14-3.
Read Maintaining Report Template Properties on page 14-123.
Note: The instructions that follow assume that you need to edit all aspects of the
configuration. Please skip those that do not apply.
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-108
Procedure
1 In the secondary frame, click the Content category button.
2 In the Content frame, click the Templates icon.
3 In the Report Categories frame, select the report category with
the template you want to change.
The grid displays the templates that have been defined for the
category.
4 Click in the Default Style column in the grid and then click the
drop-down arrow that appears.
5 Select another style from the list.
Editing Report Template Destinations
Use the instructions below to edit the folders and who receives reports
created from a template.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Reports Administration task module using
the instructions in Opening the Reports Administration Module on
page 14-3.
Read Maintaining Report Template Properties on page 14-123.
Procedure
1 In the secondary frame, click the Content category button.
2 In the Content frame, click the Templates icon.
3 In the Report Categories frame, select the report category that
contains the template you want to change.
The grid displays the templates that have been defined for the
category.
4 Click in the Destinations column and then click the ellipsis button.
The Report Template Destinations dialog box opens.
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-109
Figure 14-70 The Shared Folders tab of the Report Template Destinations dialog box
5 To add or remove a shared folder, select the Shared Folders tab
and do the following:
a) To add a folder, click the Add button, then browse to and select
the folder you want to add and click OK.
b) To remove a folder, select it in the dialog box and click the
Remove button.
The new selection of folders appear in the dialog box.
6 To add or remove users, select the Users tab and do the following:
a) To add a user, click the Add button, then select the checkbox
beside their name and click OK.
b) To remove a user, select the user in the dialog box and click the
Remove button.
The new selection of users appear in the dialog box.
7 When finished, click OK.
Editing the General Report Template
Properties
Use the instructions below to edit general report template properties,
including the template name and description, the status of the
template, and the schedule to which the template is assigned.
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-110
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Reports Administration task module using
the instructions in Opening the Reports Administration Module on
page 14-3.
Read Maintaining Report Template Properties on page 14-123.
For templates that appear in Shared folders, you must be either a
System Administrator or a Report Administrator to perform this
task. Members of other user roles can view the information, but
cannot make changes.
Procedure
1 In the secondary frame, click the Content category button.
2 In the Content frame, click the Templates icon.
3 In the Report Categories frame, select the report category that
contains the template you need to edit.
The grid displays the templates that have been defined for the
category.
4 Select the template in the grid, right-click and select Properties.
The properties dialog box for the template opens.
Note: These instructions assume that you need to edit all of the properties, so please
skip any steps that do not apply.
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-111
Figure 14-71 The properties dialog box for a template
5 Do the following, as needed:
a) To change the template name, click in the Name field and edit
the text.
b) To change the template description, click in the Description
field and edit the text.
c) To change the default style for the template, select another
style from the drop-down list.
d) To change the report destination, click the ellipsis button and
select a shared folder from the window that opens.
6 Clear or select the Enable Scheduling checkbox to disable or
enable the template for scheduling reports.
7 Select the Enable Auto-refresh checkbox to allow auto-refresh
for the report, and type the number in minutes that you want it to
refresh.
8 If you need to change the schedule to which the template is
assigned, click the Default Schedule button.
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-112
Figure 14-72 The Default Schedule dialog box
9 Click the down-arrow by the Schedule field and select another
schedule to use.
The Description textbox contains a overview of the operation of the
schedule you select. You can use this to decide if you have selected
the right schedule.
10 Click OK.
Creating New Templates From Existing
Report Templates
Use the instructions below to create a new report template from an
existing template. This method is useful if the properties of the new
template are similar to an existing template.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Reports Administration task module using
the instructions in Opening the Reports Administration Module on
page 14-3.
Procedure
1 In the secondary frame, click the Content category button.
2 In the Content frame, click the Templates icon.
3 In the Report Categories frame, select the report category that
contains the template you need to copy.
The grid displays the templates that have been defined for the
category.
4 Right-click the report template in the grid and select Copy.
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-113
5 Right-click anywhere in the grid and select Paste.
A new row for the template appears in the grid.
Deleting a Report Template
Use the instructions below to delete a report template. If you delete a
report template, any scheduled reports associated with that template
will not run; however, any reports generated reports remain available
to users.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Reports Administration task module using
the instructions in Opening the Reports Administration Module on
page 14-3.
Created a report template using the instructions in Creating a
Report Template on page 14-51.
Procedure
1 In the secondary frame, click the Content category button.
2 In the Content frame, click the Templates icon.
3 In the Report Categories frame, select the report category that
contains the template you need to delete.
The grid displays the templates that have been defined for the
category.
4 Right-click the report template in the grid and select Delete. A
confirmation dialog box opens.
Figure 14-73 The Confirmation dialog box
5 Click Yes.
Note: The new template is the same as the original, but its name includes Copy of
and will appear in the grid in the Cs. If you use the paste command from a
different page, you might not recognize that the operation was successful.
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-114
Deleting all Templates in a Report
Category
Use the instructions below to delete all report templates in a report
category. Any scheduled report templates associated with that
template will not run; however, any generated reports will remain
available to users.
You should remove all templates if the configuration for the report
provider changes, such as the addition of new parameters. When
created, templates take their configuration from the structure of the
report provider. If the provider structure changes, the template
structure might not match the data that the provider can present, so
these reports might fail.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Reports Administration task module using
the instructions in Opening the Reports Administration Module on
page 14-3.
Created a report template using the instructions in Creating a
Report Template on page 14-51.
Procedure
1 In the secondary frame, click the Content category button.
2 In the Content frame, click the Templates icon.
3 In the Report Categories frame, select the report category that
contains the templates you need to delete.
The grid displays the templates that have been defined for the
category.
4 On the toolbar, click the Delete All Templates button. A
confirmation dialog box opens.
Figure 14-74 The Confirmation dialog box
Note: Rather than deleting all templates, you can open their parameter configurations
and reconfigure them using the updated report provider configuration.
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-115
5 Click Yes.
Viewing and Editing Properties of a Report
Category
Use the instructions below to view and edit the properties of a report
category.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Reports Administration task module using
the instructions in Opening the Reports Administration Module on
page 14-3.
Procedure
1 In the secondary frame, click the Content category button.
2 In the Content frame, click the Categories icon.
The grid displays the report categories that have been defined.
3 Right-click the report category in the grid, and select Properties.
A properties dialog box opens.
Figure 14-75 The properties dialog box for a report category
Note: You cannot change the report provider.
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-116
4 To change the provider configuration, click the Provider
Configuration button.
The Provider Configuration dialog box opens.
The appearance of the Provider Configuration dialog box varies
with the kind of report provider.
Table 14-5 The provider Configuration dialog boxes
5 Do one of following:
a) For APRS SP provider categories, click in the Stored
Procedure Name field and edit the name of the stored
procedure that contains the configuration, or
b) For APRS Query Server provider categories, click the
down-arrow by the Dataset Name field to choose another
dataset, and in Description textbox, click and edit the
description text, or
c) For SQL Server Reporting Service provider categories: do the
following:
In the Report parameters section, you can choose to edit
the choice of either to not load any parameters or to load
the parameters from an existing report.
In the Report view toolbar section, you can edit your
selection of the options needed when SQL Reporting
Services opens. If you are referencing an existing report, in
most instances you do not need to display the toolbars.
However, the option is there should you need to reconfigure
the report.
Note: If you choose to not load the parameters, you need to specify these from within
SQL Reporting Services, or if you choose to use an existing report, you must
provide a path to the report, which is available from within SQL Reporting
Services.
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-117
6 Click OK.
You are returned to the Properties dialog box.
7 Click the Parameters button.
The Report Parameter Configuration dialog box opens with details
of the configuration.
Figure 14-76 The Report Parameter Configuration dialog box
8 In the Parameters List pane, select a parameter. Click the
Refresh Parameter List button to view new or additional
parameters.
Any additional parameters appear in red in the Parameter List
pane.
9 In the Parameter Definition groupbox, do the following, as
needed:
a) In the Prompt field, click and edit the name.
Note: When making changes in the Provider Configuration dialog boxes, you
cannot browse to and select the appropriate stored procedure, dataset, or
report definition. There is also no validation of your configuration as you
complete your changes, so you should run a report immediately afterwards to
ensure the configuration is correct.
Note: Depending on the report provider, and if the report category is locked, there
could be restrictions to what you can edit.
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-118
b) In the Data Type field, select another data type from the
drop-down list.
10 In the Data Source field, choose one of the following from the
drop-down list:
a) If you no longer need a defined list of values, select None and
go to Step 17.
b) If you need a defined list of default values, select
User-defined list, then click the ellipsis button by the Data
Source field.
The Data Source Configuration dialog box opens.
Figure 14-77 The Data Source Configuration dialog box
11 For each new value that you need to change, do the following:
a) To modify existing labels and values, double-click in the
appropriate cell and edit as needed.
b) To remove entries, select the row and then click the Remove
button.
12 When finished, click OK.
Note: The data type you choose determines the options in the Parameter Options
groupbox. You can edit active fields.
Note: The values in the Data Source dialog box must match the data type. For
example, if the data type is Text, the list items must text strings, or if the data
type is Boolean, the values must 1 or 0.
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-119
13 If you want users to be able to edit the list, ensure the Editable
checkbox is selected.
14 In the Default Value field, do one of the following:
a) Clear the field if you chose None in the Data Source field and
there is no need to create a default value, or
b) Type a value into the field, if you chose None in the Data
Source field, but there is a need for a default value, or
c) Click the down-arrow by the User-defined list, and select an
item from the list.
15 Edit the parameter value and number of values by selecting one of
the following:
a) If the data type is Text, and there might be multiple values,
select the checkbox and specify a punctuation character to
separate the values.
b) If the parameter does not need a value to function, select the
checkbox.
16 Click OK.
The Properties dialog box displays. You can view and edit other
parameters from this dialog box.
Deleting a Report Category
Use the instructions below to delete a report category.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Reports Administration task module using
the instructions in Opening the Reports Administration Module on
page 14-3.
Created a report category using the instructions in Creating a
Report Category on page 14-43.
Procedure
1 In the secondary frame, click the Content category button.
2 In the Content frame, click the Categories icon.
The grid displays the report categories that have been defined.
3 Right-click the report category in the grid and select Delete.
A confirmation dialog box opens.
4 Click Yes.
Note: Before deleting a category, you should recognize that you will also loose any
report templates and scheduled reports that are associated with the category.
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-120
Viewing and Editing Properties of Report
Styles
Use the instructions below to view and edit the properties of a report
style.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Reports Administration task module using
the instructions in Opening the Reports Administration Module on
page 14-3.
Determine the location (path) and names of the stylesheet (.xsl)
files that control the appearance of reports. These are located on
the report server.
Procedure
1 In the secondary frame, click the Content category button.
2 In the Content frame, click the Styles icon.
3 In the Report Categories frame, select the category that uses the
report style whose properties you need to change
The grid displays the report styles that have been defined for the
category.
4 Right-click the report style in the grid and select Properties.
Note: You can view the properties of all report styles, but you cannot edit the
properties of styles associated with locked report categories.
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-121
Figure 14-78 The properties dialog box for report styles
5 Do the following, as needed:
a) Click in the Name field and edit the name.
b) Click in the Description textbox and edit the text.
c) If you need to use a different stylesheet, edit the path in the
Transformation field.
d) Select or clear the Active checkbox.
6 Click OK.
Deleting a Report Style
Use the instructions below to delete a report style.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Reports Administration task module using
the instructions in Opening the Reports Administration Module on
page 14-3.
Created a report style using the instructions in Creating a New
Report Style From an Existing Style on page 14-50.
Procedure
1 In the secondary frame, click the Content category button.
2 In the Content frame, click the Styles icon.
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-122
3 In the Report Categories frame, select the category that uses the
report style that you need to delete.
The grid displays the report styles that have been defined for the
category.
4 Right-click the report style in the grid and select Delete.
A confirmation dialog box opens.
5 Click Yes.
Viewing a Report Template Definition
Use the instructions below to view a report template definition. This
procedure allows you to view, not edit a report template definition.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Reports Administration task module using
the instructions in Opening the Reports Administration Module on
page 14-3.
Created a report template using the instructions in Creating a
Report Template on page 14-51.
Procedure
1 In the secondary frame, click the Content category button.
2 In the Content frame, click the Templates icon.
3 In the Report Categories frame, select the category that uses the
report template that you need to view.
The grid displays the report templates that have been defined for
the category.
4 Right-click the report template in the grid and select View
Template Definition.
A window opens with details of the configuration of the template.
5 View the information in the window, and click Close when finished.
Maintaining Data Item Configuration for
APRS SP, APRS Query Server, and SQL
Reporting Service Report Categories
APRS SP, APRS Query Server, and SQL Reporting Service reports pull
information from different sources. If you need to change data items
such as incidents, faults, time frames, etc. for report categories, you
can edit some parameters and not others, depending on the report
category that you choose. See Report ProvidersWhich is Best for
You? on page 14-18 and Editing Report Parameters for APRS SP, APRS
Query Server, and SQL Reporting Services on page 14-107.
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-123
Maintaining Report Template Properties
You can view and edit most of the properties of the report templates in
one of two ways:
Double-click on the template properties from the cells in the grid,
or
Right-click a template in the grid and select Properties from the
context menu.
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-124
Maintaining Report Scheduling and Delivery
As you become familiar with the reports and how they are viewed, you
can change the method and frequency of delivery.
This section covers the following topics:
Viewing the General Properties of a Scheduled Report on page
14-124
Viewing and Editing Templates for Scheduled Reports on page
14-125
Viewing and Editing the Schedule for a Scheduled Report on page
14-128
Viewing and Editing the Delivery Instructions for a Scheduled
Report on page 14-130
Deleting a Scheduled Report on page 14-131
Viewing and Editing Report Distribution Properties on page 14-132
Deleting a Report Distribution on page 14-137
Viewing the Properties of Scheduled Reports on page 14-138
Maintaining Report Distributions on page 14-138
Viewing the General Properties of a
Scheduled Report
Use the instructions below to view the basic properties of a scheduled
report in the properties dialog box.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Reports Administration task module using
the instructions in Opening the Reports Administration Module on
page 14-3.
Procedure
1 In the secondary frame, click the Delivery category button.
2 In the Delivery frame, click the Scheduled Reports icon.
Any scheduled reports that have already been defined are
displayed in the grid.
3 In the Report Categories frame, select the category that contains
the scheduled report.
4 On the row in the grid for the scheduled report, right-click and
select Properties.
A properties dialog box opens.
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-125
5 Click the General tab and do the following as needed:
a) To change the name of the report, edit the text in the Name
field.
b) To change the description, edit the text in the Description
field.
6 Click the Details tab.
The Details page opens. This page contains several options that are
explained elsewhere in this documentation. For more information,
see the Related topics below.
Figure 14-79 An example of the properties dialog box
7 Click OK.
Viewing and Editing Templates for
Scheduled Reports
Use the instructions below to view and edit the template used to
produce a scheduled report. These instructions assume you need to
edit all aspects of the template in use, so please skip those steps you
do not need.
Note: You can edit the template, but you cannot select another template to use.
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-126
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin.
If necessary, open the Reports Administration task module using
the instructions in Opening the Reports Administration Module on
page 14-3.
Created a template using the instructions in Creating a Report
Template on page 14-51.
Procedure
1 In the secondary frame, click the Delivery category button.
2 In the Delivery frame, click the Scheduled Reports icon.
Any scheduled reports that have already been defined are
displayed in the grid.
3 In the Report Categories frame, select the category that contains
the scheduled report.
4 Select the scheduled report in the grid, click the Report Template
column, then click the ellipsis button.
Figure 14-80 The Report Template Configuration dialog box
5 To add or remove report styles, click the Styles button.
The Select Styles for Pre-Transformation dialog box opens.
Note: The Report style(s) groupbox lists the styles the template is using.
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-127
Figure 14-81 The Select Styles for Pre-Transformation dialog box
6 Do the following, as needed.
a) To add a style to the pre-transformation list, select it in the
Available report styles pane and click the Add button.
b) To remove a style to the pre-transformation list, select it in the
Style(s) selected report styles pane and click the Remove
button.
c) When done, click the OK button.
7 To view the properties of the template, click the View button, then
click the Close link.
A window opens with details of the report template. You cannot
edit anything within the window.
Figure 14-82 An example of the properties of a report template
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-128
8 To edit the properties of the template, do the following:
a) Click the Edit button.
Figure 14-83 Examples of the Report Template Parameters dialog box
b) For each parameter you need to edit, click or double-click the
cell in the Value column and edit.
c) When finished, click OK to close the Report Template
Parameters dialog box.
9 Click OK to close the Report Template Configuration dialog box.
Viewing and Editing the Schedule for a
Scheduled Report
Use the instructions below to view the schedule for a scheduled report.
Note: The steps to edit configure report parameters can vary with each report
category.
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-129
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Reports Administration task module using
the instructions in Opening the Reports Administration Module on
page 14-3.
Created a schedule for a scheduled report using the instructions in
Creating a Scheduled Report on page 14-75.
Procedure
1 In the secondary frame, click the Delivery category button.
2 In the Delivery frame, click the Scheduled Reports icon.
Any scheduled reports that have already been defined are
displayed in the grid.
3 In the Report Categories frame, select the category that contains
the scheduled report.
4 Select the scheduled report in the grid, click the Schedule column,
then click the ellipsis button.
Figure 14-84 The Select a Schedule dialog box
5 Edit the schedule as required, completing the fields from top to
bottom.
The selections you make in one field changes the selections you
can make in the fields below it.
6 When finished, click OK.
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-130
Viewing and Editing the Delivery
Instructions for a Scheduled Report
Use the instructions below to view and, if necessary, edit the delivery
instructions for a scheduled report.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Reports Administration task module using
the instructions in Opening the Reports Administration Module on
page 14-3.
Created a scheduled report using the instructions in Creating a
Scheduled Report on page 14-75.
Procedure
1 In the secondary frame, click the Delivery category button.
2 In the Delivery frame, click the Scheduled Reports icon.
Any scheduled reports that have already been defined are
displayed in the grid.
3 In the Report Categories frame, select the category that contains
the scheduled report.
4 Select the scheduled report, click in the Delivery Instructions
column, then click the ellipsis button.
Note: The starting point for creating By Time and By Shift schedules differs from
what you see in Reports Administration, as the instructions refer to the
procedures in the Schedule Administration task module. Start at Step 2 in both
instances.
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-131
Figure 14-85 The Delivery Instructions dialog box
5 On the Users/Roles tab, click the Add button and select users and
roles, or to remove users, select users and roles and click the
Remove button, then click OK.
6 On the Folders tab, do one of the following:
a) To enable delivery to a folder, select the Enable delivery to
checkbox and select a folder in the tree view below.
b) To change the shared folder, select another in the tree view.
c) To disable delivery to a shared folder, clear the Enable
delivery to checkbox.
7 When finished, click OK.
Deleting a Scheduled Report
Use the instructions below to delete a scheduled report.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Reports Administration task module using
the instructions in Opening the Reports Administration Module on
page 14-3.
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-132
Procedure
1 In the secondary frame, click the Delivery category button.
2 In the Delivery frame, click the Scheduled Reports icon.
Any scheduled reports that have already been defined are
displayed in the grid.
3 In the Report Categories frame, select the category that contains
the scheduled report.
4 Right-click the scheduled report in the grid and select Delete.
A confirmation dialog box opens.
5 Click Yes.
Viewing and Editing Report Distribution
Properties
Use the instructions below to view and edit the properties of a report
distribution.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Reports Administration task module using
the instructions in Opening the Reports Administration Module on
page 14-3.
Created a report distribution using the instructions in Creating a
Report Distribution on page 14-80.
Procedure
1 In the secondary frame, click the Delivery category button.
2 In the Delivery frame, click the Report Distributions icon.
3 In the Report Categories frame, select the category with the
report distribution you need to view/edit.
Any previously defined distributions appear in the grid.
4 Right-click the report distribution in the grid and select
Properties.
Note: These instructions assume that you need to edit all aspects of a report
distribution. Please skip any steps that do not apply.
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-133
Figure 14-86 The properties dialog box for a report distribution
5 Ensure that you are on the General tab and edit the fields as
needed.
6 Click the Details tab.
Figure 14-87 The Details page
7 Click the Delivery Instructions button.
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-134
Figure 14-88 The Distribution Types page
8 On the E-mail row in the grid, click in the Properties column,
then click the ellipsis button.
A dialog box opens where you can view and edit the e-mail delivery
settings.
Figure 14-89 The e-mail settings dialog box
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-135
9 To add recipients, do the following:
a) For ActivEssentials users, click the Activplant Users button.
A dialog box opens with a listing of all ActivEssentials users with an
e-mail address associated with their profile.
Figure 14-90 The Available Users dialog box
b) Select the checkboxes next to the users who should receive the
reports.
10 When finished, click OK.
The users appear in the Recipient List.
11 To remove users from the Recipient List, select them in the pane
and click the Remove button.
12 Click the down-arrow by the Mail report as field and select the
method to use.
13 Click the down-arrow by the Report style field and select a style
from the list.
14 When finished setting up the e-mail recipients, click OK.
15 On the File Delivery row, click in the Properties column, then
click the ellipsis button.
A dialog box opens where you can view and edit the settings for
delivering the report as a file.
Note: E-mail is controlled by the web.config file that is located on the report server.
Before you can add users or roles in the E-mail Settings, you must edit the
configuration file.
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-136
Figure 14-91 The file delivery settings dialog box
16 To change the destination folder, click the Browse button and
navigate to and select the folder where you need to save the
reports.
17 To change the file name settings, do the following, as needed:
a) To use a specific file name for the report, select the Define a
file name option, or
b) To use a predefined name, select the Use the file name
generated by option.
The file names are always different with this method, but if
viewed through the VPWeb Report Viewer, users always see the
most recent report.
18 When finished, click OK.
19 On the Delivery Instructions dialog box, click the Retries tab.
Note: This should be a shared folder on your network that is available to anyone who
needs to view the report.
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-137
Figure 14-92 The Retries page
20 Select or clear the In case of failure checkbox. If now selected,
do the following:
a) Click the up- or down-arrows by the Maximum retries field,
and set the number of attempts.
b) Click the up- or down-arrows by the Wait between retries
field, and set an interval in minutes between each attempt.
21 When finished, click OK to close the Delivery Instructions dialog
box.
Deleting a Report Distribution
Use the instructions below to delete a report distribution.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Reports Administration task module using
the instructions in Opening the Reports Administration Module on
page 14-3.
Created a report distribution using the instructions in Creating a
Report Distribution on page 14-80.
Note: The Retries page lets you determine a strategy for handling times when report
delivery fails. You can set the number of attempts at delivery and the interval
between each.
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-138
Procedure
1 In the secondary frame, click the Delivery category button.
2 In the Delivery frame, click the Report Distributions icon.
3 In the Report Categories frame, select the category with the
report distribution you need to delete.
Any previously defined distributions appear in the grid.
4 Right-click the report distribution in the grid and select Delete.
A confirmation dialog box opens.
5 Click Yes.
Viewing the Properties of Scheduled
Reports
You can access the properties of scheduled reports by either opening
the properties dialog box for a report, or directly through the grid. To
open the properties dialog box, right-click the entry for the scheduled
report in the grid and select Properties.
You can view and edit the following properties of scheduled reports in
the grid:
Name. The names of the scheduled reports. You can double-click
the cell and edit the name directly.
Report Template. The report template is used for preparing the
reports. Click once in the cell to display an ellipsis button, and then
click the ellipsis button to open the Report Template
Configuration dialog box. For more information, see Viewing and
Editing Templates for Scheduled Reports on page 14-125.
Schedule. The name of the schedule that is in use for preparing
the reports. Click once in the cell to display an ellipsis button, and
then click the ellipsis button to open the Select a Schedule dialog
box. For more information, see Viewing and Editing the Schedule
for a Scheduled Report on page 14-128.
Delivery Instructions. A link to the Delivery Instructions
dialog box. Click once in the cell to display an ellipsis button, and
then click the ellipsis button to open the dialog box. For more
information, see Viewing and Editing the Delivery Instructions for a
Scheduled Report on page 14-130.
Subscription. A selected checkbox means the report is available
by subscription to users. If you clear the checkbox, you remove
from potential subscribers the option to receive the report, but
existing subscribers still have access.
Active. The report runs to schedule. If you clear the checkbox, the
report does not run.
Maintaining Report Distributions
Report distributions push reports out to users. You can do this for both
ActivEssentials users and those who are outside the system but who
still need the reports.
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-139
Database Rules for Cleaning up Reports
The Activplant Reporting Services include a database cleanup job that
ensures that all reports that are no longer in use are deleted from the
server. This job depends on database routines that manage the
number of references made to a report file.
This section covers the following topics:
Report References on page 14-139
Report References for Scheduled Reports on page 14-140
Report Clean-up on page 14-140
Report References
A report file is created whenever a users request for a report is
successful, or when a scheduled report runs. When the report file is
stored on the report server, a record is created in the database. The
database tracks the report trail by adding references to the file: when
it was produced, where it went, report or subscription removal, etc.
In the case of a subscription, the users My Subscriptions folder
contains links to the reports to which the user has subscribed, and
each report has a reference for every user who is subscribed.
When a user deletes an entry in the Recent Reports folder, or deletes a
subscription from the Subscriptions folder, the number of references to
the report decreases by one and the database updates the number
accordingly.
The number of references to a report determines when it will be
deleted from the reporting system. If there are no references to a
report, it is deleted.
Figure 14-93 Overview of report references and report deletion
AP
Report 1
Database Record
AP Report 1 REF Count = 2
AP Report 2 REF Count = 0
AP Report 3 REF Count = 4
Generate a Report
Execute a
Scheduled Report
One REF
One REF for Each
Subscriber/Folder
One REF for Each
User/Folder
One REF for Each
User/Folder
File
Cleanup
Process
Decrease REF Count
- Delete Report
- Delete Subscription
Increase REF Count
- Send Report to User
- Save Report to Folder
AP
Report 2
AP
Report 3
Delete Report
File(s)
Create
Multiple
Report
Files
Create
Report
File
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-140
Report References for Scheduled Reports
In a scheduled report, a report file is created for each style that is
designated for pre-transformation. A link is created in each subscribed
users Subscriptions folder, as well as a link in any shared folder to
which the report is sent. These links are included in each report files
reference count.
When the report is regenerated according to schedule, the links in the
users folders are all updated to point to the new files. The old links are
moved to the history folder. If the users history has reached its limit,
the oldest link is removed to make room for the new one. Links in
shared folders are replaced.
Any files that have references to them (all users history links are
deleted) are automatically deleted.
Report Clean-up
If the initial owner of a template or saved report deletes them, these
reporting items only exist in the Activplant reporting system for as
long as other users have links to them. However, the report server
does not remove reports the moment the reference count falls to zero;
the actual clean-up job might not occur for more than one hour, but
the report is no longer available for use.
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-141
Report Generation and a Users Folder Limits
When a Report Viewer user creates a report, the report file is saved
and the Recent Reports folder shows a link to the report. The database
also checks the users Recent Reports folder. If the number of links in
the folder has reached the folders maximum limit, the oldest
reference is deleted to make room for the new one. This ensures that
the number limit on the users Recent Reports folder will never prevent
them from creating a report.
The size limit on the users folders is checked automatically before
report execution. The report will be generated if the users usage is
less than maximum (even if only by 1 KB), even if the new report will
push the usage above the maximum. If the users limit has already
been reached, an error message appears and the user cannot
generate the report unless they first delete some reports.
This section covers the following topics:
Failure to Create a Report on page 14-141
Failure to Create a Report
A user is almost always able to run at least one report. The reasons
are as follows:
If the Recent Reports limit is already reached, the system deletes
the oldest link to accommodate the new request.
The user can create a new report if the disk space used already is
less than the limit. It can be less by as little as 1 KB.
A user cannot generate a report if:
Their folder size or number limits have been reduced by an
administrator.
They have cleared the Recent Reports folder to use the space for
other purposes (for example, to store more reports in other
folders) and have reached the overall number limit. If they try to
generate a report later, it will fail because there is no link in Recent
Reports that can be deleted to make room for the new one.
Their folder is over the size limit and the new report is larger than
the oldest report that would be deleted.
Note: A user has a total size limit of 100 MB. The previous report was generated
when usage was at 98.750 MB, and this report pushed usage to 103.54 MB.
Note: The oldest report in Recent Reports has a size of 2.87 MB.
Report Administration
CDC Factory 7.1
ActivEssentials Administration Guide
14-142
In each of these cases report generation fails. The user must make
space to generate a report.
Note: The user now generates a new report. The system sees that the limit is
exceeded and deletes the oldest report. However, the limit is still exceeded
(103.54 2.87 = 100.67), so report generation fails.
CDC Factory 7.1
ActivEssentials Administration Guide
15-1
Retroactive Incident Editing
Retroactive Incident Editing
CDC Factory 7.1
ActivEssentials Administration Guide
15-2
Introduction to Retro Stop
If you intend to use retroactive incident editing, this chapter provides
information about the set up and an overview of the operation.
Retroactive incident editing occurs through the use of Retro Stop,
which allows for revisions to the ActivEssentials database in
recognition that automatically assigned incident definitions may
improperly describe incidents.
In operation, Retro Stop allows operators to reassign the incident
definitions attributed to an incident. Retro Stop is not invoked from
within ActivEssentials, but through the use of a Human Machine
Interface (HMI).
This chapter covers the following topics:
How Retro Stop Functions on page 15-2
Retro Stop Set Up on page 15-12
How Retro Stop Functions
Retro Stop functions as a means of amending database records when
the automatically assigned incident definition does not properly
describe the reason for an incident. The machine operator, through a
Human Machine Interface (HMI), can press a button to insert a new
Retro Stop incident description in the database, bringing to an end the
wrongly described incident. The operator then initiates a new incident,
assigning the correct fault code, overwriting both the original and the
Retro Stop database records. The database then shows only the
replacement incident, which has the same start time as the original
incident.
This section covers the following topics:
Changing the Record on page 15-2
Retro Stop in Action on page 15-4
How the Database Handles Allowed Gap Timing Errors on page
15-7
Consequences of Misapplying Retro Stop on page 15-9
Comparing Retro Stop with Root Cause Analysis on page 15-10
Changing the Record
When the operator presses the Retro Stop button, the button
invokes the Retro Stop incident definition. At this point, the original
incident is halted and the new Retro Stop incident starts.
The user does not initiate the Retro Stop incident within
ActivEssentials, but through the use of an independent HMI device.
When the operator activates the Retro Stop incident, this changes
values in the PLC attached to the asset where the incident occurred.
Retroactive Incident Editing
CDC Factory 7.1
ActivEssentials Administration Guide
15-3
The values in the PLC that indicate the closure of the original incident
and the opening of the Retro Stop incident are collected by VPCollector
through an OPC server.
The new Retro Stop incident must run for at least 2 seconds, to allow
for network delays, but there is no maximum period defined. With the
Retro Stop incident in place, the operator then chooses the incident
definition that properly describes the incident, which then replaces
both the original incident and the Retro Stop incident.
When applying Retro Stop two sets of changes are made to the
database:
Firstly, the initiation of the Retro Stop incident closes the original
incident and starts the Retro Stop incident.
Secondly, the correct incident replaces both the original and Retro
Stop incidents in the database, with a start time coincident with
that of the original incident. The Retro Stop incident exists only
temporarily in the database, acting as a place holder until the
replacement incident is inserted.
The following figure indicates how the process works:
Figure 15-1 The effect of using Retro Stop
Operator presses Retro Stop button,
starting Retro Stop incident
Original incident underway
Operator enters the correct
incident definition, starting
replacement incident
Span of original incident
Span of original incident Span of Retro Stop incident
Replacement incident ends. Total duration spans from the start time of the original
incident, through to the end time of the replacement incident
Within allowed gap
Within allowed gap Within allowed gap
Retroactive Incident Editing
CDC Factory 7.1
ActivEssentials Administration Guide
15-4
Incident Priorities
To use Retro Stop the incident categories with which it is used should
be priority enabled when applied to an asset. See Adding Retro Stop
Enabled Incident Categories to an Asset on page 15-18, and Enabling
Incident Categories to Use Retro Stop on page 15-25 for more
information. Having priorities enabled allows the Retro Stop incident,
which should have the highest priority, to bring to a close any other
incidents with a lower priority.
In some situations you may prefer that the Retro Stop incident is not
defined as having the highest priority, or that incident priority is
determined through other means. If this is so, there are two conditions
where the Retro Stop incident does not need the highest priority:
Trigger value. In instances where incidents are triggered through
the values at a PLC address (OPC item), you can set a unique
trigger value to initiate the incident. In this circumstance, only one
value can exist at a time at the OPC item address, so if the value
that triggers the Retro Stop incident exists, the previous incident
ends and the Retro Stop incident starts.
For this to occur, you must set the trigger value and the OPC item
for the Retro Stop incident definition as it is applied to the asset,
and make sure the HMI writes this value to the correct PLC
address. VPCollector then gathers the new incident data from the
OPC server.
HMI software configuration. If the HMI software is able to close
the original incident before the Retro Stop incident is initiated,
there is no need for a higher priority. The original incident is
closed, so the Retro Stop incident (or any other incident) can now
begin.
If you need the Retro Stop incident to behave in either of these ways,
you must set up your HMI software to write the correct values to the
PLC, or to write values in the right order.
Incident Merging
The merging of incidents that have the same incident description is
supported with the use of Retro Stop. At the completion of the Retro
Stop process, the database checks the new incident description and
compares it to the last closed incident. If the incidents have the same
incident description, and the gap is within that allowed interval, the
incidents are merged.
It does not matter that the description of the original incident in the
Retro Stop chain was different to its immediate predecessor, if the
descriptions are the same after the process they are candidates for
merging.
Retro Stop in Action
The effect of using the Retro Stop incident definition is visible in
VPWeb. The following sequence of screenshots illustrates the
application of Retro Stop, as seen in Layout View and Detailed View.
Retroactive Incident Editing
CDC Factory 7.1
ActivEssentials Administration Guide
15-5
Although the following screen shots illustrate several stages in the
transition from the original incident to the correct, replacement
incident, there are only two steps for the operator:
Applying the Retro Stop incident, which closes the original incident
and starts the Retro Stop incident.
Applying the correct incident, which closes the Retro Stop incident
and removes from the database the records for both the original
incident and the Retro Stop incident, and then starts the correct
incident using the start time for the original incident.
The First Incident Occurs
As the incident occurs, you can see the current incident (fault2) in the
Layout View window, and the start time for the incident in Detailed
View. The start time is 17:58:38.
Figure 15-2 The first incident starts
The Retro Stop Button is Pressed
The operator realizes that the incident definition represented by
fault2 is wrong, so the Retro Stop button is pressed to bring the first
incident (fault2) to an end. The end time is 17:59:56.
Figure 15-3 The first incident ends
Retroactive Incident Editing
CDC Factory 7.1
ActivEssentials Administration Guide
15-6
The Retro Stop Incident Starts
After the first incident has ended, the Retro Stop incident will start.
Although the Retro Stop incident appears in the real-time view (Layout
View), it does not appear in Detailed View even though the database
recognizes it; only the closed, original incident appears in Detailed
View. The start and end times are 17:58:38 and 17:59:56.
Figure 15-4 The Retro Stop incident starts
The Retro Stop Incident Stops
After the Retro Stop incident definition has started, the operator
applies the correct incident definition. To apply the new, replacement
incident definition, the Retro Stop incident must now close. In Layout
View the Retro Stop incident ends, but it is never recorded in Detailed
View where the original incident (Fault2) continues to appear with its
factual start and end times.
Figure 15-5 The Retro Stop incident ends
The Correct Incident Starts
As the Retro Stop incident ends, the new incident (fault4) can begin.
The new (replacement) incident appears in both Layout View and
Detailed View, and has a start time of 17:58:38, the same as the start
time for the original incident (fault2), but the incident is now open.
Retroactive Incident Editing
CDC Factory 7.1
ActivEssentials Administration Guide
15-7
Figure 15-6 The correct incident (fault4) starts
The Correct Incident Ends
When the incident is over, the incident (fault4) comes to an end. As
the incident ends, the recorded duration of 00:04:03 spans the period
from the start time of the original incident (fault2) through to the end
time of the replacement incident (fault4). However, the original and
Retro Stop incidents have been replaced in the database with the
replacement incident (fault4). The database does not keep a record of
the use of the Retro Stop incident.
Figure 15-7 The correct indicent (fault4) comes to an end
How the Database Handles Allowed Gap
Timing Errors
Network delays and delays in SQL Server can upset the flow of
changes to the database. To allow for timing errors, the database has
the following rules:
The allowed gap between the end time of the original incident and
the start time for the Retro Stop incident is set to 30 seconds.
The allowed gap between the end time of the Retro Stop incident
and the start time for the new incident is set to 30 seconds.
Retroactive Incident Editing
CDC Factory 7.1
ActivEssentials Administration Guide
15-8
If the gap before the Retro Stop incident is greater than the
allowed gap, and the gap after the Retro Stop incident is within the
allowed gap (Scenario 1), the original incident remains in the
database, and the replacement incident is recorded as starting at
the start time of the Retro Stop incident. See the following figure:
Figure 15-8 Scenario 1First allowed gap exceeded
If the gap before the Retro Stop incident is within the allowed gap,
and the gap after the Retro Stop incident is greater than the
allowed gap (Scenario 2), both the original and replacement
incidents remain in the database with their actual ending and
starting times, and the Retro Stop incident is removed from the
database. Thus, there will be no database record for the period
spanning the Retro Stop incident. See the following figure:
Figure 15-9 Scenario 2Second allowed gap exceeded
If the gaps both before and after the Retro Stop incident are
greater than the allowed gap (Scenario 3), both the original and
replacement incidents remain in the database with their actual
ending and starting times, and the Retro Stop incident is removed
from the database. Thus, there will be no database record for the
period spanning the Retro Stop incident. See Figure 15-10 below.
Note: The Allowed Gap parameter is set in the System Settings module of
MI Admin, where the default value is 30 seconds. This gap may not reflect your
experience with your network. You can edit the default value in the
ActivEssentials System Properties module to reflect a gap period slightly
longer than you would normally expect. If you do not have the allowed gap
parameters set correctly, the data recorded may not be what you intended.
Operator enters the correct
incident definition, starting
replacement incident
Span of original incident Span of Retro Stop incident
Allowed gap exceeded Within allowed gap
Original incident
remains in database
Retro Stop incident removed from database, and replacement incident
starts from the start time of the Retro stop incident.
Scenario 1
Operator enters the correct
incident definition, starting
replacement incident
Span of original incident Span of Retro Stop incident
Allowed gap exceeded Within allowed gap
Original incident
remains in database
Retro Stop incident removed
from database, and
replacement incident starts
from the start time it was
invoked.
Scenario 2
Retroactive Incident Editing
CDC Factory 7.1
ActivEssentials Administration Guide
15-9
Figure 15-10 Scenario 3 Both allowed gaps exceeded
Consequences of Misapplying Retro Stop
If the Retro Stop incident is applied in error, perhaps to the wrong
incident, it may be possible to restore the original incident. There are
two allowed gap parameters used in ActivEssentials to control the
joining of incidents: one controls the gap between incidents of the
same description, and the other the gap between the steps of the
Retro Stop process. When applying Retro Stop though, it is the Retro
Stop allowed gap that controls if incidents are merged. If the Retro
Stop allowed gaps are not exceeded, you can restore the original
incident description.
Example
An operator applies the Retro Stop incident to the wrong open incident
and needs to correct the situation. The Retro Stop allowed gap is 5
seconds, and the merging allowed gap is 10 seconds. To correct the
problem the operator then applies the same incident description as the
replacement.
This procedure could fix the problem, but because of network delays
the first Retro Stop allowed gap was exceeded by 2 seconds (7
seconds overall). When the new (restored) incident description is
applied it is merged only with the term of the Retro Stop incident, so
two incidents appear in the historical record.
The merging allowed gap was not exceeded, so it should capture the
two incidents and merge them into one incident. However, because the
incidents were handled by Retro Stop the merge does not take place.
Operator enters the correct
incident definition, starting
replacement incident
Span of original incident Span of Retro Stop incident
Allowed gap exceeded
Original incident
remains in database
Retro Stop incident removed
from database, and
replacement incident starts at
the time it was invoked.
Scenario 3 Allowed gap exceeded
Note: The net result for any of the scenarios produces data that differs from what was
intended. It is important to recognize that the allowed gap parameter must
reflect the performance of your network.
Retroactive Incident Editing
CDC Factory 7.1
ActivEssentials Administration Guide
15-10
Comparing Retro Stop with Root Cause
Analysis
ActivEssentials can contain two functional methods for changing
incident records: Retro Stop and the optional Root Cause Analysis.
Each is able to change the incident record for an asset, but they go
about it in fundamentally different ways.
Root Cause Analysis is an optional extra ActivEssentials module,
whereas Retro Stop is part of the standard ActivEssentials product but
it not enabled by default.
Retro Stop Methodology
Retro Stop allows users to substitute the description of a current
incident with a description that more closely matches the incident as
observed. Root Cause Analysis can also be used to retroactively
change incident descriptions, but its main purpose is in assigning
reason codes.
For the automatically assigned incident descriptions assigned by
ActivEssentials to be changed, Retro Stop relies on the use of HMI
devices that are independent of ActivEssentials. In the first instance
ActivEssentials gathers data from PLC devices, which when analyzed
can indicate that an incident has taken place. At this point
ActivEssentials records in its database that an incident is on going.
If an operator recognizes that a current incident is improperly
described, the HMI, if properly configured, can stop the incident and
start a new (Retro Stop) incident. The Retro Stop incident is not a
proper description of the incident, but a temporary placeholder used
while the operator determines the correct description.
The operator, through using the HMI, writes a value to a PLC address
that terminates the first incident. The OPC server that monitors the
values in the PLC records this change in its own record of the current
values in the PLCs it monitors. VPCollector then gathers this data and
the ActivEssentials database is updated to acknowledge the incident
has ended. This action also initiates the Retro Stop incident by
changing an appropriate value in the PLC. This might be a trigger
value or some other value. The OPC server collects this data and
passes it onto VPCollector which in turn updates the database. The
important point here is that the use of the Retro Stop incident is
recognized by the database, so it creates a connection between the
original incident and this temporary incident.
The second part of the process is when the operator assigns the
correct incident description, which again occurs through the use of an
HMI. The flow of data is the same. The HMI changes the value at a PLC
address, the OPC server recognizes this and passes the data onto
VPCollector, which then updates the database. The database
recognizes the termination of the Retro Stop incident and merges the
three incidents. In all of this ActivEssentials is an observer. All of the
Retroactive Incident Editing
CDC Factory 7.1
ActivEssentials Administration Guide
15-11
changes to the database have occurred as a result of external
changes, but the configuration of the Retro Stop incident indicates to
the database how it should handle these changes.
Root Cause Analysis Methodology
Root Cause Analysis is a database manipulation application; there is
no interaction with the PLCs or OPC servers. When using Root Cause
Analysis, operators can change incident descriptions for all historical
incidents and almost all open incidents.
In use, Root Cause Analysis provides very flexible control over the
database records for incident time stamps. Operators can create new
incidents, delete existing incidents, split incidents at a change of shifts
or some other time, merge incidents that might otherwise be seen as
separate, and change start and end times.
Root Cause Analysis provides additional functions such as allowing
operators to assign reason codes to incidents, add comments, link
incidents to incidents occurring elsewhere in the plant, and provide
extra information through extended properties. This type of control
does not exist through using Retro Stop.
All operations in Root Cause Analysis are based on observing the
existing database record and manipulating it to reflect the observed
state of the assets being monitored.
Coexistence
Retro Stop and Root Cause Analysis can co-exist in an ActivEssentials
installation, but there are some minor limitations. Root Cause Analysis
does not interfere with Retro Stop in any way, however, the Retro Stop
stored procedure in SQL Server can prevent Root Cause Analysis from
dealing with very recently opened or closed incidents. The database
prevents Root Cause Analysis from editing incidents under the
following circumstances:
When the most recently occurring incidents fall under a Retro Stop
enabled incident category. Such incidents are candidates for Retro
Stop incident editing, and are protected from change should users
need to change the incident description. If such an incident closes
without the use of Retro Stop, it can then be edited in Root Cause
View.
Incidents that have been closed by Retro Stop, but the
replacement incident has not yet been inserted into the database.
While these incidents are closed, the Retro Stop process is
Note: Retro Stop can only handle incidents that are open. You cannot change the
incident description of a closed incident, whereas with Root Cause Analysis
you can.
Note: Root Cause Analysis cannot be used to alter the incident description of the
most recently occurring incident on an active Retro Stop enabled incident
category, whereas this is the purpose of Retro Stop.
Retroactive Incident Editing
CDC Factory 7.1
ActivEssentials Administration Guide
15-12
incomplete. Once it has been completed the incident record is
removed from the database and there is no historical record of its
existence.
Incidents inserted as replacements through the use of Retro Stop
that remain open. The replacement incidents can be edited later
once they have been closed normally.
Retro Stop Set Up
Retro Stop is included in a normal ActivEssentials installation, but by
default it is not enabled. To enable Retro Stop you must make changes
in the System Settings and Data Collection Configuration
modules of MI Admin, and then apply the Retro Stop incident definition
to the assets where it is required. You will also have to configure your
HMIs to modify the data switches in the PLCs involved.
This section covers the following topics:
Setting up Retro Stop in the System Settings on page 15-12
Creating the Retro Stop Incident Definition on page 15-14
Editing the Properties of the Retro Stop Incident Definition on page
15-16
Adding Retro Stop Enabled Incident Categories to an Asset on page
15-18
Adding the Retro Stop Incident Item to an Asset Using a Wizard on
page 15-20
Adding the Retro Stop Incident Item to an Asset Using the Grid on
page 15-23
Enabling Incident Categories to Use Retro Stop on page 15-25
Configuring the HMI on page 15-26
The Retro Stop System Settings on page 15-27
Effect of Disabling Incident Priorities on page 15-27
Setting up Retro Stop in the System
Settings
Use the instructions below to set up Retro Stop in the System Settings
of MI Admin. There are two settings required for Retro Stop to function
correctly: the Retro Stop Allowed Gap and Enable Incident Retro
Stop. Enabling Retro Stop does interfere in a limited way with the
operation of Root Cause Analysis (an optional ActivEssentials module).
See Comparing Retro Stop with Root Cause Analysis on page 15-10 for
more information.
Note: While it is possible to change many aspects of an ActivEssentials installation
by exporting the configuration to Excel, making the required changes, and then
importing the modified configuration, this can lead to errors with Retro Stop.
You should make all changes to the Retro Stop incident through the Data
Collection Configuration module.
Retroactive Incident Editing
CDC Factory 7.1
ActivEssentials Administration Guide
15-13
Prerequisites
Before doing this you need to have done or read the following:
If necessary, open the System Settings module using the
instructions in Opening the System Settings Module on page 2-2.
Procedure
1 In the secondary frame area, click the System Settings category
button.
The System Settings frame with icons for each of the modules in
this category.
2 Click the System Properties icon.
The grid refreshes to display the current ActivEssentials system
settings.
3 Locate the Retro Stop Allowed Gap row in the grid.
The entry in the Value column cell is the presently applied
allowed gap. By default, the value is 30 seconds.
Figure 15-11 The ActivEssentials system properties
4 Double-click in the Value cell to edit the allowed gap.
5 Locate the Enable Incident Retro Stop row in the grid.
The default value in the Value cell is 0.
6 Click the Value cell.
A down-arrow appears in the cell.
7 Click the down-arrow and select 1 from the drop-down list.
8 Click on any other row in the grid to save the changes.
Note: Only users who are members of either the Data Collection Global Definition
Management role, or the System Administrator role, may edit the Retro Stop
system properties.
Note: The allowed gap is in seconds, and can be set in a range of 03 600 seconds (1
hour).
Retroactive Incident Editing
CDC Factory 7.1
ActivEssentials Administration Guide
15-14
Creating the Retro Stop Incident Definition
Use the instructions below to create the Retro Stop incident definition.
The ActivEssentials database only allows for one Retro Stop incident
definition, regardless of whether it is active or not. If you need to set
an existing incident definition as the Retro Stop incident, see Editing
the Properties of the Retro Stop Incident Definition on page 15-16.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Data Collection Configuration task
module using the instructions in Opening the Data Collection
Configuration Module on page 7-3.
Before you can create the new incident definition, you must enable
Retro Stop in the System Settings module of MI Admin. See
System Settings on page 2-1 for the a ppropriate setting.
Procedure
1 In the Plant Hierarchy frame, select the Object Library item.
The secondary frame opens below.
2 Click the Global Collection Configuration category button.
3 In the Global Collection Configuration frame, click the
Incidents button.
All of the previously defined incident definitions appear in the grid.
4 Do one of the following:
a) Right-click on any row in the grid and select New from the
context menu, or
b) Click the New button on the toolbar.
The Add New Incident Definition wizard starts.
5 Click Next to move past the Welcome page.
Retroactive Incident Editing
CDC Factory 7.1
ActivEssentials Administration Guide
15-15
Figure 15-12 The Name and Code page of the wizard
6 Type a name for the definition in the Name field.
7 If required, type a code in the Code field.
8 Click Next.
Figure 15-13 The Incident Definition Properties page of the wizard
9 Do each of the following:
a) In the Collection category drop-down list, select the category
to which the definition should belong.
b) Select the Set as Retro Stop incident checkbox.
Note: You can either select just one category or all of the categories. If you select
All, the definition is globally available. You will need to decide which is more
appropriate for your situation.
Retroactive Incident Editing
CDC Factory 7.1
ActivEssentials Administration Guide
15-16
c) Select the Active checkbox.
10 Click Next.
The Summary of Item Properties page of the wizard opens.
11 Check the settings and then click Finish.
The new incident data item appears in the grid with a red letter R
is superimposed over the bottom left corner of the icon , in the
column to the left of the definition name.
Editing the Properties of the Retro Stop
Incident Definition
Use the instructions below to edit the properties of the Retro Stop
incident definition.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, open the Data Collection Configuration task
module using the instructions in Opening the Data Collection
Configuration Module on page 7-3.
Created a Retro Stop incident definition using the instructions in
Creating the Retro Stop Incident Definition on page 15-14.
Procedure
1 In the Plant Hierarchy frame, select the Object Library item.
The secondary frame opens below.
2 Click the Global Collection Configuration category button.
3 In the Global Collection Configuration frame, click the
Incidents button.
The previously defined incident definitions appear in the grid.
Note: If the Set as Retro Stop incident checkbox is not on the dialog box, you need
to enable Retro Stop in the System Settings module. See The Retro Stop
System Settings on page 15-27 for more information.
Note: If an error message appears stating that the Retro Stop incident already exists,
click OK. ActivEssentials will create the new definition, but it will not be flagged
as the Retro Stop incident definition. You need to find the other incident and, if
necessary, change its designation as the Retro Stop incident.
Note: To find the Retro Stop incident definition, you will need to know the name if it is
inactive. The grid only identifies the Retro Stop incident when it is active, using
an icon with a red background.
Retroactive Incident Editing
CDC Factory 7.1
ActivEssentials Administration Guide
15-17
4 Do one of the following:
a) Right-click the Retro Stop incident definition in the grid, and
select Properties from the context menu, or
b) Select the Retro Stop incident definition in the grid, and click
the Properties button on the toolbar.
Figure 15-14 The Retro Stop incident definition properties
5 Do the following as needed:
a) If you need to change the name of the incident definition, edit
the text in the Name field.
b) If you need to edit or enter a code for the incident definition,
edit the text in the Code field.
c) If you need to change the incident category to which the
incident definition is applied, click the down-arrow in the
Category field and select from the list.
Leaving the selection set to All makes the definition available
in all incident categories.
d) If you need to change the Retro Stop status of the definition,
clear or select the Set as Retro Stop incident checkbox.
Note: The Retro Stop status of the incident is indicated by a red letter R
superimposed over the bottom left corner of the icon , in the column to the
left of the definition name. If you remove the Retro Stop status, the letter R is
removed from the icon. However, deactivating the Retro Stop incident does not
remove its status.
Retroactive Incident Editing
CDC Factory 7.1
ActivEssentials Administration Guide
15-18
e) If you need to change the active status of the definition, clear
or select the Active checkbox.
6 Click OK.
Adding Retro Stop Enabled Incident
Categories to an Asset
Use the instructions below to add a Retro Stop enabled incident
category to an asset. You can add more than one incident category to
an asset, and if the Retro Stop incident definition has been applied to
all incident categories, each category can be Retro Stop enabled.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Data Collection Configuration task
module using the instructions in Opening the Data Collection
Configuration Module on page 7-3.
Procedure
1 In the Plant Hierarchy frame, navigate to and select the
appropriate asset.
The grid refreshes to display all of the incident categories assigned
to the asset.
2 Click the New button on the toolbar.
The Add Collection Category to Asset wizard starts.
3 Click Next to move past the Welcome page.
The Category Definition page opens.
Note: With the exception of enabling/disabling the Retro Stop status, the other
properties can be edited directly in the grid by either double-clicking and editing
the text, or by clicking to reveal a down-arrow and then selecting from a
drop-down list.
Retroactive Incident Editing
CDC Factory 7.1
ActivEssentials Administration Guide
15-19
Figure 15-15 The Category Definition page
4 Click the down-arrow by the Name field and select an incident
category from the list.
Only the categories that have not been added to the asset are
listed.
5 Click Next.
Figure 15-16 The Collection Category Properties page
Note: The Category Definition page of the wizard gives options for operator
acknowledgment and to return data to the PLC. Retro Stop does not require
these options, so if the category is used solely for the Retro Stop incident
definition, do not select these.
Retroactive Incident Editing
CDC Factory 7.1
ActivEssentials Administration Guide
15-20
6 In the Collection Category Properties page, first select the
Priorities enabled checkbox, and then select the Set as Retro
Stop incident category checkbox.
7 Click Next.
8 Review the definition, then click Finish.
A red letter R is superimposed over the bottom left corner of the
icon , in the column to the left of the category name.
Adding the Retro Stop Incident Item to an
Asset Using a Wizard
Use the instructions below to add the Retro Stop incident data item to
an asset. In order to use Retro Stop with an asset, you must first add
an incident category that is Retro Stop enabled, and then add the
Retro Stop incident definition.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, open the Data Collection Configuration task
module using the instructions in Opening the Data Collection
Configuration Module on page 7-3.
Set one incident category as Retro Stop enabled and define one
incident as the Retro Stop incident, using the instructions in Adding
Retro Stop Enabled Incident Categories to an Asset on page 15-18.
Procedure
1 In the Plant Hierarchy frame, expand the tree and then select the
appropriate asset.
The grid refreshes to display all of the incident categories assigned
to the asset.
2 In the Collection Configuration frame, expand the Collection
Categories tree and then select the incident category that needs
the Retro Stop incident definition.
The grid refreshes to display all of the incident definitions available
for use with the asset under the selected incident category.
Note: You need also to set the incident category as Active, but you cannot do so if
there are no active incident definitions assigned to the category. If you activate
it before adding a definition, the database will deactivate it later. The remainder
of the options may only be necessary if you add other incident definitions.
Note: After adding the new incident category, you must then add the Retro Stop
incident definition, and set the incident category to active by editing the
category properties.
Retroactive Incident Editing
CDC Factory 7.1
ActivEssentials Administration Guide
15-21
3 On the toolbar, click the New button.
The Add Incident Item to Asset wizard starts.
4 Click Next to move past the welcome page.
Figure 15-17 The Add Incident Item to Asset wizard
5 Clear the New item checkbox, if selected.
6 Click the ellipsis button to the right of the Name field.
Figure 15-18 The Global Definition Items dialog box
7 Scroll through the global definitions to find the Retro Stop incident
data item, and select it.
Note: If you have numerous incidents defined and you are sure of the name of the
Retro Stop incident definition, it is easier to add the incident definition directly in
the grid.
Retroactive Incident Editing
CDC Factory 7.1
ActivEssentials Administration Guide
15-22
8 Click OK to return to the wizard, then click Next.
Figure 15-19 The Incident Item Properties wizard page
9 In the Access path field, type the name of the OPC server.
10 In the cell in the OPC item column, do the following:
a) Click the ellipsis button
Figure 15-20 The AppCenter OPC Item Browser
b) Browse to and select the OPC item.
c) Click OK.
Note: There may be several pages of definitions available, so you may need to use
the back and forward buttons to find the Retro Stop definition. The name will be
the same as the one you used when creating the definition.
Retroactive Incident Editing
CDC Factory 7.1
ActivEssentials Administration Guide
15-23
11 In the OPC item field, do the following:
a) Click the ellipsis button
Figure 15-21 The AppCenter OPC Item Browser
b) Browse to and select the OPC item.
c) Click OK.
12 Click Next.
13 Review the definition, and click Finish to save it.
Adding the Retro Stop Incident Item to an
Asset Using the Grid
Use the instructions below to add the Retro Stop incident data item to
an asset. In order to use Retro Stop with an asset, you must first add
an incident category that is Retro Stop enabled, and then add the
Retro Stop incident definition.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, open the Data Collection Configuration task
module using the instructions in Opening the Data Collection
Configuration Module on page 7-3.
Set one incident category as Retro Stop enabled and define one
incident as the Retro Stop incident, using the instructions in Adding
Retro Stop Enabled Incident Categories to an Asset on page 15-18.
Note: If you already know the OPC item address, you can double-click the cell and
type the address there.
Retroactive Incident Editing
CDC Factory 7.1
ActivEssentials Administration Guide
15-24
Procedure
1 In the Plant Hierarchy frame, navigate to and select the
appropriate asset.
The grid refreshes to display all of the incident categories assigned
to the asset.
2 In the Collection Configuration frame, expand the Collection
Categories tree and then select the incident category that needs
the Retro Stop incident definition.
The grid refreshes to display all of the incident definitions available
for use with the asset under the selected incident category.
3 Double-click the cell in the Name column and type the name of the
Retro Stop incident.
4 Double-click the cell in the Access Path column and type the
name of the OPC server.
5 In the cell in the OPC item column, do the following:
a) Click once to reveal an ellipsis button.
b) Click the ellipsis button
Figure 15-22 The AppCenter OPC Item Browser
c) Browse to and select the OPC item.
d) Click OK.
Note: If you have numerous incidents defined and you are sure of the name of the
Retro Stop incident definition, it is easier to add the incident definition directly in
the grid.
Note: If you type the name incorrectly you will create a new locally defined incident
definition that has no connection to the purpose of Retro Stop. This incident
would then apply to the selected asset only. For this reason, you must be sure
of the name of the Retro Stop incident.
Retroactive Incident Editing
CDC Factory 7.1
ActivEssentials Administration Guide
15-25
6 Double-click the cell in the Trigger column and type the required
value.
7 Double-click the cell in the Priority column and type a priority
value that ensures that the Retro Stop incident has the highest
priority.
8 Select the checkbox in the cell in the Active column.
9 Click on any other row in the grid to save your changes.
Enabling Incident Categories to Use Retro
Stop
Use the instructions below to enable incident categories to use Retro
Stop. If the Retro Stop incident definition has been made available to
all incident categories, you can set more than one incident category as
a Retro Stop category for any one asset.
Prerequisites
Before doing this you need to have done or read the following:
If necessary, log on to MI Admin using the instructions in Logging
onto MI Admin on page 1-4.
If necessary, open the Data Collection Configuration task
module using the instructions in Opening the Data Collection
Configuration Module on page 7-3.
Created a Retro Stop incident definition using the instructions in
Creating the Retro Stop Incident Definition on page 15-14.
Procedure
1 In the Plant Hierarchy frame, navigate to and select the
appropriate asset.
The grid refreshes to display all of the incident categories assigned
to the asset.
2 Do one of the following:
a) Select the appropriate incident category in the grid, and click
the Properties button on the toolbar, or
b) Right-click the appropriate incident category in the grid, and
select Properties from the context menu.
A dialog box opens displaying the properties for the incident
category.
Note: If you already know the OPC item address, you can double-click the cell and
type the address there.
Note: You have completed the procedure for adding the Retro Stop incident definition
to the asset.
Retroactive Incident Editing
CDC Factory 7.1
ActivEssentials Administration Guide
15-26
Figure 15-23 Incident category properties
3 Ensure that both the Priorities enabled and Set as Retro Stop
incident category checkboxes are selected.
4 If you need to set the incident category as active, select the Active
checkbox.
5 Click OK.
Configuring the HMI
ActivEssentials is not able to communicate directly with PLCs, so you
must either configure the HMIs you use to communicate in the way
needed, or re-program the PLCs to work in the way intended. For
these actions to work, the HMI and the PLC must use the same logic.
Note: If there is not a Set as Retro Stop incident category checkbox on the dialog
box, you have not enabled Retro Stop in the system settings. See Setting up
Retro Stop in the System Settings on page 15-12 for more information.
Note: The remainder of the options are not required for the operation of Retro Stop.
However, if you have added other incident definitions to the category these
may be required.
Note: This document cannot give you instructions for the programming necessary in
either the HMIs or PLCs. For assistance with re-programming, you will have to
consult the documentation for each, or contact the providers of the HMI
software and/or the manufacturers of the PLCs.
Retroactive Incident Editing
CDC Factory 7.1
ActivEssentials Administration Guide
15-27
The four actions the HMI/PLC must complete for the Retro Stop
function to work effectively are:
When the operator presses the Retro Stop button, the HMI
software must send a trigger to switch the original incident
description Off.
As the original incident switches off, the HMI must also send a
trigger to switch the Retro Stop incident On.
When the operator enters the replacement incident description, the
HMI must send a trigger to switch the Retro Stop incident Off.
As the Retro Stop incident switches off, the HMI must also send a
trigger to switch the new incident On.
Although the actions here represent the actual course of events, the
records held in the database will indicate that the original and Retro
Stop incidents did not occur, and that the new incident started at the
same time as the original incident.
The Retro Stop System Settings
In order for Retro Stop to function it is necessary to adjust two of the
ActivEssentials system properties. These are:
Retro Stop Allowed Gap. The allowed gap is the maximum time
between the database records for the end time of the original
incident and the start time of the Retro Stop incident, and the end
time of the Retro Stop incident and the start time of the
replacement incident. These timings are not a reflection of the
actions of the operator, but of the time stamps in the database.
The allowed gap should be sufficient to account for any network
delays. See How the Database Handles Allowed Gap Timing Errors
on page 15-7 for an understanding of how the allowed gap controls
how database records are recorded.
Enable Incident Retro Stop. The enablement of Retro Stop is
required to set up the Retro Stop incident definition and enable the
use of the Retro Stop definition with the incident categories. If you
do not enable this setting, the appropriate checkboxes are missing
from the wizards and property pages. Disabling the Retro Stop
incident does not remove it from the database, but only changes
its status. The same is true of any incident categories that use
Retro Stop. Re-enabling restores both the incident and the
categories to their former condition.
Effect of Disabling Incident Priorities
For Retro Stop to function you must set each of the incident categories
where it is used such that priorities are also enabled. Retro Stop
requires the enablement of priorities so that when it is invoked its
higher priority brings to an end the lower priority incident.
The ActivEssentials database is designed to recognize if priorities are
disabled on a Retro Stop enabled incident category. If you disable
priorities, the database also disables the use of Retro Stop. Enabling
incident priorities occurs at the asset level, so if priorities are disabled
for an incident category, the change affects only the selected asset.
Retroactive Incident Editing
CDC Factory 7.1
ActivEssentials Administration Guide
15-28
The Retro Stop incident definition can be made available to all incident
categories. If more than one Retro Stop incident category is applied to
an asset and priorities are disabled on one, the change does not affect
any of the other incident categories.
If you need to disable incident priorities, open the incident categories
properties dialog box as described in Enabling Incident Categories to
Use Retro Stop on page 15-25. If you clear the Priorities enabled
checkbox, ActivEssentials also clears and then disables the Set as
Retro Stop incident category checkbox. See the screenshot below,
which illustrate the effect of disabling priorities in the dialog box:
Figure 15-24 Effect of disabling priorities
If you need to re-enable Retro Stop, you will need to select both the
Priorities enabled and Set as Retro Stop incident category
checkboxes. See Enabling Incident Categories to Use Retro Stop on
page 15-25 for more information.
CDC Factory 7.1
ActivEssentials Administration Guide
i
Glossary
Access path
The name of the device from which the OPC Server is receiving
data. ActivEssentials uses this name as part of the definition of
data.
Accumulators
(i) An ActivEssentials collection method used to collect items that
increment over time, such as counters and timers.
(ii) Data items collected using this method.
Acknowledgment
(i) A manual response to an event; for example, by clicking an OK
button.
(ii) An automatic response to an event, in which Activplant
automatically sends a message to a specific PLC address when the
event happens. The acknowledgment may trigger another event in
the PLC.
ActivEssentials
The core components of the Activplant solution. They handle the
collection, storage, and presentation of manufacturing data.
Aggregation method
A method of summarizing and presenting data, such as Total,
Average, etc. in VPWeb, calculations, and data warehousing.
Glossary
CDC Factory 7.1
ActivEssentials Administration Guide
ii
Alarms
Machine problems which are a cause for concern but do not stop the
machine. Alarms are collected using the Incidents collection method.
Alias
An alternative identity, used in Activplant to give a convenient name to
an identifier value or other item.
Allowed gap
The minimum time allowed between identical incident or identifier
database records. If the time is less than the allowed gap, the records
will be merged into one.
Alphanumeric
(i) Containing letters, numbers, or symbols.
(ii) A data item representing a string value in the PLC. For example, a
string value collected when an event occurs.
Alphanumeric variables
String values, available only in raw form, and used in Detailed View
and Layout View, and VPWeb reports.
AppCenter
A web client that hosts other ActivEssentials applications, such as
VPWeb and MI Admin. (Other applications can be added to AppCenter.)
Application
A container that stores a collection of templates for use in MI Admin.
Archive
A job created in the Data Managment module, whereby data belonging
to a data category is regularly archived.
Archive file hierarchy
The relationships between different archive files. For example, an
event variable archive cannot be restored without an event archive.
The event archive has a hierarchy level of 1 and the event variable
archive has a level of 2.
Asset
(i) The lowest level of the plant hierarchy, usually representing a
machine. A point at which data collection occurs.
(ii) A piece of machinery that is capable of functioning independently,
and from which data is collected.
Asset States
An ActivEssentials collection method used to collect the current state
of an asset (for example, Running, Faulted, etc.).
Glossary
CDC Factory 7.1
ActivEssentials Administration Guide
iii
Auto-insert
Used for identifiers, if this option is selected the database
automatically records all values of the identifier in a lookup table.
Available minutes
The number of minutes in an hour that are used for regular
production. This is usually 60, but may be fewer if a break falls in the
hour. Available minutes are factored into productivity calculations so
that an hour containing a break does not appear to be less productive.
Base item
A data item used as a basis for a derived item. The derived item
displays the base item in real time. For example, how many times a
fault has occurred in the current shift.
Bit
A Binary Digit. A bit can be in only one of two possible states, ON or
OFF (1 or 0).
Boolean
Pertaining to logical (true, false) values. Many programming languages
directly support a Boolean data type, with predefined values for true
and false. Usually 0 equals false and not 0 equals true.
BPDU
Basic Process Data Unit (BPDU) is the number of assets that are
processed in an archive and purge job. The BPDU controls the amount
of data that is included in each job. This unit can be set by an
administrator in the System Settings module of AppCenter.
BPTU
Basic Process Time Unit (BPTU) is the frequency with which data is
archived and purged. In APMS, the default frequency is one week
starting on Monday and ending on Sunday.
By Time schedule
A schedule that runs according to a calendar based time frame. By
time schedules can be daily, weekly, or monthly schedules. See also
daily, weekly, or monthly schedules.
Cache
A temporary memory storage area for storing data for rapid reuse.
Calculation template
A calculation building-block that has data items, aggregation method,
etc. defined. The template can be used over and over again to create
calculations for groups or assets.
Glossary
CDC Factory 7.1
ActivEssentials Administration Guide
iv
Category
A group of data items, all of which are collected using the same
collection method. Examples are Faults, Cycle Times, Counters, etc.
The administrator can use any name for the category.
Change-over
A machine idle period in which the machine is being prepared for
production of a new part or batch of parts.
Child
An item in the plant hierarchy, or other hierarchy, that branches off
one level lower than the item selected (the parent) in the interface.
Such items are organizationally subordinate to the selected item, and
may inherit properties of the parent item.
Collection category
A group of data items, all of which are collected using the same
collection method. Examples are Faults, Cycle Times, Counters, etc.
The administrator can use any name for the category.
Collection method
One of several ActivEssentials data formats for data collected from the
PLCs. See Accumulators, Events, Incidents, Identifiers, Asset States.
Every data item is collected using one (and only one) collection
method. The system administrator decides which one is used for each
data item.
Comma-separated values
A text file in which separate items of tabulated data are separated by a
comma. Other applications, such as Microsoft Excel, can read such a
file and convert it to a spreadsheet or table.
Concatenation
The process of running two or more string values together to create a
longer string. For example, concatenation of a, b. and c results in abc.
Constant
In calculations, a value that does not change over time, such as a
keyboard-input number or a numeric property of a group or asset. May
also be the result of a data item viewed over the current time frame in
VPWeb.
Context menu
Menu available in applications that is available when you right-click.
The menu shows the options available at the particular place where
the menu is selected.
Counter
A data item that increments by 1 every time a particular event occurs,
e.g. a production counter.
Glossary
CDC Factory 7.1
ActivEssentials Administration Guide
v
Cycle time
The time taken for a machine to produce a single unit of output before
repeating the process.
Daily schedule
A schedule in which the interval between each occurrence is measured
in days.
Data collection template
A standard pattern of data items and memory addresses used in PLC
programming in preparation for data collection.
Data item
A value stored in the memory tables of a PLC or other Device. The
value can be read by ActivEssentials.
Data age
A term used in the Data Management module of AppCenter. The
maximum age that data can reach before it is archived.
Data swap
Term used for transferring separately stored data into the appropriate
location in the database. Used only in Daylight Savings Period change.
Data type
Classes of data stored for each data category that is archived. Each
data category contains different data types, and can be viewed
through the archive logs.
Deadband
A range of values that are ignored. For example, temperatures
between 45 and 60 degrees may be ignored, while values outside this
range are recorded.
Default property
For identifiers and tasks, a property that is used as a default if there
are no other properties defined.
Default value
A value used in calculations where there is no specific database record
available. The default value may be the value of the previous record,
or some other value that is inserted.
Derived identifier
A time-based calculation. Time-based calculations allow you to
combine identifier values so that you can see, for example, when
Batch Number 2435 of Part Number 2100 was being produced.
Glossary
CDC Factory 7.1
ActivEssentials Administration Guide
vi
Derived item
A real-time data item that presents a historical data item in the
context of a time frame. For example, the number of times a fault
code has occurred during the current shift.
Desktray
The area at the bottom right corner of a computer monitor, containing
the clock and several icons indicating which programs are running in
the background.
Domain
A group of networked computers and users defined by a security
boundary. Security policies and settings do not cross from one domain
to another.
E-stop
An emergency stop, usually by the machine operator pressing a
button.
Event
A data item collected using the Events collection method. When the
event fires, the event variables associated with it are collected.
Event variable
A data item in the PLC that is collected using the Events collection
method, such as a temperature or pressure. The variables can be
numeric or alphanumeric, and more than one variable can be collected
for a given incident.
Events
An ActivEssentials collection method used to collect data items as a
snapshot reading, such as Temperature or Pressure.
Fault
A machine problem which stops the machine. Faults are collected
using the Incidents collection method.
Federated database
A set of databases that are linked so that data can be distributed
among, or accessed from, any of them.
Formula
A generic mathematical expression used as a building block for a
calculation.
Group
A department, area, or production line in the plant hierarchy.
Glossary
CDC Factory 7.1
ActivEssentials Administration Guide
vii
Hi
A high value of a data item that is cause for concern but is not
dangerous. Compare to HiHi.
HiHi
A high value of a data item that is regarded as dangerous. Compare to
Hi.
Historical data
Data that has already been stored in the database and is retrieved
from there. Compare to real-time data. Note that historical data may
only be a few seconds old.
Identifier
A data item collected using the Identifiers collection method. An
identifier identifies a period of time in the manufacturing process, such
as batch number, serial number, etc.
Identifiers
An ActivEssentials collection method used to collect data items that
identify a period of time in the manufacturing process, such as Batch
Number.
Illegal characters
Typographical characters, such as a double quote (), that may create
errors when used in names or other items.
Incident
A data item collected using the Incidents collection method that
includes a start time and an end time, used particularly for faults,
alarms, etc.
Incident sub-category
A sub-group of incident data items that can be used to isolate
incidents, such as those occurring in a group of devices such as
pumps.
Incidents
An ActivEssentials data collection method that includes a start time
and an end time, used particularly for faults, alarms, etc.
Layout View
A graphical VPWeb view that includes images, lines, and controls that
display data items.
Lo
A low value of a data item that is cause for concern but not dangerous.
Compare to LoLo.
Glossary
CDC Factory 7.1
ActivEssentials Administration Guide
viii
LoLo
A low value of a data item that could be dangerous. Compare to Lo.
Mathematical function
A standard function used in formulas and calculations, such as Square
Root, Exponent, etc.
Memory template
A standardized memory map for a PLC, showing the location of all the
data items that are to be collected. While a template is not mandatory
in Activplant, it is easier to locate data items if you use one.
Merge Identical Values
For non-unique identifiers, this option causes consecutive, identical
database records to be merged if the Allowed Gap is not exceeded.
Merging
Used in incidents and non-unique identifiers, this option causes
consecutive, identical database records (usually caused by a network
interruption) to be merged if the Allowed Gap is not exceeded.
MI Admin
The administrator component of Activplant/ActivEssentials 4.0 and
later, replacing the VPAdministrator of earlier versions. MI Admin runs
in AppCenter and is used to configure the data collection system.
Monthly schedule
A schedule in which the interval between each occurrence is measured
in months.
Non-productive shift period
A shift period in which no production occurs, such as a break period.
Non-standard shift period
An exceptional shift period that extends the length of the shift.
Non-unique identifier
An identifier whose value can recur, such as a part number. Compare
unique identifier.
Numeric variable
A data item (variable) that consists only of numbers. The value is
collected when the associated event occurs.
Microsoft Message Queuing
A message queuing application that supervises the transfer of records
to a database. Also known as MSMQ.
Glossary
CDC Factory 7.1
ActivEssentials Administration Guide
ix
MSMQ
See Microsoft Message Queuing
Object
(i) A software process that is initiated by the code and then
terminates.
(ii) An item in the VPAdministrator window, such as a Plant, Asset,
Group, Shift Schedule, Task, etc.
Object Library
A repository in AppCenter that is used to store objects that can be
reused in the plant hierarchy.
OPC
OLE for Process Control (OPC). An initiative of the automation industry
that led to the publication of Data Access standards for devices such as
PLCs. OPC is administered by the OPC Foundation.
OPC real-time item
A data item that is collected only in real-time and is not stored in the
database.
OPC server
A software application that acts as an interface between devices such
as PLCs and other software. The OPC server reads PLC data tables and
presents the data in standard format.
Parent
An object in a hierarchy that resides at one level above the item
selected in the interface (the child).
Plant
The manufacturing facility. In ActivEssentials, the highest level of the
plant hierarchy, representing the ActivEssentials database.
Plant hierarchy
A branching concept in which groups and assets are arranged in
parent-child relationships, similar to the structure of folders and files
on a computer. Groups represent production lines, departments, etc.
while assets represent points of data collection.
PLC
Programmable Logic Controller. A solid-state device used to control the
operation of machinery in an automated manufacturing plant. The
term PLC is actually a trademark of Allen-Bradley.
Glossary
CDC Factory 7.1
ActivEssentials Administration Guide
x
Priority
Applies to incidents and to asset states. If two incidents and/or states
occur at the same time, the priority determines which one takes
precedence and is recorded in the database.
Privilege word
The value in the database that describes the privileges assigned to an
individual user of the system. It is calculated from the privileges that
belong to roles and users on different plant hierarchy objects.
Productive shift period
A shift period in which production continues, in contrast to a break
period.
Publish to Web
To save an ActivEssentials report in a format that allows it to be
viewed in a web browser.
Purge job
A database job that deletes data that is marked for deletion.
Query Builder
Application used to create datasets for use in APRS Query Server
reports.
RAID
Redundant Array of Independent Disks. The use of multiple,
synchronized hard drives in a computer so that failure of a disk does
not result in loss of data.
RTLE
Real-Time Logic Engine. An OPC bridge used to collect and manipulate
data items from up to 24 OPC servers.
Real-time data
Data that comes directly from the OPC server or from the real-time
data cache, instead of from the database. It is therefore available
immediately. In practice, there is about a 1-second delay, depending
on network traffic.
Report category
A container for similar kinds of reports created in the Reports
Administration module.
Report distribution
One of the methods for sending reports to users. In this method, a
report is generated automatically and sent to an e-mail account, to a
network folder, or an FTP site. See also Scheduled report.
Glossary
CDC Factory 7.1
ActivEssentials Administration Guide
xi
Report schedule
An automatic scheduling scheme for the production of reports; for
example, at 9am every day.
Report server
In the Reports Administration module, this is a computer that hosts a
reporting service.
Report style
A set of properties governing the way data is displayed in reports,
from any given set of data. The style is an XSL stylesheet that controls
what data is displayed, as well as its formatting.
Report template
A set of report parameters that can be used to generate reports many
times. The template contains information such as a time frame, data
items, and the groups or assets to which the report should refer.
Reports Viewer
A VPWeb view for creating and viewing reports.
Reports Administration
A module in AppCenter where the reporting system is managed.
Role
A group of users defined in the Security module of Activplant. The role
has privileges belonging to it and all members of the role share those
privileges (unless they are modified for individual users).
Roll-over
A predefined value for a counter or timer in the PLC at which the
counter or timer re-sets itself to zero.
Sampling frequency
The frequency at which a process variable is measured. The frequency
is defined in MI Admin.
Schedule
(i) A job that runs according to a frequency that you define. A schedule
could be to generate reports, or process archive and purge jobs.
(ii) In the Shift Configuration module this refers to the completed shift
definition, which consists of a sequence of daily schedules.
Scheduled report
One of the methods for sending reports to users. In this method, the
report is generated automatically and sent to a users report folder, or
to a shared folder. See also Report distribution.
Glossary
CDC Factory 7.1
ActivEssentials Administration Guide
xii
Shift calendar
The calendar of dates on which shift schedules start or finish. For
example, a factory may have a summer schedule and a normal
schedule.
Shift period
A subdivision of a production shift, such as an hour or a lunch period.
A shift period may be productive or non-productive, standard or
non-standard.
Shift rotation plan
A sequence of one or more shift schedules applied to groups or assets.
Each group or asset only has one rotation plan at any time, but the
user can modify the plan.
Shift schedule
The arrangement of production shifts during the day.
Shift schedule type
A set of daily shift schedules (for example, Monday to Friday). The
shift schedule types may span less or more than a week.
Shift structure
The assembly of shift periods that can be assigned to a shift. A shift
structure consists of at least one shift period, but cannot contain
non-standard periods.
Solicited accumulator
An accumulator data item that is collected in the PLC. Compare to
unsolicited accumulator.
Solicited data collection
Collection of data by active polling (reading) of the PLC memory
tables. Compare triggered data collection or unsolicited data
collection.
Standard shift period
A shift period that does not extend the length of the shift.
States
An ActivEssentials collection method that collects the state of an asset.
Subscription
(i) In the Reports Administration module, a users folder. This folder
contains reports that a user has requested (that is, subscribed to).
(ii) The method to send reports to a users Subcriptions folder.
Template folder
A virtual file system for report templates used in ActivEssentials.
Glossary
CDC Factory 7.1
ActivEssentials Administration Guide
xiii
Throughput Analyzer
A solution that uses manufacturing data supplied by the
ActivEssentials to identify manufacturing constraints.
Time-out
A time period after which an action has to be performed again. It is
used for user sessions, in which a period of inactivity will result in a
user having to log on again; it is also used for database activity or
other transactions.
Time picker
A small window that is used to define the time frame of the data to be
displayed.
Time-sensitive property
For identifiers, a property that changes automatically at a predefined
time.
Time span
A discrete period of time used to define the time frame of data to be
displayed for example, two hours.
Timer
A data item that uses the Accumulators collection method to measure
elapsed time. Timers increment in the PLC to a roll-over value.
Trigger
A value in the PLC that causes a second data item to be collected from
a different PLC address.
Triggered sample event
An event in which data is collected when a trigger occurs, and then
sampled at a predefined rate or when the trigger stops.
Triggered data collection
Collection of a data item when a separate value in the PLC (trigger
value) changes. Compare solicited data collection. Also called
unsolicited data collection.
Unsolicited data collection
The collection of data prompted by a separate event (trigger) in a PLC.
Unsolicited accumulator
An accumulator data item that is collected by VPCollector when a
defined trigger value occurs in the PLC. Compare to solicited
accumulator.
Unique identifier
An identifier that does not recur, such as a serial number.
Glossary
CDC Factory 7.1
ActivEssentials Administration Guide
xiv
Unknown value
The value that is to be stored in the database if an identifier value is
unknown.
URL
Uniform Resource Locator. A web site address, such as
www.activplant.com.
Variable
(i) A data value that is collected using the Events collection method.
For example, a temperature or pressure value.
(ii) In computer terms, a piece of memory set aside as a container for
a value.
View
A window in VPWeb that can display a certain type of data; for
example, Production View.
VPCollector
The data collection engine of ActivEssentials. VPCollector reads data
from the OPC server that receives it from the PLC.
VPFoundation
The heart of ActivEssentials, it is the component which handles the
storage and serving of data.
VPQManager
The ActivEssentials message queuing component that inserts the data
collected by VPCollector into the database.
VPWeb
A container on the client side of ActivEssentials that contains several
views that are used to display different kinds of manufacturing data in
Internet Explorer.
Weekly schedule
A schedule in which the interval between each occurrence is measured
in weeks.
Working folder
A network folder designated to receive the files created by archive
jobs. The files can be moved elsewhere after archiving.
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
CDC Factory 7.1
ActivEssentials Administration Guide
xv
Symbols
$ReportDeliveryServer$ 10-8
$ReportURLAccessUser$ 10-8
.Net Framework, AppCenter requirement 1-8
A
Abbreviation, for units of measurement 2-12
Access level, changing for network group 10-36
Accumulators
caching values 6-5, 6-7, 6-16
collection in the PLC 7-146
collection method 7-17
database record creation 7-146
default rollover value 3-17
defining on assets 7-75
expressions to filter 7-145
filtering 7-79
global, creating 7-20
global, deleting 7-28
global, editing 7-27
global, used once per asset 7-77, 7-87
icons for 7-10
lag time in derived items 8-54
limit of 10000 per VPCollector 6-20, 7-19
linking with identifiers 7-79, 7-94
local 7-75
names, used only once 7-19
report templates 14-68
rollover value, default 3-17
rollover value, for individual items 3-18
rollover value, maximum 7-146
rollover value, on asset 6-18
solicited and unsolicited 7-79, 7-146
solicited, caching values 6-5, 6-16
time change, effect on 2-16
trigger values 7-79
types of 7-22
VPCollector stoppage, effect on 6-16
Acknowledgment
events 7-97, 7-114, 7-148
incidents 2-6, 7-14, 7-74
Actions
process of purging data 13-20
processing options for archive definitions
13-19
ActivApplications
detaching templates 4-77
removing templates 4-79
resynchronizing asset configuration 4-84
tasks 4-12
ActivEssentials
basic functions, in calculations 8-8, 8-23
control panel 6-13, 6-14
license key 3-2
licensing 2-2, 2-3, 4-47
ActivEssentials database
backward compatibility and upgrade 13-2
introduction to archiving 13-11
reports and restore schedules 12-1, 12-2
ActivEssentials error messages, See Error mes-
sages
ActivEssentials schedules, creating 12-13
ActivEssentials tasks, role of schedules 12-9
Activplant desktray icon 6-13
Activplant Requirements dialog box 1-3, 1-8
Administrator user 10-8
Advanced VPWeb User role 10-5
Aggregation methods
calculations 8-5, 8-32
derived items 8-57
descriptions 8-32
Aging of data, when to archive 13-19
Alarm, defining a trigger to initiate 12-22
Alias for identifiers 7-51
Allowed Gap
identifiers 6-16, 7-52
identifiers and incidents 7-17
incidents 6-16
Retro Stop 15-7, 15-27
time change, effect on 2-17
Alphanumeric
calculations 8-10
event variable, expressions in 7-148
event variables, creating 7-126
formulas, creating 8-16
variables, icons for 7-10
AppCenter
appearance See Skins
connection integrity monitor 1-18
connection to VPFoundation 1-18
deleting objects 1-20
documents 1-18
Index
Index
CDC Factory 7.1
ActivEssentials Administration Guide
xvi
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
freezing 1-18
Internet Explorer requirements 1-8
JavaScript requirement 1-8
locking 1-6, 1-11
logging on to 1-4
MSXML requirement 1-8
operating systems 1-8
options 1-11, 1-19
preferences 1-20
prerequisites 1-8, 1-24
refreshing data 1-11
response error 1-19
restarting 1-6, 1-11
shutting down 1-6, 1-11
software requirements 1-8, 1-24
status bar 1-18
system requirements 1-3
taskbar 1-12
taskbar toggle 1-13
URL for 1-4
VPFoundation crash, effect on 1-19
VPFoundation, connection to 1-18
web address 1-4
AppCenter objects
applying to plant hierarchy 1-21
copying and pasting 1-20
deleting 1-20
editing 1-20
finding and replacing 1-21
sorting 1-21
AppCenter requirements
.Net Framework 1-8
Direct Animation 1-8
Internet Explorer 1-8
JavaScript enabled 1-8
MDAC 1-8
MSXML 1-8
operating systems 1-8
VML 1-8
Append data, rules applied before restoring 13-88
Application maintenance 4-774-93
Application Template Management 4-24-93
Application templates
configuration template types 4-3
introduction 4-2
licensing for assets 4-47
purpose of asset templates 4-3
purpose of configuration templates 4-2
Applications
creating 4-41
creating a workbook from 4-57
description 4-8
exporting 4-56
found in Plant Management module 4-11
import options 4-14
importing 4-52
initial set up 4-414-75
introduction 4-8
process when importing templates 4-14
processing workbooks 4-65
reimport options at asset level 4-35
reimport options for existing applications 4-25
reimporting with options 4-15
specifying import options 4-58
where stored 4-8
Applications and templates 4-84-12
APRS Query Server 14-19
APRS reporting system, initial set up 14-2
APRS SP report provider 14-19
APRS SP report, Incident Reason Code reports
14-64
APRS SP-XML report
data items for 14-59
time frame for 14-55
wizards for reports 14-67
APRS SP-XML report provider 14-18
APRS system settings 2-22-10
Archive and purge data
manual data editing rules 13-88
versus table partitioning 13-11
Archive configuration
best practices 13-25
purpose 13-4
summary of tasks 13-8
Archive definition
data types in collection methods 13-18
deleting 13-50
editing properties 13-52
groups and assets in the archive scope 13-18
information needed when defining 13-23
new 13-36
oldest data 13-19
properties in Detailed Log for Data Types 13-29
purging as a part of 13-20
viewing properties 13-52
Archive detailed logs, viewing 13-60
Archive file management 13-2213-25
Archive files
data integrity 13-25
external storage 13-24
naming convention 13-92
properties of 13-24
rules for handling 13-94
secure binary format 13-25
warning against renaming 13-24
where stored 13-24
Archive jobs, role of SQL Server 13-44
Archive logs 13-2613-31
managing the various log types 13-35
Index
CDC Factory 7.1
ActivEssentials Administration Guide
xvii
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
overview 13-26
viewing master logs 13-57
Archive Logs view
filtering Master log information 13-58
summary of tasks 13-9
Archive only data, manual data editing rules 13-87
Archive schedules
deleting
modifying 13-46
setting up 13-40
Archive settings
editing 13-45
settings needed for Data Management 13-13
Archive structure, how archives are built 13-16
Archived data
See also Data
in older versions of database 13-2
restoring 13-70
verifying data integrity 13-95
Archiving
See also Data archiving
archive files described 13-92
automatic process 13-94
data archived by BPTU
data in BPDU 13-91
database management 13-90
database process 13-96
Daylight Saving Time data 13-101
limitations to manual tasks 13-85
options for 13-17
role of BPDUs 13-91
system settings required 13-16
Archiving data, overview 13-1113-21
Archiving scope, See Scope 13-16
Asset properties, use with asset templates 4-5
Asset states 7-1327-141
adding to an asset 7-137
collection method 7-17
color associated with 7-134
comparison to other collection methods 7-170
copying between assets 7-140
copying within an asset 7-136
creating 7-132
data available for export 7-172
deleting 7-136
deleting from asset 7-141
editing 7-135
exporting configuration 7-152
filtering not used 7-143
global, not local 7-7, 7-93, 7-132
icons for 7-10
importing new states for an asset 7-166
not collected by VPCollector 5-2
priority of 7-132, 7-142
properties of 7-135
use in asset templates 4-5
Asset templates
ActivApplications tasks 4-12
applying 4-70
applying vs. reapplying 4-29
asset level tasks 4-11
asset states 4-5
collected data 4-3
collection configuration 4-4
creating a new template 4-42
initial set up 4-414-75
options when applying 4-28
options when reapplying 4-29
options when removing 4-38
role of RTLE configuration 4-5
scope when applying 4-28
use of asset properties 4-5
use of calculations 4-5
use of OPC item name spaces 4-10
use of RTLE item device names when defining
4-11
validating 4-75
variations in plant hierarchy structures 4-10
viewing configuration reports 4-93
viewing template definition reports 4-90
viewing usage reports 4-91
VPWeb views 4-5
ways to apply 4-29
Assets
accumulator data items, adding 7-75
activating and inactivating 3-16
applying templates to 4-70
asset states, adding to 7-137
calculations, copying between 8-46
categories, adding to 7-71
categories, copying between 7-14
changing template removal options 4-82
copying 3-12, 3-13
creating 3-9
creating calculations for 8-368-44
creating, effect on shift schedules 9-50
defining data items on 7-707-92
definition of 1-14, 3-3
deleting 3-11
deleting large numbers of 3-4
deleting shift rotation plan 9-50
derived items, copying between 8-55
detaching asset templates 4-77
editing 3-15
editing shift rotation plan 9-50
event items, defining on 7-1107-130
exporting asset state configuration 7-152
exporting data collection configuration 7-151,
7-169
Index
CDC Factory 7.1
ActivEssentials Administration Guide
xviii
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
extended properties 11-7
identifier data items, adding 7-85
incident data items, adding 7-81
linking incidents and incident sub-categories on
7-38
lowest level of plant hierarchy 3-3
maximum number per group 3-4
number allowed by license 2-3
OPC server assigned to, determining 3-16
OPC server, assigning to 5-12
OPC server, changing 5-13
properties 3-14
properties of data items 7-89
refreshing VPCollector when adding data items
7-70
removing asset templates 4-79
resynchronizing with template 4-84
Retro Stop incident categories 15-18
rollover value set on 3-17, 6-18
security requirements to add shift schedules
9-47
states See Asset states
template asset 1-25, 3-7, 3-9, 7-11
variables limited to 1125 per asset 7-19
VPCollector information for 3-16
VPCollector used by, determining 6-9
VPCollector, assigning 6-8
VPCollector, changing 6-10
Assets, choosing for reports 14-54
Attributes
defined with new identifiers 7-43
in identifier extended properties 7-45
Audit log, for shift editing 9-1029-105
example 9-103
Audit Logs 9-66
Auto-insert (identifiers) 7-44, 7-87
Auto-refresh, option for reports 14-64
Available minutes, in calculations 8-8
B
Backup files, See Archive files 13-24
Base item, for derived items 8-52, 8-57
Base Object Value, when defining parameters 4-10
Basic Process Time Unit, See BPTU
Basic Processing Data Unit, See BPDU 13-91
Batch number, example of identifier 7-42
Best practices
archive configuration 13-25
configuring data items 7-11
data types and VBScript functions 7-99
in daylight saving 2-33
report configuration templates 4-7
update rate for linked identifiers 7-94
Birth History reports 14-68
time frame 14-57
BPDU (Basic Process Data Unit)
controlling database performance 13-91
definition 13-91
determining number needed 13-91
role in purging 13-95
role when defining schedules 13-44
BPTU (Basic Process Time Unit)
definition 13-91
length determination
role in purging 13-95
role when restoring writeable data 13-84
used for restore method 13-84
Breaks, in shift definitions 9-11
Buttons, MI Admin toolbar 1-10
By Time schedules
editing the properties 12-17
recurrence 12-9, 14-24
viewing the properties 12-17
C
Caching accumulator values 6-5, 6-7, 6-16
Calculate Open Incident Duration property 2-7
Calculating privileges 10-11
Calculation templates
copying 8-31
creating and editing 8-258-33
creating calculations from 8-39
data item allocation 8-29
definition 8-5, 8-9
deleting 8-32
editing 8-30
example of 8-9
properties 8-30
used to create calculations on assets only 8-39
Calculations
See also Calculation templates; Formulas
ActivEssentials basic functions in 8-8, 8-23
aggregations in 8-32
alphanumeric 8-10
available minutes in 8-8
building blocks used in 8-6
causes of error 8-47
constants 8-6
copying 8-46
creating from calculation templates 8-39
creating from formulas 8-41
creating from scratch 8-36
creating on assets 8-368-44
default value in 8-5, 8-33
defining 8-28-47
deleting 8-46
editing 8-44
errors in 8-47
Index
CDC Factory 7.1
ActivEssentials Administration Guide
xix
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
inactive data items in 8-49
mathematical functions in 8-5, 8-23
missing from VPWeb 8-49
name change, effect of 8-49
numeric 8-10
opening the Calculations module 8-2
operators in 8-7
order of operations in (BEDMAS principle) 8-48
process of defining 8-3
properties 8-44
resetting VPServer 8-13
standard functions in 8-7
time frame in 8-8
time interval in 8-8
time-based 8-11
troubleshooting 8-47
types of 8-108-12
used in templates 4-5
user-defined functions in 8-8
VPWeb, missing from 8-49
ways of creating 8-47
where used 8-5
Calculations module, opening 8-2
Callback data items 5-3
Cancel Purge Restored Data 13-5
operational limits 13-86
Cancel Re-archive 13-5
operational limits 13-86
Cancel re-process archive, operational limits 13-86
Cancelling
purge of restored data 13-80
re-archive instruction 13-81
re-process of restored data 13-78
restore job 13-76
Cancelling data swap in Daylight Saving 2-28
Categories
adding to an asset 7-71
copying between assets 7-14
creating 7-12
creating new, using export-import 7-155
data archiving 13-18
data available for export 7-172
deleting 6-17, 7-16
deleting, consequences of 6-19
editing 7-15
exporting asset states from assets 7-152
exporting data from assets 7-151
icons for 7-10
illegal characters for names 7-13
incident acknowledgment 7-74
incident category, adding to an asset 7-73
linking incident categories and sub-categories
7-36
names for 7-12
properties 7-15
Category buttons 1-9, 1-12
accessing in minimized taskbar 1-14
Celsius, converting to Fahrenheit 7-131
Changed, notation for Shift Structures 9-63
Changing system settings 2-4
Child groups and assets, deleting 3-11
Cleanup and then restore data, rules applied before
restoring 13-88
Collection categories See Categories
Collection methods
Accumulators 7-17
Asset States 7-17
categories and 7-12
data archived by data types within 13-18
data available for export 7-171
defined as data categories 13-18
description 7-17
Events 7-17
Identifiers 7-17
Incidents 7-17
Collector Configuration module
description 6-3
opening 6-2
Color extended property 11-7, 11-9
Commas, removed when exporting and importing
7-152
Comma-separated values file 7-150, 7-151
Comments, on incidents 2-6
Configuration
effects of changes to 6-19
exporting and importing 7-1507-168
Configuration templates
creating new report configuration template
4-49
creating new shift configuration template 4-48
initial set up 4-414-75
types 4-6
validating 4-75
viewing configuration reports 4-93
viewing template definition reports 4-90
viewing usage reports 4-91
Connection integrity
monitor 1-18
response error 1-19
resuming checking 1-19
Connection, testing for OPC servers 5-11
Constants (calculations)
assigning data items to 8-29
definition 8-4, 8-6
identifier properties as 8-23
items used as 8-4
limited number to be used 8-7
Continue Processing button, daylight saving 2-26,
2-30
Index
CDC Factory 7.1
ActivEssentials Administration Guide
xx
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
Control panel (ActivEssentials) 6-13
Copying
asset states 7-136, 7-140
assets 3-12
calculation templates 8-31
calculations 8-46
categories between assets 7-14
data items between assets 7-92
data items within an asset 7-91
derived items 8-55
extended properties 11-11
formulas 8-20
groups and assets 3-5, 3-12, 3-13
groups and assets, inactive copies 3-13
groups and assets, names when 3-13
incident sub-categories 7-32
incident sub-category items 7-35
shift periods 9-9
shifts 9-23
Copying and pasting 1-21
AppCenter objects 1-20
items that can be copied and pasted 1-22
object names when 1-21
rules for 1-22
Counters 7-22
Creating
accumulator data items 7-20
accumulator/identifier links 7-79
alphanumeric event variables 7-126
archive and purge schedules 13-40
archive definitions 13-36
asset states 7-132
assets 3-9
calculation templates 8-258-33
calculations 8-3
calculations from calculation templates 8-39
calculations from formulas 8-41
calculations from scratch 8-36
categories 7-12
data items 7-27-130
derived items 8-50
event variables 7-25
formulas 8-138-24
groups 3-7
groups and assets 3-5
identifier values 7-58
identifiers, global 7-42??
incident data items 7-22
incident sub-categories 7-30
incident sub-category items 7-33
new schedules from existing 12-15
number formats, not allowed 2-13
numeric event variables 7-123
OPC Real-Time events 7-116
OPC servers 5-5
Retro Stop incident 15-14
roles 10-15
Sample Time events 7-110
schedules 12-13
shift definitions 9-13
shift periods 9-7
shift schedule types 9-26
shift schedules 9-33
shift structures 9-14
temporary shift plans 9-106
Triggered Sample events 7-118, 7-121
triggers 12-22
units of measurement 2-11
users 10-16
Value Change events 7-112
VPCollectors 6-4
Creating a shift editing group 9-58
Creating the first asset 3-6
Ctrl key, copying groups and assets 3-14
D
Daily Schedule 12-10, 13-44
delete shift 9-72
editing 9-71
See also Schedules
Daily schedules
options 12-10
when to use 12-11
Data
See also Data collection; Data items; Data
swapping
aging process 13-90
archives outside control of SQL Server 13-104
BPDU definition 13-91
BPTU definition
cancelling a purge job 13-80
cancelling a re-archive 13-81
cancelling a re-process instruction 13-78
cancelling a restore job 13-76
database control over manual editing 13-101
database management of archiving and purging
13-90
database validation of restored data 13-85
deleted when deleting groups and assets 3-11
deleting restore jobs 13-77
how many BPDUs needed 13-91
initial archiving of oldest 13-20
manual processing 13-95
modifying and cancelling restore jobs 13-89
process of verifying integrity of archives 13-95
purging as an archive activity 13-20
purging restored data 13-79
re-archiving after changes 13-80
re-processing restored data 13-77
restore job properties 13-83
Index
CDC Factory 7.1
ActivEssentials Administration Guide
xxi
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
restoring 13-70
retrying a failed restore job 13-75
swapping See Data swapping
Data archiving
creating an archive definition 13-36
data categories 13-18
data processing actions 13-19, 13-20
deleting archive definitions 13-50
designating working folder 13-16
determining when to start 13-19
information needed when setting up 13-23
introduction 13-11
options for 13-17
parameters 13-17
process of handling expired data 13-20
Data categories, archived as data types 13-18
Data collection
beginning 1-24
creating the system 1-25
minimum requirements for 1-25
Data collection categories See Categories
Data collection configuration
exporting at asset level 7-169
exporting from an asset 7-151
exporting from Object Library 7-154
refreshing VPCollector 7-71
resetting VPServer 7-19
Data Collection Configuration module
description 7-3
icons used in grid 7-9
opening 7-3
printing from 7-3
Data Collection Global Definition Administrators role
10-5
Data integrity
limitations when using manual tasks 13-85
manual data editing violations 13-87
options when restoring 13-88
process of ensuring 13-25
rules controlling manual tasks 13-86
rules for active restore definitions 13-87
rules for changes to restore definitions 13-89
rules for deleting restore definitions 13-89
rules preventing purging 13-89
Data item allocation, in calculation templates 8-29
Data items
choosing for reports 14-59
copying and pasting 7-11
copying between assets 7-92
copying within an asset 7-91
creating new items using export-import 7-158
defining 7-27-130
deleting from assets 7-91
editing on assets 7-89
global and local 7-19, 7-70, 7-93
global, defining 7-19??
global, deleting 7-28
importing and exporting 7-11
importing at asset level 7-162
local items, icon for 7-93
local, defining 7-707-92
name changes when copying 7-92
names unique within a category 7-19
refreshing VPCollector 6-18
role in archives 13-18
saving time in configuring 7-11
stopping/refreshing VPCollector 6-15
viewing on assets 7-89
Data life-time, when data is archived 13-19
Data Management
initial configuration 13-3613-40
maintaining configuration 13-4513-51
manual tasks 13-7013-82
relationship to other database activities
13-10113-103
security maintained by access privileges
13-104
summary of tasks 13-713-10
system settings 13-13
system settings needed 13-11
toolbar buttons 13-5
Data Management Administrators role 10-6
Data Management interface 13-213-10
Archive Logs view 13-4
Data Archiving frame 13-3
Restore Data view 13-4
Data Management module, opening 13-3
Data Management schedules, See Schedules
Data quality for Triggered Sample events 7-102
Data Readers role 10-5
Data restoring
conditions making restore inactive 13-87
options when restoring 13-88
system settings required 13-16
Data security 13-10313-104
Data swapping
cancelling 2-20, 2-28
Continue Processing button 2-26
description 2-20
failure 2-26
refreshing the view, importance of 2-26
rescheduling 2-26
scheduling 2-20
status 2-31
Data types
description of 13-18
in expressions 7-99
role in archive definitions 13-18
Index
CDC Factory 7.1
ActivEssentials Administration Guide
xxii
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
role in the structure of archives 13-18
Database
Allowed Gap for Retro Stop 15-7
backward compatibility 13-2
controls over manual editing 13-101
Daylight Saving tables 2-18
deleting historical data 2-7
determining storage needs 13-91
exporting and importing configuration 7-169
introduction to archiving 13-11
management of archiving and purging 13-90
optimizing performance 13-44
process for handling aging data 13-96
purging process 13-95
Retro Stop incident not recorded 15-7
security maintained by access privileges
13-104
support for only one in export-import 7-169
Throughput version 2-10
unavailable when refreshing assets 6-20
Database logs, descriptions 13-2613-35
Database logs, overview of use in archiving 13-26
Database management
administrator information 13-9013-103
archiving and purging 13-9013-99
Database performance
oldest expired data 13-20
role of archive and purge schedules 13-92
role of BPDU 13-91
Database records
accumulators 7-146
duplicates caused by network interruption 7-17
Triggered Sample events 7-103, 7-106
Dataset definitions, part of report configuration
templates 4-6
Daylight saving 2-152-35
actions available in 2-19
archived data 13-101
best practices for 2-33
cancelling a data swap 2-28
context menu 2-30
Continue Processing button 2-26, 2-30
database tables for 2-18
deleting time change definitions 2-23
effect of time change 2-15
effect on sampled events 7-100
enabling and disabling 2-7, 2-21, 2-22, 2-30
known issues and workarounds 2-34
network disconnection and 2-35
OPC server shut-down 2-35
refreshing VPCollector 2-30
rescheduling a data swap 2-26
Retro Stop, effect on 2-35
roll back 2-33
rolling back, effects of 2-16
SQL Server Agent, avoiding use of 2-34
Status column 2-31
Status of swapping 2-33
swapping data See Data swapping
system time, changing 2-35
terms used in 2-19
time change definitions 2-17, 2-32
toolbar buttons 2-29
VPCollector start during daylight saving 2-35
VPWeb time-line, effect on 2-16
Deadband, trigger expression with 12-22
Default role
caution when modifying 10-22
changing 10-22
definition of 10-6
icon for 10-7
network user and 10-7
new users and 10-6
Default rollover value, for assets 3-17
Default value (calculations)
definition 8-5
Interpolated option 8-34
need for 8-33
No value option 8-35
Previous option 8-34
User-defined option 8-34
zero not to be used 8-5, 8-33, 8-49
Defining
archive settings 13-13
working folder 13-11
Deleting
all report templates 14-114
AppCenter objects 1-20
archive and purge schedules 13-46
archive definitions 13-50
asset states 7-136, 7-141
assets and groups 6-19
assets, large numbers of 3-4
calculation templates 8-32
calculations 8-46
categories 6-17, 6-19, 7-16
data items 6-19, 7-91
derived items 8-56
Detailed Log for Groups/Assets 13-82
effects of deleting user 10-23
extended properties 11-12
formulas 8-21
global data items 7-28
groups and assets 3-5, 3-11
historical data 2-7
incident sub-categories 7-33
incident sub-category items 7-36
network group 10-38
OPC servers 5-8
report distribution 14-137
Index
CDC Factory 7.1
ActivEssentials Administration Guide
xxiii
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
report server 14-97
report style 14-121
reports from personal folder 14-95
reports from shared folder 14-93
restore job from grid 13-77
roles 10-24
scheduled report 14-131
schedules, By Time and By Production Shift
12-19
shared folder 14-90
shift periods 9-10
shift rotation plans 9-50
shift schedule type, results in loss of data 9-31
shift schedule types 9-31
shift schedules 9-36
shift schedules from rotation plan 9-46, 9-49
shifts 9-24
system folder contents (reports) 14-89
temporary shift plans 9-109
time change definitions 2-23
units of measurement 2-12
users 10-23
VPCollectors 6-7
Deleting data, See Purging
Deleting restore definitions, rules governing 13-89
Deleting temporary shift plans 9-83
Delivery of reports, retry times 14-137
Demoting shift schedules 9-49
Denied privileges
See also Privileges
inheritance of 10-50
inheritance, examples of 10-52
Denying privileges 10-10
Derived identifiers See Time-based calculations
Derived items 8-508-56
aggregation method for 8-57
base item for 8-52, 8-57
building blocks for 8-56
components of 8-56
copying 8-55
creating 8-50
definition 8-50
deleting 8-56
editing 8-54
in triggers 12-21
lag time using accumulators 8-54
properties 8-54
reading frequency 8-58
time frame for 8-58
where to use 8-50
Desktray icon for ActivEssentials 6-13
Detailed Log for Data Types
archive properties available 13-29
properties in Restore Data 13-34
purpose and properties 13-29
viewing archive logs 13-60
viewing for restore jobs 13-66
Detailed Log for Groups/Assets
deleting 13-82
properties in Restore Data 13-35
purpose and properties 13-31
viewing archive logs 13-60
viewing for restore jobs 13-66
Detailed View (VPWeb)
Retro Stop incident does not display 15-6
Retro Stop, effect of 15-4
Direct Animation, AppCenter requirement 1-8
Display incidents in VPWeb 2-6
Distributed database See Federated database
Distribution options for reports 14-27
Do not validate, restore verification option 13-85
Document status indicator 1-10, 1-18
Domains, adding to Security module 10-30
DST See Daylight saving
Duration, changing shift duration 9-67
Duration, in Triggered Sample events 7-102, 7-106
E
Editing
See also Editing shift data, Editing reports
accumulators 7-27
AppCenter objects 1-20
archive definition properties 13-52
asset states 7-135
By Time schedule properties 12-17
calculation templates 8-30
calculations 8-44
categories 7-15
derived items 8-54
event variables 7-27
events on assets 7-129
extended properties 11-10
formulas 8-19, 8-22
groups and assets 3-15
identifiers, global 7-54
in the grid 9-74
incident properties 7-27
incident sub-categories 7-31
incident sub-category items 7-34
incidents See Retro Stop; Retro Stop incident
incidents in VPWeb 7-75
incidents, enabling 2-7
network domains 10-35
network groups 10-36
OPC servers 5-9
restore jobs properties 13-61
roles 10-27
shift definitions 9-22
Index
CDC Factory 7.1
ActivEssentials Administration Guide
xxiv
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
shift periods 9-8
shift rotation plans 9-43, 9-46
shift schedule types 9-29
shift schedules 9-35
shift time or duration 9-67
temporary shift plans 9-108
units of measurement 2-12
users 10-24
Editing report template destinations 14-108
Editing reports
changing template style 14-107
data items 14-105
general template properties 14-109
groups and assets 14-98
parameters for categories 14-107
properties 14-96
report categories 14-115
time frame definitions 14-100
Editing shift data
audit log 9-1029-105
audit log example 9-103
description ??9-101
options for 9-64
rules for 9-64
viewing changes 9-102
E-mail Link extended property 11-7, 11-9
Enable Incident Retro Stop property 2-7
Enabling Retro Stop 15-12
Error messages
group/asset list not defined for report 14-26
no active schedules defined 14-63
permission denied 1-5
selection not for scheduled report 14-27
unable to contact Foundation 1-5
unknown name 1-5
Errors in calculations 8-47
Event
defining a trigger in response to 12-22
Event variables
See also Events
alphanumeric, creating 7-126
filtering 7-148
global, creating 7-25
global, deleting 7-28
global, editing 7-27
limit of 1125 per asset 7-19
numeric and alphanumeric 7-130
numeric, creating 7-123
Events
See also Event variables
acknowledgment 7-97, 7-114, 7-148
collection method 7-95
Daylight saving, effect on sampled events
7-100
defining on assets 7-1107-130
editing, on assets 7-129
expressions for filtering 7-114, 7-147
filtering, two levels 7-147
icons for 7-10
OPC read method, Value Change events 5-3
OPC Real-Time events, creating 7-116
OPC Real-Time events, description 7-95, 7-96
properties, on assets 7-129
report templates 14-68
Sample Time, creating 7-110
Sample Time, description 7-95
steps in defining 7-97
time change, effect on 2-16
trigger expressions for 7-98
Triggered Sample See Triggered Sample events
types, described 7-95, 7-147
Value Change event 7-95
Value Change event, creating 7-112
VPCollector stoppage, effect on 6-16
Excel
exporting and importing with 7-11, 7-150,
7-151
modifying plant hierarchy in 7-172
reproducing plant hierarchy in 7-172
Excel workbooks, creating from applications 4-57
Exclude All filtering See Incident filtering
Exclusive filtering See Incident filtering
Expired data, when to archive 13-20
Expiry
license 2-3
useful life-time for data 13-19
user account (security) 10-16
Export
application workbooks 4-57
applications 4-56
Export-import
See also Exporting; Importing
asset level data items, creating with 7-162
commas stripped from names 7-152
creating new data items 7-158
Excel, use with 7-11, 7-150, 7-151
file size limit setting 2-8, 4-90
operation and security 7-168
performance testing 7-169
Retro Stop, not recommended 7-169, 15-12
setting up new collection categories 7-155
single database support 7-169
Exporting
See also Export-import; Importing
asset level configuration 7-169
asset state configuration 7-152
asset states 7-172
collection categories 7-172
configuration 7-1507-168
Index
CDC Factory 7.1
ActivEssentials Administration Guide
xxv
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
from Object Library 7-154
Expressions
See also Filtering; Incident filtering
accumulators 7-145
alphanumeric event variables 7-148
asset states, not used 7-143
data types in 7-99
event triggers 7-98, 7-99
event variables 7-148
events 7-147
invalid 7-145
negative numbers in 7-145
numeric event variables 7-148
overlapping 7-145
real-time data, not used 7-143
solicited accumulators, not used for 7-146
Triggered Sample events 7-120, 7-122
unsolicited accumulators, used with 7-146
valid formats for 7-143
Value Change events 7-114
wildcards in 7-145
Extended properties 11-211-12
assets 11-7
attributes of in identifier extended properties
7-45
Color property 11-7, 11-9
copying 11-11
creating 11-5, 11-7
deleting 11-12
different from ordinary properties 11-2
editing 11-10
E-mail Link property 11-7, 11-9
File property 11-7, 11-9
Number property 11-7, 11-9
plants and groups 11-5
Text property 11-7, 11-9
types of 11-12
Web Link property 11-7, 11-9
Extended Properties module, opening 11-5
Extended_Period_After_Shift 9-11
Extended_Period_Before_Shift 9-11
Extending a shift 9-11
F
F1 key 1-11
F4 key 1-6, 1-11
F5 key 1-11
F10 key 1-11
F11 key 1-11
FactoryViewer Administrators role 10-5
Fahrenheit, converting to Celsius 7-131
File extended property 11-7, 11-9
File size, setting limit for configuration 2-8, 4-90
Filter Incident by Duration, system setting 2-7
Filtering 7-1437-149
See also Expressions
accumulators 7-145
asset states, not used 7-143
event variables 7-148
events 7-147
incidents See Incident filtering
Master log information in Archive Logs 13-58
real-time data, not used in 7-143
restore job information in Restore Data 13-68
Triggered Sample events 7-148
valid expressions 7-143
Value Change events 7-147
Find and replace 1-21
First Hour in Log 2-17
Folders
default limits 14-30
limits to system folders 14-15
personal 14-16
personal folder properties 14-94
shared 14-16
size and report failure 14-141
space required for users reports 14-29
system 14-14
Formula editor
500 character limit 8-22, 8-48
free editing in 8-22
keyboard shortcuts in 8-24
numbers and operations 8-23
use of 8-22
use of keyboard keys in 8-23
Formulas
alphanumeric, creating 8-16
copying 8-20
creating and editing 8-138-24
creating calculations from 8-41
definition 8-4, 8-9, 8-21
deleting 8-21
editing 8-19, 8-22
Formula Editor 8-22
numeric, creating 8-14
placeholders in 8-21
properties 8-19
time-based, creating 8-17
valid but inappropriate 8-24
validating 8-16, 8-17, 8-19, 8-23
Freezing, poor connection to VPFoundation 1-18
G
Gaps between shifts 9-29
Global and local data items 7-70, 7-93
Global category button, on taskbar 1-21
Global collection categories, data available for ex-
port 7-171
Index
CDC Factory 7.1
ActivEssentials Administration Guide
xxvi
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
Granted privileges
See also Privileges; Roles; Security; Users
examples 10-51
inheritance of 10-50
Granting privileges 10-10
Graphical view of shifts 9-31
Grid
archive master logs 13-27
creating new objects in 1-20
description 1-10, 1-17
Detailed Log for Data Type 13-30
Detailed Log for Groups/Assets 13-31
editing in 1-17
filtering archive logs in 13-58
functions of 1-17
pages in 1-17
Plant Management module, appearance 3-4
restore data 13-33
Grid, editing using 9-74
Groups
adding network groups to Security module
10-31
creating 3-7
definition of 1-14, 3-3
deleting 3-11
extended properties, creating 11-5
maximum number of assets 3-4
properties 3-14
removal of a role from 10-54, 10-55
Groups and assets
See also Assets; Extended Properties; Groups
access privileges for 10-41
activating and inactivating 3-16
activating, no VPCollector refresh 6-18
active and inactive 1-15, 3-4
adding a shift rotation plan 9-49
adding a shift schedule 9-40
copying 3-5, 3-12, 3-13
copying within the grid 3-12
creating 3-5
data also deleted when deleting 3-11
deleting 3-11, 6-18, 6-19
deleting a shift rotation plan 9-50
demoting shift schedules 9-49
descendants 3-11
editing 3-15
extended properties 11-211-12
icons for 1-14
inactivating 6-18, 6-19
inactive when copied 3-13
moving 3-12, 3-13
names when copying 3-13
names, uniqueness 3-5
OPC server, assigning 5-12
OPC server, changing 5-13
order of 3-16
ordinal position 3-15, 3-16
Plant Hierarchy frame 1-9
properties 3-5, 3-14
shift rotation plans for 9-50
shift schedule relationships 9-48
shift schedules for 9-409-53
source of archived data 13-18
template asset 1-25
VPCollector, assigning 6-8
Guest user 10-8
member of Public role 10-9
H
Hard drive space, requirements for reports 14-10
Heartbeat item 5-5
change rate for 5-4
item ID 5-4
message posted when missing 5-4
OPC servers 5-2, 5-4
VPCollector 6-2
Help
F1 key 1-11
finding 1-21
Help category button, on taskbar 1-12
Historical data, number of rows deleted 2-7
Historical shift data
SeeShift editing
HMI
programming for Retro Stop 15-26
use with Retro Stop 15-2, 15-4, 15-10
HMI Operators role 10-5
Host name, VPCollector, effect of changing 6-17
Human Machine Interface See HMI
I
Icons
AppCenter grid items 1-17
groups and assets 1-14
in Data Collection Configuration module 7-9
inactive data items 7-9
local data items 7-93
OPC servers 5-14
Schedules & Real-time Triggers grid 12-5
Identifier change, moment of 7-94
Identifier properties
use as constants in formulas 8-23
uses of 7-51
VPWeb appearance of 7-51
where viewed 7-51
Identifier values
auto-insert 7-44, 7-58
creating 7-58
Identifiers
Index
CDC Factory 7.1
ActivEssentials Administration Guide
xxvii
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
alias 7-51, 7-58
Allowed Gap 7-17
Allowed Gap, and time change 2-17
attributes defined 7-43
attributes of extended properties 7-45
bogus identifiers 6-16
collection method 7-17
daylight saving, best practices 2-33
defined in reports 14-23
defining on assets 7-85
filtering incidents with 2-362-39
global, creating 7-52
global, defining 7-42??
global, editing 7-54
global, properties of 7-54
global, used once per asset 7-77, 7-87
icons for 7-10
linked identifiers, update rate for 7-79, 7-94
linking with accumulators 7-79, 7-94
local 7-85
merging 2-16, 7-17
moment of change 7-94
names used only once 7-19
network interruption, effect on 7-17
non-unique 7-87
number of unique values setting 2-7
time change, effect on 2-15, 2-16
using as filter for reports 14-22
using to adjust time frame 14-22
values, 80-character limit 6-20
VPCollector stoppage, effect on 6-16
VPWeb appearance after daylight saving 2-34
Illegal characters
names in MI Admin 1-17, 9-3
Importing
See also Export-import; Exporting
application workbooks 4-65
asset states 7-166
collection categories 7-155
collection categories, one at a time 7-162
commas stripped from names 7-151, 7-158,
7-161, 7-165, 7-168
data items 7-158
data items at asset level 7-162
network users 10-33
requirement for unique names 7-156, 7-158,
7-162
Importing and exporting See Export-import; Export-
ing; Importing
Inbox, folder for reports 14-14
Incident by Identifier time frame 14-57
Incident categories, applying Retro Stop to 15-18
Incident duration, limits for Retro Stop 15-3
Incident editing See Incidents, editing in VPWeb;
Retro Stop; Retro Stop incident
Incident filtering 2-362-39
choosing a model 2-39
coincident duration model 2-38
Exclude All filtering 2-36
Exclusive filtering 2-36
expressions for 7-149
full duration model 2-37
Inclusive filtering 2-36
models for 2-37
system settings for 2-7
Incident priority, Retro Stop 15-4, 15-25
Incident sub-categories 7-307-40
copying 7-32
creating 7-30
deleting 7-33
editing 7-31
explanation of 7-40
linking to categories 7-36
linking to incidents and assets 7-38, 7-41
viewed in real-time data viewer 7-41
VPWeb display 2-6
Incident sub-category items
copying 7-35
creating 7-33
deleting 7-36
editing 7-34
Incidents
See also Incident filtering; Incident sub-catego-
ries; Incident sub-category items; Retro
Stop; Retro Stop incident
acknowledgment 2-6, 7-14, 7-74
adding Retro Stop incidents 15-20, 15-23
Allowed Gap 6-16, 7-17
Allowed Gap, and time change 2-17
bogus incidents 6-16
by Identifier reports 14-68
calculating open incident duration 2-7
closed by database 2-6
collection method 7-17
concurrent incidents with different priority
7-149
daylight saving, best practices 2-33
defining on assets 7-81
editing in VPWeb 7-75
editing See Retro Stop; Retro Stop incident
editing, enabling 2-7
expressions for filtering 7-84
filtering by sub-category 7-36
global, creating 7-22
global, deleting 7-28
global, editing 7-27
icons for 7-10
kept open on trigger change 7-149
linking to sub-categories 7-41
linking with incident sub-categories 7-38
Index
CDC Factory 7.1
ActivEssentials Administration Guide
xxviii
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
local 7-81
merging 2-16, 6-16, 7-14, 7-17
merging, in Retro Stop 15-4
network interruption, effect of 7-17
priority 7-75, 7-84, 7-149
priority, ignoring 7-149
properties, display in VPWeb 2-6
Reason Code report category 14-72
Reason Code reports 14-64
report templates 14-68
Retro Stop incident 7-75
retroactive editing 2-7
setting for comments 2-6
sub-categories See Incident sub-categories
time change, effect on 2-15, 2-16
truncating in VPWeb 2-6
viewing in VPWeb 7-75
VPCollector stoppage, effect on 6-16
Inclusive filtering See Incident filtering
Inheritance of privileges
See also Privileges; Roles; Users
description 10-48
examples 10-51
Insight for Excel Users role 10-6
Installation, Retro Stop 15-12
Internet Explorer
AppCenter requirement 1-8
error messages See Error messages
installing Direct Animation 1-8
installing VML 1-8
JavaScript 1-8
Internet Information Services See IIS (Internet In-
formation Services)
Interpolated default value, in calculations 8-34
IP address, VPCollector, effect of changing 6-17
J
JavaScript, enabled for AppCenter 1-8
K
Keyboard shortcuts
formula editor 8-24
MI Admin 1-11
Plant Hierarchy frame 1-16
L
Layout View, effect of Retro Stop 15-4
Length of a shift 9-13
License key 3-2
Licensing 2-3
expiry date 2-3
key 2-2
support code 2-3
templates and asset count 4-47
Limits
accumulators per VPCollector 7-19
assets per group 3-4
assets per OPC server 6-20
characters in alphanumeric variables 6-20
characters in identifier values 6-20
event variables per VPCollector 6-20
groups within groups 3-4
incident priority value 6-21
incidents per asset 6-21
triggered events per VPCollector 6-21
variables per asset 7-19
VPCollector 6-20
Linking
accumulators and identifiers 7-79
incident categories and sub-categories 7-36
incidents and sub-categories on an asset 7-38
report category to a style 14-49
Locking AppCenter 1-6, 1-11
Log on to Production Shift Editor 9-55
Logging on
as a network user 1-5
dialog box 1-5
error messages See Error messages
MI Admin 1-4
security privileges 10-11
Logs
archive for Data Types 13-29
archive for Groups and Assets 13-31
archive types 13-35
in Restore Data 13-32
Logs and properties, viewing 13-5213-70
Lunch breaks, in shift definitions 9-11
M
Manual data editing
conflicts with archive definitions 13-101
violations of database rules 13-87
Manual tasks
limitations 13-85
list of 13-86
re-archiving vs. re-processing 13-86
Master logs
filtering information in Archive Logs 13-58
purpose and properties 13-26
viewing 13-57
Mathematical functions, in calculations 8-5, 8-23
Maximum rollover value 3-17
MDAC (Microsoft Data Access Components), App-
Center requirement 1-8
Measurement, units of See Units of measurement
Merge Identical Incidents checkbox 7-18
Merge Identical Values 7-52
Merge Values
Index
CDC Factory 7.1
ActivEssentials Administration Guide
xxix
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
checkbox 7-18
identifiers 6-16
incidents 6-16
Merging
identifiers 7-17
in time-based calculations 8-12
incidents 7-14, 7-17
incidents and identifiers 7-17
MI Admin
accessing Shift Configuration 9-65
accessing the Production Shift Editor 9-55
common functions in 1-20
consequences of changes in 6-19
copying and pasting objects 1-21
creating new objects 1-20
Data Management module 13-3
Data Management system settings 13-11
illegal characters 1-17
information required for using 1-24
keyboard shortcuts 1-11
Plant Management module 3-2
Temporary shift plans 9-66
toolbar 1-9, 1-10
toolbar buttons 1-10
window elements 1-9
MI Admin taskbar 1-9
Microsoft Data Access Components 1-8
Minimized taskbar 1-13
Minimized taskbar, accessing modules in other cat-
egories 1-14
Modifying archive system settings 13-45
Module buttons, on AppCenter taskbar 1-9, 1-12
Monitoring OPC servers 5-2
Monthly schedules
definition 12-10, 13-44
options 12-11
when to use 12-11
Moving groups and assets 3-12, 3-13
MSXML (Microsoft Extensible Markup Language)
installing 1-8
versions required 1-8
N
Names
copying and pasting objects 1-21
groups and assets when copied 3-13
illegal characters in 1-17
Negative numbers in expressions 7-145
Network
disconnection during daylight saving 2-35
incidents and identifiers, effect of interruption
7-17
Retro Stop, effect of delay 15-7
traffic, effect on AppCenter 1-19
Network domain
adding to Security module 10-30
changing 10-35
Network group
adding to Security module 10-31
changing role or access level 10-36
deleting from Security module 10-38
users able to log in 10-31
Network user, logging on to AppCenter 1-5
New objects, creating 1-20
Non-administrative Report Viewer privileges 14-12
Non-productive shift periods
description 9-11
recommended for daylight saving change 2-35
Non-productive time, not ignored 9-11
Non-productive time, toggling in grid 9-86, 9-87
Non-unique identifiers 7-87
Normal users 10-8
Number extended property 11-7, 11-9
Number formats, viewing 2-13
Numeric calculations 8-10
Numeric event variables
creating 7-123
expressions in 7-148
icons for 7-10
Numeric formulas 8-14
O
Object Library
Data Collection Configuration module 7-5
exporting data collection configuration 7-154
new objects in 1-20
Plant Hierarchy frame 1-9
Plant Management module, absent from 3-4
use of 1-15
Old data, when to archive 13-20
OPC item name spaces
usage of Search Patterns 4-10
use of Base Object Value 4-10
use when defining asset template parameters
4-10
OPC Real-Time events
creating 7-116
description 7-96
not stored in database 7-116
OPC Server Configuration module
icons in 5-14
opening 5-5
OPC server lockup issues 5-2
OPC servers
assigned to an asset 3-16
assigning to assets 5-12
changing on assets 5-13
Index
CDC Factory 7.1
ActivEssentials Administration Guide
xxx
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
configuration 5-25-13
creating 5-5
deleting 5-8
deleting, effect on VPCollector 6-17
editing 5-9
heartbeat item for 5-2, 5-4
installation requirements 5-2
maximum number of assets 6-20
monitoring 5-2
network interruptions, handling 7-17
properties 5-9
re-connection by VPCollector 5-4
Server Class ID 5-10
shutting down during daylight saving 2-35
testing the connection 5-11
VPCollector re-connection 5-2, 5-4
zero values on re-starting VPCollector 6-16
Open Incident Expired Time property 2-6
Opening AppCenter 1-4
Opening Reports Administration 14-3
Opening Schedules & Real-time Triggers 12-3
Operating systems for AppCenter 1-8
Operator comments 2-6
Operators (calculations)
definition 8-7
time-based calculations 8-11
Operators for Filter by Incident reports 14-73
Options
applying a template to an asset 4-28
choosing templates when importing 4-24
for archiving and purging 13-17
for verifying restored data 13-85
reapplying templates to assets 4-29
reimporting application templates 4-15
removing archive logs 13-35
removing template from asset 4-38
when importing applications 4-14
Options button 1-11
Order of groups and assets 3-16
Ordinal position, groups and assets 3-15, 3-16
Overlapping
expressions 7-145
roles 10-54
shift schedules, effects of 9-51
Overwrite data, rules applied before restoring
13-88
Overwriting historical shift data 9-45
Owner alias 2-6
Owner of shift rotation plan 9-50
P
Parameters for data archiving 13-17
Partitioning, enabling in MI Admin 2-9
Password
changing, for a user 10-21
logging on to AppCenter 1-5
requirements for 10-21
setting, for a user 10-16
unlocking AppCenter 1-6
Performance, export-import operations testing
7-169
Permission denied error 1-5
Personal folder 14-16
properties of 14-94
removing reports from 14-95
Plant
definition of 1-14, 3-3
extended properties, creating 11-5
Plant hierarchy
See also Assets; Groups; Groups and assets
adding a group 3-7
adding an asset 3-9
adding roles to 10-39
applying other objects to 1-21
asset as lowest level 3-3
assets in 3-3
caution when editing in Excel 7-172
concept of 3-2, 3-3
creating 3-7
defining 3-23-17
expanding 1-14
groups in 3-3
keyboard shortcuts for 1-16
navigating in 3-5
order of procedure 1-25
plants in 3-3
relationship to actual plant hierarchy 3-4
reporting, effect on 3-4
reproducing with Excel 7-172
security privileges in 10-3910-43
virtual hierarchy in AppCenter 3-3
Plant Hierarchy frame 1-9, 1-14, 3-3
Plant Hierarchy frame, minimizing 1-15
Plant Management module 3-23-17
See also Assets; Groups; Groups and assets
application and template tasks 4-11
description 3-4
grid, appearance of 3-4
opening 3-2
PLC programming for Retro Stop 15-26
Predefined (system) users 10-8
Preferences, saving 1-20
Prerequisites for AppCenter 1-24
Previous default value, in calculations 8-34
Printing, from Data Collection Configuration module
7-3
Priority
Index
CDC Factory 7.1
ActivEssentials Administration Guide
xxxi
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
asset states 7-142
ignoring incident priority 7-149
incidents 7-75, 7-149
incidents, for Retro Stop 15-4, 15-25, 15-27
Privilege word (security) 10-3, 10-9, 10-10
Privileges
See also Roles; Security; Users
changing, for roles 10-46
changing, for users 10-44
denying 10-10
granting 10-10
granting, denying, and revoking 10-10
inheritance between roles and users 10-48
inheritance in plant hierarchy 10-48, 10-51
inheritance of granted or denied 10-50
inheritance, examples of 10-52
interaction between roles and users 10-50,
10-53
plant hierarchy and 10-41
revoking 10-10
role privileges 10-9
rules governing changes to 10-50
setting in plant hierarchy 10-3910-43
types of 10-3
user privileges modify role privileges 10-9
Production lines 3-3
Production Shift Editor
accessing in MI Admin 9-55
accessing Shift Configuration 9-65
log on 9-55
Production tasks 2-6
Production View 7-94
support in reports category 14-18
Productive and non-productive periods 9-11
Productive time, toggling in grid 9-86, 9-87
Properties
See also Extended Properties, Identifier Proper-
ties
accumulator, incident, and variable data items
7-27
archive Detailed Log for Data Types 13-29
asset states 7-135
calculation templates 8-30
calculations 8-44
data items on assets 7-89
derived items 8-54
Detailed Log for Data Types 13-29
Detailed Log for Groups/Assets 13-31
editing archive definitions 13-52
editing report properties 14-96
editing restore jobs 13-61
event variables 7-130
events on assets 7-129
extended properties 11-10
formulas 8-19
global identifiers 7-54
groups and assets 3-5, 3-14, 3-15
Master log 13-26
of archive files 13-24
OPC servers 5-9
Restore Data grid 13-33
restore Detailed Log for Data Types 13-34
restore Detailed Log for Groups/Assets 13-35
restore jobs 13-83
restore logs 13-34
Retro Stop incident 15-16
roles and users 10-24, 10-27
shift periods 9-8
shift rotation plans 9-43
shift schedule types 9-29
shift schedules 9-35
shifts 9-22
units of measurement 2-12
VPCollector 6-6
Public role
all users members of 10-6
as default role 10-22
definition of 10-5
new users and 10-6
Purge jobs, role of SQL Server 13-44
Purge only data, manual data editing rules 13-87
Purge restored data
operational limits 13-86
rules that govern 13-89
Purge schedules
deleting
modifying 13-46
setting up 13-40
Purging
automatic process 13-94
database management 13-90
database process 13-95, 13-96
database process of removing old data 13-20
restored data 13-79
role in an archive definition 13-20
system settings required 13-16
Q
Query Builder User role 10-6, 14-12
Query Builder, use to create reports 14-19
Quiet period setting, for OPC server heartbeat 5-3
R
RCA Setting Users role 10-6
RCA Users role 10-6
Reading frequency, for derived items 8-58
Real-time data viewer, incident sub-categories in
7-41
Real-time data, not filtered 7-143
Index
CDC Factory 7.1
ActivEssentials Administration Guide
xxxii
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
Real-Time Logic Engine, use with VPServer 7-19,
8-13
Real-time triggers
creating a trigger template 12-26
defining a trigger using a template 12-27
defining and maintaining 12-2112-30
defining new 12-22
deleting 12-30
duplicating a trigger 12-29
overview of logic used 12-21
role within ActivEssentials 12-1, 12-2
Reapply options
Data Items tab on dialog box 4-30
Web Views tab 4-34
Re-archiving
compared to re-processing 13-86
operational limits 13-86
Recreate Shifts 9-46, 9-47
Refresh button 1-11
Refreshing
assets 6-12
data 1-11
VPCollector, effect on incidents and identifiers
7-17
VPCollector, effects of 7-70
VPCollector, in daylight saving 2-30
Registry, effect of changes on VPCollector 6-17
Reimport template options
Data Items tab 4-19
Global Definitions tab 4-17
RTLE Items tab 4-21
Templates tab 4-15
Web Views tab 4-23
Reimport, customized options 4-58
Relative Date schedule, see Schedules
Removing a template 4-82
Removing archive logs 13-35
Removing data, See Purging
Report Administrator
privileges 14-12
user role 14-12
Report Administrators role 10-6
Report Categories, part of report configuration tem-
plates 4-6
Report configuration templates
best practices 4-7
component structures 4-6
creating 4-49
export and import of custom configuration 4-6
packaged configuration 4-6
secondary configuration elements 4-6
standardized reports 4-6
viewing configuration reports 4-93
viewing template definition reports 4-90
viewing usage reports 4-91
Report Delivery role 10-5
Report Distribution vs. Scheduled Report 14-24
Report failure, because of folder size 14-141
Report Power Users role 10-6
Report Power users role 14-12
Report Provider
APRS Query Server 14-19
APRS SP 14-19
APRS SP-XML 14-18
SQL Reporting Service 14-19
Report server
part of report configuration templates 4-6
setting up 14-40
Report style
creating new 14-20
deleting 14-121
part of report configuration templates 4-6
Report template
creating 14-51
data items for 14-59
groups and assets for 14-54
part of report configuration templates 4-6
time frame for 14-55
time frame to retrieve data 14-21
Report user role 14-12
Report Viewer
relationship to Reports Administration 14-11
user privileges 14-12
user roles and privileges 14-12
Reporting, relationship to plant hierarchy 3-4
Reports
accumulators 14-68
assigning users to shared folder 14-36
auto-refresh option 14-64
Birth History 14-68
Birth History time frame 14-57
building blocks 14-67
changing groups and assets 14-98
changing template style 14-107
controlling storage limits by role 14-31
controlling storage limits by user 14-33
creating a report category 14-43
creating report template 14-51
deleting all templates 14-114
deleting from personal folder 14-95
deleting from shared folder 14-93
deleting report distribution 14-137
deleting scheduled report 14-131
delivery retries 14-137
distribution options 14-9, 14-27
editing categories 14-115
editing data items 14-105
editing general template properties 14-109
Index
CDC Factory 7.1
ActivEssentials Administration Guide
xxxiii
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
editing parameters 14-107
editing properties 14-96
editing template destinations 14-108
editing time frames 14-100
events 14-68
filtering options 14-72
folder limits and report creation 14-141
generating 9-97
identifier definition 14-23
Inbox for user 14-14
Incident by Identifier 14-68
Incident by Identifier time frame 14-57
Incident Reason Code 14-18
Incident Reason Code template 14-64
incidents 14-68
legacy report wizards 14-67
limits to system folders 14-15
linking to a report style 14-49
operators for Filter by Incident 14-73
Production View category support 14-18
removing users from shared folder 14-91
roles for 10-6
scheduled report properties 14-124
scheduled reports not usable 14-26
setting up report server 14-40
space for reports 14-10
space required for folders 14-29
subscriptions to 14-14
summary reports 14-68
template overview 14-21
types available 9-97
user folders 14-14
viewing template configuration 4-93
viewing template definitions 4-90
viewing template usage 4-91
when removed from database 14-139
XSL style location for 14-20
Reports Administration
interface overview 14-4
introduction 14-2
opening 14-3
relationship to the Report Viewer 14-11
Re-process archive, operational limits 13-86
Re-processing, compared to re-archiving 13-86
Requirements for AppCenter 1-8
Rescheduling a data swap 2-26
Response error 1-19
Restarting AppCenter 1-6, 1-11
Restore Data
logs explained 13-32
properties available in grid 13-33
properties in Detailed Log for Data Types 13-34
properties in Detailed Log for Groups/Assets
13-35
properties of restore logs 13-34
Restore Data interface, purpose 13-4
Restore Data view
filtering restore job information 13-68
summary of tasks 13-10
Restore definitions
conditions that force an inactive status 13-87
limitations of when active 13-87
options when restoring data 13-88
when to delete 13-89
Restore detailed logs, viewing 13-66
Restore jobs
cancelling 13-76
deleting from the grid 13-77
modifying and cancelling 13-89
retrying when failed 13-75
viewing and editing properties 13-61
Restore logs, properties in Restore Data 13-34
Restored data
cancelling a purge job 13-80
cancelling a re-process instruction 13-78
purging 13-79
re-processing after changes 13-77
what is restored 13-84
Restoring data
database validation 13-85
modifying and cancelling restore jobs 13-89
process of 13-70
restore job properties 13-83
retrying a failed restore job 13-75
scheduling options for 13-84
where to start 13-84
Retro Stop 15-215-28
See also Retro Stop incident
adding incident definition to asset 15-20,
15-23
Allowed Gap 2-7, 15-7, 15-27
changing the record 15-2
daylight saving and 2-35
enabling 2-7, 15-12
enabling at asset level 15-25
error in use 15-9
errors when using export-import 7-169, 15-12
HMI programming for 15-26
HMI use with 15-2, 15-10
incident categories, enabling for 15-18
incident priority enabled 15-4
incident priority, effect of disabling 15-27
installation and set up 15-12
merging incidents 15-4
network delays, effect of 15-7
open incidents only handled 15-11
PLC programming for 15-26
purpose 15-2
Root Cause Analysis, combination with 15-11
Root Cause Analysis, comparison with 15-10
Index
CDC Factory 7.1
ActivEssentials Administration Guide
xxxiv
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
security roles required 15-13
sequence of events 15-4
VPWeb, use in 15-4
Retro Stop incident
See also Retro Stop
activating and inactivating 15-18
category, assigning 7-75
defining 7-24
editing 15-16
icon for 7-9
identifying 15-14
inactive 15-16
minimum length 15-3
not displayed in Detailed View 15-6
not recorded in database 15-7
only one allowed 7-24
trigger for 15-4
wrong incident changed 15-9
Retroactive incident editing See Retro Stop; Retro
Stop incident
Revoking privileges 10-10
Roles
See also Privileges; Security; Users
adding to plant hierarchy objects 10-39
administrator and user roles for reports 10-6
Advanced VPWeb User 10-5
assigning users to 10-18, 10-20
changing for network group role 10-36
changing privileges for 10-46
controlling report storage limits by 14-31
creating 10-15
Data Collection Global Definition Administrators
10-5
Data Management Administrators 10-6
Data Readers 10-5
Default role 10-6
definition of 10-4
deleting 10-24
editing 10-27
FactoryViewer Administrators 10-5
HMI Operators role 10-5
Insight for Excel Users 10-6
interaction with users 10-53
overlapping 10-54
predefined roles 10-5
privileges modified by user privileges 10-9
properties of 10-27
Public role 10-5
Query Builder Users 10-6
RCA Setting Users 10-6
RCA Users 10-6
removing from plant hierarchy objects 10-54
Report Administrators 10-6
Report Delivery 10-5
Report Power Users 10-6
Root Cause Analysis 10-6
Security Administrators 10-5
Shift Global Definition Management 9-40, 10-5
System Administrator role 10-5
system roles 10-42
system roles, cannot edit 10-42
system roles, tool-tip for 10-42
VPWeb roles 10-5
Rolling back, in time change definition 2-16, 2-17,
2-33
Rollover value
absolute maximum 7-146
accumulator value 7-145
default for assets 3-17
default maximum 7-146
maximum 3-17
maximum for an asset 7-145
maximum for VPCollector 6-21
methods of setting 7-145
system-wide maximum 7-145
Root Cause Analysis
Incident Reason Code report 14-18
Retro Stop, combination with 15-11
Retro Stop, comparison with 15-10
roles 10-6
security for 10-2
Rotation Plan dialog box 9-40
Rotation plan See Shift rotation plans
Rotation Plans 9-66
RTLE configuration in asset templates 4-5
RTLE item device names, for defining asset template
parameters 4-11
Rules when importing application templates 4-14
Run schedules, imported with report configuration
templates 4-6
S
Sample Time events
creating 7-110
described 7-96
sampling frequency 7-96
Schedule, adding shift 9-69
Scheduled execution tasks, owner alias 2-6
Scheduled reports
enabling 14-60
properties 14-25
subscribing to 14-14
vs. Report Distribution 14-24
Schedules
activating 12-20
changing template removal time 4-82
creating 12-13
daily 12-10
deactivating 12-20
Index
CDC Factory 7.1
ActivEssentials Administration Guide
xxxv
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
deleting 12-19
deleting for archive and purge
duplicating 12-15
examples of 12-11
maintaining 12-17
modifying for archive and purge 13-46
monthly 12-11
no active schedule for report 14-63
role in managing database performance 13-92
setting up archiving and purging 13-40
source of schedule configuration 12-1, 12-2
types of 12-9, 12-10, 13-44, 14-24
understanding their structure 12-9
weekly 12-10
what type to use 12-11
Schedules & Real-time Triggers
context menus 12-6
description of interface 12-3
icons used in grid 12-5
opening 12-3
schedule status (active/inactive) 12-5
the interface 12-212-6
toolbar buttons 12-6
Scheduling 12-212-6
options for restore jobs 13-84
Scope
choosing for an asset template 4-28
definition of the structure of an archive 13-16
role of groups and assets 13-18
Search Pattern, usage when defining parameters
4-10
Secondary frame
buttons in 1-16
description 1-9, 1-16
information when minimized 1-16
minimizing 1-15
Security 10-210-55
See also Roles; Users; Privileges
adding network domains 10-30
additional security for archives 13-104
archiving functions subject to privileges 13-104
decision tree 10-11
exporting and importing configuration 7-168
logging on 10-11
network users 10-3010-38
predefined users 10-8
property of archive files 13-25
Retro Stop, roles required 15-13
Root Cause Analysis, interaction with 10-2
rules governing changes 10-50
Security Administrators 10-5
Security Configuration module, opening 10-14
Security Warning dialog box 1-5
Seed database, contains application 4-8
Serial number, example of identifier 7-42
Server Class ID, for OPC servers 5-10
Services, starting in correct order 3-6
Shared folder
component of report configuration templates
4-6
deleting 14-90
deleting reports from 14-93
editing properties 14-90
removing users from 14-91
Shift
building blocks 9-89
creating 9-89
deleting 9-92
modifying 9-90
Shift audit log 9-1029-105
Shift configuration 9-29-106
See also Shifts; Shift periods; Shift schedules
extending shifts 9-11
overview 9-4
process of 9-5
Shift Configuration module, opening 9-3
Shift configuration templates
creating 4-48
distribute to other servers 4-6
packaged configuration 4-6
standardized shifts 4-6
viewing template definition reports 4-90
viewing usage reports 4-91, 4-93
Shift Configuration, accessing the Production Shift
Editor 9-65
Shift data, editing See Editing shift data
Shift definitions 9-139-25
Shift editing
overwriting historical shift data 9-45
Shift Editing Group
creating 9-58
selecting 9-61
Shift extension 9-11
Shift Global Definition Management role 9-40, 10-5
Shift periods 9-89
a part of shift configuration templates 4-6
configuring 9-79-11
copying 9-9
copying, name change when 9-10
creating 9-7
definition 9-4, 9-62
deleting 9-10
editing 9-8, 9-86
Extended_Period_After_Shift 9-11
Extended_Period_Before_Shift 9-11
inserting 9-84
must fall within shift 9-64
no initial length 9-7, 9-11, 9-94
Index
CDC Factory 7.1
ActivEssentials Administration Guide
xxxvi
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
order of, changing 9-18
overview 9-11, 9-94
productive and non-productive 9-11
standard and non-standard 9-11
Standard property not changeable 9-9
Shift plans, temporary 9-1069-110
See also Temporary shift plans
Shift Production Editor
differences between editor and MI Admin 9-62
layout and components 9-62
Shift rotation plans
adding groups or assets 9-49
composition of 9-48
definition 9-47
deleting schedules from 9-49
deleting, effect of 9-50
editing 9-43
overlapping schedules 9-51
overwriting historical data 9-45
owner of 9-50
properties 9-43
removing a schedule 9-46
start date and time, setting 9-42
viewing in grid 9-50
Shift schedule types 9-269-35
a part of shift configuration templates 4-6
adding to a schedule 9-33
creating 9-26
daily 9-37
definition 9-5, 9-37
deleting 9-31
deleting, results in loss of data 9-31
editing 9-29
graphical view of shifts 9-31
monthly 9-38
overview 9-37
properties 9-29
starting day of schedule 9-38
types of 9-37
weekly 9-38
Shift schedules 9-269-35
adding to assets, security requirements 9-47
adding to groups or assets 9-40
creating 9-33
definition 9-5, 9-38, 9-62
deleting 9-36
deleting from rotation plans 9-46, 9-49
editing 9-35
groups and assets See Shift rotation plans
overlapping 9-51
overview 9-37
properties 9-35
re-applying shifts to 9-76
Shift schedules for groups and assets 9-409-53
Shift Structures
"Changed" notation 9-63
Shift structures 9-139-25, 9-89
creating from shift periods 9-14, 9-18, 9-20
definition 9-4, 9-12, 9-25
multiple for different needs 9-89
must contain at least one standard period 9-12
removing from a shift 9-21
steps before and after creating 9-25
uniqueness 9-25
Shift structures, definition 9-62
Shifts
See also Shift configuration; Shift periods, etc.
audit log 9-103
copying 9-23
creating 9-13
definition 9-4, 9-62
deleting 9-24
editing definitions 9-22
editing historical data See Editing shift data
extending 9-11
gaps between 9-29
graphical view 9-31
information required 1-24
inserting in schedule gap 9-69
items that can be edited 9-62
length determined by structure 9-13, 9-25
order of operations when defining 9-5
overlapping not allowed 9-29
part of shift configuration templates 4-6
properties 9-20, 9-22
re-applying original shifts 9-76
removing a shift structure 9-21
temporary shift plans 9-110
use in derived items 8-58
Show/Hide Frame button 1-11
Shut Down button 1-11
Shutting down AppCenter 1-6, 1-11
Software requirements
AppCenter 1-8
checking 1-3
Solicited accumulators 7-146
advantages and disadvantages 7-146
expressions not used for 7-146
Solicited counters, OPC read method 5-3
Sorting items in AppCenter modules 1-21
SQL Server
archive and purge schedules 12-1, 12-2
data for reports 14-19
role in archive and purge jobs 13-44
table partitioning in 2-9
table partitioning versus archiving 13-11
verification of archives 13-104
SQL Server Agent, in daylight saving 2-34
SQL Server Reporting Service 14-19
Index
CDC Factory 7.1
ActivEssentials Administration Guide
xxxvii
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
Standard and non-standard periods 9-11
Standard functions (calculations) 8-7
Starting MI Admin 1-4
Starting Reports Administration 14-3
States, of assets See Asset states
Status bar, AppCenter 1-10, 1-18
Status column, in daylight saving 2-31
Stopping a temporary shift plan 9-109
Structure (shifts) See Shift structures
Subscription to reports 14-14
See also Reports distribution options
for Inbox 14-14
making scheduled report available 14-25,
14-79
Support code, for license 2-3
Swapping data See Data swapping
Sychronize All
reimporting applications 4-25
Sychronize Insertion and Modification
reimporting applications 4-25
Synchronize All
reimporting applications at asset level 4-36
Synchronize Insertion and Modification
reimporting applications at asset level 4-36
System Administrator role 10-5
System Default
reimporting applications 4-25
reimporting applications at asset level 4-36
System folder
default limits, setting 14-30
deleting users contents 14-89
editing 14-88
System requirements
checking 1-3
System roles 10-42
System settings 2-22-10, 13-21
calculating open incident duration (RCA) 2-7
changing 2-4
configuration transfer size 2-8, 4-90
daylight saving 2-7
deleting historical data 2-7
description 2-5
duplicate user names 2-10, 10-35
editing 13-45
for data archiving 13-11
incident editing 2-7
number formats 2-14
required for archiving and purging 13-16
required for data restoration 13-16
Unique Identifier Values 2-7
VPWeb 2-6
System Settings module
Allowed Gap parameter, and Retro Stop 15-8
daylight saving toolbar buttons 2-29
enabling partitioning 2-9
enabling Retro Stop 15-13
opening 2-2
System time
changing during daylight saving 2-35
effect on VPCollector 6-17
System users 10-8, 10-42
T
Taskbar, AppCenter
description 1-12
Help category button 1-12
minimizing 1-13
Taskbar, MI Admin 1-9
Tasks 2-6
in Reports Administration 14-6
summary of in Archive Logs 13-9
summary of in Restore Data 13-10
Template asset 1-25, 3-7, 3-9
Template maintenance 4-774-93
Template Management, introduction to 4-2
Templates
ActivApplications tasks 4-12
applying to asset 4-70
applying vs. reapplying to assets 4-29
asset data collection configuration 4-4
asset level tasks 4-11
asset states 4-5
Birth History report 14-68
changing removal options 4-82
choosing when importing 4-24
configuration template types 4-3
creating a new asset template 4-42
creating from a real-time trigger 12-26
creating new report configuration template
4-49
creating new shift configuration template 4-48
data collected from assets 4-3
description of role within applications 4-8
detaching 4-77
for scheduled reports 14-26
found in Plant Management module 4-11
import process 4-14
in applications 4-84-12
Incident by Identifier 14-68
Incident Reason Code report 14-64
initial set up 4-414-75
introduction to application templates 4-2
introduction to use in applications 4-8
options when applying to an asset 4-28
options when importing 4-14
purpose of asset templates 4-3
purpose of configuration templates 4-2
Index
CDC Factory 7.1
ActivEssentials Administration Guide
xxxviii
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
reapply options in Data Items tab 4-30
reapply options, Web Views tab 4-34
reimport options at asset level 4-35
reimport options for existing applications 4-25
reimport options, Data Items tab 4-19
reimport options, Global Definitions tab 4-17
reimport options, RTLE Items tab 4-21
reimport options, Templates tab 4-15
reimport options, Web Views tab 4-23
removal options 4-38
removing 4-79
replicate and deploy shift configuration 4-6
report configuration best practices 4-7
reports overview 14-21
resynchronizing asset configuration 4-84
RTLE configuration included 4-5
scope when applying to asset 4-28
specifying import options 4-58
standardized shifts 4-6
Summary for Accumulators, Events, Incidents
14-68
types of configuration templates 4-6
usage of report configuration templates 4-6
use of asset properties 4-5
use of calculations 4-5
validating 4-75
viewing configuration reports 4-93
viewing template definition reports 4-90
viewing usage reports 4-91
VPWeb views used in asset templates 4-5
ways to applying to assets 4-29
Temporary shift plans 9-1069-110
characteristics of 9-110
creating 9-81, 9-106
definition 9-80
deleting 9-83, 9-109
editing 9-108
in MI Admin 9-66
reason for creating 9-107
stopping 9-109
Temporary shift schedule 9-11
Testing OPC server connection 5-11
Text extended property 11-7, 11-9
Throughput Analyzer Database Version property
2-10
Time change definitions
automatic retrieval 2-18
deleting 2-19, 2-23
description 2-17, 2-20
display of 2-32
System Administrator role to delete 2-23
Time changes See Data swapping; Daylight saving;
Time change definitions
Time frame
adjust by identifier 14-22
based on unique identifier for reports 14-22
calculations 8-8
choosing for reports 14-55
derived items 8-58
filter by identifier 14-22
in report templates 14-21
Time interval, in calculations 8-8
Time-based calculations
definition 8-11
merging records in 8-12
Time-based formulas 8-17
Timers 7-22
Toggle
Plant Hierarchy frame 1-15
taskbar 1-13
Toolbar, MI Admin 1-9, 1-10
Trigger expressions See Expressions; Filtering
Triggered Sample events
comparison with Sample Time events 7-101
creating 7-118, 7-121
data quality 7-102
database records, with a duration 7-106
database records, without a duration 7-103
described 7-96
display in VPWeb 7-102
expressions 7-120, 7-122
invalid trigger 7-101
limitations of 7-109
modes of collection 7-102
overview 7-101
rapid trigger changes 7-104
trigger for 7-101
using a duration 7-102
Triggers 12-2112-31
characteristics of 12-21
creating 12-22
creating a real-time trigger template 12-26
data items used in 12-21
deadband option 12-22
defining by using a real-time trigger template
12-27
deleting a real-time trigger 12-30
duplicating a real-time trigger 12-29
filtering with 7-143
for events 7-95
Retro Stop incident 15-4
Triggered Sample events 7-101
Value Change events 7-112
Triggers overview of logic used 12-21
Truncate Incidents in VPWeb property 2-6
Trusted (network) users 10-8
effects of deleting 10-23
importing into Security module 10-33
setting login capability 2-10, 10-35
Index
CDC Factory 7.1
ActivEssentials Administration Guide
xxxix
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
U
Units of measurement
creating 2-11
deleting 2-12
editing 2-12
properties 2-12
Unknown name error 1-5
Unsolicited accumulators, advantages and disad-
vantages 7-146
Update rates, for data types 5-3
URL for AppCenter 1-4
User
deleting system folder contents (reports) 14-89
effects of deleting 10-23
network group, able to log in 10-31
storage limits for reports by 14-10
User accounts, expiry of 10-9, 10-16
User Defined Options
reimporting applications 4-25
reimporting applications at asset level 4-36
User roles
descriptions of privileges 14-12
overview 14-11
privileges 14-12
User-defined default value, in calculations 8-34
User-defined functions, in calculations 8-8
Users
$ReportDeliveryServer$ 10-8
$ReportURLAccessUser$ 10-8
See also Privileges; Roles; Security
account expiry 10-9, 10-16
adding network user 10-33
Administrator user 10-8
assigning roles to 10-18, 10-20
assigning to a shared folder 14-36
changing privileges for 10-44
controlling report storage limits by 14-33
creating 10-16
deleting 10-23
duplicate user names 2-10, 10-35
editing 10-24
Guest user 10-8, 10-9
interaction with roles 10-53
names 10-8
overlapping roles 10-54
password, changing 10-21
password, requirements for 10-21
predefined users 10-8
privileges modify role privileges 10-9
properties of 10-24
removing from shared folder (reports) 14-91
system users 10-42
types of 10-8
V
Validating formulas 8-16, 8-17, 8-19, 8-23
Validation
continue if validation fails, restore verification
option 13-85
stop if validation fails, restore verification option
13-85
templates 4-75
Value Change events
creating 7-112
described 7-95, 7-96
filtering 7-147
Variables
defining 7-7
icons for 7-10
limit of 1125 per asset 7-19
values, 80-character limit 6-20
Variables (calculations)
assigning data items to 8-29
definition 8-7
limited number to be used 8-7
VBScript functions in expressions 7-99, 7-143
Vector Markup Language (VML), AppCenter require-
ment 1-8
Verification
archive compared to log 13-84
database checks against restored data 13-85
process for archived data 13-95
Viewing
archive definition properties 13-52
archive detailed logs 13-60
By Time schedule properties 12-17
logs and properties 13-5213-70
master logs 13-57
restore detailed logs 13-66
restore jobs properties 13-61
Virtual plant hierarchy 3-3
VML (Vector Markup Language), AppCenter require-
ment 1-8
VPCollector
accumulators, maximum number of 6-20
asset states not recorded 5-2
assigned to an asset 6-9
assigning to groups and assets 6-8
boundary conditions 6-20
caching accumulator values 6-5, 6-7
callback data items 5-3
changes not allowed while running 6-17
changing on an asset 6-10
configuration 6-26-11
creating 6-4
daylight saving best practices 2-33, 2-34
deleting 6-7
deleting, not allowed if running 6-7
Index
CDC Factory 7.1
ActivEssentials Administration Guide
xl
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
failure, effects of 6-15
filtering data with expressions 7-143
heartbeat 6-2
inactivating, not allowed if used on assets 6-7
information for an asset 3-16
interruption of data collection 6-7
limit of 10000 accumulator items 7-19
limitations 6-20
message log 6-13
message when heartbeat item missing 5-4
OPC server heartbeat 5-3
OPC server monitoring 5-3
OPC server re-connection 5-2
properties 6-6
re-connection to OPC server 5-4
refreshing 6-12
refreshing automatically 6-18
refreshing during in daylight saving 2-30
refreshing in Data Collection Configuration 7-71
refreshing manually 6-18
refreshing when database is unavailable 6-20
refreshing, at asset level only 6-12
refreshing, effect on accumulators 6-7
refreshing, effect on incidents and identifiers
7-17
refreshing, effects of 6-15
refreshing, when adding items to asset 7-70
refreshing, when to refresh 6-17
rollover value, maximum 3-17, 6-21
service in Activplant control panel 6-14
starting 3-6, 6-14
starting, during daylight saving 2-35
starting, effects of 6-15
stopping 6-14
stopping, effects of 6-15
VPFoundation 1-18
.Net Framework requirement 1-8
connection to AppCenter 1-18
crash, effects of 1-19
factors affecting response time 1-19
poll every xx seconds 1-20
rollover value, maximum 3-17
starting 3-6
VPQManager
message log 6-13
service in Activplant control panel 6-14
starting 3-6
VPServer
purpose of use 7-19, 8-13
resetting in Calculations 8-13
resetting in Data Collection Configuration 7-19
use with Real-Time Logic Engine 7-19, 8-13
use with third-party applications 7-19, 8-13
VPTray 3-17
VPWeb
auto-refresh option for report display 14-64
calculations not appearing 8-49
comments on incidents 2-6
daylight saving, effect on performance 2-34
filtering incidents by identifier 2-36
incident acknowledgment display 2-6
incidents truncated in 2-6
restarting after configuration changes 6-19
Retro Stop in 15-4
roles 10-5
time-line, effect of time change 2-16
views used in asset templates 4-5
W
Web address for AppCenter 1-4
Web Link extended property 11-7, 11-9
Weekly schedule
See also Schedules 12-10, 13-44
definition 12-10, 13-44
Weekly schedules
options 12-10
when to use 12-11
Wildcards, in expressions 7-145
Windows 2000 Server 5-2
Workbooks
creating from applications 4-57
processing 4-65
Working folder
designating for archiving 13-16
moving archive files from 13-24
storage for archive files 13-24
X
XML reports transformed to HTML 14-18
XSL and report styles 14-19
XSL, location for report styles 14-20
Z
Zero, not to be used as default value 8-5, 8-33
CDC Factory 7.1 ActivEssentials Administration Guide
The information contained in this document is subject to change without notice.
Except as may otherwise be provided in a written agreement with a licensee, CDC Software Corporation makes
no warranty of any kind with regard to this material, either expressed or implied, including, but not limited to,
the documentation, function, and performance of these programs. CDC Software Corporation disclaims all
implied warranties, including, but not limited to, any implied warranty of merchantability or fitness for a
particular purpose.
Except as may otherwise be provided in a written agreement with a licensee, CDC Software Corporation shall
not be liable for any errors contained herein or for incidental, special, or consequential damages in connection
with the furnishing, performance, or use of this material, and liability for direct damages is limited to the cost
of the materials.
This document contains proprietary information which is protected by copyright. No part of this document may
be reproduced in any manner or translated into another program language without the prior written consent
of CDC Software Corporation.
Copyright 2011 CDC Software Corporation. All Rights Reserved.
CDC Software, Ross ERP, Strategic Application Modeler (SAM) are registered trademarks of CDC Software
Corporation and/or its wholly owned subsidiaries.
Ross ERP, Ross APS, Ross SCP, Ross CRM, Ross EPM, Ross Localization and Customer Portal are trademarks of
CDC Software Corporation and/or its wholly owned subsidiaries.
Other trademarks mentioned herein are the property of their respective companies.
For additional information, log on to http://www.cdcsoftware.com.