Commissioning AspenTech InfoPlus.21 Historian Technical ...

M-Historian Technical Manual 646.0Commissioning Section

Issue Date 0101

© 2001 Johnson Controls, Inc. www.johnsoncontrols.comCode No. LIT-646300

TECHNICAL BULLETIN

Commissioning AspenTech® InfoPlus.21™ Historian

Commissioning AspenTech InfoPlus.21 Historian .......................... *3

Introduction........................................................................................................*3

Key Concepts.....................................................................................................*4

AspenTech InfoPlus.21 Historian................................................................................... *4

InfoPlus.21 Tools ........................................................................................................... *4

File Sets ........................................................................................................................ *5

Database Word Size...................................................................................................... *7

Back Up and Restore..................................................................................................... *8

Procedure Overview ..........................................................................................*9

Detailed Procedures ........................................................................................*10

Starting and Stopping InfoPlus.21................................................................................ *10

Backing Up the InfoPlus.21 Historian Database........................................................... *11

Restoring an InfoPlus.21 Historian Database............................................................... *11

Viewing File Set Information ........................................................................................ *12

Modifying Database Configuration Parameters............................................................ *12

Modifying File Set Subdirectories................................................................................. *18

Configuring Database Word Size................................................................................. *18

Archiving a Database File Set...................................................................................... *21

Restoring a Database File Set ..................................................................................... *22

* Indicates those sections where changes have occurred since the last printing.

Commissioning2

Commissioning AspenTech InfoPlus.21 Historian 3

Commissioning AspenTechInfoPlus.21 Historian

IntroductionThis document describes how to configure the AspenTechInfoPlus.21 Historian database. This document describes how to:

• start and stop InfoPlus.21

• back up the InfoPlus.21 Historian database

• restore an InfoPlus.21 Historian database

• view file set information

• modify database configuration parameters

• modify file set subdirectories

• configure database word size

• archive a database file set

• restore a database file set

Commissioning4

Key Concepts

AspenTech InfoPlus.21 Historian

The InfoPlus.21 Historian provides long-term storage of historical datain an efficient and economical system of repositories that contain diskarchive files. The InfoPlus.21 Historian is composed of one or morerepositories each containing:

• a Queue and possible Queue files

• a Cache and Cache file

• two or more archive file sets

• the h21 archive process

Each repository is a complete, self-contained, history system.

Historical data is placed into a memory-resident Queue. The h21archive process transfers the entries from the Queue into amemory-resident Cache where they are indexed by record ID and bytimestamp. The archiving process removes the indexed entries fromthe Cache and stores them in disk archive files called file sets.

The InfoPlus.21 Historian quickly and efficiently retrieves stored datafrom the file sets for use in the system whenever it is required.

InfoPlus.21 Tools

Several tools are included with AspenTech InfoPlus.21. Thethree tools typically used include: InfoPlus.21 Administrator,InfoPlus.21 Manager, and History/21 Monitor.

! CAUTION: Users making changes to database configuration

through these utilities should understand theparameters and their usage. Changingconfiguration parameters after storing data altershow the database works. Invalid values toconfiguration parameters can damage thedatabase.

InfoPlus.21 Administrator

Allows users to explore and interact with local and remote InfoPlus.21systems. Use the Administrator to search databases for specificrecords, retrieve database properties, create new folders, create andmodify records, add history repositories, set history parameters, andadd file sets.


Note: OEM Historian Release 1.0 advanced commissioningprocedures used the DOS program, History/21 Monitor.Those procedures are valid and available inHistory/21 Monitor. However, InfoPlus.21 provides theInfoPlus.21 Administrator, a Windows program thatprovides most of the commissioning options.History/21 Monitor is required for archiving and restoringdatabase file sets.

History/21 Monitor

Backs up, restores, and repairs InfoPlus.21 history repository file sets.The History/21 Monitor is a DOS based program that must run on theWindows NT computer that contains the InfoPlus.21 Historiandatabase. The History/21 Monitor consists of a set of screens andcommand-line text entries that can be used to look at the current trendand message log (GWS only) database configuration and modify theconfiguration parameters.

InfoPlus.21 does not create a menu for History/21 Monitor. Launch theprogram from the following directory:C:\AspenTech\InfoPlus21\c21\h21\bin\h21mon.exe.

InfoPlus.21 ManagerManages groups and tasks in the database and includes instructions forthe History/21 utility programs provided with InfoPlus.21. Creates andmanages InfoPlus.21 groups and the tasks associated with thedatabase.

File SetsAll long-term historical tag data collected in a plant is stored withinarchive files, which form part of a self-contained group of related filescalled a file set. Each repository should have a minimum of three filesets: one to use, another to shift to, and a third file set for restoringarchival backups. There is a maximum limit of 100 file sets perrepository. The number of file sets needed depends on the amount ofdata you want to keep available for immediate access by users and theway you want to archive older data. For example, you might set up13 file sets, specifying that 12 should be used to store data for a monthat a time and the 13th should not be used for storage of new data. Thiswould allow users access to the most recent 12 months of data andprovide you with a place to restore an older file set if, at any time,someone needs to see archived data that goes back further than the last12-month period.

Each file set holds all the data for a continuous period of time for allincluded tags, for example, from 10 December 98 11:27:45 to15 Jan 99 05:34:32.

Commissioning6

Each file set has a data file, a long-record data file, and a companionkey file that reside under the same directory. The files in a set alwayshave the names: arc.dat, arc.byte, and arc.key. Since all archive filesets contain the same file names, the file sets must be maintained inseparate directories.

The data file (arc.dat) contains variable length data records up to256 bytes. Each record contains multiple history samples saved for thesame tag. Each history sample contains a timestamp havingmicrosecond resolution, a key level, and the other fields defined forthe historical occurrence.

The records for a specific tag are linked together by pointers creating acontinuous time history. The size of the records is determined by theactivity of the tag. Active tags with many events are given larger, moreefficient records, while quiet tags have small records to minimizewasted space when the file set shifts.

If it takes more than 256 bytes to store any data sample, the data filecontains a pointer to the long-record data file and the data sample itselfis stored in that file (arc.byte).

The key file (arc.key) is an index that has one entry for each datarecord in the data file. The keys are the Tag ID, starting time, andending time of the corresponding records. The key file allows thesystem to go directly to the correct starting record when the tag andtime are given. After that, data retrieval is a simple matter of readinglinked records for the tag and jumping across file set boundaries wherenecessary. To the client programs, such as Aspen Process Explorer, itappears as one continuous, time-based record.

By definition, the file set in use for storing data is called the active fileset. It receives all the current data samples (although other file sets canalso be updated by edits or backdated events, such as delayed labsamples). As data samples are stored, the active file set grows until itreaches its size limit, threshold, or preset time limit. The system thenshifts into the next available file set. The previously active file setbecomes permanently bounded by the start and end times of its activeperiod. Normally there are no time gaps between file sets except whereold sets have been restored from an archive tape.

File sets can be set up based either on size or time. So you can have afile set collect data until it reaches a certain preset size or you canspecify that it will collect data from 10 December 98 11:27:45 to15 Jan 99 05:34:32 and then shift to a different file set.


When InfoPlus.21 is initially installed, the installation software sets updirectories for three file sets (arc1, arc2, and arc3) in a repositorynamed TSK_DHIS. By design, those file sets provide for a verylimited amount of data storage and are intended to be used only as atemporary storage means until you can set up file sets that are based onthe needs of your system and located so that it is convenient for you toback them up frequently.

IMPORTANT: Install history repositories and file sets on a local driveto optimize performance and minimize the possibilityof losing the connection to the repository drive. Usingremote drives seriously degrades performance.

The InfoPlus.21 databases store history in InfoPlus.21 historyrepositories. Within the Administrator, each InfoPlus.21 database hasan item in its subtree named Historian that contains all the historyrepositories for that database. A history repository has one item in itssubtree, File_Sets, which is the set of file sets for that repository.

To set up the InfoPlus.21 history repository file sets for a singlerepository system:

• Determine the data storage parameters.

• Add a history repository.

• Add file sets.

• Optionally, set up a file set shift procedure.

Database Word SizeThe database word size setting determines how much Random AccessMemory (RAM) memory is allocated (reserved) for use by theInfoPlus.21 Historian database. If the system is low on virtualmemory, it means the system is not able to hold required informationfor the database within the allocated space.

The Database word size depends on the number of tags saved in thedatabase. Every tag saved to the database determines the databaseword space required. There are two entries controlling the word size:

• Maximum word size—This restricts the number of words thedatabase can have. This value is set by installation and can bealtered from the Infoplus.21 Manger.

• Total word size—This is the actual word size the database is using.This directly depends on the number of tags inserted into thedatabase. This value cannot increase more than maximum wordsize value. This value is set by the installation and increments byJohnson Controls OLE (Object Linking and Embedding) interfaceapplication when new tags are inserted. This value can also be setfrom engineering console application.

Commissioning8

If the database word size is set up much larger than the actual size ofyour database, excess computer memory is allocated for the databasebut not used. This lowers the performance of the system. The properword sizes are set up during installation.

Only modify this value to correct an error from the installation.Database word size is setup from the data user entered in configurationdialog during installation. If a lower value is entered duringinstallation and trend collector fails with this error, change themaximum word size parameter to increase it. You do not have toreinstall the software.

Back Up and RestorePerform regular backups of the database to protect the data fromhardware and system failures. The InfoPlus.21 Historian databasebackup and restore can be done one of two ways:

• backing up and restoring the InfoPlus.21 Historian files using acommercial or operating system backup/restore utility program

• archiving and restoring individual file sets usingHistory/21 Monitor

IMPORTANT: We recommend a full backup of all program files andall database files every week and daily backups ofdatabase files and the configuration files directories.

The History/21 Monitor provides commands for archiving andrestoring individual file sets. Using these commands, it is possible toarchive a file set to offline storage, and later restore it so that old datacan be viewed. Because the databases software re-uses file sets,eventually the oldest file sets are overwritten. By backing upindividual file sets onto secondary storage, it is possible to save thempast the date when they will be overwritten. Then old file sets can berestored to look at the old data. Back up the existing data beforerestoring the old data.

Before doing a backup of the InfoPlus.21 Historian files, you mustshut down the database. If the InfoPlus.21 Historian is backed upwhile it is running, there is a chance that the database files will bebacked up in the middle of a write operation, resulting in a corrupteddatabase.

Pause mode allows users to archive a database file set saving currentdata to a temporary location and free the file sets for backup. WhenPause mode is stopped, the database engine returns all the data storedin temporary location to file sets. This method can be used for regulararchives.

The workstation applications may have to be shut down while thedatabase is being backed up to make sure the data retrieved is correct.


Procedure Overview

Table 1: Commissioning AspenTech InfoPlus.21 HistorianTo Do This Follow These Steps:Start and Stop InfoPlus.21 Select Windows Start menu > Programs > AspenTech >

InfoPlus.21 Manager. Click either Start InfoPlus.21 or Stop InfoPlus.21.

Back Up the InfoPlus.21Historian Database

Stop InfoPlus.21. Shut down all the clients connected to theInfoPlus.21 Historian. Back up the following:

• all file sets

• InfoPlus21.snp file. The default location isC:\AspenTech\InfoPlus21\db21\group200.

• All files in the data configuration subdirectory. The default location isC:\AspenTech\InfoPlus21\c21\H21\dat.

Start InfoPlus.21.

Restore an InfoPlus.21Historian Database

Stop InfoPlus.21. Shut down all the clients connected to theInfoPlus.21 Historian. Copy and paste the following files from the backedup database:

• all file sets


• All files in the data configuration subdirectory. The default location isC:\AspenTech\InfoPlus21\c21\H21\dat.

Start InfoPlus.21.

View File Set Information Select Windows Start menu > Programs > AspenTech > InfoPlus.21Administrator. Select Group 200 > Historian > TSK_DHIS > File Sets.

Modify Database ConfigurationParameters

Select Windows Start menu > Programs > AspenTech > InfoPlus.21Administrator. Right click on the database, TSK_DHIS, and selectProperties. Calculate proper database configuration parameters usingTable 6. Edit the fields in the Properties dialog box and click OK. Enterthe new parameters in the Pending edit boxes.

Modify File Set Subdirectories Select Windows Start menu > Programs > AspenTech > InfoPlus.21Administrator. Select Group 200 > Historian > TSK_DHIS > File Sets.Right-click on a file set and select Properties.

Configure Database Word Size Select Windows Start menu > Programs > AspenTech >InfoPlus.21 Manager. Click on TSK_DBCLOCK task in the defined taskssection. Calculate the total number of words (space) required:(x * 146) + (y*627) + 39731w here x is the number of trend tags andy is the number of message log tags. Change the value following theDOUBLE in the Command line parameters field to the value calculatedwith the formula above. Click the Update button.

Archive a Database File Set In Windows NT Explorer, double-click on the History/21 application:C:\AspenTech|InfoPlus21\c21\h21\bin\h21mon.exe. At the H/21mon>prompt, type DATES. Enter the command SETREP TSK_DHIS so thetrend database is the database being backed up. At the H/21mon>prompt, type PAUSE. Back up the desired file set. At the H/21mon>prompt, type PROCESS.

Restore a Database File Set In Windows NT Explorer, double-click on the History/21 application:C:\AspenTech|InfoPlus21\c21\h21\bin\h21mon.exe. At the H/21mon>prompt, type DATES. At the H/21mon> prompt, type PAUSE. Select oneof the old file sets not needed. Dismount the selected file set. Restore theold file set into the file set number just dismounted. Type: MOUNT –a.Then type: PROCESS.

Commissioning10

Detailed Procedures

Starting and Stopping InfoPlus.21

To start and stop InfoPlus.21:

1. Select Windows Start menu > Programs > AspenTech >InfoPlus.21 Manager. The InfoPlus.21 Manager dialog boxappears (Figure 1).

Figure 1: InfoPlus.21 Manager Dialog Box

2. Click either Start InfoPlus.21 or Stop InfoPlus.21.


Backing Up the InfoPlus.21 Historian Database

Note: Backup of the InfoPlus.21 Historian database and programfiles can be done with any commercial or operating systembackup/restore utility program.

To back up the InfoPlus.21 Historian database:

1. Stop InfoPlus.21. It is preferable to pause the database duringbackup. Shut down the database only when backing up allprogram files.

2. Shut down all the clients connected to the InfoPlus.21 Historian.

3. Back up the following:

• all file sets


• All files in the data configuration subdirectory. The defaultlocation is C:\AspenTech\InfoPlus21\c21\H21\dat.

Note: Refer to Viewing File Set Information for information onfinding file set locations.

4. After the backup successfully completes, start InfoPlus.21.

Restoring an InfoPlus.21 Historian Database

To restore an InfoPlus.21 Historian database:

1. Stop InfoPlus.21.

2. Shut down all the clients connected to the InfoPlus.21 Historian.

3. Copy and paste the following files from the backed up database:

• all file sets


• All files in the data configuration subdirectory. The defaultlocation is C:\AspenTech\InfoPlus21\c21\H21\dat.

Note: Refer to Viewing File Set Information for information onfinding file set locations.

4. After the restore successfully completes, start InfoPlus.21.

Commissioning12

Viewing File Set Information

To view file set information:

1. Select Windows Start menu > Programs > AspenTech >InfoPlus.21 Administrator.

2. Select Group 200 > Historian > TSK_DHIS > File Sets. The listof file sets appears (Figure 2).

Figure 2: InfoPlus.21 Administrator - File Sets

Modifying Database Configuration Parameters

To modify database configuration parameters:


2. Right click on the database, TSK_DHIS, and select Properties.The Properties dialog box contains several tabs described inFigure 3 through Figure 6 and Table 2 through Table 5.


Figure 3: Database Properties: Repository Tab

Table 2: Database Properties: Repository Tab

Field DescriptionPath The location of the database

Time Past:

Amount of time (in seconds) prior to the current time that trendsamples can be added to the database. This value should be inthe range of 86400 (1 day) and 1581120000 seconds(50 * 366 days).

Future:

Amount of time (in seconds) past the current time that trendsamples can be added to the database. This value should be inthe range of 0 seconds and 1581120000 seconds(50 * 366 days).

Number ofPoints

Maximum number of tags cached for trend in the database.Leave this parameter set at 50,000; even when there are fewertags. This value is the absolute maximum value used by thedatabase. The license purchased determines the maximumnumber of tags.

Commissioning14

Figure 4: Database Properties: Global Tab

Table 3: Database Properties: Global Tab

Field DescriptionFile Sets Size Maximum amount of disk space (in bytes) used for each file set.

When a file set reaches the threshold, the databaseautomatically switches to the next file set to avoid overflowingthe hard disk. This maximum size is 1 GB (1,073,741,824).

Threshold Percentage of the file set size (the Global Arc Size) when thedatabase automatically switches to the next file set. In Figure 4,the database switches to the next file set when the current fileset is 85% full. This leaves room in the existing file set for dataadded to the file set at a later time.

Time Span Maximum amount of time (in seconds) a file set can be in use.When a file set has been active for the specified number ofseconds, the database automatically switches to the next file setto avoid overflowing the hard disk. This time span should be inthe range of 3600 seconds and 63244800 seconds.


Figure 5: Database Properties: Advanced Tab

Table 4: Database Properties: Advanced Tab

Field DescriptionBuffer Size Size of the primary event buffer. Leave this parameter set

at 100,000.

Cache Size Number of bytes per point in the cache table. Leave thisparameter set at 256.

Commissioning16

Figure 6: Database Properties: General Tab

Table 5: Database Properties: General Tab

Field DescriptionRecord Size of the primary event buffer. Leave this parameter set

at 100,000.

Defined by Number of bytes per point in the cache table. Leave thisparameter set at 256.

3. Calculate proper database configuration parameters using Table 6.For each step (row) in Table 6, enter information for the user’sconfiguration in the Value column.

Note: All of the values entered, except for the threshold value inStep 8, should be whole numbers (integers) with nofractional part. The right-hand column contains the namesof the configuration parameters that change with theHistory/21 Monitor program.

4. Edit the fields in the Properties dialog box using Table 6 and clickOK. Enter the new parameters in the Pending edit boxes. Thesevalues take effect the next time the PC is shut down and restarted.


Table 6: Database Configuration Parameters

Step Instructions Value ConfigurationParameter

1 Determine the number of points trended (maximum 50,000) for trenddatabases. Determine the number of languages for messages;multiply by 7.

2 Determine how many trend samples are collected (on average) fromeach point per day. For example, if points are trended, on average,every 15 minutes, enter 100 samples per point per day.

Determine how many messages will be collected (on average) eachday. For example, if the system generates on average 800 messagesper day, enter 800.

3 Determine how long you want to keep data online in days. If you wantdata online for 4 weeks, enter 28 days. If you want data online for2 years, enter 730 days.

4 Determine how often you want the database to switch to a newdatabase file set. Enter this value in days. As a guideline, start a newfile set after 10-20% of the time shown in Step 3 has elapsed. Forexample, if you want data online for one year, switch to a new file setevery one to two months. To store a large amount of data, switch to anew file set every two weeks for better performance.

5 Convert Value 4 from days to seconds using the following equation:File Set Timespan = (Value 4 * 86,400).

Time Span

6 Calculate the number of database directories (file sets). Use thefollowing equation: Number of File Sets = (Value 3 / Value 4) + 1.Round this number up to the next integer value. Note this calculationadds one extra file set to allow for an active file set. Normally thisnumber is a value between 5 and 30. If your value is outside of thisrange, return to Step 4.

Number of FileSets

7 Determine the amount of disk space (in bytes) needed for each fileset. Approximately 22 bytes are needed for each trend sample. Tocalculate the disk space required for a file set, use the equation:File Set Size = (Value 1 * Value 2 * Value 4 * 22).

File Set Size

8 Set the threshold for a file set for rolling over to a new file set. A valueof 0.90 means rollover occurs when a file set is 90% full, leaving 10%of the space for old data. Normally, leave this value at 90%.Decrease this number if you plan to add a lot of old data to thedatabase.

0.90 Threshold

9 Determine the number of days in the past you can add old data to thedatabase. Normally this is the same as the online time for thedatabase entered in Step 3: Value 9 = Value 3.

10 Convert Value 9 from days to seconds using the following equation:Past Time = (Value 9 * 86,400).

Time: Past

11 Determine the number of days in the future you want to add data tothe database. Normally this is the same as the timespan for a singlefile set entered in Step 4: Value 11 = Value 4.

12 Convert Value 11 from days to seconds using the following equation:Future Time = (Value 11 * 86,400).

Time: Future

13 Calculate how much disk space is needed for your database usingthe equation: Total Disk Space = (Value6 * Value7). This informationis not required for the database configuration, but it is used todetermine the size of the hard disk needed. The calculated disk sizeis a maximum database size. A typical database uses slightly lessdisk space than indicated. This value indicates the disk requirementsfor the database files. The disks installed should be larger to providespace for the operating system and application programs.

Total Hard DiskRequirements

Commissioning18

Modifying File Set Subdirectories

Note: If the database directories are changed, any data alreadystored in the database is lost. Move the data manually.

To modify file set subdirectories:


2. Select Group 200 > Historian > TSK_DHIS > File Sets. The listof file sets appears (Figure 2).

3. Right-click on a file set and select Properties. The appearsProperties dialog box for the selected file set appears (Figure 7).

Figure 7: File Set Properties

Configuring Database Word Size

Note: Only modify this value to correct an error from theinstallation. Do not use the Infoplus.21 Manager for anyother changes. Changes here can damage the database.


To configure database word size:

1. Select Windows Start menu > Programs > AspenTech >InfoPlus.21 Manager. The InfoPlus.21 Manager appears(Figure 8).

Figure 8: InfoPlus.21 Manager

2. Click on TSK_DBCLOCK task in the defined tasks section. Thispopulates the task definition fields in the New Task Definitionsection. The command line parameter field in the New TaskDefinition section displays the current value of the maximumword size.

3. Calculate the total number of words (space) required:

(x * 146) + (y*627) + 39731

where x is the number of trend tags and y is the number ofmessage log tags

Note: Set the size 5% to 10% more than the actual value calculatedusing the above formula.

Commissioning20

4. Change the value following the DOUBLE in the Command lineparameters field to the value calculated with the formula above.

5. Click the Update button to update the configuration.


Archiving a Database File Set

To archive a database file set:

1. In Windows NT Explorer double-click on the History/21application:

C:\AspenTech|InfoPlus21\c21\h21\bin\h21mon.exe

2. At the H/21mon> prompt, type DATES. The Archive Status Tablescreen appears.

3. Determine which file set is active and which file sets contain olddata. The % Full column indicates how full each file set is. TheFile_Path column indicates the subdirectory location for that fileset. This database shows the two repositories available. It is veryimportant to set the repository before starting the backupprocedure. Enter the command SETREP TSK_DHIS so the trenddatabase is the database being backed up.

4. At the H/21mon> prompt, type PAUSE.

5. Back up the desired file set. The -a parameter is the file setnumber. The -d parameter specifies the directory and filenamewhere the backup copy should be stored. For example, to backupFile Set 5 to the C:\DBSave\arc5.dat filename, type the following:

BACKUP -a 5 -d C:\DBSave\arc5.dat

6. At the H/21mon> prompt, type PROCESS.

Commissioning22

Restoring a Database File Set

To restore a database file set:

1. In Windows NT Explorer double-click on the History/21application:

C:\AspenTech|InfoPlus21\c21\h21\bin\h21mon.exe

2. At the H/21mon> prompt, type DATES to determine which fileset is active and which file sets contain old data.

3. At the H/21mon> prompt, type PAUSE.

4. Select one of the old file sets not needed.

5. Dismount the selected file set. The –a parameter is the file setnumber. For example, to dismount File Set 7, execute thefollowing command:

DISMOUNT -a 7

6. Restore the old file set into the file set number just dismounted.The -a parameter is the file set number. The -d parameter specifiesthe directory and filename where the old file set is backed up. Forexample, to restore the file set from C:\DBSave\arc7.dat, executethe following command:

RESTORE -a 7 -d C:\DBSave\arc7.dat

7. Mount the selected file set, which was dismounted by typing:

MOUNT –a 7

8. Resume the OEM Historian database by executing the followingcommand:

PROCESS


Notes

Commissioning24

Notes

www.johnsoncontrols.comControls Group FAN 646.0507 E. Michigan Street M-Historian Technical ManualP.O. Box 423 Release 2.0Milwaukee, WI 53201 Printed in U.S.A.

Commissioning AspenTech InfoPlus.21 Historian Technical ...

Documents

Transcript of Commissioning AspenTech InfoPlus.21 Historian Technical ...