Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Next »

Summary

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

For information on how to generate the XML for import see the KB Article: Data Migration – Creating XML to Import

For information on importing specific data for instance system configuration settings or customer data see the Additional Data Import Guides section at the bottom of this article.

Data Import Methods

Note: you can import data via the API (webservices). Go to your Webservices file and search for 'XMLImport' to find the requirements and formatting.

There are currently three methods for importing XML data:

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

  • Via the AdminPortal interface (Setup tab / Import)

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

AdminPortal Import Utility

The Import functionality in the AdminPortal is suitable for importing small amounts of data. The interface will not import data if there is an error, it will roll back any changes so that you can address the issue and attempt the import again.

To access the AdminPortal XML Import:

  1. Access the Setup tab 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

    • Legacy Mode - enable to maintain compatibility with older import files

    • Use Generic XML - enable to import data using basic table and column mapping, do not use specific/advance importing logic for particular tables/records

    • 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

Designed to import data into the EngageIP Billing application through XML it allows you to reset a database quickly and import a single or predefined list of files. When run, the database migratory tool looks for XML Elements which can be combined into one file if you wish. Configuring the migrator is done within the DatabaseMigrator.exe.config file.

Located usually here: C\Program Files\EngageIP\DatabaseMigrator\

Sample Configuration File

<?xml version="1.0"?>
<configuration>
<appSettings>
<add key="SQLServer" value="(local)"/>
<add key="SQLDatabase" value="boss"/>
<add key="SQLServerUser" value="boss"/>
<add key="SQLServerPassword" value="boss"/>
<add key="path" value="..\..\XML"/>
<add key="Current1SQLConnectionString" value="server=192.168.1.169;Trusted_Connection=false;database=current1sql;uid=boss;pwd=boss;Timeout=3000"/>
<add key="BossConnectionString" value="server=localhost;Trusted_Connection=false;database=boss;uid=boss;pwd=boss;Timeout=3000"/>
<add key="ErrorLogging" value="false"/>
<add key="RollBackOnError" value="false"/>
<add key="CreateWorkFlowEvent" value="false"/>
<add key="UseGenericXML" value="false"/>
</appSettings>
<startup><supportedRuntime version="v2.0.50727"/></startup></configuration>

Note:

  • RollBackOnError - if TRUE, it will not import any data on error. It will wait until ALL import data passes before committing

  • Current1SQLConnectionString - this is a legacy connection point to EngageIP 6 databases

  • If ErrorLogging is TRUE, the log file will drop in the folder where the EXE is run from or in the folder where the XML import file was loaded from if different than the EXE location

Configuration File Options:

  • SQLServer - The sql server to use.

  • SQLDatabase - The database to import into.

  • SQLServerUser - A valid user with valid permissions.

  • SQLServerPassword - The password for the user.

  • BossConnectionString - The full connection string to the server.

Note: This tool will also show two buttons for disbursing payments (usually used after import) and a textbox where you can enter the name of a single account you wish to manually disburse payments on. Click 'Disburse User Payment' to disburse just the user account you have entered in the textbox beside it. If you simply wish to have the tool disburse all payments set as automatic disburse, click 'Disburse Payments'. This tool will ONLY disburse those payments that are already checked as 'automatic disburse'. Any payments not marked as such will not be disbursed. Also, deposit payments will not be disburse, these will need to be manually disbursed, or changed to payments and marked as 'auto disburse' before the tool will look at them for disbursal.

Resetting Database Using MDF Files

The database migratory tool will look for a file named after what is defined in the SQL Database section for the config file.

It will then detach the existing database and copy the one defined to the new (if different) location only if Reset Database is checked.

For Example, the SQL Database name is EngageIP. The Database Migratory Tool will look for EngageIP.MDF in the executing directory which it will use to reset the database by first detaching the original database then reattaching this new MDF.

The final step is the import which happens once the above is complete. You have the option to import a single file or defining a list of files in the importfiles.txt file.

Database Migrator Usage

Note: The order of the following is very important. Make sure that you follow the steps as outlined below.

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

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.

You may also wish to setup your owner structure prior to importing your accounts manually.

Database Migrator XML Files

Note: XML files should be imported in the following order. Each import section will include a table which defines, describes, and provides applicable options or v
alid data that should or can be inserted in to the import file.

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.

Once configuration is imported, use the customer data import doc.

Additional Data Import Guides

  • No labels