Product Documentation

Dynamic tokens

May 22, 2017

String operations

Sometimes you need to manipulate strings within a script to map drives or launch applications. The following string operations are accepted by the Workspace Environment Management agent:

String operations Copy

#Left(string,length)#

#Right(string,length)#

#Truncate(string,length)#

 

&Trim(string)&

&RemoveSpaces(string)&

&Expand(string)&

 

$Split(string,[splitter],index)$

 

#Mid(string,startindex)#

!Mid(string,startindex,length)!

Note

All Operators are case sensitive. String operations are also supported with hashtags and Active Directory attributes. In cases where your string operations are nested, Mid operations are always performed last.

Hashtags

Hash-tags are a replacement feature widely in Workspace Environment Management item processing. The following example illustrates how you use hash-tags:

To write to an .ini file, you can use %UserName% in the .ini file's path and Workspace Environment Management processes it and expands the final directory. However, assessing the value which Workspace Environment Management writes in the .ini itself is more complicated: you may want to write %UserName% literally, or write the expanded value.

To increase flexibility, ##UserName## exists as a hash-tag, so that using %UserName% for a value writes it literally and ##UserName## writes the expanded value.

The following hash-tags have been implemented for general use:

Hash tags Copy

##UserName##

##UserProfile##

##FullUserName##

##UserInitials##

##UserAppData##

##UserPersonal##

##UserDocuments##

##UserDesktop##

##UserFavorites##

##UserTemplates##

##UserStartMenu##

##UserStartMenuPrograms##

##ComputerName##

##ClientName##

##ClientIPAddress##

##ADSite##

##DefaultRegValue##

##UserLDAPPath##

##VUEMAgentFolder##

##RDSSessionID##

##RDSSessionName##

##ClientRemoteOS##

##ClientOSInfos##

Hash-tag ##UserScreenCaptureComment## is implemented for use in specific parts of the product. This tag can be included in the Email Template under Advanced Settings > UI Agent Personalisation > Helpdesk Options. When included, users are presented with a comment field located below the screen capture in the agent screen capture utility. The comment is included in the support email at the location at which you placed the tag in the email template.

Note

All Hashtags are case sensitive.

Active Directory Attributes

To work with Active Directory Attributes, Workspace Environment Management replaces the [ADAttribute:attrName] value with the related Active Directory attribute.

For user OU structures, Citrix Workspace Environment Management replaces the [UserParentOU:level] value with the related Active Directory OU name.

Note

All AD attributes are case sensitive.