Session Management
Discover more about the Session Management component and how to use it on the Digibee Integration Platform.
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.
Parameters
Take a look at the configuration parameters of the component. Parameters supported by Double Braces expressions are marked with (DB).
Operation
Operation to be executed (Get Data, Put Data, Delete Data).
Get Data
String
Session Type
Session to insert the object specified in Fields (Local or Global).
Local
String
Fields
Object to be specified - e.g. body, data, id.
body, data, id
String
Scoped
When this option is enabled, the session is isolated from other sub-processes. In this case, the sub-processes see their own version of the session data.
False
Boolean
Operation
This component can be configured in the following operations:
Get Data: the object specified in the Fields parameter is searched to be inserted in the request body.
Put Data: the object specified in the Fields parameter of the previous step will be inserted in the session (Local or Global).
Delete Data: the object specified in the Fields parameter will be deleted.
Session Type
Local
Handles a session in which the stored values are available only in the pipeline with current execution.
Example: The "body" and "data" tags from Fields step are stored in the Local session.
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 Trigger or the HTTP Trigger and has the token JWT as a 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
Fields: object
Messages flow
Input
The component accepts any input message and can use it by declaring the JSON values in the Fields parameter.
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 Data operation selected, the items specified in the Fields parameter are added to the output message (if they exist in the session).
Last updated