Mapping Templates

Mapping Templates in Compound Direct define how the columns in a CSV file correspond to customer, prescriber, product, prescription, draft, order, account, delivery, and e-prescription information. A mapping template is required before starting a bulk import, and can be reused whenever a source file follows the same layout.

Templates can also supply default values, require important information, and apply rules that standardise or validate each row before it is imported. Setting up the template carefully reduces repeated data entry and makes each bulk import easier to review.

This guide will help you:

• Create a mapping template from an existing CSV file or by selecting mapped fields.
• Configure source columns, default values, required fields, and mapping rules.
• Download a blank CSV template, start an import, and manage existing templates.

Finding a mapping template

1. Go to the ‘Settings’ page.
2. Click on ‘Templates’.
3. Select ‘Mapping Templates’.
   1. You can also go to ‘Bulk Imports’ and click ‘Manage Templates’ on the ‘Bulk Import Dashboard’.
4. The ‘Mapping Templates’ page displays each template's Name and Description, Template Type, Date Created, and Last Used date.
5. Begin typing the template name in the search search bar to refine the list.
6. Click the desired ‘Mapping Template’ to view or edit it.

Planning a mapping template

Before creating a template, identify which columns your source system provides and which Compound Direct fields they should populate.

1. Use one row in the CSV file for each draft you intend to create.
2. Keep the source column headings consistent between files. A saved Source column should match the corresponding CSV heading.
3. Include enough information to identify the required customer and product for every active row.
4. Add prescription, prescriber, delivery, account, or order fields only when they are needed for your workflow.
5. Decide which values are supplied by the CSV and which should be supplied by a template Default Value.
6. Decide which fields must be completed before drafts can be created, then mark those mappings as Required.

Creating a mapping template

1. Go to the ‘Mapping Templates’ page.
2. Click ‘Create Template’.
3. Enter a clear Template Name.
4. Enter a Description that identifies the source system, file type, or intended workflow.
5. Build the ‘Column Mapping’ in either of the following ways:
   1. To scan an existing layout, upload or drag and drop one .csv file into ‘Upload import file to be scanned’.
      1. Compound Direct reads the first row as the source column headings.
      2. Where a heading resembles an available Compound Direct field name, the corresponding Mapped field is selected automatically.
      3. Review every automatically selected field before saving.
   2. To build the template manually, click ‘Add Mapped Field’ or ‘Add Mapped Fields’.
      1. Search for a field or expand a category.
      2. Tick each field you want the template to support.
      3. Click ‘Done’.
6. Configure each row in ‘Column Mapping’:
   1. In ‘Source column’, enter the heading used in the CSV file.
   2. In ‘Default Value’, optionally enter a value to use when the source value is blank or the source column is not supplied.
   3. Tick ‘Required’ when the mapped value must be present before the item can proceed.
   4. Under ‘Mapped field’, select the Compound Direct field that receives the value.
7. Drag the reorder icon to arrange the mappings in a practical review order.
8. To remove a mapping, click the delete_outline icon beside it.
9. Add any required Mapping Rules.
10. Click ‘Create Template’.

Understanding column mapping

Each mapping row controls how one value is prepared for the import.

Common mapped-field formats

1. Enter dates in your workspace date format or as YYYY-MM-DD.
2. For a Yes/No field, use TRUE, YES, Y, or 1 for Yes. Other or blank values are treated as No.
3. Separate multiple tags with commas in fields such as Tags, Customer Tags, or Order Tags.
4. Enter percentages as numbers between 0 and 100 where a percentage field is used.
5. Enter currency and quantities as numbers without explanatory text.

Mapped fields that affect later processing

Adding mapping rules

Mapping Rules conditionally change or validate row values. Use them when the same source layout needs different outcomes depending on the contents of a row.

1. Create or open a mapping template.
2. Under ‘Mapping Rules’, click ‘Add Rule’.
3. Enter an optional Rule name so the rule's purpose is easy to recognise.
4. Leave ‘Rule enabled’ switched on for the rule to run during imports.
5. Under ‘When’, configure the condition:
   1. Select whether to inspect a Source column or a Mapped field.
   2. Select or enter the column or field.
   3. Choose a comparison, such as equals, does not equal, contains, starts with, ends with, a greater/less than comparison, is empty, or is not empty.
   4. Enter the Comparison value when required.
6. To use more than one condition, click ‘Add Condition’ and select whether all conditions are true (AND) or any condition is true (OR).
7. Under ‘Then’, configure one or more actions. A rule can:
   1. Set a mapped field to a value.
   2. Copy from a source column or another mapped field.
   3. Append, prepend, remove, or replace text.
   4. Add, subtract, multiply, or divide a number.
   5. Clear a mapped field.
   6. Add an issue to the whole row or to a related field with a user-readable message.
8. If needed, tick ‘Do not run this rule when these conditions are true’ and configure the exception conditions.
9. Tick ‘Stop processing later rules when this rule matches’ if no later rule should change the row after this rule succeeds.
10. Click ‘Save Rule’.
11. Review the When and Then summary shown on the rule card.
12. Drag the drag_indicator icon to change the order in which rules are applied.
13. Click ‘Duplicate’, ‘Edit’, or ‘Remove’ to manage an existing rule.
14. Click ‘Save Template’ when finished.

Using the JSON rule editor

The Visual / JSON toggle provides an advanced editor for specialised rules.

1. Click the ‘Visual / JSON’ toggle to view the rule as JSON.
2. Only edit the JSON if you understand the rule format used by your workspace.
3. Resolve any validation message before clicking ‘Save Rule’.
4. Toggle back to ‘Visual’ when the rule can be represented by the visual editor.

Testing and downloading a mapping template

1. Save the mapping template.
2. Click ‘Get Template file_download’ to download a blank CSV containing its source headings.
3. Open the file and confirm that the headings match the export produced by your source system.
4. Add a small set of representative rows, including any unusual customer, product, order, or prescription scenarios.
5. Start a test import and review the ‘Uploaded’ and ‘Drafting’ stages before creating drafts.
6. If columns map incorrectly or repeated issues appear, return to the mapping template, make the correction, and use a new test import.

Starting an import from a mapping template

1. Open a saved, unarchived mapping template.
2. Ensure there are no unsaved changes.
3. Click ‘Start Import’.
4. In the ‘New Import’ modal, either:
   1. Upload or drag and drop a completed .csv file; or
   2. Click ‘Create Without CSV’ to add rows manually.
5. Continue with the Starting a bulk import guide.

Editing and managing mapping templates

1. Go to the ‘Mapping Templates’ page.
2. Select the desired template.
3. Update the Template Name, Description, column mappings, defaults, required fields, or mapping rules.
4. Click ‘Save Template’.

To duplicate a mapping template:

1. Open the mapping template.
2. Click the ‘More actions’ menu.
3. Select ‘Duplicate Template’.
4. Update the duplicate's name or settings, then click ‘Save Template’.

To archive or unarchive a mapping template:

1. Open the mapping template.
2. Click the ‘More actions’ menu.
3. Select ‘Archive’ or ‘Unarchive’.

Customising import columns with a mapping template

The table layout used during an import is saved with its mapping template, helping repeated imports use a consistent review layout.

1. During an import, open the ‘Uploaded’, ‘Drafting’, ‘Queued’, or ‘Dispensed’ tab.
2. Click ‘Columns’.
3. Tick the fields you want displayed and untick fields you want hidden.
4. Click ‘Done’.
5. Drag a column boundary to resize it, or double-click the boundary to reset its width.
6. Click the push_pin icon in a column heading to pin or unpin the column where available.