Data Import/Bulk Referral Programme - Revision history

Scarpenter: /* This Content Has Moved House */

2017-10-16T01:32:43Z

‎This Content Has Moved House

Scarpenter: Replaced content with "{{DISPLAYTITLE:Bulk Referral Programme}} =This Content Has Moved House= This article has been moved to our new home for documentation and help content, the new Emersion K..."

2017-10-16T01:32:24Z

Replaced content with "{{DISPLAYTITLE:Bulk Referral Programme}} =This Content Has Moved House= This article has been moved to our new home for documentation and help content, the new Emersion K..."

Scarpenter: /* Bulk Update Quarantine Data Definition */

2015-10-01T00:50:42Z

‎Bulk Update Quarantine Data Definition

Scarpenter: Created page with "= Bulk Referral Programme = This bulk tool is used exclusively with the Referral Programme feature to perform a number of activities that form part of the referral programme..."

2015-10-01T00:49:57Z

Created page with "= Bulk Referral Programme = This bulk tool is used exclusively with the Referral Programme feature to perform a number of activities that form part of the referral programme..."

New page

= Bulk Referral Programme =

This bulk tool is used exclusively with the Referral Programme feature to perform a number of activities that form part of the referral programme business process. This tool will:

# Trigger a notification to the customer who referred another customer ('referrer').
# Trigger a notification to the customer (end user) who was referred by an existing customer ('referee').
# Add and activate a bolt-on add-on to the referrer's service subscription
# Add and activate a bolt-on add-on to the referee's service subscription

A total of three (3) events are used by this process and all events need to have a template and be active in order for the bulk tool to successfully complete all actions.

* Notify Service Referrer of bonus Bolt On Add On (event type ID: 1021)
* Notify Service Referee of bonus Bolt On Add On (event type ID: 1022)

The bulk upload tool utilises the '''Bulk upload processing notification''' event to send a notification with the results of the bulk approval attempt. You must set up a template for this event and enable it before you can use this tool.
If the bulk update is successful, the email notification will advise you when the process is complete. If the bulk approval is not successful, the email notification will send details of the records that failed to be approved 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 template file below. To assist further with this task, the following reports will contain data with values that are accepted by the import tool.

There is a hard limit of 20,000 records that can be updated using this import tool. If you need to update more than 20,000 notes at a time, please create multiple import files. A single import file can have up to 19,999 rows of data plus the header row.

[[File:bulk-referral-programme-template.csv]]

You must ensure the data meets all validation requirements. These 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 notes 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 bulk quarantine cleanse tool:

# Log into Cumulus.
# '''Nav: Admin > Bulk Import > Referral Programme'''.
# Click the '''Browse''' button and select the csv file containing the list of records you want to update.
# 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 or approvals, you will need to change the recipient defined in the event template.
# Press '''Submit'''

The system will validate the data and if no errors are found, the system will approve the invoices. When the notification email is received, the process has been completed.

<strong>'''It is strongly recommended that you check a few random records to ensure that bulk update was a success. If you find an problem, you cannot roll back the bulk actions.'''</strong>Should this occur, and you wish for Emersion to correct the data, you will need to submit a request to Emersion to fix the errors for you. This request can be submitted via [[Support_and_help_from_Emersion#Work_Orders | work order ticket]]. Please include a new csv data file with the records that need to be corrected. Do not include any records that do not need correcting.

== Bulk Update Quarantine Data Definition ==

This section contains a list of the required fields and a definition of what the system considers as valid data.

{| class="wikitable"
|+Bulk Referral Programme Data Definition table
|Data field ||Description
|-
|REFEREE_ACCOUNT_ID ||The account ID of the customer who was referred. (mandatory field)
|-
|REFEREE_PLAN_BOLTON_ADDON_ID || The ID of the bolt-on add-on that will be added against the customer who was referred. (mandatory field)
|-
|REFEREE_BONUS_TERM || The period for which the bonus bolt-on add-on will be valid for, given in months to the referee. Note: this will not be used to expire the bolt-on add-on automatically but will be implemented at a later date. (mandatory field)
|-
|REFERRER_ACCOUNT_ID || The account ID of the referrer. (mandatory field)
|-
|REFERRER_PLAN_BOLTON_ADDON_ID || The ID of the bolt-on add-on that will be added against the customer who was referred. (mandatory field)
|-
|REFERRER_BONUS_TERM || The period for which the bonus bolt-on add-on will be valid for, given in months to the referrer. Note: this will not be used to expire the bolt-on add-on automatically but will be implemented at a later date. (mandatory field)
|-
|SERVICE_REFERRAL_ID || The id of the service referral. This is shown on the Service Referral table on the Marketing / Referral tab of the customer who was referred ('referee').
|-
|}

@@ Line 6: / Line 6: @@
 We are sorry for the untidiness while we are shifting locations and we appreciate your patience during the transition to out new home.
-[https://resources.emersion.com/display/EKB/Service+Type+Migrations Take me to the Emersion Knowledge Base article]
+[https://resources.emersion.com/display/EKB/Referral+Programme Take me to the Emersion Knowledge Base article]
 [[file:new_home_sm.jpg|900px]]

@@ Line 1: / Line 1: @@
-= Bulk Referral Programme =
+{{DISPLAYTITLE:Bulk Referral Programme}}
-This bulk tool is used exclusively with the Referral Programme feature to perform a number of activities that form part of the referral programme business process. This tool will:
+This article has been moved to our new home for documentation and help content, the new Emersion Knowledge Base.
-# Trigger a notification to the customer who referred another customer ('referrer').
+We are sorry for the untidiness while we are shifting locations and we appreciate your patience during the transition to out new home.
-A total of three (3) events are used by this process and all events need to have a template and be active in order for the bulk tool to successfully complete all actions.
+[https://resources.emersion.com/display/EKB/Service+Type+Migrations Take me to the Emersion Knowledge Base article]
-* Notify Service Referrer of bonus Bolt On Add On (event type ID: 1021)
+[[file:new_home_sm.jpg|900px]]

@@ Line 60: / Line 60: @@
 |REFERRER_BONUS_TERM || The period for which the bonus bolt-on add-on will be valid for, given in months to the referrer. Note: this will not be used to expire the bolt-on add-on automatically but will be implemented at a later date. (mandatory field)
 |-
-|SERVICE_REFERRAL_ID || The id of the service referral. This is shown on the Service Referral table on the Marketing / Referral tab of the customer who was referred ('referee').
+|SERVICE_REFERRAL_ID || The id of the service referral. This is shown on the Service Referral table on the Marketing / Referral tab of the customer who was referred ('referee'). (mandatory field)
 |-
 |}