Xerox component RRTs
Component RRT ID
The RRT ID for this component is UFD.
Custom Scripting Authentication RRTs
Values for the following fields are read and assigned from the Xerox cache. These are passed on to providers for authentication during single sign-on.
Name | Description |
---|---|
USERNAME | User ID as stored in ControlSuite. |
PASSWORD | Password of the user defined in USERNAME. |
DOMAIN | Domain used to log on user. |
EMAIL_ADDRESS | User's email address. |
JBAUSERID | User ID assigned to the job. |
JBAACCOUNTID | Account ID assigned to the job. |
XSAUSERID | Xerox Standard Accounting user ID as provided by the Xerox firmware. |
XSAACCOUNTTYPE | Xerox Standard Accounting account type as provided by the Xerox firmware. |
XSAACCOUNTID | Xerox Standard Accounting account ID as provided by the Xerox firmware. |
KERB_REALM | Kerberos realm |
Reserved Replacement Tag Names (RRTN)
The following table describes the reserved RTN values for this component:
Name | 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:
|
SenderEmail | The email address of the authenticated user. |
SenderDomain | The authenticated user’s domain name.
This RRT is populated in the following cases:
|
IP | The IP address of the MFP device. |
HostName | The resolved host name of the MFP device. |
ServerIP | The IP address of the Xerox application server associated with the device. |
ServerHostName | Host name of the Xerox 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:
|
FileName | The original name of the file. |
FileSize | Size in bytes of the scanned file. |
Format | File format of the original document:
|
User,%Attribute Name% | RRT template for a user attribute of an authenticated user. |
Device Type | Device type of the device where the document was scanned. |
Device Model Name | Model name of the device where the document was scanned. |
Device Firmware Version | The firmware version of the device. |
Unified Client Version | The version of the Unified Client. |
Device MAC Address | MAC address of the device where the document was scanned. |
Device Hostname | Host name of the device where the document was scanned. You can edit or rename the host name in the document. |
Device Serial Number | The serial number of the device. |
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:
- ~SXW::%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 ~SXW::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 ~SXW::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 |