›

Toshiba Unified Client component RRTs

This topic describes RRTs that are available for use with the Toshiba Unified Client component.

Component RRT ID

The RRT ID for this component is TSO.

Reserved Replacement Tag Names (RRTN)

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

Name Tag Description
Device Host Name HostName The resolved host name of the MFP device.
Device IP Address IP The IP address of the MFP device where the document was scanned.
File Format Format File format of the original document:
  • Multipage TIF
  • Single page TIF
  • PDF
  • JPG (color MFDs)
File Page Count PageCount Number of pages of the scanned file.
File Size FileSize Size in bytes of the scanned file.
Form Name FormName Name of the form that was selected on the MFP.
Sender Domain SenderDomain The authenticated user’s domain name if authentication has been turned on for the MFP device.

This RRT is populated in the following cases:

  • The component has been configured to use Windows authentication.
  • The component has been configured to use Custom authentication and the associated Script.NET script populates the Domain property of the UserInfo object.
Sender Email SenderEmail The email address of the authenticated user if authentication has been turned on for the MFP device.
Sender Username Sender The user name of the authenticated user that is submitting documents if authentication has been turned on for the MFP device.

This RRT is populated in the following cases:

  • The component has been configured to use an authentication method other than None.
  • The device authentication is turned on for Extensible Services (Custom Services).
  • Authentication has been configured for the device.
User Attribute User,%Attribute Name% RRT template for a user attribute of an authenticated user.

Field Replacement Tag Names (FRTN)

This component supports FRTNs and replacement of field names generated from the MFP devices.  The following example provides some examples:

~TSO::%ClientID%~
This is replaced by "Company" if the user types in "Company" for the field name called "Client ID".

User attributes Replacement Tag Names (URTN)

This component supports URTNs and replacement of user attributes specific to the authentication method used.  The following example provides some examples:

If Custom authentication is used and there is a user attribute named "Full Name" with the value" John Doe" then the RRT will look like:

The RRT ~TSO::User,%FullName%~ will be replaced by "John Doe"

If an LDAP Search is used to retrieve additional attributes and a user enters "displayName" on the Additional Attributes box, then for an authenticated user which displayName is "Jane Doe":

The RRT ~TSO::User,%displayName%~ will be replaced by "Jane Doe"

Special Set Replacement Tag Names (SSRTN)

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

Name Description
%a Abbreviated weekday name
%A Full weekday name
%b Abbreviated month name
%B Full month name
%d Day of month as 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