49
Admin Guide – AutoStore 6.0
421
Version 1.2
Copyright 2012 Notable Solutions, Inc.
out fundamental characteristics of the directory and the server. The Root DSE can also provide any
number of vendor-specific attributes.
One of the standard operational attributes is defaultNamingContext
. This attribute contains the
distinguished name (DN) of the root of the directory. In Windows 2000, this is the DN of the Domain
container at the root of the current tree. By reading the defaultNamingContext
attribute from the Root
DSE, you can discover what domain you are logged in to at run time. When you press the Test button,
the domain you are logged into is displayed.
Note
: When the root is left blank, and you press the Test
button, the results may differ from when you
actually run the server with Ricoh ESA component (equipped with Authentication). A blank root uses
the default value, which is retrieved from the account that you are logged into the machine as.
However, when you run the server, you are logged in as LocalSystem (or whichever user name you
specify on the Service tab), possibly yielding different results. For this reason, it is highly recommended
that you either supply the root or login to the service with a user name/password different than
LocalSystem.
Credentials
Enter the LDAP credentials to gain access to LDAP server to lookup user entries.
Anonymous
- Check this box if you want to log in to LDAP server as anonymous user without providing
user name and password.
Username/password
- Enter the username/password to access the LDAP server.
Searching the Database
Select from the following options to search the entries in the address book directory services database:
•
Active Directory
- With Windows Active Directory authentication method, the username is
matched against "samAccountName" field, the Get Email From is matched against "mail" field,
and the Get Display Name From is matched against "displayName" field.
•
eDirectory
- With Netware authentication method use the eDirectory search to match the
Username against "uID" field, Get Email From matched against "mail" field, and Get Display Name
matched against "cn" field.
•
Custom
- Use the custom option when you have multiple types of Authentication. To customize
the search, use this option to create matches against values that you can define for the following:
•
Match Username Against
•
Get Email From
33
Admin Guide – AutoStore 6.0
422
Version 1.2
Copyright 2012 Notable Solutions, Inc.
•
Get Display Name From
Click Reset
to blank out the above field values.
Test
To test the settings, click the Test
button and enter a user name as it will be entered on the MFP. This
verifies that an email address and display name can be found for the user on the LDAP server.
Runtime Replacement Tags (RRT)
What are RRTs?
Runtime Replacement Tags (RRT) are tags placed within the configuration file for replacement by
metadata values during execution time. At runtime (when a component is executed within the
application), each component is responsible for searching all items within the configuration memory
structure and replacing their assigned RRTs with actual metadata values.
How does it work?
When you create a process that consists of a series of components, the components are executed in
order from left to right (Capture to Route). Each component, prior to its termination, searches all
configuration entries and replaces all its own RRTs with actual meta-data values. As an example, the
XML Knowledge Package Loader component will search for RRT’s starting with “~ASX::” and replaces
them with actual metadata values.
The order of execution of components within a process is significant. Due to the component execution
order (Capture to Route), RRT’s owned by components that appear later in a process cannot be placed
within components that appear earlier in a process. As an example, placement of Folder Store
component RRT’s within a Capture component such as Poll Directory is invalid and will not be replaced
at runtime.
RRT naming convention
The figure below provides you with an illustration of the RRT definition. Each part of the RRT is designed
to create a standard field tag replacement that can be expanded to all components designed and
developed within the component framework.
40
Admin Guide – AutoStore 6.0
423
Version 1.2
Copyright 2012 Notable Solutions, Inc.
Important Note:
RRT’s are case sensitive. You must follow the proper case for all RRTs. You cannot
introduce space characters in between the RRT segments.
The table below provides details on each segment of the RRT:
Segment
Name
Description
Markers
Special characters used to mark the beginning and the ending of each RRT. The “~” is
used to mark each end. Note that you cannot use the same character anywhere within
the other parts of the RRT. Having “~” appear as a value of a special field is not
supported with this new RRT design.
RRT ID
Special three characters identifying the component owning the RRT and responsible for
replacing the tags with the actual values.
Separators
Double colon “::” characters used to separate the Component RRT ID from the actual
Replacement Tag Name. Double colon is now reserved and cannot be used within other
parts of the RRT. Example of an illegal use of :: is “~MYC::Invoice::Number~” where the
double colon is repeated within the replacement tag name
Replacement
Tag Name
The Replacement Tag Name or RTN can be the name of the metadata collected from a
content source (e.g., device, etc.), or a metadata generated by the component itself
(e.g., XML data field, etc.). The following types of RTN are currently supported:
i.
Reserved (RRTN)
– Each component is allowed to create and maintain a set of
reserved RTN or RRTN. Within the boundaries of each component reserved names
have special meaning. Each component defines a list of RRTNs.
ii.
Field (FRTN)
- Some components that support field names allow the fields to be
referenced using the special enclosure character: “%”. An example of field name
used within RRT is:
The image part with relationship ID rId241 was not found in the file.
48
Admin Guide – AutoStore 6.0
424
Version 1.2
Copyright 2012 Notable Solutions, Inc.
Segment
Name
Description
~MYC::%Invoice Number%~
This example allows replacement for a field called “Invoice Number” within the
MYC component with the value of the field Invoice Number.
iii.
Special Sets (SSRTN)
- These are special set of characters providing you with
useful information on the job such as document date, document time, etc. It’s
important to note that not all components support the SSRTN values. Look in
documentation for each component to find the components that do support
SSRTNs
Ricoh ESA Component RRTs
Component RRT ID
The RRT ID for this component is RCH
.
Reserved Replacement Tag Names (RRTN)
The following table describes the reserved RTN values for this component:
Name
Description
UserName The username of the authenticated user if authentication is enabled on the component
t
preference tab.
Email
The email address of the authenticated user if authentication is enabled on the component
preference tab.
DisplayName The display name of the authenticated user if authentication is enabled on the component
preference tab.
Domain
The domain of the authenticated user if authentication is enabled on the component
preference tab.
DoDEDI
The DOD EDI ID of the authenticated user if the device is CAC enabled.
UserID
The user ID of the authenticated user if the device is CAC or CAP enabled.
IPAddress The IP address of the MFP device.
HostName The resolved host name of the MFP device.
PageCount Number of pages received.
Format
Valid file format is: Tiff
FileSize
Received file size.
Field Replacement Tag Names (FRTN)
54
Admin Guide – AutoStore 6.0
425
Version 1.2
Copyright 2012 Notable Solutions, Inc.
This component supports FRTNs and replacement of field names generated from the MFP devices. The
following example provides some sample usage for your reference:
~RCH::%Client ID%~
- replaced by “Company” if the user types in “Company” for the field name called
“Client ID”.
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)
31)
%H Hour in 24-hour format (00 – 23)
23)
%I Hour in 12-hour format (01 – 12)
12)
%j Day of year as decimal number (001 – 366)
66)
%m Month as decimal number (01 – 12)
12)
%M Minute as decimal number (00 – 59)
59)
%p Current locale’s A.M./P.M. indicator for 12-hour clock
ock
%S Second as decimal number (00 – 59)
59)
%U Week of year as decimal number, with Sunday as first day of week (00 – 53)
53)
%w Weekday as decimal number (0 – 6; Sunday is 0)
0)
%W Week of year as decimal number, with Monday as first day of week (00 – 53)
53)
%y Year without century, as decimal number (00 – 99)
99)
%Y Year with century, as decimal number
Troubleshooting tips
No information is available at this time.
Restrictions
If you plan to use Form Field Names in the Rename Schema of your subsequent component, you cannot
use the following characters:
•
/
•
\
•
:
The image part with relationship ID rId242 was not found in the file.
How to C#: Special Effects Erase. Set the image to current background color, the background color can be set by:ImageProcess.BackgroundColor = Color.Red. Encipher.
how to delete text in pdf converter; how to erase text in pdf online
41
Admin Guide – AutoStore 6.0
426
Version 1.2
Copyright 2012 Notable Solutions, Inc.
•
?
•
"
•
<
•
>
•
|
Use of the following characters is illegal within the Menu, Form, Group:
•
&
•
<
•
>
VB Scripting
The VB Script feature provides the ability to extend the functionally of otherwise static Forms by
allowing custom VB Scripts to be executed on the server at runtime to update form field values/settings
and perform any necessary form field validation based on any available runtime data.
Events
Form_OnLoad
Button_OnClick(Form, ButtonName)
Field_OnValidate
Field_OnChanged
Form_OnScan(Form)
Form_OnLoad(Form)
This event occurs before a form is displayed on the device panel.
Arguments
Form
The form object that is being loaded.
Remarks
You can use this event to perform tasks such as initializing the form fields or the form scan settings.
Example
Sub Form_OnLoad(Form)
’Write custom code to lookup the authenticated user’s home directory.
36
Admin Guide – AutoStore 6.0
427
Version 1.2
Copyright 2012 Notable Solutions, Inc.
Form.SetFieldValue ”Path”, LookupHomeDirectory(Form.UserName)
End Sub
Field_OnValidate(FieldName, FieldValue)
This event occurs when a when user attempts to set a new value for a field on the form.
Arguments
FieldName
The name of the field that requires validation
FieldValue
The value of the field that requires validation.
Remarks
You can use this event to perform tasks such validating user input for a form field. If the return value is
empty string then validation is assumed to have been successful.
Example
Function Field_OnValidate(FieldName, FieldValue)
Field_OnValidate = ””
'Write custom validation to check that the user is attempting to enter a value for the Amount field
that is less then 100.
If (FieldName = ”Amount”) Then
If (CInt(FieldValue) > 100) Then
Field_OnValidate = ”Amount cannot be greater than 100.”
End If
End If
End Function
Field_OnChanged(Form, FieldName, FieldValue)
This event occurs when a field value on the form has changed.
Arguments
Form
The form object.
FieldName
The name of the field.
FieldValue
The value of the field.
36
Admin Guide – AutoStore 6.0
428
Version 1.2
Copyright 2012 Notable Solutions, Inc.
Remarks
You can use this event to perform tasks such as populating other form field values based on the changed
field value.
Example
Sub Field_OnChanged(Form, FieldName, FieldValue)
’Write custom code to lookup the user’s home directory.
If (FieldName = ”UserName”) Then
Form.SetFieldValue ”Path”, LookupHomeDirectory(FieldValue)
End If
End Sub
Form_OnScan(Form)
This event occurs when a form is open and the device start button is pressed and before device begins
the scan operation. If the return value is empty string then validation is assumed to have been
successful.
Arguments
Form
The form object where the scan was initiated from.
Remarks
You can use this event to perform tasks such as populating or validating the form fields.
Example
Function Form_OnScan(Form)
If (Form.UserName = "") Then
Form_OnScan = "Unable to lookup the user's home directory"
Else
’Write custom code to lookup the authenticated user’s home directory.
Form.SetFieldValue ”Path”, LookupHomeDirectory(Form.UserName)
End If
End Function
Button_OnClick(Form, ButtonName)
This event occurs when a button field on a form is pressed
Arguments
Form
38
Admin Guide – AutoStore 6.0
429
Version 1.2
Copyright 2012 Notable Solutions, Inc.
The form object.
ButtonName
The name of the button field.
Remarks
You can use this event to perform tasks such as populating other form field values.
Example
Sub Button_OnClick(Form, ButtonName)
'Write custom code to lookup the user’s home directory.
If (ButtonName = ”MyButton”) Then
Form.SetFieldValue ”Path”, LookupHomeDirectory(Form.UserName)
End If
End Sub
Form Object
Properties
DeviceAddress
- Returns the device IP address.
DoDEDI
- Returns the CAC authenticated user's DOD EDI ID. This property is only available if CAC
authentication has been enabled for the device.
UserID
- Returns the authenticated user ID. This property is only available if CAC or CAP authentication
has been enabled for the device.
UserName
- Returns the authenticated user’s account name. This property is only available if
authentication has been enabled for the device.
EMailAddress
- Returns the authenticated user’s email address. This property is only available if
authentication has been enabled for the device.
Methods
GetFieldValue
SetFieldValue
SetFieldVisible
SetFieldEnabled
UpdateListField
36
Admin Guide – AutoStore 6.0
430
Version 1.2
Copyright 2012 Notable Solutions, Inc.
UpdateStringField
UpdateBooleanField
UpdateDateField
UpdateNumberField
UpdateLabelField
SetScanAttributes
UpdateFolderBrowseField
StatusMsg
ErrorMsg
WarningMsg
TraceMsg
GetFieldValue(FieldName)
Returns the value of a form field.
Arguments
FieldName
The name of the field.
Return Value
A string expression representing the value of the field.
Note: The return value for the String list type is the label of the selected entry.
SetFieldValue(FieldName, FieldValue)
Set the value of a form field.
Arguments
FieldName
The name of the field.
FieldValue
The value of the field.
SetFieldVisible(FieldName, Visible)
Determines if the field is visible or hidden
Arguments
FieldName
The name of the field.
Visible
Documents you may be interested
Documents you may be interested
