Unified Client component RRTs

Component RRT ID

The RT ID for this component is UFD .

Reserved Replacement Tag Names (RRTN)

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

RRT	Description
FormName	Name of the form.
Sender	The user name of the authenticated user that is submitting documents. 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
SenderEmail	The email address of the authenticated user.
SenderDomain	The authenticated user’s domain name. 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.
User,%Attribute Name%	RRT template for a user attribute of an authenticated user.
IP	The IP address of the MFP device.
HostName	The resolved host name of the MFP device.
ServerIP	The IP address of the Unified Client application server associated with the device.
ServerHostName	Host name of the Unified Client application server associated with the device (IIS server host name).
PageCount	Number of pages of the scanned file.
Format	Format of the scanned file. Possible values are: PDF JPEG TIFF MTIFF
FileSize	Size in bytes of the scanned file.

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:

The ~UFD::%ClientID%~ will be replaced by "Company" if the user types in "Company" for the field name called "Client ID".

The following scanning settings are used:

Name	Description
Color Mode	Color of the received file.
File Format	File format of the received file.
Resolution	Resolution of the received file.
Original Type	The type of the original document, for example text, photo, or map.
Scan Size	The size of the original document, for example A3, A4, or A5.
Two-sided Original	If the scanned document is two-sided.
Sharpness	Sharpness of the received file.
Density	Density of the received file.
Device MAC Address	MAC address of the device where the document was scanned.
Device Model Name	Model name of the device where the document was scanned.

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 ~UFD::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 ~UFD::User,%displayName%~ will be replaced by "Jane Doe"

Azure Active Directory Replacement Tag Names

If an Azure Active Directory is used to retrieve additional attributes and a user enters "displayName" on the Attributes box, then for an authenticated user which displayName is "Jane Doe".

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

Azure Active Directory user attributes, such as displayName and jobTitle, can be seen in the Azure Portal. For more detailed and complete list of user attributes, refer to the Microsoft documentation at https://docs.microsoft.com/en-us/azure/active-directory/hybrid/reference-connect-sync-attributes-synchronized.

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

Scan Time Replacement Tag Names (STRTN)

This component supports all Date/Time tag names listed in the Special Set Replacement Tag Names (SSRTN) section and the replacement of the start time of the scan at the MFP.