Setting Up the .env File

Set the required variables which varies according to the user's environment. All of these variables are required to be changed according to the user's environment.

All of these variables are in the .env file located in the $AF_HOME/docker directory.

Procedure

  1. Set the port number for which you want to start the TIBCO Fulfillment Order Management Configurator. When you want to access the Configurator UI, you use this port.
    # Port exposed for fom-configurator on docker host machine
    #
    HOST_CONFIGURATOR_PORT=8083
  2. Set the port number for which you want to start the OMS UI. When you want to access the OMS UI, you use this port.
    # Port exposed for oms ui on docker host machine
    #
    HOST_OMS_UI_PORT=8081
  3. Set the host directory path to mount a volume from the host machine to the Docker container for the TIBCO Fulfillment Order Management config directory.
    # Path till fom's config directory, this directory will
    # be mapped as a data volume inside all the docker containers
    # 
    HOST_CONFIG_DIR_PATH=<path-to-fom-config-dir-on-host>
  4. Set the path for the OMS product model, OMS product model success, and OMS product model failure directory on the host machine.
    # Path till product model, product-success and product-failure
    # directory on host machine, this directory will be used by 
    # oms at startup time and this directory will be mapped as 
    # a data volume inside oms docker containers
    #
    HOST_OMS_PRODUCT_MODEL_DIR_PATH=<path-to-oms-product-dir-on-host>
    HOST_OMS_PRODUCT_MODEL_SUCCESS_DIR_PATH=<path-to-oms-product-success-dir-on-host>
    HOST_OMS_PRODUCT_MODEL_FAILURE_DIR_PATH=<path-to-oms-product-failure-dir-on-host>
  5. Set the path for the OMS plan fragment model, OMS plan fragment success, and OMS plan fragment failure directory on the host machine.
    # Path till planfragment model, planfragment-success and 
    # planfragment-failure directory on host machine, this 
    # directory will be used by oms at startup time and this 
    # directory will be mapped as a data volume inside oms 
    # docker containers
    #
    HOST_OMS_PLANFRAGMENT_MODEL_DIR_PATH=<path-to-oms-planfragment-dir-on-host>
    HOST_OMS_PLANFRAGMENT_MODEL_SUCCESS_DIR_PATH=<path-to-oms-planfragment-success-dir-on-host>
    HOST_OMS_PLANFRAGMENT_MODEL_FAILURE_DIR_PATH=<path-to-oms-planfragment-failure-dir-on-host>
  6. Set the path for the OMS action model, OMS action success, and OMS action failure directory on the host machine.
    # Path till action model, action-success and action-failure 
    # directory on host machine, this directory will be used by 
    # oms at startup time and this directory will be mapped as 
    # a data volume inside oms docker containers
    #
    HOST_OMS_ACTION_MODEL_DIR_PATH=<path-to-oms-action-dir-on-host>
    HOST_OMS_ACTION_MODEL_SUCCESS_DIR_PATH=<path-to-oms-action-success-dir-on-host>
    HOST_OMS_ACTION_MODEL_FAILURE_DIR_PATH=<path-to-oms-action-failure-dir-on-host>
  7. Set the path for the OMS price model, OMS price success, and OMS price failure directory on the host machine.
    # Path till price model, price-success and price-failure 
    # directory on host machine, this directory will be used by 
    # oms at startup time and this directory will be mapped as 
    # a data volume inside oms docker containers
    #
    HOST_OMS_PRICE_MODEL_DIR_PATH=<path-to-oms-price-dir-on-host>
    HOST_OMS_PRICE_MODEL_SUCCESS_DIR_PATH=<path-to-oms-price-success-dir-on-host>
    HOST_OMS_PRICE_MODEL_FAILURE_DIR_PATH=<path-to-oms-price-failure-dir-on-host>
  8. Set the path for the OMS discount model, OMS discount success, and OMS discount failure directory on the host machine.
    # Path till discount model, discount-success and discount-failure 
    # directory on host machine, this directory will be used by 
    # oms at startup time and this directory will be mapped as 
    # a data volume inside oms docker containers
    #
    HOST_OMS_DISCOUNT_MODEL_DIR_PATH=<path-to-oms-discount-dir-on-host>
    HOST_OMS_DISCOUNT_MODEL_SUCCESS_DIR_PATH=<path-to-oms-discount-success-dir-on-host>
    HOST_OMS_DISCOUNT_MODEL_FAILURE_DIR_PATH=<path-to-oms-discount-failure-dir-on-host>
  9. Set the cluster member ID for the OCS server.
    # Cluster member id for ocs server
    #
    OCS_NODE_ID=Member1
  10. Set the path for the OCS segment model directory on the host machine.
    # Path till segment model directory on host machine, 
    # this directory will be used by ocs at startup time and 
    # this directory will be mapped as a data volume 
    # inside ocs docker containers
    #
    HOST_OCS_SEGMENT_MODEL_DIR_PATH=<path-to-ocs-segment-dir-on-host>
  11. Set the path for the OCS product model directory on the host machine.
    # Path till product model directory on host machine, 
    # this directory will be used by ocs at startup time and 
    # this directory will be mapped as a data volume 
    # inside ocs docker containers
    #
    HOST_OCS_PRODUCT_MODEL_DIR_PATH=<path-to-ocs-product-dir-on-host>
  12. Set the path for the log file created in Preparing Docker Volumes.
    #Location of Logfile
    HOST_LOG_ROOT_LOCATION_DIR_PATH=<path-to-logfile>

Example

Important: When you are loading models through the containerized OMS service, you must not make any changes to the paths of "Offline Catalog Configuration" in the ConfigValues_OMS.xml file.