Partner_Onboard_V1
Partner_Onboard provides the following capabilities:
- Self-service capabilities for trading partners, business users, and IT teams to collaborate and automate the onboarding of trading partners to the B2Bi or MFT platforms.
- The ability to set up trading partners using AS2, ConnectDirect, S3, FTP, FTPS, or SFTP protocols.
- Configuration of FTP, FTPS, S3, AS2, ConnectDirect and SFTP protocols to either push/pull files to and from partners' servers, or provide the capability for partners to push/pull files to and from the sponsor.
- Capability to set up processing data flows in PCM for self-certification and code promotion to a higher environment.
To configure context data for the Partner_Onboard activity, sign in to PEM Portal as Sponsor Administrator:
| Context Data | Context Data Parameter | User Action | Description | |||
|---|---|---|---|---|---|---|
| applications | QA_B2BISFG | Assign the configured API endpoint for non-production IBM Sterling B2B Integrator. | Context data parameter for IBM Sterling B2B Integrator – B2B API non-production API configuration. | |||
| Prod_B2BISFG | Assign the configured API endpoint for the production IBM Sterling B2B Integrator. | Context data parameter for IBM Sterling B2B Integrator – B2B API production API configuration. | ||||
| QA_CM | Assign the configured API endpoint for non-production PCM. | Context data parameter for PCM non-production API configuration. | ||||
| Prod_CM | Assign the configured API endpoint for production PCM. | PCM production API configuration. | ||||
| PEM | Assign the configured IBM PEM API endpoint. | PEM API configuration parameter. This parameter is applicable only if the IBM PEM API gateway is used. |
||||
| PR | Assign the configured API endpoint for Partner Repository (PR) APIs. | PR API configuration parameter. | ||||
| QA_B2BISFGHTTP | Assign the configured non-production IBM Sterling B2B Integrator HTTP server adapter. | Context data parameter for IBM Sterling B2B Integrator non-production HTTP server API configuration. | ||||
| Prod_B2BISFGHTTP | Assign the configured production IBM Sterling B2B Integrator HTTP server adapter. | Context data parameter for IBM Sterling B2B Integrator production HTTP server adapter. | ||||
| SponsorConfigurations | AS2 | Assign configured AS2 profile configuration key. | PEM Partner Repository AS2key configuration. This parameter is applicable only if the AS2protocol is used. | |||
| CD | Assign configured ConnectDirect profile configuration key. | ConnectDirect profile configuration key. This parameter is applicable only if the ConnectDirect protocol is used. | ||||
| SFTP | Assign SFTP profile configuration key configured in PEM Partner Repository. | SFTP profile configuration key. This parameter is applicable only if the SFTP protocol is used. | ||||
| FTP | Assign configured FTP inbound push profile configuration key. | FTP profile configuration key. This parameter is applicable only if the FTP protocol is used. | ||||
| FTPS | Assign the configured FTPS inbound push profile configuration key. | FTPS profile configuration key. This parameter is applicable only if the FTPS protocol is used. |
||||
| PGP | Assign the configured PGP KEY profile configuration key. | PGP KEY profile configuration key. This parameter is applicable only if the PGP is used. |
||||
| S3 | Assign the configured S3 profile configuration key: S3 Profile Configuration Key. | This parameter is applicable if the S3 protocol is used. | ||||
| NonProd_Customer_IPs → Inboun | Provide the Non Production Inbound IPs of Sponsor. | |||||
| NonProd_Customer_IPs → Outbound | Provide the Non Production Outbound IPs of Sponsor. | |||||
| Prod_Customer_IPs → Inbound | Provide the Production Inbound IPs of Sponsor. | |||||
| Prod_Customer_IPs → Outbound | Provide the Production Outbound IPs of Sponsor. | |||||
| NativePGP | Provide Boolean value either (true or false). | |||||
| UserAccount → AuthenticationType | Provide the Authentication Type of the account (INTERNAL, EXTERNAL, BOTH). | |||||
| UserAccount → AuthenticationHost | Provide the Authentication Host configured in IBM Sterling B2B Integrator. | |||||
| UserAccount → LDAPProvisioningEnabled | True, if LDAP Provision is enabled (https://www.ibm.com/docs/en/partnerengagemanager?topic=apis-ldap-script-configuration-information) and false if not. | |||||
| S3 → S3_Polling_OnArrival | Provide boolean value: true or false. If true, it uses the SQS Adapter, if false, it uses S3 Adapter. | |||||
| FTPS_Cert | Assign the configured FTPS inbound push profile configuration key | FTPS profile configuration key. This parameter is applicable only if the FTPS protocol is used. | ||||
| Inbound_Envelope_X12 |
Upload production Inbound envelope template from the Library section. This file is available under context mapping data for selection. The file is provided inside a zip file named B2Bi_PredefinedActivities.zip. Extract the file and locate it under the following path: PEM/EnvelopeTemplates |
Inbound envelope template CSV file. | ||||
| Outbound_Envelope_X12 |
Upload production outbound envelope from the Library section. This file is available under context data mapping for selection. The file is provided inside a zip file named. B2Bi_PredefinedActivities.zip. Extract the file and locate it under the following path: PEM/EnvelopeTemplates. |
Outbound envelope template CSV file. | ||||
| Inbound_Envelope_EDIFACT |
Upload production version of inbound envelope template from Library section. This file is available for selection under context data mapping. The file is provided inside a zip file named. B2Bi_PredefinedActivities.zip. Extract the file and locate it under the following path: PEM/EnvelopeTemplates |
Inbound EDIFACT envelope template CSV file. | ||||
| Outbound_Envelope_EDIFACT |
Upload production version of outbound envelope template from Librarysection. This file is available for selection under context data mapping. The file is provided inside a zip file named B2Bi_PredefinedActivitie Extract the file and locate it under the following path: PEM/EnvelopeTemplates. |
Outbound EDIFACT envelope template CSV file. | ||||
| Sterling Secure Proxy (SSP) Note: This feature is supported for SSP` version 3.4.3and above.
|
Enable | If using SSP, then enter true else enter false. | SSP is an additional layer which helps in enhanced security. This parameter is used to enable or disable SSP. | |||
| Sterling Secure Proxy (SSP) | FTP_Netmap | Enter the netmap name which is configured for FTP protocol in the SSP server. | Defines netmap name under which the nodes are created for FTP partners. | |||
| FTP_Policy | Enter the policy name which is configured for FTP protocol in the SSP server. | Defines the policy under which the nodes are created for FTP partners. This parameter is not mandatory for defining in case all partners use same policy configured in SSP. |
||||
| FTPS_Policy | Enter the policy name which is configured for FTPS protocol in the SSP server. | Defines the policy under which the nodes are created for FTPS partners. This parameter is not mandatory for defining in case all partners use same policy configured in SSP. |
||||
| SFTP_Policy | Enter the policy name which is configured for SFTP protocol in the SSP server. | Defines the policy under which the nodes are created for SFTP partners. This parameter is not mandatory for defining in case all partners use same policy configured in SSP. |
||||
| HTTP _Policy | Enter the policy name which is configured for HTTP protocol in the SSP server. | Defines the policy under which the nodes are created for HTTP partners. This parameter is not mandatory for defining in case all partners use same policy configured in SSP. |
||||
| HTTPS_Policy | Enter the policy name which is configured for HTTPS protocol in the SSP server. | Defines the policy under which the nodes are created for HTTPS partners. This parameter is not mandatory for defining in case all partners use same policy configured in SSP. |
||||
| CD_Policy | Enter the policy name which is configured for CD protocol in the SSP server. | Defines the policy under which the nodes are created for CD partners. This parameter is not mandatory for defining in case all partners use same policy configured in SSP. |
||||
| ClientAuthentication | If using client authentication,enter true else enter false. | This parameter is used to enable or disable client authentication. Note: This parameter is applicable only in case HTTPS or FTPS used.
|
||||
| SecuritySetting | Enter the security setting which are available in the SSP. Note: To know the available security settings, log into SSP.
|
Defines the security setting which has to be used during the note creation. Note: This parameter is applicable only in case HTTPS or FTPS used.
|
||||
| KeyStore | Provide the system certificate store which is configured in the SSP. Note: To know the list of available system certificate store, log into SSP and click the credentials.
On the navigation pane, click Certificate Store > SystemCertificate Store. |
Defines the keystore from which the system certification is used. | ||||
| Truststore | Provide the system certificate which is available under system certificate store. | Defines the keystore from which the system certification is used. | ||||
| Cipher | Provide the system certificate which is available under system certificate store. | Defines the keystore from which the system certification is used. | ||||
| SystemCert | Provide the system certificate which is available under system certificate store. | This parameter is used to define the key store from which the system certification is used. | ||||
| Scripts | Server | Provide IP of non-production server on which scripts are executed. | Provide IP of non-production server on which scripts are executed | |||
| Prod_Server | Provide IP of production server on which scripts are executed. | Provide IP of production server on which scripts are executed. | ||||
| User | Provide the user ID for logging in to the server on which custom scripts are executed. | Provide the user ID for logging in to the server on which custom scripts are executed. | ||||
| Port | Provide the port number for the server on which custom scripts are executed. | Provide the port number for the server on which custom scripts are executed. | ||||
| FileDrop | Provide the folder path for staging files from IBM PEM Standard. | Provide the folder path for staging files from IBM PEM Standard. | ||||
| PGP | Provide folder location on host system in which PGP scripts are deployed. | Provide folder location on host system in which PGP scripts are deployed. | ||||
| localFile | Set value to TRUE. | Set value to TRUE. | ||||
| pemKey | Set value to TRUE if the server on which scripts are executed uses key-based authentication. | Set value to TRUE if the server on which scripts are executed uses key-based authentication. | ||||
| password | Provide server password. | Provide server password. | ||||