# Getting Started

## Overview

powerJobs Processor is an extension to the Vault JobProcessor.
This document will guide you through the first steps after the successful installation of powerJobs Processor on a Vault client machine which acts as a Job Server.

:::{warning}
Even though powerJobs Processor can run on every machine witch a Vault client, we recommend that powerJobs Processor is installed on a **dedicated** machine whose purpose is to act as a Job Processor.\
On the other hand powerJobs Client needs to be installed on each Vault client machine where it's behavior is desired.
:::

## Example how to use powerJobs

### Where do you find the jobs?

In the folder *C:\\ProgramData\\coolOrange\\powerJobs\\Jobs* there are all the sample jobs for the powerJobs Processor.

```{image} /img/pj-gs-001-jobsfolder.png
:width: 500px
```

### Create your own Job to create PDFs

Rename the job *Sample.CreatePDF.ps1* to *Custom.CreatePDF.ps1* so your PDF job can be identified as your own job and will not be overwritten by future updates. You can modify this copied job as you please.

### How to embed the Job in a Status Change

If, for example, you would like to create a PDF of drawing files (IDW and DWG) when the drawings are released in Vault, you need to do the following:

1. Open Vault Professional 2021 and edit the Lifecycle you use for your IDW and DWG files. In the “Transitions” tab, select and edit the “Work in Progress to Released” transition

   > ```{image} /img/pj-gs-002-confistate.png
   > :width: 700px
   > ```

2. In the tab “Actions” activate the option to “Synchronize Properties using Job Server” to be sure all properties will be up to date into the PDF file that powerJobs will create.

   > ```{image} /img/pj-gs-003-syncprop.png
   > :width: 480px
   > ```

3. In the tab “Custom Job Types” Add a custom job type and write the name of the MyCompanyName.CreatePDF.ps1 file without the extension. Confirm with “OK” button.

   > ```{image} /img/pj-gs-004-addjob.png
   > :width: 450px
   > ```

Your Vault is now configured to create a PDF file from IDW and DWG files that transit from Work in Progress to Released.

## Use the Job on a Lifecycle Change

1. Select an Inventor drawing (IDW or DWG) in Vault and select command “Change State”.

2. In the Change State dialog select the “Released” state -the state you have added the job for the transition - and press the OK button:

   > ```{image} /img/pj-gs-005-changestate.png
   > :width: 900px
   > ```

3. In case you have the powerJobs Client installed you will get a Windows notification after a few seconds that the job was added to the Job Queue.

   > ```{image} /img/pj-gs-006-pjclient.png
   > :width: 400px
   > ```

4. Select the command “Job Queue …” from the Tools menu to open the Job Queue.

5. In the Job Server Queue dialog, you will now find 2 jobs in a pending state:

   > - One for synchronizing the properties
   > - One to publish the PDF for the drawing

6. On the Job Server machine start powerJobs Processor from the shortcut on your desktop

   > ```{image} /img/pj-gs-007-pjicon.png
   > ```

7. Log in to your Vault:

   > ```{image} /img/pj-gs-008-login.png
   > ```

8. After powerJobs Processor started you can see how the jobs are processed:

   > ```{image} /img/pj-gs-009-pjprocessor.png
   > :width: 700px
   > ```

:::{warning}
The Job Processor has a default interval of 10 min to check the job queue for new jobs.\
To avoid waiting 10 min to test a job, it is possible to click File → Pause and then File → Resume in the dialog.\
All queued jobs should now be processed.
:::

:::{note}
If you have installed powerJobs Client you will get notified if the job runs into an error. So, you will be aware if a job fails.
:::

## Result

Get back to your Vault client and refresh the UI. Beside your drawing you will find a PDF with the same name as the drawing but with pdf as an extension:

```{image} /img/pj-gs-010-pdfattachment.png
:width: 800px
```

The “Used” tab shows that the PDF is attached to the drawing.

## Do you want to know more?

### Tutorials

- [How to configure PDF creation of Inventor files](<https://support.coolorange.com/kb/how-to-configure-pdf-creation-of-inventor-files>)
- [How to add the Part Number to the PDF file name](<https://support.coolorange.com/kb/how-to-add-the-part-number-to-the-pdf-file-name>)
- [How to create PDFs with custom filenames](<https://support.coolorange.com/kb/how-to-create-pdfs-with-custom-filenames>)

### Product Documentation

- About [](</jobprocessor/jobs>), what they are and how to register and queue them.
- The [](</jobprocessor/jobs/sample_jobs>) that come with the product.
- How custom [job scripts](</jobprocessor/jobs/creating_job_scripts>) are created.
- Which [](</jobprocessor/file_conversion>) are supported with per default.
- How custom [](</jobprocessor/applications>) can be implemented to support custom file conversions.