Refining the Policy Scope
If you want to further restrict the set of virtual APIs to which the policy is applied, you can specify additional selection criteria in the Filter criteria section of the Run-Time Policy Details page. Using this section, you can filter objects by Name, Description, and/or Classification attributes. If you specify no filter criteria, the policy will apply to all virtual APIs.
Filtering By Name and DescriptionYou can filter policies based on their Name and/or Description attributes using any of the following comparison operators:
Comparison Operator | Description |
Equals | Selects APIs whose Name or Description value matches a given string of characters. For example, you would use this operator if you wanted to apply a policy only to APIs with the Name or Description value Mobile App Store. |
Contains | Selects APIs whose Name or Description value includes a given string of characters anywhere within the property's value. For example, you would use this operator if you wanted to apply a policy to APIs that had the word Mobile anywhere in their Name or Description property. |
StartsWith | Selects APIs whose Name or Description value begins with a given string. For example, you would use this operator if you wanted to apply a policy only to APIs whose Name or Description begins with the characters Mobile. |
When specifying match strings for the comparison operators described above, keep the following points in mind:
Match strings
are not case-sensitive. If you define a filter for names that start with "ABC" it will select names starting "abc" and "Abc".
Wildcard characters are not supported. That is, you cannot use characters such as * or % to represent
any sequence of characters. These characters, if present in the match string, are simply treated as literal characters that are to be matched.
Filtering By Classification Attribute You can also filter APIs based on the way in which they are classified. When you filter APIs in this way, CentraSite applies the policy to APIs that have at least one classification attribute whose value matches a specified taxonomy category. For example, you could use a classification filter to apply a policy to those APIs that are classified with “Production” sandbox.
When you filter APIs by classification, CentraSite inspects all of an APIs classification attributes. If any of those attributes contain the exact category specified by the selection criteria, the API is listed in Run-Time Policy Details (Step 3 of 3) of the policy.
Note: | To satisfy the selection criteria, the attribute value in the API must match the category specified in the selection criteria exactly. Sub-categories of the specified category are not considered to be matches. For example, say you have a taxonomy category called "Project ABC", and that category has the subcategories “Project ABC Design”, “Project ABC Development”, and “Project ABC Deployment”. If you filter for category “Project ABC”, CentraSite will apply the policy to objects that are classified by the specific category “Project ABC”, but not objects that are classified by that category's sub-categories. |
Use the following procedure to specify additional criteria for selecting APIs to which you want the policy applied:
To refine the policy scope
2. If the policy is active, deactivate it. You cannot refine the scope of an active policy. If you need procedures for this step, see Deactivating a Run-Time Policy. 3. In Run-Time Policy Details (Step 1 of 3), locate the Filter Criteria section.
4. If you want to filter by Name or Description, take the following steps:
a. Select Name or Description in the first field.
b. Select the comparison operator (for example, Equals, Contains, StartsWith) in the second field.
c. Specify the match string in the third field.
5. If you want to filter by APIs' classification, take the following steps:
a. Select Classification in the first field.
b. Click Browse and select the category by which you want to filter APIs.
6. If you want to specify additional criteria, click the plus button and repeat steps 4 and 5.
Important: | If you specify multiple filters, the policy is applied only if the API matches all the selection criteria (that is, the selection criteria is combined using an AND operator, not an OR). |
7. You will see the generated list of services displayed in Run-Time Policy Details (Step 3 of 3).
9. When you are ready to put the policy into effect, publish it as described in Run-Time Governance with CentraSite.
