CreateApprovalPlan

This method creates a new Approval Template for the approvals process and returns 0 (zero) to indicate success. This method raises an exception if the user does not have the authority to add an Approval Template, or if the record format is invalid.

ApprovaObjects have these keys and values:

• type – either time, expense, or mileage
• bizid – the business process ID which defines the approvers structure (how many approvers there are.) Use one of these constants, which correspond to the number of approvers: default1, default2, default3, default4, default5.
• name – the name of the Approval Template.
• Userbefore – number of days before the end of a period to send a reminder email to the user.
• Userafter – number of days after the end of a period before a reminder is sent to the user (if sheet has not been submitted)
• Approverafter – number of days after the end of a period before a notice is sent to the approver (if they user has not submitted a sheet.)
• Backupafter – number of days after the end of a period to notify the backup approver if a sheet has been submitted but not approved.
• Userrejected – a string to send to the user when his sheet is rejected.
• Userapproved – a string to send to the user when his sheet is approved.
• Approversubmitted – a string to send to the approver when a sheet is in his approval queue.

In addition to the above keys, you must add all the approvers to the Template when you create it, as there is no other way to modify an Approval Template through the jxAPI once created. (However, you can modify the Approval Template through the normal web interface.) Backup approvers are optional but you must add a primary approver key (approver_1 for instance) for each "level" of approval.

For instance, if you gave "default2" for the bizid field, this indicates a 2-level approval process. This means that you must give 2 primary approvers, and 0 to 2 backup approvers.

The valid keys for Primary Approvers and Backup approvers are:

• approver_1
• backup_approver_1
• approver_2
• backup_approver_2
• approver_3
• backup_approver_3
• approver_4
• backup_approver_4
• approver_5
• backup_approver_5

Again, the number of primary approvers must correspond exactly to the number of approval levels indicated by the bizid field. It is not possible to create an Approval Template through the jxAPI without specifying all the primary approvers.

You will get a ValueError exception if you are missing a primary approver.

Arguments

Return

The CreateApprovalPlan method returns zero (an integer).