Cadac Organice Vault Job Processor Monitor
TABLE OF CONTENTS
Job Processor Monitor
Description
The job processor is a key feature of your Autodesk® Vault® environment. It’s capable of automating certain tasks to increase your productivity and optimize business processes. If a job doesn’t start or results in an error there is no easy way to find out. Business processes can be disrupted and CAD managers need to investigate why certain tasks haven’t been completed as expected.
This stand-alone application helps you to monitor the job queue. It has a clean interface which gives you an up-to-date view of the job queue. It’s giving you the opportunity to get notified by email when errors do occur. It’s capable of deleting error jobs and ‘forever pending’ jobs from the job queue automatically and it’s logging all activity.
General Usage Instructions
The application can be launched with the shortcut on your desktop. All the available commands are placed in the ribbon of the main application window.
Before the application is able to detect errors, stale jobs and send email notifications you need to specify some settings by using the ‘Options’ command on the ribbon. See detailed instructions below for more information.
After logging into Autodesk® Vault® by using the ‘Log In’ command, you can start monitoring the job queue by using the ‘Start’ command.
If you wish to modify the settings while the monitoring process is active, you need to use the ‘Stop’ command first before you are able to use the ‘Options’ command.
Job Queue Monitor Options
1. Click on the ‘Options’ command in the ribbon
2. In the dialog that appears the following options are available:
- SMTP settings for email notifications
Fill in the details of your SMTP server. Use the ‘Test Email’ button in the lower left corner of the Options dialog to test if the application is able to send emails.
Timer interval in minutes
After each interval the job queue in the main application window is automatically refreshed
- Number of days to keep log files
All activity of the application is logged and is being shown in the main application window. The activities are stored in separate text files. Log files older than the entered value are automatically deleted from your system
- Job Type Rules
See detailed instructions below
Rules
Job Type Rules
The application is able to detect two kinds of issues:
- Error
An error occurred when the job was processed by the job processor. A certain job result is returned and displayed in the job queue dialog.
- Stale
A ‘Stale’ job is a job that has been on the status ‘Pending’ for a certain amount of time. Each job handler has certain requirements. If these are not met on the system the job processor is running on, the job will never be handled and will stay in the job queue ‘forever’. There are no error messages with stale jobs.
To detect an issue you need to create one or more ‘Job Type Rules’. In the upper section of the ‘Options’ dialog an overview of all the existing rules is being displayed. The ‘New’, ‘Edit’ and ‘Delete’ commands are available to create new rules or to modify existing rules.
New Job Type Rule
1. Click ‘New’ on the toolbar above the ‘Job Type Rules’ section in the ‘Options’ dialog.
2. Select the Job Type you want to detect with the new rule (Error/Stale)
3. If you selected the ‘Stale’ job type you need to specify a time out value. When a job that meets the other criteria of this rule has been on the ‘Pending’ state for this amount of time, the rule will be applied.
4. Specify a ‘Job Name’ you want to detect with this rule. You can use a wildcard (*). (For a list of all the available job types in your environment please go to the Job Processor application --> Administration menu --> Job Types).
5. If you selected the ‘Error’ job type in step 2, you need to specify a ‘Job Result’ you want to detect with this rule. You can use a wildcard (*).
6. Check the ‘Email Notification’ option if you would like to receive an email when this rule is being triggered.
7. Check the ‘Delete Job from Job Queue’ option if you would like to delete the job that triggered this rule from the job queue.
Edit Job Type Rule
1. Select an existing ‘Job Type Rule’ in the grid.
2. Click ‘Edit’ on the toolbar above the ‘Job Type Rules’ section in the ‘Options’ dialog.
3. Change the rule settings in the dialog that appears.
Delete Job Type Rule
1. Select an existing ‘Job Type Rule’ in the grid.
2. Click ‘Delete’ on the toolbar above the ‘Job Type Rules’ section in the ‘Options’ dialog.
Job Type Rule Examples
Detect all errors and send an email notification
Job Type: Error
Job Name: *
Job Result: *
Email Notification: Yes
Delete Job from Job Queue: No
Detect an error for a specific job with a specific job result, send an email notification and delete this job from the queue.
Job Type: Error
Job Name: Autodesk.Vault.SyncProperties
Job Result: Sync properties not allowed on non-tip versions
Email Notification: Yes
Delete Job from Job Queue: Yes
Detect an error for a job in a certain name range with any job result and send an email notification.
Job Type: Error
Job Name: Autodesk.Vault.DWF*
Job Result: *
Email Notification: Yes
Delete Job from Job Queue: No
Detect any job that has been in the job queue for more than 2 days and send an email notification
Job Type: Stale
Time Out (in minutes): 2881
Job Name: *
Email Notification: Yes
Delete Job from Job Queue: No
Screenshots
Commands
Ribbon/Toolbar Icon Command Command Description 
Log In Log into a Vault Workgroup or Vault Professional server by providing a user name, password and server name. 
Log Out Disconnect the application from the Vault server. 
Start Start the job queue monitoring process. You need to be logged into a Vault Workgroup or Vault Professional server before this command is enabled. 
Stop Stop the job queue monitoring process 
Options Specify Job Type Rules for automating certain job queue actions, SMTP settings for email notifications and some other options. This command is disabled when the monitoring process is active. 
Info View version and company information. Installation/Uninstallation
The installer that ran when you downloaded this App from Autodesk Exchange has already installed the App. After installation the software needs to be activated by clicking 'Request License' in the license dialog. You'll get your free activation code as soon as possible.
To uninstall this plug-in, exit the Autodesk product if you are currently running it, simply rerun the installer, and select the "Uninstall" button.
OR, you can uninstall it from 'Control Panel\Programs\Programs and Features' just as you would uninstall any other application from your system.
Additional Information
NOTES
- Multiple instances of the application can run simultaneously on different machines. However, please make sure only one instance of the application is actively handling job issues of a specific Vault Workgroup or Vault Professional server. If more than one application is trying to send email notifications and/or deleting jobs from the job queue, duplicate emails and other errors can occur.
- This application is consuming a Vault license. It is recommended to install and run the application on the same machine as the Job Processor application is running on. If you use the same credentials in both applications only one license will be consumed.
Job Processor Monitor licensing
Pay attention!
Be sure that each Job Processor has his own Cadac account.
- Open "Job Processor Monitor [edition]"
- Login with you Cadac account or create one.
- Select the right tenant
- login in vault
- Your Job Processor monitor is ready to use.
Unattended – run on startup
You can startup the Job Processor and the Job Processor Monitor without logging-in your windows machine.
Be sure that you have configured your Job Processor licence and saved the product key in VaultConfigure the application key
- Login on www.cadac.com and go to "My Licences"
- Confirm that you want to make changes to your software licences..
- Find the product Cadac Organice Vault Professional or Cadac Organice Vault Workgroup and op the product by clicking the pencil.
- Click in "Show application key" and copy the key
- Open the Job Processor Monitor and go to the info
Go to "Set Application Key"
Fill in the Cadac account email address and the Application key.
Schedule the Job Processor and the Job Processor Monitor
Be sure! that you have set the "Application Key" described as above.
Open the Windows "Task Scheduler".
Create a new task
Add a new trigger "At startup"
* optional is to delay the task to be sure that the machine is startup completely.
Add two new actions "Start a Program"
- Autodesk Job Processor: Browse to the JobProcessor.exe file in the <install dir>\Autodesk\Vault [edition]\Explorer\ directory
- Cadac Job Processor Monitor: Browse to the Organice.Vault.JobProcessor.Monitor.exe <install dir>\Cadac Group\Cadac Organice Vault [edition] - Job Processor Monitor\ directoryPress [OK}
See also the knowledge base from Autodesk https://help.autodesk.com/view/VAULT/2023/ENU/?guid=GUID-4038E3A2-C5F2-4ECA-8599-2B8AA760FDCB
- Login on www.cadac.com and go to "My Licences"