edinn Platform: User Guide

This section handles the resources configuration. Please notice that this was changed to 'recourses' instead of 'resources' as this last is a reserved word in URLs.

GET /recourses/config/{id}

This method returns the list of resources 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 recourse.

Response:

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

Example:

POST /recourses/config

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

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

• company [mandatory]: the company name or id.
• session [mandatory]: the Id of the active session.
• id [mandatory]: the id of the resource.
• pass [mandatory]: the password of the resource.
• name: name of the person.
• lastname: last name of the person
• language: to configure the system when the user connects to the system.
• email01: used to:
• receive notifications or comments that are sent through the comments system.
• list of the autocontrol tasks that are about to expire.
• indications of what messages, in the communication flow between edinn and other systems (ERP, etc.), have failed and require manual intervention.
• email02: used to:
• receive notifications of not done autocontrol tasks.
• receive notifications of processes that are stopped more than a certain time.
• code: code for quick access from the login window. This is useful for card readers, so that the user just passes the card and automatically logs in the system.
• tooltips: if 1, help tags will appear on screen to the user next time he logs in.
• y0: yellow target of activity.
• g0: green target of activity.
• areas: if the user is restricted to access only the process of certain areas. Indicate them separated by commas: AREA1,AREA2. The user will only be able to see the areas indicated here. Leave blank to see all areas.
• processes: if the user is restricted to access only these processes. Indicate them separated by commas: PROC1,PROC2. The user will only be able to see the processes indicated here. Leave blank to see al processes.
• associated process: this is useful when a process is a person. With this field the selected person will be associated with that particular process.
• roles (permissions or security): please see the available roles in resources configuration. You should check if the bit of the corresponding role number (substracting 1 as they start in the bit zero) is active in this number.
• expire: after this date, the person will not be able to access the system, will not be shown in the resources (persons) list at the login page nor will be able to access the reports tool.
• scheduleatstart: what should happen when a new work order is started, to pause, to prefinish or to finish the work order which is being processed in that moment.
• fields_production: indicates the customized product fields that will be visible for the user.
• fields_autocontrol: indicates the customized autocontrol tasks fields that will be visible for the user.
• alertsweekdays: the days that the user will receive alerts.
• alertstype: the type alerts the user will receive.
• alertsat:the time at that the user will receive alerts.
• alertssent: indicates if the user will receive alerts.
• sso: single sing on, enables the user to autoload when starting the session in the computer.
• maxunits: the maximun number of recourses that can be used at the same time.
• decimalsymbol: indicates which symbol will be used for this resource to indicate decimals.
• schedulefields: is a combination of bits to indicate which columns of the data grid in the Schedule window are visible for this resource.
• orderschefields: if different of zero the system will allow this resource (user) to sort the data table in the Schedule window by any visible column. Otherwise, the table will be automatically sorted by the WBS column.
• notify: if 0 the user will not be notified about changes in the status of work orders.
• template_proc: template process. If indicated, it makes a copy of the indicated process and establishes it as the process associated with the person. It is useful in work management.
• maximun_time: Maximum uninterrupted time in seconds that the resource can be IN in a process. After this time, the system will automatically OUT. If left at zero, it will not be applied.

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.

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

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

Request parameters (for additional information please review the resources 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 resource.

Response:

• status: Returns "0" on success, and an error code in any other case.
• data: the json encoded B2MML data with the response.
• message: "Success" or a descriptive information of the error in any other case.

Example:

Response example:

DELETE /recourses/config/{id}

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

Request attribute:

• id: the Id of the device 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.