edinn Platform: User Guide

This section handles the processes configuration.

GET /processes

This method returns the list of processes accessible for the user.

Request parameters:

• company [mandatory]: the company name or id.
• session [mandatory]: the Id of the active session.
• id: The id of the process, to show only one.

Response:

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

Example:

GET /processes/{process}/reta

Returns the Id of the favorite tabs assigned to that process

Request attribute:

Process [mandatory]: the id of the process

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: Returns the Id of the favorite tabs assigned to that process, or true if there is no data to be returned.
• message: "success" or a descriptive information of the error in any other case.

Example:

Request:

/processes/A0L1/reta

{

"session": 01qgmfcZmZ4nqg2eNGpxY4JlpmhJuKw1H31p5rtD1a112SSK8S8odROFIKgn

"company": DEMO04

}

Response:

{

"status": 0,

"Data":

{

true,

}

"message": "Success"

}

POST /processes

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

Request parameters (for additional information please review the process configuration):

• company [mandatory]: the company name or id.
• session [mandatory]: the Id of the active session.
• id [mandatory]: the id of the process.
• order: the relative order to be shown.
• desc: the description of the process.
• calculation: the calculation type of the process.
• cycleot: operator time in seconds. How many seconds from the Cycle Time (see next) correspond to the resource (person) work.
• cyclet: time in seconds per cycle of production. Please see Maximum speed.
• maxcyclet: this is the template cycle time to apply when creating new orders.
• cycleq: number of units expected per cycle of production. Please see Maximum speed.
• npcauto: indicates the number of units of results with a maintained speed for the system to automatically update the maximum speed of the process. Automatic update of maximum speed is disconnected if this value is left to 0.
• unit: the unit id of what the process produces.
• minopers: minimum number of working persons that can work at the process at a certain moment.
• opers: maximum number of working persons that can work at the process at a certain moment.
• y0: yellow objective for availability.
• g0: green objective for availability.
• y1: yellow objective for speed.
• g1: green objective for speed.
• y2: yellow objective for quality.
• g2: green objective for quality
• y3: yellow objective for productive availability.
• g3: green objective for productive availability.
• y4: yellow objective for the quantity of MTBF.
• g4: green objective for the quantity of MTBF.
• y5: yellow objective for the MTBF.
• g5: green objective for the MTBF.
• y6: yellow objective for the MTTR.
• g6: green objective for the MTTR.
• y7: yellow objective for the OCE.
• g7: green objective for the OCE.
• trace: indicates if the signals should be sent to the registry (0 for inactive, or 2 for active).
• next_processes: the list (separated by ,) of the next processes in the line.
• resps: the list of the responsibles (ids from Resources).
• stshort: minimum stop time in seconds in order to be registered as failure (FAI). Stops with less time will be registered as Microstops.
• prshort: minimum production time in seconds in order to be registered as production. This cannot be 0 and should be correctly configured considering server parameters. Contact your technical support and request to check this value according to option "Check Status Every" at the Monitor window of the server.
• microstop: status that will be automatically used to automatically justify microstops.
• url: document or application that will be opened when the user clicks on the that appears after having clicked on the process, on the main window. Please see how to configure URLs.
• lockrec: indicates after how many minutes the time and production registers will be blocked for users without supervisor permission. This allows to force justifications before a certain time.
• man: combination of bits to indicate how the process is monitored manually.
• genpstart: this mark, when 1, 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 status configuration the option Work start has been marked for one, and no more than one, status.
• interign: marks, when 1, the process as to be ignored when transferring from and to information to another system, like ERPs. Please see integration with other systems.
• limprodtosche: if marked, with 1, the process is restricted to follow the orders scheduled for it, and that can be viewed at the view schedule window.
• allowconf: if marked with 1, allows the user to configure the process and to add more statuses and more results.
• type: indicates, when 1, that the process is dedicated to attend services. This mark will, for example, show the working time of these processes as services in the FTE report.
• requirenotify: this selector, when 1, forces the user to indicate quantities when closing an order in the selected items.
• wbs: reserved for advanced scheduling of tasks.
• notifyratios: if selected, the system will notify by email (1) when the selected ratio (OEE, Availability, Speed or Quality) is below the yellow target, in any of the defined periods.
• represent: indicates, when 1, if the process is the representant of an area.
• excessordefect: in case notifyratios is set to Scheduling, then this will include the deviation % of excess or defect in production of orders to be notified.
• img:an image to upload that represents the process visually.
• schedulefields: (to be implemented) is a combination of bits to indicate which columns of the data grid in the Schedule window are visible for this process.
• operationtime: the time the process has been in operation.

Response:

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

Example:

POST /processes (ISA-95 compliant, for more information please read the B2MML document)

This method creates a process using json encoded B2MML data. The user must have the administrator role.

Request parameters (for additional information please review the process configuration):

• company [mandatory]: the company name or id.
• session [mandatory]: the Id of the active session.
• data [mandatory]: the json encoded B2MML data defining the process.

Example:

Response example:

DELETE /processes/{id}

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

Request attribute:

• id [mandatory]: the Id of the session 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: returns the list of processes and its descriptions.
• message: "success" or a descriptive information of the error in any other case.

Example: