Introduction to Categories

In the categories section of an adapter definition document, you can categorize actions and triggers, so that it becomes easier to choose the required actions or triggers while configuring an adapter in Oracle Integration.

While modeling an adapter's capabilities, you may have to define a large number of actions and triggers depending on the requirements. As actions and triggers appear in a drop-down list in the design-time user interface of Oracle Integration, it becomes difficult to choose the required value from a long list.

Using the Rapid Adapter Builder, you can categorize actions and triggers, so that the number of items in an actions or triggers drop-down list are reduced and easy to view.

For example, if you are building an adapter for an application with multiple modules (like CRM, Financials, ERP, and HCM), you may have to define several actions for each module. In this case, you can define each module as a category.

Here's a code snippet for this example scenario:

"categories": {
        "displayName": "Select Module",
        "description": "Enter Module to filter.",
        "groups": [
            {
                "name": "crm",
                "displayName": "CRM",
                "description": "Customer Relationship Management"
            },
            {
                "name": "financials",
                "displayName": "Financials",
                "description": "Financials"
            },
            {
                "name": "erp",
                "displayName": "ERP",
                "description": "Enterprise Resource Planning"
            },
            {
                "name": "hcm",
                "displayName": "HCM",
                "description": "Human Capital Management"
            }

You can then associate an action or trigger with one of the groups defined in the categories section of the adapter definition document.

The following code snippet shows how to associate an action with a group defined earlier:

"actions": {
    "createEmployee": {
        "description": "Create Employee",
        "displayName": "Create Employee in HCM system",
        "group": "hcm",
        "execute": "flow:createEmployeeInHCM",

Note:

Categorization of actions and triggers using the category and group mechanism is optional.