Statusek

Universal tool for reading & saving statuses of task, documents & other

General

Main concept

---

It's a service with functionality of managing statuses across different services or systems

Service defines a contract for a status model associated with objects, such as tasks or documents

Imagine, we have a chain of two applications which execute some process: Service1 -> Service2

Workflow between them looks like this (async interaction):

1. Service1 pushes task to Service2
2. Service2 executes task and writes back statuses of execution
3. Service1 sees statuses and waits untill the task is fully executed

Conclusions:

• We should develop status model
• We should develop methods to set statuses
• We should develop method to share statuses
• Service2 can change statuses it retuns and does not have to inform Service1 about this
• We should foresee when task is hold on Service2 (timed out) and finish status that will never be returned

Statusek ensures implementation of all these points.

Statusek has six restAPI methods for organized interaction between services:

1. instance/create - create instance (process) of some object (model) and get its token
2. status/setStatus - set status of instance (by instance token & status name)
3. status/checkStatusIsSet - check if certain status is set
4. status/checkStatusIsReadyToSet - check if certain status can be set
5. instance/checkIsFinished - checks if instance is finished or not
6. event/getEvents - gets all set statuses

So, interaction is changing to:

1. Service1 calls instance/create and gets instanceToken
2. Service1 pushes task to Service2 and transmits instanceToken to it
3. Service2 executes task and writes certain statuses by call status/setStatus
4. Service1 calls instance/checkIsFinished and understands when task will be fully executed
5. If Service2 hasn't returned any of its statuses then instance/checkIsFinished is set to True

Statuses

---

Statuses represents states of some process, action or object.

Rest API

Creating instance of process

---

First, service-initiator of process creates instance of process inside SMS (statuses management service)

It calls: http://hostname:8080/instance/create

with raw json in the body:

{
 "object_name":"2-POINT LINE TASK",
 "instance_timeout":600
}

• timeout in seconds

and get something like this:

{
    "status": true,
    "message": "",
    "data": {
        "instance_token": "1f13cd00-f6fc-49fc-918b-2915bc05908f"
    }
}

So, field 'status' contains true if request has executed successfully. If errors occurred, the 'status' field will be set to 'false,' and you will find an accompanying message in the 'message' field. For example:

{
    "status": false,
    "message": "ERROR: Object name '2-POINT LINE TASK1' is not found",
    "data": {}
}

Setting statuses

---

Services that possess the instance token (process) can update statuses by making a call to the following endpoint: http://hostname:8080/status/setStatus

with raw json in the body:

{
 "instance_token":"1f13cd00-f6fc-49fc-918b-2915bc05908f",
 "status_name": "STARTED"
}

and get something like this:

{
    "status": true,
    "message": "",
    "data": {}
}

If there's an error, 'status' will be 'false,' and 'message' will contain an error description.

Checking if some status is set

---

To determine whether a specific status has been set or not, you can make a request to the following endpoint http://hostname:8080/status/checkStatusIsSet

with raw json in the body:

{
 "instance_token":"1f13cd00-f6fc-49fc-918b-2915bc05908f",
 "status_name": "STARTED"
}

and get something like this:

{
    "status": true,
    "message": "",
    "data": {
        "status_is_set": true
    }
}

or "status_is_set": false, if it hasn't been set yet

Checking some status is ready to be set

---

For specific logic we might want to check if some status was set or not

We call: http://hostname:8080/status/checkStatusIsReadyToSet

with raw json in the body:

{
 "instance_token":"1f13cd00-f6fc-49fc-918b-2915bc05908f",
 "status_name": "FINISHED"
}

and get something like this:

{
    "status": true,
    "message": "",
    "data": {
        "status_is_ready_to_set": false,
        "status_is_ready_to_set_description": "Not all previos mandatory statuses are set for status 'FINISHED'"
    }
}

or a positive answer if all limits to set this status have completed:

{
    "status": true,
    "message": "",
    "data": {
        "status_is_ready_to_set": true,
        "status_is_ready_to_set_description": ""
    }
}

Checking process is finished

---

Service-initiator wants to know if process is finished yet or not

We call: http://hostname:8080/instance/checkIsFinished

with raw json in the body:

{
 "instance_token":"1f13cd00-f6fc-49fc-918b-2915bc05908f"
}

and get something like this:

{
    "status": true,
    "message": "",
    "data": {
        "instance_is_finished": false,
        "instanse_is_finished_description": ""
    }
}

or status: false and message: Instance is not finished

Getting all statuses of process

---

We call: http://hostname:8080/event/getEvents

with raw json in the body:

{
    "instance_token": "1f13cd00-f6fc-49fc-918b-2915bc05908f"
}

and get something like this:

{
    "status": true,
    "message": "",
    "data": {
        "events": [
            {
                "Status": {
                    "ID": 1,
                    "CreatedAt": "2022-01-24T00:22:27.278227+03:00",
                    "UpdatedAt": "2022-01-24T00:22:27.278227+03:00",
                    "DeletedAt": null,
                    "ObjectID": 1,
                    "StatusName": "STARTED",
                    "StatusDesc": "",
                    "StatusType": "MANDATORY"
                },
                "EventCreationDt": "2023-05-10T15:44:49.879293+03:00"
            }
        ]
    }
}