DirectScale Developers

DirectScale Developers

Get Started    API Reference

XML Compensation Plan Editor

Available for Business and Premium tiers

The XML Editor is where you create or edit your commission template using an EXtensible Markup Language (XML) editor. The system uses the correctly formatted XML to run Commission Profiles.



Enabling the Page

To use this feature, you'll need to enable it in Advanced Settings > Commission > Compensation Plan Editor > select the Enable XML Editor checkbox.

[CLIENTID].corpadmin.directscale.com/Settings?category=Commission



Permissions

The EditCompPlan() permission needs to be enabled to use this feature.

Read more in the Help Center: Assigning Employee Permission Roles



Finding the Page

Compensation Plan XML pageCompensation Plan XML page

In Corporate Office, navigate to: Commissions > Compensation Plan XML.

[CLIENTID].corpadmin.directscale.com/Corporate/CRM/Commissions/ComPlanDesigner



Adding a Template

The Template Name dropdown is where you select a previously saved template. The Template Name is defined in the XML:

<ComPeriod Name="Monthly"></ComPeriod>

Typically, the Template Name is the same as the period it represents (Weekly, Monthly, Bi-Monthly, etc.).

To add a new template:

  1. Click the Clone button to make a copy of an existing template.

    Clone buttonClone button

    A pop-up window opens, where you can give the copy a name.

  2. In the pop-up, enter a name.

  3. Click Clone to confirm.

    Clone pop-up windowClone pop-up window

    The pop-up closes, and the cloned copy becomes a Template Revision.

  4. Change the <ComPeriod> Name attribute to the Revisions name.

    ComPeriod NameComPeriod Name

    • Every Template Name must have a Revision and <ComPeriod Name=""> with the same name to function correctly.
    • Template Names and Revisions are case sensitive and can't be longer than 50 characters.
  5. Click the Save button.

  6. In the pop-up, add an optional commit message.

    Save buttonSave button

  7. Click Save to confirm.

  8. Refresh the page to see changes.

    Refresh the pageRefresh the page

The Template Name dropdown now shows your new template.



Adding Revisions

A Template Revision is a specific version of a template. Your cloned templates appear in this list.

Revisions should share a name with the main template so that the version History is shared between them. For example, if you have a template named Monthly, you can have cloned Revisions called Monthly-workInProgress, MonthlyTestingNewBonus, etc. This convention allows you to test changes without affecting the main template.

To add a new Revision:

  1. Click the Clone button to make a copy of an existing template.

    Clone buttonClone button

    A pop-up window opens, where you can give the copy a name.

  2. In the pop-up, enter a name.

  3. Click Clone to confirm.

    Clone pop-up windowClone pop-up window

    The pop-up closes, and the cloned copy becomes a Template Revision.

📘

Note

Clone will copy from the current XML displayed in the XML Editor not the most recent save; therefore, your cloned Revision may not match the original Revision if you had unsaved changes.


Setting a Revisions as the Main Template

  1. Copy/paste the Revision's XML into the main template.

  2. Change the <ComPeriod> Name to the Revision name.

  3. Click the Save button.

  4. In the pop-up, add an optional commit message.

    Save buttonSave button

  5. Click Save to confirm.

  6. Refresh the page to see changes.

Following this procedure, you will have a single template with a full History of the different versions to which you can revert.



Saving a Template

Saving commits the changes to the template.

  1. Click the Save button.

  2. In the pop-up, add an optional commit message.

    Save buttonSave button

    The commit logs in History.

  3. Click Save to confirm.

  4. Refresh the page to see changes.

    Refresh the pageRefresh the page

When you save, the system:

  • Validates the XML
  • Displays a message
  • Highlight the errors

📘

Note

You can save changes even if there are validation errors to allow you to save your work-in-progress until it is complete; however, Revisions with errors will not show as templates that can be used for Commission Profiles.



Viewing History

View and compare saved versions of a template.

To view a template's history:

  1. Click the History button.

    The History For: pop-up window opens.

  2. In the pop-up, click View on the version you want to view.

    A pop-up with the version's XML opens.

  3. Click the View History button to return to the History For pop-up window.

To compare template versions:

  1. Select the Compare radio box for any two versions to compare their XML.

  2. Click Compare Selected

    The pop-up shows the two versions side-by-side, where you can compare their differences.

To revert to a previous template version:

  1. Click View on the old version.
  2. Copy the XML from the pop-up.
  3. Close the History For: pop-up.
  4. Add a Template Revision.
  5. Paste the XML into the XML Editor.
  6. Save the template.


Deleting a Template or Revision

To delete a Template:

  1. Select the Template Name with no Revisions.

    If the template has Revisions, you must first delete the Revisions.

  2. Click the Delete button.

    A pop-up opens requesting confirmation.

  3. In the pop-up, click Delete to confirm.

To delete a Revision:

  1. Select the Template Name.

  2. Select the Template Revision

  3. Click the Delete button.

    A pop-up opens requesting confirmation.

  4. In the pop-up, click Delete to confirm.



Using the Helper Documentation

The sidebar documentation helper features descriptions and snippets for many XML elements used in compensation plans.

  1. Expand a category.

  2. Locate the element you want to view and click more.

    The box expands, showing parameters.

  3. Click Copy xml snippet.

    The snippet copies to your clipboard.

  4. In the XML Editor, paste the snippet.

    A blank snippet with parameters pastes in the editor.

    <IndexVolume IndexVolume="" />
    

You can find many of the same elements documented in the XML Reference.

Updated 12 days ago



XML Compensation Plan Editor


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.