For the complete documentation index, see llms.txt. This page is also available as Markdown.

Assessment delegates

Assessment delegates are service task delegates that connect a workflow process to the assessments service. They let a workflow request that an assessment be started or retrieved for a given use case, and read back the assessment answers as process variables.

ConductAssessmentDelegate

Starts or requests the start of an assessment for a use case. Place this delegate on a service task where the process needs to hand off to the assessments service so a steward or reviewer can complete an assessment for the use case asset currently in scope.

Properties

Property
Value

Type

Service Task

Java class

com.collibra.assessments.api.v1.workflow.delegate.ConductAssessmentDelegate

Implementation

org.flowable.engine.delegate.JavaDelegate

Input parameters

Field name
Type
Required
Description
Example

useCaseOwnerId

String

Yes

The ID of the use case owner the assessment is assigned to or conducted on behalf of. If not set, the workflow user is assigned as the assessment owner. Always set this variable explicitly before the process reaches this task to ensure the intended user is assigned as the owner.

"a1b2c3d4-0000-4a4a-8b8b-000000000001"

useCaseAssetId

String

Yes

The ID of the use case asset the assessment applies to.

"f1e2d3c4-0000-4a4a-8b8b-000000000002"

Both variables are read from the execution as-is. The delegate does not validate their presence or type, so upstream tasks in the process must set them before this service task is reached.

Output

None. This delegate does not set any process variables. It sends a notification to the assessments service to start the assessment. The resulting assessment is later retrieved via a separate delegate once it has been completed: GetAssessmentDelegate.

Usage

Ensure useCaseOwnerId and useCaseAssetId are already set on the execution, typically by a preceding script task or form submission, before the process reaches this task.

GetAssessmentDelegate

GetAssessmentDelegate is the counterpart read delegate to ConductAssessmentDelegate. Where ConductAssessmentDelegate pushes a request to start an assessment, GetAssessmentDelegate pulls back the answers from a completed assessment, including template, content, and linked asset, into a result process variable for the process to branch on or persist.

Last updated

Was this helpful?