> For the complete documentation index, see [llms.txt](https://docs.digit.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.digit.org/complaints-management/deploy/configure/workflow.md). # Workflow ## Overview The content on this page helps you set up and verify the workflow for the complaints module using Postman APIs. Workflows define how a complaint moves from one stage to another (e.g., from "Apply" to "Resolved"). A workflow defines: * All states a complaint goes through (e.g., Pending, Resolved) * Transitions between states (what happens when a user clicks Assign, Resolve, etc.) * Roles allowed to take each action * SLA (Service Level Agreement) durations for each state *** ## Steps Below are the steps to configure workflows. {% stepper %} {% step %} ### Import Postman Collection * Use the provided [Postman collection](https://api.postman.com/collections/23418568-9e180744-697b-475a-b475-13e456850e8d?access_key=PMAT-01JZQ5BRNK5WSE1JWASXY40JWX) for workflow setup. * Make sure your Postman environment contains the following values: * baseUrl (e.g., ) * authToken (Superuser token) * tenantId (e.g., pb, uk) {% endstep %} {% step %} ### Setup Before API Calls
Field What to use
authTokenA Superuser token with workflow permissions
tenantIdstate-level or city level (e.g., pg, pg.citya)
{% endstep %} {% step %} ### Create Workflow * Use POST /businessservice/\_create * Paste the sample payload (see below) * Hit "Send" in Postman * If successful, you’ll receive a confirmation response {% endstep %} {% step %} ### Verify the Workflow * Use POST /businessservice/\_search * Search with: * tenantId: pb * businessService: PGR * Confirm: * All states and transitions are listed * Roles and actions are mapped correctly {% endstep %} {% step %} ### Update Workflow (if required) If something is missing or incorrect: * Use POST /businessservice/\_update * Update only the affected parts (state, action, etc.) * Re-verify using the /search API {% endstep %} {% endstepper %} ## Sample Workflow Payload Below is an example workflow for the complaints module: ``` { "tenantId": "pb", "businessService": "PGR", "business": "pgr-services", "businessServiceSla": 432000000, // 5 days "states": [ { "isStartState": true, "isTerminateState": false, "isStateUpdatable": true, "docUploadRequired": false, "actions": [ { "action": "APPLY", "nextState": "PENDINGFORASSIGNMENT", "roles": ["CITIZEN", "CSR"] } ] }, { "state": "PENDINGFORASSIGNMENT", "applicationStatus": "PENDINGFORASSIGNMENT", "isStateUpdatable": false, "actions": [ { "action": "ASSIGN", "nextState": "PENDINGATLME", "roles": ["GRO", "DGRO"] }, { "action": "REJECT", "nextState": "REJECTED", "roles": ["GRO", "DGRO"] } ] }, { "state": "PENDINGFORREASSIGNMENT", "applicationStatus": "PENDINGFORREASSIGNMENT", "isStateUpdatable": false, "actions": [ { "action": "REASSIGN", "nextState": "PENDINGATLME", "roles": ["GRO", "DGRO"] }, { "action": "REJECT", "nextState": "REJECTED", "roles": ["GRO", "DGRO"] } ] }, { "state": "PENDINGATLME", "applicationStatus": "PENDINGATLME", "sla": 259200000, // 3 days "actions": [ { "action": "RESOLVE", "nextState": "RESOLVED", "roles": ["PGR_LME"] }, { "action": "REASSIGN", "nextState": "PENDINGFORREASSIGNMENT", "roles": ["PGR_LME"] } ] }, { "state": "REJECTED", "applicationStatus": "REJECTED", "isTerminateState": true, "actions": [ { "action": "REOPEN", "nextState": "PENDINGFORASSIGNMENT", "roles": ["CITIZEN", "CSR", "CFC"] }, { "action": "RATE", "nextState": "CLOSEDAFTERREJECTION", "roles": ["CITIZEN", "CFC"] } ] }, { "state": "RESOLVED", "applicationStatus": "RESOLVED", "isTerminateState": true, "actions": [ { "action": "REOPEN", "nextState": "PENDINGFORASSIGNMENT", "roles": ["CITIZEN", "CSR", "CFC"] }, { "action": "RATE", "nextState": "CLOSEDAFTERRESOLUTION", "roles": ["CITIZEN", "CFC"] } ] }, { "state": "CLOSEDAFTERREJECTION", "applicationStatus": "CLOSEDAFTERREJECTION", "isTerminateState": true }, { "state": "CLOSEDAFTERRESOLUTION", "applicationStatus": "CLOSEDAFTERRESOLUTION", "isTerminateState": true } ] } ``` *** ## Developer Notes
ItemNotes
SLA ValuesIn milliseconds (e.g., 5 days = 432000000)
businessServiceMust match what’s used in CCRS module backend
RolesMust exist in MDMS role-action mapping
Workflow TransitionsEach action should correctly link one state to another
*** #### Understanding `businessService` in CMS If the value of `businessService` in the complaint request does **not match** what's configured: * The workflow won't initialise or progress properly. * You may see errors like "No workflow found" or "Invalid businessService". ## Summary
StepAction
1️⃣Import Postman Collection
2️⃣Set authToken, tenantId
3️⃣Create workflow via /businessservice/_create
4️⃣Verify with /businessservice/_search
5️⃣Update using /businessservice/_update if needed
--- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.digit.org/complaints-management/deploy/configure/workflow.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.