edinn Platform: User Guide

This section handles the statuses configuration.

GET /statuses/config

This method returns the list of statuses.

Request parameters:

• company [mandatory]: The company name or id.
• session [mandatory]: The Id of the active session.
• process [mandatory]: The id of the process.
• id: The Id of the parent status. Default null.
• level: The level of status list. Default 1.

Response:

• status: Returns "0" on success, and an error code in any other case.
• data: Returns the list of statuses and its properties.
• message: "Success" or a descriptive information of the error in any other case.

Example:

POST /statuses/config

This method creates a new status. The user must have the administrator role.

Request parameters:

• company [mandatory]: The company name or id.
• session [mandatory]: The Id of the active session.
• id [mandatory]: The Id of the status.
• order: the relative order to be shown.
• level: statuses are organized in 3 levels. These levels allow to show to the user the status in up to 3 levels. The user selects one option, and enters into the second level, selects another option, and goes to the 3rd level where he has to finally select a status.

• desc_de: description of the status (in german).
• desc_en: description of the status (in english).
• desc_es: description of the status (in spanish).
• desc_it: description of the status (in italian).
• desc_pt: description of the status (in portuguese).
• desc_sk: description of the status (in slovak).
• desc_zh: description of the status (in chinese).

• maxtime: maximum time in minutes that a process can be in this status. If any value different from 0 is specified, the system will automatically close this status when it is open and the indicated minutes are surpassed.
• type: production, failure (the working user is waiting for the process), idle time (the process is waiting for the working user), dependence (the process is on hold because it depends on another process) and not scheduled (no work is scheduled because of legal stops, holidays, etc.). Please see "What is a status?" for more information.
• next_status: the id of the next status to automatically pass when the maximum minutes are surpassed.
• actpct: percentage of activity that is required from a working user when a process is in this status. This is a requirement configuration for the activity report.
• url: document or application that will be opened when the user clicks on the  that appears after having clicked on the status, on the status window. Please see how to configure URLs.
• pstart: this mark indicates to the system to automatically generate a new status to indicate that a new work has started, every time a new result with 0 quantity is inserted, if at the process configuration the option Gen W. Start has been marked for the process. Only one status should be marked with this option.
• weel_days: status can be automatically scheduled by days of the week and time. This allows, for example, to close days or weeks with END OF PRODUCTION and start them up when needed.
• schedtime: time at which the status will automatically be inserted.
• blocks: if the status should block any other statuses. Options are: none (no blocking), stops (this status will block all not productive statuses coming later), production (this status will block all productive statuses coming later), all (this status will block all status coming later).
• typedef: indicates to the system that this status is the default for the type. Please see "What is a status?" for more information.
• class: allows to identify the type or class of the status, according to a general classification. This is useful to compare statuses from different plants with different configurations of statuse.

• reqcom: to use the status a mandatory comment will be required.

• reqres: to use the status it will check that no more time than Max Cycle Time of the process has passed since the last result of advance or since the current working order was started. This is useful to guarantee that users inform of results advance before, for example, indicating that they have finished the day.

DELETE /statuses/config/{id}

This method deletes a configured status. The user must have the administrator role.

Request attribute:

• id [mandatory]: the Id of the calculation type to delete.

Request parameters:

• company [mandatory]: the company name or id.
• session [mandatory]: the Id of the active session.

Response:

• status: returns "0" on success, and an error code in any other case.
• data: "Success" on success, and empty in case of error.
• message: "Success" or a descriptive information of the error in any other case.