Overview

The purpose of this importer is to import products, specifically:

  • point of sale products
  • products relating to miscellaneous usage records provided by service suppliers. These usage files are often referred to as call data records ('CDRs').

This importer, unlike most others, does not use the Bulk Import framework to receive and process the files using Cumulus.  In this case Emersion's Batch Mediation System ('BMS') receives and processes these files. Files will be delivered to a secure FTP location that will be provided to you upon subscribing to the importer. The BMS will automatically process the files that are pushed.

Business Rules

When updating an existing product, only the following fields will be updated.  If you try update a field other than the ones below, it will be ignored by the BMS.

  • GL Code
  • Product Category
  • Product Subcategory
  • Manufacturer
  • Colour
  • Tax Type
  • Price Type
  • Product Status
  • Supplier Name
  • Supplier Code
  • Product Name
  • Description

The product identifier/SKU is used to find existing products that will be updated using this importer.

Licencing

This feature is available to subscribers of the following:  

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


Import Result Notification

There is no automated communication to our customers of the success or failure of an import. 

If the import succeeds you will see products available for use within Cumulus.  If you cannot see the products, the import failed.

If the import fails, raise a ticket with the service desk team so we can assist you.




Importing The Data

Once the necessary setup is complete, you will need to deliver the file to the appropriate SFTP location.  The Emersion support team will advise you further on the necessary connection details.

Sample File

Download the product importer template

Data Definition

Filename format

The filename format is broken up into 5 sections separated by underscores, these are as follows;

  • Source company (SAMPLE) - 1-8 CHARS
  • Destination company (EME) - 3 CHAR
  • Sequence Number (5) - up to 8 NUMBERS
  • Date generated (20171105) - 8 String (YYYYMMDD)
  • Time generated (165900) - 6 String (HHMMSS)


Example valid filename: EMEO_EME_00000001_20181203_000012.csv

Sequence number is a customer-generated number. It can be anything, but is commonly an incremented number each file that is uploaded.

The product importer data template file contains example records as a guide.

Header Record

FieldField TypeExampleDescription
Record TypeString (6)HDRThe type of record (always HDR) 
Sequence NumberInteger (8)1The file sequence number
File Generation Date/TimeString (15)20171103_165455The date and time the file was generated, separated by an underscore.

Detail Record

Source File Column NumberFieldField TypeMandatory on AddUsed in Update?ExampleDescription
0Record TypeStringYesN/ADETThe type of record (always DET)
1Product Identifier/SKUStringYesYesCHG-EMO-3858The unique identifier representing the product. It will be the SKU in the product definition, and also the product key used for inbound service and equipment transactions.
2Product NameStringYesYesMy fancy modemThe product name as it will appear in the system.
3DescriptionStringYesYesThis is a special fancy modemA long description of the product.
4Product StatusStringYesYesActiveThe status of the product.
5Start DateDateYesNo2013-10-10The date the product was considered created and usable.
6CategoryStringYesYes'Network' or '1294'The product category the product associated with.  The category must exist in Emersion prior to importing products for it.
7SubCategoryStringNoYesCablingThe product sub category in Emersion.  The sub category must exist in Emersion prior to importing products for it.
8Supplier NameStringNoYesSuper Distributors Pty LtdThe supplier the product is sourced from. Not accepted where Service Type Category is provided.
9Supplier CodeStringNoYesCATRThe supplier code that provides the product.
10Product Price TypeID or StringNoYes

'units'

or Product Price Type ID

The type of pricing that applies to this product. This is a vanity field and has no bearing on calculation.

Reference Data available via the Unit Type / Price Type report under Report > List > Reference.

(info) Ensure you use the (case-sensitive) value from the SHORT_NAME column.

11GST CodeID or StringYesYes

'australia-gst'

or Tax Type ID

The Emersion tax type to be used.  Tax types are are maintained by Emersion and are available to access via the Tax Type List report under Reports > List > Reference.

(info) Ensure you use the (case-sensitive) value from the TAX_KEY column.

12GL CodeID or StringYesYesMISC_PRODUCT

The ledger code required for the product. Internal codes cannot be used. The ID or text input is valid.

Reference Data available via the Ledger Codes (and Mapping) report under Report > List > Reference.

13Is SerialisedBooleanYesYesfalseControls whether the product is serialised when purchased or fulfilled. Not accepted where Service Type Category is provided. Defaults to false.
14Track InventoryBooleanYesYesfalseControls whether inventory is tracked when purchasing within Emersion. Not accepted where Service Type Category is provided. Defaults to false.
15ManufacturerID or StringNoYesAppleString or ID matching one of the manufacturers within the Emersion reference list. Not accepted where Service Type Category is provided.
16ColourID or StringNoYesRedString or ID matching one of the colours within the Emersion reference list. Not accepted where Service Type Category is provided.
17Can Assign ServiceBooleanNoNofalseControls whether a service can be bound against the product sale if created within the Cumulus Purchase section. Not accepted where Service Type Category is provided. Defaults to false.
18Encrypt Serial NumberBooleanNoNofalseControls whether the 'Serial Number' provided for Inventory is encrypted on entry. Not accepted where Service Type Category is provided unless product type is 'Voucher'. Only used if 'Track Inventory' and 'Is Serialised' are used.
19Product Type IDID or StringYesNo'Billable Item'One of 'Service Charge', 'Billable Item', 'Physical Product', 'Labour' or 'Voucher' (or related ID).
20Service Type CategoryID or StringNoNo'EMEO Managed Services'The name or ID of the service type category that the product should go under. Used for creating inbound Service and equipment products. It should also be noted that the service type category has been enhanced as a result of this project to include a reference to the managing account id. A validation check would ensure that the connector's account id is the managing account id for the service type category; otherwise, an error will be returned.
21Supplier CategoryStringNoYes'My Supplier Category'The name of the Supplier Category

 Footer Record

FieldField TypeExampleDescription
Record TypeStringFTRThe type of record (always FTR) 
Total RecordsInteger10045The total records including the header


Related Pages