Version 3.1 by melanie@one-count_com on 2016/11/09 16:12
Show last authors
1 //A SmartLink is a link in an email that you send to a ONEcount user that will automatically identify and log that user in when they click on the link.//
2
3 //This lesson will provide you with information on SmartLinks, including proper formatting.//
4
5 //There are other types of form linkouts, such as edit profile links, password recovery links, branded pages, etc. Directions on formatting these links is included after the SmartLink section.//
6
7 (% class="western" %)
8 == SMARTLINKS ==
9
10 The theory behind SmartLinks is simple: You sent the email, so you know who that person is. All you have to do is embed a token in the links in your email to tell ONEcount who the user is when they click on the link. *
11
12
13
14 *This token varies based on the email marketing platform you use , e.g. ONEcount's integrated Email Engine, Real Magnet/MagnetMail, Exact Target, Silverpop, etc. (See more detail below.)
15
16
17
18 Upon clicking on a SmartLink, two things will happen:
19
20 1) the user will be authenticated automatically for access-controlled content; and
21
22 2) the user will be identified in the system as a ONEcount user and a cookie will be set, allowing you to track as a known user all activities across your online properties.
23
24
25
26 (% class="western" %)
27 == SmartLinks Process Flow ==
28
29 ~1. User Clicks on a SmartLink
30
31
32
33 2. System checks for a local cookie
34
35 If local cookie found, use that ID
36
37
38
39 3. If no local cookie found, check global cookie
40
41 If global cookie found, set temp cookie from global cookie
42
43
44
45 4. If no global cookie found, check device ID
46
47 If device ID found, set global cookie and local cookie
48
49
50
51 5. If no device ID found, present a pre-selected challenge question
52
53 If challenge question answered correctly, set local and global cookie
54
55
56
57 6. If challenge question not answered correctly, send to login page
58
59 (% class="western" %)
60 == Placement of SmartLinks ==
61
62 Replace all of the links in your newsletter with SmartLinks.
63
64
65
66 Using SmartLinks correctly requires changing your email template. Most media companies use pre-defined templates in a Content Management System to create individual e-newsletters. See below for token format for ONEcount integrated ESPs.
67
68 (% class="western" %)
69 == Placement of Smartlinks ==
70
71 Replace all of the links in your newsletter with SmartLinks.
72
73
74
75 In other words, if your newsletter has a link like this:
76
77 [[http:~~/~~/www.mysite.com/article.html>>url:http://www.mysite.com/article.html||shape="rect"]]
78
79
80
81 Change it to this:
82
83 [[http:~~/~~/www.mysite.com/article.html?SMARTLINK_TOKEN>>url:http://www.mysite.com/article.html?SMARTLINK_TOKEN||shape="rect"]]
84
85
86
87 Using SmartLinks correctly requires changing your email template. Most media companies use predefined templates in a Content Management System to create individual e-newsletters. To enable SmartLinks in a template, simply add the smartlink token format defined below for your ESP (Email Service Provider).
88
89 (% class="western" %)
90 == Creating OCID Attribute/Data Field in ESP ==
91
92 An attribute or data field called smartlinkhash needs to be created in your ESP.
93
94 This needs to be a varchar type field of length 64.
95
96 This field will be loaded with the corresponding partner hash id for the user from ONEcount.
97
98 (% class="western" %)
99 == Placement of Smartlink Token ==
100
101 Append the token to the end of a URL, except as noted in the first bullet in "Notes" below.
102
103 (% class="western" %)
104 == Token Format ==
105
106 Using the regular link [[http:~~/~~/www.mysite.com/article.html>>url:http://www.mysite.com/article.html||shape="rect"]] as an example, following are SmartLink formats for ONEcount's email engine, MagnetMail, Silverpop, and Exact Target.
107
108
109
110 ESP's will automatically replace the token with the user's credentials, allowing them to automatically authenticate with ONEcount. If you use an ESP other than Real Magnet, Silverpop, or Exact Target, please contact ONEcount to obtain the proper token format.
111
112
113
114 Note that if the link already has “?” and parameters, precede the SMARTLINK_TOKEN with “&”; otherwise precede with “?”.
115
116
117
118 **ONEcount Email Engine (PHPList) (No addition needed)**
119
120 [[MYSITE.com/article.html>>url:http://MYSITE.com/article.html||shape="rect"]]
121
122
123
124 **MagnetMail**
125
126 &oc_slh=insert_smartlinkhash
127
128 ?oc_slh=insert_smartlinkhash
129
130 [[mysite.com/article.html?oc_slh=insert_CUSTOM1*>>url:http://mysite.com/article.html?oc_slh=insert_CUSTOM1*||shape="rect"]]
131
132
133
134 *The actual smartlink hash will vary depending upon what custom field the hash is loaded in. i.e. If thesmartlink hash is loaded into Custom 1 field, then the link parameter will be oc_slh=INSERT_CUSTOM1; if it is loaded in Custom 5 field, it will be oc_slh=INSERT_CUSTOM5; and so on. So, the part after INSERT_ will depend on which field the smart link hash is loaded into magnetmail.
135
136
137
138 **Silverpop**
139
140 &oc_slh=[smartlinkhash]
141
142 ?oc_slh=[smartlinkhash]
143
144 [[mysite.com/article.html?oc_slh=~[smartlinkhash>>url:http://mysite.com/article.html?oc_slh=[smartlinkhash||shape="rect"]]]
145
146
147
148 **Exact Target**
149
150 &oc_slh=%%smartlinkhash%%
151
152 ?oc_slh=%%smartlinkhash%%
153
154 [[mysite.com/article.html?oc_slh=%%smartlinkhash%%>>url:http://mysite.com/article.html?oc_slh=%%smartlinkhash%%||shape="rect"]]
155
156 (% class="western" %)
157 == Notes ==
158
159
160
161 If you're using a SmartLink to a ONEcount Renewal or Edit Profile/Unsubscribe form in a newsletter, the links will include the "&type=renewal" or "&type=unsubscribe&profile=y" parameter at the end of the link. The SmartLink token is to be placed BEFORE the "&type..." parameter. You can display the renewal and edit profile/unsubscribe SmartLink format each ONEcount form you create. See [[How to Manage Forms >>path:#Lesson162||shape="rect"]]for more detail where to find the links and link formats.
162
163 **Example:** [[http:~~/~~/ocreg.DOMAIN_NAME/onecount/>>url:http://ocreg.DOMAIN_NAME/onecount/||shape="rect"]] flexreg/listredirect.cgi?form=21**&%%smartlinkhash%%&type=unsubscribe&profile=y **(Exact Target Edit Profile/Unsubscribe SmartLink format)
164
165
166
167
168
169 If adding a Brand code to a Smart Renewal or Edit Profile/Unsubscribe form, place it after the smartlink tokenand before **&type.**
170
171 **Example:** [[http:~~/~~/ocreg.DOMAIN_NAME/onecount/>>url:http://ocreg.DOMAIN_NAME/onecount/||shape="rect"]] flexreg/listredirect.cgi?form=21&%%smartlinkhash%%**&brand=ABC**&type=unsubscribe&profile=y
172
173
174
175
176
177 If using an email provider other than ONEcount, MagnetMail, Exact Target, or Silverpop, please contact ONEcount re: integration with your email provider.
178
179
180
181
182
183 One problem with embedding a personalized link in an e-mail is that if the e-mail is forwarded to another user, the personalized link is also forwarded. This means that if you don't take special precautions, Fred Smith can forward an e-mail with SmartLinks in it to 10 people; each of those 10 people would be identified (and cookied) in ONEcount as “Fred Smith” when they click on the links in that e-mail. We don't want that to happen.
184
185
186
187 Stopping users who receive a forwarded copy of an e-mail with SmartLinks requires you to change the CSS in your e-mail template. To do this, use the following <style> block in your next email, and add the class original-only to the SmartLinks. You can also add a class forwarded-only if you would like an alternative, non-personalized link to the article.
188
189
190
191 The non-personalized link (the one without OCVALIDATE) will require the person who receives the forwarded e-mail to authenticate if the page the link points to require registration or authentication.
192
193
194
195 For example:
196
197
198
199 <style type="text/css">
200
201
202
203 blockquote .original-only, .WordSection1 .original-only {
204
205
206
207 display: none !important;
208
209
210
211 }blockquote .forwarded-only, .WordSection1 .forwarded-only {
212
213
214
215 display: block !important;
216
217
218
219 }
220
221
222
223 </style><p class="original-only">
224
225
226
227 <a href="[[http:~~/~~/www.mysite.com/article.html?OCVALIDATE>>url:http://www.mysite.com/article.html?OCVALIDATE||shape="rect"]]”> Article Headline</a>
228
229
230
231 </p><p style="display: none">
232
233
234
235 <a href="[[http:~~/~~/www.mysite.com/article.html>>url:http://www.mysite.com/article.html||shape="rect"]]”> Article Headline</a>
236
237
238
239 </p>
240
241 This method is not foolproof, and works with most current mail clients. It does not work with GMAIL, which is known to strip out CSS content from e-mails.
242
243
244
245 See the link below for further info:
246
247
248
249 [[http:~~/~~/jonathan-kim.com/2011/programmatically-customizing-a-forwarded-email/>>url:http://jonathan-kim.com/2011/programmatically-customizing-a-forwarded-email/||shape="rect"]]
250
251 (% class="western" %)
252 == BRAND CODES ==
253
254 ONEcount's Brand Tool allows you to create individually branded forms, Login/Lookup and Forgot Password form pages. By default your forms display on a page in your site's look and feel, with a designated header and footer. Use the Brand tool if you have multiple brands and wish to create/maintain a separate identity for each brand by displaying various forms in the look and feel of each brand rather than on a default umbrella-branded page.
255
256 (% class="western" %)
257 == Placement of Brand Token ==
258
259 Append the Brand Code (token) to the end of a URL.
260
261 (% class="western" %)
262 == Token Format ==
263
264 **Form URLS (including Login/Lookup and Forgot Password Form Pages)**
265
266
267
268 __**Standard Form URLS that DO NOT end with ".cgi"**__
269
270 Add** &brand=[CODE] **where [CODE] is the code you created to the end of the form URL. **~*~***
271
272
273
274 //Example~://
275
276 Brand Code = **ABC**
277
278 Standard Link = [[http:~~/~~/ocreg.gcnmedia.com/onecount/reg/registerForm>>url:http://ocreg.gcnmedia.com/onecount/reg/registerForm||shape="rect"]]**.**cgi?form=58.
279
280 Link with Brand Code = [[http:~~/~~/ocreg.gcnmedia.com/onecount/reg/registerForm.cgi?form=58>>url:http://ocreg.gcnmedia.com/onecount/reg/registerForm.cgi?form=58||shape="rect"]]**&brand=ABC**
281
282 Using the Brand Code, Form 58 will display the form on the ABC branded page created in your CMS.
283
284
285
286 __**Form URLS that DO end with ".cgi"**__
287
288 Add **?brand=[CODE]** where [CODE] is the code you created. **~*~***
289
290
291
292 //Example//:
293
294 Brand Code = **ABC**
295
296 Standard Link = [[http:~~/~~/ocreg.gcnmedia.com/onecount/login/loginlogout.cgi>>url:http://ocreg.gcnmedia.com/onecount/login/loginlogout.cgi||shape="rect"]]
297
298 Link with Brand Code = [[http:~~/~~/ocreg.gcnmedia.com/onecount/login/loginlogout.cgi>>url:http://ocreg.gcnmedia.com/onecount/login/loginlogout.cgi||shape="rect"]]**?brand=ABC**
299
300
301
302 **~*~*** **This is a subtle, but critical difference:** URLs that DO NOT end with ".cgi" use the format **&brand=[CODE] **and URLs that DO end with ".cgi" use the format **?brand=[CODE]**
303
304 (% class="western" %)
305 == Notes ==
306
307
308
309 You must first create in your CMS a blank page with only a header and footer for each brand. The URL for this page will be entered in the Brand tool, identifying the page to pull the branded header/footer from.
310
311
312
313 You must include the following markers on the brand page you create in your CMS:
314
315
316
317 <!~-~-onecount_header~-~-> Place in the page where the header will END
318
319 <!~-~-onecount_footer~-~-> Place in the page where the footer will START
320
321
322
323 If you require a separate header/footer page for mobile, you must also create that page.
324
325
326
327
328
329 See[[ Brand Tool >>path:#Lesson163||shape="rect"]]documentation for more information on creating Brands and Brand Codes.
330
331 (% class="western" %)
332 == LOOKUP/LOGIN, FORGOT PASSWORD, AND EDIT PROFILE LINKOUTS ==
333
334 Note that in order for a form to display in your site's look and feel, you must first create in your CMS a blank page with only a header and footer for your brand.
335
336
337
338 You must include the following markers on the brand page you create in your CMS:
339
340
341
342 <!~-~-onecount_header~-~-> Place in the page where the header will END
343
344 <!~-~-onecount_footer~-~-> Place in the page where the footer will START
345
346
347
348 If you require a separate header/footer page for mobile, you must also create that page.
349
350 (% class="western" %)
351 == URL Formats ==
352
353 **Lookup/Login Form**
354
355 ocreg.DOMAIN_NAME/onecount/login/loginlogout.cgi
356
357
358
359 This URL will bring up the Lookup/Login form, in your site/brand look and feel.
360
361 (% align="CENTER" %)
362
363
364 **Forgot Password Form**
365
366 ocreg.DOMAIN_NAME/onecount/login/forgotpassword.cgi
367
368
369
370 This URL will bring up the Forgot Password form, in your site/brand look and feel
371
372 (% align="CENTER" %)
373
374
375 **Edit Profile/Unsubscribe Form**
376
377 ocreg.DOMAIN_NAME/onecount/flexreg/editprofile.cgi *****
378
379
380
381 This URL will bring up your Edit Profile/Unsubscribe form, in your site/brand look and feel. This form is a regular form that allows the user to make demographic information, and at the bottom of the form is a list of unsubscribed products with the option to unsubscribe.
382
383
384
385 *****This link is only for linking out on your website. It is NOT a newsletter SmartLink for auto-login to an Edit Profile/Unsubscribe form. See above for information on email SmartLink formats.
386
387 (% align="CENTER" %)
388
389
390 (% align="CENTER" %)
391
392 \\
393
394 (% align="CENTER" %)
395
396 \\