Contract
Detailed description of configuring the contract service
Last updated
Was this helpful?
Detailed description of configuring the contract service
Last updated
Was this helpful?
The contract service provides the functionality of a works contract.
The source code for this service is available . Refer to the below docs for a deeper understanding of this service.
A running DIGIT platform is needed to deploy the contract service. Specifically, the following dependencies are needed:
Estimate
Organisation
User
Workflow
IDGen
HRMS
Notification
Persister
Indexer
MDMS
The below variables should be configured for the contract service in the Helm environment file before deployment. The Helm environment file will be located under:
https://github.com/
{{ORG}}
/DIGIT-DevOps/deploy-as-code/helm/environments/
{{EnvironmentFile}}
.yaml
Add db-host,db-name,db-url,domain and all the digit core platform services configurations (Idgen, workflow,user etc.) in the YAML file.
WORK_ORDER_CREATOR
/contract/v1/_create
/contract/v1/_update
/contract/v1/_search
/wms/contract/_search
WORK_ORDER_VERIFIER
/contract/v1/_update
/contract/v1/_search
/wms/contract/_search
WORK_ORDER_APPROVER
/contract/v1/_update
/contract/v1/_search
WORK_ORDER_VIEWER
/contract/v1/_search
/wms/contract/_search
EMPLOYEE_COMMON
/inbox/v2/_search
These must be translated into JSON in the role-action mapping module in MDMS.
The following masters are to be added as per the table below:
CBO Roles
OCI Roles
ContractType
Overheads
{
"format": "WO/[fy:yyyy-yy]/[SEQ_CONTRACT_NUM]",
"idname": "contract.number"
} {
"format": "RW/[fy:yyyy-yy]/[SEQ_CONT_SUPPLEMENT_NUM]",
"idname": "contract.supplement.number"
}
The following workflow JSON needs to be put in the request body of the /egov-workflow-v2/egov-wf/businessservice/_create
API.
If not present, please make sure to add the persister YML file.
Make sure to restart MDMS and the persister service after adding the file at the above location.
Restart the Inbox service after updating the above configuration
This service provides APIs to create, update and search for contracts. Refer to the for detailed scope and functionality. Low-level technical design is
Refer to the .
Add contract-service related environment variables’ value like the way it's done in ’ environment YAML file. Search for "contract-service" in the file.
Add the ‘’ related configuration to the respective environment YAML file. Make sure you change the gitsync.branch name.
Check the contract-service persister file is added to the egov-persister.perister-yml-path
variable. If not, please add the way it's done .
Make sure to add the DB(Postgres and flyway) username & password in the respective environment secret yaml file. Follow the steps .
Make sure to add the DIGIT core services-related secrets configured in the respective environment secret file. Follow the steps .
Configure actions, roles and role-action mappings from the table below. Follow the steps .
Example - available .
Make sure the id format is configured in the ‘IdFormat.json’ file of the ‘common-masters’ module. The sample .
Please make sure that the file is present in the configs
repository in the below location.
Please make sure that the file is present in the configs
repository in the below location.
In the MDMS repository, locate the. Make sure the following JSON is added to the inbox configuration:
The API specifications for this service are located . Postman scripts are available for reference to understand the request payloads.