Defining a user exit

You can configure user exit implementations.

About this task

To configure user exit implementations:

1. Open the Applications Manager and select the application that you want.
2. From the tree in the application rules side panel, choose System Administration > User Exit Management. The User Exit List window displays in the work area.

   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'. If the User Exit can be overridden by an Enterprise, the 'Can Override for Enterprise' column displays 'Y'.

3. Locate the applicable user exit and choose the Details icon. The User Exit Details window displays.

   The following three fields at the top of the screen are informational and read-only:

   • This User Exit can be overridden for Document Types
   • This User Exit can be overridden for an Enterprise
   • This User Exit Can Be Designed As a Service

     These fields reflect the options selected on the previous screen. The Inherited User Exit Implementation panel is also informational and read-only. This panel displays the list of user exits that are inherited by the current Enterprise from other Enterprises in its hierarchy. For example, consider three Enterprises, E1, E2, and E3, that have the following hierarchical relationship:

   • Enterprise E1 inherits configurations from Enterprise E2.
   • Enterprise E2 inherits configurations from the Enterprise E3.

     Because of this hierarchy, Enterprise E1 can view and override all the configurations that are defined for Enterprise E2 and E3. Enterprise E1 can also view the configurations defined at the Hub level.

     You can add values to the table in the User Exit Implementation List panel.

4. To add values to the User Exit Implementation List table, choose the Create New icon in the User Exit Implementation panel. The User Exit Implementation Details displays. Enter information into the applicable fields. Refer to Table 1 for field value descriptions.

   Table 1. User exit implementation details fields

   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. Important: Only services defined to return a real-time response can be selected. For more information about services, see Defining service definitions.
   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 version number that requires user exit backward compatibility.
   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 wait 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.