Data Import/Xero Ledger Code Mapping - Revision history

Dcowan: page moved to confluence

2018-01-22T07:33:57Z

page moved to confluence

Dcowan: apparently somebody decided to change the tab name without changing the documentation

2017-07-11T05:47:18Z

apparently somebody decided to change the tab name without changing the documentation

Dcowan: added SystemEvents/EventTypes#Bulk_Upload_Processing_Notification link

2016-04-29T07:00:54Z

added SystemEvents/EventTypes#Bulk_Upload_Processing_Notification link

Dcowan: spelling - and xero guid definition

2016-04-22T03:06:57Z

spelling - and xero guid definition

Scarpenter: /* See Also */

2016-03-01T00:01:59Z

‎See Also

Scarpenter: /* Preparing your Data */

2015-12-22T02:50:27Z

‎Preparing your Data

Scarpenter: /* Xero Ledger Account Mappings Data Definitions */

2015-12-22T02:42:49Z

‎Xero Ledger Account Mappings Data Definitions

Scarpenter at 02:07, 22 December 2015

2015-12-22T02:07:03Z

Scarpenter: Created page with "= Import Ledger Code Mapping for Xero ="

2015-12-18T06:40:56Z

Created page with "= Import Ledger Code Mapping for Xero ="

New page

= Import Ledger Code Mapping for Xero =

← Older revision		Revision as of 07:33, 22 January 2018
Line 1:		Line 1:
−	~~= Import Ledger Code Mapping for Xero =~~	+	This page has been moved to --> [https://resources.emersion.com/display/EKB/Ledger+Code+Mapping+with+Xero+Integration Ledger Code Mapping with Xero Integration]
−
−	This ~~feature provides an easy and fast way~~ to ~~import xero ledger code mappings via a bulk upload tool.~~
−
−	~~The system utilises the '''~~[~~[SystemEvents~~/~~EventTypes#Bulk_Upload_Processing_Notification\|Bulk upload processing notification event]]''' to send a notification with the results of the import attempt~~. ~~See below for further information~~.
−
−	~~If the import is successful, the email notification will advise you when the import process is complete. <br~~ />
−	~~If the import is not successful, the email notification will send details of the records that failed validation and why.~~
−
−	~~== Preparing your Data ==~~
−	~~To prepare your data for import, you will need to create a CSV import file or you can download the import file below. You will need to extract the csv file and save it.~~
−
−	~~[[media: xero-ledger-code-mapping-import-template.csv]]~~
−
−	~~Export the full list of Emersion ledger codes by running the '''~~Ledger ~~Codes (and~~ Mapping~~)''' report located on the '''Reference''' tab under the Reports section of Cumulus.~~
−
−	Enter the data into the import sheet. You must ensure the data meets all validation requirements that are contained in the data definition table below. When you submit the data file for import, the system will parse the file looking for errors. If the system finds no errors, the system will import the ledger code mappings into the system. The file needs to be error-free in order to import the data. In the event errors are found, no data will be imported into Emersion. Review the bulk upload processing notification email, correct the file and try again.
−
−	~~== Importing your Data ==~~
−
−	~~To access the Xero Ledger Mapping import tool:~~
−
−	~~# Log into Cumulus.~~
−	~~# Nav: '''Admin > Bulk Import > Ledger Account Mapping'''.~~
−	~~# Click the Browse button and select the csv file containing the data you want to import.~~
−	# If you want the bulk upload processing notification email to be sent to a different email address than the address defined in the event template, tick the Override? checkbox and enter an alternative email address. This will only apply for this upload. To change the email address for all future imports, you will need to change the recipient defined in the event template.
−	~~# Press '''Submit'''~~
−
−	== Xero ~~Ledger Account Mappings Data Definitions ==~~
−
−	~~{\| class="wikitable"~~
−	\|+~~Xero Ledger Account Mappings Import Data Definition table~~
−	~~\|Data field \|\|Description~~
−	\|-
−	\|LEDGER_CODE_ID \|\|The ID of Emersion ledger code. This is optional however if this is not provided, Emersion will attempt to import based on the LEDGER_CODE_NAME. You must provide either a LEDGER_CODE_ID or a LEDGER_CODE_NAME.
−	\|-
−	~~\|LEDGER_CODE_NAME \|\|The name of the Emersion~~ Ledger Code~~. This is optional however if this is not provided, Emersion will attempt to import based on the LEDGER_CODE_ID. You must provide a LEDGER_CODE_ID or a LEDGER_CODE_NAME.~~
−	\|-
−	\|XERO_LEDGER_ACCOUNT_NAME \|\| The ledger account name in Xero. These can be found in Xero, or in Cumulus when mapping an Emersion ledger code to a Xero ledger account manually. This is optional however if this is not provided Emersion will attempt to import based on the XERO_LEDGER_ACCOUNT_CODE. You must provide a XERO_LEDGER_ACCOUNT_NAME, a XERO_LEDGER_ACCOUNT_CODE, or a XERO_LEDGER_ACCOUNT_GUID.
−	\|-
−	\|XERO_LEDGER_ACCOUNT_CODE \|\| The account code in Xero. These can be found in Xero, or in Cumulus when mapping an Emersion ledger code to a Xero ledger account manually. This is optional however if this is not provided Emersion will attempt to import based on the XERO_LEDGER_ACCOUNT_CODE. You must provide a XERO_LEDGER_ACCOUNT_NAME, a XERO_LEDGER_ACCOUNT_CODE, or a XERO_LEDGER_ACCOUNT_GUID.
−	\|-
−	~~\|XERO_LEDGER_ACCOUNT_GUID \|\| The ledger account ID. This can be found in Xero. (eg. 18e27517-81e0-437c-bc21-fbba8e30d6bb)~~
−	\|-
−	~~\|DESCRIPTION \|\| Provide an optional description.~~
−	\|-
−	\|}
−
−	~~=== Xero Ledger Account data in Cumulus ===~~
−
−	~~To find the XERO_LEDGER_ACCOUNT_NAME or XERO_LEDGER_ACCOUNT_CODE in Cumulus follow the steps below.~~
−
−	~~'''Nav: Admin > Xero > Xero Ledger Map'''~~
−
−	~~# Click on any Emersion Ledger Code name. A pop up will open.~~
−	~~# Drop down the list of Mapped Ledger Codes to view the names and codes to use in the import sheet~~
−
−	~~= See Also =~~
−
−	* [[Integrations/Xero \| Xero Integration ~~with Emersion]]~~
−	* [[Events \| Emersion System Events]]

@@ Line 22: / Line 22: @@
 # Log into Cumulus.
-# Nav: '''Admin > Bulk Import > Xero Ledger Account Mappings'''.
+# Nav: '''Admin > Bulk Import > Ledger Account Mapping'''.
 # Click the Browse button and select the csv file containing the data you want to import.
 # If you want the bulk upload processing notification email to be sent to a different email address than the address defined in the event template, tick the Override? checkbox and enter an alternative email address. This will only apply for this upload. To change the email address for all future imports, you will need to change the recipient defined in the event template.

@@ Line 3: / Line 3: @@
 This feature provides an easy and fast way to import xero ledger code mappings via a bulk upload tool.
-The system utilises the '''Bulk upload processing notification event''' to send a notification with the results of the import attempt. See below for further information.
+The system utilises the '''[[SystemEvents/EventTypes#Bulk_Upload_Processing_Notification|Bulk upload processing notification event]]''' to send a notification with the results of the import attempt. See below for further information.
 If the import is successful, the email notification will advise you when the import process is complete. <br />

@@ Line 41: / Line 41: @@
 |XERO_LEDGER_ACCOUNT_CODE  || The account code in Xero. These can be found in Xero, or in Cumulus when mapping an Emersion ledger code to a Xero ledger account manually. This is optional however if this is not provided Emersion will attempt to import based on the XERO_LEDGER_ACCOUNT_CODE. You must provide a XERO_LEDGER_ACCOUNT_NAME, a XERO_LEDGER_ACCOUNT_CODE, or a XERO_LEDGER_ACCOUNT_GUID.
 |-
-|XERO_LEDGER_ACCOUNT_GUID || The ledger account ID. This can be found in Xero.
+|XERO_LEDGER_ACCOUNT_GUID || The ledger account ID. This can be found in Xero. (eg. 18e27517-81e0-437c-bc21-fbba8e30d6bb)
 |-
 |DESCRIPTION || Provide an optional description.
@@ Line 58: / Line 58: @@
 = See Also =
-* [[Integrations/Xero | Xero Inegration with Emersion]]
+* [[Integrations/Xero | Xero Integration with Emersion]]
-* [[Events]]
+* [[Events | Emersion System Events]]

← Older revision		Revision as of 00:01, 1 March 2016
Line 59:		Line 59:

	* [[Integrations/Xero \| Xero Inegration with Emersion]]		* [[Integrations/Xero \| Xero Inegration with Emersion]]
		+	* [[Events]]

@@ Line 10: / Line 10: @@
 == Preparing your Data ==
 To prepare your data for import, you will need to create a CSV import file or you can download the import file below. You will need to extract the csv file and save it.
 [[media: xero-ledger-code-mapping-import-template.csv]]

@@ Line 36: / Line 36: @@
 |Data field ||Description
 |-
-|LEDGER_CODE_ID	||The ID of Emersion ledger code. This is optional however if this is not provided, Emersion will attempt to import based on the LEDGER_CODE_NAME. You must provide a LEDGER_CODE_ID or a LEDGER_CODE_NAME.
+|LEDGER_CODE_ID	||The ID of Emersion ledger code. This is optional however if this is not provided, Emersion will attempt to import based on the LEDGER_CODE_NAME. You must provide either a LEDGER_CODE_ID or a LEDGER_CODE_NAME.
 |-
 |LEDGER_CODE_NAME     ||The name of the Emersion Ledger Code. This is optional however if this is not provided, Emersion will attempt to import based on the LEDGER_CODE_ID. You must provide a LEDGER_CODE_ID or a LEDGER_CODE_NAME.
 |-
-|xero_ledger_account_name	||
+|XERO_LEDGER_ACCOUNT_NAME || The ledger account name in Xero. These can be found in Xero, or in Cumulus when mapping an Emersion ledger code to a Xero ledger account manually. This is optional however if this is not provided Emersion will attempt to import based on the XERO_LEDGER_ACCOUNT_CODE. You must provide a XERO_LEDGER_ACCOUNT_NAME, a XERO_LEDGER_ACCOUNT_CODE, or a XERO_LEDGER_ACCOUNT_GUID.
 |-
-|IS_SHARED     || A flag denoting if any available quota which remains at the end of the period can be shared with other services on the same account with similar shared subscriptions. Accepted values are:
+|XERO_LEDGER_ACCOUNT_CODE  || The account code in Xero. These can be found in Xero, or in Cumulus when mapping an Emersion ledger code to a Xero ledger account manually. This is optional however if this is not provided Emersion will attempt to import based on the XERO_LEDGER_ACCOUNT_CODE. You must provide a XERO_LEDGER_ACCOUNT_NAME, a XERO_LEDGER_ACCOUNT_CODE, or a XERO_LEDGER_ACCOUNT_GUID.
 |-
-|FALLBACK_RATECARD_ID || The ID of the rate card that is used once the included value is reached and excess charges commences. The rate card must exist in Emersion. (optional field)
+|XERO_LEDGER_ACCOUNT_GUID || The ledger account ID. This can be found in Xero.
 |-
-|INCLUDED_VALUE_TYPE_ID   ||The type of included value. Accepted values are:
+|DESCRIPTION || Provide an optional description.
 |-
-|SERVICE_PLAN_ID     ||Service plan this included value is for. The service plan must exist in Emersion, (mandatory field)
+|}
-|-
-|INCLUDED_VALUE_SLOT_TYPE_ID     ||  The corresponding slot number. Accepted values are:
+=== Xero Ledger Account data in Cumulus ===
-* SLOT1
-* SLOT2
+To find the XERO_LEDGER_ACCOUNT_NAME or XERO_LEDGER_ACCOUNT_CODE in Cumulus follow the steps below.
-* SLOT3
-* SLOT4
+'''Nav:  Admin > Xero > Xero Ledger Map'''
-These fields ''are'' case sensitive (mandatory field)
+# Click on any Emersion Ledger Code name. A pop up will open.
-|-
+# Drop down the list of Mapped Ledger Codes to view the names and codes to use in the import sheet
 = See Also =
 * [[Integrations/Xero | Xero Inegration with Emersion]]

← Older revision		Revision as of 02:07, 22 December 2015
Line 1:		Line 1:
	= Import Ledger Code Mapping for Xero =		= Import Ledger Code Mapping for Xero =
		+
		+	This feature provides an easy and fast way to import xero ledger code mappings via a bulk upload tool.
		+
		+	The system utilises the '''Bulk upload processing notification event''' to send a notification with the results of the import attempt. See below for further information.
		+
		+	If the import is successful, the email notification will advise you when the import process is complete. <br />
		+	If the import is not successful, the email notification will send details of the records that failed validation and why.
		+
		+	== Preparing your Data ==
		+	To prepare your data for import, you will need to create a CSV import file or you can download the import file below. You will need to extract the csv file and save it.
		+
		+	There is a hard limit of 10,000 notes that can be created using this import tool. If you need to import more than 10,000 notes at a time, please create multiple import files.
		+	A single import file can have up to 9999 rows of data plus the header row.
		+
		+	[[media: xero-ledger-code-mapping-import-template.csv]]
		+
		+	Export the full list of Emersion ledger codes by running the '''Ledger Codes (and Mapping)''' report located on the '''Reference''' tab under the Reports section of Cumulus.
		+
		+	Enter the data into the import sheet. You must ensure the data meets all validation requirements that are contained in the data definition table below. When you submit the data file for import, the system will parse the file looking for errors. If the system finds no errors, the system will import the ledger code mappings into the system. The file needs to be error-free in order to import the data. In the event errors are found, no data will be imported into Emersion. Review the bulk upload processing notification email, correct the file and try again.
		+
		+	== Importing your Data ==
		+
		+	To access the Xero Ledger Mapping import tool:
		+
		+	# Log into Cumulus.
		+	# Nav: '''Admin > Bulk Import > Xero Ledger Account Mappings'''.
		+	# Click the Browse button and select the csv file containing the data you want to import.
		+	# If you want the bulk upload processing notification email to be sent to a different email address than the address defined in the event template, tick the Override? checkbox and enter an alternative email address. This will only apply for this upload. To change the email address for all future imports, you will need to change the recipient defined in the event template.
		+	# Press '''Submit'''
		+
		+	== Xero Ledger Account Mappings Data Definitions ==
		+
		+	{\| class="wikitable"
		+	\|+Xero Ledger Account Mappings Import Data Definition table
		+	\|Data field \|\|Description
		+	\|-
		+	\|LEDGER_CODE_ID \|\|The ID of Emersion ledger code. This is optional however if this is not provided, Emersion will attempt to import based on the LEDGER_CODE_NAME. You must provide a LEDGER_CODE_ID or a LEDGER_CODE_NAME.
		+	\|-
		+	\|LEDGER_CODE_NAME \|\|The name of the Emersion Ledger Code. This is optional however if this is not provided, Emersion will attempt to import based on the LEDGER_CODE_ID. You must provide a LEDGER_CODE_ID or a LEDGER_CODE_NAME.
		+	\|-
		+	\|xero_ledger_account_name \|\|
		+	\|-
		+	\|IS_SHARED \|\| A flag denoting if any available quota which remains at the end of the period can be shared with other services on the same account with similar shared subscriptions. Accepted values are:
		+	* 0 Is not shared
		+	* 1 Is shared
		+	If left blank, 0 will be set. (optional field)
		+	\|-
		+	\|FALLBACK_RATECARD_ID \|\| The ID of the rate card that is used once the included value is reached and excess charges commences. The rate card must exist in Emersion. (optional field)
		+	\|-
		+	\|INCLUDED_VALUE_TYPE_ID \|\|The type of included value. Accepted values are:
		+	* Dollars
		+	* Seconds
		+	* Kilobytes
		+	* Units
		+	These fields ''are'' case sensitive (mandatory field)
		+	\|-
		+	\|SERVICE_PLAN_ID \|\|Service plan this included value is for. The service plan must exist in Emersion, (mandatory field)
		+	\|-
		+	\|INCLUDED_VALUE_SLOT_TYPE_ID \|\| The corresponding slot number. Accepted values are:
		+	* SLOT1
		+	* SLOT2
		+	* SLOT3
		+	* SLOT4
		+
		+	These fields ''are'' case sensitive (mandatory field)
		+	\|-
		+	\|EXTERNAL_NAME \|\|The ‘external’ name is the vanity name for this included value allowance that will be used on any external or public facing interface or invoice. (mandatory field)
		+	\|-
		+	\|INCVAL_PRORATA \|\|A flag denoting whether the allowance is pro-rated when a short period exists. Accepted values are:
		+	* 0 allowance is not pro-rated
		+	* 1 allowance is pro-rated
		+	If left blank, 1 will be set. (optional field)
		+	\|-
		+	\|SHARE_KEY \|\| When shared (Is Shared = 1), sharing the included value is achieved via a key. The share key is a string of alphanumeric characters. If '''Is Shared''' = 0, this information will be discarded. If '''Is Shared''' = 1, this is mandatory.
		+	\|-
		+	\|}
		+
		+	= See Also =
		+
		+	* [[Integrations/Xero \| Xero Inegration with Emersion]]