Versions Compared

Old Version 83

changes.mady.by.user Gints Vaskums

Saved on

compared with

New Version Current

changes.mady.by.user Gints Vaskums

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Expand
titleView Changelog

Date

Changes

December 2021

Created initial version

December 2023

Updated

March April 2024

Updated

Overview

To access the Importer, click PLATFORM (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 tool for receiving data in a specific format and updating a data area in the software. Different projects are created for different products, like 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

  • Regular adjustment uses a static value for the adjustment (e.g., Deduct 120).

  • Dynamic adjustment uses a formula to calculate the adjustment amount.

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.

00. Importer.png

How to Use the Importer

Follow the steps below to import data:

  1. Open the required project.

  2. Download the data importer template.

  3. Enter the data into the MS Excel spreadsheet.

  4. Save the spreadsheet in .CSV format.

  5. Import the spreadsheet.

Examples

Rw ui tabs macro
Rw tab
titleTrades

  1. Navigate to PLATFORM (1) > Importer (2), select TradesProjectV2.xml (3), and click the FORMAT button (4) to download the data importer template.

  1. Click Enable Editing and enter all available data for each trade record. At a minimum, you must enter all of the following data.

  • TradeEmployeeID (B)

  • CustomerSSN (C) or Company TaxID (D)

  • TypeSSN (E or F)

  • TradeDate (N)

  • SettlementDate (S)

  • ReportingCompany (U)

  1. Save the file as .CSV in a location that is easy to find.

  2. To proceed further, you have to import the data file to jCore.

    1. Navigate to PLATFORM (1) > Importer (2).

    2. Select TradesProjectV2.xml (3).

    3. Click the IMPORT (4) button.

  1. Select the newly created .CSV file and click Open to initiate the import.

  1. The system will display a confirmation message at the end. Click OK.

Rw tab
titleTrails

  1. Navigate to PLATFORM (1) > Importer (2), select TrailProjectV2.xml (3), and click the FORMAT button (4) to download the data importer template.

  1. Click Enable Editing and enter all available data for each trail record. At a minimum, you must enter all of the following data.

  • ReportingCompany (B)

  • EmployeeID (C)

  • CustomerSSN (D) or CustomerAccount (E)

  • CommissionDate (I)

  • CommissionAmount

  1. Save the file as a .CSV in a location that is easy to find.

  2. To proceed further, you have to import the data file to jCore.

    1. Navigate to PLATFORM (1) > Importer (2).

    2. Select TradesProjectV2.xml (3).

    3. Click the IMPORT (4) button.

  1. Select the newly created .CSV file and click Open to initiate the import.

  1. The system will display a confirmation message at the end. Click OK.

Rw tab
titleClient Suitability

  1. Navigate to PLATFORM (1) > Importer (2), select ContactSuitabilityProject.xml (3), and click the FORMAT button (4) to download the data importer template.

  1. Click Enable Editing and enter all available data for each client suitability record.

  1. Save the file on the hard drive in .CSV file format. You have created the data file for import.

  2. To proceed further, you have to import the data file to jCore.

    1. Navigate to PLATFORM (1) > Importer (2).

    2. Select TradesProjectV2.xml (3).

    3. Click the IMPORT (4) button.

  1. Select the newly created .CSV file and click Open to initiate the import.

  1. The system will display a confirmation message at the end. Click OK.

Adjustment Process

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 manually. Both methods can import Recurring or One-time adjustments.

Rw ui tabs macro

Rw tab
titleMethod 1

Adjustment Monitor on Commission Console

  1. To add a new Adjustment, navigate to COMMISSIONS (1) > Adjustment Monitor (2), and click the Add Adjustment button (3).

  1. In the Add Payout Adjustment window, assign the adjustment to an Employee, a Location, a Team, or a Company.

  1. Select theType of Adjustment you want to add.

  1. [Optional] To add a new Adjustment Type, go to the Setup tab (1) and click the Add button (2). Fill in the value in the Payout Adjustment Type window (3). Then click OK.

  1. If it's a one-time adjustment add the Adjustment Date (A). If it's recurring, enter the Effective date range (B). Then click OK.

  1. Click Save in the Employee Detail window.

Rw tab
titleMethod 2

Adjustments Importer Project

  1. Navigate to PLATFORM (1) > Importer (2), select AdjustmentsProject2.xml(3), and click the FORMAT button (4) to download the data importer template.

  1. Click Enable Editing.

Input data to the template. You should enter all the available data for each trade record. At a minimum, youmust provide the following information.

  1. AssigneeCode (B)

  2. Type (C)

  3. Value (D)

  4. StartDate (E)

  5. EndDate (F)

  6. Description (G)

  1. Save the file as .CSV in a location that is easy to find.

  2. To proceed further, you have to import the data file to jCore.

    1. Navigate to PLATFORM (1) > Importer (2).

    2. Select TradesProjectV2.xml (3).

    3. Click the IMPORT (4) button.

  1. Select the newly created .CSV file and click Open to initiate the import.

  1. The system will display a confirmation message at the end. Click OK.

Anchor
history
history
Browse the History

Use the History feature to view information about the project changes for a specific period.

Rw ui steps macro
Rw step

In the Project window, click HISTORY (1). The system will open the History window (2).

Rw step

Specify the period Date from and Date to (1), select Project (2) you are interested in (or all projects), and click FILTER (3).

The system will display a list of projects with changes.

History Results

Undo Feature

The Undo feature allows you to remove a client side import that did not work as expected or you've done something wrong.

Note: Please keep in mind that our Undo feature is only available for up to five days after the original import.

Rw ui steps macro
Rw step

To undo the import, find the project using the History feature (see section History).

Rw step

Select the Project (1) and click UNDO (2).

The system will remove the selected project.

XML To CSV Conversion

Rw ui tabs macro
Rw tab
titleExample 1

Example 1

  1. To convert the .XML file to .CSV format, select the project file (1) and click XML TO CSV (2).

  1. Choose XML data file (1) and click Open (2).

  1. After the file has been converted, the system will display a message to confirm the completion of the task. Click OK.

The converted file is saved in the .CSV format.

Rw tab
isMissingRequiredParameterstrue

Example 2

28. Conversion-4.png

Some data files may be unformatted (flat). Finding specific values within the file can be challenging, even if you know what data it contains. To simplify this task, use the XML to CSV feature. This feature organizes the data into columns in a .CSV file, making it easier to identify and edit information. You can then easily modify the .CSV file, similar to working with an MS Excel file, and upload it.

  1. To convert the flat file to CSV format, select the project file for flat file converting (1) and click XML TO CSV (2).

  1. Instead of the .CSV file, choose the flat .TXT file (1) and click Open (2).

Once the system has converted the file, it will display a message confirming the completion of the task. The system saves the converted file in the .CSV format.

Error Handling

Rw ui steps macro
Rw step

Select Project (1) and click IMPORT (2).

Rw step

Navigate to the project .CSV file to import.

Errors-2.png

Rw step

The importing process has started.

Errors-3.png

If the Importer detects an error, it will display an error message. Click the Error Report link.

Rw step

Click the Error Log >> link.

Rw step

The Error Log window displays the description of the error. Go to the project .CSV file and fix the error.

Audience:

  • Commissions Admins

  • Super Users

Info

Functionality:The Importer tool allows data uploading to the Compensation and Compliance module database.