Create or retrieve an assessment via workflows

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

The following table contains the properties of the input and output parameters for ConductAssessmentDelegate.

The following steps describe how to integrate ConductAssessmentDelegate into a workflow.

1. On the main toolbar, click → Workflow Designer.
   The Workflow Designer page opens.
2. Create a process.
   The process editor page opens.
3. On the canvas, click the start event.
   Attributes for the start event are shown in the right pane.
4. In the Details section, click Form properties.
   The Form properties dialog box appears.
5. Click Add item.
6. Enter the information for the first input parameter from the table in the Properties section above.
7. Repeat steps 5 and 6 for each input parameter.
   
   
8. Click OK.
9. Drag the following activities from the palette in the left pane to the canvas:
   • Service task
   • Script task
   • End event
10. On the canvas, add the following sequence flows:
    • From the start event to the service task.
    • From the service task to the script task.
    • From the script task to the end event.
11. Click the service task.
    Attributes for the service task are shown in the right pane.
12. In the Details section, in the Class field, enter com.collibra.assessments.api.v1.workflow.delegate.ConductAssessmentDelegate.
    Tip This class enables the service task to call ConductAssessmentDelegate.
13. Click the script task.
    Attributes for the script task are shown in the right pane.
14. In the Details section, click Script.
    The Script dialog box appears.
15. In the dialog box, enter the following.
    Copy

    def delegateResults = execution.getVariable("result")
    println "The Java Delegate service task returned the following results: " + delegateResults

16. Click OK.
17. To save the workflow, in the process editor menu bar, click .

Class: com.collibra.assessments.api.v1.workflow.delegate.GetAssessmentDelegate

The following table contains the properties of the input and output parameters for GetAssessmentDelegate.

                                {
                                "id": "60dfe2b6-0215-4a30-86dd-4ee235a1821e",
                                "name": "Direct Marketing",
                                "asset": {
                                "id": "9e6ba6fa-ae24-41c8-9b42-08e7c4231689",
                                "name": "Direct Marketing"
                                },
                                "status": "DRAFT",
                                "template": {
                                "id": "c8643d4d-f9f8-4484-b9c2-d0f3432e295f",
                                "name": "Legal Checks",
                                "version": 1,
                                "status": "PUBLISHED",
                                "assetType": {
                                "id": "0b781899-3dd2-4746-bc98-65daef8f1efa",
                                "name": "Business Process"
                                }
                                },
                                "owner": {
                                "id": "0e787414-fd78-48a0-bfdd-69411b26c65b",
                                "name": "Leonard Cohen"
                                },
                                "assignees": [
                                {
                                "type": "USER",
                                "id": "d615a9fe-8d8c-4287-80aa-5b058519ca45",
                                "name": "Freddie Mercury"
                                },
                                {
                                "type": "GROUP",
                                "id": "387b34f5-eac8-467c-89b6-5ee7c2e7368b",
                                "name": "Lawyers"
                                }
                                ],
                                "content": [
                                {
                                "id": "legalBasisSpecified",
                                "title": "Are all legal bases specified?",
                                "answer": {
                                "type": "BOOLEAN",
                                "value": true
                                },
                                "comment": "We use Legitimate interest as the legal basis."
                                }
                                ],
                                "createdOn": "2023-07-10T15:03:10.433Z",
                                "createdBy": {
                                "id": "0e787414-fd78-48a0-bfdd-69411b26c65b",
                                "name": "Leonard Cohen"
                                },
                                "lastModifiedOn": "2023-07-10T18:43:10.433Z",
                                "lastModifiedBy": {
                                "id": "0e787414-fd78-48a0-bfdd-69411b26c65b",
                                "name": "Leonard Cohen"
                                }
                                }
                            

The following image shows an assessment approval workflow that uses GetAssessmentDelegate to automatically approve an assessment based on certain answers.

The workflow uses GetAssessmentDelegate to fetch the details of the assessment when the assessment is submitted.

GetAssessmentDelegate expects the workflow to have either the assessment_id parameter or the assessment_review_id parameter as a string in the form properties of the workflow.

The following is an example of how the assessment_id parameter can be declared as a form property within the workflow.

<activiti:formProperty id="assessment_id" name="Assessment ID" type="string" default="725ca8b5-8a8d-40fa-91b9-3323b70ed524" readable="false"/>

The following is an example of how the assessment_review_id parameter can be programmatically declared.

execution.setVariable("assessment_review_id", item.id.toString())

To call the Assessments API, GetAssessmentDelegate uses the declared value 725ca8b5-8a8d-40fa-91b9-3323b70ed524 or item.id.toString(). If the call is successful, the assessment details are stored in a result variable that can be accessed in the next task, Check Answers. The answers can then be used for processing and automating business decisions.