IMPORTANT: This documentation has been discontinued. Read the updated Session Management documentation on our new documentation portal.
Session Management implements the traditional session management and its main function for the pipelines building is widely used in the storage of data similar to the variables in traditional development.
This component can be configured in the following operations:
GET: the object specified in the "field" parameter is searched to be inserted in the request body.
PUT: the object specified in the "field" parameter of the previous step will be inserted in the session (LOCAL or GLOBAL).
LOCAL
Handles a session in which the stored values are available only in the pipeline with current execution.
GLOBAL
Handles a session based on the token JWT of the authenticated users, allowing pipelines and different executions to have safe access to the stored data in the global session of the user.
The storage and data access will be allowed in GLOBAL session only when the pipeline has the REST or the HTTP Trigger and has the token JWT as safety criteria.
To execute a pipeline with this safety criteria, it's necessary for you to create a login pipeline and use the JWT component to get a token JWT.
Example
Step Name: Session-Management
Operation: GET DATA
Session Type: GLOBAL - has a global scope controlled by the JWT token injected by a REST Trigger
Fields: object - e.g., body, data, id.
Scoped: When enabled, session is isolated to other sub-process. In that case, sub-processes will see their own version of the session data.
Messages flow
Input
The component accepts any input message and can use it by declaring the JSON values in the field "fields".
Output
The component doesn't change any information of the input message. Therefore, it's returned to the following component or it's used as final answer if this component is the last step of the pipeline. When keeping the GET operation selected, the items declared in the field "fields" will be added to the output message (if they exist in the session).