REST API design

1. OpenText Confidential. ©2017 All Rights Reserved. 1
Agenda
1. Overview of Prerequisites, Available Training and Knowledge Transfers
2. New Features and Certifications
3. Migration/Upgrade Path
4. AppWorks Component Classes
5. New Customizations
6. Changes in Integration Points and Dependencies
7. Video Demonstration of New Features
8. Troubleshooting

2. OpenText Confidential. ©2017 All Rights Reserved. 2
New Features and Certifications
• Documentum REST Services API integration with the OpenText AppWorks Gateway.
AppWorks Gateway hosts server applications and is also used for hybrid client application
(mobile, desktop) rollouts and upgrades, push notification services, etc.
• Documentum REST API 20.2 is certified on Appworks Gateway 16.7.

3. OpenText Confidential. ©2017 All Rights Reserved. 3
Migration/Upgrade path
• DCTM REST service can be deployed on Appworks Gateway by deploying a specially
packaged zip archive available for download - dctm-rest-appworks_20.2.zip
• Rename the dctm-rest-appworks-service_<version>.zip to a shortened name to
enable short context path for example: dctm-rest_<version>.zip.
• Appworks Gateway has to be downloaded separately and installed. Please refer to Appworks
Gateway installation and release notes documentation.
• Deploy REST archive to the Gateway container by choosing the DCTM REST archive in the
Gateway admin UI.
• Please make sure to modify REST API dfc.properties, rest-api-runtime.properties under
WEB-INF/classes folder. Any other custom modifications needed for regular dctm-rest.war
deployment should be done on the ZIP archive prior to deployment to the Gateway.

4. OpenText Confidential. ©2017 All Rights Reserved. 4
AppWorks Component Classes
The following have been added to the REST API SDK to support consumption of AppWorks
SDK in custom resources.
• AwSdkBean A Java bean that is included in the controller classes to provide access to
AppWorks SDK clients and provide the utility functions required to send mail, notifications,
change settings, etc.
• AwSdkControllerBase A reference implementation of a controller that you can extend to
handle Appworks custom resource URLs. It includes reference to the AwSdkBean Java bean.

5. OpenText Confidential. ©2017 All Rights Reserved. 5
New Customizations
• In order to consume Appworks Gateway SDK, end users need to write custom REST API
resources and include the jar in the lib folder. Please refer to extensibility section of REST
documentation to learn more.
• A sample Appworks maven project is available in REST API SDK. The included ‘resource-
appworks-samples’ is found under samples folder in the SDK. Code samples in this folder
helps end users acquire basic knowledge of consuming Appworks Platform SDK deployed in
OpenText Gateway. We recommend that end users go through these samples before
developing new resources or extending the available samples.
• The build artifact of this sample project; ‘acme-appworks-samples-0.0.1-
SNAPSHOT.jar’ is included in the ZIP archive so you can directly verify the sample
endpoints exposed. These end points demonstrate the way end users can consume
Appworks SDK client services.

6. OpenText Confidential. ©2017 All Rights Reserved. 6
New Customizations (contd...)
• Service-clients resource: You can access the following endpoints to verify service client
creation. The sample resource bean ‘AwSdkBaseController’ acts as base class for further
customization for specific end users’ use cases.
• Send `GET` request to the URI of http://<BASE_URL>:port/otag/mailclient to successfully
create mail client. Get `success/failure` json message.
• Send `GET` request to the URI of http://<BASE_URL>:port/otag/authclient to successfully
create auth client. Get `success/failure` json message.
• Send `GET` request to the URI of http://<BASE_URL>:port/otag/notificationsclient to
successfully create notifications client. Get `success/failure` json message.
• Send `GET` request to the URI of http://<BASE_URL>:port/otag/runtimesclient to
successfully create runtimes client. Get `success/failure` json message.
• Send `GET` request to the URI of http://<BASE_URL>:port/otag/serviceclient to
successfully create service client. Get `success/failure` json message.

7. OpenText Confidential. ©2017 All Rights Reserved. 7
New Customizations (contd...)
• Send `GET` request to the URI of http://<BASE_URL>:port/otag/settingsclient to
successfully create settings client. Get `success/failure` json message.
• Send `GET` request to the URI of http://<BASE_URL>:port/otag/trustedproviderclient
to successfully create trusted provider client. Get `success/failure` json message.
• Send `GET` request to the URI of
http://<BASE_URL>:port/otag/authenticatetoken?otagtoken=<OTAG_TOKEN> to
create auth client and verify user otagtoken. This authentication is directly carried out by
the Appworks Gateway with OTDS, CORE REST authentication is not involved. Get
`success/failure` json message.

8. OpenText Confidential. ©2017 All Rights Reserved. 8
Changes to Integration Points and Dependencies
• The Appworks specific zip archive can only be deployed on Appworks Gateway via the
admin console, using the install menu. Please do not deploy directly to the webapps folder.
• All the required Appworks Platform SDK libraries will be available to REST runtime after the
zip has been successfully deployed.

9. OpenText Confidential. ©2017 All Rights Reserved. 9
Placeholder for Video Demonstration of New Features
• {=placeholder slide for the demo=}

10. OpenText Confidential. ©2017 All Rights Reserved. 10
Troubleshooting
• Check Gateway logs (gateway.log, gateway-otag.log) in Tomcat logs folder for any
deployment errors. Check for any REST API startup errors in Tomcat catalina logs.
• Ensure, REST service is successfully deployed in Gateway admin console.
• Ensure hostname (and not IP address) is used to access Gateway url.
• Enable REST API debug in log4j.properties under WEB-INF/classes folder. Collect logs for
any issues and report to support.