Administration Guide > Configuration > Structure of the Configuration Files > AE DB Archive

AE DB Archive

Default values have been specified for most parameters. They can be changed if required. Parameters that must be adjusted to your system environmentAn Environment consists of Deployment Targets which represent your endpoints. Different environments are used for different phases in the software delivery cycle, for example Development, QA, Staging, Production. An environment is typically set up once and used by several applications. are written in red letters.

Structure of the INI File UCYBDBAR.ini

Section/Parameter Description
[GLOBAL]  

helplib=

The name of the message file.

helpcache=

The availability of message and language dependent strings.

Allowed values: "ALL" (default value), "NONE", "CONTROLS"

"ALL" = The entire message file is kept in the RAM.
"NONE" = The message file is always read from the hard drive.
"CONTROLS" = All language dependent strings required for displaying a dialog program are held in the RAM. 

language=

The default language that is used for loginAn Automation Engine object type that stores account credentials used by agents on target systems..

Allowed values: "E" (default value), "D", "F"
"D" = German
"F" = French
"E" = English

The language that you select when you log on affects the utility's interface and the log-file messages. When you select several languages here, the first language is used as the default language. 

logging=

The path and the file name of the log file.

The number characters are used as place holders for consecutive numbering. When you start the utility the log files are renamed so that the current log file always shows the number "00".

logcount=

The number of stored log files.

MaxDeadlockCount=

The maximum number of deadlocks per operation.

docu_path=

The directory in which the help system is installed.

cmd=

The command-line command for starting the utility.

path=

The start path for the utility.

title=

This parameter serves internal purpose in the utility. The value must not be changed.

alloc_size=

The utility processes the data records block by block. This parameter specifies the block size (number of data records).

Default value: 200 000

[ENVIRONMENT]

 

classpath=

The path and the file name of the archive for layout files.

[TRACE]

 

file=

The path and the file name of the trace file.

The number characters are used as place holders for consecutive numbering. When you start the agentA program that enables the de-centralized execution of processes (such as deployments) on target systems (computers or business solutions) or a service that provides connectivity to a target system (such as for databases or middleware). An agent is also an object type in the Automation Engine. [Formerly called "Executor."] See also: host, the log files are renamed so that the current log file always shows the number "00".

trccount=

The number of stored trace files.

databaseA database is an organized collection of data including relevant data structures.=

The trace flag for the utility's database access.

Allowed values: "0" (default value) to "9"

Trace flags must only be used in close cooperation with Automic Support. AE does not recommend setting trace flags because the logging of database accesses decreases performance.

[AH_BODY]

This section serves to specify the data that should be written to the archiving file.

"1" - Data is included in the archiving process.
"0" - Data is not included in the archiving process.

AH_TimeStamp1=

Activation time.

AH_TimeStamp1=

Start time.

AH_TimeStamp4=

End time.

AH_MsgNr=

The message number and the message inserts.

AH_LoginDst=

The name of the Login objectAutomation Engine controlled activities and processes are structured in the form of objects. See also: Task for file transferTransfers files from one computer to another. A particular Automation Engine object type (FileTransfer object). (destination).

AH_ProcessId=

TNS/Process ID.

AH_CpuTime=

Used CPU time.

AH_KernelTime=

Used system time.

AH_UserTime=

Used userIn the Automation Engine, a user is an instance of a User object, and generally the user is a specific person who works with Automic products. The User object is assigned a user ID and then a set of access rights to various parts of the Automation Engine system and product suite. These access rights come in the form of Automation Engine authorizations and privileges, Decision user roles and EventBase rights and ARA web application object rights. You can manage all these centrally in the ECC user management functions. See also, Unified user management. time.

AH_IOCount=

IO counter.

AH_InfoText=

Text from the agent.

AH_HostDst=

The hostComputer, target system. name for the file transfer (destination).

AH_CodeNameDst=

The code tableAn Automation Engine object type that defines a complete set of characters. for the file transfer (destination).

AH_FileNameDst=

The file name for the file transfer (destination).

AH_HostSrc=

The host name for the file transfer (source).

AH_LoginSrc=

The name of the Login object for the file transfer (source).

AH_CodeNameSrc=

The code table for the file transfer (source).

AH_FileNameSrc=

The file name for the file transfer (source).

AH_Count=

The number of transferred bytes (for file transfer) or started tasks (for a groupAn Automation Engine object type that integrates tasks so that they can be processed together.).

AH_FileSize=

The bytes of the complete file.

AH_Records=

The number of records in the file.

AH_Status=

Status of the activityAn activity (or task) is an entity that can be planned, assigned to a user or a team and tracked with respect to their plan and state (started, cancelled, suspended, completed)..

AH_RetCode=

The taskAn executable object that is running. Tasks are also referred to as activities.'s return codeThe value that represents the result of tasks and script functions. .

AH_Restart=

The restarted activation.

AH_RefNr=

The RunIDShort for "run number". It is a number that provides unique information about a task's execution. The RunID can include 7 to 10 digits. It is assigned by the Automation Engine component . of the reference task for a restartA restart refers to the repetition of an object's execution. This action differs from a new start in some parts..

AH_RestartPoint=

The restart point of the restarted task .

AH_LastRP=

The last processed restart point.

AH_EventType=

TT - Time eventAction that is triggered if particular conditions apply. It can be an Automation Engine object type or an entry in a Policy Orchestrator EventBase. (timer).
TS - Time event (time of execution).

AH_RepeatType=

Event:
R = repeated
S = single
File transfer: include subdirectories
R = yes
S = no

AH_TimePeriod=

The period in minutes or HHMM depending on the event type.

AH_CheckCount=

The number of checks.

AH_OccurCount=

The number of occurred events.

AH_EventSubType=

The event's subtype

AH_Operator=

G = greater
L = less
E = equal
N = not equal

AH_Value=

Comparing value

AH_Unit=

The unit of the comparing value:
0 = host specific
1 = Byte
2 = Kilobyte
3 = Megabyte
4 = Gigabyte
5 = Terabyte

AH_Cancel=

Cancels the flag:
M = manually

AH_Source=

WIN_EVENT: Source

AH_Category=

WIN_EVENT: Category

AH_TExecType=

Time event with a start time:
E = execute
N = do not execute
Time event with an interval:
S = start immediately
File transfer:
1 = File transfer with wildcard charactersThese are placeholders for characters when you specify filters. ? stands for exactly one character, * for any number of characters.

AH_MaxRetCode=

The return code settings of the Runtime tab.

AH_IntAccount=

The internal account of the Attributes tab.

AH_Name=

The name of the object.

AH_Transferred=

The transferred number of bytes.

AH_Compress=

The compression type

"0" - None
"1" - Normal
"2" - Strong

AH_Ert= Estimated runtimeThe duration of a task's execution. It refers to the period between a task's start and end. It does not include its activation period (see also: activation and start)..

AH_Archive1=

The archive key 1 of the Header tab.

AH_Archive2=

The archive key 2 of the Header tab.

AH_Info=

Additional information, such as jobAn Automation Engine object type for a process that runs on a target system. number.

AH_ParentAct=

The parentThere are different ways of activating objects. The originator of an activation is referred to as the superordinate task (parent). See also: Child; Children's ID (Activator).

AH_ParentPrc=

The parent's ID (Processor).

AH_DeleteFlag=

Deletion flag.

AH_TaskCount=

The number of tasks.

AH_ArchiveFlag=

The archive flag.

AH_Rest=

Additional attributes.

AH_TZ=

The TimeZone for object and scriptA particular Automation Engine object type..

AH_TimePeriodTZ=

The TimeZone for the event.

AH_ReuseHostGroup=

Re-using the agent groupAn agent group combines agents of the same platform. The agents that should be included in an agent group are specified by entering the agent name or via filters. A task that runs in an agent group is processed on one or all of the agent group's agents, depending on the specified mode. A particular Automation Engine object type. calculation in workflows.

AH_HGSrc=

The name of an agent group.

AH_HGDst=

The name of an agent group as the destination of file transfers.

AH_MaxParallelHG=

The maximum number of parallel tasks in agent groups.

AH_ChildCnt=

The number of subordinated tasks.

AH_ChildCntFail=

The number of subordinated tasks that have been canceled and successfully repeated.

AH_ChildCntFailAll=

The umber of subordinated tasks that have been canceled.

AH_ChildCntRestart=

The number of subordinated tasks that have been repeated.

AH_ContainerType=

The object typeAn individual object is provided for the individual activities: There are User, UserGroup, Notification, Cockpit, CodeTable, Documentation, Event, Agent, FileTransfer, Group, Include, Job, Workflow, Calendar, Login, Client, RemoteTaskManager, Schedule, Script, Server, Sync, Variable and TimeZone objects of the related container.

[ODBC]

 

SQLDRIVERCONNECT=

The database connection.

ODBCVAR - Eight-digit command field for controlling database accesses.

1. Position = N - Do not use server cursor.
1. Position = S - Use server cursor (MS SQL Server 2000).
2. Position = N - Do not reestablish database connection after 1000 commits.
2. Position = D - Disconnects the database after 1000 commits (perhaps due to memory problems).
3. Position = N - Field names are compared case-sensitively (Oracle).
3. Position = J - Field names are compared case-insensitively (Oracle).
4. Position = N - Not used.
5. Position = N - The type of the database connection: ODBC
5. Position = I - The type of the database connection: OCI/CLI.
6. Position = N - Database access without the User ID.
6. Position = O - Database access with the User ID.
7. Position = N - Compression is deactivated.
7. Position = R - Compression is activated.
8. Position = The type of SQL syntax; N - MS SQL Server
8. Position = The type of SQL syntax; O - Oracle
8. Position = The type of SQL syntax; D - DB2

DSN - The alias name of the database connection.
UID - The User ID for the database access.
PWD - The passwordA secret combination of characters for a Automation Engine user. for the database access. Should always (also "") be encoded. See: Encoding passwords

Only for ORACLE:
The code-page settings must correspond to those of the database. Automic recommends using the variableIt stores or retrieves values dynamically at runtime. An individual Automation Engine object type. NLS_LANG or the parameter SP=.

Syntax:
SP=NLS_LANGUAGE=language,NLS_TERRITORY=area,CODESET=character set,RECONNECT=interval,commit_write='BATCH,NOWAIT'

RECONNECT refers to the frequency that is used to re-establish the database connection. This parameter is given priority even if a "D" is set in the 2nd digit of ODBCVAR (see above).

Automic recommends using the parameter commit_write='BATCH,NOWAIT' in order to increase performance.

For example:
(Two lines are used for the connection parameters for lack of space. In the INI file, you should only use one line).

SQLDRIVERCONNECT=ODBCVAR=NNJNIORO,DSN=UC4;UID=uc4;PWD=--1037B2E22BF022EBE2;
SP=NLS_LANGUAGE=AMERICAN,NLS_TERRITORY=AMERICA,CODESET=WE8ISO8859P15,commit_write='BATCH,NOWAIT'

See also: Setting up ORACLE databases

See:Notes for Configuration-File Adjustments

Example of an INI File

[GLOBAL]
helplib=uc.msl
Helpcache=all
language=E
logging=..\TEMP\UCYBDBArchiv_LOGG_##.TXT
logcount=10
MaxDeadlockCount = 2
docu_path=C:\AUTOMIC\Documentation
cmd="javaw" -jar -cp .;.\UC4LAF.jar UCYBDBAR.jar
path=.
title=UC4 DB-


[ENVIRONMENT]
classpath=.;.\UC4LAF.jar


[TRACE]
file=..\TEMP\UCYBDBArchiv_TRACE_##.TXT
trccount=10
database=0


[AH_BODY]
AH_TimeStamp1     = 1   ; start time
AH_TimeStamp4     = 1   ; end time
AH_MsgNr          = 1   ; return code
AH_LoginDst       = 1   ; name of Login object
AH_ProcessId      = 1   ; TSN / process id
AH_CpuTime        = 1   ; used CPU time
AH_KernelTime     = 1   ; used kernel time
AH_UserTime       = 1   ; used user time
AH_IOCount        = 1   ; count of I/Os
AH_InfoText       = 1   ; text from agent
AH_HostDst        = 1   ; name of the agent or agentgroup
AH_CodeNameDst    = 1   ; codetable for filetransfer
AH_FileNameDst    = 1   ; filename for filetransfer
AH_HostSrc        = 1   ; name of agent (sender)
AH_LoginSrc       = 1   ; name of Login object for sender file
AH_CodeNameSrc    = 1   ; codetable for filetransfer (sender)
AH_FileNameSrc    = 1   ; filename for filetransfer (sender)
AH_Count          = 1   ; filetransfer: bytes transfered     group: number of started activities
AH_FileSize       = 1   ; bytes of the complete file
AH_Records        = 1   ; number of records
AH_Status         = 1   ; state of the activity
AH_RetCode        = 1   ; return code
AH_Restart        = 1   ; was this a restarted activation?
AH_RefNr          = 1   ; reference job number
AH_RestartPoint   = 1   ; restart point from where the task was restarted
AH_LastRP         = 1   ; last processed restart point
AH_EventType      = 1   ; TT time event(timer), TS time event(time of execution)
AH_RepeatType     = 1   ; EV: R=repeated, S=single    FT: include subdirectories R=yes S=no
AH_TimePeriod     = 1   ; period in minutes or HHMM depending on the event type
AH_CheckCount     = 1   ; number of checks
AH_OccurCount     = 1   ; number of occourred events
AH_EventSubType   = 1   ; event sub type
AH_Operator       = 1   ; G = Greater L = Less E = Equal N = NotEqual
AH_Value          = 1   ; value to compare
AH_Unit           = 1   ; unit of AH_Wert: 0=host specific, 1 = Byte, 2=KB, 3 = MB, 4=GB, 5=TB
AH_Cancel         = 1   ; the cancel flag: M=manually
AH_Source         = 1   ; WIN_EVENT: Source
AH_Category       = 1   ; WIN_EVENT: Category
AH_TExecType      = 1   ; EV-TS: start after 'start time' E=Execute N=NoExecute EV-TT:S=start immediately     FT: 1=filetransfer with wildcard characters
AH_MaxRetCode     = 1   ; up to this retcode the activity is ENDED_OK
AH_IntAccount     = 1   ; account
AH_Name           = 1   ; name of the object
AH_Transferred    = 1   ; Transferred bytes
AH_Compress       = 1   ; Compress level
AH_Ert = 1; Estimated runtime
AH_Archive1       = 0   ; archive key 1
AH_Archive2       = 0   ; archive key 2
AH_Info           = 0   ; additional information like job number
AH_ParentAct      = 0   ; AH_Idnr of activator parent
AH_ParentPrc      = 0   ; AH_Idnr of processor parent
AH_DeleteFlag     = 0   ; the delete flag
AH_TaskCount      = 0   ; number of AJPP
AH_ArchiveFlag    = 0   ; archive flag
AH_Rest           = 0   ; . additional attributes
AH_TZ             = 0   ; Timezone for object and script
AH_TimePeriodTZ   = 0   ; Timezone for time period (event) when HHMM is used
AH_ReuseHostGroup = 0   ; reuse agentgroup in workflow
AH_HGSrc          = 0   ; name of agentgroup
AH_HGDst          = 0   ; name of agentgroup (source)
AH_MaxParallelHG  = 0   ; agentgroup max parallel
AH_ChildCnt       = 0   ; children count
AH_ChildCntFail   = 0   ; failed children - successful restarted
AH_ChildCntFailAll= 0   ; failed children total
AH_ChildCntRestart= 0   ; restarted children
AH_ContainerType  = 0   ; object type controlled by the container


[ODBC]
; ODBCVAR xxxxxxxx
;         |||||||+ type of SQL-Syntax N=SQL-SERVER  O=ORACLE  D=DB2
;         ||||||+- R=compress messages and local memory
;         |||||+-- O = with userid, N = without userid
;         ||||+--- I=OCI/CLI N=ODBC
;         |||+---- not used
;         ||+----- J = compare fieldnames case-insensitive (in case of ORACLE !!)
;         |+------ D = DB-Disconnect after 1000 commits (perhaps in case of Oracle memory leaks)
;         +------- S = use Server-Cursor (SQL-SERVER)
;
;         SNNNNNRN for SQL-Server 2000
;         NNNNNNRN for SQL-Server 2005
;         NNJNINRO for Oracle 8.x with OCI (Oracle Call Interface)
;         NNJNIORD for DB2/NT/UNIX with CLI (Call Level Interface)

; SQL-Server 2000 with ODBC
SQLDRIVERCONNECT=ODBCVAR=SNNNNNRN,DSN=UC4;UID=uc4;PWD=10BFDC349F38156A22
; SQL-Server 2005 with ODBC
;SQLDRIVERCONNECT=ODBCVAR=SNNNNNRN,DSN=UC4;UID=uc4;PWD=UC4
; Oracle with OCI
;SQLDRIVERCONNECT=ODBCVAR=NNJNIORO,DSN=UC4;UID=scott;PWD=tiger
; DB2 with CLI
;SQLDRIVERCONNECT=ODBCVAR=NNJNIORD,DSN=UC4;UID=uc4;PWD=UC4

See also:

General Procedure - Database Maintenance
Archive Browser

Archiving

Structure of the Archived Folder

 


Automic Documentation - Tutorials - Automic Blog - Resources - Training & Services - Automic YouTube Channel - Download Center - Support

Copyright © 2016 Automic Software GmbH