Wiki source code of Utilities - DExTr

Version 12.1 by Admin on 2019/12/28 19:29
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
8 DExTr is ONEcount’s data exchange and transformation engine. This tool enables data exchanges between any data source or third-party vendor. Establish a data map once and, going forward, easily import and export data in and out of ONEcount’s Customer Data Platform.
9
10 This tool the capabilities to map and sync first- or third-party data to ONEcount questions/data fields.
11
12 If there are multiple databases with similar fields, DExTr can consolidate the similar datapoints into a single ONEcount question or keep the fields separate. //(Example: if the field for ‘Customer ID’ in a legacy database is “CUST_ID” and the field name in a CRM is “CID”, there is an option to have the data consolidated in to the single ONEcount question that may be named “CustomerID”.//
13
14 **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.**
15
16 There are three types of mapping in the Mapper: Demographic Mapping and Transaction Mapping.
17
18 * (((
19 **Demographic Mapping:** Demographic mapping maps external demographic questions/data fields and responses to ONEcount demographic questions and responses.
20 )))
21 * (((
22 **Transaction Mapping:** Transaction mapping maps external transaction data, e.g. product purchase activity, status, and date formats.
23 )))
24 * (((
25 **Engagement 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, or importing activity from another system like an e-mail system.
26 )))
27
28 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.
29
30 You can either import a layout file (.csv format) with all of the necessary demographic, transacactional and engagement fields,  and map demographics and transactions directly from that file, or you can manually enter the demographics, transactions, and activities you wish to map to ONEcount questions/data fields, or do a combination of both.
31
32 **Please Note:**
33
34 **ONEcount questions, response valuess, products and packages must be created prior to performing mapping.**
35
36 **Third-party activity headers currently can't be mapped via an uploaded layout file. They must be mapped manually in the Activity Mapping Area.**
37
38 **OPEN THE MAPPING WINDOW**
39
40 Select UTILITIES from the main menu and the DExTr from the sub-menu.
41
42 [[image:attach:DExTr Nav.png||width="707"]]
43
44 This will open the Main DExTr Listing Page, as shown below.
45
46 **CREATE A NEW DExTr MAPPING**
47
48 [[image:attach:DExTr Listing Page.png||height="250"]]
49
50 \\
51
52 Select "Create Mapping" to create a new mapping. This will open the Mapping Builder, as shown below.
53
54 To edit an existing mapping, select the Edit icon.
55 To copy an existing mapping, select the Copy icon.
56 To delete an existing mapping, select the Delete icon.
57 \\
58
59 \\
60
61 (% style="margin-left: 30.0px;" %)
62 \\
63
64 Creating a Data Mapping
65
66 **[[image:attach:New-DExTr-Mapping.png||height="250"]]**
67
68 \\
69
70 As you can see, a DExTr mapping consists of the following parts. You may use any or all of these components. The only required component to save the mapping is the mapping Title. All other components are optional.
71
72 Navigate across the six tabs at the top of the interface to configure how the customer data platform will interpret and exchange data.
73
74 1. (((
75 (((
76 Exchange Map** - **Define Exchange Map
77 )))
78
79 (((
80 1. (((
81 Enter a name and description for this data exchange, then proceed to the next tab (Demographic Fields).
82 )))
83 )))
84 )))
85
86 \\
87
88 [[image:attach:DExTr Demo Tab.png||width="800"]]
89
90 \\
91
92 1. (((
93 Demographic Fields** - ** Map external demographic questions/data fields and responses to ONEcount demographic questions and responses.
94 )))
95
96 Define field names (the column headers from the import file) on the left and match them to the ONEcount field on the right.
97
98 If the ONEcount field does not yet exist, you'll need to create it using the Question Builder (see “Getting Started” section above).Map Values & Field Response Labels (non-text fields only)
99
100 If the response is not a text field and is either a drop down, radio button or check box selection, click the [ Map Values] button in the row under the “Map Responses” column. The Map Values button will open a pop-up window. Listed on the left are ONEcount Response Labels (and values). These are the responses defined for the ONEcount Question paired to the field from the database.  On the right, enter the values that will appear in the import file.  It is very important to map all values, because if a value in the input file is not found in ONEcount, the response for that field will be dropped. ONEcount will not allow external imports to add values to its response table. Also, if the values in your import file exactly match the values that ONEcount has (ie., for the State question, both the import/export file and ONEcount use the two-letter abbreviations) then you do not need to create a mapping.
101
102 \\
103
104 [[image:attach:DExTr Value Mapping Pop-Up.png||height="250"]]
105
106 \\
107
108 \\
109
110 Define how ONEcount should translate each response using the fields in the right column, ‘Field Response’. DExTr can use the same responses, or you may choose to translate or ‘transform’ data to another format.
111
112 //(Example: states may be abbreviated with 4 letters in a POS database [Conn., Mass.], while the ecommerce database has two letter abbreviations.)//
113
114 \\
115
116 Optional: add validations for the field to either check for duplicates, require an entry, or verify the format entered to the field.Click “Add” to enter additional demographic fields.
117
118 1. (((
119 Transactional Fields** - **Map external transaction data, e.g. product activity, status, and date formats.
120 )))
121
122 * (((
123 1. (((
124 Define transactional fields by entering the field name from the import file, the field type and then match the value of the field to the value in ONEcount by clicking the [Map] button.
125 )))
126 1. (((
127 i.e. if the source/import file has a product field called “PUB_TITLE” and the value for current subscribers is “YES” on the import file, but the ONEcount product is “Active Subscriber”, the Package Status Value from the import file should be matched with the Package Status in ONEcount.)
128 )))
129 1. (((
130 Within the “Map Values” pop up window, click “Add” to define all possible transactional statuses.
131 )))
132
133 1.
134
135 Engagement Fields** - **Map external engagement (activity) headers, e.g. time on page, URL, impressions, email opens, registrations, link clicks, etc. Engagement field mapping is used primarily for exporting feed reports.
136 )))
137
138 * (((
139 1. (((
140 To map engagement values of fields, define the engagement field name (the column header from the import file) and match it to the engagement type in ONEcount.
141 )))
142 1. (((
143 If the Engagement Field Value is a metric that is not a count, click the [] icon to map the metric field value to the ONEcount metric
144
145 //(i.e. if the source/import file has an ‘Engagement Field Name’ that is “NEWSLETTER_ACTIVITY_TYPE” the ‘ONEcount Engagement’ would be “Metric >> Activity Metric Name” and then map the values of metric type [“OPEN”, “CLICK”] to the ONEcount metric [“Email opens”/”Email clicks”]). //
146 )))
147 )))
148
149 5.    Static Fields
150
151 1. (((
152 *Optional Step: If a column and values needs to be added for identification, record keeping, sourcing, etc. purposes, DExTr can append data to each row.
153 )))
154 1. (((
155 Define the “Static Field Name” which will be the column heading on the export file (i.e. “DATA_SYNC_NAME”), and then the value of the static field (i.e. “CRM_SYNC”).
156 )))
157 1. (((
158 Click “Add” to create additional static field appends.
159 )))
160
161 6.    Re-order Fields
162
163 1. (((
164 *Optional Step: If the order of the columns needs to be re-arranged for the order in which they appear on the export from a data feed: simply drag and drop the order of fields by clicking and holding the field labels.
165 )))
166
167 \\
168
169 \\
170
171 Transaction Mapping 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.
172
173 There are four Mapping Areas for Transaction Mapping:
174
175 * (((
176 Product Mapping Area
177 )))
178 * (((
179 Product Status Mapping Area (optional)
180 )))
181 * (((
182 Subscription Mapping Area
183 )))
184 * (((
185 Date Mapping Area
186 )))
187
188 **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.**
189
190 **AS WITH DEMOGRPHIC MAPPING, ONECOUNT PRODUCTS, PRODUCT STATUSES, AND SUBSCRIPTION TYPES MUST BE CREATED PRIOR TO PERFORMING TRANSACTION MAPPING.**
191
192 **THIRD-PARTY TRANSACTION VALUES CAN BE PRE-POPULATED BY UPLOADING A LAYOUT FILE OR MANUALLY ENTERED (AS DESCRIBED IN "INFORMATION" SECTION ABOVE).**
193
194 *(% style="text-decoration: underline;" %)Product Mapping Area(%%) *
195 **For automated data feed reports**, the Third Party Product column shows what the ONEcount product name will be displayed as on output.
196
197 * (((
198 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.
199
200 **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.
201 )))
202
203 **For imports,** the Third Party Product column identifies the names/values from the import file that will be mapped to the ONEcount product.
204
205 * (((
206 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.
207
208 **Product Column Field:** This identifies the column header for the product column in the import file. In the above example, you would enter "product".
209 )))
210
211 (% style="text-decoration: underline;" %)**Product Status Mapping Area (Optional)**(%%)
212 **For automated data feed reports,** the Third Party Product Status column shows what the ONEcount product status will be displayed as on output.
213
214 * (((
215 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.
216
217 **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.
218 )))
219
220 **For Imports**, the Third Party Product Status column identifies what name/value from the import file will be mapped to the ONEcount product.
221
222 * (((
223 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.
224
225 **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".
226 )))
227
228 (% style="text-decoration: underline;" %)**Subscription Mapping Area**(%%)
229 **For automated data feed reports,** the Third Party Subscription column shows what the ONEcount subscription type will be displayed as on output.
230
231 * (((
232 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.
233
234 **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.
235 )))
236
237 **For Imports**, the Third Party Subscription column identifies what name/value from the import file will be mapped to the ONEcount product.
238
239 * (((
240 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.
241
242 **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".
243 )))
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.**SAVE MAPPING**
254
255 When done with mapping(s), click "Next".
256
257 You then have the option to save the mapping (Save) or return to mapping (Previous).
258
259 Once mapping is saved, you can find it on the Manage Mapping listing page.
260
261 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.
262
263
264
265 {{id name="End ScreenSteps Content"/}}
266 {{/layout-cell}}
267
268 {{layout-cell}}
269 {{panel borderStyle="solid" title="Search all Documentation:"}}
270
271
272 {{livesearch/}}
273 {{/panel}}
274
275 {{panel borderStyle="solid" title="Search System UTILITIES:"}}
276
277
278 {{pagetreesearch rootPage="System Utilities"/}}
279 {{/panel}}
280
281 {{panel title="More System UTILITIES"}}
282 {{expand title="Expand"}}
283
284
285 (% style="margin-left: 30.0px;" %)
286 [[Job List>>doc:Utilities - Job List]]
287
288 (% style="margin-left: 30.0px;" %)
289 [[Backend User Permissions>>doc:Utilities - Backend Users and Permissions]]
290
291 (% style="margin-left: 30.0px;" %)
292 [[Email Engine Sender Score>>doc:ONEmail and Sender Score]]
293
294 (% style="margin-left: 30.0px;" %)
295 [[doc:ONEmail]]
296
297 (% style="margin-left: 30.0px;" %)
298 Action Manager
299
300 (% style="margin-left: 30.0px;" %)
301 [[Configuration Manager>>doc:Utilities - Configuration Manager]]
302
303 (% style="margin-left: 30.0px;" %)
304 Backend Activity Log
305
306 (% style="margin-left: 30.0px;" %)
307 IVT Mitigator
308
309 (% style="margin-left: 30.0px;" %)
310 [[Widget Builder>>doc:Utilities - Widget Builder]]
311
312 (% style="margin-left: 30.0px;" %)
313
314
315 (% style="margin-left: 30.0px;" %)
316 Import/Export Tool
317 {{/expand}}
318 {{/panel}}
319
320 \\
321
322 \\
323 {{/layout-cell}}
324 {{/layout-section}}
325 {{/layout}}