Enterprise onboarding for the promising server

You need to run the Activator to onboard enterprises for the Promising server. The side-by-side integration is done after the Promising server and Order server are installed, and involves running a script. The process activates event handlers, event templates, and user exit implementations, and existing data are validated to ensure that no existing configurations are overwritten.

Before you begin

Notes

  • You can modify the configuration installed by the Activator only after making a copy of the configuration installed by the Activator. reserves the right to modify factory setup configuration data.
  • The enterprise activator must be run on only the OMS server, and the non-enterprise activator must be run on both the OMS server and the Promising server.
  • If an enterprise (for example, ENT) that is being onboarded to use the Promising server inherits configuration data from another enterprise, it is mandatory to override the rules of ENT’s sourcing group, as follows:
    1. Launch the Applications Manager and select the Distributed Order Management application for the ENT enterprise.
    2. From the tree in the application rules side panel, choose Cross Application > Order Promising > Sourcing And Scheduling.
    3. Right-click on Basic Configuration and choose Override Configuration.
    Note: If the Activator has already been run, by default the Availability Is Maintained Externally checkbox will be enabled.

To integrate more than one enterprise, you must run the enterprise activation script (procedure step 2) once for each enterprise code. Before executing that script the second or subsequent time, manually remove any startup files (files with the extension .xml.restart).

About this task

This procedure covers an integration done after a new installation, at a later date, or after a Sterling Order Management System Software upgrade. Integration startup files are in the /repository/factorysetup/promising_server_integration/install/ directory.

Note: When you run the Activator, the Availability Is Maintained Externally field in the Sourcing Basic Configuration window is automatically selected.

To activate the side-by-side integration:

Procedure

  1. Run the non-enterprise activation script:

    (UNIX) INSTALL_DIR/bin/sci_ant.sh -DFunctionality=PROMISING-SERVER installnonenterprise -f integration_load_defaults.xml -logfile logfile

    (Windows) INSTALL_DIR\bin\sci_ant.cmd -DFunctionality=PROMISING-SERVER installnonenterprise -f integration_load_defaults.xml -logfile logfile

  2. Run the enterprise activation script:

    (UNIX) INSTALL_DIR/bin/sci_ant.sh -DFunctionality=PROMISING-SERVER -DEnterpriseCode=<enterprise_code> -f integration_load_defaults.xml -logfile logfile

    (Windows) INSTALL_DIR\bin\sci_ant.cmd -DFunctionality=PROMISING-SERVER -DEnterpriseCode=<enterprise_code> -f integration_load_defaults.xml -logfile logfile

    where:
    enterprise_code is the code for a specific enterprise or, if no code is supplied, is DEFAULT.

    The script activates the event handlers, event templates, and user exit implementations. Existing data is also validated to ensure that no existing configurations are overwritten.
    Note: For enterprise_code, only the code for an organization that is an enterprise should be passed. Code for organizations that are not an enterprise, such as ship node, should not be passed.

    If validation fails, the script exits, and an error message is logged in the log file that specifies what could get overwritten. Search "Integration installation and configuration error messages" in this Information Center to fix any conflicting events and resolve the error.

    Optionally, you can run one of the alternate scripts, as described in the following table:
    Table 1. Alternate activation scripts
    To: Run this script: Description
    Override the validation

    (UNIX) INSTALL_DIR/bin/sci_ant.sh -DFunctionality=PROMISING-SERVER -DEnterpriseCode=<enterprise_code> -f integration_load_defaults.xml overrideinstall -logfile logfile

    (Windows) INSTALL_DIR\bin\sci_ant.cmd -DFunctionality=PROMISING-SERVER -DEnterpriseCode=<enterprise_code> -f integration_load_defaults.xml overrideinstall -logfile logfile

    where:
    enterprise_code is the code for a specific enterprise or, if not supplied, is DEFAULT.

    In this mode, if configuration is already existing, it will be overridden. For example, if the INVENTORY_CHANGE.EXTERNAL_DEMAND_CHANGE event condition is already configured for the event, no error will be thrown and the new event condition will be installed.
    Install factory defaults without overriding the validation

    (UNIX) INSTALL_DIR/bin/sci_ant.sh -DFunctionality=PROMISING-SERVER -DEnterpriseCode=<enterprise_code> -f integration_load_defaults.xml -logfile logfile

    (Windows) INSTALL_DIR\bin\sci_ant.cmd -DFunctionality=PROMISING-SERVER -DEnterpriseCode=<enterprise_code> -f integration_load_defaults.xml -logfile logfile

    where:
    enterprise_code is the code for a specific enterprise or, if a code is not supplied, is DEFAULT.

    This is the default mode. In this mode, if configuration is already existing, an error will be thrown and installation of activator data will end. For example, if the INVENTORY_CHANGE.EXTERNAL_DEMAND_CHANGE event condition is already configured for the event, the error "Event handler is already configured" will be thrown and the installation will fail.
    Install only nonconflicting activator data

    (UNIX) INSTALL_DIR/bin/sci_ant.sh -DFunctionality=PROMISING-SERVER -DEnterpriseCode=<enterprise_code> -f integration_load_defaults.xml nonconflictinginstall -logfile logfile

    (Windows) INSTALL_DIR\bin\sci_ant.cmd -DFunctionality=PROMISING-SERVER -DEnterpriseCode=<enterprise_code> -f integration_load_defaults.xml nonconflictinginstall -logfile logfile

    where:
    enterprise_code is the code for a specific enterprise or, if a code is not supplied, is DEFAULT.

    In this mode, if configuration is already existing for the activator data, no error will be thrown, no modifications will be made for that activator data, and installation will proceed to the next data to be installed. This way, only non-conflicting activator data will be installed. For example, if the INVENTORY_CHANGE.EXTERNAL_DEMAND_CHANGE event condition is already configured for the event, the installation of this activator data will be skipped without any error and the installation will proceed to the next factory setup data.
  3. Remove any startup files (files with the extension .xml.restart) from the /repository/factorysetup/promising_server_integration/install/ directory at this time. If not removed, the presence of these files interferes with integration activation for subsequent enterprise codes.
  4. Restart the application server after running the Activator.