White Paper - Modules for your website
Cision NE - Development
White Paper - Publish 2 - Subscription
Author: Elena Demirtzoglu
Contents
1 Cision Publish 2 - Subscription
This document describes the technical platform of Cision subscription. Cision subscription is a module which contains several sub modules, and this white paper describes how to integrate these sub modules into the client web site.
2 System platform
2.1
Technical system overview
Document:
Updated:
Technical_White_Paper_-Publish2_Subscription.doc
2013-01-10 Page 1 of 10
White Paper - WPY - Subscription
2.2
Software
Subscription is a module, which contains several sub modules, which all are web application that resides on a Windows IIS. Its platform and client portal pages are written in C#.NET.
The data layer is implemented in Microsoft SQL Server with XML web services.
2.3
Capacitys
Bandwidth available:
Internet provider:
Up to 100 Mbit/s
Interoute (www.interoute.com)
3 Information from your company subscription
The information from your company subscription includes subscription to your companys press releases and reports.
3.1
Client side integration
Place the HTML form that has been delivered by Cision on the client web. The form shall post the form data that has been inputted by the user to an ASPX page, located on Cision’s web server. That page will take care of the information and add the subscriber to the database of subscribers. Based on the result of the subscription registration, the user will be redirected to a desired result page that is i.e. “The subscription was successful” or “The subscription was unsuccessful”. It is recommended that those pages reside on the client side.
Document:
Updated:
Technical_White_Paper_-Publish2_Subscription.doc
2013-01-08
2
Sida 2 av 10
White Paper - WPY - Subscription
3.2
Subscription form example
Example code of a HTML form that shall be posted back to Cision:
<form method="post" action=" http://publish.ne.cision.com/Subscription/Subscribe" name="pageForm">
<input type="hidden" name="subscriptionUniqueIdentifier" value="[Identifier]"/>
<input type="hidden" name="redirectUrlSubscriptionSuccess" value="[URL]"/>
<input type="hidden" name="redirectUrlSubscriptionFailed" value="[URL]"/>
<input type="hidden" name="Replylanguage" value="[Replylanguage]"/>
<p><b>Language</b></p>
<p>
<input type="checkbox" name="Language" value="sv" id="lang_sv">
<label for="lang_sv">Swedish</label>
<br />
<input type="checkbox" name="Language" value="en" id="lang_en">
<label for="lang_en">English</label>
</p>
<p><b>Information type</b></p>
<p>
<input type="checkbox" name="informationtype" value="kmk,rpt" id="interim"/>
<label id="interim">Interim reports</label>
<br/>
<input type="checkbox" name="informationtype" value="rdv" id="annual"/>
<label id="annual">Annual reports</label>
<br/>
<input type="checkbox" name="informationtype" value="prm" id="press"/>
<label id="press">Press releases</label>
</p>
<p>
<label for="name">Name</label><br/>
<input type="text" name="Name" id="name"/>
<br/>
<label for="companyname">CompanyName</label><br/>
<input type="text" name="CompanyName" id="companyname" />
<br/>
<label for="email">Email</label><br/>
<input type="text" name="Email" id="email" />
<br/>
<label for="SMS">SMS (+46709123456)</label><br/>
<input type="text" name="Cellphone" id="SMS"/>
</p>
<p>
<input type="submit" value="Submit"/>
</p>
</form>
3.3
Input Fields
Input fields that can be set: redirectUrlSubscribtionStart
Should point to a URL located on the client side that displays a ―registration success ‖ message. redirectUrlSubscriptionFailed
Should point to a URL located on the client side that displays a ―registration failed ‖ message.
Language
The Language is set to the release language that the subscriber wants the information to be sent in. This is the language that the subscription will be saved as.
The format of the language codes is ISO 639 (2-letter).
See: http://www.loc.gov/standards/iso639-2/php/code_list.php
for more specific information on language codes.
Document:
Updated:
Technical_White_Paper_-Publish2_Subscription.doc
2013-01-08
3
Sida 3 av 10
White Paper - WPY - Subscription
ReplyLanguage
The wpyReplyLanguage is set to the desired language that the opt-in, confirmation and end-subscription mail will be sent in.
The format of the language codes is ISO 639 (2-letter).
See http://www.w3.org/WAI/ER/IG/ert/iso639.htm
for more specific information on which code to use.
Informationtype
See “Appendix – A” for a complete list of what release types that is available.
Name
The name of the subscriber.
CompanyName
The company name the subscriber.
Email is the email address that the subscriber wants to get the information to.
Cellphone
Cellphone is the cellular phone number that the subscriber wants to get the information to
3.4
Customized Fields
Add your own customized field to the subscription form through naming the input as
<input name=”CustomField.[KEY]” where [KEY] is the name of your customized field.
<input type="text" name="CustomField.Website" id="Website" />
3.5
Specialized Input Fields
Theses input fields may be used to get a more specified subscription. First an example code.
<p><b>IPTC</b></p>
<p>
<input type="checkbox" name="iptc" VALUE="[iptc value]"/>
<label>04004003</label><br />
<input type="checkbox" name="iptc" VALUE="[iptc value]"/>
<label>04007005</label><br />
</p>
<p><b>Custom Category</b></p>
<p>
<input type="checkbox" name="CustomCategory" VALUE="[category name]"/>
<label>Cat1</label><br />
<input type="checkbox" name="CustomCategory" VALUE="[category name]"/>
<label>Cat2</label><br />
</p>
<label for="subscriberCountyCode">Country</label><br/>
<select name="subscriberCountryCode" id="subscriberCountyCode"/>
<option value="se">Sweden</option>
<option value="gb">United kingdom</option>
<option value="us">USA</option>
<option value="is">Iceland</option>
</select>
Iptc
If used the subscriber will only receive releases of the selected iptc code.
CustomCategory
If used the subscriber will only receive the releases of the selected custom category. subscriberCountyCode
The country name the subscriber. Uses the ISO 3166 standard for values
Document:
Updated:
Technical_White_Paper_-Publish2_Subscription.doc
2013-01-08
4
Sida 4 av 10
4
White Paper - WPY - Subscription
Share information subscription
The share information subscription includes subscription to your own companys, competitors and index share information.
4.1
Client side integration
Place the HTML form that has been delivered by Cision on the client web. The form shall post the form data that has been inputted by the user to an ASPX page, located on Cision’s web server. That page will take care of the information and add the subscriber to the database of subscribers. Based on the result of the subscription registration, the user will be redirected to a desired result page that is i.e. “The subscription was successful” or “The subscription was unsuccessful”. It is recommended that those pages reside on the client side.
4.2
Subscription form example
Example code of a HTML form that shall be posted back to Cision:
< form method ="post" action ="http://[ADDRESS]/ActivateShareSubscrition.aspx" name ="PageForm">
< input type ="hidden" name ="wpyRedirectSubcriptionStartSuccess" value ="[URL]"/>
< input type ="hidden" name ="wpyRedirectSubcriptionStartFailed" value ="[URL]"/>
< input type ="hidden" name ="wpyRedirectSubcriptionEndSuccess" value ="[URL]"/>
< input type ="hidden" name ="wpyRedirectSubcriptionEndFailed" value ="[URL]"/>
< input type ="hidden" name ="wpyLanguageCode" value ="[LANGUAGECODE]"/>
< input type ="hidden" name ="wpyReplylanguage" value ="[REPLYLANGUAGE]"/>
< input type ="hidden" name ="wpyModuleCode" value ="[MODULECODE]"/>
< input type ="hidden" name ="wpyTickerSymbol" value ="[TICKERSYMBOL]"/>
Notify me when the Share: < br />
Exceeds: < input type ="text" name ="wpyShareOverQouteNotification" />< br />
Is below: < input type ="text" name ="wpyShareUnderQouteNotification" />< br />
Changes: < input type ="text" name ="wpyShareTickerPercentageChange" />< br />
< br />
Notify me with the shares information: < br />
Daily: < input type ="checkbox" name ="wpyShareDailySubscription" />< br />
Weekly: < input type ="checkbox" name ="wpyShareWeeklySubscription" />< br />
< br />
Email address : < br />
< input type ="text" name ="wpyEmail" size ="30" value =""/>< br />
SMS number : < br />
< input type ="text" name ="wpySMS" size ="30" value =""/>< br />
< input type ="radio" name ="wpyaction" value ="subscribe" checked ="checked"/> Begin subscription < br />
< input type ="radio" name =" wpyaction " value ="unsubscribe"/> End subscription < br />
< input type ="submit" value ="ok"/>
</ form >
Where [ADDRESS] is the address to the application which takes care of the subscription request.
Input fields that can be set: wpyRedirectSubscriptionStartSuccess
Should point to a URL located on the client side that displays a “welcome text”. wpyRedirectSubscriptionStartFailed
Should point to a URL located on the client side that displays an error message, for example if the supplied email address is malformed. wpyRedirectSubscriptionEndSuccess
Document:
Updated:
Technical_White_Paper_-Publish2_Subscription.doc
2013-01-08
5
Sida 5 av 10
White Paper - WPY - Subscription
Should point to a URL located on the client side that displays a “subscription terminated text”. wpyRedirectSubscriptionEndFailed
Should point to a URL located on the client side that displays an error message, for example if the supplied email address is malformed. wpyLanguageCode
The wpyLanguage is set to the language that the subscriber wants the information to be sent in. This is the language that the subscription will be saved as.
The format of the language codes is ISO 639 (2-letter).
See http://www.w3.org/WAI/ER/IG/ert/iso639.htm
for more specific information on which code to use. wpyReplyLanguage
The wpyReplyLanguage is set to the desired language that the opt-in, confirmation and end-subscription mail will be sent in.
The format of the language codes is ISO 639 (2-letter).
See http://www.w3.org/WAI/ER/IG/ert/iso639.htm
for more specific information on which code to use. wpyModuleCode
This code I provided by Cision upon delivery. wpyTickerSymbol
The ticker symbol of the share/index the subscription is about. wpyShareOverQouteNotification
The value in the shares currency that is set as a trigger to send a notification to the subscriber when the shares value is exceeding. wpyShareUnderQouteNotification
The value in the shares currency that is set as a trigger to send a notification to the subscriber when the shares value is below. wpyShareTickerPercentageChange
The percent that is set as a trigger to send a notification to the subscriber when the shares value has changed that much (either it’s up or down). wpyEmail wpySMS wpyEmail is the email address that the subscriber wants to get the information to. wpySMS is the cellular phone number that the subscriber wants to get the information to. wpyAction wpyAction contains what action the application that takes care of the subscription request should perform. Valid values are:
Value subscribe unsubscribe
Action
Starts the subscription
Ends the subscription
Document:
Updated:
Technical_White_Paper_-Publish2_Subscription.doc
2013-01-08
6
Sida 6 av 10
5 Calendar information subscription
White Paper - WPY - Subscription
The calendar information subscription is a subscription to your companys calendar events.
5.1
Client side integration-Include
Place your JavaScript-Include or XML-feed on the client web page
.
If neither the JavaScript-Include- or the XML-feed integration fits your needs, it’s possible to get Cision Calendar Subscription module by a FRAME/IFRAME.
5.1.1
JavaScript
The JavaScript-Include render the available items, styled with your desired HTML.
5.1.1.1
Parameters wpymodulecode=[modulecode]
The modulecode(s) is provided by Cision upon delivery.
lang=[languagecode]
Defines the language and/or date format the calendar items are presented by. The format of the language codes is ISO 639 (2-letter). See http://www.w3.org/WAI/ER/IG/ert/iso639.htm
for more specific information on which code to use.
5.1.1.2
5.1.1.2 Example
<script language="javascript1.1" type="text/javascript" src=” <hostaddress>/foo.aspx
”></script>
Where <host-address>/foo.aspx is the URL program that delivers the Cision Calendar
Subscription.
The javascript writes the HTML content of a JavaScript-Include which writes the contents of the web page within document.write() .
Pros
The size of the “frame” with Cision feed information is only dependent on the client web page content.
Cons
If the feeding Cision site is offline, the information from Cision in the JavaScript-Include will not show.
5.1.2
FRAME / IFRAME
Example code:
<iframe src=”<host-address>/foo.aspx"></iframe>
Where <host-address>/foo.aspx is the URL program that delivers the Cision Calendar
Subscription.
Pros
If the feeding Cision site is offline, the client page will load anyway but without the information from Cision.
Cons
The frame height and width has to be set when implementing the feed, and if the fed information takes more space than the frame, scrollbars will occur.
Document:
Updated:
Technical_White_Paper_-Publish2_Subscription.doc
2013-01-08
7
Sida 7 av 10
White Paper - WPY - Subscription
5.1.3
XML
This is a representation of the Cision Calendar Subscription in XML data.
5.1.3.1
Parameters
The XML feed is reached by an URL to an aspx-page. The feed allows the following parameters: wpymodulecode=[modulecode]
The modulecode(s) is provided by Cision upon delivery.
lang=[languagecode]
Defines the language and/or date format the calendar items are presented by. The format of the language codes is ISO 639 (2-letter). See http://www.w3.org/WAI/ER/IG/ert/iso639.htm
for more specific information on which code to use.
5.1.3.2
Entities
Here are the entities which are included in the Calendar Subscription Feed described.
CalendarEvents
Start block of the calendar events
CalendarEvent
Start block of an calendar event, including it’s ID.
EventTime
The time when the event is supposed to happen.
EventLocation
The location where the Event is supposed to happen.
EventTitle
The title of the event.
EventIntro
The intro text of the event.
EventSubscribeEmail
The “email-control-name” of an calendar event from which you can build a HTMLform-control and set it’s value to true or false.
EventSubscribeSMS
The “sms-control-name” of an calendar event from which you can build a HTMLform-control and set it’s value to true or false.
EventSubscribeTimeUnit
The “time-unit-name” of an calendar event from which you can build a HTML-formcontrol and set it’s value to a desired amount.
EventSubscribeTimeType
The “time-type-name” of an calendar event from which you can build a HTML-formcontrol and set it’s value to a DAYS or HOURS.
5.1.3.3
XML Subscription feed example
< CalendarEvents >
Document:
Updated:
Technical_White_Paper_-Publish2_Subscription.doc
2013-01-08
8
Sida 8 av 10
< CalendarEvent id="[ID]" >
White Paper - WPY - Subscription
< EventTime > [EVENTTIME] < EventTime >
< EventLocation > [EVENTLOCATION] < / EventLocation >
< EventTitle > [EVENTTITLE] < / EventTitle >
< EventIntro > [EVENTINTRO] < / EventIntro >
< EventSubscribeEmail > [EVENTSUBSCRIBEEMAIL] < EventSubscribeEmail >
< EventSubscribeSMS > [EVENTSUBSCRIBESMS] < EventSubscribeSMS >
< EventSubscribeTimeUnit > [EVENTSUBSCRIBETIMEUNIT] < EventSubscribeTimeUnit >
< EventSubscribeTimeType > [EVENTSUBSCRIBETIMETYPE] </ EventSubscribeTimeType >
< / CalendarEvent >
< / CalendarEvents >
5.2
Subscription form example
Here is a fully illustrated form example, which can be posted to an URL which will be delivered upon delivery from Cision.
< form name =" frm " action =" [FORM] " method =" post ">
< input type =" hidden " name =" wpyRedirectSubcriptionStartSuccess " value =" [URL] " />
< input type =" hidden " name =" wpyRedirectSubcriptionStartFailed " value =" [URL] " />
< input type =" hidden " name =" wpyRedirectSubcriptionEndSuccess " value =" [URL] " />
< input type =" hidden " name =" wpyRedirectSubcriptionEndFailed " value =" [URL] " />
< input type =" hidden " name =" wpyReplyLanguage " value =" [LANGUAGE] " />
< input type = "hidden " name = "wpyaction " value =" subscribe/unsubscribe " />
<!—This section with the individual items should be populated with either the JavaScript-
Include or data from the XML feed
< input type =” checkbox ” name =” [EVENTSUBSCRIBEEMAIL] ” value =” [true/false] ” />
< input type =” checkbox ” name =” [EVENTSUBSCRIBESMS] ” value =” [true/false] ” />
< input type =” text ” name =” [EVENTSUBSCRIBETIMEUNIT] ” value =” [amount] ” />
< select name =” [EVENTSUBSCRIBETIMETYPE] ” />
< option value =” DAYS ”> [DAYS] </ option >
< option value =” HOURS ”> [HOURS] </ options >
</ select>
<!—End of section
< input type =" text " name =" wpyemail " />
< input type =" text " name =" wpysms " />
< input type =" text " name =" wpyname " />
< input type =" submit " value =" Subscribe " / >
</ form >
Document:
Updated:
Technical_White_Paper_-Publish2_Subscription.doc
2013-01-08
9
Sida 9 av 10
White Paper - WPY - Subscription
Appendix – A: Type codes and type names
These are the possible type codes and type names that are available sending information in
Cision Online today.
Acquisition and Tender offer 058
Annual Financial Statement
KMK
Annual report/ annual accounts
RDV
Articles of association 152
Changes board/management/auditors 072
Changes in company's own shares
069
Changes in share capital and votes
075
Company Announcement/Press release PRM
Corporate Action 070
Final Bond Terms
151
Financial Calendar
059
Half Year financial report 078
Insiders' dealing 066
Interim information
153
Interim Management statement
079
Interim report RPT
Invitation INB
Major shareholder announcements
144
Minutes of annual general meeting
064
Minutes of extraordinary general meeting 065
Net Asset Value 077
Newsletter
NBR
Notice to convene annual general meeting
062
Notice to convene extr.general meeting 063
Prospectus/Announcement of Prospectus 067
Quarterly report
068
Shareholders agreements
071
Document:
Updated:
Technical_White_Paper_-Publish2_Subscription.doc
2013-01-08
10
Sida 10 av 10
