Local Archiving Agent

Local Archiving Agent

You open the Archiving Local agent configuration dialog from a workflow configuration. To open the Archiving forwarding agent configuration, click  Configuration → New Configuration. Select  Workflow from the Configurations dialog. When prompted to select workflow type, select Batch. Click Add agent and select Archiving Local from the Forwarding tab of the Agent Selection dialog.

You open the Archiving Local agent configuration dialog from a workflow configuration.

To create a workflow that uses the Archiving Local agent:

  1. In Desktop, click Configuration -> New Configuration.

  2. In the Configurations dialog, select Workflow.

  3. When prompted to select workflow type, select Batch.

  4. Click Add agent.

  5. In the Agent Selection dialog, open the Forwarding tab and select Archiving Local.

The Archiving Local agent configuration dialog - Archiving Local tab

The Archiving Local tab in the Archiving Local agent configuration dialog contains the following settings:

Setting

Option

Setting

Option

Profile

Defines the name of the Archive profile that determines the attributes of the target files.

All workflows in the same workflow configuration that use the Archiving Local agent may use separate Archive profiles. To assign different profiles per workflow:

  1. Open the Workflow Properties dialog.

  2. Open the Workflow Table tab.

  3. Set the profile to Default.

  4. Assign the correct Archive profile to each workflow in the table.

Input Type

Defines the input type that the agent processes. The agent behavior depends on the configured input type.

Compression

Defines whether the agent compresses the target files before storage, and which compression type it uses.

  • No Compression - The agent does not compress the files.

  • Gzip - The agent compresses the files by using gzip.

Note!

The system does not append an extra extension to target filenames, even if you enable compression. The system manages filename configuration only in the Filename Template tab.

Agent Directory Name

Defines one or more MIM resources that the system uses when it names the subdirectory where it stores archived files.

If you select more than one MIM resource, the values that form the directory name are separated by a dot.

Note!

If you select at least one Agent Directory Name token in Directory Templates in the Archive profile, the system uses this directory field when it builds the archive directory structure.

Produce Empty Files

Enables the agent to create files even when no data is available.

Note!

The system determines the names of the created files by using the settings in the Filename Template tab. For more information about the Filename Template service, see: Workflow Template.

Note!

For workflows that use a Local Archiving agent, the workflow that contains the Local Archiving agent deletes outdated files. The Archive Cleaner task does not delete files for Local Archiving agents.

When a Local Archiving agent uses an Archive profile with Remove Entries (days) enabled, the workflow removes files from the archive directory during its cleanup phase as soon as they are older than the configured number of days. The workflow performs this removal in the initialize block of the Local Archiving agent.

Because the workflow controls when cleanup runs, the timing and timestamps of deleted files in Local Archiving directories do not match the Archive Cleaner schedule that applies to the Archiving agent. For workflows that contain a Local Archiving agent, the workflow runs cleanup at least three hours after the previous purge. The workflow compares the last modified timestamp of each archive file with the configured Remove Entries (days) value to determine whether a file is outdated. The Archive Cleaner schedule in the Archive Cleaner workflow group does not reflect or control this workflow-based cleanup cycle.