Develop > Document Engine Guide > Objects > Object Definition form and fields > Approvals tab field descriptions

Approvals tab field descriptions

The Approvals tab sets approval options and their associated notifications for the Object. Approvals are defined in the ApprovalDef file.

The field descriptions for the Approvals tab are:

Field Name Description

Approval condition

approval.condition

If the approval condition evaluates to true, approvals are used on the Object's records.

Approval location

approval.location

Indicates where the approval information is stored: record, phase, object, or category.

Approval field name

approval.field.name

The field name that contains the actual Approval name within the table that is defined in the Approval location.

Approval status field

approval.status.field

The field in the current record in which to store the approval status.

Approval groups

approval.groups

Stores a variable to contain the groups the current user must belong to in order to issue approvals for this Object.

Approval type

appr.cond.type

There are four pre-defined approval types:

All must approve: All groups/operators defined in the Approval Definition must issue an approval before the system sets the status of the record to approved. If only one or some but not all of the groups/operators issue an approval, then the status is set to pending.

One must approve: The record is approved with one approval from any member of the approving group/operator.

Quorum: The record is approved as soon as a majority of the approving group indicate approval.

All must approve – immediate denial: All groups/operators must approve the record. The first denial causes the status to change to deny. All other approvers do not need to take any action.

Approval notification

single.notify.approval

 Select the notification to run if the request is approved.

Denial notification

single.notify.denial

Select the notification to run if one approver denies the request.

Retraction notification

single.notify.retraction

Select the notification to run when retracting a previous action.

Final approval notification

final.notify.approval

Select the notification to send once the final approval is granted.

Final denial notification

final.notify.denial

Select the notification to send when the request is denied.

Approval FC

appr.fc

Specifies the name of the Format Control record to run upon approval.

Approval process

approval.process

Select the Process to run when the record is approved.

Denial process

denial.process

Select the Process that runs when the record is denied.

Preapprove on open

preapprove.cond

Determines whether the record should be automatically approved.

If the condition is true and the user belongs to one of the pending approval groups, the approval is processed automatically. If the user does not belong to one of the pending approval groups, the approval does not occur automatically and must then go through the regular approval process. Defaults to true.

Log approvals?

log.approvals

Select this check box to log the history of approvals in the ApprovalLog table.

Require appr. comments

approval.comments

If checked, approval comments are requested from the approver.

Aggregate approvals?

aggregate.approvals

If checked, approvals are cumulative.

Recalculate approvals if

approval.recalc

Specifies the conditions that determine whether or not to recalculate the conditions on the existing approvals.

Reset approvals if

approval.reset

Determines when to delete existing approvals and recalculate all conditions.

Send Help Center feedback