Job Management

From the EDC Tools area, you can manage jobs occurring in your Study. By interacting with these jobs in EDC Tools, you can save time by reviewing and initiating jobs in from a single location. A job represents a bulk evaluation or action upon collected study data. For example, a Query Rules job evaluates all collected study data against the chosen rule.

Accessing EDC Tools

To access the EDC Tools administration area, click the Tools tab in the primary navigation bar, and then click EDC Tools.

Viewing Jobs

You can view a history of previously run jobs from EDC Tools > Job History. You can review your study’s scheduled jobs from EDC Tools > Jobs Schedule.

Use the Navigation panel to access these tabs. Job History and Job Schedule are in the Operations section.

Job History

Any in progress and past jobs run in your study display in the Job History tab. You can view information about each job, including downloading job logs and any available output files.

Note: Depending on your vault’s configuration, job logs and output files may expire after a certain number of days. Jobs continue to display in the Job History sub-tab even after any files expire.

Job Schedule

You can view all of your scheduled jobs in the Job Schedule tab. You can create new jobs from this area, as well as run scheduled jobs on an ad hoc basis, and delete existing jobs.

Adding a Job

You can add job instances to your vault on an ad hoc basis from EDC Tools.

To add a job:

1. Navigate to Tools > EDC Tools > Job Schedule for your Study.

2. Click + New Job.

3. Select a Type.
4. Different options display depending on the type of job you selected. Select the required options.

5. Select a Frequency. To run the job just once after you click Save, choose Run Now. Otherwise, choose from the available scheduling options.

6. Enter a Name for your job.
7. Click Save.
8. If you choose Run Now, Vault begins the job after you click Save. When finished, Vault sends you an email notification with a link to download the job log and any relevant output files. For scheduled jobs, Vault runs the job at the configured time, and you will receive an email notification with a link to download the job log and relevant output files each time the job runs.

Ad Hoc Runs of Scheduled Jobs

You can choose to run an ad hoc instance of an existing scheduled jobs.

To run a job:

1. Navigate to Tools > EDC Tools > Job Schedule for your Study.
2. Scroll to the Job you want to run.
3. Hover over the Job to show the Actions menu.

4. From the Actions menu, select Run Now.

5. Vault begins the job. When finished, Vault sends you an email notification with a link to download the job log and any relevant output files.

Editing a Scheduled Job

When needed, you can edit a scheduled job. For example, you may want to have a job run weekly on Friday instead of Thursday.

To edit a job:

1. Navigate to Tools > EDC Tools > Job Schedule for your Study.
2. Scroll to the Job you want to edit.
3. Hover over the Job to show the Actions menu.
4. From the Actions menu, select Edit Job.
5. Make changes to the job definition in the Edit Job dialog.
6. Click Save. Vault EDC now runs your job using the updated schedule.

Deleting a Job

To delete a job:

1. Navigate to Tools > EDC Tools > Job Schedule for your Study.
2. Scroll to the Job you want to delete.
3. Hover over the Job to show the Actions menu.

4. From the Actions menu, select Delete.

5. In the Delete Scheduled Job confirmation dialog, click Continue.
6. Vault deletes the job. The job will not run again. Any job logs and related output files remain available in the Job History tab until they expire.

Canceling a Running Job

You can cancel a job that is in the In Progress status. The following jobs are cancelable:

• Core Listing
• Retrospective Amendment
• Labs Mass Updates
• Data and Definition Export

To cancel a job:

1. Navigate to Tools > EDC Tools > Job History for your Study.
2. Locate the job that you want to cancel in the list.
3. Hover over the Job to show the Actions menu.

4. From the Actions menu, select Cancel.

5. In the Cancel Job confirmation dialog, click Cancel Job.
6. Vault cancels the job.

Vault stops the job and moves it into the Canceled status. If you cancel the run of a scheduled job, that job continues to follow the configured schedule.

Refreshing the Job History

You can refresh the Job History, without refreshing the page, to see the most up to date job status and any available logs or output files.

Click Refresh () to refresh the Job History.

Job Statuses

Vault displays the status of your job in the Listings & Exports subtab, along with other details about the job. You can click the Information () icon for additional details about a job.

Status	Meaning
In Progress	Vault is currently performing the job.
Failed	The job instance encountered one or more errors.
Completed	The job instance completed without errors.
Canceled	The job instance was canceled.

Extract Job Governor

The number of extract jobs that you run is regulated by the Extract Job Governor. Extract jobs include the Study Data Extract, Form Progress Listing, Query Detail Listing, Subject Progress Listing, and Event Progress Listing jobs. The following rules are implemented for ad hoc and scheduled extract jobs under the extract job governor.

Ad Hoc Jobs

Under the extract job governor, an extract job can only be started if another job of the same type isn’t running. For example, if one user is running a Form Progress Listing, you can’t begin another Form Progress Listing at the same time. Note that scheduled extract jobs can run at the same time as ad hoc extract jobs. You can run two ad hoc jobs per vault.

Scheduled Jobs

You can schedule two jobs of each extract type per study under the extract job governor, however, extract jobs of the same type must be scheduled at least one hour apart. You can have up to 50 scheduled jobs per vault.

Active Periods

You must select an Active Period when scheduling an export job in a non-production vault. Active periods are used to set an expiration date for your job. For example, if you select two active periods for a daily job, the job will run for two days and you’ll receive a notification that the job has reached its expiration date.

Study Priority

Users with the “Manage Study Priority” permission can set a Production instance of a study as a priority, meaning that new extract jobs for that study will be run in priority over jobs from other studies. Up to two studies can be marked as a priority at the same time. Priority expires after seven days and you can set a priority for the same study after the current priority expires.

To mark a study as a priority:

1. Log in to the vault containing your study’s production environment.
2. Navigate to Tools > EDC Tools.
3. Click your study’s Name to open it.
4. Hover over the Environment to show the Actions menu ().

5. From the Actions menu, select Set as Priority.

6. In the Set Study as Priority confirmation dialog, click Confirm.

You can view the expiration date of your prioritized study in the Priority Expiration Date column.

For more information about roles and permissions, see Standard CDMS Study Roles and to learn more about study environments and instances, see Managing Study Environments.

Job Types

The following job types are available in Vault CDMS. Note that some jobs display in the Job History, even if you cannot initiate that job type from EDC Tools (for example, an ODM Export job, which is initiated from Studio).

Job	Description	Added When
Additive Review Listing	Export a ZIP file containing a CSV file of a report for items and event dates that have been additively reviewed in a Study.	A Review user initiates an Additive Review Listing job in Review > Listings & Exports.
Review Metrics Report	Generates a report with percentages of weekly or monthly monitoring of SDV and/or DMR activities.	A Review user initiates a Review Metrics Report in Review > Listings & Exports.
Schedulable in EDC Tools > Jobs
Audit Trail Export by Study	Export a ZIP file containing a CSV version of the audit trail for each Casebook in the Study that you have permission to view. The ZIP file also contains a CSV list of all deleted Subjects in the study. The Audit Trail Export by Study also includes audit information for deleted records in your Study, such as those deleted by retrospective amendments. This job can be filtered by date range or user.	An EDC Tools user initiates an Audit Trail Export by Study job from EDC Tools > Jobs.
Audit Trail Export by Site	Export a ZIP file containing a CSV version of the audit trail for each Subject in up to ten Sites. This job can be filtered by date range or user.	An EDC Tools user initiates an Audit Trail Export by Site job from EDC Tools > Jobs.
Audit Trail Export by Subject	Export a ZIP file containing a CSV version of the audit trail for each selected subject. Up to 20 subjects can be selected at a time. The user will also have the option to select deleted subjects. This job can be filtered by date range or user.	An EDC Tools user initiates an Audit Trail Export by Subject job from EDC Tools > Jobs.
Core Listing	Export Study data in a simplified CSV file. You can choose which Forms to include and which Sites to export data from.	An EDC Tools user initiates a Core Listing job from EDC Tools > Jobs.
Data and Definition Export (Deprecated)	Export a ZIP file containing CSVs of data in your Study.	An EDC Tools user initiates the Data and Definition Export job from EDC Tools > Jobs.
Data Export	Exports study execution data as a series of either CSV or SAS files, in a format determined in your study’s design, to either download or send to a configured FTP location.	An EDC Tools user initiates a Data Export job from EDC Tools > Jobs.
Delete Site Data	Delete all subject Casebooks, including any collected data, all queries, and all Code Requests in that Site.	An EDC Tools user initiates the Delete Site action from EDC Tools > Sites.
Delete Study Data	Delete all subject Casebooks, including any collected data, all queries, all scheduled jobs, and all Code Requests in that Study.	An EDC Tools user initiates the Delete Study Data job from the EDC Tools Study lisiting (manual deployment studies) or EDC Tools > Environments (automatic deployment studies).
Delete Inactive Coding Requests	The Delete Inactive Coding Requests job deletes coding requests that belong to inactive coding forms.	An EDC Tools user initiates a Delete Inactive Coding Requests job from EDC Tools > Jobs.
Study Data Extract	The Study Data Extract job allows Lead Data Managers to extract and download study execution data.	A Lead Data Manager initiates the Study Data Extract job in EDC Tools.
Detail PDFs	Export Study data in a simplified CSV file. You can choose which Forms to include and which Sites to export data from.	An EDC Tools user initiates a Detail PDFs job from EDC Tools > Jobs.
DMR Re-assignment	Updates the DMR Requirement Mode of all existing Items in the Study to match the assigned Review Plan	An EDC Tools user initiates a DMR Re-assignment job from EDC Tools > Jobs.
Query Rules	Use this job type to have Vault evaluate a rule against existing data, for example, if the rule logic changes or it is a new rule. Select the Run in Preview Mode checkbox to run the job without creating queries. Vault sends you an email with the results of the job.	An EDC Tools user initiates a Query Rules job from EDC Tools > Jobs.
SDV Re-assignment	Updates the SDV Requirement Mode of all existing Items in the Study to match the assigned Review Plan	An EDC Tools user initiates a SDV Re-assignment job from EDC Tools > Jobs.
Workbench Export	Exports study data and sends it to the Veeva CDB application for import.	An EDC Tools user initiates a Workbench Export job from EDC Tools > Jobs.
Event Progress Listing	Generates a list of all Events in a Study with status details and operational information.	An EDC Tools user initiates an Event Progress Listing job from EDC Tools > Jobs or the Reports tab
Form Progress Listing	Generates a list of all Forms in a Study with status details and operational information.	An EDC Tools user initiates an Form Progress Listing job from EDC Tools > Jobs or the Reports tab
Query Detail Listing	Generates a list of all Queries in a Study with status details and operational information.	An EDC Tools user initiates an Query Progress Listing job from EDC Tools > Jobs or the Reports tab
Subject Progress Listing	Generates a list of all Subjects in a Study with status details and operational information.	An EDC Tools user initiates an Subject Progress Listing job from EDC Tools > Jobs or the Reports tab
Vault Coder Jobs To schedule or run these jobs, your vault must include the Vault Coder application.
Autocoding and Suggestions	Autocodes pending Code Requests and creates suggestions.	An EDC Tools user initiates an Autocoding and Suggestions job from EDC Tools > Jobs. The job then runs automatically.
Code Request Export	Export a CSV file of all Code Requests for a Study, including details about each Code Request and what each request was coded to.	An EDC Tools user initiates a Code Request Export job from EDC Tools > Jobs.
Reconstitute Code Requests	Updates existing Code Requests to use updated form configuration, and, if applicable, recreates previously deleted Code Requests to reference the updated configuration.	An EDC Tools user initiates a Reconstitute Code Requests job from EDC Tools > Jobs.
Logged in Job History, Initiated Elsewhere These jobs are logged in EDC Tools > Jobs > Job History, but they originate elsewhere, either in EDC Tools or Studio.
ODM Import	Imported an ODM XML document into vault	A Studio user imports an ODM XML document when creating a casebook version.
ODM Export	Exported an ODM XML document from vault	A Studio user exports an ODM XML document when publishing a casebook version.
Retrospective Amendment	A retrospective amendment upgrades existing subject Casebooks to a new casebook version, applying the design changes to existing data.	An EDC Tools user runs a retrospective amendment from EDC Tools > Casebook Versions.

Job Logs & Output Files

Vault provides a CSV job log file for each job. This log includes details about which objects were affected by the job and whether or not the job was successful on each object. When applicable, Vault also provides a link to the output files from a job. For example, a link to download the ODM XML file for an ODM Export job.

To access these files, click the icon () in either the Log or File column.