Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents

Summary

This article covers the recommended and proper order for importing data in to EngageIP Billing

...

  • Via the Import EXE utility available in the adminportal folder on your webserver

  • Via the AdminPortal interface (Setup tab page / Import)

  • Via API (Webservices) - Method is called 'XMLImport'

...

To access the AdminPortal XML Import:

  1. Access the Setup

...

  1. page in the AdminPortal

  2. Under the Configuration heading click on Import

  3. On the import interface either Choose File or paste in the XML Data to the imported into EngageIP

    Image Modified
    • Legacy Mode - enable to maintain compatibility with older import files. Most of the XML found on the following articles are standard or legacy XML files. They will import data using logic and validation similar to the UI. Data Migration - System Configuration Import Data Migration - Customer Data Import Normally this mode should be used as its the most simple format and it provides better data validation on import. If legacy mode XML cannot be found on the above two articles, generic can be used. Note that there are a few generic xml examples (requiring IDs as opposed to item names) in the above two as well, if generic, they are marked as such and require the ‘Use Generic XML’ to be selected. You should not use both Legacy and Generic at the same time, use one or the other depending on the type of XML required.

    • Use Generic XML - enable to import data using basic table and column mapping, do not use specific/advanced importing logic for particular tables/records. Generic XML is that which is pulled from the Database Schema, its a raw import and it uses IDs of items such as User Status Type IDs as opposed to the common name of ‘Enabled’ for example. Its more versatile but also not fully documented. NOTE: Generic method imports raw data to the tables, it will not trigger logic such as for payment disbursement related to the data or other items that may be triggered with the regular import related to the data imported.

    • Create Workflow Event - enable to trigger workflow events while records are created/updated/deleted

  4. Click Save when finished

  5. If errors are returned address them in the XML Data/XML File (if using a file it will need to be imported again after the issues are addressed)

  6. Repeat this process as needed until the data passes validation and has been successfully imported

DataMigration Utility Overview

...

Info

Note: observing the order of steps below is very important.

  1. Make sure that any linkage tables are first imported so they exist before you add the core tables

  2. Edit importfiles.txt to set the order you would like, from here you can add or remove any files from this list. The name of the file is not important however the XML Tag is. Combining contacts and contact points in one file is possible if desired, as long as they are ordered correctly in the files, however single files can be imported at any time.

Be sure to backup your database when it's in a condition ready for import.

...

Note

IMPORTANT! Be sure that all Bill Groups, Roles, and Languages exist for the owner in the MDF.

Variable Name

Short definition or description of use

Valid data or entries including format that is accepted by the migrator

Username

The name of a user account or numeric identifier

John Wayne or jwayne or ACCT112204902 or Company X

 

To use Microsoft Excel, you can import the sample XML to use as a framework.

  1. Open MS Excel

  2. Click Data

  3. Select XML then click XML Source

  4. Select the generic XML Sample file

  5. Click Open

  6. On the right hand side, the XML format is displayed

  7. Click Owners for example and drag it into the active sheet and then you can populate the rows accordingly

So now once all this is complete, start importing system configuration using the configuration import article.

...