Scanshare Application Manual v4.9
Scanshare Application Manual v4.9
Scanshare Application Manual v4.9
Table of Contents
Part I Introduction 10
Part II Installation 12
1 System
...................................................................................................................................
requirements 12
2 Installer
................................................................................................................................... 13
Custom ......................................................................................................................................................... 17
3 Activation
................................................................................................................................... 18
ABBYY Scan
.........................................................................................................................................................
pack 21
4 First
...................................................................................................................................
time startup 22
5 Log
...................................................................................................................................
in 23
Admin Login
......................................................................................................................................................... 24
User Login......................................................................................................................................................... 25
Typed or......................................................................................................................................
Selected (filtered) 122
DateTime ...................................................................................................................................... 123
Password ...................................................................................................................................... 124
Toggle ...................................................................................................................................... 125
Numeric...................................................................................................................................... 125
Label ...................................................................................................................................... 126
Triggers...................................................................................................................................... 127
Olivetti openAPI
...........................................................................................................................................
client 128
Questions ...................................................................................................................................... 129
Typed ...................................................................................................................................... 130
Selected...................................................................................................................................... 131
Typed or......................................................................................................................................
Selected 133
Typed or......................................................................................................................................
Selected (filtered) 133
DateTime ...................................................................................................................................... 134
Toggle ...................................................................................................................................... 135
Numeric...................................................................................................................................... 136
Label ...................................................................................................................................... 137
Triggers...................................................................................................................................... 138
Olivetti client
........................................................................................................................................... 139
Questions ...................................................................................................................................... 139
Typed ...................................................................................................................................... 141
Selected...................................................................................................................................... 142
Typed or......................................................................................................................................
Selected 143
Password ...................................................................................................................................... 144
Toshiba (e-BRIDGE)
........................................................................................................................................... 144
Questions ...................................................................................................................................... 145
Typed ...................................................................................................................................... 146
Selected...................................................................................................................................... 147
Search while
......................................................................................................................................
typing 149
Label ...................................................................................................................................... 150
Password ...................................................................................................................................... 151
Triggers...................................................................................................................................... 152
Kyocera client
........................................................................................................................................... 153
Questions ...................................................................................................................................... 153
Typed ...................................................................................................................................... 155
Selected...................................................................................................................................... 156
Typed or......................................................................................................................................
Selected 157
Password ...................................................................................................................................... 158
Lexmark client
........................................................................................................................................... 158
Questions ...................................................................................................................................... 159
Typed ...................................................................................................................................... 160
Selected...................................................................................................................................... 161
Typed or......................................................................................................................................
Selected 163
Password ...................................................................................................................................... 164
Ricoh client
........................................................................................................................................... 164
Questions ...................................................................................................................................... 165
Typed ...................................................................................................................................... 167
Selected...................................................................................................................................... 168
Typed or......................................................................................................................................
Selected 169
Samsung...........................................................................................................................................
client 170
Questions ...................................................................................................................................... 170
Typed ...................................................................................................................................... 172
Selected...................................................................................................................................... 173
Typed or......................................................................................................................................
Selected 175
Selected...................................................................................................................................... 230
Typed or......................................................................................................................................
Selected 231
Password ...................................................................................................................................... 232
Mobile client........................................................................................................................................... 232
Typed ...................................................................................................................................... 234
Selected...................................................................................................................................... 235
Typed or......................................................................................................................................
Selected 237
Password ...................................................................................................................................... 238
Picklists ........................................................................................................................................... 238
Static ...................................................................................................................................... 241
SQL ...................................................................................................................................... 242
Script ...................................................................................................................................... 243
XML ...................................................................................................................................... 245
Afas Online ...................................................................................................................................... 245
Affinity ...................................................................................................................................... 247
Amazon......................................................................................................................................
AWS 249
Box ...................................................................................................................................... 250
DocuWare ...................................................................................................................................... 251
Dokmee...................................................................................................................................... 253
Dropbox ...................................................................................................................................... 255
Dynamics ......................................................................................................................................
NAV 257
ELO ...................................................................................................................................... 258
Email ...................................................................................................................................... 260
Evernote ...................................................................................................................................... 261
DossierApp ...................................................................................................................................... 262
Google ......................................................................................................................................
Drive 263
InfinityLaw ...................................................................................................................................... 265
Infotraq...................................................................................................................................... 267
LEAP Matter ......................................................................................................................................
List 268
M-Files ...................................................................................................................................... 269
MediaFire ...................................................................................................................................... 270
Nedap Ons ...................................................................................................................................... 271
OliBox ...................................................................................................................................... 272
OneDrive ...................................................................................................................................... 273
OneDrive ......................................................................................................................................
for Business 274
OpenText ......................................................................................................................................
Content Server 275
Orbeon...................................................................................................................................... 277
PlacePoint ...................................................................................................................................... 278
PowerOffice ...................................................................................................................................... 281
Print ...................................................................................................................................... 282
Raet Youforce...................................................................................................................................... 282
Records......................................................................................................................................
Manager 284
Regas ...................................................................................................................................... 285
Scanshare ......................................................................................................................................
Repository 286
Sentral ...................................................................................................................................... 289
Citrix ShareFile
...................................................................................................................................... 289
Sharepoint ...................................................................................................................................... 292
WebDAV ...................................................................................................................................... 294
Folder Browse...................................................................................................................................... 295
Windream ...................................................................................................................................... 296
Worksite ...................................................................................................................................... 297
Xero ...................................................................................................................................... 305
XPLAN ...................................................................................................................................... 307
Processing
.................................................................................................................................................. 308
Annotation........................................................................................................................................... 308
Barcode Reader
........................................................................................................................................... 310
Barcode Writer
........................................................................................................................................... 314
Data Export
........................................................................................................................................... 319
ICR ........................................................................................................................................... 321
Image Processing
........................................................................................................................................... 326
OMR ........................................................................................................................................... 328
Report Generator
........................................................................................................................................... 333
Zone OCR ........................................................................................................................................... 338
Store .................................................................................................................................................. 343
Output Settings
........................................................................................................................................... 351
Output ......................................................................................................................................
Profile 352
BMP ...................................................................................................................................... 353
Alto (XML)...................................................................................................................................... 354
Excel (xls)
...................................................................................................................................... 355
Excel (xlsx)
...................................................................................................................................... 358
Jpeg ...................................................................................................................................... 362
Open Office
......................................................................................................................................
(odt) 362
Original...................................................................................................................................... 365
GIF ...................................................................................................................................... 366
PDF ...................................................................................................................................... 367
PNG ...................................................................................................................................... 374
Power Point
......................................................................................................................................
(pptx) 375
Tiff ...................................................................................................................................... 377
Word (doc)...................................................................................................................................... 378
Word (docx)
...................................................................................................................................... 381
Word (rtf)...................................................................................................................................... 385
XPS ...................................................................................................................................... 389
Splitting...................................................................................................................................... 392
Image ...................................................................................................................................... 399
Afas Online
...........................................................................................................................................
connector 400
Affinity connector
........................................................................................................................................... 404
Amazon AWS...........................................................................................................................................
connector 406
Box connector
........................................................................................................................................... 408
Database........................................................................................................................................... 410
Docuware ...........................................................................................................................................
connector 410
Dokmee connector
........................................................................................................................................... 412
DossierApp........................................................................................................................................... 413
Dropbox ...........................................................................................................................................
connector 414
Dynamics...........................................................................................................................................
NAV connector 416
ELO connector
........................................................................................................................................... 418
Email connector
........................................................................................................................................... 422
Evernote ...........................................................................................................................................
connector 424
FTP ........................................................................................................................................... 425
Google Drive
...........................................................................................................................................
connector 426
InfinityLaw
...........................................................................................................................................
connector 429
Infotraq connector
........................................................................................................................................... 432
LEAP connector
........................................................................................................................................... 433
M-Files connector
........................................................................................................................................... 434
MediaFire...........................................................................................................................................
connector 436
Nedap Ons ........................................................................................................................................... 438
Objective........................................................................................................................................... 439
OliBox ........................................................................................................................................... 442
OneDrive...........................................................................................................................................
connector 444
OneDrive...........................................................................................................................................
for Business connector 445
Orbeon ........................................................................................................................................... 446
OpenText...........................................................................................................................................
connector 447
PlacePoint ...........................................................................................................................................
connector 449
PowerOffice ........................................................................................................................................... 451
Practice Evolve........................................................................................................................................... 453
Print connector........................................................................................................................................... 454
Raet YouForce ...........................................................................................................................................
connector 455
Records Manager...........................................................................................................................................
connector 458
Regas ........................................................................................................................................... 460
Scanshare ...........................................................................................................................................
Repository 461
Script ........................................................................................................................................... 466
Sentral connector
........................................................................................................................................... 467
Citrix ShareFile
...........................................................................................................................................
connector 468
Sharepoint ...........................................................................................................................................
connector 470
Synergy Enterprise
...........................................................................................................................................
connector 472
WebDAV...........................................................................................................................................
connector 476
Windows...........................................................................................................................................
File System connector 477
Windream ...........................................................................................................................................
connector 479
Worksite...........................................................................................................................................
connector 481
Xero connector ........................................................................................................................................... 488
XPLAN connector........................................................................................................................................... 492
Wizard .................................................................................................................................................. 493
Verification
......................................................................................................................................................... 496
Repository......................................................................................................................................................... 507
Repository.........................................................................................................................................................
(e-Archive) 516
Clients ......................................................................................................................................................... 528
Konica Minolta
..................................................................................................................................................
client 529
Olivetti OpenAPI
..................................................................................................................................................
client 532
Kyocera client
.................................................................................................................................................. 535
Olivetti client
.................................................................................................................................................. 540
Lexmark ..................................................................................................................................................
client 545
Ricoh client.................................................................................................................................................. 548
Samsung..................................................................................................................................................
client 552
Sharp client.................................................................................................................................................. 555
Toshiba client
.................................................................................................................................................. 559
Xerox client.................................................................................................................................................. 562
PC client.................................................................................................................................................. 566
Oki client .................................................................................................................................................. 569
Plustek .................................................................................................................................................. 572
HP .................................................................................................................................................. 574
Mobile .................................................................................................................................................. 577
Users ......................................................................................................................................................... 580
User settings
.................................................................................................................................................. 584
OAuth User .................................................................................................................................................. 590
User Single ..................................................................................................................................................
Sign On 592
Windows........................................................................................................................................... 594
Active directory
........................................................................................................................................... 594
HowTo: scan
.........................................................................................................................................................
to HomeFolder 602
HowTo: choose
.........................................................................................................................................................
the output format with triggers 603
HowTo: using
.........................................................................................................................................................
email notification and exporting variables 604
HowTo: read
.........................................................................................................................................................
data by using the ZoneOCR 605
HowTo: using
.........................................................................................................................................................
FreeForm 606
HowTo: scan
.........................................................................................................................................................
to Google Drive 607
HowTo: scan
.........................................................................................................................................................
to Microsoft OneDrive 608
HowTo: scan
.........................................................................................................................................................
to SQL Server 609
HowTo: scan
.........................................................................................................................................................
to Box 610
2 Variables
................................................................................................................................... 611
3 Triggers
................................................................................................................................... 616
4 Regular
...................................................................................................................................
Expression 620
5 Scripts
................................................................................................................................... 624
6 Updates
................................................................................................................................... 626
7 Guides
................................................................................................................................... 628
Load Balancing
.........................................................................................................................................................
& Clustering Guide 628
Introduction.................................................................................................................................................. 629
Installation..................................................................................................................................................
topology 629
Requirements.................................................................................................................................................. 630
Hardware........................................................................................................................................... 630
Software........................................................................................................................................... 630
Deployment .................................................................................................................................................. 631
Glossary.................................................................................................................................................. 639
8 Application
...................................................................................................................................
Ports 639
9 Command
...................................................................................................................................
Line 640
I
10 Application Manual
1 Introduction
Thank you for choosing
Scanshare Enterprise V4
II
12 Application Manual
2 Installation
We will describe the installation procedure for Scanshare Enterprise V4 by following the steps:
From this version is available both the 32-bit version and the 64-bit version.
After this, you can immediately start working with Scanshare Enterprise V4. If you need more help
you can check out the Reference Guide
Hardware Recommendations
The hardware requirements for the Scanshare Enterprise V4 server will depend greatly on the
operating system selected, desired performance and workload placed onto it. Suggested
configurations are as follows:
The application requires .NET 3.5 framework to be installed. If not, the installer will automatically
show you a message stating it needs to be installed.
Many components in the Scanshare Enterprise V4 server are multithreaded, or designed to run as
a separate process. Therefore these components may benefit from multicore-enabled operating
systems and hardware; the client communication process and various CPU-intensive functions (such
as the optical character recognition module) are examples of such components.
2.2 Installer
Start the installation by double clicking the installer application, e.g.
Note: Mak e sure .NET 3.5 is installed, for the application to work properly.
The installer will be started, here you can choose the installation folder, and read and accept the
license terms and conditions. Although you can choose any folder you like, we advise to leave it at
its default setting if possible, which makes it easier in case you need support in the future.
After selecting next, a screen will appear, allowing you to choose the setup that suits you best.
In this manual, we will assume you select the Typical setup otherwise you can follow the Custom
setup.
Note: The needed ports are registered in your firewall automatically during the installation procedure.
Once the installation has completed, you can start the application by selecting
The first time you start the application, you will have to login to the server and validate your license.
2.2.1 Custom
When clicked "Modify" installation will begin and will be applicable only selezioanti components.
2.3 Activation
Activation is very easy. When you start Scanshare Enterprise V4 for the first time, the following
screen will appear, in which you have to enter your credentials.
Default Username: admin
Default Password: admin
After logging in the following screen will be shown. Here you can enter the Serial and press register.
If you do not have a serial (yet), it is possible to activate the 30-day trial period by pressing the 'use
Note: a license is always linked to one computer. If you want to move your license on
another computer you will have to remove your license first and then re-install!
You can find the option to remove or update your license in the license menu.
That's all! After you press the Finish button,Scanshare Enterprise V4 will start up automatically.
See First time startup for the next step.
So what if you don't have an internet connection on the computer you used for installation? Then you
will see the following screen instead:
In this case, leave this window open, find a computer which has internet access, and go to the
website
http://licensing.scanshare.com/offline
You will see this screen, where you have to enter your activation key and your serial.
After you select Activate, you can download your license file by clicking on the here link:
Now go back to the computer you installed Scanshare Enterprise V4 upon, copy the downloaded
license file there, load it by using the Register button and selecting the right file. Now you can
proceed to First time startup.
If all ok:
If you have a proxy server configured or you don't have a working internet connection on the
computer used for installation, the ABBYY license should be activated manually.
To do this, start the ABBYY SDK License Manager (LicenseManager.exe). You can find the License
Manager in the installation folder -> ABBYY.
Select the option activate license. This will open a wizard where you have to enter your ABBYY
license key.
To find your key, open the Scanshare Enterprise V4 settings menu and check your license in the
license information.
After entering and selecting next, the following screen will be displayed:
Make sure you copy all displayed text and send it to the email address as shown.
You will then receive a license file back, which you can then activate by selecting next and following
the steps.
The first time you start the application, user specific settings can be changed and workflows can be
designed. Starting from the Dashboard you can easily jump to the desired location.
2.5 Log in
When you start Scanshare Enterprise V4 for the first time, the following screen will appear, in which
you have to enter your credentials.
If the user "Administrator" result already logged in, possibility to take ownership of existing
administrator user session:
-Insert user and password and click Take Session
If the user "Administrator" result already logged in, possibility to take ownership of existing
administrator user session:
-Insert user and password and click Take Session
After logging will read the user license, and if you have access you will see:
If your license also includes verification and / or repository, see them in the left menu.
If you click on one of them, you will go already to read the user license, and check if there is a
license available for verification and / or repository.
If you can not add a license you will see an error like this:
Where you can see some information about the error and return to the homepage of the user.
III
Reference Guide 29
3 Reference Guide
When you have completed the installation of the software you will see a screen similar to the one
below when starting the application.
In the footer of the dashboard, you can open the Release notes and a list of installed updates.
The application checks every 7 days for new updates and installs them automatically as long as
your maintenance is still active.
In the Installed updates list, you can see all updates installed since activation of your license.
If a new update is installed, another tile will be shown on the dashboard, which will disappear
automatically after 5 minutes:
3.1 Settings
Pressing the arrow in the upper left-hand corner, different menu's will be selectable.
Settings
This menu will allow you to change multiple server settings (please refer to Settings menu for
detailed information)
Simulator
It allows to simulate the use of the MFP client, so you can test your workflows for demonstration
or doing some tests to test the workflow before being sure to put it into production. (please refer
to Simulator menu for detailed information)
Help
Pressing this button will open the in built Manual
License
License information will be displayed here (please refer to License menu for detailed information)
Info
Here all modules and connectors included in your license will be shown (please refer to Info menu
for detailed information). Here it is also possible to check if your application is up to date
This option can be used to send report to the support team to enhance resolution of problems.
- Here you can choose the MFP simulator to use (according the installed license)
Konica Minolta:
Toshiba:
Sharp:
HP:
- Device Address
You can view the list of available configured clients and select which client you want to simulate.
Note: also workflow permissions are simulated.
Note: Simulator is simulating also user permissions when login authentication is enabled for the
current simulated client.
Note: Simulator is automatically simulating user permissions according the UI control logged in
account (Simulator is available also for regular users).
General
Language
Select the desired language for your application
OAuth
o Public register link
When this option is enabled, an extra button will appear in the login screen of the server
application. Allowing users to add a new OAuth user without having to log in to the server
Network
Port
If you prefer, you can change the Network Service Port (default 1987). Selecting a new network
service port will automatically also change API ports and FTP port.
FTP
Capture
Wizard
If you prefer, you can change the viewer of the workflow designer. Select no for hide and yes for
show the wizard designer.
For many info to WIZARD, please refer a Wizard .
Failover
If you prefer, you can change the folder where document that couldn't be processed are stored.
HP
Address
This should contain the IP address of the computer Scanshare Enterprise V4 has been installed
upon. By pressing the refresh button next to this option, the current IP will be automatically
detected.
Port
By default, Scanshare Enterprise V4 uses port 8690 for communication between the application
and the devices.
FTP Port
By default, Scanshare Enterprise V4 uses port 8691 for communication between the application
and the devices.
Embedded SSO Database
Enable this function if you want to use SSO on the machine.
Check credentials
When enabled, the server checks if the saved password is still valid against AD. Validating
everytime SSO is used.
OpenAPI
OpenAPI
Address
This should contain the IP address of the computer Scanshare Enterprise V4 has been installed
upon. By pressing the refresh button next to this option, the current IP will be automatically
detected.
Communication port
By default, Scanshare Enterprise V4 uses port 51120 for communication between the application
and the devices.
Web Server communication port
By default, Scanshare Enterprise V4 uses port 51220 for communication between the application
and the devices.
Web Server port
By default, Scanshare Enterprise V4 uses port 51221 for transmission of data between the
application and the devices
Transmission method
Here you can specify the transmission method. This can be FTP or WebDAV. When WebDAV is
Note:
If you want, you can select different ports for transmission and communication, but make sure that
the ports you choose are not already in use by another application. Also, make sure that you
configure Firewall exceptions for these ports manually if you changed them, because during
installation of Scanshare Enterprise V4 only exceptions for the default ports are configured in your
firewall.
bEST Link
Status
When BeST Link is installed and recognized, the indicator will be 'on'.
Address, communication port and security token
Enter the right credentials to access your bEST link server
Olivetti
Olivetti
Address
This should contain the IP address of the computer <%SS_NAME%> has been installed upon.
Port
By default, <%SS_NAME%> uses port 8390 for communication between the application and the
devices.
Embedded SSO Database
Enable this function if you want to use SSO on the machine.
Check credentials
When enabled, the server checks if the saved password is still valid against AD. Validating
everytime SSO is used.
Client settings
Auto store
When enabled, the document will be directly stored without show a prompt on Olivetti client.
Show scan messages
When enabled, scan messages will be shown on the screen of your MFP. e.g. ´Scan has been
completed successfully´
To install the client software on your MFP, please proceed with the following steps:
Copy the file scanshare.pkg to a USB memory. This file is available from the Start menu ->
Scanshare -> Scanshare Enterprise -> Olivetti Client Tools.
Put the USB memory, containing this file, into the USB port of your device.
If 'Removable Memory was recognized. Displaying files.' appears, press [No].
Press the System Menu key and select [Application]. If the user authentication screen appears,
enter your login username and password and press [Login]
Note: you need to login with administrator privileges in order to install the software.
Then press [Add], select scanshare.pkg and press [Install]. A confirmation screen will appear,
please select [Yes].
The installation may take some time. When finished, select the application and activate it. Now the
client software is installed and the device can be connected to Scanshare server.
Make sure all settings are correct (Server IP address and default port: 8380 on the machine)
For more information, please refer to the manual of your device, section Default Setting (System
Menu)
Note: Mak e sure enhanced WSD is enabled on the machine and in the webbrowser of the machine.
Note:
If you want, you can select different ports, but make sure that the ports you choose are not already
in use by another application. Also, make sure that you configure Firewall exceptions for these ports
manually if you changed them, because during installation of <%SS_NAME%> only exceptions for
the default ports are configured in your firewall.
Olivetti OpenApi
OpenAPI
Address
This should contain the IP address of the computer Scanshare Enterprise V4 has been installed
upon. By pressing the refresh button next to this option, the current IP will be automatically
detected.
Communication port
By default, Scanshare Enterprise V4 uses port 51120 for communication between the application
and the devices.
Web Server communication port
By default, Scanshare Enterprise V4 uses port 51220 for communication between the application
and the devices.
Web Server port
By default, Scanshare Enterprise V4 uses port 51221 for transmission of data between the
application and the devices
Transmission method
Here you can specify the transmission method. This can be FTP or WebDAV. When WebDAV is
Note:
If you want, you can select different ports for transmission and communication, but make sure that
the ports you choose are not already in use by another application. Also, make sure that you
configure Firewall exceptions for these ports manually if you changed them, because during
installation of Scanshare Enterprise V4 only exceptions for the default ports are configured in your
firewall.
bEST Link
Status
When BeST Link is installed and recognized, the indicator will be 'on'.
Address, communication port and security token
Enter the right credentials to access your bEST link server
Ricoh
Specify the communication port for the Ricoh device here. Default port is 1984.
Note: this port is identical to the samsung service port
Samsung
Server port
By default port 1984 is used for communication between the application and devices.
FTP port
By default port 9921 is used for document transferring.
Embedded SSO Database
Enable this function if you want to use SSO on the machine.
Check credentials
When enabled, the server checks if the saved password is still valid against AD. Validating
everytime SSO is used.
Address
This should contain the IP address of the computer Scanshare Enterprise V4 has been installed
upon. By pressing the refresh button next to this option, the current IP will be automatically
detected.
Port
By default, Scanshare Enterprise V4 uses port 8090 for communication between the application
and the devices.
Custom Logo
Here you can select a custom logo which will be shown on the panel of the MFD.
Check credentials
When enabled, the server checks if the saved password is still valid against AD. Validating
everytime SSO is used.
Log to file
customizable service logging to file.
Client settings
Maintenance mode
Output managment
Port
Enter the port for configurable EWB Ouput Management webservice settings.
Admin username
Enter the username for configurable EWB Ouput Management webservice settings.
Admin password
Enter the password for configurable EWB Ouput Management webservice settings.
Uncompleted jobs
This is the case in which there are uncomplete jobs, whether for a transfer error or any error that
could happen on the network
Interval
The range however is the period of time in which you will delete it. The time is calculated from the
arrival of the document in the temp folder to the selected time interval.
Triggers
Triggers tab allow you to configure a trigger to be executed when a uncompleted jobs is available
in the temp folder.
For a detailed description of all trigger, please refer to the Trigger chapter
Browser simulator
Device address
Enter the IP address of your simulator or device here.
To install the client software, go to the webpanel of your multifunctional, then go to the section
Administration and select the Tab EWB.
Enter the IP Address of the server where Scanshare Enterprise V4 is installed to, use the default
port for the server :8089/.
Please note that a working IIS client is required.
After adding, the link to Scanshare Enterprise V4 will be available in the applications list on your
MFP.
OKI
OKI
Address
This should contain the IP address of the computer Scanshare Enterprise V4 has been installed
upon. By pressing the refresh button next to this option, the current IP will be automatically
detected.
Port
By default, Scanshare Enterprise V4 uses port 8490 for communication between the application
and the devices.
Custom Logo
Here you can select a custom logo which will be shown on the panel of the MFD.
Check credentials
When enabled, the server checks if the saved password is still valid against AD. Validating
everytime SSO is used.
Log to file
customizable service logging to file.
Client settings
Maintenance mode
Output managment
Port
Enter the port for configurable Ouput Management webservice settings.
Admin username
Enter the username for configurable Ouput Management webservice settings.
Admin password
Enter the password for configurable Ouput Management webservice settings.
Uncompleted jobs
This is the case in which there are uncomplete jobs, whether for a transfer error or any error that
could happen on the network
Interval
The range however is the period of time in which you will delete it. The time is calculated from the
arrival of the document in the temp folder to the selected time interval.
Triggers
Triggers tab allow you to configure a trigger to be executed when a uncompleted jobs is available
in the temp folder.
For a detailed description of all trigger, please refer to the Trigger chapter
Browser simulator
Device address
Enter the IP address of your simulator or device here.
Registration and deletion of the sXP web application are performed from a web page of the device.
After opening a web page of the device using a PC, logging in as an administrator, and selecting
[sXP Application], a list of sXP web
applications is displayed. Note, please see the user manual for detailed information regarding the
device web page. Click on the [+] button displayed on the left of the upper blank row to add a new
sXP web application.
This will open the [Application Setting] screen, so enter the application name and URL address, and
click on the [OK] button to complete entry. The URL address must be entered without omitting of the
scheme name. Note that only one of
the scheme names "http" or "https" is supported; however, it is possible to specify something other
than the said scheme names because a function that restricts input is not provided. In such a case,
an error will occur when the sXP web
application described below is started and the EWB will fail to start. When input on the [Application
setting] screen is completed, the list of sXP web applications has been updated so make
sure there is no mistakes in the display content and click on the [Submit] button. This registers this
sXP web application information to the device.
Enter the IP Address of the server where Scanshare Enterprise V4 is installed to, use the default
port for the server :8489/.
After adding, the link to Scanshare Enterprise V4 will be available in the applications list on your
MFP.
Sharp
Sharp
Address
This should contain the IP address of the computer <%SS_NAME%> has been installed upon.
Port
By default, <%SS_NAME%> uses port 8290 for communication between the application and the
devices.
FTP port
By default, <%SS_NAME%> uses port 8291 for document transferring.
Embedded SSO Database
Enable this function if you want to use SSO on the machine.
Check credentials
When enabled, the server checks if the saved password is still valid against AD. Validating
everytime SSO is used.
Client Settings
By selecting this option the question 'do you want to re-use this template?' will not be shown on
your device.
Auto close workflow
By selecting this option the question 'do you want to re-use this template?' will not be shown on
your device.
Job Build:
By selecting this option you can join multiple scanning page coming from ADF and from Platen in
a unique job.
Here you can enter the application name and enter the Server Address where Scanshare Enterprise
V4 is installed (e.g. http://IPSERVER:8290).
Note: The default port for Sharp communication is 8290.
After submitting, the application will be available on your device in the OSA section.
Note:
If you want, you can select different ports, but make sure that the ports you choose are not already
in use by another application. Also, make sure that you configure Firewall exceptions for these ports
manually if you changed them, because during installation of <%SS_NAME%> only exceptions for
the default ports are configured in your firewall.
Kyocera
Kyocera
Address
This should contain the IP address of the computer <%SS_NAME%> has been installed upon.
Port
By default, <%SS_NAME%> uses port 8390 for communication between the application and the
devices.
Embedded SSO Database
Enable this function if you want to use SSO on the machine.
Check credentials
When enabled, the server checks if the saved password is still valid against AD. Validating
everytime SSO is used.
Client settings
Auto store
When enabled, the document will be directly stored without show a prompt on Kyocera client.
Show scan messages
When enabled, scan messages will be shown on the screen of your MFP. e.g. ´Scan has been
completed successfully´
To install the client software on your MFP, please proceed with the following steps:
Copy the file scanshare.pkg to a USB memory. This file is available from the Start menu ->
Scanshare -> Scanshare Enterprise -> Kyocera Client Tools.
Put the USB memory, containing this file, into the USB port of your device.
The installation may take some time. When finished, select the application and activate it. Now the
client software is installed and the device can be connected to Scanshare server.
Make sure all settings are correct (Server IP address and default port: 8380 on the machine)
For more information, please refer to the manual of your device, section Default Setting (System
Menu)
Note: Mak e sure enhanced WSD is enabled on the machine and in the webbrowser of the machine.
Note:
If you want, you can select different ports, but make sure that the ports you choose are not already
in use by another application. Also, make sure that you configure Firewall exceptions for these ports
manually if you changed them, because during installation of <%SS_NAME%> only exceptions for
the default ports are configured in your firewall.
Xerox
Address
This should contain the IP address of the computer <%SS_NAME%> has been installed upon.
Retrieving the address can be done by pressing the refresh button next to the Address.
Server port
By default, <%SS_NAME%> uses port 8120 for communication between the application and the
devices.
Proxy
Specify if you want to use Proxy for licensing and updates. When system proxy is used, the
application will automatically take the system settings.
Address
The IP address of the proxy server
Port
The port number which is used by the proxy
Note: ask your administrator for help in order to provide correct proxy settings to Scanshare
Enterprise V4
Mail
Select protocol:
Protocol
Select to use either a SMTP, MS exchange or Office365 protocol. The setting available for the
chosen protocol will appear automatically.
Address
This is the IP address or the server on which e.g. MS Exchange is running
Port (Only for SMTP)
This specifies the port used by the mail server for SMTP connections. By default this is port 25
SSL (Only for SMTP)
Enable this checkbox if a SSL connection is used. When enabled, you can select whether an
Explicit or Implicit SLL is used. Default is Explicit.
Domain (only for Exchange)
Enter the domain of the Exchange server.
Username and Password
If authentication is required for access to the email server then you will have to specify the user
name and password
Test address
To make it easy for you to check if your Mail Settings have been entered correctly, you can enter
an email address in here and select Send test email. If all settings are correct, you should receive
an email, otherwise an error message will appear, showing what went wrong.
Logging
Log level
You can select the level of detail you would like to see in the log screen:
Nothing
Information
Detailed
Only Errors and Warning
Only Errors
Debug
Keep log for
Specify a number of days you want to save the contents of the log file. Older data will be removed,
which prevents the log files from occupying too much disk space.
Show process idle log lines
Selecting this option will also show log lines indicating what Scanshare Enterprise V4 is doing,
even though no document is actually being processed.
Verification
Verification location
If you prefer, you can change the folder where document that be processed in verification.
Repository location
If you prefer, you can change the folder where document that be processed in Repository.
Master password
You can choose to encrypt all the files in the repository by entering a master password. You
remember password if you will want decrypt.
Indexing
Service port
By default, Scanshare Enterprise V4 uses port 30440 for Indexing service port communication .
Status
It is Idle or Error depends from status of the OCR:
- Button refresh: refresh of the status
- Button Optimize: optimization of the Engine Indexing
- Button Rebuild: try to rebuild, if your status is in error
Document Types
+ button
create a new document Type
If you open the settings of this document type you can add properties or set the auto-filing
strategy by adding properties or writing a fixed path.
Name
Insert or change document type name
manually fixed parts or by clicking on the property and it will automatically be added to the location
text field (the property will be expanded automatically with its value during the document upload).
In order from left to right: Name of the property, default value and pick list you can select from all
picklists that you have created in the any existing workflow capture module.
Export/Import
Export/Import Workflows
This option allows you to import or export separate workflows.
Database
The database settings allow you to specify wether you want to use the default database (created
locally) or an SQL database.
The use of an SQL database is required when load balancing with managing clusters is used.
Address
Insert the address of your SQL database here
Catalog
Default the catalog is set. If needed you can specify a new catalog. please note that the Catalog
can not be an existing one.
Username and password
Enter the right credentials here to access your database.
Cluster Node
If you want to use load balancing with managing cluster, the Cluster node must be turned on.
Migrate
By pressing the migrate button, all settings will be migrated to the selected database
For more information about Load balancing, please refer to the Load Balancing section
Updates
The updates section lets you enable or disable the Automatic updates. When enabled the
application will check for updates regularly.
When disabled, You can check manually for updates by pressing on the info button. (For more
information about updates please refer to: Updates section)
Serial
Your server serial will be shown here
License will expire
If you have a trial license, the expiration date will be shown here
Service Contract will expire
If you have a service contract, the expiration date will be shown here
Activation key
When activating a license, an activation key is automatically created and specific for your server. If
the activation key changes, or you want to move the Scanshare Enterprise V4 server to a different
location, your license will have to be removed and activated again.
License includes
All components of your license will be shown. A full overview of all modules, connectors and
credits can be found in the info menu.
different location. If you have an ABBYY key, the application will automatically de-activate this
license too. If for some reason, de-activation of the ABBYY license fails, a wizard will show up,
allowing you to de-activate it manually. (please refer to Removing license for detailed information)
Update license file
Pressing this button will update the license. This will be done when you've ordered an extra, or
something in your license has been changed.
A question will be prompt if you have a new license. If you received a new license (not your server
license) press yes, if not, press no.
In the license menu panel pressing the Remove License button you
can remove the license from your system, so you can use the license on a different location. If you
have an ABBYY key, the application will automatically de-activate this license too. If for some
reason, de-activation of the ABBYY license fails, a wizard will show up, allowing you to de-activate it
manually.
You can remove a license in a server with internet connection and in an offline server too.
Removing online
After pressing the Remove License button a question will be prompt if you wish to remove the
license. Click on the YES button.
The license is correctly removed from the server and can be used on a different location.
Removing offline
After pressing the Remove License button a question will be prompt if you wish to remove the
license. Click on the YES button.
The application will not be unable to notify the license server of the removal of the license due to no-
internet connection. A question will be prompt if you wish to remove the license. If you want to
activate the same license in a different Scanshare Enterprise V4 server click on OFFLINE button.
The license is now correctly removed locally. In order to notify the licensing server of the license
removal leave this window open, find a computer which has internet access, and go to the
website
http://licensing.scanshare.com/offline
You will see this screen, where you have to enter your Security Key.
After you select Deactivate a screen will notify the correctly deactivation.
Now your license can be activated can be activate again in a different Scanshare Enterprise V4
server.
3.2 Menu
The menu contains 8 sections:
In addition to a normal search as described above if the license contains e-Archive search can go
to various search filters:
By default if you insert the search filters they must be all respected (logical AND), if you want a
logical OR then a condition that is not always respected just click on the filter that you want to
enter into the OR search:
Dashboard
The dashboard shows you a clear overview of all parts of the Scanshare Enterprise V4 server (for a
detailed description go to the Dashboard menu)
Load balancing
Here you can create clusters to devide the processing over one or more servers (for a detailed
description go to the Load balancing menu).
Free Form
Here you can create Free Form templates (for a detailed description go to the Free Form menu).
Workflows
Here you can create, delete or modify your workflows (for a detailed description go to the
Workflows menu)
Verification
Here you can create, delete or modify your verification process (for a detailed description go to the
Verification menu)
Repository
Here you can create, delete or modify your repository (for a detailed description go to the
Repository menu)
Clients
An overview of all configured clients is shown here. in this menu you can also add, delete or
Users
All User groups will be shown here, allowing you to create, delete or modify user groups and users
(for a detailed description go to the Users menu)
3.2.1 Dashboard
Server Status
Events
Pressing this button will open the Logs from the server
Services
Here you can see if the Scanshare Enterprise V4 services are running, and restart your services
Performance
Here you can see the performance of the server at a glance. Please note that this overview is not
dynamic
This block shows how many ABBYY pages are left in the current month.
Server deployment
When opening this menu, an overview of connected machines is displayed.
Workflows
when opening this menu, a clear overview of all active workflows is given. Only workflows that have
been used before appear in this screen. Hovering over the circles will show the amount of scans
made per client.
Clients
When opening this menu, a clear overview of all active clients is given. Only clients that have been
used appear in this screen. Hovering over de circles will show the amount of scans made per client.
Users
The Users button opens a clear overview of all active users. Only users that have been used, will
appear in this screen. Hovering over the circles will show the amount of scans made per client.
Base requirement:
Windows OS Server version:
Windows server 2008
Windows server 2008 SP2
Windows server 2008 R2
Windows server 2008 R2 SP1
Windows server 2012
Windows server 2012 R2 (32 and 64 bit)
Windows server 2016 (32 and 64 bit)
Firewall needs to allow shares and communication on ports 60440 and 60441 (or others if
installation is customized on the server)
For the cluster, Static IP configuration is recommended instead of DHCP
Domain required (all clusters need to be part of the same domain)
Running requirements:
.NET 3.5 SP1
.NET 4.5
Installation requirements
Network discovery enabled. This on Windows 2012 requires to set to automatic and start these
services (normally first 3 disabled and stopped) otherwise won’t be enabled:
o SSDP Discovery
o UPnP Device Host
o Function Discovery Resource Publication
o DNS client
Restricted security domain environments (will produce errors on cluster installation, most common
are error 2250 or Access denied):
Change account to the “UltiDev Web Server Pro” service on the Server before installing the
cluster on the target cluster machine. From “Local system” to a Domain admin user account.
There are 2 types of clusters available. The first one is the processing cluster. This option will allows
you to deploy all processing to 1 or more servers.
Adding a processing cluster can by done by the following steps:
Name
Enter a name for the cluster in the server deployment map.
Description (optional)
Enter a description of the server here.
IP address
The IP address of the cluster server needs to be entered here.
Password
Enter the password of a user with admin right.
Ask elevation
Enabled by default to run the command on the remote machine as elevated privileges.
Use System account
When enabled, run the command on the remote machine as a service under the system account
credentials.
When saving fails, a message will show up stating that you need to change your settings or install
the cluster manually.
The path were to find the cluster installer is also shown in this message.
When the cluster is saved, a processing service will be installed on the cluster machine. You will not
see a server application on this machine, it is only a process that runs in the background.
If you check the list of installed programs on the cluster, you should be able to see the application.
If the cluster cannot connect correctly, you will see this symbol on the cluster in the load
balancing map.
The second option is the managing cluster. this option allows you to create a cluster for processing
and backup. A managing cluster is a server where Scanshare Enterprise V4 is also running. To
configure Managing clusters, open the settings menu of the root machine. The following screen will
appear:
By pressing the + sign, you can add clusters by IP address. All servers in the cluster also work as
backup for each other. Managing clusters and Process cluster can be used in any formation and can
be combined.
Default there is a limit of 3 clusters per license, which is extendable. For more information about
extending or purchasing the load balancing module, please contact your reseller.
Note: When load balancing is enabled, all processing is done on a cluster. So if you have a windows
file system connector configured, mak e sure the network share is specified, otherwise document will
be stored on the cluster machine.
Note: if you have an ABBYY license, each cluster needs a separate ABBYY license for processing.
The installation and activation of ABBYY on the cluster will be done automatically, if the cluster has
a work ing internet connection. If not, the k ey has to be activated manually on the cluster machine.
However, wouldn't it be great if Scanshare Enterprise V4 would recognize the scanned document
automatically and, depending on the content, select the right template automatically. This way, you
could put Purchase Orders, Invoices and Delivery Reports all on one pile of paper, put the pile on the
scanner and have each form being processed by they corresponding workflow. This is what the Free
Form module does!
See how FreeForm works in Scanshare YouTube channel here. You can also download a complete
FreeForm sample with guide, video and workflow from here
Note: In order to use the Free Form recognition, a free from trigger should be added to your
work flows.
For more information about the trigger, refer to the trigger section.
By pressing the + New button, a new screen will show up, allowing you to add a new Freeform
profile.
Status
With this option you can turn the Free form profile on or off
Type
Select the type you want to use. You can choose from FreeFormNuance (in the screen above),
Automatic Document Recognition and Abbyy Classification.
o FreeForm OmniPage
OmniPage is a clever engine designed for automatic document classification and categorization
tasks. It allows to identify invoices, checks, forms, orders, delivery notes, page separators or any
kind of structured document by just performing image comparison of the structured
document. Best use for structured documents with visual different structure which can be
compared.
o Abbyy Classification
ABBYY FineReader Engine 11 automatic document classification enables applications to
categorize and sort batches of documents by predefined document classes. The classification
results are: the detected category of the document and the probability that a document belongs to
a category. The classification is content based and performed via OCR and linguistic and
statistical technologies guaranteeing high accuracy and universality.
Note: You can not change the type of a freeform profile, it must be deleted and recreated with the
new engine.
Name
Description (optional)
Here you can enter a description of the Free form profile
Confidence
Specify the confidence level of the profile. Default is at 90, so 90% of the scan should match the
sample file.
Viewer
Here you can load the reference document. Please note that this document should remain in it's
original folder at all times.
3.2.3.1 FreeFormOmniPage
Free form OmniPage Settings
General
be recognized. Most multi page documents normally have the most useful information only on the
first page (like logo's, customer name, header).
Trade-off
Recognizing the document affects speed and accuracy. By default it is balanced.
Engines
Document
Auto cleanup
Document cleanup before the recognition to remove all things which may lower the confidence
level.
Rasterize resolution
Is used to rasterize PDFs. By default it is at 200dpi. For better recognition, a different resolution
can be selected.
General
Language
It is possible to select multiple languages per workflow by pressing Ctrl and selecting the
desired languages
Note: the languages of ABBYY in the freeform, they can not be changed after the first profile.
Otherwise it must be deleted DB, because ABBYY must use a unique set of languages for all
profiles.
Mode
- Fast Mode:The fast classifier. This mode is recommended for documents which do not contain
much text, and the difference between classes is visible in the appearance of the documents.
- Quality Mode: The accurate classifier. This mode is recommended for documents which contain
a lot of text, and the difference between classes can be determined only by considering the
contents. The visual structure of the document is not taken into account.
Document
Deskew
Enable this option if your scanner creates more or less skewed images. Deskew can only be
processed when the skew angle is less than 45 degrees.
3.2.4 Workflows
The workflow menu shows you a list of all configured workflows.
It is also possible to search though the workflows by using the search function on the upper right
side.
Group
Here you can define the workflow group where the workflow belongs to. Changing or adding a
group can be done in the workflow settings. The workflows grouping can be used on Toshiba
MFP's only. To use the grouping, the 'Use Workflow Groups' setting needs to be enabled in the
settings menu.
# (number)
The number of the workflow defines the sequence of appearance on your client. By drag and drop
you can easily move the workflow up or down.
Status
The status of a new workflow is automatically set to true. In the workflow menu you can easily set
this to false by clicking on the green indicator. The workflow will then be grayed out, the indicator
will be red and set to off.
Name
The name of the workflow can be changed by clicking on the workflow name
Description
A short description of the workflow can be entered here.
Settings
General
Status
Switch the status of the workflow on or off
Group
Select an existing group here or create one by selecting the [ + ] sign.
Group name
When the [ + ] sign is selected at groups, you can enter a group name for your new group here.
The grouping can only be used on Toshiba MFP's.
Image
Choose or import the image of the workflow to be displayed on the client. You can either choose
from the default list, or import an image by using the import button.
Name / Description
Here you can change the name of the workflow and enter a description if desired. The description
is optional.
Interval
Specify the processing interval. In this example, the interval is set on 30 seconds. Meaning the
application will check every 30 seconds for documents to be processed in this workflow. The
Fixed time
If a fixed time is specified, the application will only check on the specified time for files to be
processed.
Processing
Skip processing
If this option is checked, all processing will be skipped. The scanned document will be stored in
its original format.
Rasterize resolution
Is used to rasterize PDFs. By default it is at 200dpi. For better recognition, a different resolution
can be selected.
Triggers
Triggers tab allow you to configure a trigger to be executed when a workflow starts or when a
workflow has finished.
For a detailed description of all trigger, please refer to the Trigger chapter
Failover
Count
Specify the amount of attempts for the application to try to process the document
Triggers
By pressing a button, a trigger can be added to the workflow. For a detailed description of
triggers, you will find a chapter in the appendix.
Failover is configured in the Work flow general settings and it means the movement of the document
off the processing queue to the NotProcessed folder after x amount of failed processing attempt.
By default the fails count is 2 (see Work flow general settings / failover / above triggers list).
This means the document, by default, goes to failover after 2 failed processing. At this stage all
configured failover triggers will be executed.
Failover doesn't mean that at the first error the trigger gets fired, so unless if you haven't changed
the count to 1 you won't get any mail (trigger) fired at the first error, you need to wait the 2nd attempt
and failing again, here you will see in the logs failover starts by removing the document from the
process queue to avoid further re-process.
By pressing the button on the top of the screen, a new workflow will be
created.
If you have enabled the Wizard in the settings Capture (Settings Menu). The workflow designer will
automatically open, allowing you to create your workflow in three easy steps.
If you want to draw the workflows without the wizard, you can choose to hide it for now (HIDE) or
forever (DON'T SHOW ANYMORE). Do not worry you can always go back to using the wizard,
enabling and disabling its setting in the menu settings.
If you disable or hide the Wizard. The workflow designer will automatically open without Wizard:
Workflow items will be connected by a line. To every connection, a trigger can be added.
On the right top of the workflow screen you see an option to Auto link modules. Default this function
is on, meaning that modules will automatically be connected to the last dropped module. When this
function is disabled, the connection between modules has to be created manually. This setting is
saved per workflow.
When you add modules, it is possible to change the naming of each module by double clicking on
the desired module.
3.2.4.1 Capture
Capture settings determine where the input for a workflow comes from.
Scanshare Enterprise V4 is capable of using input from four different sources:
Email
input from email lets you configure an email address where Scanshare Enterprise V4 will check for
incoming documents. Only attachements will be processed.
FTP
Incoming document can be retrieved from a remote location, by using FTP server connections
Watch Folder
This is a folder on a computer in the network where input documents will be put by other users or
applications. e.g. you have an older device which does not support embedded MFP software, but
is able to write scanned documents to a folder on the network. This folder could be entered as a
watch folder for a workflow in Scanshare Enterprise V4. everytime a new document is put in this
folder, it will be processed by that workflow. It is possible to use multiple watch folders in one
workflow.
For more information on PC Client Professional: Web Help Manual PC Client Professional
Printer Client
The Printer client is used to add/edit Variables for workflows.
The Printer client will be recognized by the system as a printer. The source can be a file sent to
the printer installed on the PC where the Printer client will be installed to.
Mobile Client
3.2.4.1.1 Email
E-mail capture allows to monitor mailboxes for incoming mails (POP, IMAP, EXCHANGE,
OFFICE365 ). Since the latest release it is supported to capture signed / certified email as well and
also Tls 1.2.
Protocol
Choose the protocol to use. If Exchange or Office365 are selected, some extra settings can be
specified.
Address
Set the address of the mail server here
Port / Domain
Set the port the mail server uses/Set the domain of the exchange server
Username and Password
Specify the username and password of the email address that needs to be checked.
SSL
Enable this function if an SSL connection is used for the mail server. When enabled, you can
select to use an Explicit or Implicit SSL connection. Default Explicit SSL is selected.
Keep mails
If you want other applications to be able to receive the emails too, enable this function. This way, if
your regular email program checks for new mails later, it will still retrieve the email and save it in
your inbox.l If it is unchecked, all processed emails will be deleted.
Test
Use this button to check if all settings have been set correctly. If so, a confirmation message will
show up. If not, a message will appear stating which settings are incorrect
Exchange
Only unread
Select this option if you only want unread emails to be processed. If not selected, all mails will be
processed, including the ones previously processed and not deleted.
Hard delete
When this option is selected, the processed emails will be deleted completely (also removed from
recycle bin).
N.B. When using Exchange signed / certified emails without attachments can not be
captured because signed / certified mails appear as attachments to the original mail.
Filters
Without attachments
Select this option if you capturing new email without attachments.
Extensions
You can specify the file extensions to attachment that you capture will process.
3.2.4.1.2 FTP
The FTP menu has 2 submenu's:
General
Address
Enter the address of the FTP server, e.g. ftp.myserver.com
Port
By default, most FTP servers use port 21
Folder
If you leave this field empty, you will connect to the root folder on the FTP server. If you know the
name of a specific subfolder on the FTP server, you can specify a folder name here
Passive
If your FTP server uses a passive connection, enable this option.
Check subfolders
If you want to scan all subfolders on the FTP server to, then tick this checkbox.
Because the original FTP folder name is available as variable, you can still distinguish the several
types of incoming files later on in the process.
Test
This button tries to connect to the FTP server with the settings as entered before. If all settings are
correct, a message will show up stating everything is OK. If a connection could not be
established, a message will show up stating why
Authentication
Folder
Enter the path of the filder that has to be checked by the workflow, or press the Browse button on
the right side to browse to it.
Check subfolders
This will force the workflow to check the subfolders of the watch folder for incoming documents
too.
Because the original filename with path is available as variable, you can still distinguish the
several types of incoming files later on in the process
Skip Processing
Selecting the option Sk ip processing, allows you to store your document in its original format
directly to the selected destination. The server will completely skip all processing.
Exclude extensions
Here you can specify which file extensions should be excluded from processing. Mentioned types
will not be read by the module. The extensions must be indicated by a dot followed by the
Permissions
Server Type: the type of web server, for now only Web Services available
URL: the URL of webservice
Namespace: the namespace of the webservice (visible from the WSDL, see namespace.jpg)
Document Decode: the type of data encoding, for now only Base64
Skip processing: you know what that means ...
Calls
Calls: here we add the calls to be made to the webservice, they will be executed in cascades
and the last one will be the one assumed to finally get the document and the variable. This
for all cases where multiple cross calls needs to be made. Every call can pass the query
result parameter to the next one of course till last one
I hope description is enough as it may look like a bit complicated at the first shot but it is very
easy and dynamic. Now find below the Audatex settings you need for the specific first
customer of it.
Authentication
3.2.4.1.5 PC client
Questions
The question section enables you to define questions which the user can answer when scanning a
document using the PC client. The answers to these questions are stored in variables. These
variables can be used later on in the workflow.
Questions order can be changed by drag & drop in the question list. The number in front of the
question will define the sequence of appearance.
If you want to add a question, select the + on top of the screen. This will open a new window,
looking like this:
Required
This determines if the user always has to provide an answer to this question or whether it is
optional. When the indicator is on yes (green), a question will be marked as required. If the
indicator is on no (red), the question is optional.
Question
This is how the question will be described on the panel of the PC Client
Button name
This is the name that will be used on the screen of the PC Client to select this question
Description
Here you can provide a short description of the question to clarify to users what it is meant for
Variable
Variables are used to store the answers to questions. Variables can be used elsewhere in the
application, e.g. to replace the default filename as provided by the user of the PC Client.
Variables are always written in the format %VARIABLENAME%. The application provides a
variables parsing engine as well in order to use only part of the answer.
Type
Scanshare Enterprise V4 supports four question types:
Typed
The user can enter any text they like
Selected
The user can select from a list of pre-defined entries
Typed or Selected
The user can enter any text they like or select from a list of pre-defined entries
Search while typing
The user can enter any text they like while the application dynamically searches the selected
list
Password
The user can enter a password in the PC Client. Entered characters will be shown as an
asterix.
Label
a label question can be used as an extra check for a previous question or as a default value.
3.2.4.1.5.1 Typed
Default
Optionally, you can define a default value as an answer to this question, e.g. scan %YY%-%MM
%-%DD%
Regular expression
Regular Expressions are a powerful means to limit the input the user can provide to pre-defined
patterns. If for example a user is only allowed to answer any three letter combinations of "A", "a",
"B" and "b" , you could use a regular expression
\b([A-B]|[a-b]){3}\b
For more information on regular expressions, there are many websites, e.g. http://www.
regular-expressions.info/
Note: regular expressions will only work when the question type is REQUIRED!
Example
You can provide an example of the kind of information the user should enter, this text will show up
if invalid input is entered.
3.2.4.1.5.2 Selected
By selecting the selected menu, this screen will appear:
Default
Optionally, you can define a default value as an answer to this question, e.g. scan %YY%-%MM
%-%DD%
To add a new list, use the + button on the top of the screen.
New lists can be created in different types, being Static, SQL, Script, XML, Dropbox, Email browse,
Google Drive, Sharepoint and Folderbrowse:
Name
Type the name of the item list here. We advice you to use a clear name, so you can always
recognize the list you are supposed to use.
Type
The type can be Static, SQL, Script, XML, Database, Dropbox, Email browse, FTP, Google Drive,
Sharepoint and Folderbrowse. This list can contain more items, depending on your license.
Selecting the type enables the menu accordingly.
For a detailed description of all the picklist types, refer to the picklist menu
When selecting this question type, the selected menu will be available where you can insert a new
list.
For a detailed description of the available list types, refer to the Selected section.
When selecting this question type, the selected menu will be available where you can insert a new
list.
For a detailed description of the available list types, refer to the Selected section.
3.2.4.1.5.5 Label
This question type can be used as e.g. as a control question. Label types are always filled
automatically and cannot be changed.
When selecting this question type, the selected menu will be available where you can insert a new
list.
If no question is configured in front, the first item in the list will always be displayed.
By default this question type is optional, if you want it to be required, turn the setting on 'YES'.
For a detailed description of the available list types, refer to the Selected section.
3.2.4.1.5.6 Password
When you define a question as password, the user can either select an password in their answer
Scan
By checking the Manual questions box the questions have to be manually opened after selecting
the workflow. If unchecked, the questions will automatically open when a workflow is selected.
When the clear question checkbox is enabled, all questions will be cleared after scanning, please
note that this setting only applies to newer versions of KM machines. Older models automatically
keep the questions, new models by default clear them. By changing this setting, you can change
this.
The scan properties provide a way to determine the quality of incoming scans.
Here you can select what color settings and resolution you want to use. After selecting an item, the
checkbox Lock beneath the item may be checked, which ensures that the user of the client cannot
change the setting on the MFP client to a different one than has been set in this screen. If you don't
lock the default, there is also a possibility to specify which options the user may choose from.
By checking the checkboxes, the options behind them will be selectable on the MFP. In this screen,
resolution types 200, 300 and 400 can be chosen on the MFP.
3.2.4.1.6.1 Questions
Questions
The question section enables you to define questions which the user can answer when scanning a
document using the Konica Minolta client. The answers to these questions are stored in variables.
These variables can be used later on in the workflow.
Questions order can be changed by drag & drop in the question list. The number in front of the
question will define the sequence of appearance.
If you want to add a question, select the + on top of the screen. This will open a new window,
looking like this:
Required
This determines if the user always has to provide an answer to this question or whether it is
optional. When the indicator is green, a question will be marked as required. If the indicator is red,
the question is optional.
Question
This is how the question will be described on the panel of the Konica Minolta MFP
Button name
This is the name that will be used on the screen of the multifunctional to select this question
Description
Here you can provide a short description of the question to clarify to users what it is meant for
Variable
Variables are used to store the answers to questions. Variables can be used elsewhere in the
application, e.g. to replace the default filename as provided by the user of the Konica Minolta MFP
Variables are always written in the format %VARIABLENAME%. The application provides a
variables parsing engine as well in order to use only part of the answer.
Type
Scanshare Enterprise V4 supports eight question types:
Typed
The user can enter any text they like
Selected
The user can select from a list of pre-defined entries
Typed or Selected
The user can enter any text they like or select from a list of pre-defined entries
Typed or Selected (filtered)
The user can enter any text they like or select from a list of pre-defined entries, entering a part
of the description, will show the user a list of all options containing the part given.
Password
The user can enter a password from the screen of the Konica Minolta MFP. Entered characters
will be shown as an asterix.
DateTime
The user can only enter a date (plus time) value
Toggle
Select out of 2 predefined values
Numeric
Only numeric values are allowed
Label
a label question can be used as an extra check for a previous question or as a default value.
Selecting a question type, enables the corresponding menu on the left side of the screen.
Default
Optionally, you can define a default value as an answer to this question, e.g. scan %YY%-%MM
%-%DD%
Regular expression
Regular Expressions are a powerful means to limit the input the user can provide to pre-defined
patterns. If for example a user is only allowed to answer any three letter combinations of "A", "a",
"B" and "b" , you could use a regular expression
\b([A-B]|[a-b]){3}\b
For more information on regular expressions, there are many websites, e.g. http://www.
regular-expressions.info/
Note: regular expressions will only work when the question type is Required!
Example
You can provide an example of the kind of information the user should enter, this text will show up
if invalid input is entered.
Default
Optionally, you can define a default value as an answer to this question, e.g. scan %YY%-%MM
%-%DD%
To add a new list, use the + button on the top of the screen.
New lists can be created in different types, being Static, SQL, Script, XML, Dropbox, Email browse,
Google Drive, Sharepoint and Folderbrowse:
Name
Type the name of the item list here. We advice you to use a clear name, so you can always
recognize the list you are supposed to use.
Type
The type can be Static, SQL, Script, XML, Database, Dropbox, Email browse, FTP, Google Drive,
Sharepoint and Folderbrowse. This list can contain more items, depending on your license.
Selecting the type enables the menu accordingly.
For a detailed description of all the picklist types, refer to the picklist menu
When you define a question as typed or selected, the user can either select an answer or type in
their answer
When selecting this question type, the selected menu will be available where you can insert a new
list.
For a detailed description of the available list types, refer to the Selected section.
When you define a question as typed or selected (filtered), the user can either select an answer or
type in their complete or part of the answer, after which the possible options will be filtered and
displayed and can be selected.
When selecting this question type, the selected menu will be available where you can insert a new
list.
For a detailed description of the available list types, refer to the Selected section.
Select format
You can choose between the following formats:
- DD-MM-YYYY
- YYYY-MM-DD
- DD-MM-YYYY HH:NN
- YYYY-MM-DD HH:NN
- HH:NN
DD = Day number
MM = Month number
YYYY = Year number
HH = Hour (24 hours format)
NN = Minutes
Default
This allows you to set a default date, Yesterday, Today, Tomorrow or a Selected date. In
some case this is useful to keep the user from having to enter information which is usually the
same. Of course, even when default settings have been specified, another date can be selected as
well.
Date between
If you check this option you can specify a time span which should contain the date the user
enters at the Multifunctional.
When you define a question as password, the user can either select an password in their answer
Default
When the default box is checked, the True value is already selected by default on the MFP, which
can then be changed manually.
Default
If you specify something here this will be shown by default on the Multifunctional. Even when
default settings have been specified, another number can be selected as well.
Regular Expression
Regular Expressions are a powerful means to limit the input the user can provide to pre-defined
patterns. If for example a user is only allowed to enter an invoice number which always starts with
"2011" followed by a four digit number, e.g. 20111321, 20111322 and so on, you could use a
regular expression
\b2011[0-9]{4}\b
For more information on regular expressions, there are many websites, e.g. http://www.
regular-expressions.info/
Note: regular expressions will only work when the question type is Required!
This question type can be used as e.g. as a control question. Label types are always filled
automatically and cannot be changed.
When selecting this question type, the selected menu will be available where you can insert a new
list.
If no question is configured in front, the first item in the list will always be displayed.
By default this question type is optional, if you want it to be required, turn the setting on 'YES'
For a detailed description of the available list types, refer to the Selected section.
3.2.4.1.6.2 Triggers
The trigger menu allows you to add triggers during scanning. Options for triggers are at start, end, on
error or on timeout.
note: Processing variables are not available on triggers at scanning.
For a detailed description of all trigger, please refer to the Trigger chapter
Scan
By checking the Manual questions box the questions have to be manually opened after selecting
the workflow. If unchecked, the questions will automatically open when a workflow is selected.
When the clear question checkbox is enabled, all questions will be cleared after scanning, please
note that this setting only applies to newer versions of Olivetti OpenAPI machines. Older models
automatically keep the questions, new models by default clear them. By changing this setting, you
can change this.
The scan properties provide a way to determine the quality of incoming scans.
Here you can select what color settings and resolution you want to use. After selecting an item, the
checkbox Lock beneath the item may be checked, which ensures that the user of the client cannot
change the setting on the MFP client to a different one than has been set in this screen. If you don't
lock the default, there is also a possibility to specify which options the user may choose from.
By checking the checkboxes, the options behind them will be selectable on the MFP. In this screen,
resolution types 200, 300 and 400 can be chosen on the MFP.
3.2.4.1.7.1 Questions
Questions
The question section enables you to define questions which the user can answer when scanning a
document using the Konica Minolta client. The answers to these questions are stored in variables.
These variables can be used later on in the workflow.
Questions order can be changed by drag & drop in the question list. The number in front of the
question will define the sequence of appearance.
If you want to add a question, select the + on top of the screen. This will open a new window,
looking like this:
Required
This determines if the user always has to provide an answer to this question or whether it is
optional. When the indicator is green, a question will be marked as required. If the indicator is red,
the question is optional.
Question
This is how the question will be described on the panel of the Olivetti OpenAPI MFP
Button name
This is the name that will be used on the screen of the multifunctional to select this question
Description
Here you can provide a short description of the question to clarify to users what it is meant for
Variable
Variables are used to store the answers to questions. Variables can be used elsewhere in the
application, e.g. to replace the default filename as provided by the user of the Olivetti OpenAPI
MFP
Variables are always written in the format %VARIABLENAME%. The application provides a
variables parsing engine as well in order to use only part of the answer.
Type
Scanshare Enterprise V4 supports eight question types:
Typed
The user can enter any text they like
Selected
The user can select from a list of pre-defined entries
Typed or Selected
The user can enter any text they like or select from a list of pre-defined entries
Typed or Selected (filtered)
The user can enter any text they like or select from a list of pre-defined entries, entering a part
of the description, will show the user a list of all options containing the part given.
Password
The user can enter a password from the screen of the Olivetti OpenAPI MFP. Entered
characters will be shown as an asterix.
DateTime
The user can only enter a date (plus time) value
Toggle
Select out of 2 predefined values
Numeric
Only numeric values are allowed
Label
a label question can be used as an extra check for a previous question or as a default value.
Selecting a question type, enables the corresponding menu on the left side of the screen.
Default
Optionally, you can define a default value as an answer to this question, e.g. scan %YY%-%MM
%-%DD%
Regular expression
Regular Expressions are a powerful means to limit the input the user can provide to pre-defined
patterns. If for example a user is only allowed to answer any three letter combinations of "A", "a",
"B" and "b" , you could use a regular expression
\b([A-B]|[a-b]){3}\b
For more information on regular expressions, there are many websites, e.g. http://www.
regular-expressions.info/
Note: regular expressions will only work when the question type is Required!
Example
You can provide an example of the kind of information the user should enter, this text will show up
if invalid input is entered.
Default
Optionally, you can define a default value as an answer to this question, e.g. scan %YY%-%MM
%-%DD%
To add a new list, use the + button on the top of the screen.
New lists can be created in different types, being Static, SQL, Script, XML, Dropbox, Email browse,
Google Drive, Sharepoint and Folderbrowse:
Name
Type the name of the item list here. We advice you to use a clear name, so you can always
recognize the list you are supposed to use.
Type
The type can be Static, SQL, Script, XML, Database, Dropbox, Email browse, FTP, Google Drive,
Sharepoint and Folderbrowse. This list can contain more items, depending on your license.
Selecting the type enables the menu accordingly.
For a detailed description of all the picklist types, refer to the picklist menu
When you define a question as typed or selected, the user can either select an answer or type in
their answer
When selecting this question type, the selected menu will be available where you can insert a new
list.
For a detailed description of the available list types, refer to the Selected section.
When you define a question as typed or selected (filtered), the user can either select an answer or
type in their complete or part of the answer, after which the possible options will be filtered and
displayed and can be selected.
When selecting this question type, the selected menu will be available where you can insert a new
list.
For a detailed description of the available list types, refer to the Selected section.
Select format
You can choose between the following formats:
- DD-MM-YYYY
- YYYY-MM-DD
- DD-MM-YYYY HH:NN
- YYYY-MM-DD HH:NN
- HH:NN
DD = Day number
MM = Month number
YYYY = Year number
HH = Hour (24 hours format)
NN = Minutes
Default
This allows you to set a default date, Yesterday, Today, Tomorrow or a Selected date. In
some case this is useful to keep the user from having to enter information which is usually the
same. Of course, even when default settings have been specified, another date can be selected as
well.
Date between
If you check this option you can specify a time span which should contain the date the user
enters at the Multifunctional.
Default
When the default box is checked, the True value is already selected by default on the MFP, which
can then be changed manually.
Default
If you specify something here this will be shown by default on the Multifunctional. Even when
default settings have been specified, another number can be selected as well.
Regular Expression
Regular Expressions are a powerful means to limit the input the user can provide to pre-defined
patterns. If for example a user is only allowed to enter an invoice number which always starts with
"2011" followed by a four digit number, e.g. 20111321, 20111322 and so on, you could use a
regular expression
\b2011[0-9]{4}\b
For more information on regular expressions, there are many websites, e.g. http://www.
regular-expressions.info/
Note: regular expressions will only work when the question type is Required!
This question type can be used as e.g. as a control question. Label types are always filled
automatically and cannot be changed.
When selecting this question type, the selected menu will be available where you can insert a new
list.
If no question is configured in front, the first item in the list will always be displayed.
By default this question type is optional, if you want it to be required, turn the setting on 'YES'
For a detailed description of the available list types, refer to the Selected section.
3.2.4.1.7.2 Triggers
The trigger menu allows you to add triggers during scanning. Options for triggers are at start, end, on
error or on timeout.
note: Processing variables are not available on triggers at scanning.
For a detailed description of all trigger, please refer to the Trigger chapter
Scan
By checking the Manual questions box the questions have to be manually opened after selecting
the workflow. If unchecked, the questions will automatically open when a workflow is selected.
When the clear question checkbox is enabled, all questions will be cleared after scanning, please
note that this setting only applies to newer versions of Olivetti machines. Older models automatically
keep the questions, new models by default clear them. By changing this setting, you can change
this.
The scan properties provide a way to determine the quality of incoming scans.
Here you can select what color settings and resolution you want to use. After selecting an item, the
checkbox Lock beneath the item may be checked, which ensures that the user of the client cannot
change the setting on the MFP client to a different one than has been set in this screen. If you don't
lock the default, there is also a possibility to specify which options the user may choose from.
By checking the checkboxes, the options behind them will be selectable on the MFP. In this screen,
resolution types 200, 300 and 400 can be chosen on the MFP.
3.2.4.1.8.1 Questions
Questions
The question section enables you to define questions which the user can answer when scanning a
document using the Olivetti client. The answers to these questions are stored in variables. These
variables can be used later on in the workflow.
Questions order can be changed by drag & drop in the question list. The number in front of the
question will define the sequence of appearance.
If you want to add a question, select the + on top of the screen. This will open a new window,
looking like this:
Required
This determines if the user always has to provide an answer to this question or whether it is
optional. When the indicator is green, a question will be marked as required. If the indicator is red,
the question is optional.
Question
This is how the question will be described on the panel of the Olivetti MFP
Button name
This is the name that will be used on the screen of the multifunctional to select this question
Description
Here you can provide a short description of the question to clarify to users what it is meant for
Variable
Variables are used to store the answers to questions. Variables can be used elsewhere in the
application, e.g. to replace the default filename as provided by the user of the Olivetti MFP
Variables are always written in the format %VARIABLENAME%. The application provides a
variables parsing engine as well in order to use only part of the answer.
Type
Scanshare Enterprise V4 supports eight question types:
Typed
The user can enter any text they like
Selected
The user can select from a list of pre-defined entries
Typed or Selected
The user can enter any text they like or select from a list of pre-defined entries
Password
The user can enter a password from the screen of the Olivetti MFP. Entered characters will be
shown as an asterix.
Selecting a question type, enables the corresponding menu on the left side of the screen.
Default
Optionally, you can define a default value as an answer to this question, e.g. scan %YY%-%MM
%-%DD%
Regular expression
Regular Expressions are a powerful means to limit the input the user can provide to pre-defined
patterns. If for example a user is only allowed to answer any three letter combinations of "A", "a",
"B" and "b" , you could use a regular expression
\b([A-B]|[a-b]){3}\b
For more information on regular expressions, there are many websites, e.g. http://www.
regular-expressions.info/
Note: regular expressions will only work when the question type is Required!
Example
You can provide an example of the kind of information the user should enter, this text will show up
if invalid input is entered.
Default
Optionally, you can define a default value as an answer to this question, e.g. scan %YY%-%MM
%-%DD%
To add a new list, use the + button on the top of the screen.
New lists can be created in different types, being Static, SQL, Script, XML, Dropbox, Email browse,
Google Drive, Sharepoint and Folderbrowse:
Name
Type the name of the item list here. We advice you to use a clear name, so you can always
recognize the list you are supposed to use.
Type
The type can be Static, SQL, Script, XML, Database, Dropbox, Email browse, FTP, Google Drive,
Sharepoint and Folderbrowse. This list can contain more items, depending on your license.
Selecting the type enables the menu accordingly.
For a detailed description of all the picklist types, refer to the picklist menu
When you define a question as typed or selected, the user can either select an answer or type in
their answer
When selecting this question type, the selected menu will be available where you can insert a new
list.
For a detailed description of the available list types, refer to the Selected section.
When you define a question as password, the user can either select an password in their answer
Scan
The scan properties provide a way to determine the quality of incoming scans.
Here you can select what color settings and resolution you want to use. After selecting an item, the
checkbox Lock beneath the item may be checked, which ensures that the user of the client cannot
change the setting on the MFP client to a different one than has been set in this screen. If you don't
lock the default, there is also a possibility to specify which options the user may choose from.
By checking the checkboxes, the options behind them will be selectable on the MFP. In this screen,
resolution types 200, 300 and 400 can be chosen on the MFP.
3.2.4.1.9.1 Questions
Questions
The question section enables you to define questions which the user can answer when scanning a
document using the Toshiba client. The answers to these questions are stored in variables. These
variables can be used later on in the workflow.
Questions order can be changed by drag & drop in the question list. The number in front of the
question will define the sequence of appearance.
If you want to add a question, select the + on top of the screen. This will open a new window,
looking like this:
Required
This determines if the user always has to provide an answer to this question or whether it is
optional. When the indicator is green, a question will be marked as required. If the indicator is red,
the question is optional.
Question
This is how the question will be described on the panel of the Toshiba MFP
Button name
This is the name that will be used on the screen of the multifunctional to select this question
Description
Here you can provide a short description of the question to clarify to users what it is meant for
Variable
Variables are used to store the answers to questions. Variables can be used elsewhere in the
application, e.g. to replace the default filename as provided by the user of the Toshiba MFP
Variables are always written in the format %VARIABLENAME%. The application provides a
variables parsing engine as well in order to use only part of the answer.
Type
Scanshare Enterprise V4 Toshiba client supports four question types:
Typed
The user can enter any text they like
Selected
The user can select from a list of pre-defined entries
Search while typing
The user can enter any text they like while the application dynamically searches the selected
list
Password
The user can enter a password from the screen of the Toshiba MFP. Entered characters will be
shown as an asterix.
Label
a label question can be used as an extra check for a previous question or as a default value.
Selecting a question type, enables the corresponding menu on the left side of the screen.
Default
Optionally, you can define a default value as an answer to this question, e.g. scan %YY%-%MM
%-%DD%
Regular expression
Regular Expressions are a powerful means to limit the input the user can provide to pre-defined
patterns. If for example a user is only allowed to answer any three letter combinations of "A", "a",
"B" and "b" , you could use a regular expression
\b([A-B]|[a-b]){3}\b
For more information on regular expressions, there are many websites, e.g. http://www.
regular-expressions.info/
Note: regular expressions will only work when the question type is Required!
Example
You can provide an example of the kind of information the user should enter, this text will show up
if invalid input is entered.
Default
Optionally, you can define a default value as an answer to this question, e.g. scan %YY%-%MM
%-%DD%
To add a new list, use the + button on the top of the screen.
New lists can be created in different types, being Static, SQL, Script, XML, Dropbox, Email browse,
Google Drive, Sharepoint and Folderbrowse:
Name
Type the name of the item list here. We advice you to use a clear name, so you can always
recognize the list you are supposed to use.
Type
The type can be Static, SQL, Script, XML, Database, Dropbox, Email browse, FTP, Google Drive,
Sharepoint and Folderbrowse. This list can contain more items, depending on your license.
Selecting the type enables the menu accordingly.
For a detailed description of all the picklist types, refer to the picklist menu
When you define a question as search while typing, the user can enter an answer and the
application will dynamically browse to the right answer
When selecting this question type, the selected menu will be available where you can insert a new
list.
For a detailed description of the available list types, refer to the Selected section.
This question type can be used as e.g. as a control question. Label types are always filled
automatically and cannot be changed.
When selecting this question type, the selected menu will be available where you can insert a new
list.
If no question is configured in front, the first item in the list will always be displayed.
By default this question type is optional, if you want it to be required, turn the setting on 'YES'.
For a detailed description of the available list types, refer to the Selected section.
When you define a question as password, the user can either select an password in their answer
3.2.4.1.9.2 Triggers
The trigger menu allows you to add triggers during scanning. Options for triggers are at start, end, on
error or on timeout.
note: Processing variables are not available on triggers at scanning.
For a detailed description of all trigger, please refer to the Trigger chapter
Scan
The scan properties provide a way to determine the quality of incoming scans.
Here you can select what color settings and resolution you want to use. After selecting an item, the
checkbox Lock beneath the item may be checked, which ensures that the user of the client cannot
change the setting on the MFP client to a different one than has been set in this screen. If you don't
lock the default, there is also a possibility to specify which options the user may choose from.
By checking the checkboxes, the options behind them will be selectable on the MFP. In this screen,
resolution types 200, 300 and 400 can be chosen on the MFP.
3.2.4.1.10.1 Questions
Questions
The question section enables you to define questions which the user can answer when scanning a
document using the Kyocera client. The answers to these questions are stored in variables. These
If you want to add a question, select the + on top of the screen. This will open a new window,
looking like this:
Required
This determines if the user always has to provide an answer to this question or whether it is
optional. When the indicator is green, a question will be marked as required. If the indicator is red,
the question is optional.
Question
This is how the question will be described on the panel of the Kyocera MFP
Button name
This is the name that will be used on the screen of the multifunctional to select this question
Description
Here you can provide a short description of the question to clarify to users what it is meant for
Variable
Variables are used to store the answers to questions. Variables can be used elsewhere in the
application, e.g. to replace the default filename as provided by the user of the Kyocera MFP
Variables are always written in the format %VARIABLENAME%. The application provides a
variables parsing engine as well in order to use only part of the answer.
Type
Scanshare Enterprise V4 Kyocera client supports four question types:
Typed
The user can enter any text they like
Selected
The user can select from a list of pre-defined entries
Typed or selected
The user can enter any text they like while the application dynamically searches the selected
list
Password
The user can enter a password from the screen of the Kyocera MFP. Entered characters will be
shown as an asterix.
Selecting a question type, enables the corresponding menu on the left side of the screen.
Default
Optionally, you can define a default value as an answer to this question, e.g. scan %YY%-%MM
%-%DD%
Regular expression
Regular Expressions are a powerful means to limit the input the user can provide to pre-defined
patterns. If for example a user is only allowed to answer any three letter combinations of "A", "a",
"B" and "b" , you could use a regular expression
\b([A-B]|[a-b]){3}\b
For more information on regular expressions, there are many websites, e.g. http://www.
regular-expressions.info/
Note: regular expressions will only work when the question type is Required!
Example
You can provide an example of the kind of information the user should enter, this text will show up
if invalid input is entered.
Default
Optionally, you can define a default value as an answer to this question, e.g. scan %YY%-%MM
%-%DD%
To add a new list, use the + button on the top of the screen.
New lists can be created in different types, being Static, SQL, Script, XML, Dropbox, Email browse,
Google Drive, Sharepoint and Folderbrowse:
Name
Type the name of the item list here. We advice you to use a clear name, so you can always
recognize the list you are supposed to use.
Type
The type can be Static, SQL, Script, XML, Database, Dropbox, Email browse, FTP, Google Drive,
Sharepoint and Folderbrowse. This list can contain more items, depending on your license.
Selecting the type enables the menu accordingly.
For a detailed description of all the picklist types, refer to the picklist menu
When you define a question as typed or selected, the user can either select an answer or type in
their answer
When selecting this question type, the selected menu will be available where you can insert a new
list.
For a detailed description of the available list types, refer to the Selected section.
When you define a question as password, the user can either select an password in their answer
Scan
The scan properties provide a way to determine the quality of incoming scans.
Here you can select what color settings and resolution you want to use. After selecting an item, the
checkbox Lock beneath the item may be checked, which ensures that the user of the client cannot
change the setting on the MFP client to a different one than has been set in this screen. If you don't
lock the default, there is also a possibility to specify which options the user may choose from.
By checking the checkboxes, the options behind them will be selectable on the MFP. In this screen,
resolution types 200, 300 and 400 can be chosen on the MFP.
3.2.4.1.11.1 Questions
Questions
The question section enables you to define questions which the user can answer when scanning a
document using the Lexmark client. The answers to these questions are stored in variables. These
variables can be used later on in the workflow.
Questions order can be changed by drag & drop in the question list. The number in front of the
question will define the sequence of appearance.
If you want to add a question, select the + on top of the screen. This will open a new window,
looking like this:
Required
This determines if the user always has to provide an answer to this question or whether it is
optional. When the indicator is green, a question will be marked as required. If the indicator is red,
the question is optional.
Question
This is how the question will be described on the panel of the Lexmark MFP
Button name
This is the name that will be used on the screen of the multifunctional to select this question
Description
Here you can provide a short description of the question to clarify to users what it is meant for
Variable
Variables are used to store the answers to questions. Variables can be used elsewhere in the
application, e.g. to replace the default filename as provided by the user of the Lexmark MFP
Variables are always written in the format %VARIABLENAME%. The application provides a
variables parsing engine as well in order to use only part of the answer.
Type
Lexmark client supports four question types:
Typed
The user can enter any text they like
Selected
The user can select from a list of pre-defined entries
Typed or selected
The user can enter any text they like while the application dynamically searches the selected
list
Password
The user can enter a password from the screen of the Lexmark MFP. Entered characters will be
shown as an asterix.
Selecting a question type, enables the corresponding menu on the left side of the screen.
Default
Optionally, you can define a default value as an answer to this question, e.g. scan %YY%-%MM
%-%DD%
Regular expression
Regular Expressions are a powerful means to limit the input the user can provide to pre-defined
patterns. If for example a user is only allowed to answer any three letter combinations of "A", "a",
"B" and "b" , you could use a regular expression
\b([A-B]|[a-b]){3}\b
For more information on regular expressions, there are many websites, e.g. http://www.
regular-expressions.info/
Note: regular expressions will only work when the question type is Required!
Example
You can provide an example of the kind of information the user should enter, this text will show up
if invalid input is entered.
Default
Optionally, you can define a default value as an answer to this question, e.g. scan %YY%-%MM
%-%DD%
To add a new list, use the + button on the top of the screen.
New lists can be created in different types, being Static, SQL, Script, XML, Dropbox, Email browse,
Google Drive, Sharepoint and Folderbrowse:
Name
Type the name of the item list here. We advice you to use a clear name, so you can always
recognize the list you are supposed to use.
Type
The type can be Static, SQL, Script, XML, Database, Dropbox, Email browse, FTP, Google Drive,
Sharepoint and Folderbrowse. This list can contain more items, depending on your license.
Selecting the type enables the menu accordingly.
For a detailed description of all the picklist types, refer to the picklist menu
When you define a question as typed or selected, the user can either select an answer or type in
their answer
When selecting this question type, the selected menu will be available where you can insert a new
list.
For a detailed description of the available list types, refer to the Selected section.
When you define a question as password, the user can either select an password in their answer
Scan
The scan properties provide a way to determine the quality of incoming scans.
Here you can select what color settings and resolution you want to use. After selecting an item, the
checkbox Lock beneath the item may be checked, which ensures that the user of the client cannot
change the setting on the MFP client to a different one than has been set in this screen. If you don't
lock the default, there is also a possibility to specify which options the user may choose from.
By checking the checkboxes, the options behind them will be selectable on the MFP. In this screen,
resolution types 200, 300 and 400 can be chosen on the MFP.
3.2.4.1.12.1 Questions
Questions
The question section enables you to define questions which the user can answer when scanning a
document using the Ricoh client. The answers to these questions are stored in variables. These
variables can be used later on in the workflow.
Questions order can be changed by drag & drop in the question list. The number in front of the
question will define the sequence of appearance.
If you want to add a question, select the + on top of the screen. This will open a new window,
looking like this:
Required
This determines if the user always has to provide an answer to this question or whether it is
optional. When the indicator is green, a question will be marked as required. If the indicator is red,
the question is optional.
Question
This is how the question will be described on the panel of the Ricoh MFP
Button name
This is the name that will be used on the screen of the multifunctional to select this question
Description
Here you can provide a short description of the question to clarify to users what it is meant for
Variable
Variables are used to store the answers to questions. Variables can be used elsewhere in the
application, e.g. to replace the default filename as provided by the user of the Ricoh MFP
Variables are always written in the format %VARIABLENAME%. The application provides a
variables parsing engine as well in order to use only part of the answer.
Type
Scanshare Enterprise V4 Ricoh client supports three question types:
Typed
The user can enter any text they like
Selected
The user can select from a list of pre-defined entries
Typed or selected
The user can enter any text they like while the application dynamically searches the selected
list
Selecting a question type, enables the corresponding menu on the left side of the screen.
Default
Optionally, you can define a default value as an answer to this question, e.g. scan %YY%-%MM
%-%DD%
Regular expression
Regular Expressions are a powerful means to limit the input the user can provide to pre-defined
patterns. If for example a user is only allowed to answer any three letter combinations of "A", "a",
"B" and "b" , you could use a regular expression
\b([A-B]|[a-b]){3}\b
For more information on regular expressions, there are many websites, e.g. http://www.
regular-expressions.info/
Note: regular expressions will only work when the question type is REQUIRED!
Example
You can provide an example of the kind of information the user should enter, this text will show up
if invalid input is entered.
Default
Optionally, you can define a default value as an answer to this question, e.g. scan %YY%-%MM
%-%DD%
To add a new list, use the + button on the top of the screen.
New lists can be created in different types, being Static, SQL, Script, XML, Dropbox, Email browse,
Google Drive, Sharepoint and Folderbrowse:
Name
Type the name of the item list here. We advice you to use a clear name, so you can always
recognize the list you are supposed to use.
Type
The type can be Static, SQL, Script, XML, Database, Dropbox, Email browse, FTP, Google Drive,
Sharepoint and Folderbrowse. This list can contain more items, depending on your license.
Selecting the type enables the menu accordingly.
For a detailed description of all the picklist types, refer to the picklist menu
When you define a question as typed or selected, the user can either select an answer or type in
their answer
When selecting this question type, the selected menu will be available where you can insert a new
list.
For a detailed description of the available list types, refer to the Selected section.
Scan
The scan properties provide a way to determine the quality of incoming scans.
Here you can select what color settings and resolution you want to use. After selecting an item, the
checkbox Lock beneath the item may be checked, which ensures that the user of the client cannot
change the setting on the MFP client to a different one than has been set in this screen. If you don't
lock the default, there is also a possibility to specify which options the user may choose from.
By checking the checkboxes, the options behind them will be selectable on the MFP. In this screen,
resolution types 200, 300 and 400 can be chosen on the MFP.
- One-Click Scan: If you select it, scanning will start automatically without going through the scan
settings.
3.2.4.1.13.1 Questions
Questions
The question section enables you to define questions which the user can answer when scanning a
document using the Samsung client. The answers to these questions are stored in variables. These
variables can be used later on in the workflow.
Questions order can be changed by drag & drop in the question list. The number in front of the
question will define the sequence of appearance.
If you want to add a question, select the + on top of the screen. This will open a new window,
looking like this:
Required
This determines if the user always has to provide an answer to this question or whether it is
optional. When the indicator is green, a question will be marked as required. If the indicator is red,
the question is optional.
Question
This is how the question will be described on the panel of the Samsung MFP
Button name
This is the name that will be used on the screen of the multifunctional to select this question
Description
Here you can provide a short description of the question to clarify to users what it is meant for
Variable
Variables are used to store the answers to questions. Variables can be used elsewhere in the
application, e.g. to replace the default filename as provided by the user of the Samsung MFP
Variables are always written in the format %VARIABLENAME%. The application provides a
variables parsing engine as well in order to use only part of the answer.
Type
Scanshare Enterprise V4 Samsung client supports three question types:
Typed
The user can enter any text they like
Selected
The user can select from a list of pre-defined entries
Typed or selected
The user can enter any text they like while the application dynamically searches the selected
list
Password
The user can enter a password from the screen of the Samsung. Entered characters will be
shown as an asterix.
Selecting a question type, enables the corresponding menu on the left side of the screen.
Default
Optionally, you can define a default value as an answer to this question, e.g. scan %YY%-%MM
%-%DD%
Regular expression
Regular Expressions are a powerful means to limit the input the user can provide to pre-defined
patterns. If for example a user is only allowed to answer any three letter combinations of "A", "a",
"B" and "b" , you could use a regular expression
\b([A-B]|[a-b]){3}\b
For more information on regular expressions, there are many websites, e.g. http://www.
regular-expressions.info/
Note: regular expressions will only work when the question type is Required!
Example
You can provide an example of the kind of information the user should enter, this text will show up
if invalid input is entered.
Default
Optionally, you can define a default value as an answer to this question, e.g. scan %YY%-%MM
%-%DD%
To add a new list, use the + button on the top of the screen.
New lists can be created in different types, being Static, SQL, Script, XML, Dropbox, Email browse,
Google Drive, Sharepoint and Folderbrowse:
Name
Type the name of the item list here. We advice you to use a clear name, so you can always
recognize the list you are supposed to use.
Type
The type can be Static, SQL, Script, XML, Database, Dropbox, Email browse, FTP, Google Drive,
Sharepoint and Folderbrowse. This list can contain more items, depending on your license.
Selecting the type enables the menu accordingly.
For a detailed description of all the picklist types, refer to the picklist menu
When you define a question as typed or selected, the user can either select an answer or type in
their answer
When selecting this question type, the selected menu will be available where you can insert a new
list.
For a detailed description of the available list types, refer to the Selected section.
When you define a question as password, the user can either select an password in their answer
Scan
The scan properties provide a way to determine the quality of incoming scans.
Here you can select what color settings and resolution you want to use. After selecting an item, the
checkbox Lock beneath the item may be checked, which ensures that the user of the client cannot
change the setting on the MFP client to a different one than has been set in this screen. If you don't
lock the default, there is also a possibility to specify which options the user may choose from.
By checking the checkboxes, the options behind them will be selectable on the MFP. In this screen,
resolution types 200, 300 and 400 can be chosen on the MFP.
3.2.4.1.14.1 Questions
Questions
The question section enables you to define questions which the user can answer when scanning a
document using the Sharp client. The answers to these questions are stored in variables. These
variables can be used later on in the workflow.
Questions order can be changed by drag & drop in the question list. The number in front of the
question will define the sequence of appearance.
If you want to add a question, select the + on top of the screen. This will open a new window,
looking like this:
Required
This determines if the user always has to provide an answer to this question or whether it is
optional. When the indicator is green, a question will be marked as required. If the indicator is red,
the question is optional.
Question
This is how the question will be described on the panel of the Sharp MFP
Button name
This is the name that will be used on the screen of the multifunctional to select this question
Description
Here you can provide a short description of the question to clarify to users what it is meant for
Variable
Variables are used to store the answers to questions. Variables can be used elsewhere in the
application, e.g. to replace the default filename as provided by the user of the Sharp MFP
Variables are always written in the format %VARIABLENAME%. The application provides a
variables parsing engine as well in order to use only part of the answer.
Type
Scanshare Enterprise V4 Sharp client supports three question types:
Typed
The user can enter any text they like
Selected
The user can select from a list of pre-defined entries
Typed or selected
The user can enter any text they like while the application dynamically searches the selected
list
Label
a label question can be used as an extra check for a previous question or as a default value.
Password
The user can enter a password from the screen of the Sharp MFP. Entered characters will be
shown as an asterix.
Selecting a question type, enables the corresponding menu on the left side of the screen.
Default
Optionally, you can define a default value as an answer to this question, e.g. scan %YY%-%MM
%-%DD%
Regular expression
Regular Expressions are a powerful means to limit the input the user can provide to pre-defined
patterns. If for example a user is only allowed to answer any three letter combinations of "A", "a",
"B" and "b" , you could use a regular expression
\b([A-B]|[a-b]){3}\b
For more information on regular expressions, there are many websites, e.g. http://www.
regular-expressions.info/
Note: regular expressions will only work when the question type is Required!
Example
You can provide an example of the kind of information the user should enter, this text will show up
if invalid input is entered.
Default
Optionally, you can define a default value as an answer to this question, e.g. scan %YY%-%MM
%-%DD%
To add a new list, use the + button on the top of the screen.
New lists can be created in different types, being Static, SQL, Script, XML, Dropbox, Email browse,
Google Drive, Sharepoint and Folderbrowse:
Name
Type the name of the item list here. We advice you to use a clear name, so you can always
recognize the list you are supposed to use.
Type
The type can be Static, SQL, Script, XML, Database, Dropbox, Email browse, FTP, Google Drive,
Sharepoint and Folderbrowse. This list can contain more items, depending on your license.
Selecting the type enables the menu accordingly.
For a detailed description of all the picklist types, refer to the picklist menu
When you define a question as typed or selected, the user can either select an answer or type in
their answer
When selecting this question type, the selected menu will be available where you can insert a new
list.
For a detailed description of the available list types, refer to the Selected section.
This question type can be used as e.g. as a control question. Label types are always filled
automatically and cannot be changed.
When selecting this question type, the selected menu will be available where you can insert a new
list.
If no question is configured in front, the first item in the list will always be displayed.
By default this question type is optional, if you want it to be required, turn the setting on 'YES'
For a detailed description of the available list types, refer to the Selected section.
When you define a question as password, the user can either select an password in their answer
3.2.4.1.14.2 Triggers
The trigger menu allows you to add triggers during scanning. Options for triggers are at start, end, on
error or on timeout.
note: Processing variables are not available on triggers at scanning.
For a detailed description of all trigger, please refer to the Trigger chapter
3.2.4.1.15 HP client
Scan
The scan properties provide a way to determine the quality of incoming scans.
Here you can select what color settings and resolution you want to use. After selecting an item, the
checkbox Lock beneath the item may be checked, which ensures that the user of the client cannot
change the setting on the MFP client to a different one than has been set in this screen. If you don't
lock the default, there is also a possibility to specify which options the user may choose from.
By checking the checkboxes, the options behind them will be selectable on the MFP. In this screen,
resolution types 200, 300 and 400 can be chosen on the MFP.
3.2.4.1.15.1 Questions_2
Questions
The question section enables you to define questions which the user can answer when scanning a
document using the HP client. The answers to these questions are stored in variables. These
variables can be used later on in the workflow.
Questions order can be changed by drag & drop in the question list. The number in front of the
question will define the sequence of appearance.
If you want to add a question, select the + on top of the screen. This will open a new window,
looking like this:
Required
This determines if the user always has to provide an answer to this question or whether it is
optional. When the indicator is green, a question will be marked as required. If the indicator is red,
the question is optional.
Question
This is how the question will be described on the panel of the HP MFD
Button name
This is the name that will be used on the screen of the multifunctional to select this question
Description
Here you can provide a short description of the question to clarify to users what it is meant for
Variable
Variables are used to store the answers to questions. Variables can be used elsewhere in the
application, e.g. to replace the default filename as provided by the user of the HP MFD
Variables are always written in the format %VARIABLENAME%. The application provides a
variables parsing engine as well in order to use only part of the answer.
Type
Scanshare Enterprise V4 Sharp client supports three question types:
Typed
The user can enter any text they like
Selected
The user can select from a list of pre-defined entries
Typed or selected
The user can enter any text they like while the application dynamically searches the selected
list
Password
The user can enter a password from the screen of the HP MFD. Entered characters will be
shown as an asterix.
Selecting a question type, enables the corresponding menu on the left side of the screen.
Default
Optionally, you can define a default value as an answer to this question, e.g. scan %YY%-%MM
%-%DD%
Regular expression
Regular Expressions are a powerful means to limit the input the user can provide to pre-defined
patterns. If for example a user is only allowed to answer any three letter combinations of "A", "a",
"B" and "b" , you could use a regular expression
\b([A-B]|[a-b]){3}\b
For more information on regular expressions, there are many websites, e.g. http://www.
regular-expressions.info/
Note: regular expressions will only work when the question type is Required!
Example
You can provide an example of the kind of information the user should enter, this text will show up
if invalid input is entered.
Default
Optionally, you can define a default value as an answer to this question, e.g. scan %YY%-%MM
%-%DD%
To add a new list, use the + button on the top of the screen.
New lists can be created in different types, being Static, SQL, Script, XML, Dropbox, Email browse,
Google Drive, Sharepoint and Folderbrowse:
Name
Type the name of the item list here. We advice you to use a clear name, so you can always
recognize the list you are supposed to use.
Type
The type can be Static, SQL, Script, XML, Database, Dropbox, Email browse, FTP, Google Drive,
Sharepoint and Folderbrowse. This list can contain more items, depending on your license.
Selecting the type enables the menu accordingly.
For a detailed description of all the picklist types, refer to the picklist menu
When you define a question as typed or selected, the user can either select an answer or type in
their answer
When selecting this question type, the selected menu will be available where you can insert a new
list.
For a detailed description of the available list types, refer to the Selected section.
When you define a question as password, the user can either select an password in their answer
Scan
The scan properties provide a way to determine the quality of incoming scans.
Here you can select what color settings and resolution you want to use. After selecting an item, the
checkbox Lock beneath the item may be checked, which ensures that the user of the client cannot
change the setting on the MFP client to a different one than has been set in this screen. If you don't
lock the default, there is also a possibility to specify which options the user may choose from.
By checking the checkboxes, the options behind them will be selectable on the MFP. In this screen,
resolution types 200, 300 and 400 can be chosen on the MFP.
3.2.4.1.16.1 Questions
Questions
The question section enables you to define questions which the user can answer when scanning a
document using the Xerox client. The answers to these questions are stored in variables. These
variables can be used later on in the workflow.
Questions order can be changed by drag & drop in the question list. The number in front of the
question will define the sequence of appearance.
If you want to add a question, select the + on top of the screen. This will open a new window,
looking like this:
Required
This determines if the user always has to provide an answer to this question or whether it is
optional. When the indicator is green, a question will be marked as required. If the indicator is red,
the question is optional.
Question
This is how the question will be described on the panel of the Xerox MFP
Button name
This is the name that will be used on the screen of the multifunctional to select this question
Description
Here you can provide a short description of the question to clarify to users what it is meant for
Variable
Variables are used to store the answers to questions. Variables can be used elsewhere in the
application, e.g. to replace the default filename as provided by the user of the Xerox MFP
Variables are always written in the format %VARIABLENAME%. The application provides a
variables parsing engine as well in order to use only part of the answer.
Type
Scanshare Enterprise V4 Xerox client supports three question types:
Typed
The user can enter any text they like
Selected
The user can select from a list of pre-defined entries
Typed or selected
The user can enter any text they like while the application dynamically searches the selected
list
Selecting a question type, enables the corresponding menu on the left side of the screen.
Default
Optionally, you can define a default value as an answer to this question, e.g. scan %YY%-%MM
%-%DD%
Regular expression
Regular Expressions are a powerful means to limit the input the user can provide to pre-defined
patterns. If for example a user is only allowed to answer any three letter combinations of "A", "a",
"B" and "b" , you could use a regular expression
\b([A-B]|[a-b]){3}\b
For more information on regular expressions, there are many websites, e.g. http://www.
regular-expressions.info/
Note: regular expressions will only work when the question type is Required!
Example
You can provide an example of the kind of information the user should enter, this text will show up
if invalid input is entered.
Default
Optionally, you can define a default value as an answer to this question, e.g. scan %YY%-%MM
%-%DD%
To add a new list, use the + button on the top of the screen.
New lists can be created in different types, being Static, SQL, Script, XML, Dropbox, Email browse,
Google Drive, Sharepoint and Folderbrowse:
Name
Type the name of the item list here. We advice you to use a clear name, so you can always
recognize the list you are supposed to use.
Type
The type can be Static, SQL, Script, XML, Database, Dropbox, Email browse, FTP, Google Drive,
Sharepoint and Folderbrowse. This list can contain more items, depending on your license.
Selecting the type enables the menu accordingly.
For a detailed description of all the picklist types, refer to the picklist menu
When you define a question as typed or selected, the user can either select an answer or type in
their answer
When selecting this question type, the selected menu will be available where you can insert a new
list.
For a detailed description of the available list types, refer to the Selected section.
3.2.4.1.16.2 Triggers
The trigger menu allows you to add triggers during scanning. Options for triggers are at start, end, on
error or on timeout.
note: Processing variables are not available on triggers at scanning.
For a detailed description of all trigger, please refer to the Trigger chapter
3.2.4.1.17.1 Typed
Default
Optionally, you can define a default value as an answer to this question, e.g. scan %YY%-%MM
%-%DD%
Regular expression
Regular Expressions are a powerful means to limit the input the user can provide to pre-defined
patterns. If for example a user is only allowed to answer any three letter combinations of "A", "a",
"B" and "b" , you could use a regular expression
\b([A-B]|[a-b]){3}\b
For more information on regular expressions, there are many websites, e.g. http://www.
regular-expressions.info/
Note: regular expressions will only work when the question type is REQUIRED!
Example
You can provide an example of the kind of information the user should enter, this text will show up
if invalid input is entered.
3.2.4.1.17.2 Selected
By selecting the selected menu, this screen will appear:
Default
Optionally, you can define a default value as an answer to this question, e.g. scan %YY%-%MM
%-%DD%
To add a new list, use the + button on the top of the screen.
New lists can be created in different types, being Static, SQL, Script, XML, Dropbox, Email browse,
Google Drive, Sharepoint and Folderbrowse:
Name
Type the name of the item list here. We advice you to use a clear name, so you can always
recognize the list you are supposed to use.
Type
The type can be Static, SQL, Script, XML, Database, Dropbox, Email browse, FTP, Google Drive,
Sharepoint and Folderbrowse. This list can contain more items, depending on your license.
Selecting the type enables the menu accordingly.
For a detailed description of all the picklist types, refer to the picklist menu
When selecting this question type, the selected menu will be available where you can insert a new
list.
For a detailed description of the available list types, refer to the Selected section.
When selecting this question type, the selected menu will be available where you can insert a new
list.
For a detailed description of the available list types, refer to the Selected section.
3.2.4.1.17.5 Label
This question type can be used as e.g. as a control question. Label types are always filled
automatically and cannot be changed.
When selecting this question type, the selected menu will be available where you can insert a new
list.
If no question is configured in front, the first item in the list will always be displayed.
By default this question type is optional, if you want it to be required, turn the setting on 'YES'.
For a detailed description of the available list types, refer to the Selected section.
3.2.4.1.17.6 Password
When you define a question as password, the user can either select an password in their answer
3.2.4.1.18.1 Typed
Default
Optionally, you can define a default value as an answer to this question, e.g. scan %YY%-%MM
%-%DD%
Regular expression
Regular Expressions are a powerful means to limit the input the user can provide to pre-defined
patterns. If for example a user is only allowed to answer any three letter combinations of "A", "a",
"B" and "b" , you could use a regular expression
\b([A-B]|[a-b]){3}\b
For more information on regular expressions, there are many websites, e.g. http://www.
regular-expressions.info/
Note: regular expressions will only work when the question type is REQUIRED!
Example
You can provide an example of the kind of information the user should enter, this text will show up
if invalid input is entered.
3.2.4.1.18.2 Selected
By selecting the selected menu, this screen will appear:
Default
Optionally, you can define a default value as an answer to this question, e.g. scan %YY%-%MM
%-%DD%
To add a new list, use the + button on the top of the screen.
New lists can be created in different types, being Static, SQL, Script, XML, Dropbox, Email browse,
Google Drive, Sharepoint and Folderbrowse:
Name
Type the name of the item list here. We advice you to use a clear name, so you can always
recognize the list you are supposed to use.
Type
The type can be Static, SQL, Script, XML, Database, Dropbox, Email browse, FTP, Google Drive,
Sharepoint and Folderbrowse. This list can contain more items, depending on your license.
Selecting the type enables the menu accordingly.
For a detailed description of all the picklist types, refer to the picklist menu
When selecting this question type, the selected menu will be available where you can insert a new
list.
For a detailed description of the available list types, refer to the Selected section.
When selecting this question type, the selected menu will be available where you can insert a new
list.
For a detailed description of the available list types, refer to the Selected section.
3.2.4.1.18.5 Label
This question type can be used as e.g. as a control question. Label types are always filled
automatically and cannot be changed.
When selecting this question type, the selected menu will be available where you can insert a new
list.
If no question is configured in front, the first item in the list will always be displayed.
By default this question type is optional, if you want it to be required, turn the setting on 'YES'.
For a detailed description of the available list types, refer to the Selected section.
3.2.4.1.18.6 Password
When you define a question as password, the user can either select an password in their answer
Scan
The scan properties provide a way to determine the quality of incoming scans.
Here you can select what color settings and resolution you want to use. After selecting an item, the
checkbox Lock beneath the item may be checked, which ensures that the user of the client cannot
change the setting on the MFP client to a different one than has been set in this screen. If you don't
lock the default, there is also a possibility to specify which options the user may choose from.
By checking the checkboxes, the options behind them will be selectable on the MFP. In this screen,
resolution types 200, 300 and 400 can be chosen on the MFP.
3.2.4.1.19.1 Questions
Questions
The question section enables you to define questions which the user can answer when scanning a
document using the OKI client. The answers to these questions are stored in variables. These
variables can be used later on in the workflow.
Questions order can be changed by drag & drop in the question list. The number in front of the
question will define the sequence of appearance.
If you want to add a question, select the + on top of the screen. This will open a new window,
looking like this:
Required
This determines if the user always has to provide an answer to this question or whether it is
optional. When the indicator is green, a question will be marked as required. If the indicator is red,
the question is optional.
Question
This is how the question will be described on the panel of the OKI MFP
Button name
This is the name that will be used on the screen of the multifunctional to select this question
Description
Here you can provide a short description of the question to clarify to users what it is meant for
Variable
Variables are used to store the answers to questions. Variables can be used elsewhere in the
application, e.g. to replace the default filename as provided by the user of the OKI MFP
Variables are always written in the format %VARIABLENAME%. The application provides a
variables parsing engine as well in order to use only part of the answer.
Type
OKI client supports three question types:
Typed
The user can enter any text they like
Selected
The user can select from a list of pre-defined entries
Typed or selected
The user can enter any text they like while the application dynamically searches the selected
list
Password
The user can enter a password from the screen of the Oki MFP. Entered characters will be
shown as an asterix.
Label
a label question can be used as an extra check for a previous question or as a default value.
.
Selecting a question type, enables the corresponding menu on the left side of the screen.
Default
Optionally, you can define a default value as an answer to this question, e.g. scan %YY%-%MM
%-%DD%
Regular expression
Regular Expressions are a powerful means to limit the input the user can provide to pre-defined
patterns. If for example a user is only allowed to answer any three letter combinations of "A", "a",
"B" and "b" , you could use a regular expression
\b([A-B]|[a-b]){3}\b
For more information on regular expressions, there are many websites, e.g. http://www.
regular-expressions.info/
Note: regular expressions will only work when the question type is Required!
Example
You can provide an example of the kind of information the user should enter, this text will show up
if invalid input is entered.
Default
Optionally, you can define a default value as an answer to this question, e.g. scan %YY%-%MM
%-%DD%
To add a new list, use the + button on the top of the screen.
New lists can be created in different types, being Static, SQL, Script, XML, Dropbox, Email browse,
Google Drive, Sharepoint and Folderbrowse:
Name
Type the name of the item list here. We advice you to use a clear name, so you can always
recognize the list you are supposed to use.
Type
The type can be Static, SQL, Script, XML, Database, Dropbox, Email browse, FTP, Google Drive,
Sharepoint and Folderbrowse. This list can contain more items, depending on your license.
Selecting the type enables the menu accordingly.
For a detailed description of all the picklist types, refer to the picklist menu
When you define a question as typed or selected, the user can either select an answer or type in
their answer
When selecting this question type, the selected menu will be available where you can insert a new
list.
For a detailed description of the available list types, refer to the Selected section.
This question type can be used as e.g. as a control question. Label types are always filled
automatically and cannot be changed.
When selecting this question type, the selected menu will be available where you can insert a new
list.
If no question is configured in front, the first item in the list will always be displayed.
By default this question type is optional, if you want it to be required, turn the setting on 'YES'.
For a detailed description of the available list types, refer to the Selected section.
When you define a question as password, the user can either select an password in their answer
3.2.4.1.19.2 Triggers
The trigger menu allows you to add triggers during scanning. Options for triggers are at start, end, on
error or on timeout.
note: Processing variables are not available on triggers at scanning.
For a detailed description of all trigger, please refer to the Trigger chapter
Scan
The scan properties provide a way to determine the quality of incoming scans.
Here you can select what color settings and resolution you want to use. After selecting an item, the
checkbox Lock beneath the item may be checked, which ensures that the user of the client cannot
change the setting on the MFP client to a different one than has been set in this screen. If you don't
lock the default, there is also a possibility to specify which options the user may choose from.
By checking the checkboxes, the options behind them will be selectable on the MFP. In this screen,
resolution types 200, 300 and 400 can be chosen on the MFP.
3.2.4.1.20.1 Questions
Questions
The question section enables you to define questions which the user can answer when scanning a
document using the OKI client. The answers to these questions are stored in variables. These
variables can be used later on in the workflow.
Questions order can be changed by drag & drop in the question list. The number in front of the
question will define the sequence of appearance.
If you want to add a question, select the + on top of the screen. This will open a new window,
looking like this:
Required
This determines if the user always has to provide an answer to this question or whether it is
optional. When the indicator is green, a question will be marked as required. If the indicator is red,
the question is optional.
Question
This is how the question will be described on the panel of the OKI MFP
Button name
This is the name that will be used on the screen of the multifunctional to select this question
Description
Here you can provide a short description of the question to clarify to users what it is meant for
Variable
Variables are used to store the answers to questions. Variables can be used elsewhere in the
application, e.g. to replace the default filename as provided by the user of the OKI MFP
Variables are always written in the format %VARIABLENAME%. The application provides a
variables parsing engine as well in order to use only part of the answer.
Type
Scanshare Enterprise V4 OKI client supports three question types:
Typed
The user can enter any text they like
Selected
The user can select from a list of pre-defined entries
Search while typing
The user can enter any text they like while the application dynamically searches the selected
list
Password
The user can enter a password from the screen of the Toshiba MFP. Entered characters will be
shown as an asterix.
Label
a label question can be used as an extra check for a previous question or as a default value.
Selecting a question type, enables the corresponding menu on the left side of the screen.
Default
Optionally, you can define a default value as an answer to this question, e.g. scan %YY%-%MM
%-%DD%
Regular expression
Regular Expressions are a powerful means to limit the input the user can provide to pre-defined
patterns. If for example a user is only allowed to answer any three letter combinations of "A", "a",
"B" and "b" , you could use a regular expression
\b([A-B]|[a-b]){3}\b
For more information on regular expressions, there are many websites, e.g. http://www.
regular-expressions.info/
Note: regular expressions will only work when the question type is Required!
Example
You can provide an example of the kind of information the user should enter, this text will show up
if invalid input is entered.
Default
Optionally, you can define a default value as an answer to this question, e.g. scan %YY%-%MM
%-%DD%
To add a new list, use the + button on the top of the screen.
New lists can be created in different types, being Static, SQL, Script, XML, Dropbox, Email browse,
Google Drive, Sharepoint and Folderbrowse:
Name
Type the name of the item list here. We advice you to use a clear name, so you can always
recognize the list you are supposed to use.
Type
The type can be Static, SQL, Script, XML, Database, Dropbox, Email browse, FTP, Google Drive,
Sharepoint and Folderbrowse. This list can contain more items, depending on your license.
Selecting the type enables the menu accordingly.
For a detailed description of all the picklist types, refer to the picklist menu
When you define a question as search while typing, the user can enter an answer and the
application will dynamically browse to the right answer
When selecting this question type, the selected menu will be available where you can insert a new
list.
For a detailed description of the available list types, refer to the Selected section.
This question type can be used as e.g. as a control question. Label types are always filled
automatically and cannot be changed.
When selecting this question type, the selected menu will be available where you can insert a new
list.
If no question is configured in front, the first item in the list will always be displayed.
By default this question type is optional, if you want it to be required, turn the setting on 'YES'.
For a detailed description of the available list types, refer to the Selected section.
When you define a question as password, the user can either select an password in their answer
3.2.4.1.20.2 Triggers
The trigger menu allows you to add triggers during scanning. Options for triggers are at start, end, on
error or on timeout.
note: Processing variables are not available on triggers at scanning.
For a detailed description of all trigger, please refer to the Trigger chapter
Scan
The scan properties provide a way to determine the quality of incoming scans.
Here you can select what color settings and resolution you want to use. After selecting an item, the
checkbox Lock beneath the item may be checked, which ensures that the user of the client cannot
change the setting on the MFP client to a different one than has been set in this screen. If you don't
lock the default, there is also a possibility to specify which options the user may choose from.
By checking the checkboxes, the options behind them will be selectable on the MFP. In this screen,
resolution types 200, 300 and 400 can be chosen on the MFP.
- One-Click Scan: If you select it, scanning will start automatically without going through the scan
settings.
- Continuos Scan: If you select it, the ADF continuous scan or not.
- Scan Preview: If you select it, the thumbnail preview animation as each scan finishes scanning.
3.2.4.1.21.1 Questions
Questions
The question section enables you to define questions which the user can answer when scanning a
document using the Plustek client. The answers to these questions are stored in variables. These
variables can be used later on in the workflow.
Questions order can be changed by drag & drop in the question list. The number in front of the
question will define the sequence of appearance.
If you want to add a question, select the + on top of the screen. This will open a new window,
looking like this:
Required
This determines if the user always has to provide an answer to this question or whether it is
optional. When the indicator is green, a question will be marked as required. If the indicator is red,
the question is optional.
Question
This is how the question will be described on the panel of the Plustek
Button name
This is the name that will be used on the screen of the multifunctional to select this question
Description
Here you can provide a short description of the question to clarify to users what it is meant for
Variable
Variables are used to store the answers to questions. Variables can be used elsewhere in the
application, e.g. to replace the default filename as provided by the user of the Plustek
Variables are always written in the format %VARIABLENAME%. The application provides a
variables parsing engine as well in order to use only part of the answer.
Type
Scanshare Enterprise V4 Plustek client supports three question types:
Typed
The user can enter any text they like
Selected
The user can select from a list of pre-defined entries
Typed or selected
The user can enter any text they like while the application dynamically searches the selected
list
Password
The user can enter a password from the screen of the Plustek. Entered characters will be
shown as an asterix.
Selecting a question type, enables the corresponding menu on the left side of the screen.
Default
Optionally, you can define a default value as an answer to this question, e.g. scan %YY%-%MM
%-%DD%
Regular expression
Regular Expressions are a powerful means to limit the input the user can provide to pre-defined
patterns. If for example a user is only allowed to answer any three letter combinations of "A", "a",
"B" and "b" , you could use a regular expression
\b([A-B]|[a-b]){3}\b
For more information on regular expressions, there are many websites, e.g. http://www.
regular-expressions.info/
Note: regular expressions will only work when the question type is Required!
Example
You can provide an example of the kind of information the user should enter, this text will show up
if invalid input is entered.
Default
Optionally, you can define a default value as an answer to this question, e.g. scan %YY%-%MM
%-%DD%
To add a new list, use the + button on the top of the screen.
New lists can be created in different types, being Static, SQL, Script, XML, Dropbox, Email browse,
Google Drive, Sharepoint and Folderbrowse:
Name
Type the name of the item list here. We advice you to use a clear name, so you can always
recognize the list you are supposed to use.
Type
The type can be Static, SQL, Script, XML, Database, Dropbox, Email browse, FTP, Google Drive,
Sharepoint and Folderbrowse. This list can contain more items, depending on your license.
Selecting the type enables the menu accordingly.
For a detailed description of all the picklist types, refer to the picklist menu
When you define a question as typed or selected, the user can either select an answer or type in
their answer
When selecting this question type, the selected menu will be available where you can insert a new
list.
For a detailed description of the available list types, refer to the Selected section.
When you define a question as password, the user can either select an password in their answer
Questions
The question section enables you to define questions which the user can answer when scanning a
document using the mobile client. The answers to these questions are stored in variables. These
If you want to add a question, select the + on top of the screen. This will open a new window,
looking like this:
Required
This determines if the user always has to provide an answer to this question or whether it is
optional. When the indicator is green, a question will be marked as required. If the indicator is red,
the question is optional.
Question
This is how the question will be described on the panel of the Mobile
Button name
This is the name that will be used on the screen of the smartphone to select this question
Description
Here you can provide a short description of the question to clarify to users what it is meant for
Variable
Variables are used to store the answers to questions. Variables can be used elsewhere in the
application, e.g. to replace the default filename as provided by the user of the Mobile
Variables are always written in the format %VARIABLENAME%. The application provides a
variables parsing engine as well in order to use only part of the answer.
Type
Scanshare Enterprise V4 Mobile client supports three question types:
Typed
The user can enter any text they like
Selected
The user can select from a list of pre-defined entries
Typed or selected
The user can enter any text they like while the application dynamically searches the selected
list
Password
The user can enter a password from the screen of the Mobile Client. Entered characters will be
shown as an asterix.
Selecting a question type, enables the corresponding menu on the left side of the screen.
3.2.4.1.22.1 Typed
Default
Optionally, you can define a default value as an answer to this question, e.g. scan %YY%-%MM
%-%DD%
Regular expression
Regular Expressions are a powerful means to limit the input the user can provide to pre-defined
patterns. If for example a user is only allowed to answer any three letter combinations of "A", "a",
"B" and "b" , you could use a regular expression
\b([A-B]|[a-b]){3}\b
For more information on regular expressions, there are many websites, e.g. http://www.
regular-expressions.info/
Note: regular expressions will only work when the question type is Required!
Example
You can provide an example of the kind of information the user should enter, this text will show up
if invalid input is entered.
3.2.4.1.22.2 Selected
By selecting the selected menu, this screen will appear:
Default
Optionally, you can define a default value as an answer to this question, e.g. scan %YY%-%MM
%-%DD%
To add a new list, use the + button on the top of the screen.
New lists can be created in different types, being Static, SQL, Script, XML, Dropbox, Email browse,
Google Drive, Sharepoint and Folderbrowse:
Name
Type the name of the item list here. We advice you to use a clear name, so you can always
recognize the list you are supposed to use.
Type
The type can be Static, SQL, Script, XML, Database, Dropbox, Email browse, FTP, Google Drive,
Sharepoint and Folderbrowse. This list can contain more items, depending on your license.
Selecting the type enables the menu accordingly.
For a detailed description of all the picklist types, refer to the picklist menu
When selecting this question type, the selected menu will be available where you can insert a new
list.
For a detailed description of the available list types, refer to the Selected section.
3.2.4.1.22.4 Password
When you define a question as password, the user can either select an password in their answer
3.2.4.1.23 Picklists
The picklist types available are:
Static
The static picklist allows you to create a picklist by typing or importing (.csv, .txt) a list
SQL
SQL enables you to set up a dynamic connection to a database containing the items which
should be displayed in the list
Script
A script picklist allows you to basically create a list by getting data from almost everywhere
XML
An XML picklist allows you to build a list by fetching data from any XML files with the standard
XPath query language
Afas Online
The Afas Online connector allows you to create a picklist of the specified GetConnector within
Afas Online
Affinity
The Affinity connector allows you to create a list of employees, matters, phonebook or Document
Types / Folders from Affinity
Amazon AWS
The Amazon AWS connector allows you to create a list of buckets or Folders from Amazon AWS.
Box
The Box connector allows you to create a list of buckets or Folders from Box.
Docuware
The DocuWare connector allows you to create a list of File Cabinets or Web Baskets from
DocuWare
Dokmee
The Dokmee connector allows you to create a list of File Cabinets or Folders from Dokmee
DossierApp
The DossierApp connector allows you to create a list of File Cabinets or Folders from DossierApp
Dropbox
The Dropbox picklist allows you to create a list by making a live connection with Dropbox and
retrieve any kind of data there
Dynamics NAV
The Dynamics picklist allows you to create a list by making a live connection with Dynamics and
retrieve any kind of data there
ELO
The ELO picklist allows you to create a list by making a live connection with ELO and retrieve any
kind of data there
Email
The Email picklist allows you to create a list of email addresses by making a live connection with
your Active Directory or Exchange
Evernote
The Evernote picklist allows you to create a list of Notebooks or notes from Evernote
Google Drive
The Google Drive connector allows you to create list of folders within Google Drive
InfinityLaw
The InfinityLaw picklist allows you to create a list by making a live connection with InfinitiLaw and
retrieve any kind of data there
Infotraq
The Infotraq picklist allows you to create a list of folders from Infotraq
LEAP
The Leap Matter LIst return picklist allows you to create a list of folders from Leap
MediaFire
The MediaFire picklist allows you to create a list of folders from MediaFire
M-Files
The M-Files picklist allows you to create a list of Vaults, Classes, Properties or Property Values
from M-Files
Nedap Ons
The Nedap Ons picklist allows you to create a list of Vaults, Classes, Properties or Property
Values from Nedap Ons
OliBox
The OliBox picklist allows you to create a list of Vaults, Classes, Properties or Property Values
from OliBox
OneDrive
The OneDrive picklist allows you to create a list of folders or items from your OneDrive
OneDriveForBusiness
The OneDrive for Business picklist allows you to create a list of folders or items from your
OneDrive and OneDrive for Business
Print
The Print picklist allows you to create a list of printer or property of the printers from your server
Raet
The Raet you Force picklist allows you to create a list of folders from Raet
Scanshare Repository
The Scanshare Repository picklist allows you to create a list of folders from your Scanshare
Repository
Sentral
The Sentral picklist allows you to create a list of folders from Sentral
Citrix ShareFile
The Citrix ShareFile picklist allows you to create a list of folders from Citrix ShareFile
Sharepoint
The Sharepoint picklist allows you to create a list of libraries or folders from Sharepoint
Regas
The Regas picklist allows you to create a list of libraries or folders from Regas
Records Manager
The Records Manager picklist allows you to create a list of Document Types, People or
Containers from HP Records Manager
store+find
The store+find picklist allows you to create a list of libraries or folders from store + find
WebDAV
The WebDAV picklist allows you to create a list of folders from WebDAV
Folder Browse
The folder browse list allows you to select a folder from the panel of the MFP
Windream
The Windream picklist allows you to create a list of folders or list of objects from Windream
Worksite
The Worksite picklist allows you to create a list of either Document classes, Folders, Clients or
cases from Worksite
Xero
The Xero picklist allows you to create a list of Accounts, Bank Transactions, Bank Transfers,
Contacts, Credit Notes, Invoices, Manual Journal, Receipts or Repeating Invoices from Xero
XPLAN
The XPLAN picklist allows you to create a list of Clients from XPLAN
3.2.4.1.23.1 Static
Static
When you open the static menu and click on the + to add a new item, a new screen appears in
which you can add new items by again using the + or delete items by selecting them and press -
You can also import a static picklist by pressing the import button. Allowed filetypes for import are .
txt and .CSV
You will notice that there is a distinction between the Displayed value and the Returned value. In
this example, the full name of the document type will be displayed on the Multifunctional. But
when the user selects e.g. Letters from the list, then the variable %DOCUMENT_TYPE% will contain the
value LTR, which may be convenient if we want to use this as a (sub)folder name.
NOTE: If you want to use Displayed value as Returned value, just leave the value for Returned
empty.
3.2.4.1.23.2 SQL
SQL
SQL enables you to set up a dynamic connection to a database containing the items which should
be displayed in the list. When you open the sql menu a new screen appears which looks like this:
Connection string
Enter a connection string here select it by using the Get DSN function, use the wizard button to
browse to the string, or select the variable that should contain the right string
Query
Enter the right Query here, use the Get table function to select the table, or select a variable that
contains the right table
Column displayed and Column returned
Enter or select the displayed and returned column value here.
3.2.4.1.23.3 Script
Script
A script picklist allows you to basically create a list by getting data from almost everywhere. It
executes as a standard VB script which can perform any operatiopn and create a list from the data
the script will return in the RESULT variable. The format of the data must be a string similar to the
explicit picklist import format, semicolon separated list and optionally ## separated values for Double
Values picklists.
E.g.
Value1##Value1Returned;Value2;Value3;Valu4##Value4Returned
Path
Browse to or enter the path where the script can be found. The script should always set the
variable return to a value which contains the items to be displayed.
An example of a very simple script would be
'Sample script
'Put your own code in here, just keep in mind that RESULT
'is reserved to return the items do be displayed
The semi-colon separates the items in the picklist. This example will create a picklist with three
items to choose from, and the return value will be the selected item.
If you would like to display a long description, but need a shorter return value, you will have to use
"##" as a separator between the list value and its return value, as in the example below:
'Sample script
'Put your own code in here, just keep in mind that RESULT
'is reserved to return the items do be displayed
which will return "Pur" when the user selects "Purchase order" from the picklist.
Code
In this field you can manually enter a script or use variables to use one.
3.2.4.1.23.4 XML
XML
An XML picklist allows to build a list by fetching data from any XML files with the standard XPath
query language.
Path
By selecting the button on the right, you can browse to the location of an XML file.
Element displayed
Enter or select an element which determines the value to display to the user.
Element returned
Enter or select an element which determines the value which will be returned in case of Double
Value picklists. It can be omitted when Double Value picklists are not used.
Url
Enter the Afas Online Url here, or click on the Variables button on the right, to select a variable
which will contain the Url.
Subscriber
Enter a subscriber here, or click on the Variables button on the right, to select a variable which
will contain the Subscribe.
Token
Enter the token here, or click on the Variables button on the right, to select a variable which will
contain the Token.
GetConnector
Enter a GetConnector here, or click on the Variables button on the right, to select a variable
which will contain the GetConnector.
Filter
Enter a filter to use here or select a variable which will contain the filter.
Example of the enter filter:
<Filters><Filter FilterId="Filter 1"><Field FieldId="Medewerker" OperatorType="1">FloorA</
Field></Filter></Filters>
This filter text will work for a GetConnector which returns the column Medewerker and it has a
value of FloorA. Operator 1 is Equal to, so this filter will return only a match with the provided value
(which can be a variable coming from another question to be dynamic). Of course you can also add
more fields.
Operators are:
Operat Operation Example with the value 'NL' (only the filtering rule is specified)
or
1 is equal to NL
2 is greater than or NL
equal to
3 is smaller than or Nl
equal to
4 exceeds NL
5 is less than NL
6 Text found in field %NL%
7 Text does not appear %NL%
in field
8 field is empty
The GetConnector can be used in the storing option. For all options to store in Afas Online, please
refer to the Afas Online connector chapter.
3.2.4.1.23.6 Affinity
Affinity
The Affinity connector allows you to create a list of employees, matters, phonebook or Document
Types / Folders from Affinity.
For a detailed description of all the fields displayed, please refer to the Affinity connector chapter.
AccessKey ID
Enter the AccesKey Id (generated from Amazon) here, or click on the Variables button on the
right, to select a variable which will contain the Id.
AccessKey Secret
Enter the AccessKey Secret (generated from Amazon) to use here, or click on the Variables
button on the right, to select a variable which will contain the Secret.
Check login
If you select this button,Scanshare Enterprise V4 will try to establish a connection with Amazon
AWS using the AccessKey ID and Secret you provided above.
Bucket (only return type Folder)
Select a bucket to retrieve folders from, or click on the Variables button on the right, to select a
variable which will contain the bucket.
Folder (Only for return type folder)
If you want a list of subfolders, you can enter or browse to a Folder here, or click on the Variables
button on the right, to select a variable which will contain the folder. If left empty, a list of all folder
in the selected bucket will be shown.
Return Type
Select the return type here, this can be Buckets or Folders. Depending on the type selected,
fields will be enabled.
For a detailed description of the connector displayed, please refer to the Amazon AWS connector
description.
3.2.4.1.23.8 Box
Box
The Box connector allows you to create a list of folders or sub-folders within Box.
Username
Enter your Box email address here, or click on the Variables button on the right, to select a
variable which will contain the email address.
PIN
Enter your Box PIN here, or click on the Variables button on the right, to select a variable which
will contain the PIN. (PIN will be created in OAuth User settings)
Check login
If you select this button, Scanshare Enterprise V4 will try to establish a connection with Box using
the username and password you provided above. When the connection could be made, a 'OK' will
appear on the bottom of the screen. if not the message: 'The provided user information is not valid'
will appear.
Folder
Enter the main folder to browse in Box, select a folder by pressing the browse folders button or
click on the Variables button on the right, to select a variable which will contain the Foldername,
if the folder doesn't exist, it will be created automatically. If you leave the folder field empty, a list
of all root folders will be shown.
Filter
Enter your Box folder filter here, or click on the Variables button on the right, to select a variable
which will contain the filter.
For a detailed description of the connector displayed, please refer to the Box connector description.
3.2.4.1.23.9 DocuWare
DocuWare
The DocuWare connector allows you to create a list of File Cabinets or Web Baskets from
DocuWare.
Url
Enter the Docuware Url here, or click on the Variables button on the right, to select a variable
which will contain the Url.
For a detailed description of the connector displayed, please refer to the Docuware connector
description.
3.2.4.1.23.10Dokmee
Dokmee
The Dokmee connector allows you to create a list of Cabinets or Folders from Dokmee.
Cloud
When enabled you can connect with your Dokmee cloud account.
Username
Enter your Dokmee Username here, or click on the Variables button on the right, to select a
variable which will contain the username.
Password
Enter your Dokmee Password here, or click on the Variables button on the right, to select a
variable which will contain the password.
Check login
If you select this button,Scanshare Enterprise V4 will try to establish a connection with Dokmee
using the username and password you provided above. When the connection could be made, a '
OK' will appear on the bottom of the screen.
Cabinet
Select a Cabinet here, or click on the Variables button on the right, to select a variable which will
contain the Cabinet. By pressing the update button a list of available Cabinets will be available.
Folder
Write a folder or select a folder by pressing the browse folders button or click on the Variables
button on the right, to select a variable which will contain the Foldername.
Return type
Select which list you want returned. This can either be a Cabinet or a Folder.
For a detailed description of the connector displayed, please refer to the Dokmee connector
description.
3.2.4.1.23.11Dropbox
Dropbox
The Dropbox picklist allows you to create a list by making a live connection with Dropbox and
retrieve any kind of data there.
Username
Enter your Dropbox email address here, or click on the Variables button on the right, to select a
variable which will contain the email address.
Password
Enter your Dropbox password here, or click on the Variables button on the right, to select a
variable which will contain the password.
Check login
If you select this button, Scanshare Enterprise V4 will try to establish a connection with Dropbox
using the username and password you provided above. When the connection could be made, a '
OK' will appear on the bottom of the screen. if not the message: 'The provided user information is
not valid' will appear.
Folder
Enter the folder to upload to Dropbox, select a folder by pressing the browse folders button or
click on the Variables button on the right, to select a variable which will contain the Foldername,
if the folder doesn't exist, it will be created automatically.
Filter
Enter your Dropbox folder filter here, or click on the Variables button on the right, to select a
variable which will contain the filter.
Use proxy
If your administrator has set up a proxy for your internet connections, you should check this
option and provide proxy details by selecting the Proxy settings button on the right
Proxy settings
If you select this button, a new window will appear where you can enter proxy settings details:
Address
The IP address of the proxy server
Port
The port number which is used by the proxy
Note: ask your administrator for help in order to provide correct proxy settings to
Scanshare Enterprise V4.
For a detailed description of connector, please refer to the dropbox connector chapter.
3.2.4.1.23.12Dynamics NAV
Dynamics NAV
The Dynamics NAV connector allows you to create a list of Customers, Vendors, Sales invoices,
Sales orders, purchase invoices or purchase orders from Dynamics NAV.
Server
Enter the Dynamics NAV server address here, or click on the Variables button on the right, to
select a variable which will contain the Server address.
Database
Enter the database you want to use here, or click on the Variables button on the right, to select
a variable which will contain the Database.
Username and Password
Enter a username and password with admin rights here, or click on the Variables button on the
right, to select a variable which will contain the Username or Password.
Trusted connection
When enabled, a trusted connection will be used.
Test Connection
If you select this button, Scanshare Enterprise V4 will try to establish a connection with Dynamics
NAV using the username and password you provided above.
Company name
Enter the desired company name here, or click on the Variables button on the right, to select a
variable which will contain the company name. Note that the company must already exist in your
Dynamics NAV environment.
Return type
Select which list you want to have returned. You can choose either Customers, Vendors, Sales
Invoices, Sales Orders, Purchase invoices or Purchase orders.
For a detailed description of the connector displayed, please refer to the Dynamics NAV connector
description.
3.2.4.1.23.13ELO
ELO
The ELO picklist allows you to create a list of items from ELO.
Server
Enter the server address here, or click on the Variables button on the right, to select a variable
which will contain the address. You can find ELO index server web application in ELO application
manager page:
Username
Enter your ELO username here, or click on the Variables button on the right, to select a variable
which will contain the username.
Password
Enter your ELO password here, or click on the Variables button on the right, to select a variable
which will contain the password.
For a detailed description of the connector displayed, please refer to the ELO connector description.
3.2.4.1.23.14Email
Email
The Email picklist allows you to create a list of email addresses by making a live connection with
your Active Directory, Exchange or Office 365.
Retrieve from
Specify from where you want to retrieve email addresses. Available options are Active Directory,
Exchange or Office 365.
Filter
Enter a filter here, or click on the Variables button on the right, to select a variable which will
contain the filter.
The filter is just a free text filter in both Exchange and AD types, means you can type in anything
which exists in the CN (for AD) or Display Name (for Exchange).
AD is performing a search in the AD tree, so can get any user present in the tree. Exchange is
performing a search in the contacts of the provided mail box,
so if you perhaps are logging in as Admin also for the Exchange type I guess you get no results
because the Admin as no contacts.
For a detailed description of the connector displayed, please refer to the Email connector
description.
3.2.4.1.23.15Evernote
Evernote
The Evernote picklist allows you to create list of notebooks or notes from Evernote.
Username
Enter your Evernote username here, or click on the Variables button on the right, to select a
variable which will contain the email address.
Password
Enter your Evernote password here, or click on the Variables button on the right, to select a
variable which will contain the password.
Test Connection
If you select this button, Scanshare Enterprise V4 will try to establish a connection with Evernote
using the username and password you provided above.
Return Type
Select the type of list you would like to return, this can either be Notebook or Note.
For more information about the Evernote connector, please refer to the Evernote connector chapter.
3.2.4.1.23.16DossierApp
DossierApp
The DossierApp picklist allows you to create list of notebooks or notes from DossierApp.
Url
Enter your DossierApp URL here, or click on the Variables button on the right, to select a
variable which will contain the URL.
Return Type
Select the type of Dossier you would like to return.
Filter
Enter your DossierApp type filter here, or click on the Variables button on the right, to select a
variable which will contain the filter.
For more information about the Evernote connector, please refer to the Evernote connector chapter.
3.2.4.1.23.17Google Drive
Google Drive
The Google Drive picklist allows you to create list of folders within Google Drive.
Username
Enter your Google Drive email address here, or click on the Variables button on the right, to
select a variable which will contain the email address.
Password
Enter your Google Drive password here, or click on the Variables button on the right, to select a
variable which will contain the password.
Check login
If you select this button,Scanshare Enterprise V4 will try to establish a connection with Google
Drive using the username and password you provided above. When the connection could be made,
a 'OK' will appear on the bottom of the screen. if not the message: 'The provided user information
is not valid' will appear.
Folder
Enter the main folder to browse in Google Drive, select a folder by pressing the browse folders
button or click on the Variables button on the right, to select a variable which will contain the
Foldername, if the folder doesn't exist, it will be created automatically. If you leave the folder field
empty, a list of all root folders will be shown.
Filter
Enter your Google Drive folder filter here, or click on the Variables button on the right, to select
a variable which will contain the filter.
Use proxy
If your administrator has set up a proxy for your internet connections, you should check this
option and provide proxy details by selecting the Proxy settings button on the right
Proxy settings
If you select this button, a new window will appear where you can enter proxy settings details:
Address
The IP address of the proxy server
Port
The port number which is used by the proxy
Note: ask your administrator for help in order to provide correct proxy settings to
Scanshare Enterprise V4.
For a detailed description of the connector displayed, please refer to the Google Drive connector
description.
3.2.4.1.23.18InfinityLaw
InfinityLaw
The InfinityLaw picklist allows you to create a list of Document Types, Clients, Matters, Deeds,
Users, Names, Team Departments or Authors from InfinityLaw.
Server
Enter the server address here, or click on the Variables button on the right, to select a variable
which will contain the address.
Database
Enter the database to use here, or click on the Variables button on the right, to select a variable
which will contain the Database.
Username and Password
Enter a username and password with admin rights here, or click on the Variables button on the
For more information about the connector, please refer to the InfinityLaw connector chapter.
3.2.4.1.23.19Infotraq
Infotraq
The Infotraq picklist allows you to create a list of folders from Infotraq.
Project Name
Enter the name of the Project to use, or click on the Variables button on the right, to select a
variable which will contain the name of the Project.
Cabinet
Select the Cabinet, a list will appear after pressing the update button with all available Cabinets.
Or click on the Variables button on the right, to select a variable which will contain the Cabinet
Test connection
If you select this button, Scanshare Enterprise V4 will try to establish a connection with Infotraq
using the username and password you provided above. If the connection can not be made, please
For a detailed description of the connector, please refer to the Infotraq connector description
Server
Select the needed server type here. Select one from Live, LiveB and Test.
Username
Enter your LEAP username here, or click on the Variables button on the right, to select a
variable which will contain the username.
Password
Enter your LEAP password here, or click on the Variables button on the right, to select a
variable which will contain the password.
For a detailed description of the connector displayed, please refer to the LEAP connector
description.
3.2.4.1.23.21M-Files
M-Files
The M-Files picklist allows you to create list of Vaults, Classes, Properties or Property Values from
M-Files.
Address
Enter the Address (URL) to your M-Files server here, or click on the Variables button on the
right, to select a variable which will contain the address.
Username
Enter your M-Files username here, or click on the Variables button on the right, to select a
variable which will contain the Username.
Password
Enter your M-Files password here, or click on the Variables button on the right, to select a
variable which will contain the password.
Windows Authentication
If authentication needs to be done using windows authentication, enable this option. If disabled,
internal M-Files authentication will be used.
Return Type
Select the type of list you would like to return, this can either be Vaults, Classes, Properties or
Property Values. Depending on the Return Type selected other options will be available.
Vaults
Classes
Property
Workflows
For more information about the M-Files connector, please refer to the M-Files connector chapter.
3.2.4.1.23.22MediaFire
MediaFire
The MediaFire picklist allows you to create a list of folders or subfolders from MediaFire.
Username
Enter your MediaFire Username here, or click on the Variables button on the right, to select a
variable which will contain the username.
Password
Enter your MediaFire password here, or click on the Variables button on the right, to select a
variable which will contain the password.
Test Connection
If you select this button, Scanshare Enterprise V4 will try to establish a connection with MediaFire
using the username and password you provided above.
Folder
Enter the folder to browse from MediaFire, or browse to the desired main folder. if left empty, all
root folders will be displayed.
Folder key
Enter your Folder key here, or click on the Variables button on the right, to select a variable
which will contain the Folder Key.
For a detailed description of the connector displayed, please refer to the MediaFire connector
description.
3.2.4.1.23.23Nedap Ons
Nedap Ons
The Nedap picklist allows you to create list of notebooks or notes from Nedap.
Environment
Select your Ndap Environment (Development, Staging, Live).
Certificate
Insert your Ndap Certificate here or click Browse for find it in your server folder or click on the
Variables button on the right, to select a variable which will contain the path of the certificate.
Password
Enter your Ndap password here, or click on the Variables button on the right, to select a variable
Check login
If you select this button, Scanshare Enterprise V4 will try to establish a connection with Ndap
using the username and password you provided above.
Return Type
Select the type of list you would like to return, this can either be Empliyees, Clients and Expertise
Profiles.
Filter type
Select your Filter type here, it optimize the search for the underlying filter field.
Filter
Enter your Ndap Ons filter here, or click on the Variables button on the right, to select a variable
which will contain the filter.
3.2.4.1.23.24OliBox
OliBox
The OliBox connector allows you to create a list of File Cabinets or Web Baskets from OliBox.
Url
Enter the OliBox Url here, or click on the Variables button on the right, to select a variable which
will contain the Url.
Username and Password
Enter a username and password with admin rights here, or click on the Variables button on the
right, to select a variable which will contain the Username or Password.
Folder
Enter the main folder to browse in OliBox, select a folder by pressing the browse folders button
or click on the Variables button on the right, to select a variable which will contain the
Foldername, if the folder doesn't exist, it will be created automatically. If you leave the folder field
empty, a list of all root folders will be shown.
3.2.4.1.23.25OneDrive
OneDrive
The OneDrive connector allows you to create a list of folders or sub-folders within OneDrive.
Username
Enter your OneDrive email address here, or click on the Variables button on the right, to select
a variable which will contain the email address.
PIN
Enter your OneDrive PIN here, or click on the Variables button on the right, to select a variable
which will contain the PIN. (PIN will be created in OAuth User settings)
Check login
If you select this button, Scanshare Enterprise V4 will try to establish a connection with OneDrive
using the username and password you provided above. When the connection could be made, a '
OK' will appear on the bottom of the screen. if not the message: 'The provided user information is
not valid' will appear.
Folder
Enter the main folder to browse in OneDrive, select a folder by pressing the browse folders
button or click on the Variables button on the right, to select a variable which will contain the
Foldername, if the folder doesn't exist, it will be created automatically. If you leave the folder field
empty, a list of all root folders will be shown.
Filter
Enter your OneDrive folder filter here, or click on the Variables button on the right, to select a
variable which will contain the filter.
For a detailed description of the connector displayed, please refer to the OneDrive connector
description.
Username
Enter your OneDrive for Business email address here, or click on the Variables button on the
right, to select a variable which will contain the email address.
PIN
Enter your OneDrive for Business PIN here, or click on the Variables button on the right, to
select a variable which will contain the PIN. (PIN will be created in OAuth User settings)
Check login
If you select this button, Scanshare Enterprise V4 will try to establish a connection with OneDrive
for Business using the username and password you provided above. When the connection could
be made, a 'OK' will appear on the bottom of the screen. if not the message: 'The provided user
information is not valid' will appear.
Folder
Enter the main folder to browse in OneDrive for Business, select a folder by pressing the browse
folders button or click on the Variables button on the right, to select a variable which will
contain the Foldername, if the folder doesn't exist, it will be created automatically. If you leave the
folder field empty, a list of all root folders will be shown.
Filter
Enter your OneDrive for Business folder filter here, or click on the Variables button on the right,
to select a variable which will contain the filter.
For a detailed description of the connector displayed, please refer to the OneDrive for Business
connector description.
Address
Enter the Address (URL) to your OpenText Content Server server here, or click on the Variables
button on the right, to select a variable which will contain the address.
Username
Enter your OpenText Content Server username here, or click on the Variables button on the
right, to select a variable which will contain the Username.
Password
Enter your OpenText Content Server password here, or click on the Variables button on the
right, to select a variable which will contain the password.
Check login
If you select this button,Scanshare Enterprise V4 will try to establish a connection with OpenText
Content Server using the username and password you provided above.
Return Type
Select the type of list you would like to return, this can either be Containers, Categories or
Attributes. Depending on the Return Type selected other options will be available.
For more information about the OpenText Content Server connector, please refer to the OpenText
connector chapter.
3.2.4.1.23.28Orbeon
Orbeon
he Orbeon connector picklist allows you to create a matter list.
Username
Enter your OneDrive email address here, or click on the Variables button on the right, to select
a variable which will contain the email address.
PIN
Enter your OneDrive PIN here, or click on the Variables button on the right, to select a variable
which will contain the PIN. (PIN will be created in OAuth User settings)
Check login
If you select this button, Scanshare Enterprise V4 will try to establish a connection with OneDrive
using the username and password you provided above. When the connection could be made, a '
OK' will appear on the bottom of the screen. if not the message: 'The provided user information is
not valid' will appear.
Folder
Enter the main folder to browse in OneDrive, select a folder by pressing the browse folders
button or click on the Variables button on the right, to select a variable which will contain the
Foldername, if the folder doesn't exist, it will be created automatically. If you leave the folder field
empty, a list of all root folders will be shown.
Filter
Enter your OneDrive folder filter here, or click on the Variables button on the right, to select a
variable which will contain the filter.
For a detailed description of the connector displayed, please refer to the OneDrive connector
description.
3.2.4.1.23.29PlacePoint
Placepoint
The PlacePoint picklist allows you to create a list of libraries or folders from PlacePoint.
Enter the name of the PlacePoint site address you want to upload to. If you need to connect to an
Office 365 website select the checkbox on the right.
Use proxy
If your administrator has set up a proxy for your internet connections, you should check this
option and provide proxy details by selecting the Proxy settings button on the right
Proxy settings
If you select this button, a new window will appear where you can enter proxy settings details:
Address
The IP address of the proxy server
Port
The port number which is used by the proxy
Note: ask your administrator for help in order to provide correct proxy settings to
Scanshare Enterprise V4.
Return Type
Select the type of list to display. THis can either be List / Library, Folder or List items. Default
return format is ID;#Value
List / Library
If a connection can be made with PlacePoint, using the settings you provided in the previous
entries, then you can select this button, which will give you a list of available Lists/Libraries, from
which you can select one.
Note: this may take quite some time, during which nothing seems to happen!
Folder
Enter the folder to upload to PlacePoint, select a folder by pressing the browse folders button or
click on the Variables button on the right, to select a variable which will contain the Foldername,
if the folder doesn't exist, it will be created automatically.
3.2.4.1.23.30PowerOffice
PowerOffice
The PowerOffice allows you to create list of notebooks or notes from PowerOffice.
Environment
Select your PowerOffice Environment (Demo or Production).
Client Key
Insert your PowerOffice Client Key here or click Browse for find it in your server folder or click on
the Variables button on the right, to select a variable which will contain the path of the certificate.
Check login
If you select this button, Scanshare Enterprise V4 will try to establish a connection with
PowerOffice using the Client Ket and Environment above.
Return Type
Select the type of list you would like to return, this can either be Customers, Suppliers and
BankAccounts.
Filter
Enter your PowerOffice filter here, or click on the Variables button on the right, to select a
variable which will contain the filter.
3.2.4.1.23.31Print
Print
The Print allows you to create a list of Printer or Properties or Property values from printer.
Return type
Select which list you want to have returned. You can choose either Printer or Properties or
Property values.
Printer (only available with return type Properties)
Select the property of the printer to display, or click on the Variables button on the right, to
select a variable which will contain the property.
Property (only available with return type Property values)
Select the property value of the printer property to display, or click on the Variables button on
the right, to select a variable which will contain the property value.
For a detailed description of the connector displayed, please refer to the Print connector description.
3.2.4.1.23.32Raet Youforce
Raet YouForce
The Raet YouForce picklist allows you to create a list of Categories, Products, Employees or
Contracts from Raet YouForce.
Certificate
Enter or browse to the location of the certificate which is also used when first Authenticating to
Raet Youforce, or click on the Variables button on the right, to select a variable which will
contain the certificate (incl location).
Password
Enter your Certificate password here, or click on the Variables button on the right, to select a
variable which will contain the password.
Return type
Select which list you want to have returned. You can choose either Category, Product, Employee
or Contract.
Employee (only available with list types Product and Contract)
Select the employee where you want to display the picklist from, or click on the Variables button
on the right, to select a variable which will contain the Employee. By pressing the update button, a
list of available employees will be displayed.
Out of service employees
When enabled, the list of employees will also display all out of service employees
For a detailed description of the connector displayed, please refer to the Raet YouForce connector
description.
3.2.4.1.23.33Records Manager
Server
Enter the server address here, or click on the Variables button on the right, to select a variable
which will contain the address.
Port
Enter the Port to use here, or click on the Variables button on the right, to select a variable
which will contain the Port, default is 1137.
Dataset ID
Enter a Dataset ID here, or click on the Variables button on the right, to select a variable which
will contain the ID.
Connected as
Enable this function if you want to connect as a specific user.
Username and Password
When connected as is enabled, enter a username and password here, or click on the Variables
button on the right, to select a variable which will contain the Username and Password.
Type
Select the type of list to be displayed. You can choose Document Types, People and Container.
Filter
Specify a filter here, or click on the Variables button on the right, to select a variable which will
contain the filter.
Return type (only available for Container)
Select the type to return here, you can choose either Name or Number.
Client installation
Enter or browse to the path where the client installation can be found.
For a detailed description of the connector, please refer to the HP connector description
3.2.4.1.23.34Regas
Regas
The Regas picklist allows you to create a list of Patient, Employee and case from Regas on line.
Organization
Enter the organization number of a user who has access to the Regas server.
Filter
Enter your Regas filter here, or click on the Variables button on the right, to select a variable
which will contain the filter.
Check Login
If you select this button, Scanshare Enterprise V4 will try to establish a connection with Regas
using the username and password you provided above.
Return type
Select which list you want to have returned. You can choose either Employee, Patient and Case.
3.2.4.1.23.35Scanshare Repository
Scanshare Repository
The Scanshare Repository connector allows you to create a list of folders or sub-folders within
Scanshare Repository.
Username
Enter your Scanshare username here, or click on the Variables button on the right, to select a
variable which will contain the username.
Password
Enter your Scanshare password here, or click on the Variables button on the right, to select a
variable which will contain the password.
Check login
If you select this button Scanshare will try to establish a connection with Scanshare repository
using the username and password you provided above. When the connection could be made, a '
OK' will appear on the bottom of the screen. if not the message: 'Login Failed' will appear.
Folder
Enter the main folder to browse in Scanshare repository, select a folder by pressing the browse
folders button or click on the Variables button on the right, to select a variable which will
contain the Foldername, if the folder doesn't exist, it will be created automatically. If you leave the
folder field empty, a list of all root folders will be shown.
Filter
Enter your Scanshare Repository folder filter here, or click on the Variables button on the right,
to select a variable which will contain the filter.
For a detailed description of the connector displayed, please refer to the Scanshare Repository
connector description.
3.2.4.1.23.36Sentral
Sentral
The Sentral connector allows you to create a list of available folders.
Server
Enter your Orbeon server here.
API Key
Enter your Orbeon API Key here.
Parent Folder
Enter the folder to upload to OliBox, or click on the Variables button on the right, to select a
variable which will contain the Foldername, if the folder doesn't exist, it will be created
automatically
3.2.4.1.23.37Citrix ShareFile
Citrix ShareFile
The Citrix ShareFile picklist allows you to create a list of folders or sub-folders within Citrix
ShareFile.
Username
Enter your Citrix ShareFile Username here, or click on the Variables button on the right, to
select a variable which will contain the username.
Password
Enter your Citrix ShareFile Password here, or click on the Variables button on the right, to select
a variable which will contain the password.
Sub Domain
Enter your Citrix ShareFile SubDomain here, or click on the Variables button on the right, to
select a variable which will contain the subdomain. You can retrieve you subdomain value from your
Citrix ShareFile account settings.
Control Plane
Enter your Citrix ShareFile control plane here, or click on the Variables button on the right, to
select a variable which will contain the control plane. You can retrieve your control plane value from
your Citrix ShareFile home page link.
(e.g. https://subdomain.sharefile.com/app/#home/ ). The Control Plane field is already set with
the default value (sharefile.com)
Check login
If you select this button, Scanshare Enterprise V4 will try to establish a connection with Citrix
ShareFile using the username and password you provided above. When the connection could be
made, a 'OK' will appear on the bottom of the screen. if not the message: 'The provided user
information is not valid' will appear.
Folder
Select the folders where you want to display the picklist from, or click on the Variables button on
the right, to select a variable which will contain the Folder.
For a detailed description of the connector displayed, please refer to the Citrix ShareFile connector
description.
3.2.4.1.23.38Sharepoint
Sharepoint
The Sharepoint picklist allows you to create a list of libraries or folders from Sharepoint.
Use proxy
If your administrator has set up a proxy for your internet connections, you should check this
option and provide proxy details by selecting the Proxy settings button on the right
Proxy settings
If you select this button, a new window will appear where you can enter proxy settings details:
Address
The IP address of the proxy server
Port
The port number which is used by the proxy
Note: ask your administrator for help in order to provide correct proxy settings to
Scanshare Enterprise V4.
Return Type
Select the type of list to display. THis can either be List / Library, Folder or List items. Default
return format is ID;#Value
List / Library
If a connection can be made with SharePoint, using the settings you provided in the previous
entries, then you can select this button, which will give you a list of available Lists/Libraries, from
which you can select one.
Note: this may take quite some time, during which nothing seems to happen!
Folder
Enter the folder to upload to Sharepoint, select a folder by pressing the browse folders button or
click on the Variables button on the right, to select a variable which will contain the Foldername,
if the folder doesn't exist, it will be created automatically.
on the right, to select a variable which will contain the parent folder. This field only needs to be
filled if the List items have a folder structure, so you will be able to pick up sub-folders.
For a detailed description of the connector, please refer to the Sharepoint connector chapter.
3.2.4.1.23.39WebDAV
WebDAV
The WebDAV picklist allows you to create a list of Folders from your WebDAV server.
Server
Enter the address of the WebDAV server here, or click on the Variables button on the right, to
select a variable which will contain the address.
Username and Password
Enter a username and password with admin rights here, or click on the Variables button on the
right, to select a variable which will contain the Username or Password.
Folder
Select a folder by using the Browse button, enter the folder path, or click on the Variables button
on the right, to select a variable which will contain the Folder (incl. path) to show a list of sub-
folders. If you leave the folder field empty, a list of all root folders will be shown.
For a detailed description of the connector displayed, please refer to the WebDAV connector
description.
3.2.4.1.23.40Folder Browse
Folder Browse
The folder browse list allows you to select a folder from the panel of the MFP.
Here you can configure the startpath where to browse to. If Use full path as returned value is
checked, the variable created will contain the full path. If unchecked, only the folder name will be
used as variable.
For a detailed description of the connector displayed, please refer to the Windows File System
connector description.
3.2.4.1.23.41Windream
Windream
The Windream picklist allows you to create a list of Objects or Folders from Windream.
Domain
Enter the name of the Windream domain you want to upload to.
Domain
Enter the name of the Windream server you want to upload to.
Check Connection
If you select this button, Scanshare Enterprise V4 will try to establish a connection with
Windream using the username and password you provided above.
Return type
Select which list you want to have returned. You can choose either Objects or Folders.
Note: in order to use Windream connector, your Scanshare Enterprise V4 server and Windream
server needs to be installed on the same machine.
For a detailed description of the connector displayed, please refer to the Windream connector
description.
3.2.4.1.23.42Worksite
Worksite
The Worksite picklist allows you to create a list of either Document classes, Folders, Clients or
cases from Worksite.
Server
Enter the IP address of the server where Worksite is installed.
Database
Enter the name of the database to use, or click on the Variables button on the right, to select a
variable which will contain the name of the database.
Username and Password
Enter your Worksite Username and password here, or click on the Variables button on the right,
to select a variable which will contain the username and/or password.
Return Type
Select the type of list to return. You can choose from Document Class, Folder, Client and Case.
"Documet Class", returns the Document Class picklist from the your Worksite server.
"Folder", returns all folders with these options:
Parent Folder
Enter the name of the folder from which you want to start searching (subfolder of
parent), or click on the Variables button on the right, to select a variable which will contain the
name of the folder.
SubFolder
Default to searching in the Sub folders. When disabled, it not search in to
subfolders (All the subfolders recursively down).
Client filter
Enter the filter on client to use, or click on the Variables button on the right, to
select a variable which will contain the filter
Case filter
Enter the filter on matter to use, or click on the Variables button on the right, to
select a variable which will contain the filter
Display Case/Matter
Default the work space and folder name are displayed. When enabled, case/matter
will also be displayed.
It formats the result as follows: Matter \ Folder name, if the matter has a
description instead it shows: Description (Matter) \ Folder name
Display Full Path
Default full path are not displayed. When enabled, full path will also be displayed.
It formats the result with the complete path where it is located: Work space \
COMPLETEPATHFOLDERS \ Folder name
All Workspaces
Default only the work spaces for the logged in user are shown. When enabled all
work spaces will be shown.
If all enabled work spaces can use these additional filters in the Client filter:
WORKSPACE = X limits the work spaces to include in the search, where X
is the start of the work spaces from which to tak e the folders (those in the work spaces that do not
start for the filter are discarded)
FOLDER = X where X is the beginning of the folder name to be inserted in
the results (those that do not start for the filter are discarded)
Filter on
Select whether to filter on Names or ID's
For a detailed description of the connector, please refer to the Worksite connector chapter.
3.2.4.1.23.43Xero
Xero
The Xero picklist allows you to create a list of either Accounts, Bank Transactions, Bank Transfers,
Contacts, Credit Notes, Invoices, Manual Journals, Receipts or Repeating invoices from Xero.
Certificate
Enter the Certificatename (incl path), select the certificate by pressing the browse button or click
on the Variables button on the right, to select a variable which will contain the Certificate.
Certificate Password
Enter the Password for the selected certificate here, or click on the Variables button on the right,
to select a variable which will contain the Password.
Key
Enter the Key here, or click on the Variables button on the right, to select a variable which will
contain the key (Key gets generated after adding the application to Xero and can be found in the
application page).
Secret
Enter the Secret here, or click on the Variables button on the right, to select a variable which will
contain the secret (Secret gets generated after adding the application to Xero and can be found in
the application page).
Return Type
Select the type of list you would like to return, this can either be Accounts, Bank Transactions,
Bank Transfers, Contact, Contact Group, Credit Note, Invoice, Manual Journal, Receipt or Repeating
invoice.
For a detailed description of the connector displayed, please refer to the Xero connector description.
3.2.4.1.23.44XPLAN
XPLAN
The XPLAN picklist allows you to create a list of Clients from XPLAN.
URL
Enter the URL to your XPLAN Site here, or click on the Variables button on the right, to select a
variable which will contain the URL.
Username
Enter your XPLAN username here, or click on the Variables button on the right, to select a
variable which will contain the Username.
Password
Enter your XPLAN password here, or click on the Variables button on the right, to select a
variable which will contain the password.
Check login
If you select this button,Scanshare Enterprise V4 will try to establish a connection with XPLAN
using the username and password you provided above.
Return Type
Select the type of list you would like to return, for now only Clients is available.
Criteria
Enter the Criteria of value here, or click on the Variables button on the right, to select a variable
which will contain the Criteria. Any values containing, ending or starting with the criteria will be
displayed.
ShowId
When enabled, the Client ID will also be displayed in the return list.
For a detailed description of the connector displayed, please refer to the XPLAN connector
description.
3.2.4.2 Processing
After selecting a capturing method, the next step is to process the document.
Possible processing options are:
Annotation
Barcode Reader
Barcode Writer
Image Processing
Data Export
ICR
OMR
Report Generator
Zone OCR
3.2.4.2.1 Annotation
Annotation will allow you to write information onto the scanned document. You may have to used
stamps in the past, to put the Received on ...' on a physical document. With this option, you can do
the same digitally, and much more!
-> general
Load Image
By pressing this button, you can load an example document. Then you can start specifying which
annotation you want to use
Undo and Redo
Allows you to undo or redo any changes made
Delete
Deletes the selected annotation
Edit Object
Lets you edit the selected annotation
Fit
This option will fit the sample document to your screen
One to One
This button will zoom the page to 100%. So the zone drawn is exactly the same size as the
original document
Zoom In / Out
Zoom in or out on your document
Rotate Clockwise / Counter Clockwise
Rotate your sample page either clockwise or counterclockwise
The arrows on he top right of the menu, allow you switch to the next page(s) if the example is a multi
page document.
Annotation can be different on each page.
The lower menubar contains all available annotations. By hovering over the icons, the annotation
name is shown. When an annotation is selected, you can start drawing it on the document.
-> engine
If no barcode is specified, but the module is enabled, all barcodes in the document will be read and
inserted in automatic created variables (%BARCODE01%, %BARCODE02%, ...)
Note: if you process more than one page, the Variables are created for each page, by adding a
dash, a P and an index for the page number, starting with 01 for the first page.
In the top screen you will find multiple options for barcode reading. By hovering over the icons, the
button name is shown.
This button will zoom the page to 100%. So the zone drawn is exactly the same size as the
original document
Zoom In / Out
Zoom in or out on your document
Rotate Clockwise / Counter Clockwise
Rotate your sample page either clockwise or counterclockwise
In the Engine menu, you can select the search and read direction as desired
The barcodes menu after reading barcodes will look like this:
A selected barcode will be highlighted in green. A change settings button will then be available on
the top of the screen. by opening it, a new window will open:
Here you can change the Variable name, barcode type and add a regular expression if needed.
There is also an option to select the encoding method. Possible options are Default, ASCII, Unicode,
BigEndianUnicode, UTF7, UTF8, UTF32 and custom (insert value field).
When selecting a zone, the fixed search region is automatically enabled. If the barcode is not
always in the same zone of the page, this option can be disabled. Then the complete document will
be checked for the barcode.
If the fixed search region is disabled, the selected barcodes will appear red on the sample file.
Also setting to specify on which page the barcode should be read and if the barcode needs to be
used as separator can be specified here. You can find a complete guide on how to set and use a
barcode as separator here.
Regular Expressions is used to filter a specific value. The value will only be recognized if the read
value matches the defined Regular Expression. For example you want to read an invoice number
which always starts with "2011" followed by a four digit number, e.g. 20111321, 20111322 and so
on, you could use a regular expression
\b2011[0-9]{4}\b
For more information on regular expressions, there are many websites, e.g. http://www.
regular-expressions.info/ !
By selecting the barcode line, an option to open it's settings menu will appear.
When opening the setting menu, you can configure the barcode as desired.
Value
Enter the value the barcode should contain here.
Type
Select the type of barcode to be written on the document
Only on page:
Select on which page(s) the barcode should be written.
Note: Each rule when added has a custom text field. When this field is filled with the desired output,
the selected format will not be respected anymore because a custom output has been created.
Contents
You may enter your own text here, or select "VAR" to insert variables
Path(s):
Type or select the output path here, or use a variable to specify the correct path. Multiple paths
can be entered, separated by a semicolon.
Filename
Enter or select a filename for the text file
Permissions
3.2.4.2.5 ICR
Only available with the ABBYY license
ICR (intelligent character recognition) is an advanced optical character recognition (OCR) or — rather
more specific — handwriting recognition system that allows fonts and different styles of handwriting
to be learned by a computer during processing to improve accuracy and recognition levels.
ICR enables you to specify zones on a page where you want to retrieve data from. This can be useful
when for example you want to process order forms automatically. You know each order form looks
the same, and that in the order number is always on a fixed location in the upper right hand side of
the form. ICR lets you do this easily.
Processing is done by specifying zones on the page which contain the required text. This will create
new variables for each defined zone: [ICR_ZONE01], [ICR_ZONE02], [ICR_ZONE03] and so on.
Note: if you process more than one page, the Variables are created for each page, by
adding a dash, a P and an index for the page number, starting with 1 for the first page.
So you would need [ICR_ZONE01_P3], [ICR_ZONE02_P3], [ICR_ZONE03_P3] to refer to the
zones on the third page.
Engine
ZONES
ICR zones settings can be changed by pressing the zones menu and select the tool button .
Here the variable name can be changed, recognition language can be selected and field mark type
can be set. You can also specify on which page(s) the zone(s) should be read.
It is also possible to select multiple languages per workflow by pressing Ctrl and selecting the
desired languages.
UnderlinedText
This value specifies that the text is underlined:
Text in frame
This value specifies that the text is enclosed in a frame:
Gray Boxes
This value specifies that the text is located in white fields on a gray background:
Charbox Series
This value specifies that the field where the text is located is a set of separate boxes:
Simple Comb
This value specifies that the field where the text is located is a comb:
Comb in frame
This value specifies that the field where the text is located is a comb and that this comb is
also the bottom line of a frame:
Partitioned Frame
This value specifies that the field where the text is located is a frame and this frame is split
by vertical lines:
Cells Count
Number of cells in the ICR zones (available only for field mark type with cells).
Reverse
This option mirrors the scanned image
Rotate
This option rotates the image in any specified angle
Fill
Here you can fill the scanned image completely with a specified color
Grayscale
This option allows you to convert your scanned image into grayscale, this can either be 8, 12 or
16 bits per pixel.
Invert
This option inverts all the colors in the scanned image
Histogram Equalize
a method of image processing of contrast adjustment, using the image's histogram. Select the
desired color space to equalize.
Gamma Correct
Non-linear operation used to code and decode luminance. Specify the gamma contrast value to
apply.
Auto Color Level
Applies one of the several types of automatic color leveling to an image. This function is useful for
pre-processing images for the purpose of improving barcode recognition results. Select the type of
color leveling to apply, to make the dark values darker and light values lighter to automatically
enhance shadows and brighten the image.
Color level
Applies color leveling to an image. It changes the image shadows, midtones and highlights. Select
the channel to change and specify the images highlights to be mapped (input) and the value to
which will be mapped (output) with relative gamma value as well.
Intensity detect
This is used to remove colors (especially background) from your scanned image. The option will
filter a specific image to detect colors in a specific intensity range, in a specific color channel(s).
Select the color channel to process and the range of intensity to detect (low~high), filter will
perform a binary segmentation in order to detect the specified intensity range
Change Contrast Brightness Intensity
Applies contrast, brightness and intensity adjustments to enhance the image tonal range. Specify
the amount of contrast / brightness / intensity to remove / add to the image (negative values will
remove, positive values will add)
Change Hue Saturation Intensity
Changes the hue, saturation and brightness of all colors or specific colors in the image. Specify
the amount of hue / saturation / intensity to remove / add to the image (negative values will
remove, positive values will add)
Gaussian Filter
Smooths or blurs an image by applying a Gaussian Filter to the image. Specify the radius of the
area on which the filter is applied
Unsharp Mask
Sharpens the image by applying the unsharp mask. Specify the adjustment factor (in percentage),
the color space in which to apply the mask, the size of the area on which the filter is applied and
the threshold for modifying the original value of the pixel.
Smooth Edges
Smoothes the rough edges in the image. Specify the blur size (percentage) and the threshold to
determine which pixels are edge pixels
Emboss
Creates an image with an embossed appearance. Specify the apparent depth of the 3d effect and
the direction of the apparent light source
Sharpen
Increases or decreases the sharpness of a specific image. Negative values will decrease, positive
values will increase
Anti Aliasing
Reduces distortion in fine patterns. Specify the size of the anti-aliasing mask, the type of filter to
use and the threshold value that indicates which pixels to smooth
Max Filter
Erodes dark objects by the specified amount. Specify the dimensions of the area used for filtering
(Dimension x Dimension) in pixels
Min Filter
Dilates dark objects by the specified amount. Specify the dimensions of the area used for filtering
(Dimension x Dimension) in pixels
Despeckle
Removes speckles from an image.
Blank Page detector
Detects blanc pages and removes them. When enabled, a variable will be created.
Binary Filter
Imposes a binary filter on an image. It performs a user defined effect by using suitable mask.
Spatial Filter
Image operation where each pixel is changed by a function of the intensities of pixels in a
neighborhood.
Border Remove
This option removes the borders of the scanned image. Specify the amount of borders
(percentage) and which one to remove
Dot Remove
Remove all dots from your scanned image. Specify the range in which dots need to be removed
(min size-max size)
Hole Punch Remove
Remove all hole punches from your scanned image. Specify the range in which hole punches need
to be removed (min size-max size), the amount of hole punches can be customized
Line Remove
This option removes all lines from your scanned image. Specify the type of line(s) to remove
(horizontally of vertically) and all parameters to match the desired line(s) to remove
3.2.4.2.7 OMR
OMR (Optical Mark Recognition) is ideal for the automatic recognition of e.g. check boxes on
surveys and tests. But because you can freely define the size and location of the area to check for
content, this may also be used to check forms for any content where a signature has to be entered,
and so on.
Processing is done by specifying zones on the page which contain the required text. This will create
new variables for each defined zone: [OMR_ZONE1] , [OMR_ZONE2] , [OMR_ZONE3] and so on.
Note: if you process more than one page, the Variables are created for each page, by adding a
dash, a P and an index for the page number, starting with 1 for the first page.
OMR zones settings can be changed by pressing the zones menu and select the tool button.
The Variable name and type can be changed here. You can also specify on which page(s) the zone
(s) should be read.
Types to choose from are:
Auto: automatic detection of the markup frames (borders) inside the zone
WithFrame: the zone contains the frames (borders) – means the zone has been token around the
complete box
WithoutFrame: the zone doesn’t contain the frames (borders) – means the zone has been token
inside the markup box
When the recognition area is drawn, the application automatically detects the type and checked/
unchecked.
Engine (Nuance)
Engine (Abbyy)
Zone Type
- Single: Classic OMR to a single zone. Abbyy compared to Nuance is more sensitive and
needs together to set the checkbox type (Empty, Circle, Square and Custom).
Custom is special type because it activates the general view area training mode:
if
you enter a mask 1,2,3,4,5, the result of the first row after OMR would be: 1.
That is, only the entered value of the correct answers returns.
the red area of the group distance , and the dark red zone for the distance
between the rows . It needs to be the space between multiple rows composed by
the same group defined once
(engine will replicate the rows for the number specified in the settings according this
space set) Note: for best work the space needs to take care of white space bounds as well of
the group itself,
e.g. it needs to start after the group zone finishes and ending considering this space as
well in the next row, see attached for better understanding. This because the engine cannot
see where the mark ends inside the group zone,
so we can add automatically another row, with same zone width or height (vertical or
horizontal) after the mentioned space .. so exclusive of the zone width / height.
General
Format
Choose the format of the report (now only available Word).
Path(s)
Enter the path where the output report will be created. You can also enter multiple paths that you
just enter as a ";" between the paths
or select Browse to browse to the right folder. You may also insert variables by selecting the
Variable button on the right, so you would use e.g.
C:\Output\%DOCUMENT_TYPE%\
to store a document to a subfolder based on its document type. Of course in order to do so, you
must first set up a question which lets the user choose the document type!
Filename
Enter the filename for the document to upload, or click on the Variables button on the right, to
select a variable which will contain the filename.
Permissions
Word
Source document
It is the source document composing the base report. The module starts from this document to
insert the configured dynamic data in order to create the final output report (this field is mandatory).
It may also be a white document when using a document template.
Document template
If you want to include special styles, you must include the document template (file .dotx) in this
field with all the styles used so that you can manage them in the mapping later.
It will be applied and merged on the source document.
Mapping
Connection string
Enter a valid datasource connection string here. You may select an existing system configured
DSN by using the Get DSN button, or use the wizard button which guides you in creating a
custom connection string. You can also select the variable that should contain the connection
string.
For example, you can create a connection to an Access Database by using the Wizard, selecting
the MS Access JET Provider, and configure the target .accdb file in the Data Source field:
Content Mapping:
It is used to map the dynamic contents with the source report document variables.
The dynamic content is inserted into the configured datasource according the settings below and
provided into the content mapping. Each content needs to be mapped with the target report
variable. Content may contain server workflow variable if it is composed by dynamic data
processed into the workflow processing (e.g. Questions, Zone OCR, Barcode, etc.).
Note: the dynamic content may contains also not simple text according the map type selected
below.
The report variable (Tag) are written in the form: {[VARIABLENAME]}. The dynamic content map is
configured according this tag.
Tag: In the example you can choose Author, Company, Date, ImportWord, PageBreak, Place,
ScannedImage, Signature.
Search column: in the example enter Tag.
Column: in the example enter Data.
Table: in the example enter Contents.
Type:
- Text: The DB tuple contains text.
- Paragraph: The DB tuple contains text.It will be inserted as a paragraph.
- New Paragraph: The DB tuple contains text.It will be inserted as a new paragraph.
- Image: The DB tuple contains a path to the image, The style parameter here may contain
the dimensions expressed as string "WIDTH: xxx; HEIGHT: xxx".
- Bar Chart: The DB tuple contains instructions on how to generate the chart in this format.
"COLOR: color name; MIN: numericMinimunAsseY MAX: numericMaximunAssey; WIDTH:
graph width; HEIGHT: graph hight; VALUE where VALUE is type in TITLE, VALUE,
and TITLE format can be Omitted if you do not want to write the title on the bar, so it will
only, VALUE (always with the comma to separate the first blank parameter).
- Page Break : The DB tuple can be empty because it is a page break word.
- Word: The DB tuple contains a path to the word file to be inserted at that point (the
content will be perfectly identical).
Processing is done by specifying zones on the page which contain the required text. This will create
new variables for each defined zone: [OCR_ZONE1] , [OCR_ZONE2] , [OCR_ZONE3] and so on.
Note: if you process more than one page, the Variables are created for each page, by adding a
dash, a P and an index for the page number, starting with 1 for the first page.
This button will zoom the page to 100%. So the zone drawn is exactly the same size as the
original document
Zoom In / Out
Zoom in or out on your document
Rotate Clockwise / Counter Clockwise
Rotate your sample page either clockwise or counterclockwise
Engine
Here you can select the engine to use for Zone OCR.
Note: This option is only available if you have an ABBYY license
Recognition Module:
Specifies that the Engine will try to automatically select the most suitable recognition module for
the zone. This is determined just before recognition, according to the zone's filling method and, if
necessary, other settings, most typically the Character Set.
OmniFontMText
ThisThis recognition module recognizes machine-printed text; i.e. text from printed
publications, laser or ink-jet printers and electric typewriters.
Output from mechanical typewriters in good condition may also be acceptable. It should
also be used for Letter or Near Letter Quality output from dot-matrix printers, and can also
be used for Draft Quality.
OmniFontMor
This module recognizes machine-printed text; i.e. text from printed publications, laser or
ink-jet printers and electric typewriters. Output from mechanical typewriters in good
condition may also be acceptable. It should also be used for Letter or Near Letter Quality
(LQ, NLQ) output from dot-matrix printers.
DotMatrix
This module is designed for ONLY draft-quality 9-pin dot-matrix texts. For NLQ or LQ texts,
MatrixMatching
This module is designed to read certain groups of fixed-font characters specially designed
for OCR or imaging applications, in which no two characters have similar shapes. Each
character group has its own filling method. Application areas are in banking, check or
waybill handling, product distribution and document validation, where high accuracy can be
vital. It also handles some non-fixed print styles.
OmniFontPlus2WayVoting
These recognition modules recognize machine-printed text; i.e. text from printed
publications, laser or ink-jet printers and electric typewriters. Output from mechanical
typewriters in good condition may also be acceptable.
The PLUS2WAY and PLUS3WAY modules use voting technology to improve recognition
results.
The PLUS2WAY voting module combines the results from the MOR and MTX modules.
The PLUS3WAY voting module combines the results from the MOR, MTX and FRX
modules.
With either of these two voting modules, the accuracy is considerably better, but recognition
may take significantly more time than any single module.
OmniFontFireWorx
This module recognizes machine-printed text; i.e. text from printed publications, laser or
ink-jet printers and electric typewriters. Output from mechanical typewriters in good
condition may also be acceptable. It should also be used for Letter or Near Letter Quality
(LQ, NLQ) output from dot-matrix printers.
OmniFontPlus3WayVoting
same 2WayVoting
Fill Method:
OmniFont
DraftDotMatrix9
DraftDotMatrix24,
OcrA
OcrB
DotDigit
DashDigit
CMC7
OCR zones settings can be changed by pressing the zones menu and select the tool button.
Here the variable name can be changed, recognition language can be selected and a Regular
expression can be set. You can also specify on which page(s) the zone(s) should be read.
It is also possible to select multiple languages per workflow by pressing Ctrl and selecting the
desired languages
Regular Expressions is used to filter a specific value. The value will only be recognized if the read
value matches the defined Regular Expression. For example you want to read an invoice number
which always starts with "2011" followed by a four digit number, e.g. 20111321, 20111322 and so
on, you could use a regular expression
\b2011[0-9]{4}\b
For more information on regular expressions, there are many websites, e.g. http://www.
regular-expressions.info/
Use as separator
When enabled, the zone can be used for separation. With this option enabled, the regular
expression is required.
Here you will have to specify which value needs to be used in order to separate your documents.
Remove Page
Specify if you want to keep the page used as separator or not.
3.2.4.3 Store
After a document has been captures and processed the final step is to Store the document.
Scanshare Enterprise V4 offers several possibilities to store a document, which are called
connectors.
Afas Online
This connector lets you store a scanned document and upload it directly to Afas Online
Affinity
This connector lets you store a scanned document and upload it directly to Affinity
Amazon
This connector lets you store a scanned document and upload it directly to Amazon AWS
Box
This connector lets you store a scanned document and upload it directly to Box
Database
This connector lets you store a scanned document and upload it directly to your Database
Docuware
This connector lets you store a scanned document and upload it directly to Docuware
Dokmee
This connector lets you store a scanned document and upload it directly to Dokmee
DossierApp
This connector lets you store a scanned document and upload it directly to DossierApp
Dropbox
This connector lets you store a scanned document and upload it directly to Dropbox
Dynamics NAV
This connector lets you store a scanned document and upload it directly to Dynamics NAV
ELO
This connector lets you store a scanned document and upload it directly to ELO
E-mail
This connector lets you store a scanned document and send it by email to a recipient
Evernote
This connector lets you store a scanned document and upload it directly to Evernote
FTP
This connector lets you store a scanned document and upload it directly to your FTP server
Google Drive
This connector lets you store a scanned document and upload it directly to Google Drive
InfinityLaw
This connector lets you store a scanned document and upload it directly to InfinityLaw
Infotraq
This connector lets you store a scanned document and upload it directly to Infotraq
LEAP
This connector lets you store a scanned document and upload it directly to LEAP
MediaFire
This connector lets you store a scanned document and upload it directly to M-Files
M-Files
This connector lets you store a scanned document and upload it directly to M-Files
Nedap Ons
This connector lets you store a scanned document and upload it directly to Nedap Ons
Objective
This connector lets you store a scanned document and upload it directly to Objective
OliBox
This connector lets you store a scanned document and upload it directly to OliBox
OneDrive
This connector lets you store a scanned document and upload it directly to OneDrive
Orbeon
This connector lets you store a scanned document and upload it directly to Orbeon
PlacePoint
This connector lets you store a scanned document and upload it directly to PlacePoint
PowerOffice
This connector lets you store a scanned document and upload it directly to PowerOffice
Practice Evolve
This connector lets you store a scanned document and upload it directly to Practice Evolve
Print
This connector lets you print a scanned document or send document from watch folder or other
capture and print it directly to printer
Raet YouForce
This connector lets you store a scanned document and upload it directly to Raet YouForce
Regas
This connector lets you store a scanned document and upload it directly to Regas
Scanshare Store
This connector lets you store a scanned document and upload it directly to Scanshare Store DMS
Script
The script connector enables you to gain complete control over the actions which will be
performed when a document has been processed. Because you can select a VB Script which has
to be executed, the possibilities are endless
Sentral
This connector lets you store a scanned document and upload it directly to Sentral
Citrix ShareFile
This connector lets you store a scanned document and upload it directly to Citrix ShareFile
Sharepoint
This connector lets you store a scanned document and upload it to your SharePoint or Sharepoint
Office 365 site
Synergy Enterprise
This connector lets you store a scanned document and upload it to Synergy Enterprise
Windream
This connector lets you store a scanned document and upload it directly to Windream
TRIM
This connector lets you store a scanned document and upload it directly to TRIM
WebDAV
This connector lets you store a scanned document and upload it directly to WebDAV
Worksite
This connector lets you store a scanned document and upload it directly to Worksite
Xero
This connector lets you store a scanned document and upload it directly to Xero
XPLAN
This connector lets you store a scanned document and upload it directly to XPLAN
Each connector has a setup screen which consists of two parts, the Output
Settings and the General (connector) Settings. The Output Settings are the
same for every connector, the Connector Settings are different for every
connector.
The main service used by the connectors is the Process Service is always the one
who establish any kind of connection to the third party system interface.
Output Settings are the same for every connector, below an example of the Output Settings.
On the screen, you can see to each profile name next to workflows in which it is used as output
profiles.
Profile name
Enter a descriptive name for the profile, e.g. "Excel", so you can see what kind of output this
profile generates without having to open it.
Type
Selecting this, You may choose the type of document you want to output.
Deskew
Select this option if your scanner creates more or less skewed images. Deskew can only be
processed when the skew angle is less than 45 degrees.
If you select BMP as output format, you will have the following options:
Name
Enter a descriptive name for the profile, e.g. "BMP output", so you can see what kind of output
this profile generates without having to open it.
Deskew
Enable this option if your scanner creates more or less skewed images. Deskew can only be
processed when the skew angle is less than 45 degrees.
If you select ALTO (XML) as output format, you will have the following options:
Name
Enter a descriptive name for the profile, e.g. "Alto (XML) output", so you can see what kind of
output this profile generates without having to open it.
Deskew
Enable this option if your scanner creates more or less skewed images. Deskew can only be
processed when the skew angle is less than 45 degrees.
A separate Alto (XML) menu will be available when Type Alto (XML) is selected:
OCR
OCR is always selected automatically when Alto (XML) has been selected as Output format,
you will have to select a language which is used to recognize the text.
It is also possible to select multiple languages per workflow by pressing Ctrl and selecting the
desired languages-
Profile name
Enter a descriptive name for the profile, e.g. "Excel", so you can see what kind of output this
profile generates without having to open it.
Deskew
Select this option if your scanner creates more or less skewed images. Deskew can only be
processed when the skew angle is less than 45 degrees.
A separate Excel (xls) menu will be available when Type Excel (xlsx) is selected:
OCR
OCR is always selected automatically when Excel (xls) has been selected as Output format,
you will have to select a language which is used to recognize the text.
It is also possible to select multiple languages per workflow by pressing Ctrl and selecting the
desired languages-
Profile name
Enter a descriptive name for the profile, e.g. "Excel", so you can see what kind of output this
profile generates without having to open it.
Deskew
Select this option if your scanner creates more or less skewed images. Deskew can only be
processed when the skew angle is less than 45 degrees.
A separate Excel (xlsx) menu will be available when Type Excel (xlsx) is selected:
Nuance Engine
OCR
OCR is always selected automatically when Excel (xls) has been selected as Output format,
you will have to select a language which is used to recognize the text.
It is also possible to select multiple languages per workflow by pressing Ctrl and selecting the
desired languages-
Abbyy Engine
OCR
OCR is always selected automatically when Excel (xlsx) has been selected as Output format,
you will have to select a language which is used to recognize the text.
If you have an ABBYY module, you can choose the OCR engine. Either Nuance or ABBYY can be
selected. When Nuance is selected the option Native mode must be set to On in order to have
an .xlsx input file.
It is also possible to select multiple languages per workflow by pressing Ctrl and selecting the
desired languages
Convert strings to numbers and Keep text color (only available with ABBYY)
Selecting these options will convert strings from your original, to numbers in an excel sheet and/or
keep the text color of the original file. If unselected the document will be in black and strings.
For Excel (xlsx) output, you can enter values to specify the Title, Author, and Subject, as well as
some Keywords you might want to store, this is for normal Excel (xlsx).
If you select Jpeg as output format, you will have the following options:
Name
Enter a descriptive name for the profile, e.g. "Jpeg output", so you can see what kind of output this
profile generates without having to open it.
Deskew
Enable this option if your scanner creates more or less skewed images. Deskew can only be
processed when the skew angle is less than 45 degrees.
Note: This output profile is only available if you have an ABBYY license.
Name
Enter a descriptive name for the profile, e.g. "OpenOffice", so you can see what kind of output this
profile generates without having to open it.
Deskew
Select this option if your scanner creates more or less skewed images. Deskew can only be
processed when the skew angle is less than 45 degrees.
A separate Word (odt) menu will be available when Type OpenOffice (odt) is selected:
OCR
OCR is always selected automatically when Open Office (odt) has been selected as Output
format, you will have to select a language which is used to recognize the text.
It is also possible to select multiple languages per workflow by pressing Ctrl and selecting the
desired languages
Picture Quality
Selecting the quality level you want to use for the pictures in your documents.
Note: Changing the quality level, influences the compression and size of the document.
For Open Office (odt) output, you can enter values to specify the Title, Author, and Subject, as
well as some Keywords you might want to store.
If you select Original, the application will save the original file without any processing.
Some processing functions are possible to use with this output format (e.g. barcode reader, Zone
OCR) for retrieving variables such as filename.
Note: Splitting is not supported since the complete original file will be saved.
If you select GIF as output format, you will have the following options:
Name
Enter a descriptive name for the profile, e.g. "GIF output", so you can see what kind of output this
profile generates without having to open it.
When enabled you can specify the confidence level. Default if 99,25% of the page is empty, it will
be removed.
Deskew
Enable this option if your scanner creates more or less skewed images. Deskew can only be
processed when the skew angle is less than 45 degrees.
If you select PDF for output format,you will have the following options:
Name
Enter a descriptive name for the profile, e.g. "PDF output", so you can see what kind of output this
profile generates without having to open it.
Deskew
Select this option if your scanner creates more or less skewed images. Deskew can only be
processed when the skew angle is less than 45 degrees.
Engine
If you have an ABBYY license, you can specify here wether to use the Nuance or ABBYY engine
for PDF output.
PDF/A
Optionally, you can specify that you want to store documents as PDF/A documents. For PDF
output, you can enter values to specify the Title, Author, and Subject, as well as some
Keywords you might want to store, or click on the Variables button on the right, to select a
variable which will contain the values, this is for normal PDF as well as PDF/A.
Version
Select the PDF version of your output document.
Linearize
Select this option in order to have a linearized PDF as output document.
Picture Quality
Selecting the quality level you want to use for compression of the pictures in your documents.
The compression options are:
worst = 5%
low = 20%
medium = 50% (default)
normal = 70%
good = 90%
best = 100%
Note: Changing the quality level, influences the compression and size of the document.
Force MRC
Select this option in order to have a linearized PDF as output document.
black and white (1bit per pixel). Only if the image contains no grayscale values besides pure
black and white.
Relaxed
The document writer will determine if the image is grayscale. If the image has noise or
shadows, they will be ignored and the image is converted to black and white (1bit per pixel)
Security
Protected
When enabled you can insert a protections and limitations in your output document.
Owner password
The owner password, if set, controls permissions, such as printing, editing. Acrobat Reader will
disallow these things based on the permission settings. Acrobat will require this password if you
want to set/change permissions.
User password
The user password, if set, is what you need to provide in order to open a PDF. Acrobat Reader will
prompt a user to enter the user password. If it's not correct, the document will not open.
Copy enabled
When disabled it's not possible to copy text from PDF.
Edit enabled
When disabled it's not possible to edit the PDF.
Annotate enabled
When disabled it's not possible to annotate on PDF.
Print password
When disabled it's not possible to print the PDF.
Digital Signature
Type
Select digital signature type customization (Adobe.PPKLite, Adobe.PPKMS, CADES/PADES)
Certificate Path
Enter or Browse to the destination of the certificate file to use to sign the PDF (.pfx format)
Certificate Password
Enter the password of the selected certificate.
Reason
Enter the reason of the signature.
Visible
Enable or disable the the visibility of the certificate
PADES Enhanced
Enable or disable the the PADES Enhanced
Timestamp
Enable or disable the the certified time stamp:
If you select PNG as output format, you will have the following options:
Name
Enter a descriptive name for the profile, e.g. "PNG output", so you can see what kind of output
this profile generates without having to open it.
Deskew
Enable this option if your scanner creates more or less skewed images. Deskew can only be
processed when the skew angle is less than 45 degrees.
Note: This output profile is only available if you have an ABBYY license.
Name
Enter a descriptive name for the profile, e.g. "PowerPoint output", so you can see what kind of
output this profile generates without having to open it.
Deskew
Select this option if your scanner creates more or less skewed images. Deskew can only be
processed when the skew angle is less than 45 degrees.
A separate PowerPoint (pptx) menu will be available when Type PowerPoint (pptx) is selected:
OCR
OCR is always selected automatically when PowerPoint (pptx) has been selected as Output
format, you will have to select a language which is used to recognize the text.
It is also possible to select multiple languages per workflow by pressing Ctrl and selecting the
desired languages
Remove noise
Default no noise will be removed. If needed you can change this to white noise or correlated
noise. Note: this method can be used for color and 8-bit gray images only
White noise
This mode may be useful, for example, for uncompressed images with ISO less then 800,
for reduced images
Correlated noise
This mode may be useful, for example, for the JPEG photos with high compression settings
If you select Tiff output you will have the following options:
Name
Enter a descriptive name for the profile, e.g. "Tiff output (Not rotated)", so you can see what kind of
output this profile generates without having to open it.
page is scanned upside down, it will automatically be rotated to the correct orientation.
Deskew
Select this option if your scanner creates more or less skewed images. Deskew can only be
processed when the skew angle is less than 45 degrees.
Image compression
You can choose the compression type of your Tiff document.
Name
Enter a descriptive name for the profile, e.g. "Word", so you can see what kind of output this
profile generates without having to open it.
Deskew
Select this option if your scanner creates more or less skewed images. Deskew can only be
processed when the skew angle is less than 45 degrees.
A separate Word (doc) menu will be available when Type Word (doc) is selected:
Use frames
Use frames is enabled by default. When is enable, it insert to file word of the "frames" instead of
to use "normal" text.
Name
Enter a descriptive name for the profile, e.g. "Word", so you can see what kind of output this
profile generates without having to open it.
Deskew
Select this option if your scanner creates more or less skewed images. Deskew can only be
processed when the skew angle is less than 45 degrees.
A separate Word (docx) menu will be available when Type Word (docx) is selected:
OCR
OCR is always selected automatically when Word (docx) has been selected as Output format,
you will have to select a language which is used to recognize the text.
It is also possible to select multiple languages per workflow by pressing Ctrl and selecting the
desired languages
Use frames
Use frames is enabled by default. When is enable, it insert to file word of the "frames" instead of
to use "normal" text.
Only available with ABBYY license and selecting engine ABBYY (We explain only the differences
with the screens of the Engine Nuance):
OCR
OCR is always selected automatically when Word (docx) has been selected as Output format,
you will have to select a language which is used to recognize the text.
If you have an ABBYY module, you can choose the OCR engine. Either Nuance or ABBYY can be
selected.
It is also possible to select multiple languages per workflow by pressing Ctrl and selecting the
desired languages.
This mode may be useful, for example, for the JPEG photos with high compression settings
Picture Quality
Selecting the quality level you want to use for the pictures in your documents.
Note: Changing the quality level, influences the compression and size of the document.
For Word (docx) output, you can enter values to specify the Title, Author, and Subject, as well as
some Keywords you might want to store, this is for normal Word (docx).
Name
Enter a descriptive name for the profile, e.g. "Word", so you can see what kind of output this
profile generates without having to open it.
Deskew
Select this option if your scanner creates more or less skewed images. Deskew can only be
processed when the skew angle is less than 45 degrees.
A separate Word (rtf) menu will be available when Type Word (rtf) is selected:
OCR
OCR is always selected automatically when Word (rtf) has been selected as Output format, you
will have to select a language which is used to recognize the text.
It is also possible to select multiple languages per workflow by pressing Ctrl and selecting the
desired languages
Use frames
Use frames is enabled by default. When is enable, it insert to file word of the "frames" instead of
to use "normal" text.
Only available with ABBYY license and selecting engine ABBYY (We explain only the differences
with the screens of the Engine Nuance):
OCR
OCR is always selected automatically when Word (rtf) has been selected as Output format, you
will have to select a language which is used to recognize the text.
If you have an ABBYY module, you can choose the OCR engine. Either Nuance or ABBYY can be
selected.
It is also possible to select multiple languages per workflow by pressing Ctrl and selecting the
desired languages
Picture Quality
Selecting the quality level you want to use for the pictures in your documents.
Note: Changing the quality level, influences the compression and size of the document.
For Word (docx) output, you can enter values to specify the Title, Author, and Subject, as well as
some Keywords you might want to store.
Name
Enter a descriptive name for the profile, e.g. "XPS", so you can see what kind of output this profile
generates without having to open it.
Deskew
Select this option if your scanner creates more or less skewed images. Deskew can only be
processed when the skew angle is less than 45 degrees.
OCR
OCR is always selected automatically when XPS (xps) has been selected as Output format, you
will have to select a language which is used to recognize the text.
If you have an ABBYY module, you can choose the OCR engine. Either Nuance or ABBYY can be
selected.
It is also possible to select multiple languages per workflow by pressing Ctrl and selecting the
desired languages
This method increases the local contrast of the image. Such preprocessing may increase
recognition quality of low contrast images. (for example on photos or scans with texture or
pictures in the background, or photos or scans of documents with highly colorful background or
text highlighting)
3.2.4.3.1.2 Splitting
The splitting menu allows you to split scanned documents.
When enabled, splitting pages can either be done on amount of pages or on empty pages.
This option allows you to split documents without using barcodes or separation pages.
Book split
when enabled, it allows to automatically split in standard A4 pages scanned book / brochures /
magazines from the glass. Split is automatically done calculating the middle point of the scanned
book page.
- Booklet:
when enabled, this booklet feature divides the pages of a sheet always based on their
middle point but reordering them automatically in the output document. This option is suitable when
scanning full pages extracted from the main document (e.g. a contract scanned via ADF). Example:
A contract of 4 pages, A3 format, scanned via ADF: the output will be 1,2,15,16.
- Border remove:
when enabled, it removes the black border, this feature is useful to make the scanned page
split properly and not distorted, especially for book sizes smaller than the scanning detected area.
and
and
- Auto crop:
same border removal functionality but applying to the white borders. If the first page is white
this option can also delete it.
3.2.4.3.1.3 Image
This settings is available for all type of the output profile that you have selected.
Url
Enter the Afas Online Url here, or click on the Variables button on the right, to select a variable
which will contain the Url.
Subscriber
Enter a Subscriber, or click on the Variables button on the right, to select a variable which will
contain the Subscriber.
Token
Enter the Afas Token, or click on the Variables button on the right, to select a variable which will
contain the Token.
Afas Sender
Enter a Sender from Afas here, or click on the Variables button on the right, to select a variable
which will contain the Sender.
Key Value
Enter a Key Value here, or click on the Variables button on the right, to select a variable which
will contain the Key Value.
Destination Type
Select a Destination type here.
Filename
Enter a filename here, or click on the Variables button on the right, to select a variable which will
contain the Filename.
Description
Enter a description here, or click on the Variables button on the right, to select a variable which
will contain the Description.
Feature 1, Feature 2 and Feature 3 (optional)
Enter a feature here, or click on the Variables button on the right, to select a variable which will
General
Contact data
Enter a contact ID here, or click on the Variables button on the right, to select a variable which
will contain the Contact.
Fiscal year
Enter a year here, or click on the Variables button on the right, to select a variable which will
contain the year.
Project ID
Enter a project ID here, or click on the Variables button on the right, to select a variable which
will contain the Project ID.
Campagne ID
Enter a campaign ID here, or click on the Variables button on the right, to select a variable which
will contain the Campaign ID.
Sales Relation
Environment
Enter an environment here, or click on the Variables button on the right, to select a variable
which will contain the environment.
Invoice type
Enter an invoice type here, or click on the Variables button on the right, to select a variable
which will contain the Invoice type.
Invoice
Enter an Invoice ID here, or click on the Variables button on the right, to select a variable which
will contain the Invoice ID.
Purchase Relation
Environment
Enter an environment here, or click on the Variables button on the right, to select a variable
which will contain the environment.
Invoice type
Enter an invoice type here, or click on the Variables button on the right, to select a variable
which will contain the Invoice type.
Invoice
Enter an Invoice ID here, or click on the Variables button on the right, to select a variable which
will contain the Invoice ID.
the right, to select a variable which will contain the User code and Password.
Author
Enter or select an author here, or click on the Variables button on the right, to select a variable
which will contain the author.
Operator
Enter or select an operator here, or click on the Variables button on the right, to select a variable
For the Amazon connector to work, you will have to create an AccessKey and AccessKey Secret.
To do this, follow the steps below:
When you enable the Amazon AWS connector, the following screen will appear:
AccessKey ID
Enter the AccesKey Id (generated from Amazon) here, or click on the Variables button on the
right, to select a variable which will contain the Id.
AccessKey Secret
Enter the AccessKey Secret (generated from Amazon) to use here, or click on the Variables
button on the right, to select a variable which will contain the Secret.
Service Type
For now, only Amazon S3 is available
Bucket
Select a bucket to store your documents in, or click on the Variables button on the right, to
select a variable which will contain the bucket. If the bucket doesn't exist, it will be automatically
created.
Delete
With this function you can delete the selected bucket from Amazon. Please note that the bucket
has to be empty in order to delete it. If it is nor empty, you will get an error message.
Folder
Select a folder to store your documents in, browse to a Folder here, or click on the Variables
button on the right, to select a variable which will contain the folder. If the folder doesn't exist, it
will be automatically created.
Filename
Enter the filename for the document to upload to Amazon, or click on the Variables button on
the right, to select a variable which will contain the filename.
Custom Metadata
With this option you can add metadata to your document. Added metadata can be found in the
Documents Properties (Metadata section)
Storage Class
Select the storage class for your document. This can be Standard, Glacier, ReducedRedundancy
or StandardInfrequentAccess.
Encryption Method
Select the Encryption method if needed. Default there is no encrytion. The available encryption
options are AES256 or AWSKMS.
Note: Box requires a new authorization method. For the Box connector to work , you have to
configure a OAuth user for every username you want to use in the Box connector. For more
information on how to do this, please refer to the OAuth user section. Please configure the users
before configuring the connector.
Username
Enter your Box email address here, or click on the Variables button on the right, to select a
variable which will contain the email address.
PIN
Enter your Box PIN here, or click on the Variables button on the right, to select a variable which
will contain the PIN. (PIN will be created in OAuth User settings)
Check login
If you select this button,Scanshare Enterprise V4 will try to establish a connection with Box using
the username and password you provided above. When the connection could be made, a 'OK' will
appear on the bottom of the screen. if not the message: 'The provided user information is not valid'
will appear.
Folder
Enter the folder to upload to Box, select a folder by pressing the browse folders button or click
on the Variables button on the right, to select a variable which will contain the Foldername, if the
folder doesn't exist, it will be created automatically.
Filename
Enter the filename for the document to upload to Box, or click on the Variables button on the
right, to select a variable which will contain the filename.
3.2.4.3.6 Database
The Database Connector makes it very easy to manipulate an SQL database. An example when this
could be useful, is when you are scanning orders and want to store these orders directly into a
database. It allows you to store in a database both variables and the processed document itself
depending on the used database capabilities.
Connection string
Enter a connection string here, select it by using the Get DSN function, use the wizard button to
browse to the string, or select the variable that should contain the right string.
Query
Enter the right Query here, use the variables button to create simple or complex dynamic queries
or use the Create insert and Create update buttons to automatically fill the standard insert or
update statement.
For more information about Database connector please refer in the appendix: How To -> Database
Url
Enter the Docuware Url here, or click on the Variables button on the right, to select a variable
which will contain the Url.
Username and Password
Enter a username and password with admin rights here, or click on the Variables button on the
right, to select a variable which will contain the Username or Password.
Company
Enter the Docuware company here, or click on the Variables button on the right, to select a
variable which will contain the Company. This is only required for cloud accounts.
Store to
Select where you want to store your documents to. This can either be a file cabinet or a Web
Basket.
File Cabinet/Web Basket
If a connection can be made to DocuWare, using the settings you provided in the previous
entries, then you can select this button, which will give you a list of available File Cabinet/Web
Basket, from which you can select one, or you can select a Variables button on the right, to
select a variable which will contain the File Cabinet. By pressing the update button a list of available
File Cabinets or Web baskets (depending of your previous choice) will be available.
Note: this may take quite some time, during which nothing seems to happen!
Fields
The properties menu will prompt a screen, allowing you to add values to different column fields
defined in the selected File Cabinet/Web Basket within DocuWare. Please fill in with the data type
indicated in the brackets.
Filename
Enter a filename here, or click on the Variables button on the right, to select a variable which will
Cloud
When enabled you can connect with your Dokmee cloud account.
Username
Enter your Dokmee Username here, or click on the Variables button on the right, to select a
variable which will contain the username.
Password
Enter your Dokmee Password here, or click on the Variables button on the right, to select a
variable which will contain the password.
Check login
If you select this button,Scanshare Enterprise V4 will try to establish a connection with Dokmee
using the username and password you provided above. When the connection could be made, a '
OK' will appear on the bottom of the screen.
Cabinet
Select a Cabinet here, or click on the Variables button on the right, to select a variable which will
contain the Cabinet. By pressing the update button a list of available Cabinets will be available.
Folder
Enter the folder to upload to Dokmee, select a folder by pressing the browse folders button or
click on the Variables button on the right, to select a variable which will contain the Foldername,
if the folder doesn't exist, it will be created automatically.
Filename
Enter a filename here, or click on the Variables button on the right, to select a variable which will
contain the Filename.
3.2.4.3.9 DossierApp
The DossierApp connector lets you to upload a scanned document to your DossierApp server.
When you enable it, the following screen will appear:
URL
Enter your URL DossierApp server here, or click on the Variables button on the right, to select a
variable which will contain the URL.
Reference
Enter your DossierApp Reference here, or click on the Variables button on the right, to select a
variable which will contain the Reference.
User Reference
Enter your DossierApp User Reference here, or click on the Variables button on the right, to
select a variable which will contain the User Reference.
Dossier type
Select the DossierApp Type available here after click the Update button if the connection is
complete, or click on the Variables button on the right, to select a variable which will contain the
Dossier Type.
Note: if you want to use the Dropbox connector, you have to have a Dropbox account!
Username
Enter your Dropbox email address here, or click on the Variables button on the right, to select a
variable which will contain the email address.
Password
Enter your Dropbox password here, or click on the Variables button on the right, to select a
variable which will contain the password. (Not required if you created user OAuth)
PIN
Enter your DropBox PIN here, or click on the Variables button on the right, to select a variable
which will contain the PIN. (PIN if you will be created in OAuth User settings)
Check login
If you select this button, Scanshare Enterprise V4 will try to establish a connection with Dropbox
using the username and password you provided above. When the connection could be made, a '
OK' will appear on the bottom of the screen. if not the message: 'The provided user information is
not valid' will appear.
Folder
Enter the folder to upload to Dropbox, select a folder by pressing the browse folders button or
click on the Variables button on the right, to select a variable which will contain the Foldername,
if the folder doesn't exist, it will be created automatically.
Filename
Enter the filename for the document to upload to Dropbox, or click on the Variables button on
the right, to select a variable which will contain the filename
Use proxy
If your administrator has set up a proxy for your internet connections, you should check this
option and provide proxy details by selecting the Proxy settings button on the right
Proxy settings
If you select this button, a new window will appear where you can enter proxy settings details:
Address
The IP address of the proxy server
Port
Note: ask your administrator for help in order to provide correct proxy settings to
Scanshare Enterprise V4.
Server
Enter the Dynamics NAV SQL Server address in SQL data source format (e.g.
SERVER\SQLINSTANCE), or click on the Variables button on the right, to select a variable
which will contain the Server address.
Database
Enter the database you want to use here, or click on the Variables button on the right, to select
Dynamics NAV creates records and links to documents but it doesn’t upload them into the
database. The documents are stored on the hard drive and then will be linked to the selected record.
This tab is used to choose the location where you want to store them and from where they will be
linked to the selected record. The fields Username/password are used in case you insert a UNC
path if you are on a different server than Dynamics NAV is installed.
Path
Enter or browse to a path to store the documents in here, or click on the Variables button on the
right, to select a variable which will contain the Path.
Username and Password
Enter the username and password here, or click on the Variables button on the right, to select a
variable which will contain the Username and Password.
Filename
Enter the Filename here, or click on the Variables button on the right, to select a variable which
will contain the Filename.
Note: an ELO User is required for ELO connector to access ELO repository. The ELO connector
user must have “View all entries, ignore permission settings” rights since it needs query ELO
folders.
Server
Enter the server address here, or click on the Variables button on the right, to select a variable
which will contain the address. You can find ELO index server web application in ELO application
manager page:
Username
Enter your ELO username here, or click on the Variables button on the right, to select a variable
which will contain the username.
Password
Enter your ELO password here, or click on the Variables button on the right, to select a variable
which will contain the password.
Docname
Enter a docname here, or click on the Variables button on the right, to select a variable which
will contain the docname.
Doc Owner
Enter a Doc Owner here (Default is Server Variable Username), or click on the Variables button
on the right, to select a variable which will contain the doc owner.
The E-Mail connector lets you email a scanned document to a recipient. When you enable it, the
following screen will appear:
General
Note: if you want to use the E-Mail connector, you have to setup the mail settings as well!
To address
Enter the email address of the recipient(s), or click on the Variables button on the right, to select
a variable which will contain the address of the recipient(s). Multiple addresses can be added,
separated by a semicolon (e.g. mail@company.com; mail2@company.com; mail3@company.
com)
From address
Enter the email address of the sender of this email, or click on the Variables button on the right,
to select a variable which will contain the address of the sender.
Subject
Enter the subject for this email, or click on the Variables button on the right, to select a variable
which will contain the subject.
Message Body
Enter the text for the body of this email, or click on the Variables button on the right, to select a
variable which will contain the body text.
Filename
Enter the filename for the attachment to this email, which will be the scanned document, or click
on the Variables button on the right, to select a variable which will contain the file name
Note: you can also combine text you enter manually with variables!
Server Settings
The Server settings are copied from the General server settings, but can be customized for this
connector.
A complete explanation on these settings can be found in the Settings menu
Note: if you want to use the Evernote connector, you have to have an Evernote account!
Username
Enter your Evernote username here, or click on the Variables button on the right, to select a
variable which will contain the username.
Password
Enter your Evernote password here, or click on the Variables button on the right, to select a
variable which will contain the password.
Test Connection
If you select this button, Scanshare Enterprise V4 will try to establish a connection with Evernote
using the username and password you provided above.
Notebook
Select the Notebook to scan to here, a list will appear after pressing the update button with all
available Notebooks, or click on the Variables button on the right, to select a variable which will
contain the Notebook. If a Notebook doesn't exist, the first default one will be used.
Existing Note
Select the Note to scan to here, a list will appear after pressing the update button with all
available Notes, or click on the Variables button on the right, to select a variable which will
contain the Note. If a Note doesn't exist, it will automatically be created.
Filename
Enter the filename for the document to upload to Evernote, or click on the Variables button on
the right, to select a variable which will contain the filename
3.2.4.3.15 FTP
The FTP Connector enables you to store the processed document on another server, using the FTP
protocol.
Server
The address of the FTP server, e.g. ftp.myserver.eu
Port
By default, most FTP servers use port 21, if the connection is passive, SSL or SSH, check the
box accordingly.
Folder
Enter the name of the folder on the FTP server you want to store the processed documents to. If
the folder doesn't exsist
File Name
By default, the filename will always be set as in the screen above. Since the "%" mark variables,
the actual filename will be the word "Document" followed by the current year, a dash, current
month, a dash, current day, a space, and a time stamp consisting of the hours in 24 hours format,
the minutes and seconds. This will always create a unique filename, which also makes it easy to
know the creation date just by looking at its name.
So for example Document 14-08-05 14.18.03
Overwrite
This setting determines what will happen when the filename already exists in the specified folder. if
enabled the document will be overwritten.
Test Connection
This button tries to connect to the FTP server with the settings as entered before. If all settings are
correct, a message will show up stating everything is OK. If a connection cannot be established, a
message will show up, stating why, e.g. "The password is invalid"
Note: Google Drive requires a new authorization method. For the Google Drive connector to work ,
you have to configure a OAuth user for every username you want to use in the Google Drive
connector. For more information on how to do this, please refer to the OAuth user section. Please
configure the users before configuring the connector.
Note: if you want to use the Google Drive connector, you have to have a Google Drive
account!
Username
Enter your Google Drive email address here, or click on the Variables button on the right, to
select a variable which will contain the email address.
PIN
Enter your Google Drive PIN here, or click on the Variables button on the right, to select a
variable which will contain the PIN. (PIN will be created in OAuth User settings)
Check login
If you select this button,Scanshare Enterprise V4 will try to establish a connection with Google
Drive using the username and password you provided above. When the connection could be made,
a 'OK' will appear on the bottom of the screen. if not the message: 'The provided user information
is not valid' will appear.
Folder
Enter the folder to upload to Google Drive, select a folder by pressing the browse folders button
or click on the Variables button on the right, to select a variable which will contain the
Foldername, if the folder doesn't exist, it will be created automatically.
Filename
Enter the filename for the document to upload to Google Drive, or click on the Variables button
on the right, to select a variable which will contain the filename
Use proxy
If your administrator has set up a proxy for your internet connections, you should check this
option and provide proxy details by selecting the Proxy settings button on the right
Proxy settings
If you select this button, a new window will appear where you can enter proxy settings details:
Address
The IP address of the proxy server
Port
The port number which is used by the proxy
Note: ask your administrator for help in order to provide correct proxy settings to
Scanshare Enterprise V4.
Note: for the InfinityLaw connector to work, direct access to SQL is required!
Server
Enter the server address here, or click on the Variables button on the right, to select a variable
which will contain the address.
Database
Enter the database to use here, or click on the Variables button on the right, to select a variable
which will contain the Database.
Username and Password
Enter a username and password with admin rights here, or click on the Variables button on the
right, to select a variable which will contain the Username or Password.
Trusted connection
Default a trusted connection is used, if needed this can be turned off.
Document User
Select a User here, or click on the Variables button on the right, to select a variable which will
contain the User.
Document Type
Select a Type here, or click on the Variables button on the right, to select a variable which will
contain the Type.
Filename
Enter the filename here, or click on the Variables button on the right, to select a variable which
will contain the Filename.
Folder
Enter a folder here, or click on the Variables button on the right, to select a variable which will
contain the folder.
Description
Enter the Description here, or click on the Variables button on the right, to select a variable
which will contain the Description.
Client, Matter, Deed and Name
Select a Client, Matter, Deed or Name here, or click on the Variables button on the right, to
select a variable which will contain the information.
Filter
Enter or select a filter here, or click on the Variables button on the right, to select a variable
which will contain the filter.
Special filters for InfinityLaw are:
ID=XXX (will search based on client ID, partial and full)
NAME=XXX (will search based on client name, partial and full)
SEQ=XXX (will search based on sequence number, unique search for the number provided --only
Proof of ID--)
TYPE=XXX (will search based on proof type --only Proof of ID--)
(replace XXX with your current Variable)
Expiry Date
Enter an Expiry date here, or click on the Variables button on the right, to select a variable
which will contain the Expiry date.
Date of Birth
Enter a date of birth here, or click on the Variables button on the right, to select a variable which
will contain the date.
Team Dep.
Select a Team Department here, or click on the Variables button on the right, to select a variable
which will contain the Team department.
Author
Select an Author here, or click on the Variables button on the right, to select a variable which
Project Name
Enter the name of the Project to use, or click on the Variables button on the right, to select a
variable which will contain the name of the Project.
Cabinet
Select the Cabinet, a list will appear after pressing the update button with all available Cabinets.
Or click on the Variables button on the right, to select a variable which will contain the Cabinet
Filename
Enter the filename for the document to upload to Infotraq, or click on the Variables button on the
right, to select a variable which will contain the Filename.
Document Title
Enter the Document Title for the document to upload to Infotraq, or click on the Variables button
on the right, to select a variable which will contain the Document Title.
Document Type
Select the Document Type, a list will appear after pressing the update button with all available
Document Types.
Test connection
If you select this button, Scanshare Enterprise V4 will try to establish a connection with Infotraq
using the username and password you provided above. If the connection can not be made, please
check the provided Server IP, username and password.
Note: LEAP requires a new authorization method. For the LEAP connector to work , you have to
configure a OAuth user for every username you want to use in the LEAP connector. For more
information on how to do this, please refer to the OAuth user section. Please configure the users
before configuring the connector.
Username
Enter your LEAP username here, or click on the Variables button on the right, to select a
variable which will contain the username.
PIN
Enter your LEAP PIN here, or click on the Variables button on the right, to select a variable
which will contain the PIN. (PIN will be created in OAuth User settings)
Matter No
Select the Matter numberto to here, a list will appear after pressing the update button with all
available Matter number, or click on the Variables button on the right, to select a variable which
will contain the Matter no.
Docname
Enter a docname here, or click on the Variables button on the right, to select a variable which
will contain the docname.
Staff Initials
Enter a staff initials here, or click on the Variables button on the right, to select a variable which
will contain the staff initials.
Address
Enter the Server address (URL) of your M-Files site here, or click on the Variables button on the
right, to select a variable which will contain the address.
Username
Enter your M-Files username here, or click on the Variables button on the right, to select a
variable which will contain the username.
Password
Enter your M-Files password of the corresponding user here, or click on the Variables button on
the right, to select a variable which will contain the password.
Windows Authentication
If authentication needs to be done using windows authentication, enable this option. If disabled,
internal M-Files authentication will be used.
Vaults
Select the Vault to scan to here, a list will appear after pressing the refresh button with all
available Vaults, or click on the Variables button on the right, to select a variable which will
contain the Vaults. If a Vault doesn't exist, the first default one will be used.
Class
Select the document Class here, a list will appear after pressing the refresh button with all
available Classes, or click on the Variables button on the right, to select a variable which will
contain the Class. If a Class doesn't exist, the first default one will be used.
Workflow
Select the Workflow here, a list will appear after pressing the refresh button with all available
Workflows, or click on the Variables button on the right, to select a variable which will contain
the Workflow. If a Workflow doesn't exist, the first default one will be used.
State
Select the State of the workflow selected here , a list will appear after pressing the refresh button
with all available States, or click on the Variables button on the right, to select a variable which
will contain the State. If a State doesn't exist, the first default one will be used.
Title
Enter the title of the document to upload to M-Files, or click on the Variables button on the right,
to select a variable which will contain the title.
Description (optional)
Enter a description for the document here, or click on the Variables button on the right, to select
a variable which will contain the description.
Keywords (optional)
Enter keywords for the document here, or click on the Variables button on the right, to select a
variable which will contain the Keywords.
Properties
Pressing this button, will open the properties menu of the selected Vault. Allowing you to change
the Property values of the scanned document.
Username
Enter your MediaFire Username here, or click on the Variables button on the right, to select a
variable which will contain the username.
Password
Enter your MediaFire password here, or click on the Variables button on the right, to select a
variable which will contain the password.
Test Connection
If you select this button, Scanshare Enterprise V4 will try to establish a connection with MediaFire
using the username and password you provided above.
Folder
Enter the folder to upload to MediaFire, or click on the Variables button on the right, to select a
variable which will contain the Foldername
Folder key
The folder key will automatically be filled after selecting a folder. MediaFire allows users to create
directories with the same name in the same location. Therefore the folder key property is
displayed so that users can ensure that the correct folder is selected between different templates.
Filename
Enter the filename for the document to upload to MediaFire, or click on the Variables button on
the right, to select a variable which will contain the filename
Environment
Select your Nedap Ons Environment (Development, Staging, Live).
Certificate
Insert your Nedap Ons Certificate here or click Browse for find it in your server folder or click on
the Variables button on the right, to select a variable which will contain the path of the certificate.
Password
Enter your Ndap Ons password here, or click on the Variables button on the right, to select a
variable which will contain the password.
Check login
If you select this button, Scanshare Enterprise V4 will try to establish a connection with Nedap
using the username and password you provided above.
Employee
Select the Employee a picklist will appear after pressing the update button with all available
Employee. Or click on the Variables button on the right, to select a variable which will contain
the Employee
Client
Select the client, a picklist will appear after pressing the update button with all available Client. Or
click on the Variables button on the right, to select a variable which will contain the Client
Description (Optional)
Enter the description for the document to upload to Nedap Ons, or click on the Variables button
on the right, to select a variable which will contain the description.
Filename
Enter the filename for the document to upload to Nedap Ons, or click on the Variables button on
the right, to select a variable which will contain the filename.
Tags (Optional)
Enter the tags for the document to upload to Nedap Ons, or click on the Variables button on the
right, to select a variable which will contain the description.
3.2.4.3.23 Objective
The Objective connector lets you to upload a scanned document to your Objective site. When you
enable it, the following screen will appear:
NOTE: the Objective connector is only available in the Scanshare Enterprise V4 32-bit version.
Server
Enter the Objective Server address, or click on the Variables button on the right, to select a
variable which will contain the Server address.
Port
Enter the port you want to use here, the default it is 8080.
Username and Password
Enter a username and password with admin rights here, or click on the Variables button on the
Owner
Select the owner here, a list will appear after pressing the update button with all available Owner,
or click on the Variables button on the right, to select a variable which will contain the Owner.
Use user signon value (username)
Enable or Disable the use of the user signon value (username)
Parent
Enter the parent to upload to Objective, select a folder by pressing the browse button or click on
the Variables button on the right, to select a variable which will contain the Parent name, if the
folder doesn't exist, it will be created automatically.
Use owner specific sub folder
Enable or Disable the use owner specific sub folder.
Name
Enter a Name here, or click on the Variables button on the right, to select a variable which will
contain the Name.
Comment
Enter a comment here, or click on the Variables button on the right, to select a variable which
will contain the comment.
Type
Select the type here, a list will appear after pressing the update button with all available type, or
click on the Variables button on the right, to select a variable which will contain the type.
Classification
Select the Classification here, a list will appear after pressing the update button with all available
Classification, or click on the Variables button on the right, to select a variable which will contain
the Classification.
Publish immediately
Enable or Disable the publish immediately.
Corporate value
Enable or Disable the corporate value.
Standard Fileds
Open the Standard fields available on the Objective.
Catalogue
Select the catalogue here, a list will appear after pressing the update button with all available
catalogue, or click on the Variables button on the right, to select a variable which will contain the
catalogue.
Additional Fileds
Open the Additional fields available on the Objective.
3.2.4.3.24 OliBox
The OliBox connector lets you to upload a scanned document to OliBox site. When you enable it,
the following screen will appear:
URL
Enter your URL OliBox server here, or click on the Variables button on the right, to select a
variable which will contain the URL.
Username
Enter your OliBox username here, or click on the Variables button on the right, to select a
variable which will contain the username.
Password
Enter your OliBox password here, or click on the Variables button on the right, to select a
variable which will contain the password.
Folder
Enter the folder to upload to OliBox, select a folder by pressing the browse folders button or
click on the Variables button on the right, to select a variable which will contain the Foldername,
if the folder doesn't exist, it will be created automatically
Filename
Enter the filename for the document to upload to OliBox, or click on the Variables button on the
right, to select a variable which will contain the filename.
Title
Enter the title for the document to upload to OliBox, or click on the Variables button on the right,
to select a variable which will contain the title.
Notes
Enter the notes for the property document to upload to OliBox, or click on the Variables button
on the right, to select a variable which will contain the notes.
Description
Enter the description for the property document to upload to OliBox, or click on the Variables
button on the right, to select a variable which will contain the description.
Owner
Enter the owner for the property document to upload to OliBox, or click on the Variables button
on the right, to select a variable which will contain the filename.
Creation date
Enter the correct date creation, if you "Use now" the field is disabled and get the current upload
date to OliBox.
Tags
Enter the tags for the document to upload to OliBox, or click on the Variables button on the
right, to select a variable which will contain the description.
Overwrite mode
Select the Overwrite mode: none, abort, version, update and replace.
Note: OneDrive requires a new authorization method. For the OneDrive connector to work , you have
to configure a OAuth user for every username you want to use in the OneDrive connector. For more
information on how to do this, please refer to the OAuth user section. Please configure the users
before configuring the connector.
Username
Enter your OneDrive email address here, or click on the Variables button on the right, to select
a variable which will contain the email address.
PIN
Enter your OneDrive PIN here, or click on the Variables button on the right, to select a variable
which will contain the PIN. (PIN will be created in OAuth User settings)
Check login
If you select this button,Scanshare Enterprise V4 will try to establish a connection with OneDrive
using the username and password you provided above. When the connection could be made, a '
OK' will appear on the bottom of the screen. if not the message: 'The provided user information is
not valid' will appear.
Folder
Enter the folder to upload to OneDrive, select a folder by pressing the browse folders button or
click on the Variables button on the right, to select a variable which will contain the Foldername,
if the folder doesn't exist, it will be created automatically.
Filename
Enter the filename for the document to upload to OneDrive, or click on the Variables button on
Note: OneDrive for Business requires a new authorization method. For the OneDrive for Business
connector to work , you have to configure a OAuth user for every username you want to use in the
OneDrive for Business connector. For more information on how to do this, please refer to the OAuth
user section. Please configure the users before configuring the connector.
Username
Enter your OneDrive for Business email address here, or click on the Variables button on the
right, to select a variable which will contain the email address.
PIN
Enter your OneDrive for Business PIN here, or click on the Variables button on the right, to
select a variable which will contain the PIN. (PIN will be created in OAuth User settings)
Check login
If you select this button,Scanshare Enterprise V4 will try to establish a connection with OneDrive
for Business using the username and password you provided above. When the connection could
be made, a 'OK' will appear on the bottom of the screen. if not the message: 'The provided user
information is not valid' will appear.
Folder
Enter the folder to upload to OneDrive for Business, select a folder by pressing the browse
folders button or click on the Variables button on the right, to select a variable which will
contain the Foldername, if the folder doesn't exist, it will be created automatically.
Filename
Enter the filename for the document to upload to OneDrive for Business, or click on the Variables
button on the right, to select a variable which will contain the filename.
3.2.4.3.27 Orbeon
The Orbeon connector lets you upload a scanned document to Orbeon site.
Server
Datasource
Enter your Orbeon Datasource here.
Form
Enter your Orbeon form here.
Filename
Enter the filename for the document to upload to Orbeon, or click on the Variables button on the
right, to select a variable which will contain the filename.
Template
Enter the template for the property document to upload to Orbeon.
Address
Enter the Server address (URL) of your OpenText Content server site here, or click on the
Variables button on the right, to select a variable which will contain the address.
Username
Enter your OpenText Content Server username here, or click on the Variables button on the
right, to select a variable which will contain the username.
Password
Enter your OpenText Content Server password of the corresponding user here, or click on the
Variables button on the right, to select a variable which will contain the password.
Check login
If you select this button,Scanshare Enterprise V4 will try to establish a connection with OpenText
Content Server using the username and password you provided above.
Containter
Enter the Containter to upload to OpenText Content Server, select a containter by pressing the
browse button or click on the Variables button on the right, to select a variable which will
contain the Container, if the folder doesn't exist, the first default one will be used.
Category
Enter the Category of the document to upload to OpenText Content Server, select a Category by
pressing the browse button or click on the Variables button on the right, to select a variable
which will contain the Category, if the folder doesn't exist, the first default one will be used.
Attributes
Pressing this button, will open the Attributes menu of the selected Container. Allowing you to
change the Attributes of the scanned document.
Note: if you want to use the PlacePoint connector, you have to have a PlacePoint or
Placepoint Office 365 website and the credentials to access this website!
Use proxy
If your administrator has set up a proxy for your internet connections, you should check this
option and provide proxy details by selecting the Proxy settings button on the right
Proxy settings
If you select this button, a new window will appear where you can enter proxy settings details:
Address
The IP address of the proxy server
Port
The port number which is used by the proxy
Note: ask your administrator for help in order to provide correct proxy settings to
Scanshare Enterprise V4.
List / Library
If a connection can be made with PlacePoint, using the settings you provided in the previous
entries, then you can select this button, which will give you a list of available Lists/Libraries, from
which you can select one. or you can select a Variable with the right value. Make sure the value
has the format ID;#Value for the connector to work.
Note: this may take quite some time, during which nothing seems to happen!
Folder
Enter the folder to upload to Placepoint, select a folder by pressing the browse folders button or
click on the Variables button on the right, to select a variable which will contain the Foldername,
if the folder doesn't exist, it will be created automatically.
Filename
Enter the filename for the document to upload to PlacePoint, or click on the Variables button on
the right, to select a variable which will contain the filename.
3.2.4.3.30 PowerOffice
The PowerOffice connector lets you to upload a scanned document to PowerOffice site. When you
enable it, the following screen will appear:
Environment
Select your PowerOffice Environment (Demo or Production).
Client Key
Insert your PowerOffice Client Key here or click Browse for find it in your server folder or click on
the Variables button on the right, to select a variable which will contain the path of the certificate.
Store Type
If you select this button, a new window will appear where you can enter proxy settings details:
Voucher Type
by clicking this button, a window will open where you can select a Voucher Type. You can select
None, SupplierInvoice, SupplierCreditNote, Expense, ManualJournal, CashJournal, BankJournal,
YearEndJournal.
Currency
Select the currency: DKK, EUR, GBP, ISK, NOK, RUB, SEK, USD.
Filename
Enter the filename for the document to upload to PowerOffice, or click on the Variables button on
the right, to select a variable which will contain the filename.
General
Printer
select a Printer here, or click on the Variables button on the right, to select a variable which will
contain the Printer.
Number of copies
Enter the number of copies of the document to process printing, or click on the Variables button
on the right, to select a variable which will contain the number of copies..
Custom properties
Enter the value of property capabilities (property=value) for this process printing, or click on the
Variables button on the right, to select a variable which will contain the value of property.
OR
Properties
Name
specifies the name of a printer property.
Value
select a value of a name property, or click on the Variables button on the right, to select a
variable which will contain the value of property.
Test
If you select this button, Scanshare Enterprise V4 will try to establish a connection with printer
using you provided above and print test page.
Certificate
Enter or browse to the location of the certificate which is also used when first Authenticating to
Raet Youforce, or click on the Variables button on the right, to select a variable which will
contain the certificate (incl location).
Password
Enter your Certificate password here, or click on the Variables button on the right, to select a
variable which will contain the password.
Category
Select the needed category here, or click on the Variables button on the right, to select a
variable which will contain the key. By pressing the update button, a list of available categories will
be displayed.
Employee
Select the employee where you want to save the file to, or click on the Variables button on the
right, to select a variable which will contain the Employee. By pressing the update button, a list of
available employees will be displayed.
Product
Select the Product(combination) of the document here or click on the Variables button on the
right, to select a variable which will contain the Product. Depending on the selected employee, a
list of available products will appear after pressing the update button.
Out of service employees
When enabled, the list of employees will also display all out of service employees.
Contract (optional)
Select the contract here, or click on the Variables button on the right, to select a variable which
will contain the contract.
Description
Enter a description for your document here, or click on the Variables button on the right, to
select a variable which will contain the description.
Annotation (optional)
Enter an annotation here, or click on the Variables button on the right, to select a variable which
will contain the annotation. (max. 4000chars) will be displayed next to the document in
'Weergave'.
Source process
Enter the Source process here, or click on the Variables button on the right, to select a variable
which will contain the source process. The Source process is either a description or a code of the
process that generated the document. Used to uniquely identify the document, combined with the
Source module and identifier. (max 50 characters)
Source module
Enter the Source module here, or click on the Variables button on the right, to select a variable
which will contain the source module. The Source module is a description of the process used to
generate the document. Used to uniquely identify the document, combined with the Source
module and identifier. (max 12 characters)
Source identifier
Enter the Source identifier here, or click on the Variables button on the right, to select a variable
which will contain the source identifier. The Source Identifier is a code of the system that
generated the document. Has to be unique, together with the Source process and Source module.
With this code, the document can be recognized based on the identifying credentials of the
delivery system. (max 50 characters)
Create
Enter the creation date and time here, or click on the Variables button on the right, to select a
variable which will contain the creation date and time. When 'Use now' is enabled, the date and
time of scanning will be used.
Expiry date (optional)
Enter the expiration date here, or click on the Variables button on the right, to select a variable
which will contain the expiration date.
Filename
Enter the filename here, or click on the Variables button on the right, to select a variable which
will contain the filename.
Note: for the TRIM connector to work, A client installation has to be installed on the same
server as Scanshare Enterprise V4 is installed on.
Server
Enter the server address here, or click on the Variables button on the right, to select a variable
which will contain the address.
Port
Enter the Port to use here, or click on the Variables button on the right, to select a variable
which will contain the Port, default is 1137.
Dataset ID
Enter a Dataset ID here, or click on the Variables button on the right, to select a variable which
will contain the ID.
Connected as
Enable this function if you want to connect as a specific user.
Username and Password
When connected as is enabled, enter a username and password here, or click on the Variables
button on the right, to select a variable which will contain the Username and Password.
Type
Select a User here, or click on the Variables button on the right, to select a variable which will
contain the Type.
Description
Enter a description here, or click on the Variables button on the right, to select a variable which
will contain the Description.
Assignee
Select an Assignee here, or click on the Variables button on the right, to select a variable which
will contain the Assignee.
Contact
Select an Assignee here, or click on the Variables button on the right, to select a variable which
will contain the Assignee.
Contact type
You can choose it from:
- Author
- Addressee
- Representative
- Other
- Client
Container
Select a Containter here, or click on the Variables button on the right, to select a variable which
will contain the Container.
Set as home
if "ON"Set the container as home location. If it would be in "off" is set a assignee as home
location.
Record Fields
Pressing this button will display the record fields as configured.
Note: By pressing the Refresh button a list of available field will be available. This may take
quite some time, during which nothing seems to happen!
3.2.4.3.35 Regas
The Regas connector lets you to upload a scanned document to Regas online site. When you
enable it, the following screen will appear:
Organization
Insert your Regas Organization number here, or click on the Variables button on the right, to
select a variable which will contain the organization.
Check login
If you select this button, Scanshare Enterprise V4 will try to establish a connection with Regas
using the username and password you provided above.
Employee
Select the Employee a picklist will appear after pressing the update button with all available
Employee. Or click on the Variables button on the right, to select a variable which will contain
the Employee
Patient
Select the Patient, a picklist will appear after pressing the update button with all available Client.
Or click on the Variables button on the right, to select a variable which will contain the Patient
Case
Select the Case, a picklist will appear after pressing the update button with all available Case. Or
click on the Variables button on the right, to select a variable which will contain the Case
Folder description
Enter the description for the folder, or click on the Variables button on the right, to select a
variable which will contain the description.
Filename
Enter the filename for the document to upload to Regas, or click on the Variables button on the
right, to select a variable which will contain the filename.
Note: if you want to use the Scanshare Repository, you've simply need accounts of the your
server.
Enter the username and password of a valid user account with access to the Scanshare
Repository site.
Check login
This function will attempt to establish a connection with the Scanshare Repository using
the username and password you provided above. If the connection was successful, 'OK'
will bill displayed at bottom of the screen. If the connection was not successful ‘Login
Select a document type among the available in your repository, if you have just added
more click on update to update the list. To add other types of documents, go to Settings
Folder
Enter the desired destination folder path to upload documents to in the Scanshare
Repository. Alternatively browse for a destination by pressing the browse folders
button, or click on the Variables (VAR) button to the right, to select a variable to use for
this value. Note that if the path does not exist, it will be created automatically.
Filename
Enter the filename for the document to upload, or click on the Variables button on the
right, to select a Variables (VAR) which will contain the filename.
Properties
This will display the properties dialog, from which you may add values to different column
fields defined within Scanshare Repository. The available properties will be automatically
populated if a valid connection to your Scanshare Repository site is made.
Exam ple
For example variable has been created which stored the name of the current workflow.
When applied to the properties, and after the document is stored successfully in the
repository, you may find the property correctly attributed to the document:
Filename
Enter the filename for the document to be uploaded to Scanshare Repository, or click on
the Variables button (VAR) on the right, to select a variable which will contain the
filename.
possible to drag and drop a file into this box which will be uploaded to Scanshare
Repository.
3.2.4.3.37 Script
The script connector enables you to gain complete control over the actions which will be performed
when a document has been processed. Because you can select a VB Script which has to be
executed, the possibilities are endless.
Arguments
By using arguments you can send additional parameters to a script. This might come in handy if
you create one script which you want to use in different templates, in this case you could send
the workflowname as a parameter, which can be used in the script to perform differently depending
on the workflow which invoked the script.
For example, you can enter /Workflow=CheckForms here, and retrieve the value in the VB Script
by using my_var=Arguments.Values("Workflow")
Filename
Use a variable, browse to or enter the name of the script. The script should always set the
variable return to a value which contains the items to be displayed.
An example of a very simple script would be
'Sample script
'Put your own code in here, just keep in mind that RESULT
'is reserved to return the items do be displayed
The semi-colon separates the items in the picklist. This example will create a picklist with three
items to choose from, and the return value will be the selected item.
If you would like to display a long description, but need a shorter return value, you will have to use
"##" as a separator between the list value and its return value, as in the example below:
'Sample script
'Put your own code in here, just keep in mind that RESULT
'is reserved to return the items do be displayed
which will return "Pur" when the user selects "Purchase order" from the picklist.
Code
In this field you can manually enter a script or use variables to use one.
For more information about VB script, please refer to the appendix scripts section
Server
Enter your Orbeon server here.
API Key
Enter your Orbeon API Key here.
Folder
Enter the folder to upload to OliBox, or click on the Variables button on the right, to select a
variable which will contain the Foldername, if the folder doesn't exist, it will be created
automatically
Filename
Enter the filename for the document to upload to OliBox, or click on the Variables button on the
right, to select a variable which will contain the filename.
Note: if you want to use the Citrix ShareFile connector, you have to have a Citrix ShareFile
account!
Username
Enter your Citrix ShareFile Username here, or click on the Variables button on the right, to
Password
Enter your Citrix ShareFile Password here, or click on the Variables button on the right, to select
a variable which will contain the password.
Sub Domain
Enter your Citrix ShareFile SubDomain here, or click on the Variables button on the right, to
select a variable which will contain the subdomain. You can retrieve the subdomain value from your
Citrix ShareFile account settings.
Control Plane
Enter your Citrix ShareFile control plane here, or click on the Variables button on the right, to
select a variable which will contain the control plane. You can retrieve your control plane value from
your Citrix ShareFile home page link
(e.g. https://subdomain.sharefile.com/app/#home/ ). The Control Plane field is already set with
the default value (sharefile.com)
Check login
If you select this button,Scanshare Enterprise V4 will try to establish a connection with Citrix
ShareFile using the username and password you provided above. When the connection could be
made, a 'OK' will appear on the bottom of the screen.
Folder
Enter the folder to upload to Citrix ShareFile, select a folder by pressing the browse folders
button or click on the Variables button on the right, to select a variable which will contain the
Foldername, if the folder doesn't exist, it will be created automatically.
Filename
Enter the filename for the document to upload to Citrix ShareFile, or click on the Variables
button on the right, to select a variable which will contain the filename.
Details
Enter details for your document here, or click on the Variables button on the right, to select a
variable which will contain the details.
Note: if you want to use the SharePoint connector, you have to have a SharePoint or
Sharepoint Office 365 website and the credentials to access this website!
Use proxy
If your administrator has set up a proxy for your internet connections, you should check this
option and provide proxy details by selecting the Proxy settings button on the right
Proxy settings
If you select this button, a new window will appear where you can enter proxy settings details:
Address
The IP address of the proxy server
Port
The port number which is used by the proxy
Note: ask your administrator for help in order to provide correct proxy settings to
Scanshare Enterprise V4.
List / Library
If a connection can be made with SharePoint, using the settings you provided in the previous
entries, then you can select this button, which will give you a list of available Lists/Libraries, from
which you can select one. or you can select a Variable with the right value. Make sure the value
has the format ID;#Value for the connector to work.
Note: this may take quite some time, during which nothing seems to happen!
Folder
Enter the folder to upload to Sharepoint, select a folder by pressing the browse folders button or
click on the Variables button on the right, to select a variable which will contain the Foldername,
if the folder doesn't exist, it will be created automatically.
Filename
Enter the filename for the document to upload to SharePoint, or click on the Variables button on
the right, to select a variable which will contain the filename.
Note: for the Synergy Enterprise connector to work, direct access to SQL is required!
Synergy in specific is a direct SQL connection, so the connector will attempt to make a
remote SQL connection to the target server.
Server
Enter the Server name or IP address where Synergy enterprise is installed on, or click on the
Variables button on the right, to select a variable which will contain the address.
Database
Enter the database you want to upload to here, or click on the Variables button on the right, to
select a variable which will contain the database.
Username
Enter a username with administrator rights here, or click on the Variables button on the right, to
select a variable which will contain the username.
Password
Enter the password of the corresponding user here, or click on the Variables button on the right,
to select a variable which will contain the password.
Timeout
Specify the time in seconds for the SQL timeout.
Trusted connection
When enabled, a trusted connection will be used.
Connect
Pressing this button, the application will try to establish a connection to the server.
Creator ID
Enter a valid user within Synergy Enterprise here, browse to the valid user or click on the
Variables button on the right, to select a variable which will contain the Creator ID.
Owner ID (optional)
Enter a valid user within Synergy Enterprise here, browse to the valid user or click on the
Variables button on the right, to select a variable which will contain the Owner ID.
Company (optional)
Enter the company of the user within Synergy Enterprise, browse to the valid user or click on
Variables button on the right, to select a variable which will contain the company.
Subject
Enter the subject of the scanned document here or click on the Variables button on the right, to
select a variable which will contain the subject.
Type
Enter or select the Type of document here, or click on the Variables button on the right, to
select a variable which will contain the type
JobLevel
Enter or select a JobLevel here, or click on the Variables button on the right, to select a variable
which will contain the JobLevel
Category (optional)
Enter or select a Category here, or click on the Variables button on the right, to select a variable
which will contain the Category
Body
Enter the body text here, or click on the Variables button on the right, to select a variable which
will contain the body.
Storing options
Document ID (optional)
Enter the Document ID, browse to the valid ID or click on Variables button on the right, to select
a variable which will contain the Document ID.
Order Number (optional)
Enter or select the Order Number here, or click on the Variables button on the right, to select a
variable which will contain the Order Number.
Relation (optional)
Enter or select the Relation here, or click on the Variables button on the right, to select a
variable which will contain the Relation.
Project Number (optional)
Enter or select the Project Number here, or click on the Variables button on the right, to select
a variable which will contain the Project Number.
Request (optional)
Enter or select the Request here, or click on the Variables button on the right, to select a
variable which will contain the Request
Filename
Enter the filename for the document to upload to Synergy Enterprise, or click on the Variables
button on the right, to select a variable which will contain the filename
Server
Enter the address of the WebDAV server here, or click on the Variables button on the right, to
select a variable which will contain the address.
Username and Password
Enter a username and password with admin rights here, or click on the Variables button on the
right, to select a variable which will contain the Username or Password.
Folder
Select a folder by using the Browse button, enter the folder path, or click on the Variables button
on the right, to select a variable which will contain the Folder (incl. path).
Filename
Enter a filename here, or click on the Variables button on the right, to select a variable which will
contain the Filename.
Path
Enter an output path manually, or select Browse to browse to the right folder. You may also insert
variables by selecting the Variable button on the right, so you would use e.g.
C:\Output\%DOCUMENT_TYPE%\
to store a document to a subfolder based on its document type. Of course in order to do so, you
must first set up a question which lets the user choose the document type!
Filename
Enter the filename for the document to upload, or click on the Variables button on the right, to
select a variable which will contain the filename.
Note: please do not save in the Chrome browser username and passwrod.
The Windows File System connector also gives you the possibility to create an XML or txt data file,
aligned with the output document. This data file will be saved on the same location as the original
document and will have the same filename.
Filename
The filename is automatically filled (same as in the General settings of the WFS connector). Here
you can change the extension of the file, which can be either .txt or .xml.
Contents
Enter the contents for the data output here, or click on the Variables button on the right, to
select a variable which will contain the contents.
Append
If enable, the file will be appended if it already exists.
Domain
Enter the name of the Windream domain you want to upload to.
Domain
Enter the name of the Windream server you want to upload to.
Check Connection
If you select this button, Scanshare Enterprise V4 will try to establish a connection with
Windream using the username and password you provided above.
Document objects
If a connection can be made to Windream, using the settings you provided in the previous
entries, then you can select this button, which will give you a list of available Documents Objects,
from which you can select one, or you can select a Variable with the right value.
Note: this may take quite some time, during which nothing seems to happen!
Objects Properties
The properties menu will prompt a screen, allowing you to add values to different column fields
defined in the selected Document Object within Windream. Please fill in with the data type
indicated in the brackets.
Folder
Enter the folder to upload to Windream, select a folder by pressing the browse folders button or
click on the Variables button on the right, to select a variable which will contain the Foldername,
if the folder doesn't exist, it will be created automatically.
Filename
Enter the filename for the document to upload to Windream, or click on the Variables button on
the right, to select a variable which will contain the filename.
Note: in order to use Windream connector, your Scanshare Enterprise V4 server and Windream
server needs to be installed on the same machine.
Note: for the Worksite connector to work, Scanshare Enterprise V4 has to be installed on
the same server as Worksite.
Server
Enter the IP address of the server where Worksite is installed.
Database
Enter the name of the database to use, or click on the Variables button on the right, to select a
variable which will contain the name of the database.
Author
Select the Author, a picklist will appear after pressing the update button with all available Author.
Or click on the Variables button on the right, to select a variable which will contain the Author
Document Class
Select the Document Class, a picklist will appear after pressing the update button with all
available document classes. Or click on the Variables button on the right, to select a variable
which will contain the Document Class
Description (Optional)
Enter the description for the document to upload to Worksite, or click on the Variables button on
the right, to select a variable which will contain the description.
Client (Optional)
Select the Client to which the document belongs (shown as property in your document), or click
on the Variables button on the right, to select a variable which will contain the client.
Folder (Optional)
Select the Folder where the document should be stored (default scans will be put in the root), or
click on the Variables button on the right, to select a variable which will contain the folder.
Specifying in the folder FOLDER = X where x is a string in the WORKSPACE \ FOLDERNAME
format you can specify a folder by name otherwise the field to pass to the folder is an ID.
and after this process you can found the document on the worksite:
For the Xero connector to work, you will have to register Scanshare Enterprise V4 to Xero first. To do
this, follow below steps:
1. Go to app.xero.com / My Applications
4. Once saved, you can get the key and the secret from the application page. This needs to be used
in the connector, together with the same certificate you used in the configuration to establish the
connection with your organization.
When you enable the Xero connector, the following screen will appear:
Certificate
Enter or browse to the location of the certificate which is also used when registering the
application in Xero, or click on the Variables button on the right, to select a variable which will
contain the certificate (incl location).
Certificate Password
Enter your Certificate password here, or click on the Variables button on the right, to select a
variable which will contain the password.
Key
Enter the Key of the application (can be found in the application screen in Xero) here, or click on
the Variables button on the right, to select a variable which will contain the key.
Secret
Enter the Secret of the application (can be found in the application screen in Xero) here, or click
on the Variables button on the right, to select a variable which will contain the secret.
Store to
Select the location where you want to store your scanned documents. Possible options are:
Account, Bank Transaction, Bank Transfer, Contact, Credit Note, New (if enable it create new
invoice while uploading),Invoice, Manual Journal, Receipt or Repeating Invoice. depending on the
selected location, a list of the selected location will be available.
Include Online (only valid for invoice / credit note)
When enabled, the document will also be visible in the online invoice / credit note where it has
been attached to.
Filename
Enter the filename for the document to upload, or click on the Variables button on the right, to
select a variable which will contain the filename.
Contact
Enter or browse to the location of the certificate which is also used when registering the
application in Xero, or click on the Variables button on the right, to select a variable which will
contain the certificate (incl location).
Date
Enter your Certificate password here, or click on the Variables button on the right, to select a
variable which will contain the password.
Due Date
Enter the Key of the application (can be found in the application screen in Xero) here, or click on
the Variables button on the right, to select a variable which will contain the key.
Number
URL
Enter the URL of your XPLAN site here, or click on the Variables button on the right, to select a
variable which will contain the URL.
Username
Enter your XPLAN username here, or click on the Variables button on the right, to select a
variable which will contain the username.
Password
Enter your XPLAN password of the corresponding user here, or click on the Variables button on
the right, to select a variable which will contain the password.
Check login
If you select this button,Scanshare Enterprise V4 will try to establish a connection with XPLAN
using the username and password you provided above.
Filename
Enter the filename for the document to upload, or click on the Variables button on the right, to
select a variable which will contain the filename.
Subject
Enter the subject for this email, or click on the Variables button on the right, to select a variable
3.2.4.4 Wizard
Create in 4 easy steps your workflows.
The list changes according to the connectors available in the customer's license. The user
can choose +MORE OPTIONS
The list includes some capture at any time by clicking on the previous gray side, you will return to
the previous step.
3. Well, before clicking NEXT It's time to put the last settings for the store in the connector
selected.
4. Select NEXT and the last viewed slides with just the FINISH button:
Click FINISH and you easy workflows is active and works perfectly (you can update it, e.g. in my
3.2.5 Verification
The Verification menu option displays any documents awaiting verification (see settings ->
verification).
The display shows the file name, the name of the originating workflow and the document’s
date.
Once one or more files are selected you will notice the options to "Approve" or "Reject" in
the top bar; note that you may select individual files or multiple files.
Double click on a file to display a preview in addition to the workflow’s processing variables.
Fit
One to One
o The document preview is the displayed at the same size as the original
document
Zoom In / Out
Close document
o Close or Open the menu info strip for the selected file (right bar)
Either side of the document preview you will notice the cursor buttons. Use these to switch to
the next or previous document in the verification queue.
In the right hand panel, you may verify or alter the value of the workflow variables.
You may approve or reject the document from the image viewer using
SCANJOBID is always present in the user variable and it is a unique id for the actual scan job.
If you the value of a variable (Server and User Looks like with click "VAR" for add a new
variable in the workflow design), you must the changes using the SAVE button from the top
bar.
In the left hand panel, you may alter the document with the tools:
...it are the same tools that are already present in the annotation module, for "easy" user experience of use the tools are
the same.
Add a trigger verification by click on the eye symbol in the triggers pop-up panel.
Now select a registered user to perform the verification for this workflow.
The top pane will display the registered single sign-on users and in bottom pane the local
users. Note that you may select more than one user for verification.
This workflow has now been configured for verification; when documents are placed into the
configured watchfolder the processing will halt at this trigger until a user verifies the
document.
When a verification user is logged into the web interface they will notice the verification
queue counter will update when a document is awaiting verification:
Simply click on the panel (or in the Verification menu on the left of the screen) and a list of
documents awaiting verification by the current user will be displayed.
The operations available from here are the same as described previously (File Verification).
3.2.6 Repository
The repository menu displays the root Folder of your repository in addition to any
This a Public folder, it is shared with all user that have access to the repository.
The warning displayed at the top of the screen alerts you if you have not yet configured Scanshare
Enterprise V4 to use an external database. The internal database is suitable for only a small
number of documents and would not typically be used in production in enterprise environments.
- > DON’T SHOW ANYMORE : close now and not display the warning anymore
- > Sort:
-> View:
- > Info:
displays information for the selected folder (name, total number of folders and files,
Simply enter a name for the new folder in the pop-up dialog, and select OK.
You may choose the file to upload from the pop-up window.
Select the file to upload and once the upload has completed you may find it in the
folder view.
After the document has been uploaded OCR will start in backgroud in order to index
full document contents with any file type (e.g. also Office and text documents). Indexed contents is
The top menu contains the following options which are available after selected
- Folder:
- Document:
This a Public folder, it is shared with all user that have access to the repository.
The warning displayed at the top of the screen alerts you if you have not yet configured Scanshare
Enterprise V4 to use an external database. The internal database is suitable for only a small
number of documents and would not typically be used in production in enterprise environments.
- > DON’T SHOW ANYMORE : close now and not display the warning anymore
- > Sort:
-> View:
- > Info:
displays information for the selected folder (name, total number of folders and files,
Simply enter a name for the new folder in the pop-up dialog, and select OK.
-> Name: The name of the document you are about to add.
-> Description: The description of the document you are about to add.
-> Document Type: Choose the type of document you are about to add. You can
add new types in the settings (for more info settings menu and search Repository).
-> Properties: Clicking the Properties button, you can add / set properties to the
document. If you selected a document type, you inherit its properties and you can add other
Property dialog where you can add name and value. Document
type property value can be chosen from an item list and automatically filled in the pair name and
-> File: It will be filled after uploading the file. That can be chosen from the server or
You may choose the file to upload from the pop-up window.
Select the file to upload and once the upload has completed you may find it in the
folder view.
After the document has been uploaded OCR will start in backgroud in order to index
full document contents with any file type (e.g. also Office and text documents). Indexed contents is
The top menu contains the following options which are available after selected
- Folder:
- Document:
In the right bar you can add, edit, and delete all the properties of the document. Modify the
description and change the document type. View the history and create a share of the document.
3.2.8 Clients
Clients are devices which can connect to Scanshare Enterprise V4. Clients can be put together in
a Group which allows you to change settings for multiple devices at once.
The first time you want to add a Client you will see this screen:
By pressing the + button on top of the screen, a new client can be added:
Group
Select a group here or leave the group as shown to create a new group
Group name
Webclient
This option is only available for the Konica Minolta client. Here you can specify if you need a
normal client or a webclient.
Group
Here you can see the group the client belongs to and change settings of the group by pressing the
tool icon. The group settings menu looks like this:
General:
o Status
By clicking the green indicator it changes to red and deactivates the client group.
o Type
This displays the type of group, in this case client. The group type cannot be changed
o Name
The name of the group is displayed and can be changed here
o Description
a short description of the client group can be entered here
Permissions
Here you can set the group permissions. By pressing the + on top of the screen you can add a
workflow to be shown at all the clients in that group.
Also you can specify if authentication for this group needs to be used. When enabled, the
authentication per client in the same group is disabled.
Client
At the clients menu you will be able to modify, delete or update your client.
In the openapi settings you can enter the machine password and specify the type of client. you
can also change the Setup function version and the Scan Function version.
These settings will override OpenApi function level to install and use. By default Setup Function is
3.8 and Scan function 3.7. If desired you can customize the version (if your machine supports it)
and re-install the client.
Here it is also possible to set permissions per client. by pressing the + on the top of the modify
client screen, you can add workflows to appear on that specific client.
If permissions are set in the client, these will overwrite any group permissions.
Also you can specify if authentication for this client needs to be used.
Pressing the delete button will delete the client from your list
Pressing update will update the client on the MFP. when pressing the button you will see the
device status change to uninstalling and back to installed.
Group
Here you can see the group the client belongs to and change settings of the group by pressing the
tool icon. The group settings menu looks like this:
General:
o Status
By clicking the green indicator it changes to red and deactivates the client group.
o Type
This displays the type of group, in this case client. The group type cannot be changed
o Name
The name of the group is displayed and can be changed here
o Description
a short description of the client group can be entered here
Permissions
Here you can set the group permissions. By pressing the + on top of the screen you can add a
workflow to be shown at all the clients in that group.
Also you can specify if authentication for this group needs to be used. When enabled, the
authentication per client in the same group is disabled.
Client
At the clients menu you will be able to modify, delete or update your client.
In the Olivetti OpenAPI settings you can enter the machine password and specify the type of
client. you can also change the Setup function version and the Scan Function version.
These settings will override Olivetti OpenAPI function level to install and use. By default Setup
Function is 3.8 and Scan function 3.7. If desired you can customize the version (if your machine
supports it) and re-install the client.
Here it is also possible to set permissions per client. by pressing the + on the top of the modify
client screen, you can add workflows to appear on that specific client.
If permissions are set in the client, these will overwrite any group permissions.
Also you can specify if authentication for this client needs to be used.
Pressing the delete button will delete the client from your list
Pressing update will update the client on the MFP. when pressing the button you will see the
device status change to uninstalling and back to installed.
Group
Here you can see the group the client belongs to and change settings of the group by pressing the
tool icon. The group settings menu looks like this:
General:
o Status
By clicking the green indicator it changes to red and deactivates the client group.
o Type
This displays the type of group, in this case client. The group type cannot be changed
o Name
The name of the group is displayed and can be changed here
o Description
a short description of the client group can be entered here
Permissions
Here you can set the group permissions. By pressing the + on top of the screen you can add a
workflow to be shown at all the clients in that group.
Also you can specify if authentication for this group needs to be used. When enabled, the
authentication per client in the same group is disabled.
Client
At the clients menu you will be able to modify, delete or update your client.
Here it is also possible to set permissions per client. by pressing the + on the top of the modify
client screen, you can add workflows to appear on that specific client.
If permissions are set in the client, these will overwrite any group permissions.
Also you can specify if authentication for this group needs to be used.
Pressing the delete button will delete the client from your list
Pressing update will update the client on the MFP. when pressing the button you will see the
device status change to uninstalling and back to installed.
To install the client software on your MFP, please proceed with the following steps:
Copy the file scanshare.pkg to a USB memory. This file is available from the Start menu ->
Scanshare -> Scanshare Enterprise -> Kyocera Client Tools.
Put the USB memory, containing this file, into the USB port of your device.
If 'Removable Memory was recognized. Displaying files.' appears, press [No].
Press the System Menu key and select [Application]. If the user authentication screen appears,
enter your login username and password and press [Login]
Note: you need to login with administrator privileges in order to install the software.
Then press [Add], select scanshare.pkg and press [Install]. A confirmation screen will appear,
please select [Yes].
The installation may take some time. When finished, select the application and activate it. Now the
client software is installed and the device can be connected to Scanshare server.
Make sure all settings are correct (Server IP address and default port: 8380 on the machine)
For more information, please refer to the manual of your device, section Default Setting (System
Menu)
Note: Mak e sure enhanced WSD is enabled on the machine and in the webbrowser of the machine.
Group
Here you can see the group the client belongs to and change settings of the group by pressing the
tool icon. The group settings menu looks like this:
General:
o Status
By clicking the green indicator it changes to red and deactivates the client group.
o Type
This displays the type of group, in this case client. The group type cannot be changed
o Name
The name of the group is displayed and can be changed here
o Description
a short description of the client group can be entered here
Permissions
Here you can set the group permissions. By pressing the + on top of the screen you can add a
workflow to be shown at all the clients in that group.
Also you can specify if authentication for this group needs to be used. When enabled, the
authentication per client in the same group is disabled.
Client
At the clients menu you will be able to modify, delete or update your client.
Here it is also possible to set permissions per client. by pressing the + on the top of the modify
client screen, you can add workflows to appear on that specific client.
If permissions are set in the client, these will overwrite any group permissions.
Also you can specify if authentication for this group needs to be used.
Pressing the delete button will delete the client from your list
Pressing update will update the client on the MFP. when pressing the button you will see the
device status change to uninstalling and back to installed.
To install the client software on your MFP, please proceed with the following steps:
Copy the file scanshare.pkg to a USB memory. This file is available from the Start menu ->
Scanshare -> Scanshare Enterprise -> Olivetti Client Tools.
Put the USB memory, containing this file, into the USB port of your device.
If 'Removable Memory was recognized. Displaying files.' appears, press [No].
Press the System Menu key and select [Application]. If the user authentication screen appears,
enter your login username and password and press [Login]
Note: you need to login with administrator privileges in order to install the software.
Then press [Add], select scanshare.pkg and press [Install]. A confirmation screen will appear,
please select [Yes].
The installation may take some time. When finished, select the application and activate it. Now the
client software is installed and the device can be connected to Scanshare server.
Make sure all settings are correct (Server IP address and default port: 8380 on the machine)
For more information, please refer to the manual of your device, section Default Setting (System
Menu)
Note: Mak e sure enhanced WSD is enabled on the machine and in the webbrowser of the machine.
Note: Mak e sure enhanced WSD is enabled on the machine and in the webbrowser of the machine.
Group
Here you can see the group the client belongs to and change settings of the group by pressing the
tool icon. The group settings menu looks like this:
General:
o Status
By clicking the green indicator it changes to red and deactivates the client group.
o Type
This displays the type of group, in this case client. The group type cannot be changed
o Name
The name of the group is displayed and can be changed here
o Description
a short description of the client group can be entered here
Permissions
Here you can set the group permissions. By pressing the + on top of the screen you can add a
workflow to be shown at all the clients in that group.
Also you can specify if authentication for this group needs to be used. When enabled, the
authentication per client in the same group is disabled.
Client
At the clients menu you will be able to modify, delete or update your client.
Here it is also possible to set permissions per client. by pressing the + on the top of the modify
client screen, you can add workflows to appear on that specific client.
If permissions are set in the client, these will overwrite any group permissions.
Also you can specify if authentication for this group needs to be used (you can select None or
Only Scanning).
Pressing the delete button will delete the client from your list
Pressing update will update the client on the MFP. when pressing the button you will see the
device status change to uninstalling and back to installed.
When you add the Lexmark client to server, it installs the application in the MFP automatically.
When you add the Lexmark client to server, it installs the application in the MFP
Lexmark automatically.
Group
Here you can see the group the client belongs to and change settings of the group by pressing the
tool icon. The group settings menu looks like this:
General:
o Status
By clicking the green indicator it changes to red and deactivates the client group.
o Type
This displays the type of group, in this case client. The group type cannot be changed
o Name
The name of the group is displayed and can be changed here
o Description
a short description of the client group can be entered here
Permissions
Here you can set the group permissions. By pressing the + on top of the screen you can add a
Also you can specify if authentication for this group needs to be used. When enabled, the
authentication per client in the same group is disabled.
Client
At the clients menu you will be able to modify, delete or update your client.
Here it is also possible to set permissions per client. by pressing the + on the top of the modify
client screen, you can add workflows to appear on that specific client.
If permissions are set in the client, these will overwrite any group permissions.
Also you can specify if authentication for this group needs to be used.
Pressing the delete button will delete the client from your list
Pressing update will update the client on the MFP. When pressing the button you will see the
device status change to uninstalling and back to installed.
Group
Here you can see the group the client belongs to and change settings of the group by pressing the
tool icon. The group settings menu looks like this:
General:
o Status
By clicking the green indicator it changes to red and deactivates the client group.
o Type
This displays the type of group, in this case client. The group type cannot be changed
o Name
The name of the group is displayed and can be changed here
o Description
a short description of the client group can be entered here
Permissions
Here you can set the group permissions. By pressing the + on top of the screen you can add a
workflow to be shown at all the clients in that group.
Also you can specify if authentication for this group needs to be used. When enabled, the
authentication per client in the same group is disabled.
Client
At the clients menu you will be able to modify, delete or update your client.
In the Samsung settings you can enter the Admin credentials and specify whether it is a normal
client or a webclient, or push the SmartUX client.
Here it is also possible to set permissions per client. by pressing the + on the top of the modify
client screen, you can add workflows to appear on that specific client.
If permissions are set in the client, these will overwrite any group permissions.
Also you can specify if authentication for this group needs to be used.
Pressing the delete button will delete the client from your list
Pressing update will update the client on the MFP. When pressing the button you will see the
device status change to uninstalling and back to installed.
The default password for the application (on the panel of the MPF or in the XOA part) is 0000
Group
Here you can see the group the client belongs to and change settings of the group by pressing the
tool icon. The group settings menu looks like this:
General:
o Status
By clicking the green indicator it changes to red and deactivates the client group.
o Type
This displays the type of group, in this case client. The group type cannot be changed
o Name
The name of the group is displayed and can be changed here
o Description
a short description of the client group can be entered here
Permissions
Here you can set the group permissions. By pressing the + on top of the screen you can add a
workflow to be shown at all the clients in that group.
Also you can specify if authentication for this group needs to be used. When enabled, the
authentication per client in the same group is disabled.
Client
At the clients menu you will be able to modify, delete or update your client.
Here it is also possible to set permissions per client. by pressing the + on the top of the modify
client screen, you can add workflows to appear on that specific client.
If permissions are set in the client, these will overwrite any group permissions.
Also you can specify if authentication for this group needs to be used.
Pressing the delete button will delete the client from your list
Pressing update will update the client on the MFP. When pressing the button you will see the
device status change to uninstalling and back to installed.
Here you can enter the application name and enter the Server Address where Scanshare Enterprise
V4 is installed (e.g. http://IPSERVER:8280).
Note: The default port for Sharp communication is 8280.
After submitting, the application will be available on your device in the OSA section
Group
Here you can see the group the client belongs to and change settings of the group by pressing the
tool icon. The group settings menu looks like this:
General:
o Status
By clicking the green indicator it changes to red and deactivates the client group.
o Type
This displays the type of group, in this case client. The group type cannot be changed
o Name
The name of the group is displayed and can be changed here
o Description
a short description of the client group can be entered here
Permissions
Here you can set the group permissions. By pressing the + on top of the screen you can add a
workflow to be shown at all the clients in that group.
Also you can specify if authentication for this group needs to be used. When enabled, the
authentication per client in the same group is disabled.
Client
At the clients menu you will be able to modify, delete or update your client.
Here it is also possible to set permissions per client. by pressing the + on the top of the modify
client screen, you can add workflows to appear on that specific client.
If permissions are set in the client, these will overwrite any group permissions.
Also you can specify if authentication for this group needs to be used.
Pressing the delete button will delete the client from your list
Pressing update will update the client on the MFP. when pressing the button you will see the
device status change to uninstalling and back to installed.
To install the client software on the machine, go to the webpanel of your multifunctional, then go to
the section Administration and select the Tab EWB.
Enter the IP Address of the server where Scanshare Enterprise V4 is installed to, use the default
port for the server :8089/.
After adding, the link to Scanshare Enterprise V4 will be available in the applications list on your
MFP.
If you directly want to open a workflow or a workflow group, you can enter the direct URL in this
section.
For a workflow: http://IP:8089/Workflow.aspx?id=xxx (xxx= workflow ID)
For a Workflow group: http://IP:8089/WorkflowSelection.aspx?&group=xxx
(xxx= group name (spaces need to be escaped with %20))
For a workflow with groups enabled: http://IP:8089/Workflow.aspx?id=xxx&group=xxx (id =
Workflow ID, group = group name (spaces need to be escaped with %20))
Group
Here you can see the group the client belongs to and change settings of the group by pressing the
tool icon. The group settings menu looks like this:
General:
o Status
By clicking the green indicator it changes to red and deactivates the client group.
o Type
This displays the type of group, in this case client. The group type cannot be changed
o Name
The name of the group is displayed and can be changed here
o Description
a short description of the client group can be entered here
Permissions
Here you can set the group permissions. By pressing the + on top of the screen you can add a
workflow to be shown at all the clients in that group.
Also you can specify if authentication for this group needs to be used. When enabled, the
authentication per client in the same group is disabled.
Client
At the clients menu you will be able to modify, delete or update your client.
Here it is also possible to set permissions per client. by pressing the + on the top of the modify
client screen, you can add workflows to appear on that specific client.
If permissions are set in the client, these will overwrite any group permissions.
Also you can specify if authentication for this group needs to be used.
Pressing the delete button will delete the client from your list
Pressing update will update the client on the MFP. When pressing the button you will see the
device status change to uninstalling and back to installed.
3.2.8.11 PC client
After adding and installing a device, it is visible in the clients menu:
Note: The device status 'installation not supported' is normal. The PC client will still work .
Group
Here you can see the group the client belongs to and change settings of the group by pressing the
tool icon. The group settings menu looks like this:
General:
o Status
By clicking the green indicator it changes to red and deactivates the client group.
o Type
This displays the type of group, in this case client. The group type cannot be changed
o Name
The name of the group is displayed and can be changed here
o Description
a short description of the client group can be entered here
Permissions
Here you can set the group permissions. By pressing the + on top of the screen you can add a
workflow to be shown at all the clients in that group.
Also you can specify if authentication for this group needs to be used. When enabled, the
authentication per client in the same group is disabled.
Client
At the clients menu you will be able to modify, delete or update your client.
Here it is also possible to set permissions per client. by pressing the + on the top of the modify
client screen, you can add workflows to appear on that specific client.
Also you can specify if authentication for this group needs to be used.
If permissions are set in the client, these will overwrite any group permissions.
Pressing the delete button will delete the client from your list
Icons for the PC client and storing of the PC client are done by a webservice.
This webservice is always networkport + 1, so by default 1987 + 1 = 1988.
Group
Here you can see the group the client belongs to and change settings of the group by pressing the
tool icon. The group settings menu looks like this:
General:
o Status
By clicking the green indicator it changes to red and deactivates the client group.
o Type
This displays the type of group, in this case client. The group type cannot be changed
o Name
The name of the group is displayed and can be changed here
o Description
a short description of the client group can be entered here
Permissions
Here you can set the group permissions. By pressing the + on top of the screen you can add a
workflow to be shown at all the clients in that group.
Also you can specify if authentication for this group needs to be used. When enabled, the
authentication per client in the same group is disabled.
Client
At the clients menu you will be able to modify, delete or update your client.
Here it is also possible to set permissions per client. by pressing the + on the top of the modify
client screen, you can add workflows to appear on that specific client.
If permissions are set in the client, these will overwrite any group permissions.
Also you can specify if authentication for this group needs to be used.
Pressing the delete button will delete the client from your list
Pressing update will update the client on the MFP. when pressing the button you will see the
To install the client software on the machine, go to the webpanel of your multifunctional, then go to
the section Administration and select the Tab EWB.
Enter the IP Address of the server where Scanshare Enterprise V4 is installed to, use the default
port for the server :8089/.
After adding, the link to Scanshare Enterprise V4 will be available in the applications list on your
MFP.
If you directly want to open a workflow or a workflow group, you can enter the direct URL in this
section.
For a workflow: http://IP:8089/Workflow.aspx?id=xxx (xxx= workflow ID)
For a Workflow group: http://IP:8089/WorkflowSelection.aspx?&group=xxx
(xxx= group name (spaces need to be escaped with %20))
For a workflow with groups enabled: http://IP:8089/Workflow.aspx?id=xxx&group=xxx (id =
Workflow ID, group = group name (spaces need to be escaped with %20))
3.2.8.13 Plustek
After adding and installing a device, it is visible in the clients menu:
General:
o Status
By clicking the green indicator it changes to red and deactivates the client group.
o Type
This displays the type of group, in this case client. The group type cannot be changed
o Name
The name of the group is displayed and can be changed here
o Description
a short description of the client group can be entered here
Permissions
Here you can set the group permissions. By pressing the + on top of the screen you can add a
workflow to be shown at all the clients in that group.
Also you can specify if authentication for this group needs to be used. When enabled, the
authentication per client in the same group is disabled.
Client
At the clients menu you will be able to modify, delete or update your client.
Here it is also possible to set permissions per client. by pressing the + on the top of the modify
client screen, you can add workflows to appear on that specific client.
If permissions are set in the client, these will overwrite any group permissions.
Also you can specify if authentication for this group needs to be used.
Pressing the delete button will delete the client from your list
Pressing update will update the client on the MFP. when pressing the button you will see the
device status change to uninstalling and back to installed.
3.2.8.14 HP
After adding and installing a device, it is visible in the clients menu:
Group
Here you can see the group the client belongs to and change settings of the group by pressing the
tool icon. The group settings menu looks like this:
General:
o Status
By clicking the green indicator it changes to red and deactivates the client group.
o Type
This displays the type of group, in this case client. The group type cannot be changed
o Name
The name of the group is displayed and can be changed here
o Description
a short description of the client group can be entered here
Permissions
Here you can set the group permissions. By pressing the + on top of the screen you can add a
workflow to be shown at all the clients in that group.
Also you can specify if authentication for this group needs to be used. When enabled, the
authentication per client in the same group is disabled.
Client
At the clients menu you will be able to modify, delete or update your client.
3.2.8.15 Mobile
After installing a APP on the your device and you try to connect at server, if the connection to the
server is successful, it is visible automatically in the clients menu without manually add the client. :
it will have the name and IP address of the device ID that is connecting to the server.
General:
o Status
By clicking the green indicator it changes to red and deactivates the client group.
o Type
This displays the type of group, in this case client. The group type cannot be changed
o Name
The name of the group is displayed and can be changed here
o Description
a short description of the client group can be entered here
Mobile:
if some settings are changed, the preference will be forced by the server. So the
user from the mobile App can not change them and the preferences entered on the
device will be disabled.
o Allow repository
enables repository view (default is enable)
o Allow verification
enables verification view (default is enable)
Permissions
Here you can set the group permissions. By pressing the + on top of the screen you can add a
workflow to be shown at all the clients in that group.
Also you can specify if authentication for this group needs to be used. When enabled, the
authentication per client in the same group is disabled.
Client
At the clients menu you will be able to modify, delete or update your client.
Here it is also possible to set permissions per client. by pressing the + on the top of the modify
client screen, you can add workflows to appear on that specific client.
If permissions are set in the client, these will overwrite any group permissions.
Also you can specify if authentication for this group needs to be used.
Pressing the delete button will delete the client from your list
3.2.9 Users
By adding Users in Scanshare Enterprise V4 you can control who will have access to the Clients.
Users can be put together in a Group, which allows you to change settings for multiple users at
once.
The first time you add a User, you will see this screen:
One default user is already configured. If you want to add new users, you can press the "+New"
Group
Select a pre-defined group here, or select the [+] option. By selecting [+], an extra option will
show up, allowing you to enter a new group name.
Name
Enter the name of the user here
Username
The username will automatically be filled when entering a name. Username can be changed if
desired. The username is used on the client to log in to the application
Password (optional)
Here you can enter a password if you want the user to log in with a password.
Note: creation of users is not subject to licensing but usage of them under Verification and
Repository modules yes. Users licensing is based on a concurrent model for each single module
checking the number of concurrent, logged in, sessions at the same time for the same module.
- The first and second in the list will be the user who activated the license "user repository" (you
If you try to click the button to the right (DELETE button), it will remove that user from the server
and by removing this user his personal repository, if existing, will be removed too:
-Access denied: please check the user permission in the user settings (only Administrator
can modify them).
-Reached max number of user session: please check the user that are connected at the
same time on the Repository server.
Group
Here you can see the group the user belongs to and change settings of the group by pressing the
tool icon. The group settings menu looks like this:
General:
o Status
By clicking the green indicator it changes to red and deactivates the user group.
o Type
This displays the type of group, in this case User. The group type cannot be changed
o Name
The name of the group is displayed and can be changed here
o Description
a short description of the user group can be entered here
Permissions
Here you can set the group permissions. By pressing the + on top of the screen you can add a
workflow to be shown at all the Users in that group.
Access control :
Here you can set the group Repository permissions access control. By default only View
permission is enabled for new users.
User
At the user menu you will be able to modify or delete your user.
Next to the type, group, name, username and password, there is also a possibility to add a short
description to the user and specify it's email address and home folder.
The password is optional, if left empty, the user can log in with only a username.
Here it is also possible to set permissions per client. by pressing the + on the top of the modify
client screen, you can add workflows to appear on that specific client.
If permissions are set in the client, these will overwrite any group permissions.
Here you can set the group Repository permissions access control. By default only View
permission is enabled for new users.
You can find a complete guide on how to create and use an OAuth profile here (Google Drive) , here
(Microsoft OneDrive) and here (Box).
The connector that use OAuth authorization are: Box, Dropbox, GoogleDrive, LEAP, OneDrive,
OneDriveforBusiness and ShareFile.
o Group
Select the user group for this user.
o Type
This displays the type OAuth user.
Note: to create a new OneDrive OAuth user configure your DNS as: myenterprise.scanshare.
com
o Link to User
Select the user you want to link this OAuth account to. If you select [ + ], a new user will be
created.
o Username
Enter the username here (Email address).
o Pin
Enter a Pin for this user to protect the Authorization. The PIN is required for the OAuth
connector ( Box, Dropbox, GoogleDrive, LEAP, OneDrive, OneDriveforBusiness and ShareFile)
to work.
When pressing Authorize, a connection will be made to Box, Dropbox, GoogleDrive, LEAP,
OneDrive, OneDriveforBusiness and ShareFile. If you are already logged in with an email account in
your browser, it will automatically use that account.
If no email account is logged in, a pop up with login screen will appear.
After adding the user, you will see a new user in your list. The lock on the user means it is an OAuth
user.
The group settings for an OAuth user are the same as for normal users. please refer to the User
Settings chapter for a detailed description.
When authorizing the user, the Type, Name, Description and Username cannot be changed.
You can specify an emailaddress and homefolder for the user here (to be used as variable).
The password is optional, if left empty, the user can log in with only a username or when a pin is
entered, this will be used as password.
At the Oauth settings you can change, refresh and check the OAuth type.
Here it is also possible to set permissions per client. by pressing the + on the top of the modify
client screen, you can add workflows to appear on that specific client.
If permissions are set in the client, these will overwrite any group permissions.
Note: it is not possible to use the same username more then once with the same oAuth type.
Note: User Single Sign On will overrule all other applications Single Sign On.
By pressing the button 'User Single Sign On', a new screen will pop up:
By pressing the +, a new screen will show up, allowing you to set a database.
Name
Enter the name for your new profile
Type
Select the type of database, you can either select Windows or AD (active directory)
Server
Enter the Server name to access your database
Username and Password
Enter a username and password with administrator rights to access the database
Domain
Enter the domain from you configure server AD
Username authentication only (active directory)
If enabled it check only username of the user without check AD
3.2.9.3.1 Windows
Setting a Windows Single Sign on, allows you to log on to the MFP client with user credentials from
your windows server and use the Username as a variable.
Once all fields have been filled correctly, you can press next after which a connection will be
established.
If you have a successful connection, the following screen will show up:
Once all fields have been filled correctly, you can press next after which a connection will be
established.
Default Username authentication only is off, when switched on, you can log in by username only. No
password is needed.
When pressing next and a connection can be made, the following menu will be available:
After selecting elements, you can set permissions for the selected elements:
Permissions can be given per element, for some elements at the same time, or for all elements.
In the screen as shown, the permissions set count for all 3 checked elements.
So now CN=John Smith, CN=Tim Yark, OU=finance now have access to workflow 2 and 5.
By checking the checkbox in front of Active Directory or workflow, all elements or workflows will be
selected.
IV
598 Application Manual
4 Appendix
HowTo
Variables
Picklists
Triggers
Regular Expression
Scripts
Updates
Guides
4.1 HowTo
1. HowTo: store to folder
2. HowTo: using barcode as separator
3. HowTo: write a note on a scanned document
4. HowTo: scan to HomeFolder
5. HowTo: choose the output format with triggers
6. HowTo: using email notification and exporting variables
7. HowTo: read data by using the ZoneOCR
8. HowTo: using FreeForm
9. HowTo: scan to Google Drive
10.HowTo: scan to Microsoft OneDrive
You can download this sample included of guide, video and workflow from here.
Requirements:
How to do:
2. Drag a client capture module (PC client or MFP based on the used client)
5. On the left side menu of the question dialog click on Selected and then click on the “+” sign to
create a new List
6. Insert “Document Type” as list name and then client on Static on the left side menu
1) Contract
2) Invoice
3) Other
8. Drag the “Windows File System” Connector and configure it with the following settings:
Folder: C:\Output\ScanToFolder\%MY_DOCTYPE%
Filename: %MY_FILENAME%_%UNIQUECOUNTER2+1%
9. As output profile we select a normal PDF, so not a Searchable PDF (edit the default selected
output profile and uncheck OCR)
You can now try to use the workflow by using the MFP or PC Client. The output will be stored into a
folder in “C:\Output\ScanToFolder”, there will be a folder created with the document type you’ve
selected. In that new folder you new document will be stored with the name you gave during
scanning.
You can download this sample included of guide, video and workflow from here.
Requirements:
(you can download the required file from the provided link above)
How to do:
3. Drag the watch folder capture module and configure it to monitor the above created folder
5. Load the test document for this exercise and draw a zone on the barcode, use the following
settings (to be configured in the barcodes list on the left side menu of the dialog):
Variable: BC
Regular Expression: DOCUMENT-[0-9]+
Disable “Fixed search region”
Enable “Use as separator”
Enable “Remove page”
6. Drag the “Windows File System” Connector and configure it with the following settings:
7. As output profile we select a normal PDF, so not a Searchable PDF (edit the default selected
output profile and uncheck OCR)
You can now copy the barcoded document into the watch folder, and it will be processed by the
workflow.
DOCUMENT-0001-1.pdf
DOCUMENT-0002-1.pdf
DOCUMENT-0003-1.pdf
DOCUMENT-0004-1.pdf
You can download this sample included of guide, video and workflow from here.
Requirements:
How to do:
2. Drag a client capture module (PC client or MFP based on the used client)
3. Create one Typed question, with variable: MY_NOTE o (You can choose the Question and Button
Name by yourself)
Load a document
Select the text type annotation
Create a text area on the bottom of the page and insert the variable: %MY_NOTE%
5. Drag the “Windows File System” Connector and configure it with the following settings:
Folder: C:\Output\Annotation
Filename: Leave the default value, so : Document %YY% %MM%-%DD% %HH24%.%NN%.%
SS%.%FFF%
6. As output profile we select a normal PDF, so not a Searchable PDF (edit the default selected
output profile and uncheck OCR);
Now you are able to Connect with the PC Client or the MFP Client and fill in a note at the question.
Insert the Annotation Document, and then Store it. The Output will be a PDF where at the bottom
your Note will be printed.
You can download this sample included of guide, video and workflow from here.
Requirements:
How to do:
2. Drag a client capture module (PC client or MFP based on the used client)
4. Drag the “Windows File System” Connector and configure it with the following settings:
Folder: %USERHOMEFOLDER%
Filename: %MY_FILENAME%_ %UNIQUECOUNTER+1%
5. As output profile we select a normal PDF, so not a Searchable PDF (edit the default selected
output profile and unchek OCR)
6. Create a new AD profile into the Users section, “New Single Sign On” button (when using MFP
accounting application this AD profile must be the same in use by the accounting application)
7. Make sure the created profile is marked to be enabled (AD users require to have the home folder
set as well otherwise variable will be empty)
Now you can use the PC Client or the MFP client and login using any AD user. Make sure client
authentication is enabled in the client settings (Clients section) or any accounting application is
installed on the MFP when a MFP is used (in this case client authentication is not required to be
enabled). You’ll notice that the Filename question is already filled with some value, so you can leave
it or edit it if you want. The UNIQUECOUNTER will make sure you will never have a duplicated
filename, so your file will be never overwritten.
You can download this sample included of guide, video and workflow from here.
Requirements:
How to Do:
2. Drag a client capture module (PC client or MFP based on the used client)
3. Create a Selected question, with an Explicit item list with 2 static values:
PDF
Word
5. Drag the “Windows File System” Connector and configure it with the following settings:
Folder: C:\Output\PDF
Filename: leave the default value
7. Drag another “Windows File System” Connector, disconnect it from the previous connector (linked
automatically) and make a new connection from the client capture module. Then configure it with
the following settings:
Folder: C:\Output\Word
Filename: leave the default value
8. As output profile select Word (create a new output profile is it doesn’t exist)
9. Add a Condition trigger on the first Windows File System connector route with the following
settings:
10.Add another Condition trigger on the second Windows File System connector route with the
following settings:
(the 2 triggers will decide which route to follow based on the contents of the question variable, the
items list we created. N.B. Operators are case sensitive)
Now you can use the PC Client or the MFP Client with the workflow “PDF or Word”. Depending on
what you select in the list question, the file will be stored in one of the output folder (PDF or Word)
by using the logical decision of the triggers.
You can download this sample included of guide, video and workflow from here.
Requirements:
(you can download all the required files from the provided link above)
How to do:
1. Create a new workflow with the name: “Scan to MyCRM” (note that ‘MyCRM’ is just a random
name)
2. Drag a client capture module (PC client or MFP based on the used client)
4. Drag the “Windows File System” Connector and configure it with the following settings:
Folder: C:\Output\ScanToMyCRM
Filename: Document %YY% %MM% %DD% %HH24%.%NN%.%SS%.%FFF%
5. As output profile we select a normal PDF, so not a Searchable PDF (edit the default selected
6. Drag the Data Export module and configure it with the following settings:
7. Add a Mail trigger on the Windows File System route with the following settings:
From: test@mail.com
To: %USEREMAIL%
Subject: Your document was processed
Body:
Your document with the following details was processed:
Filename: Document %YY% %MM% %DD% %HH24%.%NN%.%SS%.%FFF%.pdf
The document will be imported automatically into MyCRM.
8. Make sure “User Single Sign On” in Users section is enabled with at least 1 AD profile enabled
(AD users require to have the email address set as well otherwise variable will be empty)
9. Save the settings
Now you can use the PC Client or the MFP client to import or scan a document to the workflow
“Scan to MyCRM”. There will be a PDF and a TXT created. There are a lot of applications that
supports importing files by using a TXT of XML file with the additional information.
The workflow will also send an email to the user who scanned the document.
You can download this sample included of guide, video and workflow from here.
Requirements:
(you can download the required files from the provided link above)
How to do:
3. Drag the watch folder capture module and configure it to monitor the above created folder
5. Load the test document for this exercise and draw a zone on the invoice number, then select a
2nd zone around the “For:”-name (the name just below the word “For”)
6. Drag the “Windows File System” Connector and configure it with the following settings
Folder: C:\Output\Invoices\%OCR_ZONE02%
Filename: Invoice_%OCR_ZONE01%_%UNIQUECOUNTER+1%
Now place both ZoneOCR documents into the watch folder: C:\HotFolder\Invoices.
The workflow will create for each “For”-company a new Folder, and uses the invoice number for the
filename.
You can download this sample included of guide, video and workflow from here.
Requirements:
(you can download the required files from the provided link above)
How to do:
3. Click on Viewer on the left,load the document “colored_invoice” and click on Save;
6. Click on Viewer on the left, load the document “dots_invoice” and click on Save;
8. Drag the watch folder capture module and open its settings;
9. As watch folder insert the path “C:\FreeForm Input\” (or click on Browse and then click on “+” to
create it);
11.Drag the “Windows File System” Connector and configure it with the following settings:
12.Add a FreeForm trigger on Windows File System connector route and select both FreeForm
profiles;
You can now copy the files “colored_invoice” and “dots_invoice” into the watch folder “C:\FreeForm
Input”, and they will be processed by the workflow. At the path “C:\FreeForm Output” will be created
two folders with the names of the recognized FreeForm profiles and within each of them there will be
the corresponding document.
You can download this sample included of guide, video and workflow from here.
Requirements:
How to Do:
3. As Username insert the complete Google account address (normally it is the Gmail address);
4. As Pin insert a value to use as password to protect the OAuth token which we will receive by the
Google authorization procedure, then click on Authorize;
5. A popup with Google authorization request will appear, confirm the Google account and login if
necessary, then click on Allow;
6. Now the new OAuth profile is created and it is visible in the list of the users (a small lock icon is
appearing to identify OAuth profiles);
9. Drag the watch folder capture module and configure it to monitor the above created folder;
10.Drag the “Google Drive” Connector and configure it with the following settings:
You can now copy a document into the watchfolder, and it will be processed by the workflow. The
document will be stored on the specified Google Drive account.
You can download this sample included of guide, video and workflow from here.
Requirements:
How to do:
4. As Pin insert a value to use as password to protect the OAuth token which we will receive by the
Microsoft OneDrive authorization procedure, then click on Authorize;
5. A popup with Microsoft OneDrive sign in form will appear, login and then click on Yes.
6. Now the new OAuth profile is created and it is visible in the list of the users (a small lock icon is
appearing to identify OAuth profiles);
8. Drag a client capture module (PC client or MFP based on the used client);
9. Drag the Microsoft OneDrive connector and configure it with the following settings:
You can now try to use the workflow by using the MFP or PC Client. The document will be stored on
the specified Microsoft OneDrive account.
You can download this sample included of guide, video and workflow from here.
Requirements:
SQL Server;
Random testing document;
PC Client or MFP Client.
How to do:
2. Drag a client capture module (PC client or MFP based on the used client) and configure it with
the following question:
1. Selected question of type SQL;
2. Click on the left side "sql" and click on the button "Wizard";
3. Select the Provider: Microsoft OLE DB Provider for SQL Server;
1. Insert in the field Data Source: your Server name;
2. Insert in the field Initial catalog: your DB name;
3. Insert User e Password in their fields;
4. Click test to verify the inserted parameters are correct and the connection works
then click ok;
5. Now we just have to select the table and select the column displayed and the
column returned;
4. Before you click save, try if the list is work by clicking "Show list results";
5. Save all and return the workflow designer.
3. Drag the Windows File System connector and configure it with the following settings:
1. Path: Insert the same path as of the DB column: "C:\Repository"
2. FileName: insert the variable from the filename question: %FILENAME%
4. Drag the Database connector and configure it with the following settings:
1. Select the provider "Microsoft OLE DB Provider for SQL Server"
2. Fill the following properties:
1. Data source: the SQLServer name;
2. Initial Catalog: the DB name;
3. User and Password: the DB credential (SQL based authentication);
3. Click test to verify the inserted parameters are correct and the connection works then
click ok;
4. Click the "INSERT" query button
5. An example of insert query is displayed, customize it as follow: INSERT INTO
[Document] ([IdUser], [Status],[PathFile],[Description])VALUES('%USER%','%VISIBILITY%','C:
\Repository\%FILENAME%','%DESCRIPTION%');
You can now try to use the workflow by using the MFP or PC Client. The document will be stored in
the specified folder in the Windows file systems and inserted into the target SQL Server.
You can download this sample included of guide, video and workflow from here.
Requirements:
Box account;
Random testing document
DNS configured as: myenterprise.scanshare.com
PC Client or MFP Client
How to do:
4. As Pin insert a value to use as password to protect the OAuth token which we will receive by the
Box authorization procedure, then click on Authorize;
5. A popup with Box sign in form will appear, login and then click on Yes.
6. Now the new OAuth profile is created and it is visible in the list of the users (a small lock icon is
appearing to identify OAuth profiles);
8. Drag a client capture module (PC client or MFP based on the used client);
9. Drag the Box connector and configure it with the following settings:
You can now try to use the workflow by using the MFP or PC Client. The document will be stored on
the specified Box account.
4.2 Variables
The Variable Selection Dialog allows inserting Variables automatically, choosing from a drop down
list containing a mix of server standard variables and user created variables (Global questions,
workflow questions, processing derived such as Barcode and OCR recognition). The server standard
variables are:
General
ACTIVATIO Machine unique hardware activation
NKEY key
LICENSEKEY Current installed license key
Server standard
SMTPAUTH SMTP server authentication enabled
ENTICATIO (true/false)
N
SMTPIMPLI SMTP server Implicit SSL enabled
CITSSL (0/1)
SMTPPASS General configured password for
WORD SMTP authentication
SMTPPORTGeneral configured SMTP server port
SMTPSERV General configured SMTP server
ER address
SMTPSSL SMTP server SSL enabled (true/false)
SMTPUSER General configured username for
NAME SMTP authentication
OCR
ABBYYKEY Current installed Abbyy license
ABBYYPAGNumber of remaining monthly pages
ESLEFT allowed to scan with the current
installed Abbyy license (if any)
OCRENGINE OCR engine used
OCRTEXT Text found during OCR
OCRTEXTFILE It is a full path pointing to the text file that contains the ocr (temporary text
file, which will be deleted at the end of the process)
ZONEOCR_SEPARATIO In it you can find the pages where separation occurred (example: 3,7,8,9)
NPAGES
BARCODE
BARCODERIn it you can find the pages where
EADER_SE separation occurred (example:
PARATION 3,7,8,9)
PAGES
BARCODE0 In case there were barcodes for
1_P01 (or multiple pages, NAMEBARCODE_P
name your and the last two numbers eg
barcode) MYBARCODE_P07 (get barcode if
present on page 7)
OCRENGINE OCR engine used
Image properties
IMAGEBITSDEPTH Bits depth of the current image being processed
IMAGEHEIGHT Height in pixel of the current image being processed
IMAGEHRESOLUTION Horizontal resolution of the current image being processed
IMAGEVRESOLUTION Vertical resolution of the current image being processed
IMAGEWIDTH Width in pixel of the current image being processed
Image processing
IMAGEPROCESSING_R Total amount of detected and removed pages by the image processing
EMOVEDEMPTYPAGE module
S
IMAGEPROCESSING_E List of confidence for every removed page, separated by ; (PAGE:
MPTYPAGESCONFIDE CONFIDENCE;PAGE:CONFIDENCE;...)
NCE
FreeForm
FREEFORMCONFIDEN Confidence level of FreeForm profile on the processing document
CE
FREEFORMPROFILE Name of FreeForm profile recognized
Email
EMAILATTACHMENTS Number of attachments to the mail
EMAILATTACHMENTSIZ Size of attachment to the mail
E
EMAILBCCS List of emails in hide cc
EMAILBODY Body of mail
EMAILCCS List of emails in cc
EMAILDOMAIN Domain of the email
EMAILHTMLBODY Email html body for email capturing
EMAILMESSAGEID Email internal ID for email capturing
EMAILPASSWORD Email password for email capturing
EMAILPORT Email port for email capturing
EMAILRECIPIENTS Email recipients for email capturing
EMAILSENDER Email sender for email capturing
EMAILSERVER Email server for email capturing
EMAILSUBJECT Email subject for email capturing
EMAILUSERNAME Email username for email capturing
EMAILISSIGNED Check if the signed / certified email for email capturing
EMAILDATESENT Email data sent for email capturing
EMAILDATARECEIVED Email data received for email capturing
EMAILMESSAGEID Email internal ID for email capturing
WatchFolder
WATCHFOLDERSUBPA Return the path from the root selected Watchfolder to the subfolder where
TH the file has been inserted (only works if Check subfolder has been
enabled)
FTP
FTPFOLDER FTP folder for ftp capturing
FTPPASSWORD FTP password for ftp capturing
FTPPORT FTP port for ftp capturing
FTPSERVER FTP server for ftp capturing
FTPUSERNAME FTP username for ftp capturing
VERIFICATION
NOTE
If you need only a portion of the variable, you can use the variable parsing syntax allowing to extract
just the portion you need. It's enough to enclose in round brackets the parsing directives just after
the variable name, before the end % sign. The parsing directives are semicolon separated and can
include multiple options.
Single character extraction: Just specify the position of the character to extract.
Range extraction: Just specify the first and last position, separated by a minus symbol or how many
characters extract from the beginning and / or the end by using the minus symbol at the beginning
or at the end.
Section extraction by separator: Just indicate the sections separator character(s) followed by the
index of section to return.
Examples:
%MYVARIABLE% = 123*ABCDE*45678
%MYVARIABLE(1;4;6)% = 1*B
In the example above we got only the first, the forth and the sixth character, as indicated in the
round brackets (1,4,6)
%MYVARIABLE(2-7)% = 23*ABC
In the example above we got all characters from second to seventh position (included)
%MYVARIABLE(1-3;8;13-)% = 123D678
In the example above we get the first three characters, followed by the 8th and from the thirteenth
character to the end of the word
In the example above we get the 16th character, but in the sample variable value it doesn't exist so
we get a null value.
%MYVARIABLE(-5)% = 123*A
In the example above, we get the first 5 characters.
%MYVARIABLE('*',1)% = 123
In the example above we get the first section of the variable, considering the asterisk as sections
separators.
%MYVARIABLE('*',2)% = ABCDE
In the example above we get the second section of the variable, considering the asterisk as sections
separators.
%MYVARIABLE('*',3)% = 45678
In the example above we get the third section of the variable, considering the asterisk as sections
separators.
4.3 Triggers
Triggers can be used as failover or in a workflow. one or more triggers can be added at every point.
The triggers are executed serialized in the row they were added.
There are five types of triggers available.
Mail
This trigger allows you to send an email between executing 2 modules. Or, if it is used as failover, it
will send an email when the document couldn't be processed. If the email trigger is enabled, an
email will be send when the scanned document reached the part where the trigger is configured
Enter the right settings here. Only boxes with an asterix are required.
Script
A script trigger allows a script to be executed between two modules when the scanned document
reaches the trigger, or when a workflow fails.
In addition the script trigger can also be used as conditional gate by adding the command: RESULT
= FALSE.
By default, the condition of a script is TRUE.
Condition
Condition triggers act like a gate; as long as the condition is true, it will let the workflow continue. A
false condition terminates the workflow.
When a document reaches the trigger, the trigger will compare the operand against the defined
operand. If this doesn't correspond, the workflow will be determined.
Left operator: this value is read from the document or given as variable when the document is
scanned.
Operand: Select the condition to use, possible options are:
- Equal
- Not Equal
- Less than
- Greater than
- Contains
- Starts With
- Ends with
- Not Contains
- is Valorized (with this option, if the left operator variable is valorized, the document can
proceed. The right operator is skipped in this setting)
- is not Valorized (with this option, if the left operator variable is not valorized, the
document can proceed. The right operator is skipped in this setting)
Right operator: the right operator is the value to meet the condition (left operator).
Split
The splitting trigger lets you split a document on number of pages between two modules in a
workflow.
This way a document can be split before processing, so they are processed as separate
documents.
Free Form
The Free Form trigger is used to perform a Free Form profile check.
If the document is in accordance with the Free Form profile, it will be processed.
Question: it is possible to define a regexp to match a particular format for the question
value;
Barcode recognition: it is possible to define a regexp to match a particular barcode to find
on the document when multiple barcodes of the same type are present;
Zone OCR: it is possible to define a regexp to match a particular value in a zone.
Regexp is a very powerful language and it has got a specific syntax which needs to be respected in
order to create a valid regular expression. Regexp is a standard language, so many information can
be found everywhere about it.
Literal Characters
The most basic regular expression consists of a single literal character, e.g.: a. It will match the first
occurrence of that character in the string. If the string is Jack is a boy, it will match the a after the J
.
Special Characters
If you want to use any of these characters as a literal in a regex, you need to escape them with a
backslash. If you want to match 1+1=2, the correct regex is 1\+1=2. Otherwise, the plus sign will
have a special meaning.
You can use special character sequences to put non-printable characters in your regular expression.
Use \t to match a tab character (ASCII 0x09), \r for carriage return (0x0D) and \n for line feed (0x0A).
More exotic non-printables are \a (bell, 0x07), \e (escape, 0x1B), \f (form feed, 0x0C) and \v (vertical
tab, 0x0B). Remember that Windows text files use \r\n to terminate lines, while UNIX text files use
\n.
Character Classes
With a "character class", also called "character set", you can tell the regex engine to match only
one out of several characters. Simply place the characters you want to match between square
brackets. If you want to match an a or an e, use [ae]. You could use this in gr[ae]y to match either
gray or grey.
Dot
In regular expressions, the dot or period is one of the most commonly used metacharacters.
Unfortunately, it is also the most commonly misused metacharacter.
The dot matches a single character, without caring what that character is. The only exception are
newline characters.
Anchors
Thus far, we have explained literal characters and character classes. In both cases, putting one in a
regex will cause the regex engine to try to match a single character.
Anchors are a different breed. They do not match any character at all. Instead, they match a position
before, after or between characters. They can be used to "anchor" the regex match at a certain
position. The caret ^ matches the position before the first character in the string. Applying ^a to abc
matches a. ^b will not match abc at all, because the b cannot be matched right after the start of
the string, matched by ^.
Similarly, $ matches right after the last character in the string. c$ matches c in abc, while a$ does
not match at all.
Word boundaries
The metacharacter \b is an anchor like the caret and the dollar sign. It matches at a position that is
called a "word boundary". This match is zero-length.
Before the first character in the string, if the first character is a word character.
After the last character in the string, if the last character is a word character.
Between two characters in the string, where one is a word character and the other is not a
word character.
Simply put: \b allows you to perform a "whole words only" search using a regular expression in the
form of \bword\b. A "word character" is a character that can be used to form words. All characters
that are not "word characters" are "non-word characters".
Alternation
You can use alternation to match a single regular expression out of several possible regular
expressions.
If you want to search for the literal text cat or dog, separate both options with a vertical bar or pipe
symbol: cat|dog. If you want more options, simply expand the list: cat|dog|mouse|fish.
Optional items
The question mark makes the preceding token in the regular expression optional. E.g.: colou?r
matches both colour and color.
You can make several tokens optional by grouping them together using round brackets, and placing
the question mark after the closing bracket. E.g.: Nov(ember)? will match Nov and November.
You can write a regular expression that matches many alternatives by including more than one
question mark. Feb(ruary)? 23(rd)? matches February 23rd, February 23, Feb 23rd and Feb 23.
Repetition
The question mark. It tells the engine to attempt match the preceding token zero times or
once, in effect making it optional.
The asterisk or star tells the engine to attempt to match the preceding token zero or more
times.
The plus tells the engine to attempt to match the preceding token once or more.
It is possible also to specify how many times a token can be repeated. The syntax is {min,max},
where min is a positive integer number indicating the minimum number of matches, and max is an
integer equal to or greater than min indicating the maximum number of matches. If the comma is
present but max is omitted, the maximum number of matches is infinite. So {0,} is the same as *,
and {1,} is the same as +. Omitting both the comma and max tells the engine to repeat the token
exactly min times.
You could use \b[1-9][0-9]{3}\b to match a number between 1000 and 9999. \b[1-9][0-9]{2,4}\b
matches a number between 100 and 99999. Notice the use of the word boundaries.
Grouping
By placing part of a regular expression inside round brackets or parentheses, you can group that
part of the regular expression together. This allows you to apply a regex operator, e.g. a repetition
operator, to the entire group. I have already used round brackets for this purpose in previous topics
throughout this tutorial.
Note that only round brackets can be used for grouping. Square brackets define a character class,
and curly braces are used by a special repetition operator.
The regex Set(Value)? matches Set or SetValue. In the first case, the first backreference will be
empty, because it did not match anything. In the second case, the first backreference will contain
Value.
Examples
RegExp information in this topic are based on the information which can be found at the
http://www.regular-expressions.info website. For further information on the regular
expressions you can have a look at the website.
4.5 Scripts
VB Scripting allows you to extend the application functionalities with the integration of the powerful
visual basic scripting language.
Example
Let's say you would like to create a template which allows you to browse to the folder you want to
store the document in, from your MFP or PC Client.
You would create three scripts first:
Script 1
This script will store all folders in the root of the c: drive in" Results", separated by semi-colons. We assume that th
StartingFolder="c:\"
RESULT=""
Script 2
This script will store all child folders of the folder selected in the first script, and store them in RESULTS. We assum
dir1 = Metadata.Values("DIR1")
RESULT=""
Script 3
This script will store all child folders of the folder selected in the second script, and store them in RESULTS.
dir1 = Metadata.Values("DIR1")
dir2 = Metadata.Values("DIR2")
RESULT=""
sz
For each folderIdx In SubFolders
RESULT=RESULT & folderIdx.Name & ";"
Next
Now all that needs to be done, is create a template, which asks three questions in the capture
settings, each question referring to a VB Script to create a picklist, and storing the return value in
metadata %DIR1%, %DIR2% and %DIR3%.
Next to the standard VBS Syntax, the application also allows extra functions in the script.
Metadata.Values("VARIABLENAME")
This returns the value of a variable inside the script, e.g.
myvar = Metadata.Values("BARCODE01")
OR
4.6 Updates
Scanshare Enterprise V4 includes an update system that allows you to be up to date on all the new
features. The application checks every 7 days for new updates and installs them automatically as
long as your maintenance is still active. The automatic updates can be disabled in the settings (see
how here). However, anytime, you can check for updates manually.
Let's see how to update the application manually just following few easy steps:
1. In the Scanshare Enterprise V4 server main page press the settings button in the upper left-hand
corner and select Info.
5. After the update is installed, click the CLOSE button. Wait for the restart of the application until
you seethe above screen.
4.7 Guides
1. Load Balancing & Clustering Guide
4.7.1 Load Balancing & Clustering Guide
1. Introduction
2. Installation topology
3. Requirements
4. Deployment
5. Glossary
4.7.1.1 Introduction
This document describes how to deploy Scanshare with the Process Load Balancing module in a
Network Load Balancing environment for a Load Balancing & Clustering deployment.
This document doesn’t describe how to setup the Network Load Balancing, please refer to the
specific Microsoft TechNet documentation available at: https://technet.microsoft.com/enus/library/
cc754833(v=ws.10).aspx
4.7.1.3 Requirements
Hardware
Software
4.7.1.3.1 Hardware
Scanshare Load Balancing & Clustering deployment requires an amount of physical machines
correspondent to the number of total nodes/clusters to deploy.
Network Load Balancing node machines cannot be the same machines as the Scanshare
Process clusters, so the total amount of machines is calculated by having the Network Load
Balancing nodes + the Scanshare Process clusters;
At least 4 machines with server operating systems are required (2 NLB + 2 Process clusters);
2 network cards are required on the Network Load Balancing nodes in order to correctly setup the
cluster.
4.7.1.3.2 Software
All machines need to be part of the same domain
.NET framework 4.5 needs to be pre-installed on the Scanshare Process Clusters machines
Scanshare Web Server Service (UltiDev Web Server Pro) needs to be running under a domain
administrator account on the MSNLB Node which is used as first installation in order to correctly
deploy Scanshare Process Clusters (required only for automatic installation,can be reverted after
initial deployment)
Network Discovery needs to be enabled on the MSNLB Node which is used as first installation in
order to correctly deploy Scanshare Process Clusters
No proxy/firewall should block routing to the MSNLB node IP’ (network proxy may block routing to
the MSNLB IP’s)
Note: MSSQL Server may be installed as cluster installation as well in order to replicate settings
database for failover
4.7.1.4 Deployment
1. Install Scanshare Server on one of the MSNLB configured nodes, this installation will be referred
as SSSERVER01 from now on in this documentation
2. Start and license SSSERVER01 with an included Load Balancing module (*the number of
possible configurable managing clusters/nodes and process clusters depends on the amount of
connections contained in the license Load Balancing module)
3. On SSSERVER01 switch Scanshare database from the default one to SQL Server by enabling
Cluster Node setting as well:
a. Go to Server Settings
b. Select Database section
c. Switch Database Type to SQL Server
d. Fill in required settings (User is logged in via SQL authentication)
e. Click Migrate button in order to create the Scanshare database and move current
settings (Database doesn’t have to exist before since it will be created by the migration procedure)
f. Enable Cluster node checkbox
g. Save Settings
Note: Target database must not be already existing on the SQL Server because the application will
create new one
4. On SSSERVER01 set the MFP IP addresses to be the MSNLB Cluster IP address (this will allow
also MFP’s to reach the NLB infrastructure otherwise they will be communicating directly with the
node machine)
5. On SSSERVER01 go to Load Balancing section from the main top left menu
First time accessing this feature the Process Cluster installer needs to be created
6. On SSSERVER01, before deploy any Process cluster, configure the Managing Clusters by using
the
“Modify” icon on the unique home cluster existing in the Load Balancing Map
a. Change the Root Process Cluster IP address with the MSNLB Cluster IP Address
b. Add the internal IP address of all MSNLB Nodes under the Managing Clusters section
(*Make sure to use the IP’s of the network card assigned to the MSNLB infrastructure)
c. Save settings
Note: At this point Scanshare gator will update the Process Cluster Installer previously created
because connecting managing cluster information has changed (using MSNLB virtual IP)
10. Install Scanshare Server on all the other MSNLB Nodes, each node is referred as
SSSERVERNLB from now on in this documentation
11. On SSSERVERNLB use a trial license to start application and switch the default database to
the SQL one (see step #3 applied for SSSERVER01 except the usage of the button Migrate).
SSSERVERNLB will connect to the same DB migrated, and in use, from SSSERVER01 will obtain
SSSERVER01 settings and license.
4.7.1.5 Glossary
5.1 Load Balancing module
Optional Scanshare module which allows to distribute the processing workload across multiple and
different machines in parallel real time
5.4 Node
Microsoft Network Load Balancing (MSNLB) base machine which hosts a Scanshare Managing
Cluster.
Clients ports:
Xerox
Sharp
Kyocera
Konica Minolta
Samsung
OKI
Other ports:
- 80 = Automatic Updater & Licensing Services (N.B. Web Service communication is in use, it may
blocked by firewall/proxies/network filters even on standard web port 80)
In order to execute commands run the Windows CMD as Administrator, CWD to the installation
folder and execute the command:
(Please contact support to obtain the offline update pack age, if available)
Host.exe /checklicense
Example result:
Host.exe /updatelicense
Host.exe /removelicense
Remove current license (Note: this operation will stop the application from work ing. A new
license will be requested at the next startup)