Inside Automation Engine > XML Files of Objects > Calendar > Structure of the Export File

 Export-File Structure

The table shown below describes the XML-file structure of a Calendar objectAutomation Engine controlled activities and processes are structured in the form of objects. See also: Task and explains the individual elements.


Element

Description

uc-export

Main element of the export file

clientvers = Automation EngineThis component drives an Automation Engine system and consists of different types of server processes. version in which the export file was created

CALE

Main element of the object

clientA closed environment within an Automation Engine system where you can create and run objects. A client name consists of a 4-digit number that must be indicated when a user logs on to the Automation Engine system. Users and their rights are also defined in clients. A particular Automation Engine object type. = The client.
name = The name of the object.
system = The name of the AE system.

HEADER

Header tab

XHEADER in executable objects

HEADER = in active, passive and system objects

see object types

The attribute "stateThe state a package or a task currently is in." is used system-internally and must not be changed.

Title

Title

User-defined,

max. 255 characters

Created

Time of creation

Format:
First and last name
on: YYYY-MM-DD HH:MM:SS

Modified

Time of last modification

Format:
First and last name on: YYYY-MM-DD HH:MM:SS Total number of modifications x

LastUsed

Time of last use

Format:
First and last name
on: YYYY-MM-DD HH:MM:SS Total number of uses x

CALE

Calendar tab

in Calendar objects

The attribute "state" is used system-internally and must not be changed.

CaleData

Calendar definition

CaleData: content of the Calendar
The attribute "periods" is used system-internally and must not be changed.

Keywords: List of all Calendar keywords

Keyword

Definition of Calendar keywords

CType: Type
Allowed values: "S" (Static), "Y" (Annually), "M" (Monthly", "W" (Weekly), "G" (Group) and "R" (Roll)

The attributes "ErrMsgInsert", "ErrMsgNr", "MsgNr" and "state" are used system-internally and must not be changed.

SType: Method for filling in
Allowed values: "A" (absolute), "I" (interval)

ValidFrom, ValidTo: Calculation period

Name: Name of the Calendar keyword

Static

Calendar keyword "Static" 

Month: Days of the month included in the Calendar keyword
mm = Two-digit number of month
yyyy = Four-digit number of year

Yearly

Calendar keyword "Yearly" 

Direction: Counting direction
Allowed values: "B" (from the beginning), "E" (from the end)

Interval: Each nth day
IntervalEnd: Ending with the day (format: DDMM)
IntervalStart: Starting with the day (format: DDMM)
Period: Each nth year
PeriodEnd: Not used
PeriodStart: Starting year
DefDays: Selected days

Monthly

Calendar keyword "Monthly"

Direction: Counting direction
Allowed values: "B" (from the beginning), "E" (from the end)

Interval: Each nth day
IntervalEnd: Ending with day n
IntervalStart: Starting with day n
Period: Each nth month
PeriodEnd: Ending with month n
PeriodStart: Starting with month n
DefDays: The nth day of the month (calculated from the beginning or end)

Weekly

Calendar keyword of type "Weekly"

Direction: Not used
Interval: Not used
IntervalEnd: Not used
IntervalStart: Not used
Period: Each nth  week
PeriodEnd: Ending with week n
PeriodStart: Starting with week n
DefDays: Days of the week
Allowed values: "MO", "TU", "WE", "TH", "FR", "SA" and "SU"

Group

Calendar keyword of type "Group" 

A flag: All the following calendarsShows a calendar overview of activities, releases or reservations. apply
N flag: None of the following calendars apply
O flag: At least one of the following calendars apply

CaleKeyName: Name of the keyword object
CaleName: Name of the Calendar object
id: Internal number of the Calendar object (OH_Idnr)

Roll

Calendar keyword of type "Roll" 

RCaleAdjust: "0" (no adjustment), "1" (adjustment)
RCaleIdnr: Internal number of the Calendar object (OH_Idnr)
RCaleKeyName: Source keyword
RCaleName: Source Calendar object
RCaleOffset: Offset
RCaleOperator: Action
RCaleRef: "0" (no adjustment), "1" (adjustment)
RCaleRefIdnr: Internal number of the Calendar object (OH_Idnr)
RRCaleKeyName: Name of the Calendar object for the area
RRCaleName: Name of the Calendar keyword for the area

CaleKeyName: Name of the colliding Calendar keyword
CaleName: Name of the colliding Calendar object
Offset: Offset
Operator: Action
RCaleIdnr: Internal number of the colliding Calendar object (OH_Idnr)
RCaleKeyName: Name of the Calendar keyword for movement
RCaleName: Name of the Calendar object for movement
id: Internal number of the Calendar object (OH_Idnr) for movement

DOCU_Title

Documentation tab

in all objects (DOCU_Title)

The attribute "state" is used system-internally and must not be changed.

The attribute "type" shows the type of documentation:

text = normal documentation
xml = structured documentation

DOC

Content of the Documentation tab

Depending on the documentation type, the CDATA section contains the text or the XML structure.

 

See also:

Export file of a Calendar
Structure of the XML files or imports and exports

 


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

Copyright © 2016 Automic Software GmbH