ITXA Container Integration with Sterling B2B Integrator
Pre-requisites
- Sterling B2B Integrator and ITXA should be deployed in the same namespace or project.
- For IXTA integration, you need to download images from the entitlement registry.
- For SSO for ITXA from Sterling B2B Integrator, the host name for ASI and the ITXA UI server should be the same. Finalize the host name that can be used by both. Also, you need to set a few additional properties in config/
customer_overrides.properties
file inside the ITXA Helm chart, and one such property isHostApplication.restURL
.TheHostApplication.restURL
property must be as follows:server = '<B2BI ReleaseName>-b2bi-asi-frontend-svc'
port = '.Values.asi.frontendService.ports.restHttpAdapter.port'
from Sterling B2B Integratorvalues.yaml
file.
Considerations
Once ITXA integration is disabled, the Sterling B2B Integration services for ITXA will not be removed, and they will keep appearing in the service configuration on the Sterling B2B Integrator dashboard. This will not have any impact on the functioning of Sterling B2B Integrator.
Integration Process Overview
- Create required PVs, secrets for ITXA installation and other artifacts (only if ITXA integration is required).
- Modify
customer_overrides.properties
in the ITXA Helm chart for ITXA-SI integration. For more information, see Integrating ITXA with Sterling B2B Integrator. - Install the ITXA Helm charts to create ITXA UI and DB pods.
- Configure Sterling B2B Integrator values.yaml to enable ITXA integration flag.
- Confirm datasetup configuration is enabled for ITXA in Sterling B2B Integrator values.yaml.
- Reuse the same ITXA PVs and secrets that you used with ITXA Helm charts and refer them in Sterling B2B Integrator values.yaml.
- Install Sterling B2B Integrator Helm charts.
- If the customer_overrides.properties file from ITXA-SI integration is not updated before, then it can be updated now and then perform helm upgrade for ITXA.
- See Integrating ITXA with Sterling B2B Integrator for a complete installation guide.
Integrating ITXA with Sterling B2B Integrator
- Install ITXA Helm charts.
- The following parameters are added in Sterling B2B Integrator values.yaml:
integrations: seasIntegration: isEnabled: false seasVersion: "1.0" itxaIntegration: enabled: false dataSetup: enabled: true image: repository: "cp.icr.io/cp/ibm-itxa-runtime" tag: "10.0.1.8" digest: pullPolicy: IfNotPresent pullSecret: appSecret: "itxa-oracle-secrets" secureDBConnection: enabled: false dbservercertsecretname: "" persistence: claims: name: itxa-logs-pvc sso: host: "speui.apps.openshift.in.dev" port: 443 ssl: enabled: true resourcesInit: enabled: true image: repository: "cp.icr.io/cp/ibm-itxa-resources" tag: "10.0.1.8" digest: pullPolicy: "IfNotPresent"
- Enable ITXA integration with Sterling B2B Integrator by updating the properties below in values.yaml file in the Sterling B2B Integrator Helm charts.
itxaIntegration: enabled: true
- Enable datasetup one time, perform Helm install or upgrade, and then set the datasetup property to false.Note: You need to have required services created in Sterling B2B Integrator, such as SPE Enveloping Service, SPE De-enveloping Service, etc., and this is required to function the integration properly.
itxaIntegration: enabled: true dataSetup: enabled: true
- Add respective image details like repository, tag, digest, pullPolicy, and pullSecret for the
itxaIntegration
section in values.yaml.Note: For the ITXA 10.0.1.8 release, refer the repository to cp.icr.io/cp/ibm-itxa/itxa-runtime and tag to 10.0.1.8-x86_64. - Specify the database secret along with optional SSL details. The
appSecret
specified below should be the same as mentioned in ITXA values.yaml file.appSecret: "itxa-oracle-secrets" secureDBConnection: enabled: false dbservercertsecretname:""
- Specify the same persistence claim name from ITXA values.yaml in Sterling B2B Integrator values.yaml file as shown below.
persistence: claims: name: itxa-nfs-claim
- Configure the following properties for SSO from Sterling B2B Integrator to ITXA UI. This is the ITXA UI host and port.
sso: host: "speui.ocp.in.dev" port: "443" ssl: enabled: true
Note: The host specified for the ITXA UI server should match the host name specified for ASI in Sterling B2B Integrator Helm charts. - To make ITXA SSO work, follow these steps:Modify the
config/customer_overrides.properties
file in ITXA Helm charts and add the following configuration.HostApplication.name=SBI HostApplication.migrationStylesheet=ie_si_to_spe_hosted HostApplication.driverName=InvokeSIBP HostApplication.driverClass=com.ibm.spe.core.drivers.DriverInvokeSIBusinessProcess HostApplication.restURL=https://b2bidemo-b2bi-asi-frontend-svc:31007/restwar/restapi/v1.0
Note: Set theHostApplication.restURL
as follows:'server' set to '<SI ReleaseName>-b2bi-asi-frontend-svc' & 'port' to value of '.Values.asi.frontendService.ports.restHttpAdapter.port' from Sterling B2B Integrator values.yaml file
After this change, do the ITXA Helm chart upgrade.
Upgrading Integrated ITXA with Sterling B2B Integrator
- Follow the ReadMe.md file in ITXA Helm charts to upgrade ITXA from 10.0.1.8 to 10.0.1.9.
- Upgrade Sterling B2B Integrator by enabling the integrations sections in values.yaml for ITX with versions 10.1.2.0.20231130 and ITXA - 10.0.1.9-x86_64 and later. Run the Sterling B2B Integrator upgrade as Upgrading Sterling B2B Integrator using Certified Containers.
Disabling ITXA Integration with Sterling B2B Integrator
itxaIntegration:
enabled: false
Validating ITXA integration with Sterling B2B Integrator
- If the ITXA helm charts are not deployed before ITXA is integrated with Sterling B2B Integrator by enabling the
itxaIntegration.enabled
flag in values.yaml file to true, then Helm chart installation or upgrade for Sterling B2B Integrator will fail.Resolution: Deploy ITXA Helm charts before
itxaIntegration.enabled
flag is set to true, and before Helm install or upgrade is performed for Sterling B2B Integrator Helm charts. - When the ITXA integration is enabled, the Sterling B2B Integrator ASI or AC pods are not starting.
Resolution: Make sure that the
itxaIntegration.dataSetup.enabled
flag is set to true for ITXA in Sterling B2B Integrator values.yaml file before Sterling B2B Integrator Helm installation or upgrade. - Post ITXA integration, the below services should be available in the services configuration in the Sterling B2B Integrator dashboard, and they should be in the enabled state.
SPE Check Pending Ack Status Service
SPE De-enveloping Service
SPE Enveloping Service
SPE Transformation Service
If these services are not visible, then make sure that the
itxaIntegration.dataSetup.enabled
flag is set to true for ITXA in values.yaml file before Sterling B2B Integrator Helm installation or upgrade. - SSO for ITXA from Sterling B2B Integrator dashboard is not workingResolution: Make sure the hostname used for ASI and ITXA UI pod is same. Also, the ITXA Helm charts
config/customer_overrides.properties
file has the below properties added with the required details, and Helm install or upgrade is performed with ITXA Helm charts.HostApplication.name=SBI HostApplication.migrationStylesheet=ie_si_to_spe_hosted HostApplication.driverName=InvokeSIBP HostApplication.driverClass=com.ibm.spe.core.drivers.DriverInvokeSIBusinessProcess HostApplication.restURL=https://b2bidemo-b2bi-asi-frontend-svc:31007/restwar/restapi/v1.0
Note: Set theHostApplication.restURL
as follows:Server set to
<SI ReleaseName>-b2bi-asi-frontend-sv
.Port to value of
.Values.asi.frontendService.ports.restHttpAdapter.port
. - The ITXA UI server should have hosted mode set to Sterling B2B Integrator, i.e., IBM Standards Processing Engine (Hosted Mode Sterling B2B Integrator).
In case this is not visible, then check if ITXA Helm charts
config/customer_overrides.properties
has the required properties used. - From the ITXA UI, you should be able to browse the list of business processes from the envelope screen (under Business Process List option).
In case this is not visible, then check if ITXA Helm charts
config/customer_overrides.properties
has the required properties used. - Check if respective properties files for ITXA are updated with required relative paths and variables (examples are
SPEHostingApplication.properties
,SPE.properties
, etc.).
Logs on console
If enableAppLogOnConsole
is enabled in values.yaml, then logs generated for ITXA will be redirected to the console.
Limitations
In Sterling B2B Integrator v6.2.0.0, ITXA samples cannot be run from an ASI or AC pod.
Running ITXA samples from ASI pod
sed: can't read /opt/runtime/restapi/tx-rest.properties: No such file or directory
sed: can't read /opt/runtime/restapi/docker/tx-rest.properties: No such file or directory