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

Version 4.1 by melanie@one-count_com on 2016/12/13 13:35
Show last authors
1 {{layout}}
2 {{layout-section ac:type="two_right_sidebar"}}
3 {{layout-cell}}
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
27 == **OPEN THE MAPPING WINDOW** ==
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
39 == **CREATE A NEW DATA MAPPING** ==
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
48 === **1 – INFORMATION AND DEMOGRAPHIC MAPPING** ===
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
60 ==== __Information__ ====
61
62 (% style="margin-left: 30.0px;" %)
63 **Name:** Give the mapping a name (required)
64
65 (% style="margin-left: 30.0px;" %)
66 **Description:** Provide a description of the mapping (optional)
67
68 (% style="margin-left: 30.0px;" %)
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
71 (% style="margin-left: 30.0px;" %)
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
74 (% style="margin-left: 30.0px;" %)
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
78 (% style="margin-left: 30.0px;" %)
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
81 (% style="margin-left: 30.0px;" %)
82 See screenshots of pre-population and layout formatting rules below.
83
84 (% style="margin-left: 60.0px;text-align: center;" %)
85 **
86 **
87
88 [[image:attach:media_1468252886176.png||align="center"]]
89
90 (% style="margin-left: 60.0px;" %)
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
94 (% style="margin-left: 60.0px;" %)
95 (% style="text-decoration: underline;" %)//Demographic Mapping//
96
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.
100 *Note that text-response type questions, e.g. last name, don't require values in Column B or C.
101
102 (% style="margin-left: 60.0px;" %)
103 (% style="text-decoration: underline;" %)//Transaction Mapping//
104
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.
110
111 //**Screenshot: Pre-Populated Demographic Questions/Data Fields - Uploaded Layout**//
112
113 [[image:attach:media_1467396172019.png||align="center"]]
114
115
116
117 **//Screenshot: Pre-populated Question Responses - Uploaded Layout//**
118
119 [[image:attach:media_1467391080266.png||align="center"]]
120
121
122
123 **//Screenshot: Pre-Populated Transaction Mapping - Uploaded Layout//**
124
125 [[image:attach:media_1467391409099.png||align="center"]]
126
127 ==== MAPPING AREA ====
128
129 [[image:attach:media_1467397686498.png||align="center"]]
130
131 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.
132
133 The mapping area consists of three columns: **Third Party Questions, ONEcount Questions, and Validations.**
134
135 * **Third Party Questions** shows questions/data fields your, or a third party's, data file.
136 * **ONEcount Questions** shows the corresponding ONEcount question to be mapped to the Third Party Question.
137 * **Validations** allows you to select validations for the mapped question, i.e., Required, Email, Number and Text, Text Only.
138
139 ===== Manually Add Third-Party Questions =====
140
141 [[image:attach:media_1467398286154.png||align="center"]]
142
143 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.
144
145 Be sure to select "Yes" if it is a question with selectable responses, i.e. radio button/select/checkbox-type. Click Save.
146
147 ===== Map Third-Party and ONEcount Questions =====
148
149 [[image:attach:media_1467398257338.png||align="center"]]
150
151 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.)
152
153
154 If it's a text-type response, you won't need to map responses and values.
155
156 (% style="margin-left: 30.0px;" %)
157 //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.//
158
159 (% style="margin-left: 30.0px;" %)
160 //THIS APPLIES TO BOTH MANUALLY ADDED QUESTIONS AND QUESTIONS PRE-POPULATED BY UPLOAD OF AN IMPORT.//
161
162 (% style="margin-left: 30.0px;" %)
163 //ONEcount QUESTIONS AND RESPONSE VALUES MUST BE CREATED PRIOR TO PERFORMING MAPPING.//
164
165 [[image:attach:media_1467398730892.png||align="center"]]
166
167 Simply drag and drop ONEcount questions from the question pool into the appropriate cell in the mapping table.
168
169 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.)
170
171 [[image:attach:media_1467398948360.png||align="center"]]
172
173 Once Questions are mapped, you can add validations and/or map responses for radio/select/checkbox-type questions.
174
175 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.
176
177 //**Screenshot – Mapped Questions with Validations**//
178
179 [[image:attach:media_1467399198566.png||align="center"]]
180
181 ===== Map Question Responses =====
182
183 [[image:attach:media_1467391237758.png||align="center"]]
184
185 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.
186
187 When done mapping responses, click the "Save" button.
188
189 You'll be returned to Information and Demo Mapping where you can then continue mapping remaining questions or click "Next" to continue.
190
191 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.
192
193 === 2 – TRANSACTION MAPPING ===
194
195 [[image:attach:media_1467651841763.png||align="center"]]
196
197 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.
198
199 There are four Mapping Areas for Transaction Mapping:
200
201 * Product Mapping Area
202 * Product Status Mapping Area (optional)
203 * Subscription Mapping Area
204 * Date Mapping Area
205
206 **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.**
207
208 **AS WITH DEMOGRPHIC MAPPING, ONECOUNT PRODUCTS, PRODUCT STATUSES, AND SUBSCRIPTION TYPES MUST BE CREATED PRIOR TO PERFORMING TRANSACTION MAPPING.**
209
210 **THIRD-PARTY TRANSACTION VALUES CAN BE PRE-POPULATED BY UPLOADING A LAYOUT FILE OR MANUALLY ENTERED (AS DESCRIBED IN "INFORMATION" SECTION ABOVE).**
211
212 *(% style="text-decoration: underline;" %)Product Mapping Area(%%) *
213 **For automated data feed reports**, the Third Party Product column shows what the ONEcount product name will be displayed as on output.
214
215 * 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.
216 **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.
217
218 **For imports,** the Third Party Product column identifies the names/values from the import file that will be mapped to the ONEcount product.
219
220 * 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.
221 **Product Column Field:** This identifies the column header for the product column in the import file. In the above example, you would enter "product".
222
223 (% style="text-decoration: underline;" %)**Product Status Mapping Area (Optional)**(%%)
224 **For automated data feed reports,** the Third Party Product Status column shows what the ONEcount product status will be displayed as on output.
225
226 * 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.
227 **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.
228
229 **For Imports**, the Third Party Product Status column identifies what name/value from the import file will be mapped to the ONEcount product.
230
231 * 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.
232 **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".
233
234 (% style="text-decoration: underline;" %)**Subscription Mapping Area**(%%)
235 **For automated data feed reports,** the Third Party Subscription column shows what the ONEcount subscription type will be displayed as on output.
236
237 * 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.
238 **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.
239
240 **For Imports**, the Third Party Subscription column identifies what name/value from the import file will be mapped to the ONEcount product.
241
242 * 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.
243 **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".
244
245 (% style="text-decoration: underline;" %)**Date Mapping Area**(%%)
246 **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.
247 **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.
248
249 **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.
250 **Date Column Field:** This identifies the column header for the date column in the import file.
251
252 When done with mapping, click "Next".
253 You will then be brought either to Activity Mapping or Save, depending on selection made in 1 – Information.
254
255 === 3 – ACTIVITY MAPPING ===
256
257 [[image:attach:media_1468256607407.png||align="center"]]
258
259 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.
260
261 **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.**
262 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.
263
264 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.
265
266 When finished mapping, click the "Next" button.
267
268 == **SAVE MAPPING** ==
269
270 When done with mapping(s), click "Next".
271
272 You then have the option to save the mapping (Save) or return to mapping (Previous).
273
274 Once mapping is saved, you can find it on the Manage Mapping listing page.
275
276 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.
277
278
279
280 {{id name="End ScreenSteps Content"/}}
281 {{/layout-cell}}
282
283 {{layout-cell}}
284 **Search all Documentation:**
285
286
287
288 {{livesearch/}}
289
290
291
292 **Search System UTILITIES:**
293
294
295
296 {{pagetreesearch rootPage="System Utilities"/}}
297
298
299
300 **On this page:**
301
302
303
304 {{toc maxLevel="3"/}}
305
306
307
308 {{expand title="More System UTILITIES"}}
309 [[QR Codes>>doc:Utilities - QR Codes (v12\.x)]]
310
311 (% style="margin-left: 30.0px;" %)
312 [[Job List>>doc:Utilities - Job List (v12\.x)]]
313
314 (% style="margin-left: 30.0px;" %)
315
316
317 (% style="margin-left: 30.0px;" %)
318 [[Email Engine Sender Score>>doc:Utilities - Email Engine (v12\.x)]]
319
320 (% style="margin-left: 30.0px;" %)
321 [[Email Engine>>doc:Utilities - Email Engine (v12\.x)]]
322
323 (% style="margin-left: 30.0px;" %)
324 Action Manager
325
326 (% style="margin-left: 30.0px;" %)
327 [[Configuration Manager>>doc:Utilities - Configuration Manager (v12\.x)]]
328
329 (% style="margin-left: 30.0px;" %)
330 Backend Activity Log
331
332 (% style="margin-left: 30.0px;" %)
333 IVT Mitigator
334
335 (% style="margin-left: 30.0px;" %)
336
337
338 (% style="margin-left: 30.0px;" %)
339
340
341 (% style="margin-left: 30.0px;" %)
342 Import/Export Tool
343 {{/expand}}
344 {{/layout-cell}}
345 {{/layout-section}}
346 {{/layout}}