# Jobs

Using **Jobs**, you can establish a session to any available repository. To access **Jobs**, click the **Jobs** <img src="https://719145889-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F34SqczmUmN6PfmZmjkFe%2Fuploads%2FDWDOVdJ0k8DyH4jAGcKO%2FJobs%20toolbar%20button.png?alt=media&#x26;token=ee349e4c-403a-4879-b269-a98a72a856c0" alt="" data-size="line"> button on the toolbar.&#x20;

### Jobs: Log in/Log out

**To log in** and start open a Jobs window, either click the **Jobs** button on the toolbar or go to the **Jobs** menu and click **New Jobs Window**. If a **Jobs** window without a connection is already open, the **Connect** button on the toolbar/from the context menu of the root of the navigation tree/on the **Jobs** menu will open the login screen. Then, follow the log in procedures - for more information, see [connecting-to-documentum](https://docs.dqman.com/dqman-opentext-documentum-22.1/connecting-to-documentum "mention").

**To log out**, click **Disconnect** on the toolbar/from the context menu of the root of the navigation tree/on the **Jobs** menu.

#### The Jobs Interface Explained

**Jobs List**\
Displays the Documentum jobs, which can be colored differently according to their attributes (active jobs are colored differently than inactive jobs). This function is available in the **Options** dialog. You can sort the **Job** **List** by clicking the desired column header. Displayed jobs are subject to the selected node in the navigation tree and the filter settings.

**Navigation Tree**\
Click repository to display Repository jobs. Click **All jobs** to display all the jobs of all repositories with a valid session are shown.\
You can hide the navigation tree, in which case the last selection stays active and governs the contents of the job list.

**Filter**\
Filter settings additionally influence the contents of the job list.

**Toolbar**\
Displays the buttons for most frequently used functions.

**Status bar**\
Displays additional information.

#### Filter Management

Available filters are displayed as tabs on top of the job list. Selecting a tab activates the corresponding filter. To add an individual filter, click the **Filter** button. Possible settings are:

<table><thead><tr><th width="217.43661971830988">Filter Name</th><th>Filter Function</th><th data-hidden></th><th data-hidden></th><th data-hidden></th></tr></thead><tbody><tr><td><strong>Name</strong></td><td>One or more initial characters of job names. Separate multiple search expressions by semicolon, such as: <code>dm_DM;dm_audit</code>.</td><td></td><td></td><td></td></tr><tr><td><strong>Status</strong></td><td>All active/inactive jobs.</td><td></td><td></td><td></td></tr><tr><td><strong>Run</strong></td><td>All running/dormant/started jobs.</td><td></td><td></td><td></td></tr><tr><td><strong>Result</strong></td><td>All successfully executed/faulty jobs.</td><td></td><td></td><td></td></tr><tr><td><strong>Schedule</strong></td><td>Jobs that are about to be executed, that have just finished or that are overdue.</td><td></td><td></td><td></td></tr><tr><td><strong>Predicate</strong></td><td>A DQL predicate (the <em>where</em> part of a query without the WHERE expression, such as <em>object_name like ‘dm%’</em> or subject such as <code>‘%Execute%’</code>.</td><td></td><td></td><td></td></tr><tr><td><strong>Clear</strong></td><td>Clears all filter settings.</td><td></td><td></td><td></td></tr></tbody></table>

You can combine filter settings in any way. The individual filter will be added as a tab with the label **Current Filter** to the filter tabs and will be available for all repositories until Jobs is terminated.

To save an individual filter or make any other changes to existing filters, click ***Extras** menu > **Filter management tool***.

#### Automatic Refresh

To configure the automatic refresh of the job list, go to the **Options** dialog.

#### Additional Information

Hover your mouse over single jobs to display additional information in a tooltip.&#x20;

## Jobs Functions

#### Job Control

To control jobs, use the the functions on the toolbar/the context menu of the job list/the **Edit** menu.

* **Run a Job**: Start the selected jobs.&#x20;
* **Run with Arguments**: Starting a job with arguments first prompts you to change existing arguments (this option is deactivated when selecting multiple jobs). If you activate the **Restore method arguments** **option after run** is activated, you can reset changed arguments to their original values after the job is completed. If Jobs is closed or the session is terminated before the next job run is completed, you cannot restore changed arguments anymore (you will be notified in this respect.
* **Stop a Job**: When manually starting a job, it can take several minutes for the content server to execute the job, during which time you can stop the job. If the job was started using the **Run with Arguments** function, the original arguments will be restored immediately.

### Job Management

Right-click the desired job for the following options:

* **Create Job**, then select the target repository. If called from the navigation tree, the job will be created in the selected repository. Next, configure the new job attributes. \
  Note that new jobs will always be deactivated to prevent unwanted automatic execution.
* **Copy Job** either within the same repository or to another repository, then define the attributes in the properties dialog. If the job method object is not available in the target repository, you can decide to copy it as well. However, the source files of the job will NOT be copied. If necessary, you may need to copy these files manually. \
  Note that copied jobs will always be deactivated to prevent an unwanted automatic execution.&#x20;
* **Delete Job**, in which case the selected `dm_job` object is removed.
* **Dump dm\_job Object**, then configure the new corresponding tab accordingly.
* **Dump dm\_method Object**, then configure the new corresponding tab accordingly.
* **Reset Job Status**, which clears all the attributes of the `dm_job` object that indicate that the job is running. Sometimes jobs are no longer linked to a running process but the status is not cleared automatically and you can clean it up by executing this function.

### Job Attributes

You can manage the following job attributes:

* **Activate/Deactivate**: Use the job list context menu or go to the **Edit** menu.
* **Job Properties**: Use the properties dialog available from the job list context menu or from the **Edit** menu. When finished, click **Save & Run**.
* **Method Properties**: Open and modify the properties of the `dm_method` object from the job properties dialog by clicking the **Method Properties** button next to the method name field.

### Reports

You can reopen the latest job report by clicking the **Report** button on the toolbar. You can access up to 20 older versions of job reports from the context menu of the job list. Depending on the file type, reports will open in an external viewer. The Content Type Auto Detection can detect HTML reports and redirect them to open in your default browser.

In the XTended version, the **Report** button in the toolbar or the **All Reports** item from the context menu will open the report browser, which displays (to the left) all available reports of the selected job.&#x20;

The functions on the report list context menu enable you to open reports in an external application, delete reports or truncate the reports list.

The following functions are available in the context menu:

<table><thead><tr><th>Function</th><th>What It Does</th><th data-hidden></th></tr></thead><tbody><tr><td><strong>Copy</strong></td><td>Copies the selected text to the clipboard.</td><td></td></tr><tr><td><strong>Select All</strong></td><td>Selects the entire report text.</td><td></td></tr><tr><td><strong>Dump Objetcs</strong></td><td>Opens a dump of an objects. You must select a valid <code>r_object_id</code>.</td><td></td></tr><tr><td><strong>Find</strong></td><td>Search for an expression.</td><td></td></tr><tr><td><strong>Find Next</strong></td><td>Search again for an expression.</td><td></td></tr><tr><td><strong>Scroll to End of Report</strong></td><td>Autoscroll to the end when opening a report</td><td></td></tr><tr><td><strong>Mark Expression</strong></td><td>Mark all occurrences of the selected expression in the report.</td><td></td></tr><tr><td><strong>Wordwrap</strong></td><td>Auto-wrap text at end of line.</td><td></td></tr></tbody></table>

### Agent Exec Settings

The `agent_exec` process provides you with some parameters to influence job execution. To modify these parameters, go to ***Session** men&#x75;**>Agent Exec Settings***.

Changes only take effect before the agent exec process is restarted on the Content Server.&#x20;

## Options

To access **Options**, which are are the central tool for adapting the features and functionalities of Jobs, go to the **Extras** menu.

### Settings

<table><thead><tr><th>Options Setting</th><th>What It Does</th><th data-hidden></th></tr></thead><tbody><tr><td><strong>Open session at start-up</strong></td><td>Automatically opens a login screen at start-up.</td><td></td></tr><tr><td><strong>Autoconnect on tree expansion</strong></td><td>Available if login credentials are saved with passwords. Sessions are automatically created and terminated using the logins from the history if repository nodes of the navigation tree are expanded or collapsed.</td><td></td></tr><tr><td><strong>Show job info hints</strong></td><td>Displays additional job information as hint.</td><td></td></tr><tr><td><strong>Report Viewer</strong></td><td>A viewer application for job reports and dumps. If no viewer is entered, the windows default application for text files will be used.</td><td></td></tr></tbody></table>

### Options Colors

Depending on their current status, Jobs can change colors.&#x20;

The settings are additive. If an inactive job is colored with a foreground color only, and a successful executed job with a certain background color only, an inactive successfully executed job will be colored with the appropriate color combination. Otherwise, the priority in coloring is from top to bottom, as displayed in the dialog.

Clear the **Colors** checkbox to deactivate this option.

### Columns

You can select the columns of the job list from all available `dm_job` attributes. In addition, the **DOCBASE** column displays the home repository of the job; the **NOTIFICATIONS** column displays the job notification settings.

Use the arrow buttons to sort the columns.

#### Auto Refresh

This function refreshes the displayed jobs and their properties in the job list. The refresh interval is freely selectable:

<table><thead><tr><th>Refresh Option</th><th>What It Does</th><th data-hidden></th></tr></thead><tbody><tr><td><strong>Off</strong></td><td>Automatic refresh is deactivated. </td><td></td></tr><tr><td><strong>Slow</strong></td><td>Refresh occurs every 3 minutes. </td><td></td></tr><tr><td><strong>Medium</strong></td><td>Refresh occurs every minute.</td><td></td></tr><tr><td><strong>Fast</strong></td><td>Refresh occurs every 15 seconds.</td><td></td></tr><tr><td><strong>Custom</strong></td><td>Free value in seconds, the minimum allowed refresh interval is 5 seconds.</td><td></td></tr></tbody></table>

&#x20;To reduce server activity, you can deactivate the auto refresh function after a certain time of user inactivity.