Posted Apr 12 by Karen Ranger.
Updated Nov 11 by Edmund Clayton.

Find out how to get started with OpenText AppWorks Gateway.

Last activity Nov 11 by Edmund Clayton.
1121 views. 0 comments.

Chapter 2 - Getting Started with the OpenText AppWorks Gateway

The AppWorks Gateway is a deployment and management tool for applications, components, and their associated services.

During the installation process of the AppWorks Gateway, you were asked to connect to a database to store your data, as well as to connect to an OpenText Directory Services (OTDS) installation to manage your users. After these connections are made, you can define a trusted connection to your production server. This establishes a trusted connection between the server and clients.

In order to set a trusted server connection to your production server, you need to sign into the AppWorks Gateway as a user who has admin access to your production server.

2.1 - Defining a Trusted Server Connection

To define a trusted server connection:

  1. Sign in to the AppWorks Gateway as a production server admin user. For example, if you want to create a trusted server connection to Content Server, you need to sign into the AppWorks Gateway as a Content Server admin user, such as otadmin@otds.admin.

  2. In the left pane, click Install and follow the prompts to install the <Connector>.zip. The <Connector>.zip file may be included in a product bundle.

  3. When installation is complete, click Connectors in the left pane. If the status of the Connector says “Deploying”, wait for this to disappear.

  4. Click and then click the Settings link. The connector should have a field to define the production server URL. Enter this value.

  5. Click Update Configuration.

  6. In the left pane, click Trusted Servers and verify that a trusted key was added.

2.2 - Installing Applications, Services, and Components

The AppWorks Gateway offers flexibility over the apps and components that your users can access. Apps are separate, independent features in the app runtime client. Because apps are independent from one another, you can allow access to some apps and disable the others. For example, with OpenText ECM Everywhere you can allow access to the Personal Workspace, Enterprise Workspace, and Favorites apps, and hide the Feeds app from your users.

Apps may rely on an associated service. Therefore, you need to make sure all of the services are installed and enabled in the AppWorks Gateway. If you want to prevent your users from accessing a particular app, you must disable the app in the AppWorks Gateway. If you disable a service and not the associated app, users will still be able to see the app on their mobile device. However, users will not be able to use the app.

Components offer additional functionality for apps. For example, with ECM Everywhere, the Object Details Viewer component allows users the ability see the properties, categories, and audit information for objects in the Enterprise Workspace app.

Each app, component, and service in the AppWorks Gateway shows summary, settings, statistics, and history details. Altering the settings might negatively impact performance. Only experienced administrators should modify these settings.

To install an app, service, and component:

  1. Download the app, service, component or product bundle. A product bundle is a ZIP file of several apps, services, components, and/or connectors. Product bundles typically have a file extension of .otagbundle. For example, everywhere_16.x.x.otagbundle.

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

  3. In the left pane, click Install an app.

  4. Click Browse and navigate to the app, component, service, or product bundle.

    Tip: You can also drag and drop the file onto the indicated region.

  5. Click Install Package and follow the on-screen instructions. By default, all apps, services, and components are disabled. In order to give your users access to an app, you need to enable the app as well as the associated service.

    During the installation process, the Deployments page will appear with information showing the status of the installation. Wait until all apps, services, and components have deployed before configuring and enabling them. If errors occur during the deployment, you can redeploy the app by clicking the redeploy icon for the app that failed to deploy.

2.3 - Enabling an Application, Component, or Service

To enable an application, component, or service:

  1. In the AppWorks Gateway, do one of the following:

    • In the left pane, click Apps and then click Enable for the apps you want your users to have access to. When an app is disabled, users will not see the app in the runtime client on their mobile devices.

    • In the left pane, click Components and then click Enable for all of the components you installed.

    • In the left pane, click Services and then click Enable for all of the services you installed. When a service is disabled, your users will not be able to access their content. If the associated app is still enabled, users will still see the app in the runtime client on their mobile devices. However, it will be unusable.

    Tip: You can also enable all of the Apps, Components, and Services by clicking All in the left pane and then Enable All.


    Figure 1-1: Enabling the Content Server Connector

  2. Repeat step 1 for all of the apps, services, and components that you would like your user's to access.

2.4 - Viewing Details and Downloading Apps, Services, and Components

To view details and download apps, services, and components:

  1. In the left pane of the AppWorks Gateway, click Apps, Components, or Services.

  2. Click the Settings icon for the app, component, or service for which you want to view property details.

  3. Do one of the following:

    • Click Summary to see the version number, install date, and the date the feature was last updated.

      You can also download the feature by clicking the Download link. Some apps have associated components and services that you also need to download in order for the app to work in another AppWorks Gateway. Click Components or Services in the left pane and verify if a service or component is present. Based on the name and description of the component or service, it may not be obvious if they affect the downloaded app.

    • Click Settings to adjust the settings accordingly.

      Caution Caution: Changes to these values might negatively impact performance. Only experienced administrators should modify these settings.

    • Click Audience to filter the app based on runtime, user, or group. For details, see 2.5 - Filtering the Runtime and User Audience.

    • Click Deployments to see the deployment status of the feature. Click the deployment management link for more details on the deployment status.

2.5 - Filtering the Runtime and User Audience

By default, all enabled apps will appear in every runtime that is connected to the AppWorks Gateway. One example of a runtime is the OpenText AppWorks app that you can download from the Apple App Store or Google Play. In addition to this, all enabled apps will be available to every user or group that is present in your database. To prevent this, you can filter each app to only appear in the runtime that you specify. You can also specify that an app is only available to select users or groups.

To filter the runtime audience:

  1. In the left pane of the AppWorks Gateway, click Apps.

  2. Click the Settings icon for the app that you want to filter.

  3. Click the Audience tab and do one of the following:

    • To display the app in all runtimes installed on the user’s client, select the Available in all runtimes check box.

    • To display the app in a certain runtime client only, clear the Available in all runtimes check box and select the check box next to the appropriate runtime.

    • To display the app in a runtime that isn’t displayed, click Runtimes in the left pane. Complete the displayed fields and click Add. Repeat steps 2 – 3, only this time select the check box next to the new runtime.


      Figure 1-2: Filtering the Runtime Audience

  4. Click Save.

To filter the users and groups who can see an app:

  1. In the left pane of the AppWorks Gateway, click Apps.

  2. Click the Settings icon for the app that you want to filter.

  3. Click the Audience tab.

  4. Click the User and Group Audience link and do one of the following:

    • To display the app in the runtimes of all users, select the Available to all users check box.

    • To display the app in the runtimes of only a specific user or group, clear the Available to all users check box. In the Search for Users/Groups box, type the first few letters of the username, first name, last name, or group name to whom you want to grant access to this app. A list of users or groups displays. Select one or more check box for the user or group.


      Figure 1-3: Filtering Users and Groups

  5. Click Save.

2.6 - Distributing Mobile Clients

You can inform your users of the mobile client they need to install for your product by emailing them a link to the app. Before attempting this procedure, make sure you have an SMTP mail server properly configured in your AppWorks Gateway. For details, see Chapter 3 - Configuring the OpenText AppWorks Gateway.

To distribute mobile clients:

  1. In the left pane of the AppWorks Gateway, click Mobile Client Distribution.

  2. In the Send Distribution Email region, select a runtime that will be included in the email.

  3. In the same region, you can choose to send an email to a specific group(s) in OTDS, to specific users by entering their email address, or to a list of users that are in a CSV file.

  4. Click Send Email.

2.7 - Sending a Test Notification

To send a test notification:

  1. In the left pane of the AppWorks Gateway, click Notification Test.

  2. In the Native Alert region, enter a Title and Notification Summary.

  3. In the AppWorks Data region, enter the Data Summary and Data Payload.

  4. In the Target AppWorks App box, click Search App and search for the app to which you want to send the notification.

  5. In the Username/First Name/Last Name field, search for the user to whom you want to send this notification.

  6. Select the user from the search result.

  7. Click Send.

Top of page



Table of Contents

Your comment

To leave a comment, please sign in.