Overview

This importer will:

  • create a new or update an existing product rate card
  • NOT support product category or sub category markups
  • NOT allow to configure invoice maps

Business Rules

The following business rules apply:

  • The Account ID will match the logged-in User
  • Default approval status if supplied data is blank is 'DRAFT'
  • Default markup is blank
  • If the status is 'APPROVED" and the approval date is missing, Make the field the date of the upload.
  • If no product rate card ID present than a new card is created
  • Where a product rate card ID is present, the following fields support updating
    • Internal Name
    • External Name
    • Import Reference
    • Default Markup
    • Approval Status, Approved Date and Approved by ID providing the card is in not 'APPROVED' already
    • The saleable from the date where the card has not been 'APPROVED' already

Licencing

This feature is available to subscribers of the following:  

  • Emersion Core
  • Optional Modules 
  • Upon Request (please contact your Account Manager)


Import Result Notification

This feature utilises the Bulk upload processing notification event (event type 963) to send a notification to the user containing the results of the import attempt. 

  • If the import is successful, the email notification will advise you when the import process is complete. 
  • If the import is not successful, the email notification will send details of the records that failed validation and why.

An event template must be created and the event must be enabled before the import tool can be used.


Preparing The Data for Import

To prepare your data for import, you will need to create a CSV import file or you can download the import file below. You will need to extract the csv file and save it.

A hard limit of 500 rows is supported via this tool, including the header row. 

If you need to import more than this, create multiple import files and process them one-by-one.

Download the product rate cards import template



Importing The Data

To access the import tool:

Admin > Bulk Import > Product Rate Cards        

  1. Click the Browse button and select the csv file containing the data you want to import.
  2. If you want the bulk upload processing notification email to be sent to a different email address than the address defined in the event template, tick the Override? checkbox and enter an alternative email address. This will only apply for this upload. To change the email address for all future imports, you will need to change the recipient defined in the event template.
  3. Press Submit
  4. The system will validate the data and if no errors are found, the system will import the data. When the notification email is received, the process has been completed.

Validating the Import

Bulk Import Validation

The system will parse the data for invalid formatting only. It cannot check for data accuracy. It is strongly recommended that you check the imported data to ensure that the import was accurately imported. To do this, divide your import records into groups of 20. Check a single record in each group. If an error is found, check each previous record for the group until you find the one that was imported incorrectly.

If you find an problem, you cannot roll back the import. You have two options should this occur:

  1. Manually correct the data.
  2. Request Emersion fix the errors for you.

Any request to correct imported data must be submitted via a ticket. Emersion will provide an estimate of the work and a quote. The quote must be approved and paid in advance before any restorative work commences. 



Data Definition

This section contains a list of the required fields and a definition of what the system considers as valid inputs.

Data fieldDescriptionMandatory?
PRODUCT_RATE_CARD_IDThe ID of the product rate card.

No

BUY

BUY or SELL

Yes, if PRODUCT_RATE_CARD_ID is not entered

INTERNAL_NAMEThe internal name of the product rate card.Yes, if PRODUCT_RATE_CARD_ID is not entered
EXTERNAL_NAMEThe external name of the product rate card.Yes, if PRODUCT_RATE_CARD_ID is not entered
IMPORT_REFERENCEThe import reference.No
DEFAULT_MARKUP

Negative is allowed.

-10 = - 10%
100 = 100% 

Empty means no Default Markup.

No
APPROVAL_STATUS

DRAFT
PENDING
APPROVED

All objects will be uploaded in DRAFT status if not set.

No
APPROVED_DATE

Format: YYYY-MM-DD

If not set use the upload Date.

No
APPROVED_BY_ID

Cumulus User ID

if Status set to approved and Approved By not set then use the Logged-in User.

No
SALEABLE_FROM_DATEFormat: YYYY-MM-DDYes, if PRODUCT_RATE_CARD_ID is not entered
SERVICE_TYPE_CATEGORY_IDThe ID or name of the service type category.Yes, if PRODUCT_RATE_CARD_ID is not entered and PRODUCT_RATE_CARD_TYPE is 'Service Based'
PRODUCT_RATE_CARD_TYPE

1 = "Service Based"
2 = "Access Fee Discount"

By default, "Service Based" will be used where this is not set. 

No



Viewing Imported Data

After importing data it is important to validate it was imported correctly. Choosing a random records and performing a visual check in Cumulus should reveal any mistakes relatively quickly that would be harder to see in an import sheet.

Product Rate Cards can be found via Packages and Plans > Management - Product Rate Cards tab.


Access Control

No powers are used to govern access to this tool.


Related Pages