PVC - Create a New Job
- Jeremy Berlanga (Unlicensed)
- Taylor Treece (Unlicensed)
This article explains how to create a new job within Papervision Capture
Log into PVC Admin Console
Once logged into PVC admin console, expand Entities and expand the active entity being used, in this case, it would be "Default Company" and then select Capture Jobs.
You can then click on the plus symbol at the top-left to add a new job. This will open a dialog box where you can input the job name you wish to give it.
After you have named your new job and hit okay, it will then open the Job Definitions window where you can begin to build out your new PVC job.
Build your job steps
Insert Capture Step
To begin, you can right-click in the empty space and mouse over "insert job step" to see a list of available steps that you can add.
Most jobs will start with a capture step, which is how the images are brought into the batch. For this example, we will make a Capture → Indexing → Export job setup.
From the available job step selections, choose the Capture step.
Once created, you will notice the properties for the step are displayed on the left for the selected job step. In the properties, you can change various settings that will affect how the job step performs.
Also, you will notice that the color of the job step is green. This is because it is a manual step, meaning a user will need to take control on this step and manually send it to the next step. You must assign who will be able to take ownership of this step. You can assign specific users, groups, or even all users and groups, but at least one must be selected for a manual step.
To assign a user, in the properties of the capture step and under General, you will see "Assigned to". Select the "..." button to open a dialog box that will display all the available users and groups. For this example, we are going to set the step to allow all users and groups by clicking the box in the top-left corner of the Job Step Assignment window.
Once selected, we can close the Job Step Assignment window and proceed to the next job step.
Insert Indexing Step
Next, we will insert an Indexing step. You will insert the Indexing step the same way we inserted the capture step, by right-clicking in the empty space and selecting the Indexing step. Once it has appeared in the workflow, you will notice this step is also green, meaning it, too, is a manual step. We must assign it to a user(s) or group to allow others to take ownership of the batch on this step.
For this example, the Indexing step has been assigned to all users and groups as well, but be sure to select according to what is needed. Next, we will need to assign indexing fields.
Note on Indexing fields
Please note that indexing fields can be assigned on any job step. For example, they can be assigned on the capture step and users can scan in documents and index all in the same step if desired.
With the Indexing step still selected, in the properties and under Indexes, select the "..." button to bring up the Index Configuration window. Here you can add as many index fields as needed and configure each index field as needed. For this example, we will create a First Name, Last Name, and DOB field.
To begin, click on Add and it will bring up a new window asking what kind of field we would like to add
We will keep the New Index field selected and name the field. After giving the field a name, click OK and you will notice after it has populated in your list of indexes, that the properties will be displayed on the right-side. We will use this for the DOB field to change from a text field to a date field.
After adding the DOB field, locate the Index Type option in the index properties with DOB selected and update from text to date.
You can then update the Index Format of how the date will be display if desired. Once all the indexes have been populated and properties have been modified, you can click OK on the Index Configuration window and we will be taken back to the PVC workflow with our job steps. Next, we are ready to insert our export step.
Insert Export Step
When inserting this step, you will notice there is no actual "Export" step listed in your available job steps. That is because it will be a Custom Code step instead. Select the Custom Code step and populate it in the workflow. Once populated, you can then update the name of the step in the step properties to "Export" so that you will know it is being used for exporting.
Next, we must assign code to this step so that it will know how to function. Thankfully, PVC came with several pre-loaded scripts to use. Locate the Step Executing option in the step property and click the "..." button to bring up the Select Custom Code Generator window. For this example, we will choose the ImageSilo/PVE XML option. Once selected, hit OK.
Once selected, you will be shown the export options for how and where you would like batches to export. Once the desired options have been selected, you can select OK and the Export options window will close and you will be taken back to the job step workflow. Next, we will need to connect the steps to tell PVC what order they will operate in.
Connect Your Job Steps
Now, we are ready to connect our job steps and finalize the job. We will begin with the capture step. Select the Capture step and at the bottom of the screen, under Next, you can select the next desired job step. As stated earlier in this article, we are going to connect the steps so that the order will be Capture → Indexing → Export. Select the Indexing step from the drop-down and you will see an arrow has appeared showing that batches will transition from the Capture step to the Indexing step.
Continue until all steps have been connected to each other.
Note that the Export step in this example is the last step, so it will not be connected to any other steps.
Activate Your Job and Check Back In
Your job is now complete and you are ready to activate so that it can be used in production. Before doing so, there is a Validate Job button that will scan the job configuration and see if the job can be activated. If there are any issues, a dialog box will be displayed and let you know what needs to be corrected before you can activate. To do this, Click Job at the top-left of the Job Definitions window and select Validate. Alternatively, you may select the Validate button that is in the quick toolbar. Once selected, the validatation will alert you of any corrections you need to make. Otherwise, you are ready to activate the job.
Click on Job at the top-left again and this time, select Activate. This will activate the job and allow users to use this job to create batches. You will then need to check the job in. This can also be done from the same Job menu. Click Job at the top-left again and select Check In. This saves any changes you've made and will be applied to any new batches created when using the job .
Congratulations!
You have created a PVC job and it is now ready to be used in production! Please note that this is an easy and straight-forward example of a PVC job, but know that jobs can be as complex as needed and are very customizable. Try out new job steps and familiarize yourself with all the different options!
CASO Knowledge Base