Data Migration - Customer Data Import

Summary

This article covers the recommended and proper order for importing customer data into EngageIP. When importing large amounts of data it is recommended to use the DataMigration Utility.

Before you can proceed with any import process here please follow the article: Data Migration – Import Methods and Configuration.

XML Format

Importing Owner Accounts

See the System Configuration Import kb article for details on importing Owner accounts.

Importing User Accounts

Importing Account Contacts

Importing Account Contact's Email Address

• 'Email Address' contact point type must exist, no other names will be found by the system

• Contact Name = Firstname + Lastname on the contact

Importing Account Contact's Phone Number

Importing Account Contact's Fax Number

Importing Extra Contact Data

If you need to make more contact points besides the ones already available, of if you want to rename them, you can use this below xml to import differently named or extra contact points.

Logisense Corporation = Your owner

ContactPointType  = the name of your contactpoint you want to add, ie, Phone Number, Email Address, Extra Info

Value = the data to be added on customer

ContactID = the id of the contact on the customer account you need this added to, i.e. hover over the billing contact link on the contact page to find its ID

Importing Company Details on Contacts

Importing Child Accounts

Sets up child account relationships between accounts. This can be at any level.

Importing Account Invoices

To Add Debits

For taxes to import, ensure you have a taxcode that exists and that the taxcode also has tax rates associated, up to four rates if you want the rates to associate here. Without this config, the tax value will be ignored.

Sample Debit import file:

Open

To Add Credits

As of EngageIP 9.3.8, you can specify the bulk amount which multiplies the amount value for credits

If you want to import a set of 'transactions' and then close the invoice before adding more 'transactions', use the close tag:  <CloseInvoice CloseInvoice="" />

ApplyTax element tells the system to calculate a tax on the import of this credit

Template credit import file: 

Open

For example, the below will create two invoices. One for January (then you can see the close tag) and another for February (with another close tag after it). So you can group these 'transactions' into their individual invoices as needed.

For Payments

The generic method is below, this allows more elements such as defining the PaymentType so you can enter credit card or other predefined types.

NOTES:

• Automatic disbursement is NOT checked when you enter an Invoice. There is no way to tell this method to mark a payment as autodisburse when an invoice value is present. When the payment is imported, it IS disbursed to the invoice specified as much as it can be, if it is more than the invoice, the left over amount sits undisbursed and the payment is not set as auto disburse and will need to be manually fully disbursed

• If you leave invoice blank, the payment WILL be set to automatic disburse, BUT it will not disburse until something triggers it on the account, a new debit is created, or billing closes aninvoice perhaps

• If the invoice is specified, it will tag itself to the invoice selected for display purposes in addition to disbursement purposes. If you do NOT want the payment to show potentially on an old invoice, rather you would like it to be available to display on the next open invoice, leave this blank

Where invoice = name of the invoice (not necessarily the ID)

Importing Opening Balances

When moving data from another system to EngageIP, often you will want to import existing debit or credit balances for historical purposes. The correct procedure would be to import a debit or credit as shown above, and then close the invoice and mark it as delivered.  Its suggested that you create a service called 'Opening Balance' to be used to tag to the amount imported for reporting purposes. The balance of the created invoice will then move forward onto the 'real' invoices as a previous balance whether credit or debit.

1. Create 'Opening Balance' service

2. Add a transaction to a user (via import or manually)

   • Enter the amount of the existing balance (add transaction for debit balance, add credit for a credit balance)

   • Select the service as 'Opening Balance'

   • Add date as required

3. A new invoice will be generated if one does not already exist on the account, close this invoice

4. Mark invoice as printed. Check the box beside the invoice and click 'Printed'. This will ensure the invoice does not get sent to the customer.

Importing Account Payments

Importing UserPackage

The account's package. An account can have multiple packages which will bill according to their Bill Cycle. Any package added which does not match the billing cycle will be prorated to the account's bill cycle. .

For below, click 'Use Generic':

Importing UserService

This is a generic method for importing user-services (non-optional)

Importing Optional UserService

Importing UserPackageAttributeDiscount

User Package Discounts - allows the import of discounts that are attached specifically to the customer (if not a system wide package discount).

Importing Setup Tab / Package Services

• Attach services to packages in EngageIP

Importing UserAttributes

Apply expiry date to user account

UserAttributeChangeUserStatusType

For correct prorating, ensure that the time is completed as well, in this case, the end of day on the 31st is when the account should be canceled and if prorating applies, that will be considered

UserAttrbiutePrintGroup

The telecom attribute attached to services at the account level

The telecom bucket assigned to the account's service

Profile Answer Import

The name needs to be exactly as shown on the setup page for the service or the profile question under the Role. This IS for Role profile questions and Service profile questions

Profile Answers Import for Parent/Child Profile hierarchy questions

Applies TaxClass to user specifically

Applies Taxcode to user - as seen on Overview of account

UserAttributeTaxExempt Component

UserAttributeTaxExemptLevels

UserAttributeNote

Misc Notes from users, Type must define the 'Note Type' as specified on the setup tab. There may be one or more note types as of version 8.3.x. If nothing exists, add 'Default' as the note type and it can be used to import notes to that type. When using branded owners, the generic method needs to be used:

Generic method:

When using branded owners, the generic method needs to be used:

Importing UserExtendedAttributes

UserPackage and UserPackageExtendedAttribute:

The below will import a userpackage, along with the associated UserPackageExtendedAttribute

Importing UserExt Profile Answers

Where ‘market’ is the profile question name, ‘a’ is the answer to that profile question you want to import and ‘admin’ is the user it should be assigned to. On import screen, do not select generic even though this is a generic import style.

Importing UserPackageAttributes

Import UserAttributeChangeUserPackageStatusType

NOTE: This uses the generic method requiring that you know and insert the correct owner specific IDs for the status types (StatusTypeID, UserPackageStatusTypeID), and also the specific user package ID you want to associate this change to.

Importing UserServiceAttributes

Importing UserServiceAttributeContact

UserServiceAttributeTelecom

Importing UserServiceAttributeTelecomBucket

Importing UserServiceTechData

Importing UserServiceAttributeProfileAnswers

Import answers for user services if there is a profile question on the service. NOTE: If more than one service of the same name exists on an account, the profile answer will be completed for each of those instances. If you need this to be specific per user service ID, use the generic method further below

Generic Method here allowing you to import to a specific userserviceID:

Importing UserServiceResource attachment

the xml below allows you to import resources to a user service and to specify which user service to attach it to based on the userserviceID. The IDs would need to be found in the database (select id from userservice where...)

Importing Account Tickets

Importing Ticket Tracking Records

Ticket Tracking records are the detail attached to the ticket, the inline comments or appended text on tickets.

An example of the ticket tracking XML is shown below:

Importing Ticket Attachments

With Ticket Attachment, you can import attachments to tickets. Any file can be attached. If there are errors, check the size of the attachment as files over 2 MBs may produce errors. If this is a concern, attempt to import a large file by itself to confirm that it will import without issue.

Importing Payment Methods

Importing UserPaymentMethodCash

Importing UserPaymentMethodCreditCard

Importing UserPaymentMethodCheck

Importing UserPaymentMethodACH

The first line below adds the UserPaymentMethod object and creates a reference to it to be used in the UserPaymentMethodACH object.