Partner_SFG_Onboard_V1
Partner_SFG_Onboard_V1 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, FTP, FTPS, or SFTP protocols.
- Configuration of FTP, FTPS, 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.
- Configure code lists or insert routing information into custom tables utilizing an API.
- Set up routing channels for file processing in IBM Sterling File Gateway, allowing for self-testing and code promotion to a higher environment.
To configure context data for Partner_SFG_Onboard_V1, log in to the PEM Portal as a System Administrator and set the following values:
| Context Data | Context Data Parameter | User Action | Description | |
|---|---|---|---|---|
| applications | QA_B2BISFG | Assign configured API endpoint for non- production IBM Sterling B2BIntegrator. | Context parameter for IBM Sterling B2B Integrator API endpoint in non-production environment. | |
| Prod_B2BISFG | Assign configured endpoint for production environment IBM Sterling B2BIntegrator. | Context parameter for IBM Sterling B2B Integrator API endpoint in production environment. | ||
| QA_CM | Assign configured API endpoint for non- production Partner Community Manager (PCM). | Context parameter for non-production PCM API configuration. | ||
| Prod_CM | Assign configured API endpoint for Partner Community Manager (PCM) in production environment. | Context parameter for PCM API configuration in production environment. | ||
| PEM | Assign configured IBM PEM API endpoint. | IBM PEM API configuration parameter. This parameter is applicable only if the IBM PEM API Gateway is used. |
||
| PR | Assign configured API endpoint for Partner Repository (PR) APIs. | Partner Repository API configuration parameter. | ||
| QA_B2BISFGHTTP | Assign configured non-production IBM Sterling B2B Integrator HTTP adapter. | IBM Sterling B2B Integrator non-production HTTP adapter API configuration context parameter. | ||
| Prod_B2BISFGHTTP | Assign configured production IBM Sterling B2B Integrator HTTP adapter. | IBM Sterling B2B Integrator production HTTP adapter API configuration context parameter. | ||
| SponsorConfigurations | AS2 | Assign configured AS2 profile configuration key | AS2configuration key in Partner Repository. This parameter is applicable only if the AS2 protocol 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 configured SFTP profile configuration key 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 key. | FTP profile configuration key. This parameter is applicable only if the FTP protocol is used. |
||
| FTPS | Assign configured FTPS inbound push profile 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. |
||
| NativePGP | Provide Boolean value: true or false. | |||
| NonProd_Customer_IPs → Inbound | Provide the Non Production Inbound IPs of Sponsor. | Customers Non Production Network IPs. | ||
| NonProd_Customer_IPs → Outbound | Provide the Non Production Outbound IPs of Sponsor. | Customers Non Production Network IPs. | ||
| Prod_Customer_IPs → Inbound | Provide the Production Inbound IPs of Sponsor. | Customers Non Production Network IPs. | ||
| Prod_Customer_IPs → Outbound | Provide the Production Outbound IPs of Sponsor. | Customers Non Production Network IPs. | ||
| CustomProtocols → Protocol Note: You can either use normal protocol or custom protocol. For example, you can have either FTP or Custom FTP. You cannot have both.
|
Assign configured CustomProtocol profile configuration key in PEM Partner Repository. | CustomProtocol profile configuration key. This parameter is applicable only if the CustomProtocol protocol is used. |
||
| CustomProtocols → name | Assign the name of the Custom Protocol. | Custom Protocol Name, as is configured in AFT Extension File in IBM Sterling File Gateway. | ||
| CustomProtocols → value | Assign the protocol of the Custom Protocol. | Protocol for which it is customized. This value will be visible to the Partner. | ||
| CustomProtocols → bp | Assign the business process configured for the Custom Protocol. | Business Process which is configured for Custom Protocol in IBM Sterling File Gateway AFT Extension File. | ||
| UserAccount → AuthenticationType | Provide the Authentication Type of the account (Local, External) | |||
| 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) false if not. |
|||
| FileRoute | Select value of TRUE if routing flow is through PCM. | Parameter indicating whether or not files are routed through PCM. | ||
| SFG_Community | Assign community name from IBM Sterling File Gateway | IBM Sterling File Gateway community name. On-boarded partner is associated with a community in Sterling File Gateway based on the value assigned. | ||
| codelist | Assign non-production code list name from IBM Sterling B2BIntegrator | Non-production code list name to which file types are stored. | ||
| codelistVersion | Assign non-production code list version from IB Sterling B2BIntegrator | Non-production code list version. | ||
| codelistVersion_PCM | Assign non-production PCM code list version from IBM Sterling B2B Integrator | Non-production PCM code list version. | ||
| prod_codelist | Assign production code list name from IBM Sterling B2BIntegrator | Production code list to which file types are stored. | ||
| prod_codelistVersion | Assign production code list version from IBM Sterling B2BIntegrator | Context parameter for production code list version. Example: %7C%7C%7C(version. number}. |
||
| prod_codelistVersion_ PCM | Assign production code list version for PCM from IBM Sterling B2B Integrator | Context parameter for production PCM code list version. Example: |||{version number}. |
||
| Inbound_Envelope_X12 | 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 SFG_PredefinedActivities.zip. Extract the file and locate it under the following path: PEM/EnvelopeTemplates. |
InboundX12 envelope template (*.CSV file). | ||
| Outbound_Envelope_X12 | 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 SFG_PredefinedActivities.zip. Extract the file and locate it under the following path: PEM/Envelope Templates. |
OutboundX12 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 SFG_PredefinedActivities.zip. Extract the file and locate it under the following path: PEM/EnvelopeTemplates. |
InboundEDIFACT envelope template (*.CSV file). | ||
| Outbound_Envelope_EDIFACT | Upload production version of outbound envelope template from Library section. This file is available for selection under context data mapping. The file is provided inside a zip file named SFG_PredefinedActivities.zip. Extract the file and locate it under the following path: PEM/EnvelopeTemplates. |
OutboundEDIFACT envelope template (*.CSV file). | ||
| Sterling Secure Proxy (SSP) Note: This feature is supported for SSP version 3.4.3 and above.
|
Enable | If SSP is used, 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. | |
| 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. | ||
| FTPS_Netmap | Enter the netmap name which is configured for FTPS protocol in the SSP server. | Defines netmap name under which the nodes are created for FTPS partners. | ||
| SFTP_Netmap | Enter the netmap name which is configured for SFTP protocol in the SSP server. | Defines netmap name under which the nodes are created for SFTP partners. | ||
| HTTP_Netmap | Enter the netmap name which is configured for HTTP protocol inthe SSP server. | Defines netmap name under which the nodes are created for HTTP partners. | ||
| HTTPS_Netmap | Enter the netmap name which is configured for HTTPS protocol in the SSP server. | Defines netmap name under which the nodes are created for HTTPS partners. | ||
| Sterling Secure Proxy (SSP) | CD_Netmap | Enter the netmap name which is configured for CD protocol in the SSP server. | Defines netmap name under which the nodes are created for CD 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 if all partners use the 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 trueelse enter false. | This parameter is used to enable or disable client authentication. Note: This parameter is applicable only in case HTTPS or FTPS used.
|
||
| Scripts | Server | Provide IP address of non-production server on which scripts are executed. | IP address of non-production server on which scripts are located. | |
| Prod_Server | Provide IP address of production server on which scripts are executed. | IP address of production server on which scripts are located. | ||
| User | Provide user login name for production server | User login name for production server. | ||
| Port | Provide the port number for the server on which custom scripts are executed. | Port number for the server on which custom scripts are executed. | ||
| FileDrop | Provide the folder path for staging files from IBM PEM Standard. | Location in which APIs are to place files. | ||
| PGP | Provide folder location on host system in which PGP scripts are deployed. | Location of PGP script files. | ||
| localFile | Set value to TRUE. | This parameter identifies if Community Manager is running on a docker. | ||
| pemKey | Set value to TRUE if the server on which scripts are executed; uses key-based authentication. | Parameter used to identify authentication type. | ||
| password | Provide the server password. | Server password. Applicable when password authentication is used on the server. | ||