Variables – And the External Data Providers that Use Them
Users of the Data Integration Toolset are likely familiar with the “Common Use Variables” – <%SiteURL%>, <%HostName%> and <%SiteSecurityType%> – as these can be used throughout the Toolset web parts, anytime you have a property expecting a URL. These are great because they allow you to build your solutions with essentially relative paths throughout, ensuring portability and re-usability of the components.
However, did you know the External Data Provider (EDP) supports these, along with a dozen or so more variables? Specifically, these variables can be utilized within your EDP connection files and really extend the options you have for not only setting URLs but also passing details into the connection.
Listed here is a table of all the currently supported variables. For those that relate to user information, we’ll use the following details to illustrate.
Sample User Login: EXT\Sample.User
Sample User Name: Sample User
Sample User Email: sample.user@corasworks.net
| Name | Description (example) |
|
%SiteURL% |
The fully qualified URL for the site the EDP is currently on. |
|
%HostName% |
The Hostname of the web application where the EDP currently resides. (www.url.com) |
|
%SiteSecurityType% |
The security protocol of the web application where the EDP currently exists. (http:// or https://) |
|
%CWUserName% |
The username of the currently logged in user (EXT\Sample.User) |
|
%CWUID% |
The ID of the currently logged in user |
|
%CWUserEmail% |
The email address of the currently logged in user (sample.user@corasworks.net) |
|
%CWDisplayName% |
The display name of the currently logged in user (Sample User) |
|
%CWUserNameND% |
The username of the currently logged in user, minus any domain (Sample.User) |
|
%CWSiteURL% |
The current URL of the site where the EDP resides – deprecated, same as %SiteURL% (http://www.url.com/sites/SampleSite) |
|
%CWSiteTitle% |
The site title of the site where the EDP currently resides (Sample Site) |
|
%ReferringPage% |
The URL of the referring page that called the EDP |
Posted by Steve P. Evangelista on 6-Mar-09