Manage Topics

You can capture business requirements, and the logic that implements them, into topics by grouping your rules into topics.
lac31
You can capture business requirements, and the logic that implements them, into topics by grouping your rules into topics. Topics are methodology-neutral and provide clarity in the review of your business logic. They can represent Agile user stories or behavior-driven development (BDD) stories/behaviors that capture and group the business requirements and the business rules that implement them. For each behavior (such as Check Credit), enter it as a topic.
In this article:
Add Topics
  1. With your API open, in the Create section, click 
    API Properties
    .
    The Details page displays by default.
  2. Click the 
    Topics
     tab.
    Your topics are displayed in the topics list.
  3. Above the topics list, click 
    Add
    .
    A new topic is displayed in the list.
  4. Complete the following:
    • Enter a name and a summary for the topic.
    • Assign a color to the topic to make visualization easier.
    • In the rich text section, record why you defined the associated rule.
  5. Save your changes.
The topic is added.
Associate Rules to Topics
Group rules together by associating them to topics. Within the topic definition, you can map Agile user stories or requirements to the topic. You can associate a rule to one or more topics.
Prerequisite:
 You have added the topic to which you want to associate the rule.
  1. With your API open, in the Manage section, click 
    Rules
    .
    A list of rules display.
  2. Click the rule that you want associate to the topic.
  3. Click the 
    Topics
     field, and then select the rule.
  4. Save your changes.
The rule is associated to the topic.
Link Topics to Other Artifacts
You can link topics to other artifacts.
  1. With your API open, in the Create section, click 
    API Properties
    .
    The Details page displays by default.
  2. Click the 
    Topics
     tab.
  3. Select the topic from which you want to link other artifacts. 
  4. In the rich text section, add hyperlinks to the other artifacts.
  5. Save your changes.
Filter Rules by Topic
You can filter rules to those of interest for development and for business-user communication.
  1. With your API open, in the Manage section, click 
    Rules
    .
    A list of rules display.
  2. Click the 
    By topic
     tab.
    A list of rules display organized by topic. The following image shows this tab for the 
    Demo
     API sample:
    Screen Shot 2017-05-22 at 3.19.10 PM.png  
  3. Filter rules by a selected topic.