Prerequisites for onboarding partners in Sterling File Gateway by using FTPS protocol v2, v3, or v4

This topic describes the prerequisites for onboarding partners in Sterling File Gateway by using the FTPS protocol v2, v3, or v4. If you are using API gateway, use FTPS protocol v3 or later version activities. For more information, see API Gateway Overview.

Ensure that PEM Portal, PEM Partner Repository, and PEM Partner Provisioner are deployed and running.
  1. Sign in to PEM Portal as a Sponsor Administrator.
  2. Click Settings > Attributes.
  3. Click Create and create the following attribute names and values. For more information, see Creating attributes.
    Attribute name Attribute value
    SubResourceType
    • System
    • FTPSInboundPull
    • FTPSInboundPush
    • FTPSOutboundPull
    • FTPSOutboundPush
    RequestType
    • ProvisioningRequest
    • TestRequest
  4. Export the certificate from your Firefox browser. For more information, see Exporting a certificate from the Firefox browser.
  5. Import the certificate with type Trusted. For more information, see Uploading a certificate.
  6. Create the FTPS profile of the DG server type by using the PEM Partner Repository APIs. For more information, see Creating FTPS profile of the DG server type.
    Note: This configuration is applicable only for the FTPS Inbound Push and FTPS Outbound Pull direction.
  7. Download the predefined activities. For more information, see Downloading PEM Portal predefined activities.
  8. Extract the contents of the file to a folder.
  9. Import the required version of FTPS activity XML from the downloaded folder. For more information, see Importing an activity definition. For more information on different versions of activity, see Versions of predefined activities in IBM PEM.
  10. Customize the context data parameters.
    1. From the menu, click Activities. The activities are displayed.
    2. For the FTPS activity, in the Actions column, select Edit.
    3. In the Context Data field, click Edit.... The Context Data window opens.
    4. Click ... (the mapping button). The mapping tree is displayed.
    5. Configure the context data mapping. For more information, see Customizing the PEM Portal context data parameters for predefined activities.
  11. Click OK to save the context data.
  12. Mark the activity as final.
  13. Invite or create a partner.
  14. Sign out of PEM Portal.
  15. Sign in to PEM Partner Provisioner as a Sponsor Administrator.
  16. Create an application with the name, SFG. For more information, see Creating applications.

    As you are currently using Sterling File Gateway as the backend system, you can only create the SFG application. Based on your business need, you can also create the LDAP application if you are enabling external authentication.

  17. Create Test and Production topologies for SFG application with the appropriate values as described in the following table. For more information, see Creating topologies.
    Property SFG Test SFG Production
    Name SFG Test SFG Production
    Description Enter a brief description for test topology, Enter a brief description for production topology.
    Type Test Production
    Resource Types System System
    Applications Select the SFG check box and click Edit. The API configuration window opens. Enter the following details and save your changes. Select the SFG check box and click Edit. The API configuration window opens. Enter the following details and save your changes.
    Protocol Select http from the list. Select http or https from the list.
    Host Enter the SFG test instance host name or IP address where Sterling File Gateway is installed. Enter the SFG production instance host name or IP address where Sterling File Gateway is installed.
    Port Enter the API port number to access the B2Bi APIs. Enter the API port number to access the B2Bi APIs.
    Preemptive authentication Select the check box. Select the check box.
    Authenticate with: Click User Name and Password and enter the SFG test instance user name and password who has permission to access B2Bi APIs. Click User Name and Password and enter the SFG production instance user name and password who has permission to access B2Bi APIs.
    Verify host Select this check box to verify the host name in the URL with the host name in the server certificate. Select this check box to verify the host name in the URL with the host name in the server certificate.
  18. In System Configuration, enter the following property values:
    • PEM_REST_URL
    • PR_REST_URL
    • PEM_INTEGRATION_ENABLED - set the value to true.

    PEM Partner Repository triggers the REST API call to PEM Portal to process the activity.

    For more information, see Viewing or modifying the system configuration.

    For the system properties description, see System properties configured by Sponsor Administrators.

  19. Download the predefined activities. For more information, see Downloading PEM Partner Provisioner predefined activities.
  20. Extract the contents of the file to a folder.
  21. Import the following activities:
    • FTPS IB Pull Provisioning v2/v3/v4.xml
    • FTPS IB Pull Testing v2/v3/v4.xml
    • FTPS IB Push Provisioning v2/v3/v4.xml
    • FTPS OB Pull Provisioning v2/v3/v4.xml
    • FTPS OB Push Provisioning v2/v3/v4.xml
    • FTPS OB Push Testing v2/v3/v4.xml

    For more information, see Importing an activity definition.

  22. Customize the context data parameters.
    1. From the menu, click Activities. The activities are displayed.
    2. For the FTPS activity, in the Actions column, select Edit.
      If the activity is not migrated, the Information window is displayed that provides information about the activity migration. Click OK.
    3. In the Context Data field, click Edit.... The Context Data window opens.
    4. Click ... (the mapping button). The mapping tree is displayed.
    5. Configure the context data mapping. For more information, see Customizing the PEM Partner Provisioner context data parameters for predefined activities.
  23. Click OK to save the context data.
  24. Mark the activity as final.
  25. Create the rules in PEM Partner Provisioner for the System subresource type.
    Note: You can use your preferred rule names for the following rules.
    • System provisioning - This rule is used when the System provisioning request is triggered.
      Add the activities in the System provisioning rule under Configure resources in the following order.
      Sequence Predefined activity name SubResourceType RequestType
      1 FTPS IB Push Provisioning v2/v3/v4 FTPSInboundPush ProvisioningRequest
      2 FTPS OB Pull Provisioning v2/v3/v4 FTPSOutboundPull ProvisioningRequest
      3 FTPS IB Pull Provisioning v2/v3/v4 FTPSInboundPull ProvisioningRequest
      4 FTPS OB Push Provisioning v2/v3/v4 FTPSOutboundPush ProvisioningRequest
    • System test - This rule is used when the System test provisioning request is triggered.
      Add the activities in the System test rule under Configure resources in the following order.
      Sequence Predefined activity name SubResourceType RequestType
      1 FTPS IB Pull Testing v2/v3/v4 FTPSInboundPull TestRequest
      2 FTPS OB Push Testing v2/v3/v4 FTPSOutboundPush TestRequest

    For more information about creating rules, see Creating rules for an activity.

    If the rule exists in PEM Partner Provisioner, you can update the rule by configuring activities for the System subresource.

  26. Sign out of PEM Partner Provisioner.