Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Info

Note: SortOrder is supported on some of the imports listed below and they will have the element included in the example where supported. The list is also here:

  1. Culture

  2. Language

  3. Country

  4. TicketCategory

  5. TicketContactMethod

  6. TicketPriority

  7. TicketGroup

  8. TicketStatus

  9. State

  10. County

  11. City

The element to add into the xml would be this: SortOrder="1" or any number. 0 being default, and 1,2,3, and so on being the orders where the lowest number floats to the top of the dropdown list in EngageIP

...

Code Block
languagexml
<InvoiceTemplate Name="English" Owner="admin" InvoiceTemplate="<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
version="1.0"><xsl:template match="Invoice">
</xsl:template>
</xsl:stylesheet>" />

Character Name

Entity Reference

Character Reference

Numeric Reference

Ampersand

&amp;

&

&#38;#38;

Left angle bracket

&lt;

<

&#38;#60;

Right angle bracket

&gt;

>

&#62;

Straight quotation mark

&quot;

"

&#39;

Apostrophe

&apos;

'

&#34;

Name

Invoice Title or Name to appear in AdminPortal

English or ‘Residential Customer Invoice – 2 Page’

Owner

Name of the Owner that the role applies to

This will be based on previous import

InvoiceTemplate

This is the html / xml code that will be entered

Any valid HTML template code Is allow here and editable from interface

Bill Groups Import

BillGroups available to the owner.

Code Block
languagexml
<BillGroup Name="" AdvanceInvoiceDays="" Owner="" SortOrder="" BillDay="" InvoiceCloseType="" InvoiceDateProcessType="" InvoiceCloseThresholdAmount="" UsageBillingType="" InvoiceDueDateType="" UsageBillDay="" InvoiceConfiguration="" />

BillGroup

Name of billgroup

‘Credit Card Bill Group’ or ‘Residential Bill Group’

InvoiceTemplate

Name of invoice template you want customers with this billgroup to use

this will be based on previous import, and in the system

Owner

Owner name

this will be based on already imported owner names

AdvanceBillDays

Numerical value representing the number of days to prebill accounts

0,1,2,30,45, etc

Country Imports

Owner’s Countries

Code Block
languagexml
<Country Country="France" Owner="Quality_Assurance" SortOrder="0" />

Country

Country name

‘United States’ or ‘Canada’

Owner

Name of the Owner the country belongs to

  • this will be based on previous import

CountryAddressFormat

The formatting as created on the setup page

'Address Level 1' or 'Canadian Address Format'

 

Full Country Listings

Country Code Format

...

Code Block
languagexml
<County Country="Canada" State="Ontario" County="Wellington" Owner="Quality_Assurance" SortOrder="0" />

County

Name of county, or municipality

‘Brock’, ‘York Township’

State

Name of State or province

‘Idaho’ or ‘Prince Edward Island’

Owner

Name of the Owner the country belongs to

this will be based on previous import

City Imports

Owner’s Cities. Note the links between State, County and City. A city is associated with a county. If a city has more than 1 county it must be entered twice.

Code Block
languagexml
<City Country="USA" State="FL" County="Broward" City="Hollywood" Owner="ACME1" SortOrder="0" />

Country

Country name

‘United States’ or ‘Canada’

State

Name of State or province

‘Idaho’ or ‘Prince Edward Island’

County

Name of county, or municipality

‘Brock’, ‘York Township’

City

Name of City

‘Toronto’ or ‘New York’

Owner

Name of the Owner the country belongs to

this will be based on previous import

DisableReason Imports

Owner’s Disable Reasons

Code Block
languagexml
<DisableReason DisableReason="Cancelled" DisableType="C" Owner="Quality_Assurance" />

Disable Reason

Text name of disabled reason

‘Cancelled’ or ‘Suspended’

DisableType

Single Alpha character denoting the type of disable

C = Cancelled S = Suspended

Owner

Name of the Owner the country belongs to

this will be based on previous import

Service Imports

Defines Service offerings.

Code Block
languagexml
<?xml version="1.0"?>
<Service Name="HighSpeed Wifi unlimited" Type="Day" SKU="HWU" ShowOnTicketTransaction="Yes" BillingPeriodType="Default" Inactive="No" InvoiceIdentifier="test" Description="test" BaseFee="0" CreatedDate="mm/dd/yyyy" BaseTimeUnit="1" BaseTimeUnitType="1" Owner="admin" ServiceLength="1" ServiceType="Owner=admin/ServiceType=Test"/>

NOTE: Setup fee if zero doesn't do anything when importing, its held over from the migration from EngageIP 6 to EngageIP 8

NOTE: This is the CORE service.

Name

Name of account under which payment should b e applied. May be a child of bsmith as shown in above example

‘bsmith’ or a child of bsmith ‘frank’

Code

Transaction code as already entered on setup page. Adds as a component on services

‘DSL’ or ‘Access Service’

BaseFee

Value of base fee

’30.00’

SetupFee

Value of setup fee

’30.00’

ServiceLength

Numeric value of service length

‘1’, or ‘12’ or any other number

ServiceType

Type of service

‘AccessService’, ‘Dialup’, these will be preconfigured in Adminportal

Owner

Name of the Owner that the role applies to

this will be based on previous import

Type

This is the period type which modifies the service length. A monthly service would hav ea servicelength of 1, and the Type would be ‘MONTH’

Values: Once Minute Hour Day Week Month Year

Description

Description of the service

‘Monthly Postpaid Dialup Service’

ServiceTypes Import

Code Block
languagexml
<ServiceType Name="Service_Type_Name" Owner="/Owner=Quality Assurance"/>

...

NOTE: The 'code' element above in RED is not required, this is a value used in the migration from EngageIP 6 to EngageIP 8. Packages can be imported without this field.

Name

Name of package

DSL Lite Monthly 512

SKU

Short form name for Package

‘DSLLT512’

Code

Transaction code

‘DSL’ or ‘Access Service’

PackageLength

Numeric value of service length

‘1’, or ‘12’ or any other number

Type

This is the period type which modifies the service length. A monthly service would have a service length of 1, and the Type would be ‘MONTH’

Values: Once Minute Hour Day Week Month Year

Description

Description of the package

‘Monthly Postpaid Package’

 

 

 

Owner

Name of the Owner that the role applies to

this will be based on previous import

Package Quantity Import

Allows the import of package quantity for services if no other quantity component exists on the package for specified service.

...

Code Block
languagexml
<PackageService Package="Annual DSL Package" Service="DSL" Owner="Quality_Assurance"/>

Package

Name of the package that will show to the customer and in reports

  • this package should exist from previous import of package.xml

Service

Name of the service

  • this service should exist from previous import of service.xml

Owner

Name of the Owner that the role applies to

  • this will be based on previous import

Profile Question Imports

Account Profiles Questions.

...

  • Text

  • Integer

  • Double

  • Date/Time

  • Date

  • Password

  • Address

  • Postal Code

  • Email

  • Phone

  • CreditCard Number

  • CVV

  • CreditCard Expiry Date

  • Full Name

  • Bank Routing Number

  • Bank Account Number

  • Currency

  • IP Address

  • Memo

  • Encrypt

  • Domain Name

  • MAC Address

  • Port

  • Script

  • Time

  • Terms

  • Day Of The Month

  • Path

  • URL

  • Usage Phone Number

  • File

Name

Name of the profile

‘Profile question 1- name of cat’

Question

Value that is represented in interface when adding package, usually the question you need answered

value of the answer here

DataType

Driven from the Data Types table using the REGEX values defined here.

These names represent the format of the intended data. Name like ‘John Smith’. Email like ‘userame@domain.com’IP Address like ‘192.168.1.1’ ========== Name Text Integer Double Date/Time Date Password Address Postal Code Email Phone CreditCard Number CVV CreditCard Expiry Date Full Name Bank Routing Number Bank Account Number Currency IP Address Memo Encrypt Domain Name MAC Address Port Script Time Terms Day Of The Month Path URL Usage Phone Number File Duration

Length

Value of charactors if the number of charactors need to be restricted

15

Required

Defines whether profile question is required when adding service or whether it can be left blank

‘True’ or ‘False’

Default

The default answer to be prepopulated

‘192.168.1.1’, or ‘my favourite colour is blue’

GeneralLedger Imports

Defines General Ledger Codes

Code Block
languagexml
<GeneralLedger Name="GLTEST" GLDebit="AR" GLCredit ="Sales" Owner="Quality_Assurance"/>

Name

Name of GL Code

‘Credit GLCode’

GLDebit

Debit code

‘AR’

GLCredit

Credit Code

‘Sales’

Owner

Name of the Owner that the role applies to

this will be based on previous import

RestrictedUserName Imports

...

Code Block
languagexml
<RestrictedUserName User="admin" Owner="test"/>

User

Name or letter combination that is restricted

English or ‘Residential Customer Invoice – 2 Page’

Owner

Name of the Owner that the role applies to

this will be based on previous import

Inventory Importing


InventoryItemDefinitionCategory

...

Code Block
languagexml
<CardType CardType="American Express" Owner="Quality_Assurance" />

CardType

Name of the card

Visa, Mastercard, American Express

Owner

Name of the Owner

this will be based on previous import

TaxCode Importing

Owner’s Tax Codes which are made up of Tax Rates.

...

TaxType = Service Tax Category
TaxClass = Account Tax Category (read further down for XML here)

TaxCode

Taxcode name, or identify of taxcode, descriptive

‘Ontario Tax’ or ‘USA’

Owner

Name of the Owner the country belongs to

this will be based on previous import

Country

Country name

‘United States’ or ‘Canada’

County

Name of county, or municipality

‘Brock’, ‘York Township’

City

Name of City

‘Toronto’ or ‘New York’

Generic Taxcode Import

Code Block
languagexml
<GenericXML Enabled="True" />
<TaxCode Owner="/Owner=Logisense Corporation" Country="/Owner=Logisense Corporation/Country=Canada" State="/Owner=Logisense Corporation/Country=Canada/State=Ontario" Name="TaxCodeTest" TaxVendor="/Owner=Logisense Corporation/TaxVendor=Generic Tax Import"/>

...

Code Block
languagexml
<TaxRate Owner="Quality_Assurance" Rate="0.05" Description="Tax1" DisplayName="Tax1"/>

Owner

Name of the Owner the country belongs to

this will be based on previous import

Rate

Value of the rate

0.05 = 5%, 0.1 = 10%, 1.00 = 100%

Description

Description of the tax rate for internal purposes

Ex: 6% tax for Atlanta, USA

DisplayName

Name to show invoice or to customers in a customer portal

‘Atlanta Sales Tax’, or ‘ Goods and Services Tax’

TaxCodeRate Imports

Owner’s Tax Code Rates. This represents the link between tax codes and tax rates.

Code Block
languagexml
<TaxCodeRate Owner="Quality_Assurance" TaxCode="USA" TaxRate="TAX1" />

Owner

Name of the Owner the country belongs to

this will be based on previous import

TaxCode

Taxcode name, or identify of taxcode, descriptive

‘Ontario Tax’ or ‘USA’

TaxRate

Description of the tax rate for internal purposes

Ex: 6% tax for Atlanta, USA

TaxType Importing

(AKA Service Tax Category)This is the tax grouping for services used in conjunction with the tax codes.

Code Block
languagexml
<TaxType TaxType="Service IP" Owner="Quality_Assurance"/>

TaxType

Descriptive name of taxtype

‘Access Tax’, ‘Residential Tax’

Owner

Name of the Owner the country belongs to

this will be based on previous import

TaxClass Importing

This is Account Tax Category in the AdminPortal UI.

...

Code Block
languagexml
<TransactionCode TransactionCode="Monthly Fee" Owner="Quality_Assurance"/>

TransactionCode

Descriptive name of transaction code

Debit, Credit, Refund, Charges, Sale

Owner

Name of the Owner the country belongs to

this will be based on previous import

TicketCategory Importing

Owner’s Ticket Categories

Code Block
languagexml
<TicketCategory Category="Support" Owner="Quality_Assurance" SortOrder="0" />

Category

Descriptive name of ticket category

Support, Billing, Administrative

Owner

Name of the Owner the country belongs to

this will be based on previous import

TicketGroups Importing

Code Block
languagexml
<TicketGroups>
<TicketGroup Name="Support" Owner="admin" SortOrder="0" />
<TicketGroup Name="Accounting" Owner="admin" SortOrder="1" />
</TicketGroups>

...

Code Block
languagexml
<TicketPriority Priority="Normal" Owner="Quality_Assurance" />

Priority

Ticket Priority levels

Low, Medium, High, Critical

Owner

Name of the Owner the country belongs to

this will be based on previous import

ContactType Imports

Owner’s Contact Types. It is important that you define the contact types required with the appropriate contact points.

Code Block
languagexml
<ContactType Name="Billing Contact" Owner="Quality_Assurance" BillingContact="True" EmailContact="True" ServiceContact="True" Required="True"/>

Name

Name defining contact type

Billing Contact, Admin Contact, Technical Contact

Owner

Name of the Owner the country belongs to

this will be based on previous import

BillingContact

Defines whether this contacttype will be used for billing

True or False

EmailContact

Defines whether this contacttype will be used for emailing system emails

True or False

ServiceContact

Defines whether this contacttype will be used for service contact requests

True or False

Required

Defines whether this contact is required to be completed when adding customer accounts

True or False

...

User Extended Attributes 

Code Block
<?xml version="1.0"?>
<UserExtendedAttributes>
<ProfileQuestion DataType="/DataType=Text" Name="UserExtQuestion" Question="UserExtQuestion" Required="False" UniqueAnswer="False" IncludeInInvoiceXML="False" ShowOnViewFilter="False" ReferenceName="pqUserExt1" />
<UserExtendedAttribute Owner="/Owner=Logisense Corporation" ProfileQuestion="@pqUserExt1" />
</UserExtendedAttributes>

ContactPointType Imports

Owner’s Contact Points related to the Contact Type. These are the contact points available to Contact Types and MUST be well defined.

Code Block
languagexml
<ContactPointType Name="Address" Owner="Quality_Assurance" ContactType="Billing Contact" DataType="Address" Required="True"/>

Name

Descriptive name of ticket category

Support, Billing, Administrative

Owner

Name of the Owner the country belongs to

this will be based on previous import

ContactType

Name of contact type

this will be preconfigured in the system for contact types on the setup page

DataType

Variable data type, defined in database

These names represent the format of the intended data. Name like ‘John Smith’. Email like ‘userame@domain.com’IP Address like ‘192.168.1.1’ ========== Name Text Integer Double Date/Time Date Password Address Postal Code Email Phone CreditCard Number CVV CreditCard Expiry Date Full Name Bank Routing Number Bank Account Number Currency IP Address Memo Encrypt Domain Name MAC Address Port Script Time Terms Day Of The Month Path URL Usage Phone Number File Duration

Required

Defining whether this contact point is required when adding the user account

Values: ‘True’ or ‘False’

Languages Import

Allows the importing of language translations. You must have entered the language name already on the setup page for each owner you need to import translations for.

Steps to import translation xml files into EngageIP

  1. locate the language ID from the language table

  2. delete * from translations where languageID = X

  3. use DB migrator to import the xml.

For generic translation xml files be sure to find and replace the owner with the correct owner for import.

...

Code Block
languagexml
<?xml version="1.0" encoding="iso-8859-1" ?>
<Translation Name="A detailed description of the service" Value="Descripción detallada del servicio" LanguageID="5"/>

Name

Word in English that is to be translated

Word to be translated, ie 'Name'

Value

The word which replaces the name field

'Nom' (French for 'Name'

Owner

Owner that this translation applies to

LogiSense Corporation

Language

Language that the value will apply to

'French'

Role Imports

Specifies the roles available to each owner.

Code Block
languagexml
<Role Role="Parent" Owner=" Quality_Assurance "/>

Role

Name of the permissions set you wish to apply to a customer

Will be based on previous import

Owner

Name of the Owner that the role applies to

this will be based on previous import

 

Role Permissions

Code Block
languagexml
<RolePermissions Role="/Owner=Logisense Corporation/Role=Admin" Name="BillUser/Edit_test" />

...