Creating and Managing Taxonomies
You've landed on a page for a deprecated version of the Anypoint Platform for APIs. If you are currently using this version, please migrate to the current version of the platform.
As an API Manager administrator (i.e. organization owner), you can create custom taxonomies to apply to services and consumers registered in the repository. Using these custom taxonomies, you can organize SOA assets according to multiple logical hierarchies simultaneously. Leverage this flexible and easy-to-manage tool to categorize your services and consumers according to the specific structures that make the most sense for your business.
Example taxonomy based on region:
Example taxonomy based on academic departments:
Advantages of Using Taxonomies
With custom taxonomies in API Manager, your organization reaps several benefits.
- All users in your organization work within the same predefined logical hierarchy – no more missing relevant content due to varying terminology in tags or other categorization protocols.
- Services and consumers categorized by taxonomies are easy to find using the taxonomies page. Navigate to a taxonomy node of interest and immediately see a list of services and consumers with that taxonomic classification.
- Taxonomies facilitate batch management of SOA assets. For example, imagine that your company creates a new mandate that requires all services used by Human Resources to be protected by HTTP basic authentication. If you've created a taxonomy in the registry to organize services by department, you can navigate to Department > Human Resources and immediately see a list of relevant services to which you must apply the new policy.
Creating Taxonomies (Admin Only)
As an administrator, complete the following procedure to create a new custom taxonomy.
- Click the Administration icon in the top navigation bar, then click Taxonomies.
- Click the pencil icon under the Taxonomies heading to open the Manage Taxonomies window.
- Give your new taxonomy a name that describes the categorization. For example, common taxonomy names may include:
- Business Unit
- Business Function
- Click Add Taxonomy, then click Close. Your new taxonomy now appears in the column at the far left of page, among the other taxonomies previously defined (if any.)
- Click the name of the taxonomy you have just created. A new column appears to the right with an edit icon (pencil) in the top right corner of the column.
- Click the edit icon to open the Manage Taxonomy Nodes panel. Nodes represent the child taxonomies of the parent taxonomy you just created. For example, America and South America are nodes of the parent taxonomy, Region.
- Enter a name for the node, then click Add Taxonomy Node. Repeat this step until you have defined all the nodes that you need at this level, then click Close.
- All the nodes that you have defined now appear in the second column (see image below). Note that nodes are listed in alphabetical order. The first four are shown in the column immediately to the right of your taxonomy names; additional nodes can be seen by scrolling down.
- Click on any of the nodes to open a third column with an edit icon (see image below).
- You can continue to add node levels in this manner until you have defined all the levels necessary for your custom taxonomy. Your taxonomy may need only one node level, or it may need many.
Administrators can add new taxonomies at any time, delete existing taxonomies or individual taxonomy nodes using the edit icons. Note that you cannot delete a node that is actively applied to a service or consumer. The taxonomy must first be removed from that service or consumer main screen before it can be deleted on the taxonomies page.
After defining the taxonomies that are relevant for your organization, all users in your organization are able to view them by clicking the taxonomies icon in the top navigation bar. Users who are not administrators are not able to create, edit, or delete taxonomies. However, non-administrators can click to open each taxonomy, view its nodes, and see what services or consumers to which the taxonomy or node applies. Service owners or consumer owners can refer to this page to identify available taxonomies that might apply to their services and consumers.
Note that when you click on a taxonomy node, a panel appears at the bottom of the screen containing two tabs: one tab for services and another for consumers. As you click into various taxonomy nodes, services or consumers which use the taxonomy level appear in this panel.
A service or consumer only appears in the panel if you select the exact matching taxonomic structure. For example, imagine a service which has the following taxonomy applied: Business Unit > Human Resources > Hiring. When viewing taxonomies, if you have opened these exact nodes, this service appears in the services tab at the bottom of the taxonomy screen. If you only click to open Business Unit > Human Resources, the service does not appear; if you click to open Business Unit > Human Resources > Hiring > Onboarding, the service does not appear.
Users can access this taxonomy page to filter services in the organization and discover relevant service for their business needs. Each service or consumer name links directly to its corresponding service or consumer main page.