Creating Sponsor Configurations

This topic provides the steps to update context data for all activities in sponsor profile configuration.

The next step is to update the context data for all activities in the sponsor profile configuration. Profile configurations are created by calling the IBM Partner Repository (PR) APIs for each of the following protocols:

    • AS2
    • FTP
    • FTPS
    • SFTP
The Partner Repository URL format is https://{IP}:pr {port}/mdrws/sponsors/{sponsor_context}/doc.
Note: The API request examples in this section are for SFTP. Please refer to the IBM PEM Partner Repository documentation for the syntax to be used for other protocols.
  1. Create a profile configuration. serverType must be set to SG (sponsor gateway) since this is where sponsor information is stored. resourceType and subResourceType values are based on the protocol used. These values are listed in the table following the example: 
    
# URI: mdrws/sponsors/{sponsorcontext}/profileconfigurations/
# Sample Request:
{
"name": "TestSFTP1",
"protocolUserCredentials": null,
"resourceType": "SFTP",
"serverType": "SG",
"subResourceType": "SFTP_INB_PUSH",
}
    Protocol resourceType subResourceType
    AS2 AS2 AS2_OUTBOUND
    CD CDSA CDSA_INB_PUSH
    FTP FTP FTP_INB_PUSH
    FTPS FTPS FTPS_INB_PUSH
    SFTP SFTP SFTP_INB_PUSH
  2. Create a profile type and link it with the profile configuration created in Step 1 (above). The URI must have a value based on the protocol you're using. Protocol values are listed in the table following the example. configurationId value is the response received from Step 1. The name parameter value can be any unique name: 
    URI: mdrws/sponsors/{sponsorcontext}/sftpinboundpushs/
# Sample Request:
<?xml version="1.0" encoding="UTF-8"?>
<create name="testsftp1"
configurationId="bfc90747-7a95-4c8c-9a44-68a288d3614b"partner="">
</create>
    Protocol URI
    AS2 AS2outbound
    CD cdsainboundpushs
    FTP ftpinboundpushs
    FTPS ftpsinboundpushs
    SFTP sftpinboundpushs
  3. Create connection details containing sponsor connectivity information. This information is provided to the partner during activity execution, when the partner is connecting to the sponsor: 
    URI:
/mdrws/sponsors/{sponsorcontext}/sftpinboundpushs/{responseof2nd ap i}/configurationTypes/
# Sample Request:
<?xml version="1.0" encoding="UTF-8"?>
<create host="52.33.115.100"
port="10022" preferredAuthenticationType="PASSWORD" >
<extensions>
<SftpInboundPushTypeExtn extensionName="ParticipantActivityKey" ext
ensionValue="87653456785445"/>
</extensions>
</create>
  4. Create connection details for both non-production (type = TEST) and production (type = PROD) instances.

    Protocol-based values similar to those in Step 2 (above) must be provided in the URL. Extensions to be provided are listed in the following table:

    Protocol Extension Name Extension Value
    AS2 N/A -
    CD NetmapName Provide sponsor's netmap name
    FTP N/A -
    FTPS N/A -
    SFTP IdentityKeyName Provide sponsor's user identity key name

    The above configurations are common for both directions of a partner's connection to a sponsor (inbound push and outbound pull).