docalpha 5.0 Server Configuration Utility User Guide

Transcription

1 docalpha 5.0 Server Configuration Utility User Guide

2 Contents 1. docalpha Architecture Overview docalpha Server Overview 3 2. Working with docalpha Server Configuration Utility Starting docalpha Server Configuration Utility Starting & Stopping docalpha Server Windows Service docalpha Server Configuration Utility Tools Menu Server Options Server Service Configuration License Options Manage Packages Stop Monitoring Station Clean Up Utility Automatic backup options docalpha Server Configuration Utility Help Menu 10 2

3 1. docalpha Architecture Overview Artsyl docalpha is a client-server distributed capture application capable of running on local and global networks. It contains server components and processing stations. Some processing stations can run as unattended Windows Services and so are also often deployed in the server room. The other stations are running in User Interface mode as Windows.NET Applications. Picture 1. docalpha Components Diagram 1.1. docalpha Server Overview docalpha Server is the central component of docalpha capture and classification system. docalpha offers a very modern, fully distributed Microsoft.NET-based SOAtype architecture that ensures flexibility and scalability of the system. The communications between the server and the stations are done via the.net Windows Communication Foundation (WCF) secure communications layer. It offers 2,048-bit dual-key bidirectional encrypted streaming for the files transmitted over open Internet. That ensures that both in local network installations and when using docalpha with global network configuration with some users working via Internet access the system maintains the security of data and documents at all times. Refer to the Admin Guide for details on setting up security settings, user management and other related topics. docalpha Application Logic tier is implemented as a Windows Service. It should be deployed as a fully automatic service running on the server room side and auto-restarting with the server restart. To be able to configure and visually track the service, docalpha offers the Server Configuration Utility. The service can also be configured and controlled from docalpha Status Service Utility from a single convenient location along with the other fully automatic docalpha services such as Auto-Registration, Recognition and Export Stations services. 3

4 docalpha Database tier is using a SQL Server as the DB to store all internal data, workflows and parameters. By default docalpha installs a SQL Server 2008 R2 instance called ARTSYLPRODUCTS10 on docalpha Server installation machine, but it can also be configured to use any other, existent instance of a SQL Server database. The supported versions are SQL Server 2005, SQL Server 2008, SQL Server 2012 and SQL Server bit and 64-bit versions. Refer to the Installation Guide for more details on the prerequisites and installation instructions for the docalpha database with different installation scenarios. docalpha server can be installed and run on all supported server OS and all supported workstation OS (MS Windows XP, Vista, Windows 7, Server 2003, Server 2008, each operation system listed supported for 32-bit and 64-bit platforms). Refer to the Installation Guide for the details of operation system versions and service packs required. All docalpha stations use the Concurrent License model. If you stop a Windows Service for the automatic station such as a Recognition Station on one machine, you can use the same license to start it on another machine. The users of docalpha system use Concurrent Seat Licenses. That means the user can use the same license to start Scan Station and the Verification Station and as soon as the user logs off the license is returned to the server pool of available licenses and can be used by another user. The licenses are managed with the Network License Manager. Refer to the Network License Manager Guide for the details of adding, activating, upgrading, moving and configuring docalpha licenses. 2. Working with docalpha Server Configuration Utility docalpha Server Configuration Utility main purpose is to configure, start and stop the docalpha Server service. It can be also used to troubleshoot the docalpha database connectivity and consistency using its convenient built- in testing and troubleshooting tools Starting docalpha Server Configuration Utility Since the docalpha Server is a Windows Service, its entire configuration is done via the use of the Server Configuration Utility. To start the Utility, select Start All Programs Artsyl docalpha Artsyl docalpha Server docalpha Server Configuration Tool from the Start menu or use the desktop product accelerator icon. The alternative way is to start docalpha Server Configuration Utility from the Single Sign-On Utility that allows signing up just once and then launch any station that the operator has credentials to start without having to re-enter the user name and password: The Main UI window of docalpha Server Configuration Utility will show up: It shows the current status of the service (Started, Stopped, Start Pending or Stop Pending), the version of the docalpha database and allows starting / stopping the docalpha Server Windows service from the toolbar. The menu offers the Tools and Help menu to configure, test & troubleshoot docalpha Application Server Windows service and the internal docalpha Database. by clicking on the Server Utility button. 4

5 2.2. Starting & Stopping docalpha Server Windows Service docalpha Server Configuration Utility Toolbar provides access to starting and stopping the docalpha Server Windows Service. Click on the Start Service button to start the service. The button functions as a toggle button; it changes its face value depending on the current status of the docalpha Server Service. When the service is already running, the button will read Stop Service. Click on the Stop Service button to stop the docalpha Server Windows Service. To change the options for the server, stop the service by clicking on Stop Service, make the necessary changes in the Options dialogue box, and then restart the service again by clicking on Start Service toggle button docalpha Server Configuration Utility Tools Menu Use the docalpha Server Configuration Utility Tools menu (Menu Tools) to configure, test & troubleshoot docalpha Application Server Windows service and the internal docalpha Database: Server Options The Server Options menu item opens a three-tab Options dialogue box that provides access to the following: General tab: Batch folder: The root folder that contains all workflows and their batches. This folder can grow to a large size, it all depends on the number of documents processed per day and the number of days that the images are kept in the system based on the Retention Policies. Refer to the Admin Guide for details on setting up and using the Retention Policies. Interface Language: The default user interface language of the whole docalpha installation (docalpha Server as well as all distributed docalpha Stations). Note: this default setting can be overridden by any of the users if they desire to change their local station user interface language. 5

6 Database tab provides the database connectivity settings for docalpha DB as well as the means for its testing, troubleshooting and rebuilding: Check DB Consistency button may be the most important button to learn among the docalpha Server Configuration Utility tools. This button allows running the integrated consistency check followed by the re-build scripts necessary to bring docalpha to the latest updated state, fixing all kinds of possible issues and errors on the way. This provides a very convenient single-button troubleshooting tool that can fix most of the issues that can be caused by incorrect Administrator actions, hardware power failures and other related problems that may negatively impact the docalpha database: Server: The instance name of the SQL server that hosts the docalpha database. The default instance name for docalpha 5.0-installed instance is ARTSYL- PRODUCTS10. However, an administrator may choose any other pre-configured instance for the installation of the docalpha database. Login: the account login name to connect to the SQL server. The connection to the SQL Server DB is done using this account name. Renew DB: deletes the existent docalpha database and replaces it with a black docalpha database that does not contain any data or definitions. IMPORT- ANT! In result of this operation all data, workflows, settings, batches, Auto-Find knowledgebase, statistics, audit and reporting data, docalpha users and all other docalpha settings and data will be permanently erased from the database! Password: the account password to connect to the SQL server. Test DB Connection button allows quick confirmation if the provided credentials can be used successfully to access the designated SQL Server instance and to access the docalpha database on it: 6

7 Log Options tab provides the settings that control logging depth and provide ability to override the local user- level logging options with a centralized logging policy: Overwrite Clients Log Options: Forces the centralized logging policy to all docalpha distributed stations. The stations will then ignore the local logging depth policy and use the policy selected here in the docalpha Server Configuration Utility options. Log Levels: Selects the logging depth (verbosity). More detailed logging provides better troubleshooting capabilities but at the expense of increase log file size. It is recommended to keep the log level at first or second levels (critical issue only or critical issues and warnings) and switch to more detailed levels only if a detailed troubleshooting is required for a period of time. If the Overwrite Clients Log Option checkmark above is not selected, this policy applies only to docalpha Server. If it is selected, this policy applies to docalpha Server and all distributed docalpha stations Server Service Configuration The Server Service Configuration menu item opens the docalpha Server Service Configuration dialogue box that provides access to the service startup type and credentials used to run the docalpha Server Windows service under the operation system: Note: To be able to run a Windows Service, the account credentials used here needs to have Administrative privileges. To change the Startup Type, select the desired type from the drop-down list and click Update Startup Type button. The changes become effective immediately. To change the credentials used for running the service under the operation system, type in the login name and password and click on Update Login button. The changes will be effective on the restart of the service License Options The License Options menu item opens the License Options dialogue box that provides ability to connect to docalpha Licensing Service that may be running on another machine, another network, or on Artsyl Cloud (for SaaS-based licensing): The dialogue allows to establish the connectivity to the remote or local docalpha Licensing Server. It also offers means to select the default docalpha license or switch docalpha to the alternative license use, such as overflow, testing and other licenses that might be added to the licenses pool and managed at docalpha Licensing Server side. 7

8 Refer to Artsyl Network License Guide for more details about managing multiple docalpha licenses and the default docalpha license selection and activation. The connectivity and license selection parameters are: Connection Settings section: Address: The IP address of docalpha Licensing Server service host machine. If installed on the same machine, use the default localhost settings. Port: The licensing server service port. The default licensing server service port is The firewall needs to be configured on both docalpha Server machine and the Licensing Service host machine to allow communication through the port selected here. In case if you are using cloud license provide valid credentials for User and Password strings. After this click onto Reload license list button and select valid super license from the list which would be set to default for the current license server. Then click onto Set Enterprise License to default to apply selected license. To review the set license`s parameters use License Manager. Use Default License: If this checkmark is selected, then the default docalpha license is used. The default docalpha license is selected in the Network License Manager UI. Refer to the Network License Manager Guide for details on selecting, activating, upgrading and maintaining docalpha licenses. If another license needs to be used instead of the default license, un-check the Use Default License checkmark and select the necessary license from the drop-down list. Note: only licenses that are selected and activated at the Network License Manager side (the currently available licenses) will show up in the drop-down list. If the administrator has just added a license on the Network License Manager machine, to update the list and reflect the new license in the list click on the Update List button. The selected license shows full details in the lower part of the screen. Most sections are further expandable to see even more granular details such as total stations count, annual processing volumes for each licensed recognition engine, etc. Click on the Save button to apply the changes in licensing options and click on the Close button to close the dialogue box. To revert to the default settings, click on the Load Defaults button Manage Packages The Manage Packages menu item provides access to Automatic Update Policies screen that allows fully automatic and centralized control over the server-side and distributed stations-side updates and upgrades. Refer to docalpha Installation guide for more information on how to set up the different types of automatic update Stop Monitoring Station The Stop Monitoring station menu item allows to refresh the license for the monitoring station to return it back to the pool. It should be used if you get the notfreelicense error message while running the docalpha monitoring station as a result of incorrectly stopped services, a Windows system crash etc Clean Up Utility The Clean Up utility allows to delete batches, fix batch data in database, fix batch files according to their status at the Monitoring station (Export Exception, Postponed, Export Done etc.). Also you can set the period of time which allows you to delete/fix the batches that get into this period. 8

9 The main UI interface of Clean up Utility is next: Stop Server button: this button should be used to stop the server, only after this the other operations inside of Clean Up Utility are allowed. Select a date string: allows to choose the period of time to determine only the batches whose creation date get into this period. Status window: allows to determine the batches status: Delete Batches: this button delete the batches according to the specified period of time and selected statuses Fix Batch Data in DB: this button fixes the batches data inside docalpha`s DB according to the specified period of time and selected statuses Fix Batch Files: this button allows to fix the batches documents and images according to the specified period of time and selected statuses Automatic backup options The Automatic backup options menu item allows to setup the Automatic back up option that allows to provide automatic, scheduled back-up of docalpha s internal DB and the Batches folder. The setup instructions can be seen below: 2. For Auto backup options window: 2.1. Interval Type = Selected Day of every Month: 1. Click onto Tools and select Automatics backup options from the provided drop-down list: Select day of month set to 28 for the current example, this means that the auto backup would be done for every 28th day of every month 9

10 2.2. Interval Type = After Interval of Days: Select number of days set to 14 for current example, this means that auto back up will happen every 14 days. The remaining options are the same both for 3.1. and 3.2.: Choose Backup Folder the physical folder on the local machine were the backup files would be saved. Is turned on checkmark is checked to turn the Auto BackUp feature on docalpha Server Configuration Utility Help Menu docalpha Server Configuration Utility Help Menu provides access to the station s help and support capabilities: 1. Contents (F1): provides access to the main help file. 2. Logs Open Log Folder: opens the directory that contains detailed log files for the docalpha Server Configuration Utility. Note that the detailed log files are compressed encrypted files; they would only become necessary if requested by the vendor support team. 3. Logs Open Service Log Folder: opens the directory that contains detailed log files for the docalpha Server Windows Service. Note that the detailed log files are compressed encrypted files; they would only become necessary if requested by the vendor support team. 4. Log pen User Log: provides access to User Log Viewer utility that shows the most important events and issues in user-friendly text format arranged by the date and time of the event, for the docalpha Server Configuration Utility. 7. Help Configurations > Open Service Configuration: allows viewing and editing of the docalpha Server Windows Service configuration XML file. 8. Help Support Send Support Request: generates an addressed to the proper vendor support team and auto-inserts as attachments the necessary configuration information, logs, etc. The operator can add additional comments and/or attachments to the and send it to the support. This provides a single-click issue reporting capability to the operator. 9. About: provides detailed information about the station and all components and interfaces used. The About window contains Copy to Clipboard button that allows copying all the details to the clipboard in case they are needed for reporting, to be able to simply copy-paste all details: 5. Logs Open Service User Log: provides access to User Log Viewer utility that shows the most important events and issues in user-friendly text format arranged by the date and time of the event, for the docalpha Server Windows Service. 6. Help Configurations Open ConfigUtil Configuration: allows viewing and editing of the docalpha Server Configuration Utility configuration XML file. 10