Wiki source code of Utilities - Mapper (v12.x)

Version 9.1 by melanie@one-count_com on 2016/12/15 16:37

version	line-number	content
4.1	1	{{layout}}
	2	{{layout-section ac:type="two_right_sidebar"}}
	3	{{layout-cell}}
3.1	4
	5
	6	{{id name="Start ScreenSteps Content"/}}
	7	The Mapper is used to create mappings for generating automated feed reports for export and for data import. This tool allows you to map your, or third party, data to ONEcount questions/data fields.
	8
	9	If you will be using the Dashboard Feed Report function to generate an automated feed report or will be performing a data import that requires mapping external file questions/data to ONEcount questions/data, you must complete the report mapping here first.
	10
	11	There are three types of mapping in the Mapper: Demographic Mapping and Transaction Mapping.
	12
	13	* Demographic Mapping: Demographic mapping maps external demographic questions/data fields and responses to ONEcount demographic questions and responses.
	14	* Transaction Mapping: Transaction mapping maps external transaction data, e.g. product activity, status, and date formats.
	15	* Activity Mapping: Activity mapping maps external activity headers, e.g. time on page, URL, impressions, etc. This mapping is used primarily for feed reports for export.
	16
	17	One or all of these types of mapping may be required, depending on the type of automated feed report you want to generate or the data import you'll be performing.
	18
	19	You can either import a layout file (.csv format) and map demographics and transactions directly from that file or manually enter the demographics, transactions, and activities you wish to map to ONEcount questions/data fields, or do a combination of both.
	20
	21	Please Note:
	22
	23	ONEcount questions and response values must be created prior to performing mapping.
	24
	25	Third-party activity headers currently can't be mapped via an uploaded layout file. They must be mapped manually in the Activity Mapping Area.
	26
4.1	27	== OPEN THE MAPPING WINDOW ==
3.1	28
	29	=== Select UTILTIES from the main menu. ===
	30
	31	[[image:attach:media_1468251499518.png\|\|align="center"]]
	32
	33	=== Select Mapper from the sub-menu. ===
	34
	35	[[image:attach:media_1468251557794.png\|\|align="center"]]
	36
	37	This will open the Manage Mapping Listing Page, as shown below.
	38
4.1	39	== CREATE A NEW DATA MAPPING ==
3.1	40
	41	[[image:attach:media_1467388147151.png\|\|align="center"]]
	42
	43	Select "Create Mapping" to create a new mapping. This will open the Mapping Builder, as shown below.
	44
	45	To edit an existing mapping, select the Edit icon.
	46	To delete an existing mapping, select the Delete icon.
	47
4.1	48	=== 1 – INFORMATION AND DEMOGRAPHIC MAPPING ===
3.1	49
	50	[[image:attach:media_1468252151743.png\|\|align="center"]]
	51
	52	Information and Demo Mapping consists of three main parts:
	53
	54	1 – Information
	55	2 – Mapping Area
	56	3 – ONEcount Questions
	57
	58	See below for detail on each part.
	59
5.1	60	==== (% style="color: rgb(128,0,0);" %)__Information__(%%) ====
3.1	61
4.1	62	(% style="margin-left: 30.0px;" %)
3.1	63	Name: Give the mapping a name (required)
	64
4.1	65	(% style="margin-left: 30.0px;" %)
3.1	66	Description: Provide a description of the mapping (optional)
	67
4.1	68	(% style="margin-left: 30.0px;" %)
3.1	69	Select whether you want to map transactions and/or activity: You can create a mapping for demographic questions only, or map any combination of demographics, transactions, and actions.
	70
4.1	71	(% style="margin-left: 30.0px;" %)
3.1	72	Upload Layout: Uploading a layout document is optional. You may opt to manually enter demographic and transactional questions and values to be mapped to ONEcount questions and values. Or, you may use a combination of both uploading a layout and manual entry.
	73
4.1	74	(% style="margin-left: 30.0px;" %)
3.1	75	(% style="text-decoration: underline;" %)//To Upload a Layout File//(%%)
	76	Click on the "Browse" button, locate the file on your computer, then click on "Upload File".
	77
4.1	78	(% style="margin-left: 30.0px;" %)
3.1	79	When you upload an external layout, the Demographic and Transacton Mapping Areas will be automatically pre-populated with each question/data field and values for that field. (See screenshotbelow)
	80
4.1	81	(% style="margin-left: 30.0px;" %)
3.1	82	See screenshots of pre-population and layout formatting rules below.
	83
4.1	84	(% style="margin-left: 60.0px;text-align: center;" %)
	85	**
	86	**
3.1	87
	88	[[image:attach:media_1468252886176.png\|\|align="center"]]
	89
4.1	90	(% style="margin-left: 60.0px;" %)
3.1	91	_(% style="text-decoration: underline;" %)Layout File Format(%%) _
	92	The layout file must be in .csv format and include markers for demographic questions (~#~##demographics), products (~#~##products~#~##), subscription type(~#~##subscriptionType~#~##), and product status (optional) (~#~##productStatus~#~##).
	93
4.1	94	(% style="margin-left: 60.0px;" %)
3.1	95	(% style="text-decoration: underline;" %)//Demographic Mapping//
	96
4.1	97	*
	98	**
	99	*** For Demographic Questions: Question text must be in Column A, response values for multiple response-type questions* in Column B, and response text values in Column C.
3.1	100	*Note that text-response type questions, e.g. last name, don't require values in Column B or C.
	101
4.1	102	(% style="margin-left: 60.0px;" %)
3.1	103	(% style="text-decoration: underline;" %)//Transaction Mapping//
	104
4.1	105	*
	106	**
	107	*** For Products: Product ID must be in Column A and Product name in Column B.
	108	*** For Subscription Type: Sub Type ID/value is in Column A and subscription type name in Column B.
	109	*** For Product Status: Status ID must be in Column A and Status name in Column B.
5.1	110	\\
3.1	111
5.1	112	(% style="text-align: center;" %)
4.1	113	//Screenshot: Pre-Populated Demographic Questions/Data Fields - Uploaded Layout//
3.1	114
	115	[[image:attach:media_1467396172019.png\|\|align="center"]]
	116
4.1	117
3.1	118
5.1	119	(% style="text-align: center;" %)
4.1	120	//Screenshot: Pre-populated Question Responses - Uploaded Layout//
	121
3.1	122	[[image:attach:media_1467391080266.png\|\|align="center"]]
	123
4.1	124
3.1	125
5.1	126	(% style="text-align: center;" %)
4.1	127	//Screenshot: Pre-Populated Transaction Mapping - Uploaded Layout//
	128
3.1	129	[[image:attach:media_1467391409099.png\|\|align="center"]]
	130
5.1	131	==== (% style="color: rgb(128,0,0);" %)__Map Third-Party Questions__(%%) ====
3.1	132
	133	[[image:attach:media_1467397686498.png\|\|align="center"]]
	134
5.1	135	(% style="margin-left: 30.0px;" %)
3.1	136	Prior to uploading a layout file, or if you opt to create the mapping on the fly (without uploading a layout file), the Mapping Area will be empty.
	137
5.1	138	(% style="margin-left: 30.0px;" %)
3.1	139	The mapping area consists of three columns: Third Party Questions, ONEcount Questions, and Validations.
	140
5.1	141	*
	142	Third Party Questions** shows questions/data fields your, or a third party's, data file.
	143	ONEcount Questions** shows the corresponding ONEcount question to be mapped to the Third Party Question.
	144	Validations** allows you to select validations for the mapped question, i.e., Required, Email, Number and Text, Text Only.
3.1	145
5.1	146	(% style="margin-left: 30.0px;" %)
4.1	147	===== Manually Add Third-Party Questions =====
3.1	148
5.1	149	(% style="margin-left: 30.0px;" %)
3.1	150	[[image:attach:media_1467398286154.png\|\|align="center"]]
	151
5.1	152	(% style="margin-left: 30.0px;" %)
3.1	153	When you click on the "Add Questions" button, you'll be presented with a pop-up to create a new question/data field to be mapped to an existing ONEcount question.
	154
5.1	155	(% style="margin-left: 30.0px;" %)
3.1	156	Be sure to select "Yes" if it is a question with selectable responses, i.e. radio button/select/checkbox-type. Click Save.
	157
6.1	158	==== (% style="color: rgb(128,0,0);" %)__Map Third-Party to ONEcount Questions and Responses
	159	__(%%) ====
3.1	160
6.1	161	(% style="color: rgb(128,0,0);" %)__ __
	162
	163	(% style="margin-left: 60.0px;" %)
	164	//YOU MUST FIRST MAP THE THIRD-PARTY QUESTION TO THE CORRESPONDING ONEcount QUESTION BY DRAGGING AND DROPPING THE CORRESPONDING ONEcount QUESTION FROM THE ONEcount Questions SECTION INTO THE ONEcount Questions Column BEFORE YOU CAN MAP RESPONSES.//
	165
	166	(% style="color: rgb(128,0,0);" %)__ __
	167
	168	(% style="margin-left: 60.0px;" %)
	169	//THIS APPLIES TO BOTH MANUALLY ADDED QUESTIONS AND QUESTIONS PRE-POPULATED BY UPLOAD OF AN IMPORT.//
	170
	171	(% style="color: rgb(128,0,0);" %)__ __
	172
	173	(% style="margin-left: 60.0px;" %)
	174	//ONEcount QUESTIONS AND RESPONSE VALUES MUST BE CREATED PRIOR TO PERFORMING MAPPING.//
	175
	176	(% style="color: rgb(128,0,0);" %)__
	177	__
	178
5.1	179	(% style="margin-left: 30.0px;" %)
3.1	180	[[image:attach:media_1467398257338.png\|\|align="center"]]
	181
5.1	182	(% style="margin-left: 30.0px;" %)
3.1	183	If the question is a radio button/select/checkbox-type question, a button will be presented which will allow you to map responses and values. (See "Upgrade Checkbox" question above.)
	184
5.1	185	(% style="margin-left: 30.0px;" %)
3.1	186
4.1	187	If it's a text-type response, you won't need to map responses and values.
3.1	188
6.1	189
4.1	190
5.1	191	(% style="margin-left: 30.0px;" %)
3.1	192	[[image:attach:media_1467398730892.png\|\|align="center"]]
	193
5.1	194	(% style="margin-left: 30.0px;" %)
3.1	195	Simply drag and drop ONEcount questions from the question pool into the appropriate cell in the mapping table.
	196
5.1	197	(% style="margin-left: 30.0px;" %)
3.1	198	Note the Search function at the top of the list of ONEcount questions. Just begin typing in the question name, and the list will be filtered for you. (See screenshot below.)
	199
5.1	200	(% style="margin-left: 30.0px;" %)
3.1	201	[[image:attach:media_1467398948360.png\|\|align="center"]]
	202
5.1	203	(% style="margin-left: 30.0px;" %)
3.1	204	Once Questions are mapped, you can add validations and/or map responses for radio/select/checkbox-type questions.
	205
5.1	206	(% style="margin-left: 30.0px;" %)
3.1	207	To add validations, click in the empty "Validations" box for the corresponding question and select from the drop-down list the validation(s) you want to apply to the question, i.e. Required, Email, Number and Text, Text Only. (See screenshot below.
	208
5.1	209	(% style="text-align: center;" %)
4.1	210	//Screenshot – Mapped Questions with Validations//
3.1	211
	212	[[image:attach:media_1467399198566.png\|\|align="center"]]
	213
5.1	214	(% style="margin-left: 30.0px;" %)
4.1	215	===== Map Question Responses =====
3.1	216
	217	[[image:attach:media_1467391237758.png\|\|align="center"]]
	218
	219	To map question responses, click on the "Response Map" button. Doing so will present a pop-up window where you can map third-party to ONEcount responses. Just drag and drop ONEcount responses from the list of ONEcount Responses into the appropriate cell.
	220
	221	When done mapping responses, click the "Save" button.
	222
	223	You'll be returned to Information and Demo Mapping where you can then continue mapping remaining questions or click "Next" to continue.
	224
	225	Depending on the mapping selections you made under "Information", clicking "Next" will direct you either to save the Demographic Mapping or to the Transaction Mapping and/or Activity Mapping sections.
	226
	227	=== 2 – TRANSACTION MAPPING ===
	228
	229	[[image:attach:media_1467651841763.png\|\|align="center"]]
	230
	231	Transaction Maping is done the same way as Demographic Mapping by using the drag and drop functionality to match Third-Party transaction values with ONEcount transaction values.
	232
	233	There are four Mapping Areas for Transaction Mapping:
	234
	235	* Product Mapping Area
	236	* Product Status Mapping Area (optional)
	237	* Subscription Mapping Area
	238	* Date Mapping Area
	239
	240	NOTE THAT MAPPING IS ID TO ID IN TRANSACTION MAPPING. THE ID IS FOUND IN PARENTHESIS AFTER THE TEXT IN THE "THIRDPARTY..." COLUMN OF MAPPING AREAS.
	241
	242	AS WITH DEMOGRPHIC MAPPING, ONECOUNT PRODUCTS, PRODUCT STATUSES, AND SUBSCRIPTION TYPES MUST BE CREATED PRIOR TO PERFORMING TRANSACTION MAPPING.
	243
	244	THIRD-PARTY TRANSACTION VALUES CAN BE PRE-POPULATED BY UPLOADING A LAYOUT FILE OR MANUALLY ENTERED (AS DESCRIBED IN "INFORMATION" SECTION ABOVE).
	245
	246	(% style="text-decoration: underline;" %)Product Mapping Area(%%)
	247	For automated data feed reports, the Third Party Product column shows what the ONEcount product name will be displayed as on output.
	248
	249	* For example, a user is subscribed to/registered for ABCXY Pharma Aug. Webinar(207) in ONEcount. The third party requires that on the report output show a value of August Webinar rather than ABCXY Pharma Aug. Webinar. Mapping ONEcount's ABCXY Pharma Aug. Webinar(207) product to August Webinar(400) will display the Third Party Product value of August Webinar on the output.
	250	Product Column Field: This identifies what to output as the header for the product field. Enter the heading that's required for the report output.
	251
	252	For imports, the Third Party Product column identifies the names/values from the import file that will be mapped to the ONEcount product.
	253
	254	* For example, there's "product" column in the import file that identifies what product a particular record is subscribed to or registered for. In the import file, August Webinar in that colum indicates the record is subscribed to/registered for the August Webinar. In ONEcount, the product name is ABCXY Pharma Aug. Webinar. Any record in the import file that has August Webinar in the product column will be subscribed to the ABCYXY Pharma Aug. Webinar product in ONEcount.
	255	Product Column Field: This identifies the column header for the product column in the import file. In the above example, you would enter "product".
	256
	257	(% style="text-decoration: underline;" %)Product Status Mapping Area (Optional)(%%)
	258	For automated data feed reports, the Third Party Product Status column shows what the ONEcount product status will be displayed as on output.
	259
	260	* For example, a user has a product status of "Not Active(405)" in ONEcount. The third party requires that the report output show a value of Inactive, rather than Not Active. Mapping ONEcont's "Not Active(405)" status to "Inactive(203)" will display the Third Party Product Status of Inactive on the output.
	261	Product Status Column Field: This identifies what to output as the header for the product status field. Enter the heading that's required for the report output.
	262
	263	For Imports, the Third Party Product Status column identifies what name/value from the import file will be mapped to the ONEcount product.
	264
	265	* For example, there's a "product status" column in the import file that identifies the product status a particular record has for a particular product. In the import file, "Inactive(203)"in that column indicates the record has a product status of inactive. In ONEcount, the product status is "Not Active(405)". Any record in the import file that has a product status of "Inactive" in the product status column will have the product status of "Not Active" applied to the record in ONEcount.
	266	Product Status Column Field: This identifies the column header for the product status column in the import file. In the above example, you would enter "product status".
	267
	268	(% style="text-decoration: underline;" %)Subscription Mapping Area(%%)
	269	For automated data feed reports, the Third Party Subscription column shows what the ONEcount subscription type will be displayed as on output.
	270
	271	* For example, a user has a subscription type of "n" in ONEcount. The third party requires that the report output show a value of new, rather than "n". Mapping ONEcont's "n" status to "new(new)" will display the Third Party Product Status of new on the output.
	272	Subscription Column Field: This identifies what to output as the header for the subscription type field. Enter the heading that's required for the report output.
	273
	274	For Imports, the Third Party Subscription column identifies what name/value from the import file will be mapped to the ONEcount product.
	275
	276	* For example, there's a "Subcription Type" column in the import file that identifies the subscription type a particular record has for a particular product. In the import file, "New" in that column indicates the record has a subscription type of new. In ONEcount, the subscription type is "n". Any record in the import file that has a product status of "New" in the subscription type column will have the product status of "n" applied to the record in ONEcount.
	277	Subscription Column Field: This identifies the column header for the subscription type column in the import file. In the above example, you would enter "Subscription Type".
	278
	279	(% style="text-decoration: underline;" %)Date Mapping Area(%%)
	280	For automated data feed reports, enter the format you would like dates to be exported as. For example mm/dd/yyyy will export as 07/05/2016 and yy/mm/dd will export as 16/07/05.
	281	Date Column Field: This identifies what to output as the header for the date field. Enter the heading that's required for the report output.
	282
	283	For Imports, enter the format of dates in the import file. For example, if a date is 07/05/2016, enter the format mm/dd/yyyy.
	284	Date Column Field: This identifies the column header for the date column in the import file.
	285
	286	When done with mapping, click "Next".
	287	You will then be brought either to Activity Mapping or Save, depending on selection made in 1 – Information.
	288
	289	=== 3 – ACTIVITY MAPPING ===
	290
	291	[[image:attach:media_1468256607407.png\|\|align="center"]]
	292
	293	Activity Maping is done the same way as Demographic and Transaction Mapping by using the drag and drop functionality to match Third Party Activity Header with ONEcount Activity Header. The Third Party Activity Headers will display as column headings for Web, Ad, and Newlsetter data in the export file.
	294
	295	Third-party activity headers currently can't be mapped via an uploaded layout file. They must be mapped manually in the Activity Mapping Area by clicking on the "Add Activity Header" button.
	296	When you click on the "Add Activity Header" button, you'll be presented with a pop-up where you can add the Activity Header Name.
	297
	298	The ONEcount Activity Header section is divided into the following categories: Web, Ad, Newsletter, Generic (includes general headers, such as ONEcount unique identifier, Channel Code, etc.) Note the scroll bar to move through the categories.
	299
	300	When finished mapping, click the "Next" button.
	301
4.1	302	== SAVE MAPPING ==
3.1	303
	304	When done with mapping(s), click "Next".
	305
	306	You then have the option to save the mapping (Save) or return to mapping (Previous).
	307
	308	Once mapping is saved, you can find it on the Manage Mapping listing page.
	309
	310	A saved mapping is ready to be used for generating automated feed reports in the Dashboard. See Dashboard Reports – Create Feed Report for more information.
	311
	312
	313
	314	{{id name="End ScreenSteps Content"/}}
4.1	315	{{/layout-cell}}
	316
	317	{{layout-cell}}
7.1	318	{{panel borderStyle="solid" title="Search all Documentation:"}}
4.1	319
	320
	321	{{livesearch/}}
7.1	322	{{/panel}}
4.1	323
7.1	324	{{panel borderStyle="solid" title="Search System UTILITIES:"}}
4.1	325
	326
	327	{{pagetreesearch rootPage="System Utilities"/}}
7.1	328	{{/panel}}
4.1	329
7.1	330	{{panel title="More System UTILITIES"}}
	331	{{expand title="Expand"}}
4.1	332
	333
	334	(% style="margin-left: 30.0px;" %)
	335	[[Job List>>doc:Utilities - Job List (v12\.x)]]
	336
	337	(% style="margin-left: 30.0px;" %)
7.1	338	[[Backend User Permissions>>doc:Utilities - Backend Users and Permissions (v12\.x)]]
4.1	339
	340	(% style="margin-left: 30.0px;" %)
7.1	341	[[Email Engine Sender Score>>doc:Email Engine and Sender Score]]
4.1	342
	343	(% style="margin-left: 30.0px;" %)
	344	[[Email Engine>>doc:Utilities - Email Engine (v12\.x)]]
	345
	346	(% style="margin-left: 30.0px;" %)
	347	Action Manager
	348
	349	(% style="margin-left: 30.0px;" %)
	350	[[Configuration Manager>>doc:Utilities - Configuration Manager (v12\.x)]]
	351
	352	(% style="margin-left: 30.0px;" %)
	353	Backend Activity Log
	354
	355	(% style="margin-left: 30.0px;" %)
	356	IVT Mitigator
	357
	358	(% style="margin-left: 30.0px;" %)
7.1	359	[[Widget Builder>>doc:Utilities - Widget Builder (v12\.x)]]
4.1	360
	361	(% style="margin-left: 30.0px;" %)
	362
	363
	364	(% style="margin-left: 30.0px;" %)
	365	Import/Export Tool
	366	{{/expand}}
7.1	367	{{/panel}}
	368
	369
	370
	371
4.1	372	{{/layout-cell}}
	373	{{/layout-section}}
	374	{{/layout}}