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:
Click the New Configuration button in the upper-left part of the Desktop window.
Select Archive Profile from the menu.
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 |
|---|---|
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 |
|---|---|
| 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. |
| 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. |
| 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 |
|---|---|
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:
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:
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:
Setting | Description |
|---|---|
Special token | Tokens that the system uses as part of the directory name:
|
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:
Click the External References button in the Archive profile configuration.
Configure the external references as described in External Reference Profile.
You can configure the following Archive profile fields using External Reference Profile.
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 = /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 = 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:
|