Copyright © TIBCO Software Inc. All Rights Reserved
Copyright © TIBCO Software Inc. All Rights Reserved


Chapter 2 Working with Projects, Packages, and Processes : Presentation Channels

Presentation Channels
See "Presentation Channels" in TIBCO Business Studio Concepts.
Editing Email Attributes at Workspace Level
You can edit the attributes of the Openspace Email channel type at the workspace level or the project level.
To edit at the workspace level:
1.
Select Window > Preferences > Presentation Channels.
2.
Expand Default Channel (Default) to view the presentation channels available.
3.
The Channel Type Openspace Email is included in the Default Channel. Double-click on Default Channel, or click the edit sign on the right of the Presentation Channels dialog. You see a list of the following available Channel Types to add (the channel types which are already part of the Default Channel are ticked):
4.
Click on Openspace Email to view its attributes. The attributes are as follows:
You can edit the values of the Email attributes to meet your own requirements:
List of custom headers, of the format Header Name:Header Value. This is an optional field.
The following "tokens" can be put into any of the above Email attributes:
%%token.workItemId%% - The work item id.
%%token.entityName%% - The entity name who requires push notifications as defined in the Organizational Model.
%%token.mailDate%% - The date and time the pushed mail message was sent.
You can add a token by typing the string directly into an attribute value. For example, for mailSubject you could enter:
PUSH DEMO - Pushing Work Item Id %%token.workItemId%%
Then at runtime, the token will be replaced by the actual value:
PUSH DEMO - Pushing Work Item Id 1
Editing Email Attributes at Project Level
You can edit email attributes at the project level.
1.
From Project Explorer, right-click on the project and select Properties > Presentation Channels. Check the tickbox for Enable project specific settings.
or select Window > Preferences > Presentation Channels and click on Configure Project Specific Settings... Select the project you want to configure and press OK.
2.
Expand Default Channel (Default) to view the presentation channels available
3.
Select Openspace Email and edit the attributes as described above.
4.
Click Apply. The attribute changes are applied next time you deploy your project.
To restore default values you can click Restore Defaults.
Extended attributes are also available for custom use.
Creating an Alternative Email Template
You can create your own email template which can contain organization-specific information, with your own logos and corporate style.
After deployment it can be used as the default email template for any Push Destination using the Openspace Email channel type.
The files you can use to create your email template are as follows:
HTML file (Mandatory) This contains the information about what you want the email to contain. It typically includes:
<link rel="stylesheet" type="text/css" href="cid:Easycss" />
<img src="cid:cidOne"/>
refers to NewProductLogo.png in the example in cid.properties above. Referring to them in this way means they can by shown externally as part of the email when the html file is used to create an email after deployment.
This html can contain any of the following tokens, each of which will be replaced by an actual value at runtime;
CSS (Cascading Style Sheet) file This is a stylesheet file, typically for your organization, which contains standard information such as banners or background colors, that you want to be in every email you send.
graphics you are referencing from the cid.properties file, which would then be used by the html file. These must be available locally, and can either be in the same directory (Presentation Resources), or in a sub-directory.
cid.properties This allows you to reference any graphics files you have available locally (in the same directory, or a subdirectory) which you want to be used when you push the work item (which then sends an email to notify the user of the work item). It is specifically used for embedded images / css in emails, rather than providing the option of external calls.
Each filename will have a cid:<name> identifier which allows it to be accessed remotely as well as locally. For example, the cid.properties file might contain lines such as the following, where cidOne is the cid: identifier for NewProductLogo.png when you reference it later in the HTML file:
To create your Email template files:
In Project Explorer, navigate to the project you want to add the Email template to:
1.
Right-click New > Folder and name your folder.
2.
Right-click on the folder you created, and select Special Folders > Use as Presentation Resources Folder.
3.
From the Presentation Resources folder you created, right-click New >File and create the files you require.
Alternatively:
Right-click Presentation Resources > New > File, and create the files you require
If you create the files you require elsewhere, copy and paste them by copying them and then clicking on Presentation Resources (or your new Presentation Resources folder) > Paste.
To apply the Email template to a Project:
1.
From the project, right-click Properties > Presentation Channels. Select the checkbox Enable project specific settings.
or select Window > Preferences > Presentation Channels, and click Configure Project Specific Settings... Select the project you want to configure and click OK.
2.
Expand Default Channel and select Openspace Email.
3.
Click in the Value field for mailTemplateLocation, and you will see the picker, ():
4.
5.
Click Apply.
Next time you push an email, it will use this template.

Copyright © TIBCO Software Inc. All Rights Reserved
Copyright © TIBCO Software Inc. All Rights Reserved