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 Name of the form.
Sender The user name of the authenticated user that is submitting document(s) is returned. 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 The email 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 The authenticated user’s domain name.  This is available 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 The IP address of the MFP device.
HostName The resolved host name of the MFP device.
ServerIP The IP address of the Sharp OSA Web server which should be the same as the AutoStore server.
ServerHostName The Host Name of the Sharp OSA Web server which should be the same as the AutoStore Server.
PageCount Number of pages of the scanned file.
Format Format of the scanned file. Possible values are:
  • TIFF
  • PDF
  • JPEG
  • EncryptedPDF
FileSize 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. When third-party card authentication is used with the following authentication settings:

  • If authentication is set to None, Sender, SenderEmail and SenderDomain will be set according to device information for the logged in third-party card authenticated user.
  • If authentication is set to Windows, Sender, SenderEmail and SenderDomain will be set according to device and server authentication information for logged in third-party card authenticated users who have Windows logins. Device information has priority for these three reserved RTNs.
  • If set to Netware, Sender, SenderEmail and SenderDomain will be set according to Netware authentication. Device information will be discarded.
  • If set to Custom Script, Sender, SenderEmail and SenderDomain will be 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. The following example provides some sample usage for your reference:

The RRT string ~SH2::%Client ID%~ will be 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 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 RRT will look like:

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 be pre-fixed with the text MFPUserAttr- to distinguish normal user attributes. For example, if third-party card authentication provides attribute "Display-name", the third-party card authenticated user's attribute name for this will appear as "MFPUserAttr-Display-name". The RRT will look like:

 

The RRT string ~SH2::User,%MFPUserAttr-Display-name%~ will be replaced by "John Doe" with the logged in user's display name from the third-party card authentication system.

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