Sharp MFP (OSA) component RRTs

Component RRT ID

The RRT ID for this component is SH2.

Reserved Replacement Tag Names (RRTN)

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

Name Description
FormName Returns the name of the form.
Sender Returns the user name of the authenticated user that is submitting documents. If authentication is set to None and third-party card authentication is not used, this will return blank. If third-party card authentication is used, the user credentials for the logged in third-party card authenticated user will be returned.
SenderEmail Returns the email address of the user. If authentication is set to None and third-party card authentication is not used, this will return blank. If third-party card authentication is used, the email address for the logged in third-party card authenticated user will be returned.
SenderDomain Returns the domain name of the authenticated user.  This is available if Windows authentication has been turned on for the MFP device or if Custom authentication is used and the associated VB.NET script populates the Domain property of the UserInfo object.
IP Returns the IP address of the MFP device.
HostName Returns the resolved host name of the MFP device.
ServerIP Returns the IP address of the Sharp OSA Web server, which is usually the same as the AutoStore server.
ServerHostName Returns the host name of the Sharp OSA Web server, which is usually the same as the AutoStore Server.
PageCount Returns the number of pages in the scanned file.
Format Returns the format of the scanned file. Possible values are:
  • TIFF
  • PDF
  • JPEG
  • EncryptedPDF
FileSize Returns the size in bytes of the scanned file.

When third-party card authentication is used, Sender, SenderEmail, and SenderDomain will be set according to credentials for the third-party card authentication system as shown in the following table:

Authentication Sender, SenderEmail, and SenderDomain
None Set according to device information for the logged in third-party card authenticated user.
Windows Set according to device and server authentication information for logged in third-party card authenticated users who have Windows logon credentials. Device information has priority for these three reserved RTNs.
NetWare Set according to NetWare authentication. Device information will be discarded.
Custom Script Set according to device and custom script information for the logged in third-party card authenticated users that are verifiable through the custom script. Device information has priority for these three reserved RTNs.

Field Replacement Tag Names (FRTN)

This component supports FRTNs and replacement of field names generated from the MFP devices.

For example, if a user types "Company" in the Client ID field, the RRT string ~SH2::%Client ID%~ will be replaced by "Company".

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 sample usage for your reference:

If Custom authentication is used and there is a user attribute named "Display-name" with the value "John Doe", then the the RRT string ~SH2::User,%FullName%~ will be replaced by "John Doe".

When third-party card authentication is used, all attributes will be pulled from the device and every attribute name will have the prefix MFPUserAttr- to distinguish them from normal user attributes.

For example, if third-party card authentication provides the attribute Display-name, the third-party card authenticated user attribute name will be %MFPUserAttrr-Display-name%. Then when the display name from the third party authentication system is "Jane Smith", the RRT string ~SH2::User,%MFPUserAttr-Display-name%~ will be replaced by "Jane Smith".

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