Importer
Overview
To access the Importer, click ADMIN (1) > Importer (2).
The client-side Importer tool allows you to upload data from your computer into the Compensation and Compliance module database. It is often used to load trades and recurring revenue transactions (sometimes called trails) for small product providers that do not report their activity electronically via DST or DAZL. This is also used in the early stages of implementation to establish the baseline master data on employees, representative IDs, and locations.
Terms
Term | Description |
---|---|
Importer project | An importer project (loader) is a configuration for receiving data in a specific format and updating corresponding entries in the database. Different projects are created for importing various objects and types of data, for example, Employee Licenses, list of Companies, Adjustments, Trades and Recurring Revenue. |
Reporting and error handling | The Data Load Reports web page displays the results under the Client Side Imports node. |
Dynamic and regular adjustments |
|
Features
Feature | Description |
---|---|
Importer Template | Provides the user with the proper spreadsheet layout to use with a project. Download the Data Importer Template using the Format button. Then, input data into the template. |
Confirming a successful load | By filtering transactions or accounts by file name using the Transaction Monitor or Account Monitor, you can verify that all data has been loaded correctly. |
History and Undo | The History and the Undo features allow you to back out a client side import that did not work as expected. |
XML to CSV conversion | The inbound data files are sometimes in complex and hard-to-read formats such as fixed-length and looping structures (e.g., DTCC). The XML to CSV conversion utility can convert these formats to a CSV format that is easy to load to a spreadsheet. This feature is useful for clients who wish to modify data before importing it. |
Formats and Limitations
The client side Importer supports the following inbound data formats:
CSV
XLS
Data size limitations
We do not recommend loading files >10,000 rows using the Importer. Instead, put them in your SFTP server. Our data team will load them using the larger capability servers that we use for overnight importer processing.
Excel spreadsheet formatting
If you use a currency in Excel, it automatically formats the cell with a comma and decimal point. A comma may cause issues. Remove commas and currency symbols in numerical columns of Excel.
Remove commas in names such as “Microsoft, Inc.”
Remove leading zeros in account numbers and Rep IDs.
Format columns as text, not numbers.
Projects
The Projects window contains five action buttons and a list of projects.
Button / Column Name | Description |
---|---|
IMPORT | Imports the project data to the system. |
HISTORY | Lists project changes made during a specific period. |
FORMAT | Downloads a data importer template. |
XML TO CSV | Converts .XML files to .CSV. |
CANCEL | Cancels the last unsaved changes. |
ProjectName | A list of Projects in MS Excel format. |
Required Input File | If the project requires an input file (yes/no). |
Description | Description of the project. |
How to Use the Importer
Follow the steps below to import data:
Open the required project.
Download the data importer template.
Enter the data into the MS Excel spreadsheet.
Save the spreadsheet in .CSV format.
Import the spreadsheet.
Examples
Importing Adjustments
Adjustments refer to additional charges applied to a payment made to a producer. Some examples include chargebacks, carryforwards, and bonuses. There are two ways to import adjustments - in bulk through the Importer or one-by-one through the Adjustment Monitor. Both methods can create recurring or one-time adjustments.
To import adjustments:
Browse the History
Use the History feature to view information about the project changes for a specific period.
Undo Feature
The Undo feature allows you to remove a client-side import that did not work as expected.
Important: The Undo feature is only available for five days after the original import.
XML to CSV Conversion
Error Handling
Audience:
Commissions Admins
Super Users
Functionality: The Importer tool allows data uploading to the Compensation and Compliance module database.