Kyocera MFP (HyPAS) component RRTs

Component RRT ID

The RRT ID for this component is K20.

Reserved Replacement Tag Names (RRTN)

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

Name Description
FormName The name of the form.
Sender The user name of the authenticated user that is submitting documents.
Note: This RRT is populated in any of the following cases:
  • The component has been configured to use an authentication method other than None.
  • The device authentication is turned on.
SenderEmail The email address of the authenticated user.
SenderDomain The domain name of the authenticated user.

This RRT is populated in both the following cases:

  • The component has been configured to use Windows authentication.
  • The component has been configured to use Custom authentication and the associated .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.
Format Format of the scanned file. Possible values are:
  • Tiff (TIFF file)
  • PDF
  • JPEG
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 sample usage for your reference:

The RRT ~K20::%Client ID%~ 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 sample usage for your reference:

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

If an LDAP Search is used to retrieve additional attributes, and you entered "displayName" on the Additional Attributes box, then for an authenticated user with displayName set to "Jane Doe", the RRT ~K20::User,%displayName%~ will be replaced by ”Jane Doe”.

Special Set Replacement Tag Names (SSRTN)

This component supports all the Date/Time tag names listed in the following table:

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 to 31)
%H Hour in 24-hour format (00 to 23)
%I Hour in 12-hour format (01 to 12)
%j Day of year as decimal number (001 to 366)
%m Month as decimal number (01 to 12)
%M Minute as decimal number (00 to 59)
%p Current locale’s A.M./P.M. indicator for 12-hour clock
%S Second as decimal number (00 to 59)
%U Week of year as decimal number, with Sunday as first day of week (00 to 53)
%w Weekday as decimal number (0 to 6; Sunday is 0)
%W Week of year as decimal number, with Monday as first day of week (00 to 53)
%y Year without century, as decimal number (00 to 99)
%Y Year with century, as decimal number