Posted Jun 08 by Edmund Clayton.
Updated Oct 31.

An overview of the available settings in OpenText AppWorks Gateway version 16.2.1

Last activity Oct 31 by Edmund Clayton.
871 views. 1 comment.

Chapter 9 – OpenText AppWorks Gateway Settings Overview

This chapter describes the settings that are available for the following categories:

  • General – Specify the URL of the AppWorks Gateway server and the OTDS server, and choose from various authentication options.

  • MDM – Specify the settings for mobile device management, for example, whether to enable or disable client tracking.

  • Mail – Specify the SMTP settings to use when sending emails from the Gateway.

  • Temp File – Specify where to store temporary data files, and how long to leave files on the system.

  • Notifications – Determine the settings to use when sending messages to client applications.

9.1 – General Settings

To define the general settings:

  1. Sign in to the AppWorks Gateway as an admin user.

  2. In the Admin Menu, click Settings from the Configuration section, and then click General Settings.

  3. Define the following:

    • AppWorks Gateway Server URL – The URL that clients and providers use to reach this server. This URL is also needed for links in external invitations and for auto-configuration of the OT Sync Connector. Use the fully qualified host name of the server. Do not use http://localhost:8080. This URL is also needed for links in external invitations and for auto-configuration of the OTSync Connector. The OTSync Connector provides a connection, authentication handling, proxy mappings and trusted provider key registration for OpenText Tempo Box.

      Note: If you change the AppWorks Gateway Server URL, stop and restart the Apache Tomcat service.

    • Session Token Cleanup Interval (s) – Timed out OTAG session tokens will be cleared from memory periodically given this duration.

    • Session Token Timeout (s) – Session tokens generated by the OTAG layer will become invalid after this period of inactivity.

    • OpenText Directory Services (OTDS) URL – The URL of the OTDS service that is used by OTAG for authentication and identity information. When you installed AppWorks Gateway, you connected to an OTDS service. You cannot change to a different OTDS service after installation, and this field is therefore read-only.

    • Do Not Proxy OTDS – The proxy server will not be used by the client to obtain an OTDS login URL. Instead, the client will use the URL specified in the AppWorks Gateway.

    • Cookie domain for generated OTDS cookies – Enter a cookie domain for generated OTDS cookies generated by OTAG to be used across subdomains. For example, enter “.example.com” to allow subdomain app2.example.com to use cookies generated for subdomain app1.example.com.

    • Force password based (non-OAuth) authentication – Asks the mobile client to use form-based authentication. There will be no OTDS single sign on regardless of whether OTDS supports OAuth. Ensure that this check box is selected when you install the AppWorks Gateway with the following OpenText products:

      • Process Suite

      • Tempo Box

      • Content Server Mobile

    • Disable OTDS OAuth – Disables the use of OAuth within AppWorks Gateway. By default, the mobile client shows the OTDS login page and uses oAUTH for login. If you choose to the select Disable OTDS OAuth, the mobile client will show the OTDS login page but will not use oAuth for login.

    • OTDS SSO Disable by IP (Comma Separated List, CIDR Notation) – Allows the administrator to disable the single sign on dialogue for users outside the network. For example, with Tempo Box external users.

    • AppWorks Gateway Console Developer Mode – When selected, this adds a User Management link in the AppWorks Gateway and increases the level of detail in the gateway.log error responses.

  4. Click Update Settings.

9.2 – MDM Settings

To define the mobile device management settings:

  1. In the Admin Menu, click Settings from the Configuration section, and then click MDM Settings.

  2. Define the following:

    • Client Tracking Enabled – If enabled, you can track the clients that a user has used and perform a remote wipe.

    • Remote Wipe Timeout (s) – The duration in which an email is sent to the recipients in the Remote Wipe Failure Email Recipients field if a remote wipe was not successful.

    • Remote Wipe Failure Email Recipients – The email addresses listed in this field will be emailed if a remote wipe action did not occur after the timeout duration specified in Remote Wipe Timeout (s) has passed. If you receive a remote wipe email failure, the wipe did not take place so you should reset the user password to prevent the user from signing into their account.

    • Permit Storage of Password (On Device) – After a user signs in for the first time, this setting allows your users the ability to close and reopen the app without typing their password. The only exceptions are if the user signs out of the app or the duration in which a password expires in the Password on device expiry (s) field has not passed.

    • Password on Device Expiry (s) – The duration in which a password is stored on a device.

    • Permit Offline Access on Device – When selected, users can access information on a device when it is offline.

    • Notify Devices of Offline Policy Change – When selected, users will be notified if the value of the Permit Offline Access on Device field changes.

  3. Click Update Settings.

9.3 – Mail Settings

To define the mail settings:

  1. In the Admin Menu, click Settings from the Configuration section, and then click Mail Settings.

  2. Define the following:

    • SMTP Return Address – The email that is generated by the AppWorks Gateway will be sent from this email address.

    • SMTP Host – The host name or IP for the SMTP mail server.

    • SMTP Port – The port for connecting to the SMTP mail server. The default port is 25.

    • SMTP Username – The username for connecting to the SMTP mail server. This setting is optional.

    • SMTP User Password – The password for connecting to the SMTP mail server. This setting is optional.

    • SMTP Use SSL – If enabled, communication with the SMTP mail server will be secured using SSL.

  3. Click Update Settings.

  4. To test these settings, do the following:

    a. In the Send Test Email section, enter an email address in the To field.

    b. Optional: Enter information in the Subject and Message fields.

    c. Click Send Email.

9.4 – Temp File Settings

To define the temp file settings:

  1. In the Admin menu, click Settings from the Configuration section, and then click Temp File Settings.

  2. Define the following:

    • Temporary Directory Path – The absolute path to a directory that is writable by the AppWorks Gateway, which will be used for temporary data. This directory should already exist.

    • Temporary File Cleanup Interval (s) – Temporary files will be checked for freshness and stale files discarded periodically with this duration.

    • Temporary File Lifetime (s) – Old temporary files will be cleared from disk when they have been untouched for at least this long.

  3. Click Update Settings.

9.5 – Notifications Settings

  1. In the left pane of the AppWorks Gateway, click Settings and then click Notifications.

  2. Define the following:

    • Notification Purge Interval (s) – The interval at which the notifications table will be purged of notification records.

    • Maximum Notifications Table Size – The maximum number of notification records retained before a purge is triggered by the table monitor.

    • Back-channel Stale Connection Cleanup Period (s) – The interval at which back-channel connections will be checked for freshness and stale connections discarded.

    • Notification Refresh Interval (s) – The interval at which fresh notification sequence data is published to clients. This affects how often a client will ask for new notifications based on the last known sequence value.

    • Back-channel Timeout (ms) – The time in which a client long poll connection for notifications will remain open.

    • Max Long-poll Connections per User – This is used to prevent DoS attacks. When a user connects more than this number of clients simultaneously, the oldest connection will be dropped.

    • Back-channel Stale Connection Cleanup Age (s) – Back-channel connections will be cleared from memory when they have been idle for at least this long.

    • Permitted Get Request Interval (s) — The interval at which notifications clients are permitted to request notifications before being throttled. Client requests will be dropped in favour of a Denial of Service at the Gateway.

    • Activate Push Notification Logging – Specifies whether push notification activity is logged to gcm.log.

      Note: Logging the push notification activity results in a large log file that must be actively managed.

  3. Click Update Settings.


1 Comment

0

This article has been updated to expand on some definitions. The same updates are available in the PDF version of the AppWorks Gateway Installation and Administration Guide, labelled as version 2, and available from the Getting Started page, the Software Downloads page, and from the Release Notes for 16.2.1 page.


Table of Contents

Your comment

To leave a comment, please sign in.