Form Transporter API Details
This document provides basic information for the API calls for the transporter. Three operations are available:
- Request a Form Export
- Request a Form Import
- Get Status of a Form Import/Export
In addition, there is Integration Broker setup information.
Transporter API Calls
Navigation: Manage GT eForms 3.x > GT Utilities > Transporter Tool
Request Form Export
Service Operation: G3TRANSPORTER_REQUEST_EXP.v1
Request Message: G3TRANSPORTER_REQUEST_EXP_CONT.v1
- Base URL =
http://<yourdomain:port>/PSIGW/PeopleSoftServiceListeningConnector/<your node> - Message Type = POST
- Message Format = soap+xml
| Field Name | Format | Required | Comments |
|---|---|---|---|
| FileLocation | Character(100) | Y | Location to write the export file; either a literal path or PeopleSoft URL definition. Literal path should have trailing “/” or “\” PS URL recognized by a prefix of “URL.” |
| FormType | Character(10) | Y | Form to export |
| UseProcessScheduler | Character(1) | N | When not specified the setting on the Form Transporter configuration will be used. When “N” the handler will complete the export before returning the status. |
Request Message: G3TRANSPORTER_STATUS_RESP_CONT.v1
- Message Format = xml
| Field Name | Format | Comments |
|---|---|---|
| TransporterId | Character(30) | Transporter Request Id generated for the request. |
| Status | Character(4) | Export Request Status – ERR (error), PND (pending), CMP (complete) |
| StatusInformation | Character(254) | Description of the status, for example the reason why the status is ERR |
| Filename | Character(80) | Name of the file generated for the export |
Request Form Import
Service Operation: G3TRANSPORTER_REQUEST_IMP.v1
Request Message: G3TRANSPORTER_REQUEST_IMP_CONT.v1
- Base URL =
http://<yourdomain:port>/PSIGW/PeopleSoftServiceListeningConnector/<your node> - Message Type = POST
- Message Format = soap+xml
| Field Name | Format | Required | Comments |
|---|---|---|---|
| FileLocation | Character(100) | Y | Location to read the import file; either a literal path or PeopleSoft URL definition. Literal path should have trailing “/” or “\” PS URL recognized by a prefix of “URL.” |
| Filename | Character(80) | Y | Name of the file containing the form import |
| UseProcessScheduler | Character(1) | N | When not specified the setting on the Form Transporter configuration will be used. When “N” the handler will complete the import before returning the status. |
Request Message: G3TRANSPORTER_STATUS_RESP_CONT.v1
- Message Format = xml
| Field Name | Format | Comments |
|---|---|---|
| TransporterId | Character(30) | Transporter Request Id generated for the request. |
| Status | Character(4) | Export Request Status – ERR (error), PND (pending), CMP (complete) |
| StatusInformation | Character(254) | Description of the status, for example the reason why the status is ERR |
| Filename | Character(80) | Not applicable |
Get Request Status
Service Operation: G3TRANSPORTER_STATUS.v1
Request Message: G3TRANSPORTER_STATUS_RQST_CONT.v1
- Base URL =
http://<yourdomain:port>/PSIGW/PeopleSoftServiceListeningConnector/<your node> - Message Type = POST
- Message Format = soap+xml
| Field Name | Format | Required | Comments |
|---|---|---|---|
| TransporterId | Character(30) | Y | Transporter Request to get the status for |
Request Message: G3TRANSPORTER_STATUS_RESP_CONT.v1
- Message Format = xml
| Field Name | Format | Comments |
|---|---|---|
| TransporterId | Character(30) | Transporter Request the status is for |
| Status | Character(4) | Export Request Status – ERR (error), PND (pending), CMP (complete), NF (not found) |
| StatusInformation | Character(254) | Description of the status |
| Filename | Character(80) | Name of file imported or exported |
Integration Broker Configuration
Service Operation Routings
The service operation routings may need to be modified or replaced with the IB node that represents the 3rd-party system.
Service Operation Routing Summary
| Service Operation | Operation Type | Sender Node | Receiver Node |
|---|---|---|---|
| G3TRANSPORTER_REQUEST_EXP | Synchronous | 3rd Party | PeopleSoft |
| G3TRANSPORTER_REQUEST_IMP | Synchronous | 3rd Party | PeopleSoft |
| G3TRANSPORTER_STATUS | Synchronous | 3rd Party | PeopleSoft |
Service Operation Security
Integration Broker has several options for security if needed. The service operations for the transporter use PeopleSoft user security, permission lists G3FORMADMIN or G3FORMTECH. This can be removed or replaced with another security approach. It must be done before the WSDL is generated.
Provide Web Services to the Service
Once the Service Operations are configured the WSDL file can be generated. The process should be repeated for any changes to the service operations.
Use the Provide Web Services component to generate (Navigation: PeopleTools > Integration Broker > Web Services > Provide Web Services).
- Step 1: Choose the Service
G3FORMTRANSPORTER - Step 2: Include all Service Operations
- Accept all defaults on remaining steps, click Finish