Show search and navigation.

 

Administering Drafts and Rules

This section explains how to perform the following administrative tasks:

Creating a Draft

Create a draft by either adding a brand new one or by copying an existing draft/policy.

ClosedTo create a draft
  1. Navigate to the Rules Engine page.

  2. From the Drafts tab, click on the icon.

  3. From the Create Draft page, type the name that will be assigned to the new draft.
  4. Click Continue to save the new draft.
  5. Set up a rule and then click Save to save it. Repeat this step as needed.
ClosedTo copy a draft
  1. Navigate to the Rules Engine page.
  2. From the Drafts tab, click on the name of the desired draft.

  3. Click Duplicate to create a copy of the draft. The name of the new draft will use this syntax:

    DraftRepresents the name of the draft that was copied. - copy
ClosedTo create a draft from an existing policy
  1. Navigate to the Rules Engine page.
  2. Click the Policies tab.
  3. Click on the name of the desired policy.

  4. Click Duplicate to create a draft from the policy. The name of the new draft will use this syntax:

    PolicyRepresents the name of the policy that was copied. - clone from Policy

Importing a Draft / Policy

An alternate method of duplicating a draft or policy is to import an XML version of it into an empty draft.

Key information:

ClosedTo export a draft or policy as XML
  1. Navigate to the Rules Engine page.
  2. Open the desired draft or policy by clicking on it from either the Drafts or Policies tab.
  3. Click the Raw XML tab.
  4. Click Export.
ClosedTo import a draft or policy
  1. Verify that the desired draft or policy has been exported.
  2. Navigate to the Rules Engine page.

  3. From the Drafts tab, click on the icon.

  4. From the Create Draft page, type the name that will be assigned to the new draft.
  5. Click Continue to save the new draft.
  6. Click the Raw XML tab.
  7. Click Import. When prompted, find and select the file that was created in step 1.
  8. Click the Rule Builder tab and then review your draft.
  9. click Save to save it. Repeat this step as needed.

Modifying a Draft

Modify a draft to fine-tune a Rules Engine configuration.

Only a policy may be applied to test or live site traffic. This means that once a draft accurately reflects the desired configuration, it should be converted into a read-only policy.

Use the search bar to filter the drafts listed on the Drafts tab by name. Only drafts whose name contain the specified word or phrase will be displayed. Clear the search bar to view all drafts.

All settings within a draft may be modified. However, only a single rule may be modified at any given time. Likewise, a draft may not be renamed until changes to a rule have been saved or canceled.

To modify a draft

  1. Navigate to the Rules Engine page.
  2. From the Drafts tab, open the desired draft by clicking on its name.

  3. Perform one or more of the following actions:

    ClosedRename a draft
    1. Click the icon next to its name.
    2. Type the desired name.
    3. Click the button to save the new name.
    ClosedAdd a rule
    1. Add a rule by clicking .
    2. Optional. Type a description for the new rule.
    3. Modify the rule as needed.
    4. Click Save to save your changes.

    A new rule may be created by copying an existing rule within the current draft.

    ClosedCopy a rule within a draft
    1. Find the desired rule.
    2. From the rule's header bar, click the ellipsis (i.e., ...) and then click Copy Rule.

    3. Determine whether the new rule will be configured exactly like the original rule by selecting one of the following options:

      • Reset: All match conditions and features in the copied rule will be reset to their original state.
      • Preserved: The configuration associated with matches and features in the copied rule will match the original rule.
    4. Click Copy. A copy of the rule will appear at the bottom of the list. The term "- copy" will appended to the name of the copied rule.
    5. Modify the copied rule as needed.
    6. Click Save to add the rule to the draft.

    A rule may not be copied while another one is being modified. Save or cancel rule changes before attempting to copy a rule.

    ClosedCopy a rule to another draft
    1. Find the desired rule.
    2. From the rule's header bar, click the ellipsis (i.e., ...) and then click Transfer Rule.
    3. Navigate to another draft.

    4. Click Paste rule from clipboard which can be found at the bottom of the draft.

      The new rule will be appended to the draft and it will be configured exactly like the original rule.

    5. Modify the copied rule as needed.
    6. Click Save to add the rule to the draft.

    A rule may not be copied while another one is being modified. Save or cancel rule changes before attempting to copy a rule.

    ClosedModify a rule

    Only a single rule may be modified at any given time.

    1. Find the desired rule.
    2. From the rule's header bar, click .
    3. Perform any of the following actions:
      ClosedTo rename a rule

      Rename the rule by simply typing a new description in the edit box that appears directly below the rule's header bar.

      ClosedTo add a match condition
      1. Find the location in the rule where a new match condition should be inserted.

      2. Click and then select "Match."

        • First Match Condition: A rule's first match condition is always added at the top of the rule.
        • Subsequent Match Conditions: The new match condition will be added at the same level as the button.
      3. Select a category and a match condition.
      4. Configure the match condition's settings.

      A match condition cannot be nested under the Always match condition. However, a match condition may be added as a sibling to the Always match condition. This type of setup allows an additional set of actions to be applied to requests that satisfy that match condition.

      ClosedTo add a feature
      1. Find the match condition that must be met before the feature will be applied to a request.
      2. Click the button that appears under it and then select "Feature." A new feature will be added directly below the match condition.
      3. Select a category and a feature.
      4. Configure the feature's settings.
      ClosedTo add a select first match section
      1. Find the location in the rule where a new select first match section should be inserted.
      2. Click and then select "Select First Match." A new select first match section will be added directly below it. This section will contain an initial match condition.
      3. Select a category and a match condition.
      4. Configure the match condition's settings.
      5. Optional. Add a nested match condition or a feature by clicking on the button that appears directly below it, selecting "Match" or "Feature," and then configuring it.
      6. Optional. Add an else if match condition by clicking on the button that appears directly below it. Select the match condition and configure it. Add a feature to it.

      Only a single select first match section may be added per rule.

      ClosedTo modify a match condition, select first match, and/or feature

      Simply make the desired changes (e.g., select a different match condition or adjust a setting).

      ClosedTo delete a match condition, select first match, or feature

      Click on the icon that appears directly to the right of it.

      Hovering over the icon will highlight the section or feature that will be deleted.

    4. Click Save to save your changes.
    ClosedMove a rule
    1. Find the desired rule.

    2. From the rule's header bar, perform one of the following actions:

      • Click and drag it to the desired position.
      • Click the ellipsis (i.e., ...) and then select Move to top to move this rule to the top of the list.
      • Click the ellipsis (i.e., ...) and then select Move to bottom to move this rule to the bottom of the list.
      • Click the ellipsis (i.e., ...) and then type the desired position next to the Move to option. Click ENTER to move this rule to the specified position.

    A draft will be automatically saved upon moving a rule.

    Rules may not be reordered while a rule is being modified. Save or cancel rule changes before attempting to move a rule.

    ClosedDelete a rule
    1. From the rule's header bar, click the ellipsis (i.e., ...) and then select Delete Rule.
    2. Click Delete to confirm the rule deletion.

    A rule with unsaved changes may not be deleted. Please save or cancel your changes and try again.

Converting a Draft

Before a draft may be applied to the Production or Staging environment, it must be converted into a read-only policy. Before taking this step, please make sure that the rule(s) defined in the draft accurately reflect(s) how traffic should be handled by the CDN.

A policy may be applied to the Production or Staging environment via a deploy request.

Use the search bar to filter the drafts listed on the Drafts tab by name. Only drafts whose name contain the specified word or phrase will be displayed. Clear the search bar to view all drafts.

The conversion of a draft to a read-only policy is irreversible. However, a draft may be created by duplicating a policy.

ClosedTo convert a draft into a read-only policy
  1. Navigate to the Rules Engine page.
  2. From the Drafts tab, click on the name of the desired draft.
  3. Click Lock Draft as Policy.

Basic validation will be performed upon converting a draft to a policy. A misconfigured rule (e.g., a blank match condition, feature, or setting) will generate an error. Please review and address any issues with the draft.

Deleting a Draft

A draft may be deleted by viewing it and then clicking Delete.

The deletion of a draft is permanent. Once a draft has been deleted, it cannot be recovered.

Use the search bar to filter the drafts listed on the Drafts tab by name. Only drafts whose name contain the specified word or phrase will be displayed. Clear the search bar to view all drafts.

More Information