Launching Laserfiche Scanning with a Custom URL
lfwa80://scanning/<LocationOfScanningService.asmx>?<custom parameters>
Laserfiche Scanning accepts the following parameters:
Parameter | Description |
r=RepositoryName | Specifies the Laserfiche repository name. The specified repository must be listed on the Laserfiche web client Configuration page. The parameter is required for all custom Laserfiche Scanning URLs. |
b=EntryID | Loads Laserfiche Scanning in basic mode and scans into the specified entry. By default, Laserfiche Scanning launches in Standard mode if the URL does not include the b or c parameter. |
c=EntryID | Loads Laserfiche Scanning in standard mode and scans into the specified entry. By default, Laserfiche Scanning launches in Standard mode if the URL does not include the b or c parameter |
d=1 | Specifies that the entry ID set on the b or c parameter is a document and that Laserfiche Scanning will scan into the existing document. This parameter is required if the EntryID specified for the b or c parameter is a document. |
p=PageNumber | If scanning into an existing document, Laserfiche Scanning will insert new pages after the specified page number. |
ci=LanguageString | Loads Laserfiche Scanning in a different language mode if the appropriate Laserfiche language pack is installed. |
rtl=1 | Loads Laserfiche Scanning in Right-To-Left user interface mode. |
cl=EntryID | Specifies that Laserfiche Scanning will automatically fill in the template and field data with the same values as the specified entry. |
custom=CustomizationString | Specifies default values when loading Laserfiche Scanning and whether certain parts of the user interface is disabled. |
The following table details acceptable values for the CustomizationString.
Keyword | Description |
name:'DocumentName' | Specifies the default document name. |
path:'FolderPath' | Specifies the default destination Laserfiche folder path. |
volume:'VolumeName' | specifies the default destination Laserfiche volume using the volume name. |
volid:'VolumeID' | Specifies the default destination Laserfiche volume using the volume ID. |
template:'TemplateName' | Specifies the default Laserfiche template to use for the scanned document. |
[FieldName]'FieldValue' | Specifies default field values. For a multi-value field, separate multiple values with a | character. |
{TagName}'TagComment' | Assign a default tag to the scanned document. |
(AttributeName)'AttributeValue' | Set a user attribute value for that specific instance of Laserfiche Scanning. |
(ProtectedItems)'IntegerValue' |
A user attribute that locks certain default document settings as read-only in the Laserfiche Scanning user interface. IntegerValue can be a sum of the following values: 1: User cannot change the default template. 2: User cannot change the default document name. 4: User cannot change the default volume. 8: User cannot change the default destination folder path. |
Sample custom Scanning URLs:
The following sample launches Scanning in Basic mode and tells Laserfiche Scanning to
- Connect to a repository named "MyRepository"
- Scan into an existing document that has an entry ID of 434166
- Insert new pages after page 3
lfwa80://scanning/http://MyWebServer/laserfiche/App_Services/ScanningService.asmx?r=MyRepository&b=434166&d=1&p=3
This next sample launches Scanning in Standard mode and tells Laserfiche Scanning to
- Connect to a repository named "MyRepository"
- Scan new documents into an existing folder that has an entry ID of 22307
- Set the default document name to "MyNewDoc"
- Set the default template to "General"
- Set the value of the Document field to "MyField Value"
- Prevent the user from being able to change the default template or path of new documents
lfwa80://scanning/http://MyWebServer/laserfiche/App_Services/ScanningService.asmx?r=MyRepository&c=22307&custom=name:'MyNewDoc'template:'General'[Document]'MyFieldValue'(ProtectedItems)'9'
The following sample launches Scanning in Standard mode and tells Laserfiche Scanning to
- Connect to a repository named "MyRepository"
- Scan new documents into the "\Folder 1\SubFolder 2" folder
- Set the default document name to "MyNewDoc"
- Set the default volume to volume ID 124
- Set the default template to "General"
- Set 3 default values for a multi-value field named "Author"
- Prevent the user from modifying the default document name, template, path, and volume.
lfwa80://scanning/http://MyWebServer/laserfiche/App_Services/ScanningService.asmx?r=MyRepository&custom=name:'MyNewDoc'path:'\\Folder 1\\SubFolder 2'volid:'124'template:'General'[Author]'Value1|Value2|Value3'(ProtectedItems)'15'