Archive Profile

Archive Profile

Profiles that define storage, naming schemes, and lifetimes for targeted files reside in the Archive profile. You can configure several workflows to use the same Archive profile, but only one of these workflows may be active at a time.

The system loads the Archive profile when you start a workflow that depends on it. Changes to the Archive profile take effect when you restart the workflow.

Configuration

To create a new Archive profile configuration:

  1. Click the New Configuration button in the upper-left part of the Desktop window.

  2. Select Archive Profile from the menu.

Archive profile configuration dialog

The menu bar contents can change depending on the configuration type that you open. The Archive profile uses the standard menu items and buttons that are visible for all configurations. These items are described in Configuration View.

The External References button is specific to Archive profile configurations.

Button

Description

Button

Description

External References

Select to Enable External References in an Agent profile field. For details, see External Reference Profile. See also, https://infozone.atlassian.net/wiki/spaces/MD95/pages/1195081745/XE-22856+Archive+Profile#Enabling-External-Referencing below.

The Archive File Naming Algorithm builds the full path of each filename that the system stores in the archive. The algorithm uses three parameters:

  • AAA/BBB/CCC

Name placeholder

Description

Name placeholder

Description

AAA

Represents one of the base directories from the Base Directory list in the Archive profile. If several base directories exist, the value changes according to the frequency that you select from the Switch Policy list. The system automatically appends a directory delimiter after this value.

BBB

Represents the directory structure that the Directory Template constructs. If the template contains one or several Directory delimiters, this part contains one or several directory levels.
For example, if the template contains Month, Directory delimiter, and Day, the system creates new directories every day, named 03/01, 03/02, and so on, up to 03/31, then 04/01, 04/02, and so on, up to 04/30. In this example, the system stores files in a directory structure that contains all months, and under each month a directory for each day. The system automatically appends a directory delimiter after this part.

CCC

Represents the filename. You define this name for each Archiving agent by using the settings on the Filename Template tab in the Archiving agent configuration dialog.

The Archive profile configuration contains the following settings:

Setting

Description

Setting

Description

Switch Policy

Determines how long the Archive services populate each base directory before they switch to the next base directory when you configure several base directories. You can configure daily, weekly, or monthly switch intervals. After the Archive services have populated the last base directory, archiving wraps to the first base directory again.

Base Directory

Defines one or several base directories that the system uses to archive files. For large amounts of archived data, you may need several base directories on different disk partitions.

Directory Template

Defines a list of tokens that, at run time, build subdirectory names that the system appends to one of the base directories. The tokens can be special tokens or user-defined values. You can construct subdirectories at any level by using the special token Directory delimiter. For details about these tokens, see https://infozone.atlassian.net/wiki/spaces/MD95/pages/1195081745/XE-22856+Archive+Profile#Directory-Template below.

Remove Entries (days)

If you enable this option, the system deletes files that are older than the defined retention period. The Archiving agent type that uses the Archive profile controls how the system removes files:

  • Local Archiving agent - For workflows that use a Local Archiving agent, the workflow deletes outdated files, not the Workflow Types task. The workflow removes files from the archive directory in the initialize block. The workflow runs this cleanup only if at least three hours have passed since the previous purge.

  • Archiving agent - For workflows that use an Archiving agent, the Workflow Types task deletes outdated files. Archive Cleaner removes both file references from the Platform database and the corresponding files from the archive directory. The purge frequency depends on how you configure the Archive Cleaner schedule in the Archive Cleaner workflow group.

Note!

You can set the retention period to any value from 1 to 365 days. Values greater than 365 days are not supported.

Note!

The system removes files recursively. You must not use a base directory that resides inside another Archive profile base directory, because cleanup in one profile can affect files in another profile.

Note!

If you use the Local Archiving agent together with the Inter Workflow collection agent, you can enable cleanup of outdated files only through the Inter Workflow agent configuration:

  1. Open the Inter Workflow agent configuration dialog.

  2. Select the Deactivate on Idle check box.

  3. Save the configuration.

For more information about how the system removes outdated files in each case, see Maintaining Archives.

Keep Files

Prevents the system from deleting files.

If you enable both Keep Files and Remove Entries (days), the system removes only the references in the database and keeps the files on disk. This behavior does not apply to the Local Archiving agent.

Directory Template

When you add a Directory Template entry, you configure the following:

Add Directory Template dialog

Setting

Description

Setting

Description

Special token

Tokens that the system uses as part of the directory name:

  • Year - Inserts four digits that represent the year when the system archived the file.

  • Month - Inserts two digits that represent the month when the system archived the file.

  • Day - Inserts two digits that represent the day of the month when the system archived the file.

  • Hour - Inserts two digits that represent the hour, in twenty-four hour format, when the system archived the file.

  • Agent directory name - Inserts the MIM value or values from the Agent Directory Name list in the Archiving agent configuration dialog.

  • Day index - Inserts a day index between zero and the value in the Remove Entries (days) field. The index increases by one each day until it reaches one less than the Remove Entries (days) value. It then wraps back to zero. You cannot use Day index in the template if Remove Entries (days) is disabled.

  • Directory delimiter - Inserts the standard directory delimiter for the operating system that receives the files. This token creates a subdirectory.

Text

If enabled, you enter the token in a text field. If disabled, you select the token from the Special token list.

Enabling External Referencing

To enable external referencing of Archive profile fields:

  1. Click the External References button in the Archive profile configuration.

  2. Configure the external references as described in External Reference Profile.

You can configure the following Archive profile fields using External Reference Profile.

Setting

Description

Setting

Description

Base Directory

The Base Directory external reference field accepts a comma‑separated list of directory paths.

Example – Configuring Base Directory values when using the Properties File external reference type

In the following example, the Base Directory is represented by myBaseDirectoryKey as the Properties File Key.

myBaseDirectoryKey = /mypath/no1, /mypath/no2

Remove Entries (days)

The Remove Entries external reference field accepts numeric numbers ranging from -1 to 365.

Example – Configuring Remove Entries values when using the Properties File external reference type

In the following example, the Remove Entries external reference field is represented by myRemoveEntriesKey as the properties file key. The values and their meanings are:

myRemoveEntriesKey = 1 #! Remove after 1 day myRemoveEntriesKey = 365 #! Remove after 365 days myRemoveEntriesKey = -1 #! Do not remove. #! This value is equivalent to clearing the check box.

Keep Files

Valid values for the Keep Files external reference field and their meanings are as follows:

  • A true or yes value is equivalent to selecting the check box.

  • A false or no value is equivalent to clearing the check box.