Sterling Order Management System resources

All Sterling Order Management System resources have a set of primary properties (common to all resource types) and a set of unique properties (specific to a particular type of resource).

Common primary properties are characteristics all resources have in common. For example, all resources have a Resource ID. These resources are used to define screens within the Application Console.

Note: To create new resources from the Applications Manager application, you must set the yfs.enable.resource.addition property to true in the <INSTALL_DIR>/properties/customer_overrides.properties file.

For an explanation of all primary resource information, refer to the following table.

In addition to primary information, each type of resource has unique characteristics. For information about each resource type, see the list of tables within this chapter.

Table 1. Primary information of the resource details.

Resource details primary information field value descritpions

Field Description
Resource ID Unique identifier for each resource. Each type of resource has its own Resource ID syntax convention:
  • API - <Parent Resource ID>AP<one up sequence number>. For example, the Order Console uses the getOrderList() API, whose Resource ID is orderAP2.
  • Detail View - Y<two-character module code> D<sequence number>. For example, Sterling Order Management System has a detail view Resource ID YOMD010.
  • Entity- Free form. For example, Order.
  • Icon - <Parent Resource ID>C<two-digit sequence number>. For example, YOMD010D1C02.
  • Inner Panel - <Parent Resource ID>I<two-digit sequence number>. For example, YOMDO101I01.
  • Link - <Parent Resource ID>L<two-digit sequence number>. For example, YOML010.
  • List View - Y<two-character module code> L<sequence number>. For example, YOML010.
  • Action - <Parent Resource ID>A<two-digit sequence number>. For example, YOMD010I02A01.
  • Related Entity - <Parent Entity ID>S<sequence number>. For example, OrderS01.
  • Search View - Y<two-character module code>S<sequence number>. For example, YOMS010.
Description Literal value displayed as a label on the target screen and within the Resource Hierarchy tree. This value is stored within the resource bundle.
URL For Sterling Order Management System enter the uniform resource locator of the resource.

For the Rich Client Platform applications, enter the ID of the action that the resource is associated to. This ID is the action id of the class that invokes the screen, which is defined in the plugin.xml file.

Resource Type Sets of characteristics that define a set of features on the user interface. For the Application Consoles resources, see the following:
Resource Sequence The order in which screen-related literals and logic display or executed. Resource sequencing is valid only in the context of sibling resources.
  • Related Entity - Order in which the entity's popup shows up in the search panel.
  • Search View - Order in which search views are listed in the search view popup menu.
  • Detail View - Order in which detail views are listed in the detail view popup menu.
  • List View - Order in which the list views are listed in the list view popup menu.
  • API - Order in which APIs are invoked. The sequencing is particularly important in the case of APIs, since the output of one API may be used as input to another.
  • Action - Order in which actions display in the UI.
  • Icon - Order in which icon links to other views display in the UI.