Edit

Configure session timeout

In the this guide, you will come across the following terms:

• Assignment processing time: the time within which a Manual Task (MT) (or assignment) is not available to other workers. When this period ends, the assignment progress is lost if the user hasn't saved the results.
• New processing period: the time in minutes you want to set as the new processing period for assignments.
• Session idle period: SSO Session Idle, the time in minutes before a user session expires automatically if a user doesn't interact with the application. A session can be idle before its time expires. Tokens and browser sessions are invalidated when a session is expired.

Problem

As soon as the processing period of a Manual Task expires, all task progress is lost, and the assignment becomes available to other workers. Some assignments can be too complicated for workers to complete within the default timeframe. In this case, you can increase the Manual Task processing time.

To check the time remaining for the MT processing, see the timer in the top right corner of the WorkSpace interface.

Explanation

The WorkSpace application uses two sessions: the Keycloak one and the WorkSpace one.

• The Keycloak session is configured in the Keycloak administrator's section with the SSO Session Idle parameter. The value must be greater than New processing period.
• The WorkSpace session is configured in ZooKeeper with the ws.assignment.max-lock-time and server.servlet.session.timeout properties.

The default values ​​for these properties are as follows:

• SSO Session Idle: 40m
• ws.assignment.max-lock-time: 35m

To avoid problems when processing assignments, use the defaults. If you want to change the values, you must follow the rule: SSO Session Idle > ws.assignment.max-lock-time.

Otherwise, if you work on a Manual Task longer than the session timeout, you can't submit the processed assignment and lose your changes.

Solution

To change the assignment processing time, follow the steps below.

Step 1. Configure session in Keycloak

important

You need Step 1 only if you want to increase the processing time. For reducing the timeframe, you can skip Step 1 and go to Step 2.

First, you need to ensure that the Keycloak's SSO Session Idle value is greater than New processing period. Thus, the user's session is not lost before New processing period passes.

To verify the SSO Session Idle parameter, follow the steps below:

1. Open Keycloak.

2. On the left menu, in the realms dropdown, select WorkfusionRealm.

3. Go to the Realm settings section.

4. Open the Tokens tab.

5. In the SSO session idle box, change the value to make it greater than the projected New processing period.

   Remember to set the period in minutes. The unit of measurement is displayed to the right of the numeric value of the SSO session idle box.

6. Click Save.

Step 2. Update processing period in ZooKeeper

To change the processing period, you have to configure the properties loaded by WorkSpace on startup.

Change application properties

You can change application properties via the ZooKeeper service.

For a detailed guide on connecting to and working with ZooKeeper via ZooNavigator, see Set properties in ZooKeeper.

1. Log in to ZooNavigator and find the WorkSpace properties in the /config/workspace folder (or node). To find the folder, in the Search bar, type "/config/workspace" and press Enter.

   

   On the left bar, you can see all WorkSpace properties synchronized with ZooKeeper. You need the items associated with the assignment processing time:

   • ws.assignment.max-lock-time: assignment processing maximum time. The default value is 30m.
   • server.servlet.session.timeout: user session timeout in minutes in WorkSpace. The default value is 35m.

   If there are no such properties, create nodes for them:

   1. In the top toolbar, click the Create node icon (it looks like a folder with the plus sign).

   2. In the Enter new path box, type /config/workspace/ followed by the required property name. For example, /config/workspace/ws.assignment.max-lock-time.

      

   3. Click the Create button to sync the new property with ZooKeeper.

   4. Repeat Steps 1 to 3 for the other property.

      

2. On the left bar, click the ws.assignment.max-lock-time node and set the new New processing period, for example, 60m. Click Save.

   

3. Click the server.servlet.session.timeout node and set the same New processing period value as above +5m. Click Save.

   

   note

   The server.servlet.session.timeout value must be greater than ws.assignment.max-lock-time by at least 5 minutes. For example:

   • ws.assignment.max-lock-time=NEW_PROCESSING_PERIOD m
   • server.servlet.session.timeout=(NEW_PROCESSING_PERIOD + 5) m

You have successfully updated the properties.

Restart WorkSpace

To sync the updated properties with WorkSpace, restart the application:

1. On the Master server, connect to the server's terminal via SSH.
2. In the terminal, execute the command wfmanager restart workspace.
3. Wait until the command execution finishes.

Check

To check that the assignment processing time is changed, follow the steps below:

1. In your browser, log in to WorkSpace.
2. Click any assignment.
3. In the top right corner, you can see the new processing time.