Installation Instructions
Table of Contents
Overview
Note:
If you are updating from version 6153.0 and have already completed these steps, you can skip them.
These instructions apply only to users updating from a version prior to 6153.0.
Below are the detailed instructions for the a NEW and Update installations of XDOC. Also, detailed information on the install and startup of the Axacore.Xdoc.Service.OCR.exe service(s) for the AIVA Document integration and delivery.
NOTE: It is recommended that a single Axacore OCR Service (Axacore.XDoc.Service.OCR.exe) be installed only once per XDoc DB installation. Multiple instances on the same DB is not supported and may cause errors.
XDoc Build 6161 - Clean Installation
Pre-Installation Requirements:
- Download latest XDoc 6153 media
- Microsoft Visual C++ Redistributable for Visual Studio 2015, 2017 and 2019
- .NET 4.8
- Windows Features - IIS
Install Steps:
- Install Media
- Unzip XDoc media to a temp folder – C:\<temp>
- Create a new XDOC folder - C:\XDoc
- Copy all contents from <temp> to the new XDOC folder
- Install the Services
- Open a Command Prompt as an Administrator
- From the C:\XDoc folder install the following services:
- axAllservices.exe -install
- axDispatcher.exe -install
- axRenderagent.exe -install
- From the C:\XDoc\deploy folder install the Axacore.XDoc.Ocr service:
- Copy the C:\XDoc\deploy\Program Files\Axacore\XDoc\Axacore.XDoc.Service.Ocr folder to C:\Program Files\Axacore\XDoc\Axacore.XDoc.Service.Ocr.exe”
- Copy the C:\XDoc\deploy\ProgramData\Axacore\XDoc\bootstrap.config file to folder C:\ProgramData\Axacore\XDoc folder
- Open C:\ProgramData\Axacore\XDoc\bootstrap.config and replace the variables {SERVER}, {DATABASE}, {USER} and {PASSWORD} with the appropriate values in the database connection string. The password value is plain text.
- From an Administrator prompt run:
sc create Axacore.XDoc.Ocr binpath="C:\Program Files\Axacore\XDoc\Axacore.XDoc.Service.Ocr.exe"
- Create the websites
- Open a Command Prompt as an Administrator
- From the C:\XDoc\deploy\WebSiteTemplates folder run both:
- wxWebSite.exe
- wxWebSiteWorkflow.exe
(verify in IIS Manager both sites were created and started)
- Create the Database
- Open SSMS
- Create a new database named xdoc
- Run the following sql files:
- C:\XDoc\deploy\DatabaseScripts\BaseInstall\xd6_axcm_base_install.sql
- C:\XDoc\deploy\DatabaseScripts\UpdateInstall\xd6_axcm_update_install.sql
- Run the following stored procedure to create the default users
- exec axcm.xdba_xapp_dbLoginCreateAxDefault @pDoExe=1, @pDoExeCmds=1, @pDoRebuild=1
- Set database connection settings
- Edit file C:\XDoc\xapp_cfg.xml
- Update the database hostname and port settings where you created your XDOC database
- <DbConnHostname>127.0.0.1</DbConnHostname>
- <DbConnPort>5610</DbConnPort>
- Update the database hostname and port settings where you created your XDOC database
- Edit file C:\XDoc\xapp_cfg.xml
Post-Installation:
- Start the service - XDOC.AllServices
- Start the service – Axacore.XDoc.Ocr
- Restart IIS – iisreset
- Open a browser to localhost and logon
- Username: admin
- Password: password
- Update Document Stores accordingly in Admin-System-System Resources-Document Stores
- Configure any custom Integration settings in the Admin Section
XDoc Build 6161 – Update Installation
- Pre-Update
- Download the latest XDOC Version to temporary folder
- In the temporary folder, unzip the XDOC software.
- Database update
- Stop all XDOC services ( Stop XDOC.AllServices )
- Stop IIS websites for XDOC ( iisreset /stop )
- Backup current XDOC database
- Run XDOC update script located at:
- <unzip location>\deploy\DatabaseScripts\xutil_xdba\xd6_axcm_update.sql
- Software update
- Stop all XDOC services ( Stop XDOC.AllServices )
- Stop IIS websites for XDOC ( iisreset /stop )
- Rename the old XDOC directory to XDOC_LAST
- Create a new XDOC directory
- Copy all contents from <unzip location> to the new XDOC folder.
- Grab the original config files from XDOC_LAST
- XDOC_ LAST \axBootstrap.cfg
- XDOC_ LAST \axSystemConfig.xml
- XDOC_ LAST \axSystemGateway.xml
- XDOC_ LAST \xapp_cfg.xml
- XDOC_ LAST \xapp_cfg_brand.xml
NOTE: If you have any custom files, contact support. DO NOT OVERWRITE ANY OTHER FILES!!
example: Web timeout settings
- Turn back up services
- Start services ( XDOC.AllServices )
- Turn back on IIS ( iisreset )
- Start testing
- Rollback procedure
- Stop all XDOC services ( Stop XDOC.AllServices )
- Stop IIS websites for XDOC ( iisreset /stop )
- Restore Database backup
- Remove XDOC folder
- Rename XDOC_ LAST back to XDOC
- Start services ( XDOC.AllServices )
- Turn back on IIS ( iisreset )
Axacore.XDoc.Ocr
Single OCR Service
Service Name: Axacore.XDoc.Ocr
- must always be running
Installation directory:
- C:\Program Files\Axacore\XDoc\Axacore.XDoc.Service.Ocr
Bootstrap Config File:
- C:\ProgramData\Axacore\XDoc\bootstrap.config
- contains database connection information
Log File Directory:
- C:\ProgramData\Axacore\XDoc\Logs\Axacore.XDoc.Service.Ocr
- Contains 2 subfolders
- IntakeWorker – OCR Send queue
- OutputWorker – OCR Receive queue
- Contains 2 subfolders
Multiple OCR Services
Rules for Multiple OCR Services
-
Config File Naming
- Each service must have its own bootstrap config file.
- File name format: .bootstrap.config Example: Axacore.XDoc.Ocr.1.bootstrap.config Axacore.XDoc.Ocr.2.bootstrap.config
-
Database Connection
- Only one service can point to a database.
- Multiple services pointing to the same DB will cause conflicts.
Example Multi-Instance Setup
- Service Name:
Axacore.XDoc.Ocr.1- Config File:
Axacore.XDoc.Ocr.1.bootstrap.config
- Config File:
- Service Name:
Axacore.XDoc.Ocr.2- Config File:
Axacore.XDoc.Ocr.2.bootstrap.config
- Config File:
Troubleshooting & Verification
-
Logs Location: C:\ProgramData\Axacore\XDoc\logs\
-
Check logs for errors or issues after configuration.
-
Confirm Settings:
- Verify System-AIVA Info-Settings.
- Verify Project-AIVA Info-Settings.
Final Step
- After configuring, restart the OCR service.