Application programming interface (API)
The API component is used to invoke the Sterling Order Management System Software System APIs or any user-written Java™ class.
To configure extended database APIs for custom and hang-off entities, see Extending the database.
Configuration properties
The following are the properties of this node:
| Property | Description |
|---|---|
| General Tab | |
| Standard Sterling Order Management System Software API | Select this option if a standard Sterling Order Management System Software API is to be invoked. If selected, a Standard Sterling Order Management System Software API Name drop down list displays. For each API, the Class Name and Method Name are provided and cannot be edited. |
| Extended API | Select this option if a custom java code is to be invoked. |
| Extended Database API | Select this option if the service invokes a custom or hang-off API. If selected, a custom API
Name drop-down list displays. For each API, the Class Name and Method Name are provided and cannot
be edited. Note: If you want to lock a record in a custom table, pass the
SelectMethod attribute as part of the input XML to the custom entity API. The
SelectMethod attribute can take the following values:WAIT, NO_WAIT, and NONE. Note: SelectMethod attribute is supported only for getAPI. Ensure that you verify the input xml of
getAPI if the SelectMethod attribute is exposed.
For more information about locking records in Extended APIs, see Customizing APIs. |
| API Name | Select or enter the API to be called. Note: This field is for integration purposes only.
|
| Class Name | Specifies the class to be called. |
| Method Name | Specifies the method to be called. |
| Requires Backward Compatibility | Select this field to indicate that input data coming through the API is from a previous version (only applicable to Sterling Order Management System Software system APIs). |
| Version | If you chose Requires Backward Compatibility, select the Sterling Order Management System Software version the API is to behave as. Only the applicable versions for the individual API display. |
| Arguments Tab | |
| Argument Name | You can pass name/value pairs to the API by entering the values
in the Arguments Tab. In order for custom APIs to
access custom values, the API should implement the interface If entered, these name/value pairs are passed to the CustomApi as a Properties object. |
| Argument Value | Enter the argument value. |
| Template Tab | |
| When the Sterling Order Management System Software System APIs are invoked, you can specify an output template to be used by the API. You can specify the template in the configuration properties of the Service Definition, the Resource Definition in the Resource Hierarchy tree, or both. However, if the template has been specified at both definition levels, the template specified in the Service Definition is used. | |
| XML Template | Select this radio button to construct the XML to be used for the API output. Enter the template root element name and click OK. You can then construct the XML. |
| File Name | Select this radio button to enter the filename of the XML file to be used as the API output template. This file should also exist in your CLASSPATH. |
| Facts Tab | |
| A Fact is an attribute that is used by an API or an agent in to identify which colony to connect to and retrieve data from. . Based on the fact name and fact value entered, the corresponding colony is determined. | |
| Fact Name | Enter the fact name of the XML attribute. |
| Fact Value | Enter the fact value of the XML attribute. |
Connection properties
The following are the API node's connection properties:
| Connection | Node Connection Rules |
|---|---|
| Can be the first node after the start node | Only for services invoked synchronously |
| Can be placed before |
|
| Can be placed after |
|
| Passes data unchanged | Yes |