2.1 Understanding Retain Jobs

If your messaging platforms require pull-based archiving, you need a basic understanding of Retain Jobs and their components: modules, schedules, profiles, and workers, as illustrated in Figure 2-1 and explained in Table 2-1.

Figure 2-1 The Components That Make Up a Job

Table 2-1 Job Component Information and Links


Brief Description


Retain Modules are the foundation that links messaging systems to Retain. To set up a Job, you must first create a Module for the targeted messaging system so that the Retain Server can connect to it. Each module is as unique as the system it represents.

Both Retain archiving models require a module. For Pull-based archiving, you cannot create Profiles or Jobs until after you create Modules for them.

After you complete the instructions in this chapter, you are directed to Section 2.0, Setting Up Pull-Based Archiving, which contains module-creation instructions.


Schedules define the time framework that jobs run within.

They can set up a single time for a job to run or they can specify recurring times.

Schedules are not module- or job-specific. You can use a schedule with as many jobs as makes sense.

HINT:The order implied by the letters in Figure 2-1, reflects the process of creating jobs, beginning with module creation.

However, as a best practice, you might want to start by planning the best times for your jobs to run, and then create schedules that reflect your plans.

For instructions on creating schedules, see Schedules.


Profiles define what Retain retrieves from the message system. You can archive everything or filter by time periods, folders, subjects, and how the data is stored.

Profiles are module-specific and module-dependent.

Profiles perform duplicate checking, which keeps the Retain system from storing multiple instances of the same message.

Instructions for creating profiles are contained in their relevant platform sections.


Workers pull data from message-system servers.

They track their associated jobs, when to start them (the schedule), and which items to retrieve (the profile).

Workers can only run one job at a time.

They are not module-specific, but they might require module-specific settings in the module-specific tab.

Each Worker has two parts:

  • Worker Agent: Retrieves and initially processes message data.

  • Worker Web Object: Connects (bootstraps) the Worker Agent and the Retain Server.

Instructions for creating and setting up Workers are found in Creating Workers.


Jobs tie all the other components together.

Jobs specify which mailboxes (users and groups) Retain archives on the targeted systems.

Jobs and Modules tie directly to each other. You select one or more modules by name before creating the Job.

Instructions for creating jobs are contained in their relevant platform sections.