Scheduling Jobs in Align
Using the Vault scheduler, Align operational users can schedule jobs to run daily. This saves time by executing recurring processes automatically rather than manually.
The following processes are supported for scheduled jobs:
- Import data from Vault CRM
- Push data to Vault CRM
- End-to-end integration – A combination of a Vault CRM import, an assignment preview, a commit, and a Vault CRM push. This process can be configured to run off of individual territories, territory trees, or field forces. Additionally, users can define minimum and maximum thresholds to prevent pushing data to Vault CRM if territories after the assignment preview have too few or too many accounts.
Who can use this feature?
- Align Operational Users - Browser
- Formatting the Job URL
- Creating a Scheduled Job
- Users require an Align License
Configuring Scheduling Jobs in Align for
Align Operational Users
To configure this feature, ensure Configuring Align is complete.
Formatting the Job URL as
Align Operational Users
Scheduled jobs run based on the URL entered in the job. For the three types of tasks that can be scheduled, the base URL is:
https://lambda.veeva-vcrm.com/api/latest/process/
Each job type has a unique URL format that is appended to the base URL:
-
Import data from Vault CRM
crmImport?vaulturl=${Vault.domain}&vaultid=${Vault.id}
-
Push data to Vault CRM
crmPush?vaulturl=${Vault.domain}&vaultid=${Vault.id}
-
End-to-end integration for a territory or field force
run?vaultid=${Vault.id}&vaulturl=${Vault.domain}&territoryId=<TERR_ID>&jobName=<JOB_NAME>&jobInstanceId=${job_instance_id__v}&lowerLimit=<LIMIT_LOW>&upperLimit=<LIMIT_HIGH>
This job can be configured to run off a field force rather than a territory by replacing the &territoryID=<TERR_ID> parameter with the &fieldForceID=<FIELDFORCE_ID> parameter.
The following parameters are used by scheduled jobs. Parameters can be entered in any order, and not all jobs use every parameter:
|
Parameter |
Jobs Using This Parameter |
Description |
|---|---|---|
|
&vaultid |
Import Data from Vault CRMPush Data to Vault CRMEnd-to-end integration |
The ID of the instance of Align. Always set this parameter exactly to ${Vault.id}. |
|
&vaulturl |
Import Data from Vault CRMPush Data to Vault CRMEnd-to-end integration |
The domain of the instance of Align. Always set this parameter exactly to ${Vault.domain}. |
|
&fieldForceId |
End-to-end integration |
The Vault ID of the field force used to launch the rule. Note: This parameter cannot be used with &territoryId. |
|
&territoryId |
End-to-end integration |
The Vault ID of the territory used to launch the rule. Note: This parameter cannot be used with &fieldForceId. |
|
&jobName |
End-to-end integration |
The name of the Scheduled Job. |
|
&jobInstanceId |
End-to-end integration |
The ID of the job instance. Always set this parameter exactly to ${job_instance_id__v}. |
|
&lowerLimit |
End-to-end integration |
The lower limit of accounts that can be assigned to a territory. This parameter is optional. |
|
&upperLimit |
End-to-end integration |
The upper limit of accounts that can be assigned to a territory. This parameter is optional. |
Example URL
For example, the URL for an end to end scheduled job would be:
https://lambda.veeva-vcrm.com/api/latest/process/run?vaultid=${Vault.id}&vaulturl=${Vault.domain}&territoryId=XYZ000000000001&jobName=DailyJob&jobInstanceId=${job_instance_id__v}&lowerLimit=0&upperLimit=10000
Creating a Scheduled Job as
Align Operational Users
To create a scheduled job:
- Navigate to the Admin > Operations > Job Definition.
- Select Create.
-
Enter the following job information:
- Title
- Name
- Job Owner
- Schedule
- Status
- Type – Select External URL Call
- Navigate to the Action Configuration section.
- Enter the formatted URL for the appropriate job in the URL field.
- Select the appropriate Run As user. Veeva recommends selecting the Align Integration User for all scheduled jobs.
- Select the Post Session Credentials via Form Data with Key "Session.id" check box.
Once a scheduled job is created, it runs every day at the specified time. If an error prevents a job from starting, the job owner is notified via email. If a job completes successfully or an error occurs during a job, the Run As user is notified via email and the job owner is notified in the Alert section.
To ensure Vault CRM has up-to-date assignments based on the latest account data, end-to-end scheduled jobs run from the root territory or field force are given priority over manually initiated processes. In-progress manually initiated processes are canceled when the scheduled job starts.
