Adding a File Deployment with Rest Service Connection: Example

The following example describes how to add a File deployment connection to send and receive data using the XMLSampleRestAPI delivered with Primavera Gateway.

• Notes:
• API programmers can use the SampleRestAPI as a template to create rest api and rest services that are specific to the XML data you would like to send and receive using your provider application. For more details see the Primavera Gateway API Programming Guide.
• File deployments using RestService connection only support XML file format.

Prerequisites

(On-Premises Only) SampleRestAPI has been deployed in WebLogic or an application server of your choice. For more details, see the Primavera Gateway Installation and Configuration Guide.

Procedure

To add a File deployment that supports XML file formats using a rest service connection:

1. In the sidebar, select Configuration.
2. Select the Deployments tab.
3. Select Add....
4. In the General step of the Deployment wizard:
   1. Select File in the Select Application Provider field and name the deployment.
   2. Enter the Description: File Deployment - XML Format.
   3. Select Next.
5. In the Deployment step:
   1. Select XML as the File Format.
   2. Select RestService as the File Data Source Type.
   3. Enter the Rest Service User Name.
   4. Enter the Rest Service Password of the user.
   5. Enter the base URL of the rest service in the Rest Service URL field. Use the formats:

      https://<Host Name>:<SSL Port Number>/xmlsamplerestapi/rest

      or

      http://<Host Name>:<Port Number>/xmlsamplerestapi/rest

   6. Set Enable Cross Reference Tracking to True only if you want to ensure Gateway stores and tracks the cross-references for the data being synchronized. This helps the destination application determine if it is a create or update action.

      If the field is unchecked, cross-references will not be stored, and it will be up to the destination application to determine whether to create or update data in the destination application.

6. Select Test Connection to ensure connectivity is established.
7. Select Save.

Tips:

• You can also edit a deployment and select Save in any step to exit the wizard.

Learn more about...

Adding an Application Deployment Connection

Legal Notices | Your Privacy Rights
Copyright © 2013, 2022

Last Published Thursday, October 6, 2022