# Job Configuration

powerJobs Processor extends the Vault Client to display and edit [PowerJobs Processor Job Settings] directly in the Vault Client and allow queueing jobs for specific entities to test the configuration.<br>

## powerJobs Settings Dialog

The powerJobs Settings Dialog can be opened via the **Tools** → **powerJobs Settings...** menu entry in the Vault Client.

```{image} img/vault_menu.png
:width: 500px
```

The dialog displays the settings of all the jobs in the [jobs directory] on the current Job Processor machine.\
Newly [created jobs](jobprocessor/jobs/creating_job_scripts) in the jobs directory are display with their settings as soon as the dialog is closed and re-opened.

When a Vault entity (File, Item, Folder, Change Order or Custom Object) is selected in the Vault Client and the powerJobs Settings Dialog is opened, a job of the selected job type can be submitted for testing purposes.

### Job Settings

The Dialog displays the [Settings](<jobprocessor/jobs:job settings>) for the selected job type. The job type can be changed by clicking the arrow on the right and selecting a different entry.

```{image} img/job_dialog.png
:width: 600px
```

When a job is selected that declares Settings, the table displays the following information for each declares option:

- **Name**
- Settings current **Value**
- **Description**

#### Editing Settings
The values of settings can be edited by selecting a job from the dropdown list and clicking the **Edit** button.\
After clicking the button, the **Value** column of becomes editable.

Values are displayed based on the type of the [underlying powershell variables](<jobprocessor/jobs:job settings>):
- **Switch** settings allow to enable or disable particular job settings by clicking the Checkbox.
- **Text** settings allow to specify setting values as string contents.
- **Powershell** settings allow experienced users to specify settings as Powershell syntax which are evaluated as the job runs. Powershell settings are highlighted as underlined and italic in the dialog.

```{admonition} Warning
:class: warning

Multi-Line **Text settings** are currently not supported by the powerJobs Settings Dialog!<br>
This includes also setting specifications in the form of powershell line-feeds (`` `r`n ``, `` `n ``).
```

```{image} img/job_dialog_edit.png
:width: 600px
```

While the settings are edited, the job type can not be changed and jobs can not be submitted using the **Submit Job** button.\
The settings must either be saved using the **Apply** button or discarded with the **Cancel** button.
Pressing **Apply** writes the values verbatim to the [settings section](<jobprocessor/jobs:job settings>) in the Job.\
The **Cancel** button discards the current changes and revert all values back to the original values.

### Queueing Jobs

The **Submit Job** button adds a job of the selected type to the Job Queue for the currently selected entity in the Vault Client.<br>
The job will be triggered for the **exact version** of the selected Vault entity.<br>
The status bar then provides information on whether the job was successfully queued.

```{image} img/failed_to_submit_job.png
:width: 800px
```

Jobs that are added to the Job Queue using the powerJobs Settings Dialog are queued with entity specific parameters such as the _EnitiyId_ and _EntityType_ of the selected elements and are queued with priority 1 which is the highest job priority.<br>
The powerJobs Settings Dialog supports triggering jobs for _Files_, _Items_, _Folders_, _Change Orders_ and _Custom Objects_.

The following parameters are passed to the Job:

- `EntityId`
- `EntityClassId` (with value "FILE" for _Files_, etc.)

These parameters are used in the [Setup Job script](jobprocessor/jobs/setup_job:Setup_Job.ps1) to automatically create the Powershell representation of the [entity](jobprocessor/code_reference/objects) (`$File`, `$Folder`, `Item`, `Changeorder`, `Customobject`).<br>

### Enabling Job Queue

When the Settings Dialog is opened and a Vault User with enough permissions is signed into Vault, a check is performed whether the **Job Queue** is enabled on the current Vault Server and it tries to enable it in case it is disabled.<br>
The following Vault permissions are required to perform theses actions:

- _Vault Get Options_ to check if the Job Queue is enabled
- _Vault Set Options_ to enable the Job Queue on the Vault Server

[powerjobs processor job settings]: jobprocessor/jobs
[jobs directory]: jobprocessor/jobs.html#job-scripts