SiteVision Onlinehelp

My subscriptions portlet

The custom Velocity templates in the My subscription portlet uses the JCR (Java Content Repository, JSR 283) programming model. The SiteVision API is available here. There are two templates available corresponding to the different views.
Elements available in the Velocity Context
Name Type and Description
portlet javax.jcr.Node
  This portlet. See properties below
sitevisionUtils senselogic.sitevision.api.Utils
  The main entry point to all utility classes
jcrSession javax.jcr.Session
  The JCR Session
request javax.portlet.PortletRequest
  The portlet request
Additional properties available for the portlet ($portlet) in both views:
Name Type and Description  
subscriptionRepository javax.jcr.PropertyType.WEAKREFERENCE  
  Corresponds to 'Subscriptions' in the portlet configuration. A JCR-node with subnodes containing information about the active subscription. More information bellow  
useSubmitText javax.jcr.PropertyType.BOOLEAN  
  Corresponds to the selection 'Standard button' in the portlet configuration  
submitText javax.jcr.PropertyType.STRING  
  Corresponds to 'Button text' in the portlet configuration  
submitTextFont javax.jcr.PropertyType.WEAKREFERENCE  
  Corresponds to 'Button text font' in the portlet configuration. A Node that has property selectorText (java.lang.String) - the css class name of the font .  
submitImage javax.jcr.PropertyType.WEAKREFERENCE  
  Corresponds to 'Button image' in the portlet configuration. A JCR-Node that has property URI pointing at the image resource  
submitImageDesc javax.jcr.PropertyType.STRING  
  Corresponds to 'Button image description' in the portlet configuration  
saveUseSubmitText javax.jcr.PropertyType.BOOLEAN  
  Corresponds to the selection 'Standard button' in the portlet configuration  
saveSubmitText javax.jcr.PropertyType.STRING  
  Corresponds to 'Button text' in the portlet configuration  
saveSubmitTextFont javax.jcr.PropertyType.WEAKREFERENCE  
  Corresponds to 'Button text font' in the portlet configuration. A Node that has property selectorText (java.lang.String) - the css class name of the font .  
saveSubmitImage javax.jcr.PropertyType.WEAKREFERENCE  
  Corresponds to 'Button image' in the portlet configuration. A JCR-Node that has property URI pointing at the image resource  
saveSubmitImageDesc javax.jcr.PropertyType.STRING  
  Corresponds to 'Button image description' in the portlet configuration  
abortUseSubmitText javax.jcr.PropertyType.BOOLEAN  
  Corresponds to the selection 'Standard button' in the portlet configuration  
abortSubmitText javax.jcr.PropertyType.STRING  
  Corresponds to 'Button text' in the portlet configuration  
abortSubmitTextFont javax.jcr.PropertyType.WEAKREFERENCE  
  Corresponds to 'Button text font' in the portlet configuration. A Node that has property selectorText (java.lang.String) - the css class name of the font .  
abortSubmitImage javax.jcr.PropertyType.WEAKREFERENCE  
  Corresponds to 'Button image' in the portlet configuration. A JCR-Node that has property URI pointing at the image resource  
abortSubmitImageDesc javax.jcr.PropertyType.STRING  
  Corresponds to 'Button image description' in the portlet configuration  
onlySubscribersSubscriptions javax.jcr.PropertyType.BOOLEAN  
  Corresponds to 'Show only users subscriptions' in the portlet configuration  
listShowTitle javax.jcr.PropertyType.BOOLEAN  
  Corresponds to 'Show title' in the portlet configuration  
listTitleFont javax.jcr.PropertyType.WEAKREFERENCE  
  Corresponds to 'Title font' in the portlet configuration. A Node that has property selectorText (java.lang.String) - the css class name of the font .  
listShowDescription javax.jcr.PropertyType.BOOLEAN  
  Corresponds to 'Show description' in the portlet configuration  
listDescriptionFont javax.jcr.PropertyType.WEAKREFERENCE  
  Corresponds to 'Description font' in the portlet configuration. A Node that has property selectorText (java.lang.String) - the css class name of the font .  
showSentMessage javax.jcr.PropertyType.BOOLEAN  
  Corresponds to the selection 'Show message after subscription' in the portlet configuration  
sentMessage javax.jcr.PropertyType.STRING  
  Corresponds to the text 'Show message after subscription' in the portlet configuration  
sentMessageFont javax.jcr.PropertyType.WEAKREFERENCE  
  Corresponds to 'Show message after subscription font' in the portlet configuration. A Node that has property selectorText (java.lang.String) - the css class name of the font .  
defaultInput javax.jcr.PropertyType.STRING  
  Corresponds to 'Default value' in the portlet configuration  
inputWidth javax.jcr.PropertyType.LONG  
  Corresponds to 'Width' in the portlet configuration  
inputFont javax.jcr.PropertyType.WEAKREFERENCE  
  Corresponds to 'Text field font' in the portlet configuration. A Node that has property selectorText (java.lang.String) - the css class name of the font  
allowEmail javax.jcr.PropertyType.BOOLEAN  
  Corresponds to 'Allow e-mail' in the portlet configuration  
allowPhone javax.jcr.PropertyType.BOOLEAN  
  Corresponds to 'Allow phone number' in the portlet configuration  
errorFont javax.jcr.PropertyType.WEAKREFERENCE  
  Corresponds to 'Font for error messages' in the portlet configuration. A Node that has property selectorText (java.lang.String) - the css class name of the font  
inputFieldValue javax.jcr.PropertyType.STRING  
  Corresponds to the value of the input field  
currentEmail javax.jcr.PropertyType.STRING  
  Corresponds to the e-mail for the current user (needs to be logged in)  
adminURL javax.jcr.PropertyType.URI  
  The form action URL for the subscription action  
Additional properties available on the subscribe (i.e. the first) view
Name Type and Description  
subscriberInputName javax.jcr.PropertyType.STRING  
  The form text input name for the subscriber e-mail / phone  
subscriberSubmitName javax.jcr.PropertyType.STRING  
  The submit button name for the subscription action  
bundle javax.jcr.PropertyType.WEAKREFERENCE  
  A JCR-node containing the language dependent strings. The actual node can be resolved by calling getNode() on this property. The strings are javax.jcr.PropertyType.STRING properties  
errors javax.jcr.PropertyType.WEAKREFERENCE  
  A JCR-node containing the input errors. The actual node can be resolved by calling getNode() on this property. The errors are javax.jcr.PropertyType.STRING properties with names prefixed with "error"  
Additional properties on the administration (i.e. the second) view
Name Type and Description  
redirectURL javax.jcr.PropertyType.URI  
  Corresponds to the 'Send user to an other page after subscription' in the portlet configuration  
saveSubmitName javax.jcr.PropertyType.STRING  
  The submit button name for the save button  
abortSubmitName javax.jcr.PropertyType.STRING  
  The submit button name for the abort action  
isAlteredSubscriptions javax.jcr.PropertyType.BOOLEAN  
  Indicates that the previous operation altered subscriptions (i.e. when to show the message)  
bundle javax.jcr.PropertyType.WEAKREFERENCE  
  A JCR-node containing the language dependent strings. The actual node can be resolved by calling getNode() on this property. The strings are javax.jcr.PropertyType.STRING properties  
The subscriptionRepository node has no properties. The sub nodes corresponds to the selected active subscriptions in the portlet configurations. They have the following properties:
Name Type and Description  
page javax.jcr.PropertyType.WEAKREFERENCE  
  The page / article where the active subscription is configured. To get the JCR-node use the method getNode()  
subscribeElementName javax.jcr.PropertyType.STRING  
  The form element name used to indicate that the user want to be a subscriber  
isSubscriber javax.jcr.PropertyType.BOOLEAN  
  Indicates that the current user is a subscriber (needs to be logged in)  
help-cluster-3.sitevision.net