Organization Processes

Manage processes associated with an organization on the API platform.

For general information on using the Process Editor, refer to:

API Platform Version: 8.4 and later

Table of Contents

  1. What is a process?
  2. How do I manage processes for my business organization on the platform?
  3. How do I add a process to an organization on the API platform?
  4. How do I view processes for an organization on the API platform?
  5. How do I modify a process associated with an organization on the API platform?
  6. How do I move a process from one organization to another?
  7. How do I delete a process associated with an organization on the API platform?
  8. What roles can manage processes for my business organization on the platform?
  9. Related Topics

What is a process?

A process is an ordered group of activities that can be performed by an API Gateway that supports the virtualization capability. The logic performed in a virtual service operation is defined as a process. When a message is received by the container, once the virtual service operation is identified, its process is executed. As determined by the activities in the process, down-stream services might be invoked. When the process is complete, a response to the original message is generated.

In Policy Manager, the Add Process Wizard allows you to define a library of reusable processes with common activities. For example, you might define a process to retrieve user information based on an account number, or to build a custom form.

In the developer portal, you can define a custom process:

Using the Process Palette, you can:

  • Define the sequence of messages as they flow through for each virtual service operation.
  • Configure a variety of different types of activities, each represented by a separate icon in the Process Palette user interface, for achieving the results required for each operation.

How do I manage processes for my business organization on the platform?

The API platform allows you to manage the processes that are available for your business organization. You can:

All the processes available for your business organization are available for all child organizations also.

Back to top

How do I add a process for my organization?

There are two steps to adding a process:

  • Define the basic information about the process, such as name, description, and process type: see To add a process below.
  • Configure the process to define what it actually does: see To configure a process below.
To add a process
  1. In the Developer Portal, go to the Organizations List (see To access the Organizations List).
  2. Find your organization on the list, and then click the title to view the Details page for the organization.
  3. On the left navigation bar, choose Processes. All processes associated with the organization are displayed.
  4. Click Add.
  5. In the Add Process page, specify:
    • Process Name: A short, descriptive name for the process; for example, Get-User-Info-For-AccountNo or Build-Custom-Form-Request. Used on the process summary page.
    • Process Description: A brief description of the process. Include any key information relating to how the process is used and what it does.
  6. Click Save. The process is added to the list of processes for the organization.
To configure a process
  1. First, add the process; see To add a process above.
  2. Find the process on the list and click the title to access the process details.
  3. Click Edit Process. The Process Editor appears. Here, you can use all the features of the Process Editor to build the process you want. For more information on using the Process Editor, see How do I use the Process Editor?
  4. When done, click Finish.

Back to top

How do I view processes for an organization on the API platform?

If you're a Business Admin, you have full rights to add, view, edit, or delete processes that are set up for your organization.

To view processes for a business organization
  1. In the Developer Portal, go to the Organizations List (see To access the Organizations List).
  2. Find your organization on the list, and then click the title to view the Details page for the organization.
  3. In the left menu, click Processes. All processes associated with the organization are displayed. An example is shown below.

    Processes List

  4. To view details of a specific process, click the link in the title.

Back to top

How do I modify a process associated with an organization on the API platform?

If you're a Business Admin, you have full rights to add, view, edit, or delete processes that are set up for your organization.

To modify a process associated with a business organization
  1. In the Developer Portal, go to the Organizations List (see To access the Organizations List).
  2. Find your organization on the list, and then click the title to view the Details page for the organization.
  3. In the left menu, click Processes. All processes associated with the organization are displayed.
  4. Find the process on the list, and click the link in the title. The Details page for the process is displayed, as shown below.

    Process Details page

  5. You can edit in two ways:
    • To edit the process name and description, click Edit.
    • to edit the process details, click Edit Process (as shown above) to access the Process Editor, make the changes, and then, in the Process Editor, click Finish. For more information on using the Process Editor, see How do I use the Process Editor?

Back to top

How do I move a process from one organization to another?

You can move a process that's in the context of one of your business organizations into another organization, as long as you are a Business Admin for both organizations. For example, you might have created the process in the context of a child organization by mistake. You can easily move it to the parent organization. Follow the steps below.

To move a process from one business organization to another
  1. In the Developer Portal, go to the Organizations List (see To access the Organizations List).
  2. Find the organization that the process currently exists under, and then click the title to view the Details page for the organization.
  3. On the left navigation bar, choose Processes. All processes associated with the organization are displayed.
  4. Find the process that you want to move, and then click the title to view the Details page for the process.
  5. In the top section, click Edit.
  6. In the Organization Name field, start typing the name of the organization you want to move it to. After the first three characters, the platform displays a list of matching organizations for you to choose from.
  7. Click the entry for the new organization so that the full name is displayed in the field.
  8. Click Save. The process is moved to the new organization.

Back to top

How do I delete a process associated with an organization on the API platform?

If you're a Business Admin, you have full rights to add, view, edit, or delete processes that are set up for your organization.

To delete a process associated with a business organization
  1. In the Developer Portal, go to the Organizations List (see To access the Organizations List).
  2. Find your organization on the list, and then click the title to view the Details page for the organization.
  3. In the left menu, click Processes. All process associated with the organization are displayed.
  4. Find the process on the list, and click the link in the title. The Details page for the process is displayed.
  5. Click Delete.
  6. At the confirmation prompt, click OK. The process is deleted.

Back to top

What roles can manage processes for my business organization on the platform?

The Business Admin has full responsibility for all processes, created at the organization level. The API Admin can create and manage processes at the API level, but only the Business Admin can manage processes for the organization.

Back to top