Active Workspace timeouts

The following diagram shows a typical Teamcenter layout. Types of timeouts Activity timeout Starts a timer on the last activity and will time out the resource if no new activity is detected within the time frame. Lack of response timeout Encountered when a resource makes a request and does not receive a response within the timeout period Teamcenter server manager (pool manager) timeout This is an activity timeout. If the tcserver doesn't receive any requests within the timeout period it is closed out. Server manager timeout settings Teamcenter web tier session timeout This is an activity timeout. Session timeout represents the event occurring when a user does not perform any action on a web site during an interval (defined by a web server). The event on the server side, changes the status of the user session to ‘invalid’ (no longer used) and it instructs the web server to destroy it, deleting all data contained in it. Session Timeout on owasp.org Active Workspace gateway timeout This is a lack of response timeout. This is a timer for how long the Active Workspace Gateway will wait for a response from a backend server (Teamcenter web tier, FMS, etc.). Session timeout on requests originating with the server to backends/routes. The node.js default is 2 minutes. The parameter is in milliseconds. https://nodejs.org/api/http.html#http_request_settimeout_timeout_callback https://nodejs.org/api/https.html#https_server_settimeout_msecs_callback You can configure per the CLI or via the configuration file. autoLogout Default value is 120000 ms (2 minutes). This is a session logout timeout. Specifies the amount of time the gateway should wait before logging out the user session. The gateway starts waiting when either: All Active Workspace browser tabs to that session are closed or when the browser is completely closed. Requires WebSocket communication between the browser and the gateway. When an Active Workspace client logs in using a browser, it establishes a WebSocket connection between the browser and the Active Workspace Gateway. If this WebSocket connection is lost for more than a timeout period, then the Active Workspace Gateway will use the session cookie to terminate the session via logout. httpRequestResponse Default value is 600000 ms (10 minutes). This is a timeout on request responses originating with the server to backends/routes. Copy { "timeout": { "autoLogout": 120000, "httpRequestResponse": 600000 } } Proxy timeout This is a lack of response timeout. Proxy severs like Apache and F5 have activity timeout and lack of response timeouts. Activity timeouts usually default to 300 seconds. The latest proxies have plenty of RAM, so there isn’t a problem keeping session for long period. In the past, administrators would want idle sessions clear to save resources. A load balancer using session cookies to maintain persistence (stickiness) solves the problem because with the cookies the load balancer re-establishes the connections even when they have been timeout. Apache Server (httpd) https://httpd.apache.org/docs/2.4/mod/core.html#timeout F5 Load Balancer https://www.f5.com Amazon Elastic Load Balancer https://aws.amazon.com/blogs/aws/elb-idle-timeout-control/ Active Workspace client polling timeout This is an activity timeout. There are background SOA calls if the user leaves the client open in a browser. This timeout controls how long these polling calls happen after the last user activity in the browser for the Active Workspace client. The Teamcenter preference name is AWC_Polling_Timeout. This is a site level preference and the value is in minutes. If the value is not greater than zero, there is no choking of the polling. The value must be greater than zero to enable this feature. Following are related Teamcenter preferences that do not control timeouts, but rather the wait times between polling calls from the client. AWS_Notifications_Polling_Interval This value is in minutes. If set to 0 (zero), this will disable the polling. AWS_Inbox_Polling_Interval This value is in minutes. If set to 0 (zero), this will disable the polling. User session timeout When it comes to timeouts on the tcserver, you need to consider the following. Assuming you have a user logged into an AW client & they stop all interactive activity. The AW Client polling timeout needs to happen. The TC web tier session timeout and TC Server Manager timeout would begin as soon as the Active Workspace client stops making requests. Once an Active Workspace client user goes idle, the AW Client polling timeout countdown begins. When this timeout is reached, the Active Workspace client blocks background polling SOA calls, and the Teamcenter web tier timeout countdown starts from the last SOA call. Once this timeout is reached, subsequent call to Teamcenter require re-authentication with the underlying identity provider. Troubleshooting The following information many be needed by support personnel. What are the timeout settings? Preferences: AWC_Polling_Timeout, AWS_Notifications_Polling_Interval, AWS_Inbox_Polling_Interval Active Workspace Gateway: http response timeout Teamcenter web tier: session timeout Teamcenter pool manager: inactivity timeout What is the tested scenario that is not working as desired? For example: User logs into Active Workspace client. User performs specific actions. User stops interacting with the AW client browser tab. Was the browser tab in the foreground or background? After a specified time, the user does a specific action which indicates that a timeout has occurred. Was the user presented with an error, prompted for re-authentication, or resumed the session? What is the expected behavior? What exactly was expected other than the observed behavior? Additional data that may be required. Browser HAR of the failing scenario from login or page refresh to failure. Verify that the preferences returned from getPreferences align with the configured timeout settings. Active Workspace log file. Active Workspace gateway config.json file.