Managing a base transaction's user exits

User exits are Java™ interfaces which can be implemented for creating custom logic components. Once implemented, they must be configured so that the Sterling Order Management System Software transactions can invoke them to perform the necessary logic at runtime.

About this task

To manage a base transaction's user exits:


  1. Open the Applications Manager and select an application.
    1. From the Transaction Detail window, choose the User Exits tab.

      If the user exit can be implemented for a document type, the 'Can Override For Document Types' column displays 'Y'. If the user exit can be implemented for services, the 'Can Attach Service' column displays 'Y'. If the user exit is implemented, the 'User Exit Implemented' column displays 'Y'.

      Note: The User Exit List may not display the complete list of user exits available for the transaction. To view the complete list of available user exits, use the User Exit Management Console.
  2. Locate the applicable user exit and choose the Details icon. The User Exit Details window displays.
  3. From the User Exit Implementation List table, choose the Create New icon. User Exit Implementation Details displays.
  4. Enter information into the applicable fields. Refer to Table 1 for field value descriptions.
    Table 1. User exit implementation details fields.

    User exit implementation details field value desriptions

    Field Description
    User Exit Implementation Details
    Document Type If the user exit can be implemented for a document type, select the appropriate document type, if applicable.
    Implement As A Service If the user exit can be implemented to use a service and you are configuring it as such, choose Implement As A Service.
    Implement As A Java Class If you are configuring the user exit to be implemented as a Java class, choose Implement As A Java Class.
    Service Name (if selected Implement as Service) If you selected Implement As A Service, select the applicable service to configure.
    Java Class (if selected Implement as Java Class) If you selected Implement As A Java Class, enter the Java class as it displays in the User Exit Name field.
    Requires Backward Compatibility Select this field if the user exit requires backward compatibility for another release.
    Version If you selected Requires Backward Compatibility, select the Sterling Order Management System Software version number that requires user exit backward compatibility.
    Restrict Number Of Calls If a call made to the external system through the User exit custom code hangs, the API thread, which invoked this user-exit, also hangs. Potentially this could block out all the execute threads in an App server. If checked, you can configure Calls Per JVM, Waiting Calls and Wait time.
    Pool Size Indicates total number of concurrent active calls to User Exit.
    Maximum Queue Length The maximum queue length for the number of user exit calls that are waiting to become active if the active count is filled up. If the queue is filled with calls waiting to be active, any new User Exit requests cause an error.
    Wait Time (seconds) Time for which the user exit call waits in queue. If the wait time exceeds the configured wait time, an exception is thrown.
    User Exit Implementation Notes Enter any additional information regarding user exit implementation.