Setting up BOPIS deployment accelerator

Edit online

You can set up BOPIS deployment accelerator using installService script.

Before you begin

  • Download the IBM® Sterling Order Management System Developer Toolkit. Learn more....
  • Set up the IBM Sterling Order Management System runtime sandbox. Learn more...

About this task

The BOPIS deployment accelerator script installs both Hub and Organization level setup. For an Organization level setup, ensure to pass the organization code and the corresponding corporate address as input to the deploymentaccelerator.properties file. Additionally, provide all properties required by the BOPIS service to load stores in the customer_overrides.properties file.

When you run the BOPIS deployment accelerator script, an enterprise organization is created in Sterling Order Management System, and configurations are added for the organization.

Procedure

  1. Run the installService script on the BOPIS deployment accelerator JAR by running the following command from the OMS_Runtime/bin folder. The BOPIS deployment accelerator JAR is located in the OMS_Runtime/deploymentaccelerator directory.

    ./InstallService.sh OMS_Runtime/deploymentaccelerator/deploymentaccelerator.jar

    The BOPIS deployment accelerator script places all the resources, JARs, and properties in their respective directories.
  2. Navigate to OMS_Runtime/properties/deploymentaccelerator.properties.sample and rename the sample file to deploymentaccelerator.properties.
  3. Set the following properties in the deploymentaccelerator.properties file:
    • Organization.OrganizationCode - Pass the organization code of the enterprise organization.
      Note: The BOPIS deployment accelerator script calls the manageOrganizationHierarchy API to create an enterprise organization. However, if the organization is already present in Sterling Order Management System, the API is not called.
    • Organization.CorporatePersonInfo.* - Set of properties that are used for capturing the personal information and addresses of the enterprise organization.
      The sample deploymentaccelerator.properties.sample property file contains the following corporate address attributes:
      • Organization.CorporatePersonInfo.EMailID=
      • Organization.CorporatePersonInfo.DayPhone=
      • Organization.CorporatePersonInfo.ZipCode=
      Important: You must set at least one corporate address attribute.

      Additionally, you can set other address or personal information attributes such as AddressID, Company, MiddleName that is supported by Sterling Order Management System. For the list of attributes, see the CorporatePersonInfo input XML element of the manageOrganizationHierarchy API present in the Javadoc.

      The syntax for the property is Organization.CorporatePersonInfo.attribute name. For example, in the manageOrganizationHierarchy API, the City attribute refers to the name of the city in the organization's address. Pass the city name as Organization.CorporatePersonInfo.City=city name.

  4. Provide all the properties required by the BOPIS service to load stores in the customer_overrides.properties file. For more information on these properties, see Configuring properties
  5. To load all the configuration data, run the BOPIS deployment accelerator script by running the following command from the OMS_Runtime/bin folder.

    ./sci_ant.sh -f load_bopis_DeploymentAccelerator.xml