Set up Batch

This topic describes how to set up Proficy Batch REST API.

Before you begin

Download these files from GE Salesforce.
  • Proficy Batch Execution ISO file
  • Batch REST API zip file
  • Latest Batch SIM file
Note: You also require a GE Digital Batch License Key with Batch Integration Services and Electronic Signatures for the Batch computer.

About this task

With Proficy Batch, operators can oversee batch processing using a set of batch widgets. Operator views and controls are provided in the form of Batch list, Batch control, etc. to execute batches efficiently. A sequential flow chart (SFC) widget presents a graphical view of the batch flows. For more information, refer to Proficy Batch Execution.

Procedure

  1. Log in to the machine where Operations Hub is installed.
  2. Run the ISO file to install the Proficy Batch Execution application with default settings.
    To create a Windows user account for the batch executive, provide the User name and Password details.
    After installation, Batch Execution folder is created on your desktop.
  3. Install the latest Batch SIM.
  4. Restart your machine.
  5. Unzip the BatchRestAPI file and place the folder in your C drive.
  6. From the command prompt, run the installation for BatchRestAPI service.
  7. Access the Readme file in the unzipped BatchRestAPI folder and follow the instructions for installation.
    For example,
    Country Name US
    State or Province Name Massachusetts
    Locality Name Boston
    Organization Name GE
    Organization Unit Name Digital
    Common Name Enter your server name
    Email Address [email protected]
    Enter Export Password Enter a password.

    You must modify the batch_config_rest_service.json file to reflect this password.
  8. From the unzipped BatchRestAPI folder, open batch_config_rest_service.json in a text editor. For example, Notepad.
    Refer to the BatchRestAPI Readme.txt for more details.
  9. Verify and update these parameters:
    serverCertificatePassword Enter the export password.
    basicAuthWindowsGroupValidation If true, then the Windows user (used for basic auth and for bearer token security) should be a member of the Windows user group indicated by the property basicAuthWindowsGroup. This is initially set to PROFICY_BATCH_REST_USERS. You must create this Windows group on the Batch REST Service computer, and add the corresponding Windows users to this group.

    Set this to false if you do not want to use Windows Group validation.
    basicAuthWindowsGroup PROFICY_BATCH_REST_USERS
    uaaServers Enter the URL for Operations Hub Proficy Authentication (UAA).
    Note: Only one UAA server is supported.
  10. Ensure that the Operations Hub user is also a domain user or a local Windows user on the batch computer system. Refer to Configuring Windows User Accounts on the Batch REST Service Computer.
  11. From the Batch Execution folder, launch Server Manager.
    The BatchServerManager application screen appears.
  12. Select Start Server > Cold.
    Important:
    • Use the Windows Services to start/restart the BatchRestService after you start/restart the Batch Server.
    • If BatchRestService fails to start, stop the VBIS service and try again. If it still fails, check for error messages in the logs\batch_rest_api.log file. Look for a syntax error in the batch_config_rest_service.json file, which may be responsible for the BatchRestService to not start.
    • Remember to restart BatchRestService if you make changes to the batch_config_rest_service.json file.
    • You can also start your Batch Client if you want to compare the data screens with the batch widgets.
    • After the Batch REST Service starts, it can take a minute before it is available to receive REST calls.
    For additional information on the UI screens of the batch widgets, refer to https://www.ge.com/digital/documentation/batch/Operations_Manual.pdf.
  13. From the Batch Execution folder:
    Note: You can perform this step right after installing the ISO file as well.
    1. Launch Equipment Editor and define your equipment models.
      Refer to https://www.ge.com/digital/documentation/batch/Equipment_Configuration_Manual.pdf.
      In case you modify the equipment model:
      • Make sure to validate your recipes.
      • If the Batch Server was running, you must restart the Batch Server and the Soft Phase Server.
      • If the VBIS Service was running, you should stop it. Then start/restart the Batch REST Service (this will automatically start the VBIS Service).
    2. Launch Recipe Editor and create your recipes.
      A recipe contains a series of automated steps to execute a particular batch instance. The steps may also contain prompts that request for permission to proceed ahead, and trigger alarms that need your attention.
      Refer to https://www.ge.com/digital/documentation/batch/Recipe_Development_Manual.pdf.