TSScan - Usage Guide. Usage Guide. TerminalWorks TSScan 2.5 Usage Guide. support@terminalworks.com

Transcription

1 Usage Guide TerminalWorks TSScan 2.5 Usage Guide Page 1

2 Contents Installation... 5 TSScan Server... 5 TSScan Client... 9 TSScan Modes TSScan Standalone TSScan DS Virtual TWAIN DS TSScan 2.5 GUI Scanner Options Select Scanner Scan Engine Document Source Duplex Scanner UI Ask for more pages Documents Skip if Blank Invert Resolution Color Mode Color Mono Black / White Size Auto Brightness (Only Available in Mono and Color Mode) Brightness (Only Available in Mono and Color Mode) Contrast (Only Available in Mono and Color Mode) Auto Threshold (Only Available in Black/White Color Mode) Page 2

3 Threshold (Only Available in Black/White Color Mode) Format Save Preview Right Click Options Copy Save As Save Selection Remove Selection Restore Selection Clear Scan Action Preview Open Scan Close TSScan Menu File Save Send via Copy to clipboard Exit Tools Options Info About Registration Help TSScan 2.5 Options Compression PDF TIFF Page 3

4 Scanner Driver JPG Quality File Name Preview DPI PDF OCR Ask for more pages (Scanner Driver) Close TSScan when Saved Logging Top Most (Local Driver) Change Engine TSScan Data Source Mapped Local Scanner Licensing FAQ & Troubleshooting There are no scanners showing up on my remote desktop server Scanning options are ignored The scanning is slow It takes a long time till my scans get transferred to the remote desktop server There is a TSScanList.exe process running for each user I receive the following message on the TSScan GUI: Communication failed, please check client installation I am using a WIA driver for my imaging device Does TSScan work on a RWW (Remote Web Workplace) environment Page 4

5 Installation TSScan 2.5 comes in two parts. TSScan Server and TSScan Client. TSScan Server The TSScan Server component should be installed on your remote desktop server. To install TSScan Server please first login to your remote desktop server as a user who has admin privileges. In case your server is inside a domain please use a domain server account. TSScan uses the Microsoft Virtual Channel technology. For TSScan to function properly the usage of the standard Microsoft RDP client is necessary. The same applies for the remote desktop server. The remote desktop server must be the standard RDP server distributed by Microsoft. Third party remote desktop or terminal services application are not supported. Some of those applications do utilize the Microsoft RDP implementation and TSScan could work but in case you experience any issues TerminalWorks cannot provide support. Now let s continue with the installation Page 5

6 Once you have connected to your remote desktop server please execute the TSScan_Server_2.5.exe installer. This will give you the following dialog: TSScan uses minimal configuration. During the installation there are zero configuration options as everything is handled by the installer. So feel free to press Next If you are planning on using TSScan please read the license agreement and accept it if your agree to the terms provided. After you select I accept the agreement please press Next Page 6

7 It is important to mention that TSScan 2.5 requires the.net framework. It is included in most Windows Server installation but in case it is missing the installer will take care of downloading it and installing it for you. You can now feel free to press Next You are free to choose you installation directory as long as it is located inside the Program Files directory. We would suggest that you leave it by default to easier keep track on your installation in case you need support. You can now press Next and continue the installation. Page 7

8 . This is the last screen before the installation starts. It contains just the full path to the installation directory. Please press Install to start the installation. The installation should take no more than 5 minutes. It s mostly over in less than a minute but could take longer depending on the number of profiles you have on your server. Copying the virtual scanner drivers to each profile is the longest running task during the installation. When the installer is done with that you will receive the following dialog: Page 8

9 Please press OK on this dialog and let the installation finish. The process should take now just a few seconds and you should see this dialog: You can uncheck the Launch TSScan Server checkbox as you still need to install the TSScan Client part of TSScan 2.5 to get the full TSScan functionality. TSScan Client The TSScan Client is installed on each workstation which connects to your terminal server and which users are planning to use TSScan. In case you have user you have no need to use TSScan you do not need to install the TSScan Client. The installation is as simple as the server part. First start the client installation by executing the TSScan_Client_2.5.exe. Page 9

10 Just as last time the installation starts with a Welcome dialog. Not much to do here so we can press Next The same agreement that was showed during the server installation is also here present so please accept the agreement and press Next... Page 10

11 Important! During the installation of the TSScan client ALL remote desktop connections should be closed. The TSScan Client will register itself as a component of the Microsoft RDP client. It is important that no mstsc.exe processes are running during the installation as the installer could have problems registering the required TSScan Client DLLs. If you are sure that each RDP connection is closed press Next Just as the server part of TSScan the client will also reside in the Program Files directory. Press Next Page 11

12 This dialog just shows the full path of the TSScan Client installation. You can now proceed and press Install... The installation of the TSScan client takes less than a minute. Press Next Page 12

13 And that s it! TSScan can now be used on the server. For more information on how to use TSScan and what options are available continue to the next section. Page 13

14 TSScan Modes TSScan can be used in three different ways. It can act as a standalone application, as a virtual scanner or it scan map your local scanners directly so that you don t even notice that it is TSScan running. TSScan Standalone The first way is to use it as a standalone scanning application. This way you can scan multiple types of images from your local scanners or you can directly scan to a PDF document. TSScan DS Using this method you can use TSScan as a virtual scanner on your terminal server. When you open your application in which you normally scan and open the list of scanners you should find the TSScanDS. This is a virtual TSScan scanner. When you invoke the TSScan GUI will show up and let you choose from which scanner and with what options you would like to scan. After you scan TSScan just as every other scanner will transfer the images to the application which called it. Virtual TWAIN DS This virtual scanners map directly to your local scanners. If you have for example 3 local scanners attached to your workstation TSScan will map them to virtual scanners on the terminal Page 14

15 servers. The scanners will contain the same name as your local scanners and will behave exactly as they behave. All options are set using your scanner drivers GUI. Using this method you will not see any TSScan interface and you can use your scanner is it is connected directly to your terminal server In the next section we will describe in more detail each of those methods. Page 15

16 TSScan 2.5 GUI Please take a look at the following picture: Now let us explain each component. Scanner Options The scanner options configure the main scanner behavior. The following options are present: Page 16

17 Select Scanner Here you can select the desired scanner from which you wish to scan. On the right side of the dropdown box you will find the Refresh button. Using that button TSScan will retrieve the list of your local scanners attached. You can use the refresh button in case you have TSScan already opened and have connected another scanner. Scan Engine The Scan Engine setting relates to the internal TWAIN CLIENT which is utilized by the TSScan Client. Changing the Scan Engine could change the results of your scans. This option will allow you to cover a wider range of scanner models as by changing this options you will be able to resolve issues presents in the TWAIN driver of that particular scanner. Different scanning engines show different performances, scan quality and scan size. We advise that in case you experience any issues with TSScan that you change the Scan Engine. Currently there are two scan engines available. V2.5 Present in TSScan client 2.5 V2.0 Present in TSScan client 2.0 and 2.5 For changing the scan engine you need to have at least version of the TSScan Server installed. Document Source The Document Source drop down box will contain three entries: 1. Flatbed 2. Feeder 3. Auto detect In case you scanner has no feeder and you can only scan one document at a time you should use this function. Most office scanners have ADF which stand for Auto Document Feeder. The ADF function is similar to your printer paper tray. You put all your paper/documents inside the ADF and it will retrieve page per page and scan them. Use this function if you are exclusively using your scanner with ADF. The Auto Detect option will check if your scanner has any papers inside the ADF. In case the ADF is empty it will scan from the flatbed of the scanner. You should use this option if you are using your scanner in both ways. Based on the scanner that you have this option could sometime not work as expected as some scanner vendors to not follow the TWAIN standard strictly and have not properly implemented the ADF checking. Duplex You should check duplex in case you possess a scanner which can scan in duplex mode. Using duplex scanning you can scan both sides of your document. Even if your scanner has this option sometimes you are scanning only documents which have information only on one side of the paper so duplex scanning them would introduce blank pages. Page 17

18 Scanner UI When you check this option you will notice that all TSScan GUI options get disabled. This is because now TSScan will leave the configuration of the scanning to the scanner drivers. Enabling Scanner UI will delegate all scanning options to your scanner directly and the scanner GUI should appear as soon as you press Scan. This option is very useful in case your scanner driver has options that you will from TSScan. For example your scanner drivers have a wider range of image post processing capabilities like setting the brightness, contrast, temperature of your scanned images. It is also very helpful in case you experience any issues with TSScan where you get weird results from you scan. In such cases we will always suggest you to use Scanner UI as your scanner drivers probably handle scanning better than TSScan can do. Ask for more pages If your scanner has no ADF and you can only scan from flatbed but would like to scan more than one paper or document you can enable this option. It will after each scan ask you if you would like to scan more pages. In case you say Yes the scan that is done next will be appended to the scan before. Documents Skip if Blank Enable this option in case you would like that blank pages are removed from your scan. Please bear in mind that in some cases blank pages are part of the document and removing them would change the look of the document. Invert This option inverts the colors of the picture. Useful in B/W scans where the scan is inverted. This will fix the image by inverting it again to the normal black and white pattern (black fonts white background). Page 18

19 Resolution Using this option you can set the resolution of the resulting image in DPIs. Please bear in mind that as you choose a larger resolution so the image will be larger. On slow networks or if you connect to your remote desktop server via internet connection the transfer time could increase. A value of 300 DPI is more than enough in most cases. This will give you a detailed and large image which still has a acceptable files size. The following standard resolutions are available: But always keep in mind, as the resolution is higher so the file size is higher and the transfer to your terminal server will take longer. Color Mode The color mode can be set to three different values. Those are: Color Setting this mode will scan all your documents with full color. This color mode when selected takes the longest time to be scanned and transferred to your remote desktop server. Only use color mode if you really require color in your documents. For normal documents which are Page 19

20 Mono This mode creates images which are composed exclusively of shades of gray, varying from black at the weakest intensity to white at the strongest. As opposed to pure black and white scans this mode preserves some details. Please take a look at the following images for comparison: GrayScale Image B/W Image Black / White Black and white scans contain only two colors. Because of this the resulting file size is very low and the scanner can scanner at his top speed in this mode. For every document where you do not require any image data but only text this is your mode of choice. Size The size option sets the scanner page size which will be scanned. By default there is a list of predefined page sizes. You can also retrieve the page sizes available from your scanner by clicking on the small page icon right to the Size dropdown box. Page 20

21 Auto Brightness (Only Available in Mono and Color Mode) By checking this option TSScan will try to find the optimal brightness setting for your scan. The image gets post processed after it is retrieved from the scanner. Brightness (Only Available in Mono and Color Mode) This is a slider which makes your scanned image brighter as you move him to the right. If you move your slider to the left the scanned image will get darker. Contrast (Only Available in Mono and Color Mode) This slider controls the contrast of your scanned image. As you move the slider to the right side the contrast will be increased. The opposite happens if you move the slider to the left. Auto Threshold (Only Available in Black/White Color Mode) This option will tell TSScan to find the best threshold value for your black and white scan. The threshold setting controls what pixel will be white and what black based on the threshold value. Threshold (Only Available in Black/White Color Mode) This is the manual configuration of the threshold value. If the value is lower the more pixels will be white. If you increase this value more black pixels will appear. Format There are currently three formats supported by TSScan: 1.) JPEG 2.) TIFF 3.) PDF JPEG is a commonly used method of lossy compression for digital photography (image). The degree of compression can be adjusted, allowing a selectable tradeoff between storage size and image quality. JPEG typically achieves 10:1 compression with little perceptible loss in image quality. TIFF is a flexible, adaptable file format for handling images and data within a single file, by including the header tags (size, definition, image-data arrangement, applied image compression) defining the image's geometry. Digitized replica or scanned copy of a document as it was originally published. This file type preserves all formatting, page numeration, and original images/charts/graphs/etc. TSScan will return your scan in the selected format. Save You can set here to which folder each scan should be automatically saved. In case this field is blank TSScan will ask you to which folder to save after each scan. Page 21

22 Preview Right Click Options Copy Copies the image located inside the preview windows to your clipboard. You can later on then paste it to your favorite word processor or image editor. Save As Save the image currently displayed in the preview window. You will be able to choose the location where it should be saved an the format in which it should be saved. Save Selection In case you have selected a part of the image in the preview you can save that selection and later on restore it using the Restore Selection button bellow. Remove Selection In case you have selected part of the image inside the preview you can clear that selection by clicking on this button. Restore Selection This will restore the last save selection that was saved on the preview windows. Clear Clear the current image displayed in the preview windows together with any selection that could be present. Page 22

23 Scan Action Preview Preview the results of the current scanning options set. When you press this button a preview image will be generated which has a lower resolution than the one which you have selected. This way you will receive a preview fast and can further adjust your settings to receive the desired results. Open Once clicked the last scanned image or last previewed image will show up inside your default image editor or viewer. Scan This starts the scanning process on your local workstation. In case a scan is in progress this button will switch to STOP which will cancel your current scanning progress. Close This closes TSScan. TSScan Menu File Save Using this menu entry you will open the save dialog for the last scanned image or preview where you can choose the location where you wish to save your scan and the format in which you would like to save. Send via Using this option TSScan will automatically open your default application and create a new e- mail with the last scan added as attachment to the message. This way you can quickly scan documents into a PDF document and forward them to another person without having to switch between multiple applications. Copy to clipboard Copies the last scanned or previewed image to your clipboard where you can later on paste it to any applications which accept image pastes. Exit Closes and exits TSScan. Page 23

24 Tools Options Opens the options dialog. The option dialog will be explained in detail in the TSScan 2.5 Options section. Info About Tells you everything you need to know about TSScan. Registration This menu entry contains the licensing dialog for TSScan. You will also find your hardware-id on that dialog. Help This option will lead you to this document. Page 24

25 TSScan 2.5 Options The TSScan 2.5 options are kept simple but still offer you the possibilities to fine tune you TSScan installation so that it suites your environment. The easiest way to go through all options is to first take a look at the options dialog and then explain each option. Compression PDF Set the compression options for scans which are returned as PDFs. Take a look at the compression table. TIFF Set the compression options for scans which are returned as PDFs. Take a look at the compression table. Page 25

26 Both PDF and TIFF have the same compressions options. The following settings are available: Compression table: AUTO JPG LZW ZIP This option will try to find the best compression based on the image scanned. This option will never set JPG as the compression method. Will scan images with the JPEG compression. Very good compression which reduced the image size to 10% of the original but does not sacrifice the quality of the image. Compresses the image with minimal loose of quality. Choose this options if you are using TSScan inside a LAN environment. Uses the ZIP compression for your images. None None compression is applied and you get a high quality image but the file size will be extremely large so avoid disabling the compression of the scanned images. Scanner Driver Opposed to PDF and TIFF compression settings this compression settings configure the way images are compressed from your local scanner and then transferred to the virtual scanner on your remote desktop server. This setting is critical when you wish to achieve good transfer rates of your scanned documents to the remote desktop server. The following compression methods are available to choose from: JPG JPG (In TIFF) None Creates individual JPEG images and puts them inside a single TIFF file on your local workstation. It later then transfers that TIFF file to your remote desktop server. This compression method has shown to be the fastest. Single JPEGs are transferred to your remote desktop server and then packed for transfer to your virtual scanner driver. Saves resources on your local workstation. No compression. The resulting images have a huge file size. This option should only be used in case you have a very fast internet connection or are working inside a LAN environment. JPG Quality All JPG compressed images are affected by this setting. If you move the slider to the right the quality of JPG images will increase together with the file sizes. Please adjust this setting depending on the Page 26

27 network connection that you have. If you have a fast internet connection or are connecting inside a LAN to your remote desktop server increase the quality. If you have a very slow connection please reduce the quality of the JPG images to receive faster transfer rates. File Name Here you can choose the way files should be saved if you set the file path for automatic saving. Two options are available: 1.) Auto Number Each scan will be saved with a number attached to the end of the file name and increased after each scan. 2.) Date Time Append the date and time in the format specified by the dropdown box. Preview DPI This option controls in which resolution should the preview scan be scanned. The default value is 50 what we also recommend as for previewing the image this resolution offers both enough details but also a fast transfer rate. PDF OCR By enabling this option the TSScan Client will OCR each scanned document which you selected to be saved in a PDF document on the TSScan GUI. This option requires that you have the Transym OCR library installed on your local workstation. Direct download link: Product link: Ask for more pages (Scanner Driver) In case you are using the virtual scanner driver the dialog which asks for more pages will be displayed after each scan. This shows useful when you use a flatbed scanner but would like to scan multiple documents into your application without having to do the scanning procedure for each page separately. Close TSScan when Saved Automatically closes TSScan once you save your scanned document. Logging Once checked this option will turn on the logging facility of TSScan. In case you experience any issues with TSScan please turn this option on, do a few scans which produce the issues that you would like to report and send to support@terminalworks.com the %APPDATA%\TSScan folder on your local workstation. Top Most (Local Driver) This will set each TSScan dialog together with your local scanner driver dialogs as top most. This option should always be turned on as your remote desktop window could cover up your scanner dialog. Page 27

28 Change Engine The Change Engine button opens up the Scan Engine selection dialog which will set he scanning engine for the virtual TSScan TWAIN drivers. Page 28

29 TSScan Data Source As we mentioned earlier TSScan can work in two modes. The first is as a standalone application which you can use to scan from your local scanners while working on a remote desktop server. The second mode is that TSScan will work as a virtual scanner. In the TWAIN standard scanners are normally named data sources. TSScan has two different types of TWAIN data sources. The first one is the TSScan DS which we will discuss in this chapter. The other type of data source is the virtual scanner mapped to your local scanners. You will normally invoke the TSScan Data Source in case when you try to scan from a third party application and choose the TSScan Scanner. Once you select the TSScan virtual scanner (data source) and started scanning the above application will show up. It looks very similar to the normal standalone TSScan application but it is missing the format and save settings. That s because instead of saving the scan to your hard drive in PDF, JPEG or TIFF the TSScan data source will return the scanned image to the application which called it. Using the TSScan DS you can use TSScan just like any other scanner. In case you would like to avoid the TSScan GUI and use your local scanner directly than take a look at the next capture. Mapped Local Scanner Once you install TSScan on your remote desktop server it will create 10 data sources (virtual scanners). Later on TSScan will look up what scanners you have locally available and map them to those virtual data sources. Using this technique you will be able to utilize your local scanners as if they were attached to the server. If I open the scanner selection dialog on my local workstation I will receive the following list: Page 29

30 If I open the scanner selection on my terminal server with TSScan installed I will receive the following list of scanners: As you probably see the list is identical except that there is also the TSScan scanner which we discussed earlier. Once you choose your desired scanner and start scanning the dialog of your local scanner will show up over your remote desktop window. You can then use your scanner just as before. Once you finished scanning TSScan will take care of those scans, transfer them from your local workstation to your remote desktop server and import them into the application which invoked the scan. During that process TSScan also compresses each scan so that even on very slow networks you get great performance. Licensing TSScan 2.5 comes with 3 types of licenses: Unlimited license o You can have as many users on your remote desktop server as you please. The number of scanners, TSScan clients etc. is also not counted. 10 Clients license o You can have a maximum of TEN users on your remote desktop server. If more than 10 users are present TSScan will not work till the number of users is below the amount of Clients license o There can be at most 3 users present at your server. If more than that are present TSScan will not work. All licenses have no additional fees or recurring charges attached to them. Also each license gives you a life-time upgrade policy. So whenever a new version of TSScan gets release you have the right download it and install it. For 10 Clients and 3 Clients licenses please visit: Page 30

31 FAQ & Troubleshooting There are no scanners showing up on my remote desktop server You should follow the next steps to resolve this issue: 1.) Check if the TSScan client is properly installed 2.) Check if you have the latest version of both the TSScan Server and the TSScan client installed. 3.) Please check if the TSScan drivers are in the proper location: If you are connected to your remote desktop server as a user make sure that the DS files are located in: o C:\Users\<USER>\WINDOWS\twain_32\TSScanDS If you connected to your remote desktop server for administration purposes make sure that the DS files are located in: o C:\Windows\twain_32\TSScanDS Both of those files should contain multiple *.DS files. In case they are missing please copy the TSScanDS folder and the twain_32.dll file from: C:\Program Files(x86)\TerminalWorks\TSScan Server\twain_32 To: C:\Windows\twain_32\ C:\Users\<USER>\WINDOWS\twain_32\ Scanning options are ignored In case you experience this issue when scanning and all your settings (B/W, Color etc) are ignored please open up the TSScan options and enable the TSScan UI option. The scanning is slow If the process of scanning is slow there could be multiple reasons. 1.) Change the color mode to black and white and reduce the resolution of your scans. 2.) If your scanner is scanning slowly even if the settings indicated a low resolution black and white scan then check what drivers are you using for your scanner. Some manufacturers are by default installing WIA drivers which very often show such behavior when utilized by third part utilities. To resolve that please contact your manufacturer for TWAIN drivers. They are available in most cases as a separate download or they get installed when you install the complete package. It takes a long time till my scans get transferred to the remote desktop server This relates to the quality of the scans and the speed of the connection to the remote desktop server. Page 31

32 The easiest way to reduce the size of the scan is to set the compression to JPG and reduce the quality of the JPG compression. Both steps can be done in the TSScan Options. If possible also please change the color mode to black and white which will greatly reduce the scan size. There is a TSScanList.exe process running for each user This process is responsible for mapping your local scanners to the remote desktop server. It also copies the necessary virtual scanning drivers to the user profile. As your scanners probably rarely change you could remove this process by renaming the TSScanList.exe from: C:\Program Files(x86)\TerminalWorks\TSScan Server\tsscanlist.exe To: C:\Program Files(x86)\TerminalWorks\TSScan Server\tsscanlist1.exe By renaming it will not start automatically again. In case you changed your local scanners you could manually execute this process again or by using TSScan go to options and press the Change DSM button. This will remap your scanners and check if all drivers are present in your profile. This process is NOT running for a user who does not have the TSScan Client installed on their local workstation. I receive the following message on the TSScan GUI: Communication failed, please check client installation. This message is show when the TSScan server is not able to communicate with the TSScan Client. In most cases this can be traced back to either wrongly installing the TSScan Server on the local workstation and the client on the server. It also happens that some registry cleaners and performance improving software outright deletes the necessary registry key for the TSScan Client. One case where you could receive this message is when using Microsoft RWW which in some cases requires additional manual steps. I am using a WIA driver for my imaging device WIA drivers are supported to some degree but you could experience performance issues and some of the options could not work. We always suggest our clients to contact their vendor and check if an appropriate TWAIN driver is available for their imaging device. Does TSScan work on a RWW (Remote Web Workplace) environment Log-in to the SBS which is hosting the RWW web interface. On the SBS server you should find the tsweb.aspx file in the RWW web page folder. Add the following line: MsRdpClient.AdvancedSettings.PluginDlls = "TSPrint.dll" This line should be added below the following line: 'Device redirection options Once you added this line you need to restart the IIS server so that the changes take effect. Page 32