Working with Tokens
Tokens are Ektron-defined variables surrounded by at signs (@). When a message is generated, tokens retrieve information about Ektron CMS400.NET users, groups, and objects. For example, the following message:
@SubjectUser.FirstName@ added a new document, ‘@Content.title@’, to his profile page.
might look like this:
“Paul added a new document, ‘How to Write Code’, to his profile page.”
In this example, @SubjectUser.FirstName@ is the first name of the user performing the action. @Content.title@ is the title of the object that was uploaded.
See Also:
- Token Types
- Message Tokens: User and Content-Based
- Message Tokens: Community Group-Based
- Making Tokens into Hyperlinks
Token Types
A message can include several token types.
- SubjectUser tokens—represent the user who performs the activity
- DirectObjectUser tokens—represent the user to which the activity is happening
- Content tokens—represent the content that was a part of the activity
- CommunityGroup tokens—represent the community group that was involved in the activity
- Blog tokens—represent the blog use in the activity
- webEvent tokens—represents the Web Calendar used in the activity
- MicroMessage tokens—represent micromessages used in the activity
The table below lists Message Sub Types and the Tokens available to each one.
|
Message Sub Type |
Associated Tokens |
|
Add Calendar Event Update Calendar Event |
@System.SiteUrl@ @System.GroupProfileTemplate@ @System.UserProfileTemplate@ @SubjectUser.Id@ @SubjectUser.UserName@
@SubjectUser.FirstName@ @SubjectUser.LastName@
@WebEvent.Id@ @WebEvent.Title@ @WebEvent.Quicklink@ @WebEvent.StartTime@ @WebEvent.EndTime@ |
AddColleague |
@System.SiteUrl@, @System.GroupProfileTemplate@ @System.UserProfileTemplate@ @SubjectUser.Id@ @SubjectUser.UserName@
@SubjectUser.FirstName@ @SubjectUser.LastName@
@DirectObjectUser.Id@ @DirectObjectUser.UserName@
@DirectObjectUser.FirstName@ @DirectObjectUser.LastName@ @DirectObjectUser.TemplateAlias@ |
|
AddContent |
@System.SiteURL@ @System.GroupProfileTemplate@ @System.UserProfileTemplate@ @SubjectUser.Id@ @SubjectUser.UserName@
@SubjectUser.FirstName@ @SubjectUser.LastName@
@Content.Id@ @Content.Title@ @Content.Quicklink@ @Content.Icon@ |
|
AddWorkspaceItem |
@System.SiteURL@ @System.GroupProfileTemplate@ @System.UserProfileTemplate@ @SubjectUser.Id@ @SubjectUser.UserName@
@SubjectUser.FirstName@ @SubjectUser.LastName@
@Content.Id@ @Content.Title@ @Content.Quicklink@ @Content.Icon@ |
|
BlogComment |
@System.SiteUrl@ @System.GroupProfileTemplate@ @System.UserProfileTemplate@ @BlogComment.Id@ @BlogComment.Message@ @SubjectUser.Id@ @SubjectUser.UserName@
@SubjectUser.FirstName@ @SubjectUser.LastName@ @SubjectUser.TemplateAlias@ |
|
BlogPost |
@System.SiteUrl@ @System.GroupProfileTemplate@ @System.UserProfileTemplate@ @SubjectUser.Id@ @SubjectUser.UserName@
@SubjectUser.FirstName@ @SubjectUser.LastName@
@Content.Id@ @Content.Title@ @Content.Quicklink@ @Content.Icon@ |
|
CreateCommunityGroup |
@System.SiteUrl@ @System.GroupProfileTemplate@ @System.UserProfileTemplate@ @SubjectUser.Id@ @SubjectUser.UserName@
@SubjectUser.FirstName@ @SubjectUser.LastName@
@CommunityGroup.Id@ @CommunityGroup.Name@ @CommunityGroup.TemplateAlias@ |
|
ContentMessageBoardPost |
@System.SiteUrl@ @System.GroupProfileTemplate @System.UserProfileTemplate@ @SubjectUser.Id@ @SubjectUser.UserName@
@SubjectUser.FirstName@ @SubjectUser.LastName@
@Content.Id@ @Content.Title@ @Content.Quicklink@ @Content.Icon@ @MessageBoard.ObjectId@ @MessageBoard.ObjectType@ @MessageBoard.Message |
| EditContent |
@System.SiteUrl@ @System.GroupProfileTemplate@ @System.UserProfileTemplate@ @SubjectUser.Id@ @SubjectUser.UserName@ @SubjectUser.DisplayName@ @SubjectUser.FirstName@ @SubjectUser.LastName@ @SubjectUser.TemplateAlias@ @Content.Id@ @Content.Title@ @Content.Quicklink@ @Content.Icon@ |
| EditWorkspaceItem |
@System.SiteUrl @System.GroupProfileTemplate@ @System.UserProfileTemplate@ @SubjectUser.Id@ @SubjectUser.UserName@ @SubjectUser.DisplayName@ @SubjectUser.FirstName@ @SubjectUser.LastName@ @SubjectUser.TemplateAlias@ @Content.Id@ @Content.Title@ @Content.Quicklink@ @Content.Icon@ |
| ForumReply |
@System.SiteUrl@ @System.GroupProfileTemplate@ @System.UserProfileTemplate@ @Topic.Id@, @Topic.Title@ @Topic.Quicklink@ @TopicReply.Id@ @SubjectUser.Id@ @SubjectUser.UserName@ @SubjectUser.DisplayName@ @SubjectUser.FirstName@ @SubjectUser.LastName@ @SubjectUser.TemplateAlias@ |
| ForumPost |
@System.SiteUrl@ @System.GroupProfileTemplate@ @System.UserProfileTemplate@ @Topic.Id@, @Topic.Title@ @Topic.Quicklink@ @TopicReply.Id@ @SubjectUser.Id@ @SubjectUser.UserName@ @SubjectUser.DisplayName@ @SubjectUser.FirstName@ @SubjectUser.LastName@ @SubjectUser.TemplateAlias@ |
|
JoinCommunityGroup |
@System.SiteUrl@ @System.GroupProfileTemplate@ @System.UserProfileTemplate@ @SubjectUser.Id@ @SubjectUser.UserName@
@SubjectUser.FirstName@ @SubjectUser.LastName@
@CommunityGroup.Id@ @CommunityGroup.Name@ @CommunityGroup.TemplateAlias@ |
|
MicroMessage |
@System.SiteUrl@ @System.GroupProfileTemplate@ @System.UserProfileTemplate@ @SubjectUser.Id@ @SubjectUser.UserName@
@SubjectUser.FirstName@ @SubjectUser.LastName@
@MicroMessage.Id@ @MicroMessage.Message@ |
|
UserMessageboardPost |
@System.SiteUrl@ @System.GroupProfileTemplate@ @System.UserProfileTemplate@ @SubjectUser.Id@ @SubjectUser.UserName@
@SubjectUser.FirstName@ @SubjectUser.LastName@ @DirectObjectUser.Id@ @DirectObjectUser.UserName@ @DirectObjectUser.FirstName@ @DirectObjectUser.LastName@
@MessageBoard.ObjectId@ @MessageBoard.ObjectType@ @MessageBoard.Message@ |
|
Message Type |
Associated Tokens |
| Add Calendar Event Update Calendar Event |
@System.SiteUrl@, @System.GroupProfileTemplate@ @System.UserProfileTemplate@ @SubjectUser.Id@ @SubjectUser.UserName@
@SubjectUser.FirstName@ @SubjectUser.LastName@
@WebEvent.Id@ @WebEvent.Title@ @WebEvent.Quicklink@ @WebEvent.StartTime@ @WebEvent.EndTime@ |
|
AddWorkspaceItem |
@System.SiteURL@ @System.GroupProfileTemplate@ @System.UserProfileTemplate@ @SubjectUser.Id@ @SubjectUser.UserName@ @SubjectUser.FirstName@ @SubjectUser.LastName@ @DirectObjectUser.Id@ @DirectObjectUser.UserName@ @DirectObjectUser.FirstName@ @DirectObjectUser.LastName@ @CommunityGroup.Id@ @CommunityGroup.Name@ @Content.Id@ @Content.Title@ @Content.Quicklink@ @Content.Icon@ |
|
BlogComment |
@BlogComment.Id@ @BlogComment.Message@ @SubjectUser.Id@ @SubjectUser.UserName@ @SubjectUser.FirstName@ @SubjectUser.LastName@ |
|
BlogPost |
@SubjectUser.Id@ @SubjectUser.UserName@ @SubjectUser.FirstName@ @SubjectUser.LastName@ @Content.Id@ @Content.Title@ @Content.Quicklink@ |
|
CreateCommunityGroup |
@SubjectUser.Id@ @SubjectUser.UserName@ @SubjectUser.FirstName@ @SubjectUser.LastName@ @CommunityGroup.Id@ @CommunityGroup.Name@ |
|
GroupMessageBoardPost |
@System.SiteUrl@ @System.GroupProfileTemplate@ @System.UserProfileTemplate@ @SubjectUser.Id@ @SubjectUser.UserName@ @SubjectUser.DisplayName@ @SubjectUser.FirstName@ @SubjectUser.LastName@ @SubjectUser.TemplateAlias@ @CommunityGroup.Id@ @CommunityGroup.Name@ @CommunityGroup.TemplateAlias@ @MessageBoard.ObjectId@ @MessageBoard.ObjectType@ @MessageBoard.Message@ |
|
JoinCommunityGroup |
@SubjectUser.Id@ @SubjectUser.UserName@ @SubjectUser.FirstName@ @SubjectUser.LastName@ @CommunityGroup.Id@ @CommunityGroup.Name@ |
|
UserMessageboardPost |
@SubjectUser.Id@ @SubjectUser.UserName@ @SubjectUser.FirstName@ @SubjectUser.LastName@ @DirectObjectUser.Id@ @DirectObjectUser.UserName@ @DirectObjectUser.FirstName@ @DirectObjectUser.LastName@ @MessageBoard.ObjectId@ @MessageBoard.ObjectType@ @MessageBoard.Message@ |
