Web Capture component RRTs

Component RRT ID

The RRT ID for this component is WCC.

Reserved Replacement Tag Names (RRTN)

The following table describes the reserved RTN values for this component.

Name Description
FileCount The number of the captured files.
FileName,* The name of the captured file where * is the ordinal number of the file in the complex object.

Examples:

  • ~WCC:FileName,1~ will be replaced with the name of the first file in the object.
  • ~WCC:FileName,*~ will be replaced with the names of all files in the object.

FilePath,* The path to the captured file where * is the ordinal number of the file in the complex object.

Examples:

  • ~WCC:FilePath,1~ will be replaced with the path to the first file in the object.
  • ~WCC:FilePath,*~ will be replaced with the paths of all files in the object.

FileSize,* The size in bytes of the captured file where * is the ordinal number of the file in the complex object.

Examples:

  • ~WCC:FileSize,1~ will be replaced with the size to the first file in the object.
  • ~WCC:FileSize,*~ will be replaced with the sizes of all files in the object.

FormName The name of the form.
UserName The user name of the authenticated user that is submitting document(s).
UserEmail The email address of the authenticated user. This RRT is populated under one of the following conditions:
  • When Active Directory authentication is selected.
  • When Integrated Windows or LDAP authentication is selected, the email address is searched for in the LDAP server if the Use an LDAP Search to retrieve additional user information option on the Authentication tab is selected and the search parameters in the LDAP Lookup Settings dialog box are properly configured.
  • When Custom Script authentication is selected, this RRT is populated if the associated .NET script defines the Email property of the UserInfo object.
UserDomain The authenticated user's domain name. This RRT is populated under one of the following conditions:
  • The component has been configured to use Windows authentication.
  • The component has been configured to use Active Directory authentication.
  • The component has been configure to use LDAP authentication. In this case, the domain will be defined if the user enters his/her name in the following forms: Domain\User or User@domain.com.
  • The component has been configured to use Custom authentication and the associated .NET script populates the Domain property of the UserInfo object.
UserIp The IP address of the client.
UserHostName The resolved host name of the client.
WebServerIp The IP address of the web server.
WebServerHostName The resolved host name of the web server.
RRT for Send To Folder form
#Path The path to the folder in which the documents are saved.
#DocName The name of the document.
RRT for Send to Email Form
#To The list of recipients of the email message.
#From The sender address. Unavailable if the option Do not show a From field. Use the device logged in user's email address is selected.
#Subject The subject of the email.
#Message The message.
#CC The list of secondary recipients. This RRT is available if the Show a CC field option is selected.
#BCC The list of recipients who will receive the message without anyone else seeing who they are. This RRT is available if the Show a BCC field option is selected.
RRT for Send To SharePoint Form
#Site The name of the SharePoint site.
#DocumentLibrary The name of the document library to which the documents are sent.
#FolderPath The name of the folder where the documents are stored.
#ContentType The name of the content type.

User Attributes Replacement Tag Names (URTN)

This component supports URTNs and replacement of user attributes specific to the used authentication method. The basic template for such RRTs is as follows:

~WCC::User,%Attribute Name%~. The Attribute Name represents a user specific attribute.

The following examples provide some samples of URTN usage:

  • If Custom authentication is used and there is a user attribute named "FullName" with the value John Doe, then the corresponding RRT will be ~WCC::User,%FullName%~. This RRT will be replaced with "John Doe".
  • If an LDAP Search is used to retrieve additional attributes, and you entered DisplayName on the Additional Attributes box, then for an authenticated user whose DisplayName is Jane Doe, the corresponding RRT string will be ~ WCC::User,%DisplayName%~. This RRT will be replaced with "Jane Doe".

Field Replacement Tag Names (FRTN)

The component supports Field Replacement Tag Names and replacement of field names. Such RRTs look as follows: ~WCC::%FieldName%>~, where FieldName represents the name of the referenced field.

The following example provides some sample usage for your reference:

If the user adds a field with the name "Client ID" and specifies its value as "", the RRT string for this field will be ~WCC::%Client ID%~, and the RRT will be replaced with "".

Special Set Replacement Tag Names (SSRTN)

This component supports all the Date/Time tag names listed below:

Name Description
%a Abbreviated English weekday name (Sun – Sat)
%A Full English weekday name (Sunday – Saturday)
%b Abbreviated English month name (Jan – Dec)
%B Full English month name (January – December)
%d Day of month as 2-digit decimal number (01 – 31)
%H Hour in 24-hour format (00 – 23)
%I Hour in 12-hour format (01 – 12)
%j Day of year as decimal number (001 – 366)
%m Month as decimal number (01 – 12)
%M Minute as decimal number (00 – 59)
%p Current locale’s A.M./P.M. indicator for 12-hour clock
%S Second as decimal number (00 – 59)
%U Week of year as decimal number, with Sunday as first day of week (00 – 53)
%w Weekday as decimal number (0 – 6; Sunday is 0)
%W Week of year as decimal number, with Monday as first day of week (00 – 53)
%y Year without century, as decimal number (00 – 99)
%Y Year with century, as decimal number
Date and time related RRTs are evaluated in Coordinated Universal Time (UTC) by default. It can be set to use local time, for more details, see Using RRTs.