Creating a Standalone Callout BIC - EnterWorks_Process_Exchange_(EPX) - 11.0

EnterWorks Process Exchange (EPX)
Product type
Software
Portfolio
Verify
Product family
EnterWorks
Product
Precisely EnterWorks
Precisely EnterWorks > EnterWorks Process Exchange (EPX)
Precisely EnterWorks > EnterWorks
Version
11.0
Language
English
Product name
Precisely EnterWorks
Title
EnterWorks Process Exchange (EPX)
Copyright
2024
First publish date
2007
Last updated
2024-02-29
Published on
2024-02-29T08:35:54.993000

When a new Callout BIC class is created and registered, it shares the same thread pool as all other Callout BIC classes that are only registered. The Design Console will also show the double-green gear icon for each of the different registered classes. To provide the Callout BIC with its own thread pool and/or to provide a unique icon for the activity in Design Console, a Standalone Callout BIC for the class needs to be created by performing the following steps:

  1. Copy the Standalone Callout BIC Template folder from the Services Framework deployment to a temporary directory.
  2. Open a PowerShell window.
  3. Change the current directory to the copied Standalone Callout BIC Template folder.
  4. Enter the command: 
    .\GenerateBIC.ps1

    For example:

  5. Enter the name of the BIC as it is to appear in the Design Console:
  6. Enter the name of the package for the BIC:
  7. Enter the name for the BIC Class. This class can be defined in a separate JAR file or it can be added to the Standalone Callout BIC package so the BIC is self-contained. All of the Services Framework Standalone Callout BICs reside in the Services.jar file. This allows the processing code for the Callout BICs to be deployed/updated in a single file but also sets up a dependency to the Services.jar file:
  8. Enter the source directory path where the files for the BIC class will be placed. This should include all of the package fields except the last one as the final part of the path:
  9. Review the settings. If they are correct, enter "y":
  10. The script will create the directories, copy the files, and update them to reflect the settings entered:
  11. Review the files that were generated:

    Note: If the Callout BIC class is to be contained within the BIC JAR file, it will need to be copied to this directory.

  12. Edit the *.gif files to contain the desired images which must be 64x64 pixels in size. There are three images that need to be updated:
    1. valid.gif – image that is displayed when the activity is valid
    2. invalid.gif – image that is displayed when the activity has a misconfiguration. This should include the BICErrorFlag.gif image on top of the valid.gif image:

       

    3. validsp.gif – image that is displayed when the activity is a starting point. This should include the BIC Starting Point Flag.gif image on top of the valid.gif image:
    4. TIP: Use a paint program that supports layers (e.g., paint.net) so the error flag or starting point flag can be added on top of the normal image, then saved as a flattened GIF image.
    5. The Callout BIC Template folder includes the error and starting point images:
  13. Integrate the build.xml file into your existing source development. Or simply export a JAR file from your IDE for the BIC :
  14. The build.xml script expects the following environment variables to be defined (these can be renamed in the script):
    1. SERVICES_TOP – root folder of the source tree containing the new BIC
    2. SVN_TOP – root folder containing the Enterworks project, which contains JDKs, Enterworks Product and Services Framework libraries, ANT and other utilities
  15. When the Standalone Callout BIC build is run, a JAR file and config file will be placed in the dist\lib folder under the SERVICES_TOP folder. These files will need to be copied to the <drive>:\Enterworks\EPX\bin\agents\<server> folder on the EPX server to deploy the BIC. If the Callout BIC class is in a separate JAR file, it will need to be deployed as well (and identified in the EPX_Web_Wrapper.conf and DesignConsole.lax files under the <drive>:\Enterworks\EPX\bin folder). Once the files have been deployed, EPX Services must be restarted. The Design Console will show the label for the Standalone Callout BIC in the automatic activity selection list: