| Table of Contents |
|---|
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 complete the kb article: Data Migration – Import Methods and Configuration.
Import Examples
| 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: |
Culture
Language
Country
TicketCategory
TicketContactMethod
TicketPriority
TicketGroup
TicketStatus
State
County
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
Owners Import
allows Allows you to setup your owner structure.
| Code Block | ||
|---|---|---|
| ||
<?xml version="1.0"?> <Owners> <Owner Name="Owner Import Test" Parent="Test Telecom" Role="Admin" Culture="English" Currency="USA" Language="English" OwnerParentAccountBillingType="Bill Owner Using Owner Taxes" BillGroup="Main Bill Group" CreditRating="Default" Branded="True" Country="True" State="False" County="False" City="False" UserStatusType="Enabled" /> </Owners>[cce lang="xml"] |
| Info |
|---|
Note: With regards to OwnerParentAccountBillingType="" result can be any of the following choices: Bill Accounts, Bill Owner Using Account Taxes, Bill Owner Using Owner Taxes, Bill Top Owner Using Account Taxes and finally Bill Top Owner Using Owner Taxes. |
Branded indicates if the owner is Branded (presents owner account with a Setup Menu allowing for their own configuration options which will apply to all accounts under them) or Non-branded (inherits configuration of brandedowner above them).
Country/State/County/City allows you to set the INPUT level of the address. For example, if they are all true, then pick lists will appear within the system. If they are false free form text fields will appear.
| Info |
|---|
Note: Parent is the Owner below which you want to import this owner. 'Admin' is the owner by default that is installed with EngageIP. |
Owner Page Extension Import
| Code Block |
|---|
<?xml version="1.0"?> <PageExtensions> <PageExtension Name="TestPageExtension" Owner="/Owner=Logisense Corporation" Page="child/add" Script="return true" /> </PageExtensions> |
...
Invoice templates available to the owner.
| Code Block | ||
|---|---|---|
| ||
<InvoiceTemplate Name="English" Owner="Quality_Assurance" InvoiceTemplate="English" />
|
Your invoice template will go in the InvoiceTemplate element, however before you import, you need to use ascii characters in place of 5 key characters to allow the import. Example:
| Code Block | ||
|---|---|---|
| ||
<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 | & | & | &#38; |
Left angle bracket | < | < | &#60; |
Right angle bracket | > | > | > |
Straight quotation mark | " | " | ' |
Apostrophe | ' | ' | " |
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 | ||
|---|---|---|
| ||
<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 | ||
|---|---|---|
| ||
<Country Country="France" Owner="Quality_Assurance" SortOrder="0" /> |
Country | Country name | ‘United States’ or ‘Canada’ |
Owner | Name of the Owner the country belongs to |
|
CountryAddressFormat | The formatting as created on the setup tab | 'Address Level 1' or 'Canadian Address Format' |
Full Country Listings
Country Code Format
| Code Block | ||
|---|---|---|
| ||
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <Country> <Country Country="AF" Owner="admin" SortOrder="0"/> <Country Country="AX" Owner="admin" SortOrder="1"/> <Country Country="AL" Owner="admin" SortOrder="2"/> <Country Country="DZ" Owner="admin" SortOrder="3"/> <Country Country="AS" Owner="admin" SortOrder="4"/> <Country Country="AD" Owner="admin" SortOrder="5"/> <Country Country="AO" Owner="admin" SortOrder="6"/> <Country Country="AI" Owner="admin" SortOrder="7"/> <Country Country="AQ" Owner="admin" SortOrder="8"/> <Country Country="AG" Owner="admin" SortOrder="9"/> <Country Country="AR" Owner="admin" SortOrder="10"/> <Country Country="AM" Owner="admin" SortOrder="11"/> <Country Country="AW" Owner="admin" SortOrder="12"/> <Country Country="AU" Owner="admin" SortOrder="13"/> <Country Country="AT" Owner="admin" SortOrder="14"/> <Country Country="AZ" Owner="admin" SortOrder="15"/> <Country Country="BS" Owner="admin" SortOrder="16"/> <Country Country="BH" Owner="admin" SortOrder="17"/> <Country Country="BD" Owner="admin" SortOrder="18"/> <Country Country="BB" Owner="admin" SortOrder="19"/> <Country Country="BY" Owner="admin" SortOrder="20"/> <Country Country="BE" Owner="admin" SortOrder="21"/> <Country Country="BZ" Owner="admin" SortOrder="22"/> <Country Country="BJ" Owner="admin" SortOrder="23"/> <Country Country="BM" Owner="admin" SortOrder="24"/> <Country Country="BT" Owner="admin" SortOrder="25"/> <Country Country="BO" Owner="admin" SortOrder="26"/> <Country Country="BQ" Owner="admin" SortOrder="27"/> <Country Country="BA" Owner="admin" SortOrder="28"/> <Country Country="BW" Owner="admin" SortOrder="29"/> <Country Country="BV" Owner="admin" SortOrder="30"/> <Country Country="BR" Owner="admin" SortOrder="31"/> <Country Country="IO" Owner="admin" SortOrder="32"/> <Country Country="BN" Owner="admin" SortOrder="33"/> <Country Country="BG" Owner="admin" SortOrder="34"/> <Country Country="BF" Owner="admin" SortOrder="35"/> <Country Country="BI" Owner="admin" SortOrder="36"/> <Country Country="KH" Owner="admin" SortOrder="37"/> <Country Country="CM" Owner="admin" SortOrder="38"/> <Country Country="CA" Owner="admin" SortOrder="39"/> <Country Country="CV" Owner="admin" SortOrder="40"/> <Country Country="KY" Owner="admin" SortOrder="41"/> <Country Country="CF" Owner="admin" SortOrder="42"/> <Country Country="TD" Owner="admin" SortOrder="43"/> <Country Country="CL" Owner="admin" SortOrder="44"/> <Country Country="CN" Owner="admin" SortOrder="45"/> <Country Country="CX" Owner="admin" SortOrder="46"/> <Country Country="CC" Owner="admin" SortOrder="47"/> <Country Country="CO" Owner="admin" SortOrder="48"/> <Country Country="KM" Owner="admin" SortOrder="49"/> <Country Country="CG" Owner="admin" SortOrder="50"/> <Country Country="CD" Owner="admin" SortOrder="51"/> <Country Country="CK" Owner="admin" SortOrder="52"/> <Country Country="CR" Owner="admin" SortOrder="53"/> <Country Country="CI" Owner="admin" SortOrder="54"/> <Country Country="HR" Owner="admin" SortOrder="55"/> <Country Country="CU" Owner="admin" SortOrder="56"/> <Country Country="CW" Owner="admin" SortOrder="57"/> <Country Country="CY" Owner="admin" SortOrder="58"/> <Country Country="CZ" Owner="admin" SortOrder="59"/> <Country Country="DK" Owner="admin" SortOrder="60"/> <Country Country="DJ" Owner="admin" SortOrder="61"/> <Country Country="DM" Owner="admin" SortOrder="62"/> <Country Country="DO" Owner="admin" SortOrder="63"/> <Country Country="EC" Owner="admin" SortOrder="64"/> <Country Country="EG" Owner="admin" SortOrder="65"/> <Country Country="SV" Owner="admin" SortOrder="66"/> <Country Country="GQ" Owner="admin" SortOrder="67"/> <Country Country="ER" Owner="admin" SortOrder="68"/> <Country Country="EE" Owner="admin" SortOrder="69"/> <Country Country="ET" Owner="admin" SortOrder="70"/> <Country Country="FK" Owner="admin" SortOrder="71"/> <Country Country="FO" Owner="admin" SortOrder="72"/> <Country Country="FJ" Owner="admin" SortOrder="73"/> <Country Country="FI" Owner="admin" SortOrder="74"/> <Country Country="FR" Owner="admin" SortOrder="75"/> <Country Country="GF" Owner="admin" SortOrder="76"/> <Country Country="PF" Owner="admin" SortOrder="77"/> <Country Country="TF" Owner="admin" SortOrder="78"/> <Country Country="GA" Owner="admin" SortOrder="79"/> <Country Country="GM" Owner="admin" SortOrder="80"/> <Country Country="GE" Owner="admin" SortOrder="81"/> <Country Country="DE" Owner="admin" SortOrder="82"/> <Country Country="GH" Owner="admin" SortOrder="83"/> <Country Country="GI" Owner="admin" SortOrder="84"/> <Country Country="GR" Owner="admin" SortOrder="85"/> <Country Country="GL" Owner="admin" SortOrder="86"/> <Country Country="GD" Owner="admin" SortOrder="87"/> <Country Country="GP" Owner="admin" SortOrder="88"/> <Country Country="GU" Owner="admin" SortOrder="89"/> <Country Country="GT" Owner="admin" SortOrder="90"/> <Country Country="GG" Owner="admin" SortOrder="91"/> <Country Country="GN" Owner="admin" SortOrder="92"/> <Country Country="GW" Owner="admin" SortOrder="93"/> <Country Country="GY" Owner="admin" SortOrder="94"/> <Country Country="HT" Owner="admin" SortOrder="95"/> <Country Country="HM" Owner="admin" SortOrder="96"/> <Country Country="VA" Owner="admin" SortOrder="97"/> <Country Country="HN" Owner="admin" SortOrder="98"/> <Country Country="HK" Owner="admin" SortOrder="99"/> <Country Country="HU" Owner="admin" SortOrder="100"/> <Country Country="IS" Owner="admin" SortOrder="101"/> <Country Country="IN" Owner="admin" SortOrder="102"/> <Country Country="ID" Owner="admin" SortOrder="103"/> <Country Country="IR" Owner="admin" SortOrder="104"/> <Country Country="IQ" Owner="admin" SortOrder="105"/> <Country Country="IE" Owner="admin" SortOrder="106"/> <Country Country="IM" Owner="admin" SortOrder="107"/> <Country Country="IL" Owner="admin" SortOrder="108"/> <Country Country="IT" Owner="admin" SortOrder="109"/> <Country Country="JM" Owner="admin" SortOrder="110"/> <Country Country="JP" Owner="admin" SortOrder="111"/> <Country Country="JE" Owner="admin" SortOrder="112"/> <Country Country="JO" Owner="admin" SortOrder="113"/> <Country Country="KZ" Owner="admin" SortOrder="114"/> <Country Country="KE" Owner="admin" SortOrder="115"/> <Country Country="KI" Owner="admin" SortOrder="116"/> <Country Country="KP" Owner="admin" SortOrder="117"/> <Country Country="KR" Owner="admin" SortOrder="118"/> <Country Country="KW" Owner="admin" SortOrder="119"/> <Country Country="KG" Owner="admin" SortOrder="120"/> <Country Country="LA" Owner="admin" SortOrder="121"/> <Country Country="LV" Owner="admin" SortOrder="122"/> <Country Country="LB" Owner="admin" SortOrder="123"/> <Country Country="LS" Owner="admin" SortOrder="124"/> <Country Country="LR" Owner="admin" SortOrder="125"/> <Country Country="LY" Owner="admin" SortOrder="126"/> <Country Country="LI" Owner="admin" SortOrder="127"/> <Country Country="LT" Owner="admin" SortOrder="128"/> <Country Country="LU" Owner="admin" SortOrder="129"/> <Country Country="MO" Owner="admin" SortOrder="130"/> <Country Country="MK" Owner="admin" SortOrder="131"/> <Country Country="MG" Owner="admin" SortOrder="132"/> <Country Country="MW" Owner="admin" SortOrder="133"/> <Country Country="MY" Owner="admin" SortOrder="134"/> <Country Country="MV" Owner="admin" SortOrder="135"/> <Country Country="ML" Owner="admin" SortOrder="136"/> <Country Country="MT" Owner="admin" SortOrder="137"/> <Country Country="MH" Owner="admin" SortOrder="138"/> <Country Country="MQ" Owner="admin" SortOrder="139"/> <Country Country="MR" Owner="admin" SortOrder="140"/> <Country Country="MU" Owner="admin" SortOrder="141"/> <Country Country="YT" Owner="admin" SortOrder="142"/> <Country Country="MX" Owner="admin" SortOrder="143"/> <Country Country="FM" Owner="admin" SortOrder="144"/> <Country Country="MD" Owner="admin" SortOrder="145"/> <Country Country="MC" Owner="admin" SortOrder="146"/> <Country Country="MN" Owner="admin" SortOrder="147"/> <Country Country="ME" Owner="admin" SortOrder="148"/> <Country Country="MS" Owner="admin" SortOrder="149"/> <Country Country="MA" Owner="admin" SortOrder="150"/> <Country Country="MZ" Owner="admin" SortOrder="151"/> <Country Country="MM" Owner="admin" SortOrder="152"/> <Country Country="NA" Owner="admin" SortOrder="153"/> <Country Country="NR" Owner="admin" SortOrder="154"/> <Country Country="NP" Owner="admin" SortOrder="155"/> <Country Country="NL" Owner="admin" SortOrder="156"/> <Country Country="NC" Owner="admin" SortOrder="157"/> <Country Country="NZ" Owner="admin" SortOrder="158"/> <Country Country="NI" Owner="admin" SortOrder="159"/> <Country Country="NE" Owner="admin" SortOrder="160"/> <Country Country="NG" Owner="admin" SortOrder="161"/> <Country Country="NU" Owner="admin" SortOrder="162"/> <Country Country="NF" Owner="admin" SortOrder="163"/> <Country Country="MP" Owner="admin" SortOrder="164"/> <Country Country="NO" Owner="admin" SortOrder="165"/> <Country Country="OM" Owner="admin" SortOrder="166"/> <Country Country="PK" Owner="admin" SortOrder="167"/> <Country Country="PW" Owner="admin" SortOrder="168"/> <Country Country="PS" Owner="admin" SortOrder="169"/> <Country Country="PA" Owner="admin" SortOrder="170"/> <Country Country="PG" Owner="admin" SortOrder="171"/> <Country Country="PY" Owner="admin" SortOrder="172"/> <Country Country="PE" Owner="admin" SortOrder="173"/> <Country Country="PH" Owner="admin" SortOrder="174"/> <Country Country="PN" Owner="admin" SortOrder="175"/> <Country Country="PL" Owner="admin" SortOrder="176"/> <Country Country="PT" Owner="admin" SortOrder="177"/> <Country Country="PR" Owner="admin" SortOrder="178"/> <Country Country="QA" Owner="admin" SortOrder="179"/> <Country Country="RE" Owner="admin" SortOrder="180"/> <Country Country="RO" Owner="admin" SortOrder="181"/> <Country Country="RU" Owner="admin" SortOrder="182"/> <Country Country="RW" Owner="admin" SortOrder="183"/> <Country Country="BL" Owner="admin" SortOrder="184"/> <Country Country="SH" Owner="admin" SortOrder="185"/> <Country Country="KN" Owner="admin" SortOrder="186"/> <Country Country="LC" Owner="admin" SortOrder="187"/> <Country Country="MF" Owner="admin" SortOrder="188"/> <Country Country="PM" Owner="admin" SortOrder="189"/> <Country Country="VC" Owner="admin" SortOrder="190"/> <Country Country="WS" Owner="admin" SortOrder="191"/> <Country Country="SM" Owner="admin" SortOrder="192"/> <Country Country="ST" Owner="admin" SortOrder="193"/> <Country Country="SA" Owner="admin" SortOrder="194"/> <Country Country="SN" Owner="admin" SortOrder="195"/> <Country Country="RS" Owner="admin" SortOrder="196"/> <Country Country="SC" Owner="admin" SortOrder="197"/> <Country Country="SL" Owner="admin" SortOrder="198"/> <Country Country="SG" Owner="admin" SortOrder="199"/> <Country Country="SX" Owner="admin" SortOrder="200"/> <Country Country="SK" Owner="admin" SortOrder="201"/> <Country Country="SI" Owner="admin" SortOrder="202"/> <Country Country="SB" Owner="admin" SortOrder="203"/> <Country Country="SO" Owner="admin" SortOrder="204"/> <Country Country="ZA" Owner="admin" SortOrder="205"/> <Country Country="GS" Owner="admin" SortOrder="206"/> <Country Country="ES" Owner="admin" SortOrder="207"/> <Country Country="LK" Owner="admin" SortOrder="208"/> <Country Country="SD" Owner="admin" SortOrder="209"/> <Country Country="SR" Owner="admin" SortOrder="210"/> <Country Country="SJ" Owner="admin" SortOrder="211"/> <Country Country="SZ" Owner="admin" SortOrder="212"/> <Country Country="SE" Owner="admin" SortOrder="213"/> <Country Country="CH" Owner="admin" SortOrder="214"/> <Country Country="SY" Owner="admin" SortOrder="215"/> <Country Country="TW" Owner="admin" SortOrder="216"/> <Country Country="TJ" Owner="admin" SortOrder="217"/> <Country Country="TZ" Owner="admin" SortOrder="218"/> <Country Country="TH" Owner="admin" SortOrder="219"/> <Country Country="TL" Owner="admin" SortOrder="220"/> <Country Country="TG" Owner="admin" SortOrder="221"/> <Country Country="TK" Owner="admin" SortOrder="222"/> <Country Country="TO" Owner="admin" SortOrder="223"/> <Country Country="TT" Owner="admin" SortOrder="224"/> <Country Country="TN" Owner="admin" SortOrder="225"/> <Country Country="TR" Owner="admin" SortOrder="226"/> <Country Country="TM" Owner="admin" SortOrder="227"/> <Country Country="TC" Owner="admin" SortOrder="228"/> <Country Country="TV" Owner="admin" SortOrder="229"/> <Country Country="UG" Owner="admin" SortOrder="230"/> <Country Country="UA" Owner="admin" SortOrder="231"/> <Country Country="AE" Owner="admin" SortOrder="232"/> <Country Country="GB" Owner="admin" SortOrder="233"/> <Country Country="US" Owner="admin" SortOrder="234"/> <Country Country="UM" Owner="admin" SortOrder="235"/> <Country Country="UY" Owner="admin" SortOrder="236"/> <Country Country="UZ" Owner="admin" SortOrder="237"/> <Country Country="VU" Owner="admin" SortOrder="238"/> <Country Country="VE" Owner="admin" SortOrder="239"/> <Country Country="VV" Owner="admin" SortOrder="240"/> <Country Country="VG" Owner="admin" SortOrder="241"/> <Country Country="VI" Owner="admin" SortOrder="242"/> <Country Country="WF" Owner="admin" SortOrder="243"/> <Country Country="EH" Owner="admin" SortOrder="244"/> <Country Country="YE" Owner="admin" SortOrder="245"/> <Country Country="ZM" Owner="admin" SortOrder="246"/> <Country Country="ZW" Owner="admin" SortOrder="247"/> <Country/> |
Long Name Format
| Code Block | ||
|---|---|---|
| ||
<!--?xml version="1.0" encoding="UTF-8" standalone="yes"?--> <?xml version="1.0" encoding="UTF-8" standalone="yes"?> <Country> <Country Country="Afghanistan" Owner="admin" SortOrder="0"/> <Country Country="Aland Islands" Owner="admin" SortOrder="1"/> <Country Country="Albania" Owner="admin" SortOrder="2"/> <Country Country="Algeria" Owner="admin" SortOrder="3"/> <Country Country="American Samoa" Owner="admin" SortOrder="4"/> <Country Country="Andorra" Owner="admin" SortOrder="5"/> <Country Country="Angola" Owner="admin" SortOrder="6"/> <Country Country="Anguilla" Owner="admin" SortOrder="7"/> <Country Country="Antarctica" Owner="admin" SortOrder="8"/> <Country Country="Antigua and Barbuda" Owner="admin" SortOrder="9"/> <Country Country="Argentina" Owner="admin" SortOrder="10"/> <Country Country="Armenia" Owner="admin" SortOrder="11"/> <Country Country="Aruba" Owner="admin" SortOrder="12"/> <Country Country="Australia" Owner="admin" SortOrder="13"/> <Country Country="Austria" Owner="admin" SortOrder="14"/> <Country Country="Azerbaijan" Owner="admin" SortOrder="15"/> <Country Country="Bahamas" Owner="admin" SortOrder="16"/> <Country Country="Bahrain" Owner="admin" SortOrder="17"/> <Country Country="Bangladesh" Owner="admin" SortOrder="18"/> <Country Country="Barbados" Owner="admin" SortOrder="19"/> <Country Country="Belarus" Owner="admin" SortOrder="20"/> <Country Country="Belgium" Owner="admin" SortOrder="21"/> <Country Country="Belize" Owner="admin" SortOrder="22"/> <Country Country="Benin" Owner="admin" SortOrder="23"/> <Country Country="Bermuda" Owner="admin" SortOrder="24"/> <Country Country="Bhutan" Owner="admin" SortOrder="25"/> <Country Country="Bolivia" Owner="admin" SortOrder="26"/> <Country Country="Bonaire, Saint Eustatius and Saba" Owner="admin" SortOrder="27"/> <Country Country="Bosnia and Herzegovina" Owner="admin" SortOrder="28"/> <Country Country="Botswana" Owner="admin" SortOrder="29"/> <Country Country="Bouvet Island" Owner="admin" SortOrder="30"/> <Country Country="Brazil" Owner="admin" SortOrder="31"/> <Country Country="British Indian Ocean Territory" Owner="admin" SortOrder="32"/> <Country Country="Brunei Darussalam" Owner="admin" SortOrder="33"/> <Country Country="Bulgaria" Owner="admin" SortOrder="34"/> <Country Country="Burkina Faso" Owner="admin" SortOrder="35"/> <Country Country="Burundi" Owner="admin" SortOrder="36"/> <Country Country="Cambodia" Owner="admin" SortOrder="37"/> <Country Country="Cameroon" Owner="admin" SortOrder="38"/> <Country Country="Canada" Owner="admin" SortOrder="39"/> <Country Country="Cape Verde" Owner="admin" SortOrder="40"/> <Country Country="Cayman Islands" Owner="admin" SortOrder="41"/> <Country Country="Central African Republic" Owner="admin" SortOrder="42"/> <Country Country="Chad" Owner="admin" SortOrder="43"/> <Country Country="Chile" Owner="admin" SortOrder="44"/> <Country Country="China" Owner="admin" SortOrder="45"/> <Country Country="Christmas Island" Owner="admin" SortOrder="46"/> <Country Country="Cocos (Keeling) Islands" Owner="admin" SortOrder="47"/> <Country Country="Colombia" Owner="admin" SortOrder="48"/> <Country Country="Comoros" Owner="admin" SortOrder="49"/> <Country Country="Congo" Owner="admin" SortOrder="50"/> <Country Country="Congo, the Democratic Republic of the" Owner="admin" SortOrder="51"/> <Country Country="Cook Islands" Owner="admin" SortOrder="52"/> <Country Country="Costa Rica" Owner="admin" SortOrder="53"/> <Country Country="Cote d'Ivoire" Owner="admin" SortOrder="54"/> <Country Country="Croatia" Owner="admin" SortOrder="55"/> <Country Country="Cuba" Owner="admin" SortOrder="56"/> <Country Country="Curacao" Owner="admin" SortOrder="57"/> <Country Country="Cyprus" Owner="admin" SortOrder="58"/> <Country Country="Czech Republic" Owner="admin" SortOrder="59"/> <Country Country="Denmark" Owner="admin" SortOrder="60"/> <Country Country="Djibouti" Owner="admin" SortOrder="61"/> <Country Country="Dominica" Owner="admin" SortOrder="62"/> <Country Country="Dominican Republic" Owner="admin" SortOrder="63"/> <Country Country="Ecuador" Owner="admin" SortOrder="64"/> <Country Country="Egypt" Owner="admin" SortOrder="65"/> <Country Country="El Salvador" Owner="admin" SortOrder="66"/> <Country Country="Equatorial Guinea" Owner="admin" SortOrder="67"/> <Country Country="Eritrea" Owner="admin" SortOrder="68"/> <Country Country="Estonia" Owner="admin" SortOrder="69"/> <Country Country="Ethiopia" Owner="admin" SortOrder="70"/> <Country Country="Falkland Islands (Malvinas)" Owner="admin" SortOrder="71"/> <Country Country="Faroe Islands" Owner="admin" SortOrder="72"/> <Country Country="Fiji" Owner="admin" SortOrder="73"/> <Country Country="Finland" Owner="admin" SortOrder="74"/> <Country Country="France" Owner="admin" SortOrder="75"/> <Country Country="French Guiana" Owner="admin" SortOrder="76"/> <Country Country="French Polynesia" Owner="admin" SortOrder="77"/> <Country Country="French Southern Territories" Owner="admin" SortOrder="78"/> <Country Country="Gabon" Owner="admin" SortOrder="79"/> <Country Country="Gambia" Owner="admin" SortOrder="80"/> <Country Country="Georgia" Owner="admin" SortOrder="81"/> <Country Country="Germany" Owner="admin" SortOrder="82"/> <Country Country="Ghana" Owner="admin" SortOrder="83"/> <Country Country="Gibraltar" Owner="admin" SortOrder="84"/> <Country Country="Greece" Owner="admin" SortOrder="85"/> <Country Country="Greenland" Owner="admin" SortOrder="86"/> <Country Country="Grenada" Owner="admin" SortOrder="87"/> <Country Country="Guadeloupe" Owner="admin" SortOrder="88"/> <Country Country="Guam" Owner="admin" SortOrder="89"/> <Country Country="Guatemala" Owner="admin" SortOrder="90"/> <Country Country="Guernsey" Owner="admin" SortOrder="91"/> <Country Country="Guinea" Owner="admin" SortOrder="92"/> <Country Country="Guinea-Bissau" Owner="admin" SortOrder="93"/> <Country Country="Guyana" Owner="admin" SortOrder="94"/> <Country Country="Haiti" Owner="admin" SortOrder="95"/> <Country Country="Heard Island and McDonald Islands" Owner="admin" SortOrder="96"/> <Country Country="Holy See (Vatican City State)" Owner="admin" SortOrder="97"/> <Country Country="Honduras" Owner="admin" SortOrder="98"/> <Country Country="Hong Kong" Owner="admin" SortOrder="99"/> <Country Country="Hungary" Owner="admin" SortOrder="100"/> <Country Country="Iceland" Owner="admin" SortOrder="101"/> <Country Country="India" Owner="admin" SortOrder="102"/> <Country Country="Indonesia" Owner="admin" SortOrder="103"/> <Country Country="Iran, Islamic Republic of" Owner="admin" SortOrder="104"/> <Country Country="Iraq" Owner="admin" SortOrder="105"/> <Country Country="Ireland" Owner="admin" SortOrder="106"/> <Country Country="Isle of Man" Owner="admin" SortOrder="107"/> <Country Country="Israel" Owner="admin" SortOrder="108"/> <Country Country="Italy" Owner="admin" SortOrder="109"/> <Country Country="Jamaica" Owner="admin" SortOrder="110"/> <Country Country="Japan" Owner="admin" SortOrder="111"/> <Country Country="Jersey" Owner="admin" SortOrder="112"/> <Country Country="Jordan" Owner="admin" SortOrder="113"/> <Country Country="Kazakhstan" Owner="admin" SortOrder="114"/> <Country Country="Kenya" Owner="admin" SortOrder="115"/> <Country Country="Kiribati" Owner="admin" SortOrder="116"/> <Country Country="Korea, Democratic People's Republic of" Owner="admin" SortOrder="117"/> <Country Country="Korea, Republic of" Owner="admin" SortOrder="118"/> <Country Country="Kuwait" Owner="admin" SortOrder="119"/> <Country Country="Kyrgyzstan" Owner="admin" SortOrder="120"/> <Country Country="Lao People's Democratic Republic" Owner="admin" SortOrder="121"/> <Country Country="Latvia" Owner="admin" SortOrder="122"/> <Country Country="Lebanon" Owner="admin" SortOrder="123"/> <Country Country="Lesotho" Owner="admin" SortOrder="124"/> <Country Country="Liberia" Owner="admin" SortOrder="125"/> <Country Country="Libyan Arab Jamahiriya" Owner="admin" SortOrder="126"/> <Country Country="Liechtenstein" Owner="admin" SortOrder="127"/> <Country Country="Lithuania" Owner="admin" SortOrder="128"/> <Country Country="Luxembourg" Owner="admin" SortOrder="129"/> <Country Country="Macao" Owner="admin" SortOrder="130"/> <Country Country="Macedonia, the former Yugoslav Republic of" Owner="admin" SortOrder="131"/> <Country Country="Madagascar" Owner="admin" SortOrder="132"/> <Country Country="Malawi" Owner="admin" SortOrder="133"/> <Country Country="Malaysia" Owner="admin" SortOrder="134"/> <Country Country="Maldives" Owner="admin" SortOrder="135"/> <Country Country="Mali" Owner="admin" SortOrder="136"/> <Country Country="Malta" Owner="admin" SortOrder="137"/> <Country Country="Marshall Islands" Owner="admin" SortOrder="138"/> <Country Country="Martinique" Owner="admin" SortOrder="139"/> <Country Country="Mauritania" Owner="admin" SortOrder="140"/> <Country Country="Mauritius" Owner="admin" SortOrder="141"/> <Country Country="Mayotte" Owner="admin" SortOrder="142"/> <Country Country="Mexico" Owner="admin" SortOrder="143"/> <Country Country="Micronesia, Federated States of" Owner="admin" SortOrder="144"/> <Country Country="Moldova, Republic of" Owner="admin" SortOrder="145"/> <Country Country="Monaco" Owner="admin" SortOrder="146"/> <Country Country="Mongolia" Owner="admin" SortOrder="147"/> <Country Country="Montenegro" Owner="admin" SortOrder="148"/> <Country Country="Montserrat" Owner="admin" SortOrder="149"/> <Country Country="Morocco" Owner="admin" SortOrder="150"/> <Country Country="Mozambique" Owner="admin" SortOrder="151"/> <Country Country="Myanmar" Owner="admin" SortOrder="152"/> <Country Country="Namibia" Owner="admin" SortOrder="153"/> <Country Country="Nauru" Owner="admin" SortOrder="154"/> <Country Country="Nepal" Owner="admin" SortOrder="155"/> <Country Country="Netherlands" Owner="admin" SortOrder="156"/> <Country Country="New Caledonia" Owner="admin" SortOrder="157"/> <Country Country="New Zealand" Owner="admin" SortOrder="158"/> <Country Country="Nicaragua" Owner="admin" SortOrder="159"/> <Country Country="Niger" Owner="admin" SortOrder="160"/> <Country Country="Nigeria" Owner="admin" SortOrder="161"/> <Country Country="Niue" Owner="admin" SortOrder="162"/> <Country Country="Norfolk Island" Owner="admin" SortOrder="163"/> <Country Country="Northern Mariana Islands" Owner="admin" SortOrder="164"/> <Country Country="Norway" Owner="admin" SortOrder="165"/> <Country Country="Oman" Owner="admin" SortOrder="166"/> <Country Country="Pakistan" Owner="admin" SortOrder="167"/> <Country Country="Palau" Owner="admin" SortOrder="168"/> <Country Country="Palestinian Territory, Occupied" Owner="admin" SortOrder="169"/> <Country Country="Panama" Owner="admin" SortOrder="170"/> <Country Country="Papua New Guinea" Owner="admin" SortOrder="171"/> <Country Country="Paraguay" Owner="admin" SortOrder="172"/> <Country Country="Peru" Owner="admin" SortOrder="173"/> <Country Country="Philippines" Owner="admin" SortOrder="174"/> <Country Country="Pitcairn" Owner="admin" SortOrder="175"/> <Country Country="Poland" Owner="admin" SortOrder="176"/> <Country Country="Portugal" Owner="admin" SortOrder="177"/> <Country Country="Puerto Rico" Owner="admin" SortOrder="178"/> <Country Country="Qatar" Owner="admin" SortOrder="179"/> <Country Country="Reunion" Owner="admin" SortOrder="180"/> <Country Country="Romania" Owner="admin" SortOrder="181"/> <Country Country="Russian Federation" Owner="admin" SortOrder="182"/> <Country Country="Rwanda" Owner="admin" SortOrder="183"/> <Country Country="Saint Barthelemy" Owner="admin" SortOrder="184"/> <Country Country="Saint Helena" Owner="admin" SortOrder="185"/> <Country Country="Saint Kitts and Nevis" Owner="admin" SortOrder="186"/> <Country Country="Saint Lucia" Owner="admin" SortOrder="187"/> <Country Country="Saint Martin (French part)" Owner="admin" SortOrder="188"/> <Country Country="Saint Pierre and Miquelon" Owner="admin" SortOrder="189"/> <Country Country="Saint Vincent and the Grenadines" Owner="admin" SortOrder="190"/> <Country Country="Samoa" Owner="admin" SortOrder="191"/> <Country Country="San Marino" Owner="admin" SortOrder="192"/> <Country Country="Sao Tome and Principe" Owner="admin" SortOrder="193"/> <Country Country="Saudi Arabia" Owner="admin" SortOrder="194"/> <Country Country="Senegal" Owner="admin" SortOrder="195"/> <Country Country="Serbia" Owner="admin" SortOrder="196"/> <Country Country="Seychelles" Owner="admin" SortOrder="197"/> <Country Country="Sierra Leone" Owner="admin" SortOrder="198"/> <Country Country="Singapore" Owner="admin" SortOrder="199"/> <Country Country="Sint Maarten" Owner="admin" SortOrder="200"/> <Country Country="Slovakia" Owner="admin" SortOrder="201"/> <Country Country="Slovenia" Owner="admin" SortOrder="202"/> <Country Country="Solomon Islands" Owner="admin" SortOrder="203"/> <Country Country="Somalia" Owner="admin" SortOrder="204"/> <Country Country="South Africa" Owner="admin" SortOrder="205"/> <Country Country="South Georgia and the South Sandwich Islands" Owner="admin" SortOrder="206"/> <Country Country="Spain" Owner="admin" SortOrder="207"/> <Country Country="Sri Lanka" Owner="admin" SortOrder="208"/> <Country Country="Sudan" Owner="admin" SortOrder="209"/> <Country Country="Suriname" Owner="admin" SortOrder="210"/> <Country Country="Svalbard and Jan Mayen" Owner="admin" SortOrder="211"/> <Country Country="Swaziland" Owner="admin" SortOrder="212"/> <Country Country="Sweden" Owner="admin" SortOrder="213"/> <Country Country="Switzerland" Owner="admin" SortOrder="214"/> <Country Country="Syrian Arab Republic" Owner="admin" SortOrder="215"/> <Country Country="Taiwan" Owner="admin" SortOrder="216"/> <Country Country="Tajikistan" Owner="admin" SortOrder="217"/> <Country Country="Tanzania, United Republic of" Owner="admin" SortOrder="218"/> <Country Country="Thailand" Owner="admin" SortOrder="219"/> <Country Country="Timor-Leste, Democratic Republic of" Owner="admin" SortOrder="220"/> <Country Country="Togo" Owner="admin" SortOrder="221"/> <Country Country="Tokelau" Owner="admin" SortOrder="222"/> <Country Country="Tonga" Owner="admin" SortOrder="223"/> <Country Country="Trinidad and Tobago" Owner="admin" SortOrder="224"/> <Country Country="Tunisia" Owner="admin" SortOrder="225"/> <Country Country="Turkey" Owner="admin" SortOrder="226"/> <Country Country="Turkmenistan" Owner="admin" SortOrder="227"/> <Country Country="Turks and Caicos Islands" Owner="admin" SortOrder="228"/> <Country Country="Tuvalu" Owner="admin" SortOrder="229"/> <Country Country="Uganda" Owner="admin" SortOrder="230"/> <Country Country="Ukraine" Owner="admin" SortOrder="231"/> <Country Country="United Arab Emirates" Owner="admin" SortOrder="232"/> <Country Country="United Kingdom" Owner="admin" SortOrder="233"/> <Country Country="United States" Owner="admin" SortOrder="234"/> <Country Country="United States Minor Outlying Islands" Owner="admin" SortOrder="235"/> <Country Country="Uruguay" Owner="admin" SortOrder="236"/> <Country Country="Uzbekistan" Owner="admin" SortOrder="237"/> <Country Country="Vanuatu" Owner="admin" SortOrder="238"/> <Country Country="Venezuela" Owner="admin" SortOrder="239"/> <Country Country="Vietnam" Owner="admin" SortOrder="240"/> <Country Country="Virgin Islands, British" Owner="admin" SortOrder="241"/> <Country Country="Virgin Islands, U.S." Owner="admin" SortOrder="242"/> <Country Country="Wallis and Futuna" Owner="admin" SortOrder="243"/> <Country Country="Western Sahara" Owner="admin" SortOrder="244"/> <Country Country="Yemen" Owner="admin" SortOrder="245"/> <Country Country="Zambia" Owner="admin" SortOrder="246"/> <Country Country="Zimbabwe" Owner="admin" SortOrder="247"/> <Country/> |
...
XML for abbreviations listed below for US states. Long Name is the full state name where as the 'State' value is often the abbreviated value.
| Code Block | ||
|---|---|---|
| ||
<?xml version="1.0" encoding="UTF-8"?> <States> <State SortOrder="0" Owner="Branded Owner" LongName="California" Country="USA" State="CA"/> </States> |
...
State Listings
State Code Format
| Code Block | ||
|---|---|---|
| ||
<States> <State State="AL" Country="USA" Owner="admin" SortOrder="0"/> <State State="AK" Country="USA" Owner="admin" SortOrder="1"/> <State State="AS" Country="USA" Owner="admin" SortOrder="2"/> <State State="AZ" Country="USA" Owner="admin" SortOrder="3"/> <State State="AR" Country="USA" Owner="admin" SortOrder="4"/> <State State="CA" Country="USA" Owner="admin" SortOrder="5"/> <State State="CO" Country="USA" Owner="admin" SortOrder="6"/> <State State="CT" Country="USA" Owner="admin" SortOrder="7"/> <State State="MP" Country="USA" Owner="admin" SortOrder="8"/> <State State="DE" Country="USA" Owner="admin" SortOrder="9"/> <State State="DC" Country="USA" Owner="admin" SortOrder="10"/> <State State="FM" Country="USA" Owner="admin" SortOrder="11"/> <State State="FL" Country="USA" Owner="admin" SortOrder="12"/> <State State="GA" Country="USA" Owner="admin" SortOrder="13"/> <State State="GU" Country="USA" Owner="admin" SortOrder="14"/> <State State="HI" Country="USA" Owner="admin" SortOrder="15"/> <State State="ID" Country="USA" Owner="admin" SortOrder="16"/> <State State="IL" Country="USA" Owner="admin" SortOrder="17"/> <State State="IN" Country="USA" Owner="admin" SortOrder="18"/> <State State="IA" Country="USA" Owner="admin" SortOrder="19"/> <State State="KS" Country="USA" Owner="admin" SortOrder="20"/> <State State="KY" Country="USA" Owner="admin" SortOrder="21"/> <State State="LA" Country="USA" Owner="admin" SortOrder="22"/> <State State="ME" Country="USA" Owner="admin" SortOrder="23"/> <State State="MH" Country="USA" Owner="admin" SortOrder="24"/> <State State="MD" Country="USA" Owner="admin" SortOrder="25"/> <State State="MA" Country="USA" Owner="admin" SortOrder="26"/> <State State="MI" Country="USA" Owner="admin" SortOrder="27"/> <State State="MN" Country="USA" Owner="admin" SortOrder="28"/> <State State="MS" Country="USA" Owner="admin" SortOrder="29"/> <State State="MO" Country="USA" Owner="admin" SortOrder="30"/> <State State="MT" Country="USA" Owner="admin" SortOrder="31"/> <State State="NE" Country="USA" Owner="admin" SortOrder="32"/> <State State="NV" Country="USA" Owner="admin" SortOrder="33"/> <State State="NH" Country="USA" Owner="admin" SortOrder="34"/> <State State="NJ" Country="USA" Owner="admin" SortOrder="35"/> <State State="NM" Country="USA" Owner="admin" SortOrder="36"/> <State State="NY" Country="USA" Owner="admin" SortOrder="37"/> <State State="NC" Country="USA" Owner="admin" SortOrder="38"/> <State State="ND" Country="USA" Owner="admin" SortOrder="39"/> <State State="OH" Country="USA" Owner="admin" SortOrder="40"/> <State State="OK" Country="USA" Owner="admin" SortOrder="41"/> <State State="OR" Country="USA" Owner="admin" SortOrder="42"/> <State State="PW" Country="USA" Owner="admin" SortOrder="43"/> <State State="PR" Country="USA" Owner="admin" SortOrder="44"/> <State State="PA" Country="USA" Owner="admin" SortOrder="45"/> <State State="RI" Country="USA" Owner="admin" SortOrder="46"/> <State State="SC" Country="USA" Owner="admin" SortOrder="47"/> <State State="SD" Country="USA" Owner="admin" SortOrder="48"/> <State State="TN" Country="USA" Owner="admin" SortOrder="49"/> <State State="TX" Country="USA" Owner="admin" SortOrder="50"/> <State State="VI" Country="USA" Owner="admin" SortOrder="51"/> <State State="UT" Country="USA" Owner="admin" SortOrder="52"/> <State State="VT" Country="USA" Owner="admin" SortOrder="53"/> <State State="VA" Country="USA" Owner="admin" SortOrder="54"/> <State State="WA" Country="USA" Owner="admin" SortOrder="55"/> <State State="WV" Country="USA" Owner="admin" SortOrder="56"/> <State State="WI" Country="USA" Owner="admin" SortOrder="57"/> <State State="WY" Country="USA" Owner="admin" SortOrder="58"/> </States> |
...
Long Name Format
| Code Block | ||
|---|---|---|
| ||
<!--?xml version="1.0" encoding="UTF-8" standalone="yes"?--> |
Full Province Listing
| Code Block | ||
|---|---|---|
| ||
<States> <State State="AB" Country="Canada" Owner="admin" SortOrder="0"/> <State State="BC" Country="Canada" Owner="admin" SortOrder="1"/> <State State="MB" Country="Canada" Owner="admin" SortOrder="2"/> <State State="NB" Country="Canada" Owner="admin" SortOrder="3"/> <State State="NL" Country="Canada" Owner="admin" SortOrder="4"/> <State State="NS" Country="Canada" Owner="admin" SortOrder="5"/> <State State="NT" Country="Canada" Owner="admin" SortOrder="6"/> <State State="NU" Country="Canada" Owner="admin" SortOrder="7"/> <State State="ON" Country="Canada" Owner="admin" SortOrder="8"/> <State State="PE" Country="Canada" Owner="admin" SortOrder="9"/> <State State="QC" Country="Canada" Owner="admin" SortOrder="10"/> <State State="SK" Country="Canada" Owner="admin" SortOrder="11"/> <State State="YT" Country="Canada" Owner="admin" SortOrder="12"/> </States> |
...
Owner’s Counties. Note the links to State and County below.
| Code Block | ||
|---|---|---|
| ||
<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 | ||
|---|---|---|
| ||
<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 | ||
|---|---|---|
| ||
<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 | ||
|---|---|---|
| ||
<?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: 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 tab. 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 | ||
|---|---|---|
| ||
<ServiceType Name="Service_Type_Name" Owner="/Owner=Quality Assurance"/> |
...
To import the provisioning component, a table in the EngageIP database will need to be manually updated (BOSS). Open the table ServerTypeAttributeProvisionSet, add a new row by entering a ServerTypeID, for example '1', then add a name,for example 'test', hit enter to save the row. Then you can import them with the below XML replacing the ServerTypeProvisionSet element with the name that you specified in the table.
ServiceAttributes
| Code Block | ||
|---|---|---|
| ||
<ServiceAttributes> <ServiceAttributeProvisioning ServerTypeAttributeProvisionSet="test" ProvisionSet="test" Server="test" Owner="admin" Service="Weekly" /> </ServiceAttributes> |
ServiceAttributeCost
| Code Block | ||
|---|---|---|
| ||
<?xml version="1.0"?> <ServiceAtrributes> <ServiceAttributeCost Amount="10.00" Service="AttributeService" Owner="Quality_Assurance"/> </ServiceAtrributes> |
ServiceAttributeGeneralLedger
| Code Block | ||
|---|---|---|
| ||
<?xml version="1.0"?> <ServiceAttributes> <ServiceAttributeGeneralLedger Name="GLTEST" Service="AttributeService" Owner="Quality_Assurance"/> </ServiceAttributes> |
ServiceAttributeInvoiceDetail
| Code Block | ||
|---|---|---|
| ||
<?xml version="1.0"?> <ServiceAtrributes> <ServiceAttributeInvoiceDetail Detail="This is the extended details line" Service="AttributeService" Owner="Quality_Assurance"/> </ServiceAtrributes> |
ServiceAttributePrepaid
| Code Block | ||
|---|---|---|
| ||
<?xml version="1.0"?> <ServiceAtrributes> <ServiceAttributePrepaid BaseTimeUnit="1" BaseTimeUnitType="HOUR" Service="AttributeService" Owner="Quality_Assurance" Allowed="1000" PrepaidType="Download"/> </ServiceAtrributes> |
ServiceAttributeProfileQuestion
| Code Block | ||
|---|---|---|
| ||
<?xml version="1.0"?> <ServiceAttributeProfileQuestions> <ServiceAttributeProfileQuestionImport Owner="admin" Service="Dialup Service" Name="ModemID" DataType="Text" Required="false" Default="No" /> </ServiceAttributeProfileQuestions> |
ServiceAttributeProfileAnswer
| Code Block | ||
|---|---|---|
| ||
<import> <ProfileAnswer ProfileQuestionID="4114" Value="test" ReferenceName="uspa1" /> <ServiceAttributeProfileAnswer Owner="/Owner=Logisense Corporation" ServiceProfileQuestionID="64" ProfileAnswer="@uspa1" Service="/Owner=Logisense Corporation/Service=Monthly" /> </import> |
...
(NOTE: Update the reference as the two lines are associated. Two lines per profile question)
| Code Block | ||
|---|---|---|
| ||
<?xml version="1.0"?> <ServiceAttributeProfileQuestions> <ProfileQuestion DataType="/DataType=MAC Address" Name="Mac Address" Question="Mac Address" Required="True" UniqueAnswer="True" ShowOnOverview="True" MultipleAnswers="False" DisplayName="Mac Address" ParentQuestion="False" ProfileQuestionListProviderMultiSelect="False" ShowOnUserPackage="True" IncludeInInvoiceXML="True" ShowOnCustomerPortalSignup="False" ShowOnCustomerPortal="False" ShowOnViewFilter="False" ReferenceName="profileQuestionMac" /> <ServiceAttributeProfileQuestion Service="/Owner=Logisense Corporation/Service=Dialup Service" ProfileQuestion="@profileQuestionMac" /> </ServiceAttributeProfileQuestions> |
...
Here is the generic xml to Import ServiceAttributeProfileQuestion with ProfileQuestionListprovider, in this example we are assuming a ProfileQuestionListProvider exists with the name “TestListProvider”
| Code Block | ||
|---|---|---|
| ||
<?xml version="1.0"?><ServiceAttributeProfileQuestions> <ProfileQuestion ProfileQuestionListProvider="/Owner=Logisense Corporation/ProfileQuestionListProvider=TestListProvider" DataType="/DataType=Text" Name="Device Type" Question="Device Type" Required="True" UniqueAnswer="True" ShowOnOverview="True" MultipleAnswers="False" DisplayName="Device Type" ParentQuestion="False" ProfileQuestionListProviderMultiSelect="False" ShowOnUserPackage="True" IncludeInInvoiceXML="True" ShowOnCustomerPortalSignup="False" ShowOnCustomerPortal="False" ShowOnViewFilter="False" ReferenceName="profileQuestionDevice" /> <ServiceAttributeProfileQuestion Service="/Owner=Logisense Corporation/Service=Dialup Service" ProfileQuestion="@profileQuestionDevice" /> </ServiceAttributeProfileQuestions>[cce lang="xml"] |
ServiceAttributeRadius
| Code Block | ||
|---|---|---|
| ||
<?xml version="1.0"?> <ServiceAtrributes> <ServiceAttributeRadius Attribute="Session-Timeout" Value="10" Service="AttributeService" Owner="Quality_Assurance"/> </ServiceAtrributes> |
ServiceAttributeTaxCode
| Code Block | ||
|---|---|---|
| ||
<?xml version="1.0"?> <TaxCodes> <ServiceAttributeTaxCode TaxCode="USA" Owner="Quality_Assurance" Service="AttributeService" /> </TaxCodes> |
ServiceAttributeTaxExempt
| Code Block | ||
|---|---|---|
| ||
<?xml version="1.0"?> <ServiceAttributes> <ServiceAttributeTaxExempt Owner="Quality_Assurance" Service="AttributeService" /> </ServiceAttributes>[cce lang="xml"] |
TaxExemptTypes
XML Import file:
| View file | ||
|---|---|---|
|
| Code Block | ||
|---|---|---|
| ||
<?xml version="1.0"?> <TaxExemptTypes> <TaxExemptType Name="NO_TAX" TaxTypeCode="0"/> <TaxExemptType Name="SALES_TAX" TaxTypeCode="1"/> </TaxExemptTypes |
ServiceAttributeTaxType - NOTE: This is is the Service Tax Category on the Setup tabpage
| Code Block | ||
|---|---|---|
| ||
<?xml version="1.0"?> <ServiceAttributes> <ServiceAttributeTaxType TaxType="Service IP" Owner="Quality_Assurance" Service="AttributeService" /> </ServiceAttributes> |
ServiceAttributeTelecom
| Code Block | ||
|---|---|---|
| ||
<ServiceAttributeTelecom Service="Email Service" TelecomRatePlan="FDN CallManager" InboundTelecomRatePlan ="NO InBound rate plan" Owner="Logisense Corporation"/> |
ServiceAttributeTelecomBucket
| Code Block | ||
|---|---|---|
| ||
<?xml version="1.0"?> <ServiceAttributes> <ServiceAttributeTelecomBucket TelecomBucket="Test" Amount ="0" Pool="false" Priority="0" Owner="Logisense Corporation" Service="Voip Service" /> </ServiceAttributes> |
ServiceAttributeTransactionCode
| Code Block | ||
|---|---|---|
| ||
<?xml version="1.0"?> <ServiceAttributes> <ServiceAttributeTransactionCode TransactionCode="Monthly Fee" Owner="Quality_Assurance" Service="AttributeService" /> </ServiceAttributes> |
Service Invoice Group
| Code Block | ||
|---|---|---|
| ||
<?xml version="1.0"?> <ServiceAttributeInvoiceGroups> <ServiceAttributeInvoiceGroup InvoiceGroup="/Owner=Logisense Corporation/InvoiceGroup=Business" Service="/Owner=Logisense Corporation/Service=Dialup Service" /> <ServiceAttributeInvoiceGroup InvoiceGroup="/Owner=Logisense Corporation/InvoiceGroup=Personal" Service="/Owner=Logisense Corporation/Service=Email Service" /> </ServiceAttributeInvoiceGroups> |
...
Defines Package Offerings. A package is made up of services and therefore you always sell packages. The services within the package will convert up to the Package type and Length. Each package can have components. Refer to the XML samples for details.
PackageAttributeContract
| Code Block | ||
|---|---|---|
| ||
<PackageAtrributes> <Reference Name="THEOWNER" Value="/Owner=Logisense Corporation/Package=DialUp Package" /> <PackageAttributeContract Term="1" BaseTimeUnitType="/BaseTimeUnitType=Year" Penalty="30.00" ChargeRemainder="false" Package="@THEOWNER"/> </PackageAtrributes> |
PackageAttributeCreditCardAuthOnly
| Code Block | ||
|---|---|---|
| ||
<PackageAttributeCreditCardAuthOnly Amount="1.00" Package="PackageAttribute" Message="Your credit card will be authorized for $1.00" Owner="Quality_Assurance"/> |
PackageAttributeDiscount
| Code Block | ||
|---|---|---|
| ||
<PackageAttributeDiscount DiscountType = "Price" Amount="25" Package="Business Sphere Complete_Premium_330_24" Service="Setup Fee" Owner="Admin"/> |
PackageAttributeProfileAnswer
| Code Block | ||
|---|---|---|
| ||
<PackageAttributeProfileAnswer Answer = "Test" Package="PackageAttribute" Profile="What is your mothers maiden name?" Owner="Quality_Assurance"/> |
PackageProfileQuestion
| Code Block | ||
|---|---|---|
| ||
<PackageProfileQuestion Profile="What is your mothers maiden name?" Package="PackageAttribute" Owner="Quality_Assurance"/> |
PackageAttributeEquipment
| Code Block | ||
|---|---|---|
| ||
<PackageAttributeEquipment Package="/Owner=Admin/Package=DSL Lite Monthly 512" PackageServiceConnector="/Owner=Admin/Package=DSL Lite Monthly 512/PackageServiceConnector.Service=Polycom 330" InventoryItemDefinition="/Owner=Admin/InventoryItemDefinition=Polycom 330" RentOption="true" RentAmount="15" /> |
PackageAttributeResource
| Code Block | ||
|---|---|---|
| ||
<Import> <Reference Name="OWNER" Value="/Owner=Logisense Corporation"/> <Reference Name="SERVICE" Value="/Owner=Logisense Corporation/Service=Polycom 330"/> <PackageAttributeResource Package="/Owner=Logisense Corporation/Package=BusinessSphere_Complete_Basic_330_36" PackageServiceConnector="/Owner=Logisense Corporation/Package=BusinessSphere_Complete_Basic_330_36/PackageServiceConnector.Service=@SERVICE" ResourceType="/Owner=Logisense Corporation/ResourceType=DID" ResourceTypeCategory="/Owner=Logisense Corporation/ResourceType=DID/ResourceTypeCategory=DID" ResourceItemPool="/Owner=Logisense Corporation/ResourceType=DID/ResourceTypeCategory=DID/ResourceTypeCategoryOwner.Target_Owner=@OWNER/ResourceItemPool=USA" AutoAssign="0"/> </Import> |
PackageAttributeContract
| Code Block | ||
|---|---|---|
| ||
<Reference Name="Admin" Value="/Owner=Admin/Package= DSL Lite Monthly 512" /> <PackageAttributeContract Term="24" BaseTimeUnitType="/BaseTimeUnitType=Month" Penalty="30.00" ChargeRemainder="false" Package="@Admin" |
Package Attribute Bulk Package
| Code Block | ||
|---|---|---|
| ||
<PackageAttributeBulkPackage Package="/Owner=Logisense Corporation/Package=3 Monthly Packages" Owner="Admin"/> |
Main Package Import XML:
| Code Block | ||
|---|---|---|
| ||
<Package Name="Annual DSL Package" SKU="AnnualDSLPackage" Code="AnnualDSLPackage" PackageLength="1" Type="YEAR" Description="Annual DSL" Owner="Quality_Assurance"/> |
Generic:
| Code Block | ||
|---|---|---|
| ||
<Packages> <pre><Package Name="Package1CMB10" SKU="Sku110" Owner="/Owner=Logisense Corporation" Frequency="1" BaseTimeUnitType="Once" CreatedDate="2011-07-01 12:00:00.000" Description="Desc1" InactiveOverride="true" StartDate="2011-07-01 12:00:00.00" ExpiryDate="2012-07-01 12:00:00.00" ShowToUserPortal="True" /> </Packages></pre> |
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 | ||
|---|---|---|
| ||
<PackageAttributeQuantity Package="/Owner=Logisense Corporation/Package=SMS Data Package" PackageServiceConnector="/Owner=Logisense Corporation/Service=SMS Data Service" Maximum="2" Default="2" Threshold="2" Minimum="0" Inactive="" /> |
...
Allows importing of the upgrade component onto packages. Multiple upgrade components are allowed here. Monthly Package in the example is the package on which the upgrade component will be placed and the package that you would like to allow an upgrade to would be the 'Quarterly Package' in the below. Quarterly service is the one to which we will tag any GL codes if they exist when a debit is added do to an upgrade charge.
| Code Block | ||
|---|---|---|
| ||
<PackageAttributeUpgrades> <PackageAttributeUpgrade Package='/Owner=Logisense Corporation/Package=Monthly Package' Target_Package='/Owner=Logisense Corporation/Package=Quarterly Package' Service='/Owner=Logisense Corporation/Service=Quarterly Service'/> </PackageAttributeUpgrades> |
...
This is the connection between the packages and services known as the Package Service Connector. Basically, the collection of services that make up the packages.
| Code Block | ||
|---|---|---|
| ||
<PackageService Package="Annual DSL Package" Service="DSL" Owner="Quality_Assurance"/> |
Package | Name of the package that will show to the customer and in reports |
|
Service | Name of the service |
|
Owner | Name of the Owner that the role applies to |
|
Profile Question Imports
Account Profiles Questions.
| Code Block | ||
|---|---|---|
| ||
<Profile Name="What is your MAC ADDRESS" Question="What is your MAC ADDRESS?" DataType="Mac Address" Length="15" Required="false" Default="Yes"/> |
...
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 | ||
|---|---|---|
| ||
<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
Restricted user names for an owner.
| Code Block | ||
|---|---|---|
| ||
<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
Defines the Inventory Item’s Category.
| Code Block | ||
|---|---|---|
| ||
<InventoryItemDefinitionCategory Name="Hardware" Owner="Owner=Quality_Assurance" /> |
...
Defines the Inventory Item’s description and details.
| Code Block | ||
|---|---|---|
| ||
<InventoryItemDefinition Name="VOIP Phone" SKU="VP1" Owner="Owner=Quality_Assurance" Supplier_InventoryLocation="Owner=Quality_Assurance InventoryLocation=Import" InventoryItemDefinitionCategory=" Owner=Quality_Assurance InventoryItemDefinitionCategory=Hardware" ReferenceName="QA_IID_VP1" /> |
...
Defines the Inventory Item
| Code Block | ||
|---|---|---|
| ||
<Reference Name="QA_SERVICE_VOIP" Value="Owner=Quality_Assurance Service=VOIP" /> <InventorySupplyOrder InventoryLocation="Owner=Quality_Assurance InventoryLocation=Warehouse" OrderedFrom_InventoryLocation="Owner=Quality_Assurance InventoryLocation=Import" InventorySupplyOrderStatusType="InventorySupplyOrderStatusType=Completed" ReferenceName="QA_ISO" /> <InventorySupplyOrderDetail InventorySupplyOrder="@QA_ISO" InventoryItemDefinition="Owner=Quality_Assurance InventoryItemDefinition=VOIP Phone" InventorySupplyOrderStatusType="InventorySupplyOrderStatusType=Completed" OrderedQuantity="1" DeliveredQuantity="1" ReferenceName="QA_ISOD" /> <ProfileQuestion Name="MACAddress" Question="MAC Address" DataType="DataType=MAC Address" Required="true" ReferenceName="QA_IIDAPQ_PQ" /> <InventoryItemDefinitionAttributeProfileQuestion InventoryItemDefinition="Owner=Quality_Assurance InventoryItemDefinition=VOIP Phone" ProfileQuestion="@QA_IIDAPQ_PQ" ReferenceName="QA_IIDAPQ" /> <InventoryItem Name="VOIP Phone" InventoryItemDefinition="Owner=Quality_Assurance InventoryItemDefinition=VOIP Phone" InventoryLocation="Owner=Quality_Assurance InventoryLocation=Warehouse" InventorySupplyOrderDetail="@QA_ISOD" InventoryItemStatusType="InventoryItemStatusType=CPE" ReferenceName="QA_II" /> <ProfileAnswer Value="aa:bb:cc:dd:ee:ff" ProfileQuestion="@QA_IIDAPQ_PQ" ReferenceName="QA_IIAPA_PA" /> <InventoryItemAttributeProfileAnswer InventoryItem="@QA_II" InventoryItemDefinitionAttributeProfileQuestion="@QA_IIDAPQ" ProfileAnswer="@QA_IIAPA_PA" /> <UserServiceAttributeEquipment UserService="User=bsmithy UserService.Service=@QA_SERVICE_VOIP" InventoryItemDefinition="Owner=Quality_Assurance InventoryItemDefinition=VOIP Phone" InventoryItem="@QA_II" RentAmount="1.00" /> |
...
Defines Inventory Item Locations
| Code Block | ||
|---|---|---|
| ||
<InventoryLocation Name="Import" Owner="Owner=Quality_Assurance" InventoryLocationType="InventoryLocationType=Supplier" /> |
...
Defines the Resource Management Item.
| Code Block | ||
|---|---|---|
| ||
<Reference Name="QA_Owner" Value="Owner=Quality_Assurance" /> <Reference Name="QA_SERVICE_VOIP" Value="Owner=Quality_Assurance Service=VOIP" /> <ResourceRequest ResourceType="Owner=Quality_Assurance ResourceType=DID" ResourceTypeCategory="Owner=Quality_Assurance ResourceType=DID ResourceTypeCategory=US" ResourceTypeProvider="Owner=Quality_Assurance ResourceType=DID ResourceTypeProvider=Database Import" Quantity="1" Filled="true" ReferenceName="QA_RR_IMPORT" /> <ProfileQuestion Name="AreaCode" Question="Area Code" DataType="DataType=Text" Required="true" ReferenceName="QA_RTAPQ_PQ" /> <ResourceTypeAttributeProfileQuestion ResourceType="Owner=Quality_Assurance ResourceType=DID" ProfileQuestion="@QA_RTAPQ_PQ" ReferenceName="QA_RTAPQ" /> <ResourceItem Name="5196582736" ResourceTypeCategory="Owner=Quality_Assurance ResourceType=DID ResourceTypeCategory=US" ResourceRequest="@QA_RR_IMPORT" ResourceItemStatusType="ResourceItemStatusType=Allocated" ReferenceName="RI_5196582736" /> <ResourceItemResourceItemPoolConnector ResourceItemPool="Owner=Quality_Assurance ResourceType=DID ResourceTypeCategory=US ResourceTypeCategoryOwner.Target_Owner=@QA_Owner ResourceItemPool=All" ResourceItem="@RI_5196582736" /> <ProfileAnswer Value="519" ProfileQuestion="@QA_RTAPQ_PQ" ReferenceName="QA_RIAPA_PA" /> <ResourceItemAttributeProfileAnswer ResourceItem="@RI_5196582736" ResourceTypeAttributeProfileQuestion="@QA_RTAPQ" ProfileAnswer="@QA_RIAPA_PA" /> <UserServiceAttributeResource UserService="User=bsmithy UserService.Service=@QA_SERVICE_VOIP" ResourceItem="@RI_5196582736" /> |
...
Defines the Resource Item Type.
| Code Block | ||
|---|---|---|
| ||
<ResourceType Name="DID" Owner="Owner=Quality_Assurance" /> |
...
Defines the Resource Item’s Category Type.
| Code Block | ||
|---|---|---|
| ||
<ResourceTypeCategory Name="US" ResourceType="Owner=Quality_Assurance ResourceType=DID" /> |
...
Defines the Resource Item’s Owner.
| Code Block | ||
|---|---|---|
| ||
<ResourceTypeCategoryOwner ResourceTypeCategory="Owner=Quality_Assurance ResourceType=DID ResourceTypeCategory=US" Target_Owner="Owner=Quality_Assurance" /> |
...
Defines the Resource Item’s Pool.
| Code Block | ||
|---|---|---|
| ||
<Reference Name="QA_Owner" Value="Owner=Quality_Assurance" /> <ResourceItemPool Name="All" ResourceTypeCategoryOwner="Owner=Quality_Assurance ResourceType=DID ResourceTypeCategory=US ResourceTypeCategoryOwner.Target_Owner=@QA_Owner" /> |
...
Defines the Resource Item’s Provider.
| Code Block | ||
|---|---|---|
| ||
<ResourceTypeProvider Name="Database Import" ResourceType="Owner=Quality_Assurance ResourceType=DID" /> |
...
To import just the profile question, use the first two data rows. note that the ReferenceName needs to be unique per line for importing
| Code Block | ||
|---|---|---|
| ||
<?xml version="1.0"?> <InventoryItems> <ProfileQuestion Name="MACAddress" Question="MAC Address" DataType="/DataType=MAC Address" Required="true" ReferenceName="QA_IIDAPQ_PQ" /> <InventoryItemDefinitionAttributeProfileQuestion InventoryItemDefinition="/Owner=Logisense Corporation/InventoryItemDefinition=VOIP Phone" ProfileQuestion="@QA_IIDAPQ_PQ" ReferenceName="QA_IIDAPQ" /> <ProfileAnswer Value="aa:bb:cc:dd:ee:ff" ProfileQuestion="@QA_IIDAPQ_PQ" ReferenceName="QA_IIAPA_PA" /> <InventoryItemAttributeProfileAnswer InventoryItemID="65" InventoryItemDefinitionAttributeProfileQuestion="@QA_IIDAPQ" ProfileAnswer="@QA_IIAPA_PA" /> <ProfileAnswer Value="bb:bb:cc:dd:ee:ee" ProfileQuestion="@QA_IIDAPQ_PQ" ReferenceName="QA_IIAPA_PA2" /> <InventoryItemAttributeProfileAnswer InventoryItemID="66" InventoryItemDefinitionAttributeProfileQuestion="@QA_IIDAPQ" ProfileAnswer="@QA_IIAPA_PA2" /> </InventoryItems> |
...
Owner’s Credit Card Types
| Code Block | ||
|---|---|---|
| ||
<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.
| Code Block | ||
|---|---|---|
| ||
<TaxCode TaxCode="USA" Owner="Quality_Assurance" Country="USA" State="New York" County="New York" City="New York" TaxClass="USA" TaxType="Access Tax"/> |
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 | ||
|---|---|---|
| ||
<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"/> |
TaxRate Imports
Owner’s Tax Rates
| Code Block | ||
|---|---|---|
| ||
<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 | ||
|---|---|---|
| ||
<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 | ||
|---|---|---|
| ||
<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 interfaceAdminPortal UI.
| Code Block | ||
|---|---|---|
| ||
<TaxClasses> <TaxClass TaxClass="USA" Owner="admin" /> <TaxClass TaxClass="Nevada" Owner="admin" /> </TaxClasses> |
...
Service’s Transaction Code for grouping.
| Code Block | ||
|---|---|---|
| ||
<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 | ||
|---|---|---|
| ||
<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 | ||
|---|---|---|
| ||
<TicketGroups> <TicketGroup Name="Support" Owner="admin" SortOrder="0" /> <TicketGroup Name="Accounting" Owner="admin" SortOrder="1" /> </TicketGroups> |
...
TicketTypeCategoryConnector
| Code Block | ||
|---|---|---|
| ||
<?xml version="1.0"?> <TicketTypeCategoryConnectors> <TicketTypeCategoryConnector Name="WiredNotes" TicketCategory="/Owner=Logisense Corporation/TicketCategory=Notes" TicketType="/Owner=Logisense Corporation/TicketType=Wired" /> </TicketTypeCategoryConnectors> |
Owner Ticket Email Template
| Code Block | ||
|---|---|---|
| ||
<?xml version="1.0"?> <OwnerTicketEmailTemplates> <OwnerTicketEmailTemplate Owner="/Owner=Logisense Corporation" EmailTemplate = "Hello testing ticket" /> </OwnerTicketEmailTemplates> |
Ticket Extended Attribute Import
| Code Block | ||
|---|---|---|
| ||
<?xml version="1.0"?> <TicketExtendedAttributes> <ProfileQuestion DataType="/DataType=Text" Name="TicketExt" Question="TicketExt" Required="True" UniqueAnswer="False" IncludeInInvoiceXML="True" ShowOnViewFilter="False" ReferenceName="pqTicketExt1" /> <TicketExtendedAttribute Owner="/Owner=Logisense Corporation" ProfileQuestion="@pqTicketExt1" /> </TicketExtendedAttributes> |
...
Here is for one with a select list:
| Code Block | ||
|---|---|---|
| ||
<?xml version="1.0"?> ><TicketExtendedAttributes> <ProfileQuestion DataType="/DataType=Text" Name="TicketExt" Question="TicketExt" Required="True" Options="ExtSupport, ExtBilling, ExtTest" UniqueAnswer="False" IncludeInInvoiceXML="True" ShowOnViewFilter="False" ReferenceName="pqTicketExt1" /> <TicketExtendedAttribute Owner="/Owner=Logisense Corporation" ProfileQuestion="@pqTicketExt1" /> </TicketExtendedAttributes> |
...
The migrator format here is the 'generic' format (where there is no specific import format to import the specific piece of data). It requires that you enter the owner as shown below in a string with the category. (The string of data actually then searches through the tables for the right owner to find where to import the data to)
| Code Block | ||
|---|---|---|
| ||
<TicketCategorySubcategories> <TicketCategorySubcategory TicketCategory="/Owner=admin/TicketCategory=Support" Name="Sub_Support" /> </TicketCategorySubcategories> |
...
Ticket resolutions attached to Categories / Subcategories
| Code Block | ||
|---|---|---|
| ||
<?xml version="1.0"?> <TicketResolutions> <TicketResolution Name="TestTR1" TicketCategory="/Owner=Logisense Corporation/TicketCategory=Billing" TicketCategorySubcategory="/Owner=Logisense Corporation/TicketCategory=Billing/TicketCategorySubcategory=Test" /> </TicketResolutions> |
...
Type = "Open" or "Closed" (system statuses)
Name = your custom status
| Code Block | ||
|---|---|---|
| ||
<TicketStatuss> <TicketStatus Owner="admin" Type="Open" Name="Open1" SortOrder="0" /> <TicketStatus Owner="admin" Type="Open" Name="OPen2" SortOrder="0" /> </TicketStatuss> |
...
Owner’s Ticket Priority
| Code Block | ||
|---|---|---|
| ||
<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 | ||
|---|---|---|
| ||
<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 |
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 | ||
|---|---|---|
| ||
<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 setup tab |
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 tab page for each owner you need to import translations for.
...
For generic translation xml files be sure to find and replace the owner with the correct owner for import.
| Code Block | ||
|---|---|---|
| ||
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <Languages> <Language Name="Word" Value="Word Replacement in Spanish" Owner="Test" Language="Spanish" SortOrder="0" /> <Language Name="Word2" Value="Word Replacement in Spanish2" Owner="Test" Language="Spanish" SortOrder="0" /> </Languages> |
For generic import which is used if special language characters and accents will not work is the below XML format where language ID corresponds to the ID of the language in the database:
| Code Block | ||
|---|---|---|
| ||
<?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 | ||
|---|---|---|
| ||
<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 | ||
|---|---|---|
| ||
<RolePermissions Role="/Owner=Logisense Corporation/Role=Admin" Name="BillUser/Edit_test" /> |
...
Update the 'x' there in the bottom sections with the ID of the role for each owner.
| Code Block | ||
|---|---|---|
| ||
<RoleAttributeProfileQuestions> <ProfileQuestion DataType="/DataType=Text" Name="InvoiceType-CustomerData" Question="InvoiceType-CustomerData" Required="False" Options="Yes, No" UniqueAnswer="False" ShowOnOverview="False" MultipleAnswers="False" DisplayName="InvoiceType-CustomerData" ParentQuestion="False" ProfileQuestionListProviderMultiSelect="False" ShowOnUserPackage="False" IncludeInInvoiceXML="True" ShowOnCustomerPortalSignup="False" ShowOnCustomerPortal="False" ShowOnViewFilter="False" ReferenceName="PROFILEQUESTIONx" /> <RoleAttributeProfileQuestion RoleID="x" ProfileQuestion="@PROFILEQUESTIONx" /> </RoleAttributeProfileQuestions> |
...
Same as above but this provides a select list instead of a text input box:
| Code Block | ||
|---|---|---|
| ||
<RoleAttributeProfileQuestions> <ProfileQuestion DataType="/DataType=Text" Name="On or off site?" Question="On or off site?" Required="True" Options="On Site,Off Site" UniqueAnswer="False" ShowOnOverview="False" MultipleAnswers="False" DisplayName="On or off site?" ParentQuestion="False" ProfileQuestionListProviderMultiSelect="False" ShowOnUserPackage="False" IncludeInInvoiceXML="True" ShowOnCustomerPortalSignup="False" ShowOnCustomerPortal="False" ShowOnViewFilter="False" ReferenceName="PROFILEQUESTIONx" /> <RoleAttributeProfileQuestion RoleID="x" ProfileQuestion="@PROFILEQUESTIONx" /> </RoleAttributeProfileQuestions> |
...
OwnerID must = the ID of the owner in the 'owner' table.
StatusTypeID must equal the id of the status type in 'StatusType' table
ImageURL - this is the URL pointing to the image you want displayed on the account for the specified status. A cancelled stamp or suspended stamp
ShowInAccountStatistics - this defines whether you want this named status to show in the account statistics at the bottom left of each page
Code Block language xml <UserStatusType Name="Enabled1" OwnerID="1" StatusTypeID="1" ImageURL="http://www.domain.com/ENABLEDimage.jpg" ShowInAccountStatistics="True"/>
...
The sample below provides a way to import rate plans. Note that if Inbound = true, it means you are importing an inbound rateplan. If its outbound, set that flag as false.
| Code Block | ||
|---|---|---|
| ||
<TelecomRatePlans> <TelecomRatePlan CSRName="Test" Owner="admin" Name="Test" RoundID="0" Rctrl="~" Starts="*" Ends="*" Active="0" InActive="0" Inbound="false" /> <TelecomRatePlan CSRName="Test1" Owner="admin" Name="Test1" RoundID="0" Rctrl="~" Starts="*" Ends="*" Active="0" InActive="0" Inbound="true" /> </TelecomRatePlans> |
...
The telecom buckets available within the system. These can be assigned to services using the Telecom Bucket service attribute.
| Code Block | ||
|---|---|---|
| ||
<TelecomBucket Name="Test" Code="NAT" Owner="LogiSense Corporation" /> |
Import UDR Rate Plan
Code Block language xml <UDRRatePlan Owner="Logisense Corporation" Name="newUDRrateplan" />
Attached UDR Rateplan to a Package/ Service
Code Block language xml <PackageAttributeUDRRatePlan Owner="admin" Package="iLine" Service="iLine" UDRRatePlan="newUDRrateplan" />
To import UDRClass, and UDRRateGroups the XML import works out of the box using the following format(s).
Code Block language xml <UDRClasss> <UDRClass Name="TestImportXMLClass" UDRRater="Class" Owner="/Owner=Logisense Corporation"/> <UDRClass Name="TestImportXMLGeo" UDRRater="Geo Tree" Owner="/Owner=Logisense Corporation"/> </UDRClasss>
...
For UDRRateGroups, they need UDRRates to be useful, and the stored procedure takes care of copying both, so you may want to continue having that as part of your procedure, but this will be useful for any new (System-wide) rategroups, add them to one Owner (ie: Logisense Corporation), import rates and then use the SP to copy to all.
| Code Block | ||
|---|---|---|
| ||
<UDRRateGroups> <UDRRateGroup Owner="/Owner=Logisense Corporation" Name="TestImportRateGroup" Start="2010-01-01 00:00:00.000" End="9999-12-31 23:59:59.997" Retired="0" UseForCost="0" /> <UDRRateGroup Owner="/Owner=Logisense Corporation" Name="TestImportRateGroup2" Start="2010-01-01 00:00:00.000" End="9999-12-31 23:59:59.997" Retired="0" UseForCost="0" /> </UDRRateGroups> |
...
UDR Rate Groups to RatePlans
| Code Block | ||
|---|---|---|
| ||
<UDRRatePlanUDRRateGroups> <UDRRatePlanUDRRateGroup UDRRatePlan="/Owner=OwnerName/UDRRatePlan=Standard" UDRRateGroup="/Owner=OwnerName/UDRRateGroup=Unlimited Domestic" Priority="1" /> </UDRRatePlanUDRRateGroups> |
UDR Custom Field Imports
| Code Block | ||
|---|---|---|
| ||
<UDRCustomField Name="Answered" DataType="Text" SQLDataType="nvarchar(3)" Label="Answered" Help="Was the call answered" /> |
Note Types Imports
| Code Block | ||
|---|---|---|
| ||
<NoteTypes> <NoteType Name="Test" Owner="/Owner=Logisense Corporation"/> <NoteType Name="Test" Owner="/Owner=ResellerX"/> </NoteTypes> |
...
FinancialPeriod
| Code Block | ||
|---|---|---|
| ||
<FinancialPeriod Owner="TopOwner" Name="PeriodName" StartDate="mm/dd/yyyy" EndDate="mm/dd/yyyy" FiscalYear="yyyy" FiscalQuarter="mm/dd/yyyy" FiscalMonth="mm" SystemGenerated="mm/dd/yyyy" FinancialPeriodStatus="Enabled" /> FinancialPeriodStatus <FinancialPeriodStatus Name="Enabled" /> |
Server Imports - Server and Profile Answers
| Code Block | ||
|---|---|---|
| ||
<Import> <GenericXML Enabled="True" /> <ServerType Name="servertype" Owner="/Owner=Logisense Corporation" AddedScript="ScriptName" RemovedScript="ScriptName" EnabledScript="ScriptName" DisabledScript="ScriptName" ProfileChangedScript="ScriptName" ReferenceName="ST1" /> <Server Name="test" Address="1.1.1.1" Owner="/Owner=Logisense Corporation" ServerType="/Owner=Logisense Corporation/ServerType=servertype" Identifier="ScriptIdentifier" ReferenceName="SERVER1"/> <ProfileQuestion Name="Username" Question="Username" DataType="Text" ReferenceName="PQ1"/> <ProfileQuestion Name="Password" Question="Password" DataType="Text" ReferenceName="PQ2"/> <ServerTypeAttributeProfileQuestion ServerType="@ST1" ProfileQuestion="@PQ1" ReferenceName="STAPQ1" /> <ServerTypeAttributeProfileQuestion ServerType="@ST1" ProfileQuestion="@PQ2" ReferenceName="STAPQ2"/> <ProfileAnswer ProfileQuestion="@PQ1" Value="answer1" ReferenceName="PA1" /> <ProfileAnswer ProfileQuestion="@PQ2" Value="answer2" ReferenceName="PA2"/> <ServerAttributeProfileAnswer ServerTypeAttributeProfileQuestion="@STAPQ1" Server="@SERVER1" ProfileAnswer="@PA1" /> <ServerAttributeProfileAnswer ServerTypeAttributeProfileQuestion="@STAPQ2" Server="@SERVER1" ProfileAnswer="@PA2" /> </Import> |
...
In order to get it working a TierSyncOwner and TierSyncPackage has to be present already in the database and make sure you reference the correct package and servers by name.
| Code Block | ||
|---|---|---|
| ||
<PackageAttributeTierSync Package="Toll Free Number" Service="Toll Free Number" Owner="Pulse Broadband" CoreOwner="Pulse Broadband (Parent Acct)" CorePackage="Toll Free Number" /> <PackageAttributeTierSync Package="DSL Package" Service="Extreme DSL Service" Owner="admin" CoreOwner="NewOwner" CorePackage="DialUp Package" /> |
...
Run the .exe named “Logisense.RateImporter.exe”. You will be greeted with a window that looks like this:
...
Click the Next button.
Now you are presented with the following options:
...
Click the Import Profile drop-down to select a file type that you will be importing:
...
After you have selected what you need, select the import file by clicking the Browse button and then the Next button to continue.
...
In this example, a somewhat incomplete Geotree GeoTree was used (and the first row was intentionally badinvalid), hence it found 6712 errors. At this point we can click Cancel, if we wish to try and fix things (update the Geotree, use the correct rates file if this one is wrong, etc.) We can also choose to click Next and continue importing the valid rates that were found. Note that before we select either option, we also have the “Save Errors” button on the left, where it will save a CSV file with all the ‘bad’ rates out.
...
OCN in the first column (three digits, and one alpha/digit)
Lata in the second column (three digits)
Amount in the third column (floating point number)
...
Troubleshooting - Common File Errors
Make sure your opening and closing tags are pluralized, ie add an 's' to the end. <tests> <test name="asdf"> </tests>
Make sure elements are spelled correctly and capitalized correctly
Make sure the data referenced exists in EngageIP. i.e. for things like taxcode being applied to customers, the taxcode specified must exist exactly as you have it typed in the file
If you are trying to open an XML file in Excel, make sure to have more than one line of data, two lines is the minimum otherwise Excel won't recognize the format correctly (this does not include opening and closing tags)