1 | P a g e
IBM Datacap Deployment Automation Scripts
Contents Overview ...................................................................................................................................................... 2
Automation scripts .................................................................................................................................. 2
Component nodes .................................................................................................................................. 3
Deploying Datacap ..................................................................................................................................... 4
Installing the prerequisites .................................................................................................................... 5
Modifying scripts for custom applications ........................................................................................... 6
Running scripts for simple one-machine deployment ....................................................................... 7
Running scripts for simple two-machine deployment ....................................................................... 8
Running scripts for simple three-machine deployment .................................................................. 10
Readying the system for use after deployment ............................................................................... 12
Reference .................................................................................................................................................. 13
Installation script ................................................................................................................................... 13
Configuration script .............................................................................................................................. 14
Sample application configuration (SAC) scripts .............................................................................. 15
SAC script: Microsoft Access database and TMA authentication ....................................................... 16
SAC script: Microsoft SQL database .................................................................................................... 17
SAC script: Oracle database ................................................................................................................ 19
SAC script: IBM DB2 database ............................................................................................................. 21
Update script ......................................................................................................................................... 24
Final state of components after deployment .................................................................................... 25
2 | P a g e
Overview The IBM Datacap deployment automation scripts automate the installation of IBM Datacap components in
a client/server environment. The scripts are applicable to the following versions of IBM Datacap: 8.1, 9.0,
and 9.0.1.
The name of IBM Datacap and the names of many Datacap components were changed in version 9.0.
For the equivalent names that were used in version 8.1, see Highlights of IBM Datacap Version 9.
The use of an orchestration engine like Urbancode Deploy (UCD) is suggested but not required to run the
scripts. If UCD is being used, one possible use case is as follows:
Export components and applications from the internal Datacap UCD to the target UCD.
Use the exported components and applications to build new workflow processes.
The use of an orchestration engine is not the subject of this document, however.
Automation scripts The scripts that deploy Datacap components are of two types:
Batch (.bat) The batch files use native Windows OS commands, which make the batch files portable across various Windows versions and easy to run.
Groovy (.gvy) The Groovy scripts are platform independent and require the installation of the free distribution of Groovy from the Groovy site.
Here are the four main scripts:
Main purpose Script details
Component installation install.bat
This batch file installs an applicable IBM Datacap version.
Component configuration configure.bat
This batch file configures the systems so that they can function in a distributed client/server environment as a unit.
Sample application configuration (SAC)
The specific SAC script that you run depends on the database type. Here are the main scripts:
appsconfig.gvy
configureApp4Ora.bat
configureApp4db2.bat
configureApp4sql.bat
The batch files in this list call Groovy scripts. These scripts configure the sample applications for taskmaster servers. For more information, see Sample application configuration (SAC) scripts.
Component updates
update.bat
If necessary, this batch file applies an IBM Datacap update. For example, it might update IBM Datacap version 8.1.0 to 8.1.0.3.
3 | P a g e
Component nodes A node refers to the way that Datacap components can be installed together on any one machine. The
bolded node names in the following diagram refer to the values that can be specified for the component
argument of the install.bat and update.bat scripts. (Two possible nodes are not shown in the
diagram: all and clients.)
Here are the possible component nodes:
all Installs all components of Datacap.
serverandapps Installs Datacap Server and the following applications:
Datacap Accounts Payable
TravelDocs
Flex
Application Wizard
FastApp (IBM Datacap Taskmaster Capture 8.1 only)
serverandwebclient Optional: Installs Datacap Server and Datacap Web Server. You can have multiple nodes of this type.
IBM Datacap Deployment Automation Sequence
rrs
update.bat
serverandwebclient
install.bat
serverandapps
DB Server
Pre-configured
Pre-configured
LDAP
Server clientsandrr
install.bat
configure.bat configure.bat configure.bat configure.bat
install.bat install.bat
update.bat update.bat update.bat
SAC script
4 | P a g e
rrs Installs the following components:
Rulerunner Service
Fingerprint Service
eMail and eDoc connectors
Datacap Insight Edition (IBM Datacap 9.0.1 only)
clients Installs the following components:
Datacap Desktop
Datacap Web Services
Datacap Maintenance Manager
Datacap Report Viewer
Datacap FastDoc
Datacap Studio
Datacap Insight Edition (IBM Datacap 9.0.1 only)
clientsandrr Installs the components that are listed for the rrs and clients nodes.
Deploying Datacap In terms of this procedure, there are two main types of Datacap deployments: simple deployments and all
other deployments. A simple deployment involves the use of the default Microsoft Access database and
default TMA authentication. For simple deployments, detailed procedures exist that show the precise way
that install.bat and other scripts are to be run. For all other deployments, reference documentation is
provided for script parameters.
To deploy IBM Datacap:
1. Ready the machines for Datacap installation. See Installing the prerequisites.
2. For any deployment other than simple one-machine deployment, download and install a
distribution of Groovy on the machine that hosts the IBM Datacap sample applications.
Specifically, install Groovy to the following path: "C:\Program Files\agent\opt\groovy-1.8.8”. For
more information, see the Groovy website.
Important: If you do not install Groovy to the specified path, the batch files that call Groovy fail.
The double quotes around the path are required since the path contains whitespaces.
3. Optional: Modify the scripts so that your custom applications can be installed and configured in
the same manner as the IBM Datacap sample applications. See Modifying scripts for custom
applications.
4. For a simple deployment with Microsoft Access as the database and TMA authentication, select
one of the following procedures based on your topology:
o Running scripts for simple one-machine deployment
o Running scripts for simple two-machine deployment
o Running scripts for simple three-machine deployment
5 | P a g e
5. For all other deployments, perform the following steps for each node:
Important:
o For information about nodes, see Component nodes.
o Each step has a link to reference documentation for the relevant script. You can also
obtain help for any script by running the script with the –help option.
a. Run the installation script. See Installation script.
b. Run the configuration script. See Configuration script.
c. For the serverandapps node, run one of the following scripts based on your database:
SAC script: Microsoft Access database and TMA authentication
SAC script: Microsoft SQL database
SAC script: Oracle database
SAC script: IBM DB2 database
d. Run the update script. See Update script.
6. For the serverandapps node, if you modified scripts for your custom applications (in step 3), edit
C:\Datacap\datacap.xml to add an app element for your application.
7. Ready the system for use. See Readying the systems for use after deployment.
8. Optional: Perform other configuration as needed. For more information, see Final state of
components after deployment.
Installing the prerequisites Here is a list of things that need to be in place before you run the deployment automation scripts.
Database If you need to use a database other than the default Microsoft Access database, install and configure a database. For more information, see Databases.
LDAP server If you need to authenticate by using an enterprise directory server instead of the default TMA, install and configure an LDAP server. For more information, see Configuring authentication for Datacap.
Windows account Configure a Windows domain user. For more information, see Domains and Windows accounts.
File share Make a file share accessible to all machines in the deployment environment. This file share hosts installable images, common configuration files, and other items.
Unzip utility
The scripts use the unzip utility to extract zipped files. If this utility is not already installed, do as follows:
1. Install the utility.
2. Update the PATH environment variable so that a command-line
reference to the utility works.
Other prerequisites
For all other prerequisites, see Prerequisites for installing Datacap.
6 | P a g e
Modifying scripts for custom applications You can modify some of the automation scripts so that your custom applications are installed and
configured in the same manner as the IBM Datacap sample applications.
To modify scripts for your custom applications:
1. Determine the gvy file to modify:
Microsoft ACCESS database appsconfig.gvy
Oracle 11g appsconfig4ora.gvy
Microsoft SQL appsconfig4sql.gvy
IBM DB2 database appsconfig4db2.gvy
2. Modify the gvy file as follows:
a. Look for the global variable at top of file named appList.
b. Replace the name Survey with your application name. If you have two applications,
replace DotEdit_Large_DemoJob with the name of your second application;
otherwise, do not change it.
c. Look for the variable that is named appFile and replace Survey with your application
name: 'Survey':'C:\\Datacap\\Survey\\Survey.app'. If you have two applications,
repeat the same action with the DotEdit_Large_DemoJob.
d. Save and exit the file.
3. Create a zip file of your application in such a way that extracting the application to the
Datacap root folder has the following result: the application name is created as the first
subfolder that follows the root. Place the application zip file in a folder that you can specify for
the customAppsDir argument for the install.bat script.
7 | P a g e
Running scripts for simple one-machine deployment This deployment involves the following circumstances:
You are installing all IBM Datacap components on a single machine
You are using the default Microsoft Access database and default TMA authentication
In these circumstances, the Datacap server is the localhost and the various file paths are sufficient as
initially configured. You do not need to do the following actions:
Modify application (.app) files
Install Groovy (since the application files are not being modified)
Connect to a remote database
IBM Datacap Taskmaster Capture 8.1
Run the following commands:
1. install.bat <pathToInstallImage> all 8.1 yes C:\Temp
For information about script parameters, see Installation script.
2. configure.bat C:\Datacap\Taskmaster <username> <password> localhost
For information about script parameters, see Configuration script.
3. update.bat <pathToUpdateFile> all 8.1 TMA
For information about script parameters, see Update script.
IBM Datacap 9.0
Run the following commands:
1. install.bat <pathToInstallImage> all 9.0 yes C:\Temp
For information about script parameters, see Installation script.
2. configure.bat C:\Datacap\Taskmaster <username> <password> localhost
For information about script parameters, see Configuration script.
3. update.bat <pathToUpdateFile> all 9.0 TMA
For information about script parameters, see Update script.
IBM Datacap 9.0.1
Run the following commands:
1. install.bat <pathToInstallImage> all 9.0.1 yes C:\Temp
For information about script parameters, see Installation script.
2. configure.bat C:\Datacap\Taskmaster <username> <password> localhost
For information about script parameters, see Configuration script.
3. update.bat <pathToUpdateFile> all 9.0.1 TMA
For information about script parameters, see Update script.
8 | P a g e
Running scripts for simple two-machine deployment This deployment is for Microsoft Access and TMA authentication.
All steps of the same numeric value might be run in parallel across all machines. For more information,
see Component nodes.
IBM Datacap Taskmaster Capture 8.1
On the serverandapps node, run the following commands:
1. install.bat <pathToInstallImage> serverandapps 8.1 yes <configPath>
For information about script parameters, see Installation script.
2. configure.bat <configPath> <username> <password> <tmsCName>
For information about script parameters, see Configuration script.
3. "C:\Program Files\agent\opt\groovy-1.8.8\bin\groovy" appsconfig.gvy <tmsHost> <sharedPath> 8.1
For information about script parameters, see SAC script: Microsoft Access database and TMA authentication.
4. update.bat <pathToUpdateFile> serverandapps 8.1 TMA
For information about script parameters, see Update script. On the other machine, run the following commands:
1. install.bat <pathToInstallImage> clientsandrr 8.1
For information about script parameters, see Installation script.
2. configure.bat <configPath> <username> <password> <tmsCName>
For information about script parameters, see Configuration script.
3. update.bat <pathToUpdateFile> clientsandrr 8.1 TMA
For information about script parameters, see Update script.
9 | P a g e
IBM Datacap 9.0
On the serverandapps node, run the following commands:
1. install.bat <pathToInstallImage> serverandapps 9.0 yes <configPath>
For information about script parameters, see Installation script.
2. configure.bat <configPath> <username> <password> <tmsCName>
For information about script parameters, see Configuration script.
3. "C:\Program Files\agent\opt\groovy-1.8.8\bin\groovy" appsconfig.gvy <tmsHost> <sharedPath> 9.0
For information about script parameters, see SAC script: Microsoft Access database and TMA authentication.
4. update.bat <pathToUpdateFile> serverandapps 9.0 TMA
For information about script parameters, see Update script. On the other machine, run the following commands:
1. install.bat <pathToInstallImage> clientsandrr 9.0
For information about script parameters, see Installation script.
2. configure.bat <configPath> <username> <password> <tmsCName>
For information about script parameters, see Configuration script.
3. update.bat <pathToUpdateFile> clientsandrr 9.0 TMA
For information about script parameters, see Update script.
IBM Datacap 9.0.1
On the serverandapps node, run the following commands:
5. install.bat <pathToInstallImage> serverandapps 9.0.1 yes <configPath>
For information about script parameters, see Installation script.
6. configure.bat <configPath> <username> <password> <tmsCName>
For information about script parameters, see Configuration script.
7. "C:\Program Files\agent\opt\groovy-1.8.8\bin\groovy" appsconfig.gvy <tmsHost> <sharedPath> 9.0.1
For information about script parameters, see SAC script: Microsoft Access database and TMA authentication.
8. update.bat <pathToUpdateFile> serverandapps 9.0.1 TMA
For information about script parameters, see Update script. On the other machine, run the following commands:
4. install.bat <pathToInstallImage> clientsandrr 9.0.1
For information about script parameters, see Installation script.
5. configure.bat <configPath> <username> <password> <tmsCName>
For information about script parameters, see Configuration script.
6. update.bat <pathToUpdateFile> clientsandrr 9.0.1 TMA
For information about script parameters, see Update script.
10 | P a g e
Running scripts for simple three-machine deployment This deployment is for Microsoft Access and TMA authentication.
All steps of the same numeric value might be run in parallel across all machines. For more information,
see Component nodes.
IBM Datacap Taskmaster Capture 8.1
On the serverandapps node, run the following commands:
1. install.bat <pathToInstallImage> serverandapps 8.1 yes <configPath>
For information about script parameters, see Installation script.
2. configure.bat <configPath> <username> <password> <tmsCName>
For information about script parameters, see Configuration script.
3. "C:\Program Files\agent\opt\groovy-1.8.8\bin\groovy" appsconfig.gvy <tmsHost> <sharedPath> 8.1
For information about script parameters, see SAC script: Microsoft Access database and TMA authentication.
4. update.bat <pathToUpdateFile> serverandapps 8.1 TMA
For information about script parameters, see Update script. On the rrs node, run the following commands:
1. install.bat <pathToInstallImage> rrs 8.1
For information about script parameters, see Installation script.
2. configure.bat <configPath> <username> <password> <tmsCName>
For information about script parameters, see Configuration script.
3. update.bat <pathToUpdateFile> rrs 8.1 TMA
For information about script parameters, see Update script. On the clientsandrr node, run the following commands:
1. install.bat <pathToInstallImage> clientsandrr 8.1
For information about script parameters, see Installation script.
2. configure.bat <configPath> <username> <password> <tmsCName>
For information about script parameters, see Configuration script.
3. update.bat <pathToUpdateFile> clientsandrr 8.1 TMA
For information about script parameters, see Update script.
11 | P a g e
IBM Datacap 9.0
On the serverandapps node, run the following commands:
1. install.bat <pathToInstallImage> serverandapps 9.0 yes <configPath>
For information about script parameters, see Installation script.
2. configure.bat <configPath> <username> <password> <tmsCName>
For information about script parameters, see Configuration script.
3. update.bat <pathToUpdateFile> serverandapps 9.0 TMA
For information about script parameters, see Update script. On the rrs node, run the following commands:
1. install.bat <pathToInstallImage> rrs 9.0
For information about script parameters, see Installation script.
2. configure.bat <configPath> <username> <password> <tmsCName>
For information about script parameters, see Configuration script.
3. update.bat <pathToUpdateFile> rrs 9.0 TMA
For information about script parameters, see Update script.
On the clientsandrr node, run the following commands:
1. install.bat <pathToInstallImage> clientsandrr 9.0
For information about script parameters, see Installation script.
2. configure.bat <configPath> <username> <password> <tmsCName>
For information about script parameters, see Configuration script.
3. "C:\Program Files\agent\opt\groovy-1.8.8\bin\groovy" appsconfig.gvy <tmsHost> <sharedPath> 9.0
For information about script parameters, see SAC script: Microsoft Access database and TMA authentication.
4. update.bat <pathToUpdateFile> clientsandrr 9.0 TMA
For information about script parameters, see Update script.
12 | P a g e
IBM Datacap 9.0.1
On the serverandapps node, run the following commands:
4. install.bat <pathToInstallImage> serverandapps 9.0.1 yes <configPath>
For information about script parameters, see Installation script.
5. configure.bat <configPath> <username> <password> <tmsCName>
For information about script parameters, see Configuration script.
6. update.bat <pathToUpdateFile> serverandapps 9.0.1 TMA
For information about script parameters, see Update script. On the rrs node, run the following commands:
4. install.bat <pathToInstallImage> rrs 9.0.1
For information about script parameters, see Installation script.
5. configure.bat <configPath> <username> <password> <tmsCName>
For information about script parameters, see Configuration script.
6. update.bat <pathToUpdateFile> rrs 9.0.1 TMA
For information about script parameters, see Update script.
On the clientsandrr node, run the following commands:
5. install.bat <pathToInstallImage> clientsandrr 9.0.1
For information about script parameters, see Installation script.
6. configure.bat <configPath> <username> <password> <tmsCName>
For information about script parameters, see Configuration script.
7. "C:\Program Files\agent\opt\groovy-1.8.8\bin\groovy" appsconfig.gvy <tmsHost> <sharedPath> 9.0.1
For information about script parameters, see SAC script: Microsoft Access database and TMA authentication.
8. update.bat <pathToUpdateFile> clientsandrr 9.0.1 TMA
For information about script parameters, see Update script.
Readying the system for use after deployment If you performed a single machine deployment with Microsoft ACCESS database and TMA
authentication, the system is ready for use.
Otherwise, do as follows before you use the deployed Datacap system:
1. Run Datacap Application Manager from the clientsandrr or clients machine.
2. Select the applications you migrated into the database from the Applications list so that it is loaded.
3. Visually inspect the values from the Main tab and Save Changes to ensure that connection strings
are encrypted.
13 | P a g e
Reference
Installation script This script installs IBM Datacap from an installation image folder. Specifically, it stops Datacap running services, uninstalls the existing Datacap version, and performs a new installation. It might also generate a security encryption key, export the key file, place the key file in a file share folder, and start the Datacap Server.
It copies the installable image files into C:\Temp\DCinstall and runs setup.exe. The installation log file
is written to C:\Temp\dcinstall.log. You can inspect the log file after installation. The log file and
C:\Temp\DCinstall folder are purposefully undeleted after installation. The files in
C:\Temp\DCinstall might be required by Update.exe during update. Hence, it is not deleted.
However, when install.bat is run later, it deletes the C:\Temp\DCinstall folder before it copies
over new files. Input arguments
arg1: pathToInstallImage A UNC path where the IBM Datacap installable image is located. This location is where the setup.exe and msi files exist.
arg2: component The IBM Datacap components to install on this machine. Here are the valid values:
o all o serverandapps o serverandwebclient o rrs o clients o clientsandrr
For information about the meaning of these values, see Component nodes.
arg3: version
The version of IBM Datacap to install. The valid values are 8.1, 9.0, and 9.0.1. arg4: primaryTMS
Whether this machine with Datacap server must also generate the security encryption key. The value yes indicates that this Datacap server must generate the key. If any other value or no value is specified, it consumes a generated key. Within a deployment, one Datacap server must be
designated as a primaryTMS unless you supply a key file when you run the configure.bat
script later. If no Datacap server was tagged as a primaryTMS and no previously generated key file exists, the deployment is not usable for the following reason: Datacap clients are not able to log on to Datacap server.
arg5: configPath
A UNC path of where to put the generated security key file, dc_KTF.xml. If you do not want a
new key to be generated because you have an existing key file to use, do as follows:
o Set primaryTMS to no. o Do not set a configPath.
If primaryTMS is yes, you must specify a configPath.
14 | P a g e
arg6: customAppsDir An optional path to a location that contains the customer application. The file or files inside the location must be zip files of the applications. Before you use this argument, see Modifying scripts for custom applications.
Command Syntax
install.bat <pathToInstallImage> <component> <version> [<primaryTMS>]
[<configPath>] [<customAppsDir>]
Example commands
Goal Example command
To get usage information
install.bat -help | -? | /?
To install all components of IBM Datacap 9.0
install.bat "\\cm-dc-fdr\FDR_E\Installers\Datacap
Taskmaster\TM90" all 9.0
To install the Rulerunner and Fingerprint Services components of IBM Datacap 9.0)
install.bat "\\cm-dc-fdr\FDR_E\Installers\Datacap
Taskmaster\TM90" rrs 9.0
To install Taskmaster server of IBM Datacap Taskmaster Capture 8.1 and make it generate security key and save
it in \\cm-dc-fdr\FDR_E\team\config
install.bat \\cm-dc-fdr\FDR_E\Installers\V81
serverandapps 8.1 yes \\cm-dc-fdr\FDR_E\team\config
Configuration script This script configures a newly installed version of IBM Datacap. It performs the following configurations:
1. Copies the generated security encryption key file, dc_KTF.xml, from <configPath> to other
machines in the deployment environment. 2. Configures the Datacap RuleRunner Service and DCTMS services to log on with user
credentials passed in as arguments instead of LocalSystem. 3. Configures the following web clients:
o Datacap Web Client o Datacap Report Viewer o Datacap Fingerprint Service
15 | P a g e
Input arguments
arg1: configPath The UNC path of the security key file. The specific value that is required depends on whether you
specified a <configPath> for install.bat:
configPath specified for install.bat
This value must match what you specified for install.bat.
configPath not specified for install.bat
This value must be the location of the key file that you want to use for this deployment.
arg2: username
The name of a user in the Windows domain that has administrative privileges.
arg3: password
The password that corresponds to the username.
arg4: tmsCName
The computer name of the Datacap server with applications. For a single machine installation,
specify a value of localhost.
Command Syntax
configure.bat <configPath> <username> <password> <tmsCName>
Example commands
Goal Example command
To get usage information
configure.bat -help | -? | /?
To configure the system configure.bat \\cm-dc-fdr\FDR_E\team\config
[email protected] **** localhost
Sample application configuration (SAC) scripts In a client/server deployment, each sample application must be configured to connect to the Datacap server. The script that performs this configuration is called the sample application configuration script. This type of configuration is database-dependent because the way that client machines connect to the Database server machine depends on the database. Therefore, there are different scripts for each supported database server. The sample application configuration script configures the connection string for the following items to use the network shared drive of the IBM Datacap installation:
Adm, Eng, and FP databases
Paths for runtime batches, the document hierarchy, and rules The automated deployment assumes that all the Datacap sample applications are installed on a single machine. Therefore, the sharedPath argument is used to hold the UNC form of the Datacap installation
root folder. The installation root folder is always on C:\Datacap; hence, <sharedPath> must always be
the shared form of <C:\Datacap>.
16 | P a g e
SAC script: Microsoft Access database and TMA authentication The appsconfig.gvy script configures IBM Datacap applications in a distributed client/server
deployment environment. For background information about sample application configuration, see Sample application configuration (SAC) script. Input arguments
arg1: tmsHost The comma-separated, fully qualified hostname or IP address of the TM servers.
arg2: sharedPath
The shared network path of the IBM Datacap installation location.
arg3: version The IBM Datacap version. The valid values are 8.1, 9.0, and 9.0.1.
All arguments are required. Command Syntax
"C:\Program Files\agent\opt\groovy-1.8.8\bin\groovy" appsconfig.gvy A.B.C.D
\\A.B.C.E\Datacap 8.1
In this example, A.B.C.D is the IP address or fully qualified hostname of the Datacap server host. The
variable A.B.C.E is the IP address of the machine with the sample apps installed.
17 | P a g e
SAC script: Microsoft SQL database The configureApp4sql.bat script performs the following actions:
Installs Microsoft SQL Server Native Client
Installs Microsoft Command-Line Utilities 11 for SQL Server
Creates database tables
Runs DBCopy
Configures a specified application for Microsoft SQL database use For background information about sample application configuration, see Sample application configuration (SAC) script. For Microsoft SQL database, the following items must be created before deployment as the native client does not allow for the creation of these items:
The database
The database user that is used to connect to the database
Here are some details of the operations that are performed: (1) Copies Microsoft SQL msi files from file share to local folder and installs it if not already
installed. (2) Connects to the database by using SQLCMD such that the user is created before the
deployment scripts are run. (3) Runs SQL scripts in Datacap\support\DBScript to create tables for Adm, Eng, and FP.
(4) Uses DBCopy.exe to silently copy Microsoft Access databases to Microsoft SQL database for
the specified Datacap application. (5) If the authentication system is not TMA, it creates a group and user in the TMGROUP and
TMUSER database tables respectively for use.
(6) Runs the Groovy script, appsconfig4sql.gvy, to complete the rest of the applications
configurations.
Input arguments
arg1: msiFilePath A UNC path to Microsoft SQL native client and Microsoft Command-Line Utilities 11 for SQL
Server installation images.
arg2: dbServerHost The fully qualified hostname or IP address of the database server machine.
arg3: dbInstance
The instance name for the database server.
arg4: dbName The name of the database.
arg5: dbUserName
The name to use as database user.
arg6: dbUserPass The password to the dbUserName.
arg7: tmsHost
The comma-separated, fully qualified hostname or IP address of the Datacap servers.
18 | P a g e
arg8: dcVersion
The Datacap version, such as 8.1, 9.0, or 9.0.1.
arg9: sharedFolder The Datacap installed shared network folder.
arg10: authSystem
The authentication system. Here are the valid values:
o ADSI
o LDAP
o LLLLDAP
o ADLDS
o TMA
TMA is the default. If you do not select the default, modify the following supplied files for your
environment before you run the scripts:
o dbScripts\SqlInsertGroup.sql
Modify the following statement:
INSERT INTO dbo.tmgroup (gr_ind, gr_name, gr_desc, gr_priv)
VALUES (1, 'QA.cmqadatacap', 'Group added by automation', -
469788708)
o dbScripts\SqlInsertUser.sql
Modify the following statement:
INSERT INTO dbo.tmuser (us_id, us_name, us_pass, us_perm,
us_ind)
VALUES ('localadm', 'Auth System user', '247030098058198',
-469788708, 4)
Also, in both of these files, there are other insert statements that use the gr_ind and us_ind
values as foreign keys to their tables. Modify those statements.
arg11: dbEnabledApp
The application to be copied into the Microsoft SQL database, such as Datacap Accounts
Payable.
arg12: templatePath
An optional template path for the authentication system. The default authentication template path
is shown in the Datacap Server Manager. If you enter a template path that is not the default path,
the entered template path must correspond to your <authSystem> value. Specifically, enter a
correct template path for your directory server so that the user can be authenticated during logon.
This user is the user that you created with SQL insert statements as shown for the <authSystem>
argument.
19 | P a g e
Command Syntax
configureApp4sql.bat <msiFilePath> <dbServerHost> <dbInstance> <dbName>
<dbUserName> <dbUserPassword> <tmsHost> <dcVersion>
<sharedFolder>!<authSystem>!<dbEnabledApp>!<templatePath>
Arguments 9, 10, 11, and 12 are passed in as a single Windows batch file command argument by using exclamation point (!) to separate them. Example commands
Goal Example command
To get usage information
configureApp4sql.bat -help | -? | /?
To configure the system configureApp4sql.bat \\cm-dc-fdr\FDR_E\team\UCD\mssql
myDBhost myInstance myDB userFoo passFoo a.b.c.d,a.b.c.e 8.1
uncPath!LDAP!APT!LDAP://ipaddr.domain
SAC script: Oracle database The configureApp4Ora.bat script performs the following actions:
Installs Oracle client
Configures Net Configuration Assistant
Creates database user and tables
Runs DBCopy
Configures a specified application for Oracle database use.
For background information about sample application configuration, see Sample application configuration (SAC) script. Here are the details of the operations that are performed:
(1) If the Oracle client is not currently installed in C:\Oracle\product\11.2.0\client_1
or %HOMEPATH%\product\11.2.0\client_1, performs the following actions: copies the
Oracle client zip from the file share to a local folder and installs the Oracle client. The
OraClient.rsp file comes bundled with these scripts and is used for the installation response
file.
(2) Queries the tnsnames.ora for the presence of the <dbServiceName> argument and if not
found configures Net Configuration Assistant with the bundled netca.rsp file. Edit the
netca.rsp file to reflect your Oracle installation settings.
(3) Runs SQLPlus with the bundled script CreateUserForAutomation.sql to create a user in
the Oracle database. (4) Connects to the database as created user and runs SQL scripts in Datacap\support\DBScript to
create tables for Adm, Eng, FP (5) Uses DBCopy.exe to silently copy databases from Microsoft ACCESS to Oracle database.
(6) Edits Datacap\tmweb.net\apps.ini. This editing replaces the edited copy in the runtime
folder. (7) If the authentication system is not TMA, it creates a group and user in the TMGROUP and
TMUSER database tables respectively for use.
(8) Runs the Groovy script, appsconfig4ora.gvy, to complete the rest of the applications
configurations.
20 | P a g e
Input arguments
arg1: clientZipPath The network folder that contains the Oracle client zip.
arg2: dbServerHost
The fully qualified hostname or IP address of the database server machine.
arg3: dbServiceName The Oracle database service name.
arg4: dbUserName
The name to use as database user and schema for Oracle. This name is the same as the database name and you must save and remember this value. If this schema exists in the database, it is dropped and a new one created. The created user is granted the following privileges:
o Resource o DBA o EXP_FULL_DATABASE
arg5: dbUserPassword
The password that corresponds to the <dbUserName>.
arg6: dbAdminPass The DB administrative user password.
arg7: tmsHost
The comma-separated, fully qualified hostname or IP address of the Datacap servers.
arg8: dcVersion The Datacap version, such as 8.1, 9.0, or 9.0.1.
arg9: sharedFolder
The Datacap installed shared network folder.
arg10: authSystem
The Authentication System. Here are the valid values:
o ADSI
o LDAP
o LLLLDAP
o ADLDS
o TMA
TMA is the default. If you do not select the default, modify the following supplied files for your
environment before you run the scripts:
o dbScripts\OraInsertGroup.sql
Modify the following statements:
INSERT INTO tmgroup (gr_ind, gr_name, gr_desc, gr_priv)
VALUES (1, 'QA.cmqadatacap', 'Group added by automation', -
469788708)
21 | P a g e
o dbScripts\OraInsertUser.sql
Modify the following statements:
INSERT INTO tmuser (us_id, us_name, us_pass, us_perm,
us_ind)
VALUES ('localadm', 'Auth System user', '247030098058198',
-469788708, 4)
Also, in both of these files, there are other insert statements that use the gr_ind and us_ind
values as foreign keys to their tables. Modify those statements.
arg11: dbEnabledApp
The application to be copied into the Oracle database, such as TravelDocs.
arg12: templatePath
An optional template path for the authentication system. The default authentication template path
is shown in the Datacap Server Manager. If you enter a template path that is not the default path,
the entered template path must correspond to your <authSystem> value. Specifically, enter a
correct template path for your directory server so that the user can be authenticated during logon.
This user is the user that you created with SQL insert statements as shown for the <authSystem>
argument.
Command Syntax
configureApp4Ora.bat <clientZipPath> <dbServerHost> <dbServiceName>
<dbUserName> <dbUserPassword> <tmsHost> <dcVersion>
<sharedFolder>!<authSystem>!<dbEnabledApp>!<templatePath>
Arguments 9, 10, 11, and 12 are passed in as a single Windows batch file command argument by using an exclamation point (!) to separate them. Example commands
Goal Example command
To get usage information
configureApp4Ora.bat -help | -? | /?
To configure the system configureApp4Ora.bat \\cm-dc-
fdr\FDR_E\Installer\Oracle\win32_11gR2_client myDBhost
myService myDBUser userFoo admPassFoo a.b.c.d,a.b.c.e 8.1
uncPath! LDAP!TravelDocs!LDAP://ipaddr.domain
SAC script: IBM DB2 database The configureApp4db2.bat script performs the following actions:
Installs IBM DB2 Client if it is not already installed
Catalogs the remote database and server on the local machine
Creates Datacap database tables
Runs Datacap Application Copy Tool
Configures a specified application for IBM DB2 database use For background information about sample application configuration, see Sample application configuration (SAC) script.
22 | P a g e
The following items must be created before deployment as the native client does not allow for the creation of these items:
The database
The database user that is used to connect to the database Here are the details of the operations that are performed:
(1) Extracts v10.5fp5_ntx64_client.exe from input folder to local folder and installs it if not
already installed. (2) Connects to the database by using DB2CMD such that the user is created before the
deployment scripts are run. (3) Runs SQL scripts in Datacap\support\DBScript to create tables for Adm, Eng, and FP. (4) Uses the Datacap Application Copy Tool to silently copy Microsoft ACCESS databases to IBM
DB2 database for the specified Datacap application. (5) If the authentication system is not TMA, it creates a group and user in the TMGROUP and
TMUSER database tables respectively for use.
(6) Runs the Groovy script, appsconfig4db2.gvy, to complete the rest of the applications
configurations. Input arguments
arg1: clientExePath The folder path where the DB2 client self-extracting exe, v10.5fp5_ntx64_client.exe, exists.
arg2: dbServerHost
The fully qualified hostname or IP address of the database server machine.
arg3: dbName The name of the DB2 database.
arg4: dbUserName
The name to use as database user.
arg5: dbUserPass The password to the dbUserName.
arg6: tmsHost
The comma-separated, fully qualified hostname or IP address of the TM servers.
arg7: dcVersion The Datacap version. The valid values are 9.0 and 9.0.1. Datacap 9.0 and later versions support
IBM DB2.
arg8: sharedFolder The Datacap installed shared network folder.
arg9: authSystem
The authentication system. Here are the valid values:
o ADSI
o LDAP
o LLLLDAP
o ADLDS
o TMA
23 | P a g e
TMA is the default. If you do not select the default, modify the following supplied files for your
environment before you run the scripts:
o dbScripts\DB2InsertGroup.sql
Modify the following statements:
INSERT INTO dbo.tmgroup (gr_ind, gr_name, gr_desc, gr_priv)
VALUES (1, 'QA.cmqadatacap', 'Group added by automation', -
469788708)
o dbScripts\DB2InsertUser.sql
Modify the following statements:
INSERT INTO dbo.tmuser (us_id, us_name, us_pass, us_perm,
us_ind)
VALUES ('localadm', 'Auth System user', '247030098058198',
-469788708, 4)
Also, in both of these files, there are other insert statements that use the gr_ind and us_ind
values as foreign keys to their tables. Modify those statements.
arg10: dbEnabledApp
The application to be copied into the IBM DB2 database, such as Datacap Accounts Payable.
arg11: templatePath
An optional template path for the authentication system. The default authentication template path
is shown in the Datacap Server Manager. If you enter a template path that is not the default path,
the entered template path must correspond to your <authSystem> value. Specifically, enter a
correct template path for your directory server so that the user can be authenticated during logon.
This user is the user that you created with SQL insert statements as shown for the <authSystem>
argument.
Command Syntax
configureApp4db2.bat <clientExePath> <dbServerHost> <dbName> <dbUserName>
<dbUserPassword> <tmsHost> <dcVersion>
<sharedFolder>!<authSystem>!<dbEnabledApp>!<templatePath>
Arguments 8, 9, 10, and 11 are passed in as a single Windows batch file command argument by using an exclamation point (!) to separate them. Example commands
Goal Example command
To get usage information
configureApp4db2.bat -help | -? | /?
To configure the system configureApp4db2.bat \\cm-dc-fdr\FDR_E\team\UCD\mssql
myDBhost myDBName myDB userFoo passFoo a.b.c.d,a.b.c.e 9.0
uncPath!LDAP!APT!LDAP://ipaddr.domain
24 | P a g e
Update script This script updates IBM Datacap to the fix pack level that you specify.
It copies the update.exe file into C:\Temp\DCupdate and runs update.exe. The update log file is
written to C:\Temp\dcupdate.log. You might want to inspect the log file after the update. The log file
and the C:\Temp\DCupdate folder are purposefully undeleted after update. However, when
update.bat is run later, it deletes the C:\Temp\DCupdate folder before it copies over new files.
Input arguments
arg1: pathToUpdateFile A UNC path where the IBM Datacap installable image is located. This location is where the
update.exe file exists.
arg2: component
The IBM Datacap components to be updated on this machine. Here are the valid values:
o all o serverandapps o serverandwebclient o rrs o clients
For information about the meaning of these values, see Component nodes.
arg3: version
The version of IBM Datacap. The valid values are 8.1, 9.0, and 9.0.1. arg4: authSystem
The authentication system. Here are the valid values:
o ADSI o LDAP o LLLLDAP o ADLDS o TMA
TMA is the default.
Command Syntax
update.bat <pathToUpdateFile> <component> <version> <authSystem>
25 | P a g e
Example commands
Goal Example command
To get usage information
update.bat -help | -? | /?
To update a machine in which all components were installed
update.bat \\cm-dc-fdr\FDR_E\Installers\V81Update all
8.1 TMA
To update a machine in which the Rulerunner and Fingerprint Services components were installed
update.bat \\cm-dc-fdr\FDR_E\Installers\V81Update rrs
8.1 TMA
To update a machine in which the serverandapps was installed
update.bat \\cm-dc-fdr\FDR_E\Installers\V81Update
serverandapps 8.1 TMA
Final state of components after deployment The following table shows the configuration state of components after deployment. You might want to
perform additional configuration as needed for your specific use case. For example, you might want to
configure a load balancer for high availability and to distribute the load among the same servers.
Configuration item
Components affected Configuration action
32-bit Applications Datacap Web Client
Datacap Report Viewer
Datacap Fingerprint Service
Selects the Enable 32-bit Applications setting.
Application pool Datacap Web Client
Datacap Report Viewer
Datacap Fingerprint Service
Configures the application pool, and adds the application to the Default Web Site node.
Authentication system and path template
Datacap Server Configures the authentication system and authentication path template (if the authentication system is not TMA).
Connection strings
Sample applications Sets the Admin, Engine, and FP connection strings
Group name and username
Datacap Server Possibly configures a group name and username in the Adm tables of TMGROUP and TMUSER respectively (if the authentication system is not TMA). You set the group name and username in the dbScripts folder of the deployment code bundle.
Managed pipeline mode
Datacap Web Client (Classic)
Datacap Report Viewer (Integrated)
Datacap Fingerprint Service (Integrated)
For the application pool, sets the managed pipeline mode to the indicated value.
26 | P a g e
Physical path
Datacap Web Client (C:\Datacap\tmweb.net)
Datacap Report Viewer (C:\Datacap\RV2)
Datacap Fingerprint Service (C:\Datacap\FingerprintService)
Sets the physical path to the indicated path.
Process model identity
Datacap Web Client
Datacap Report Viewer
Datacap Fingerprint Service
Sets the process model identity to the specified user and configures the username and password.
Recycling restart Datacap Web Client Sets the recycling periodic restart time to 3 AM.
Service credentials Datacap Server
Rulerunner Service
Datcap Web Service (IBM Datacap 9.0 and later versions only)
Configures the service with specified username and password (instead of LocalSystem).
Service name
Datacap Server Configures the DCTMS service to use specified username and password instead of LocalSystem.
Service start Rulerunner Service Does not start the service.
Taskmaster IP address
Sample applications and custom app if applicable
Updates the Datacap server IP address to the specified IP addresses.
V attributes
Sample applications and custom app if applicable
Sets other v attributes in the .app file.
Top Related