Batch Scheduler Service Installation
Version 6.0 and 6.1
Overview
Step by step Govern Batch Scheduler Service installation procedure.
- Before Getting Started (Requirements, Prerequesites)
- Step by Step Installation
See What’s New in Govern Batch Scheduler
If you are installing the Batch Scheduler Service for OpenForms Version 5 and less, click here (106-all-SC-v5).
Before Getting Started
Validate Requirement
A dedicated server is strongly recommended. To maximize execution speed, the most important factors are:
- Memory (Quantity and Type)
- Network (Speed and Routing)
Govern System Requirements
Email Notification Server Information
SMTP Server Information
The batch scheduler generates email. To enable this option, you will need to supply SMTP server and account information for the organization.
- Host Name
- Port Number
- Username & Password
SMTP4Dev Test Server setup (Optional)
- For testing purposes, you can Install SMTP4Dev, a dummy SMTP server that sits in the system tray and does not deliver the received messages. This Open Source Software is distributed by Code Plex. For more information or to download, see smtp4dev.codeplex.com
Step by Step Installation
Step 1 – Deploy Binaries and Services
Refresh the source environment. The deployment/connection key for which we want to have a scheduler service.
- Deploy the latest binaries, services and installation pack
- Binaries
- Resources
- Custom Control
- System Files
- Govern Scheduler
- Services
- Govern Scheduler Service
- Govern WCF Services
- Install Pack
- Binaries
- Run a Database Verification
Step 2 – Install / Verify Email setup
In Govern Administrator, in General Settings Editor (SY REGISTRY)
- Select Registry Filter Section = General | Section Name = SMTP
- Host:
- Port: Any port that is not currently in used (ex:6666)
- Connection User and Password
- Default Sender Address
TESTERS: Click here to download and install a Test SMTP Server |
Step 3 – Install the Batch Scheduler Service
On the server where you will be installing the Govern Scheduler application:
Execute (double-click) BatchSchedulerServiceSetup.exe located on the deployment server INSTALL > VERSION > Batch Scheduler Service Setup Folder
- Supply the Deployment Configuration Path
- GovernNetConfig.xml Path: Located in the source DEPLOYMENT Folder (Note: Use UNC path if typed in)
- The following information will auto-fill
-
- Base Installation Path:
- Full Installation Path:
- Deployment Name:
- Connection Name:
- Service Name: GovernSchedulerService_[Connection Key]
- NOTE: Copy the name to notepad or word as the service name will be needed later during the installation
-
- Enter the Failure Alert Configuration
- Email Address: Provide one or more e-mail addresses in order to have key users receive e-mail alerts when a program failure occurs. The default message that you enter is sent
- SMTP Server
- Email Subject and Email Body
- Click Start and once completed, you can exit.
Once completed, in Task Manager, Services, you should have the following service running
- GovernSchedulerService_[Connection Key]
Step 4 – Configure Govern Scheduler in GNA
In Govern Administrator, in General Settings Editor (SY REGISTRY) – to be validated
- Select Registry Filter Section = Batch Process | Section Name = Scheduler
- Scheduler Service Port Number: Any port that is not currently in used (ex:6666)
- Scheduler Service Machine Name:
- Minimum Batch Process Interval for Update (minutes): Number of minutes needed for upgrade (will not auto-upgrade if a batch is schedule to be executed in X minutes) – usually 15 minutes
- Select Registry Filter Section = Batch Process | Section Name = Batch Process
- Worker Service Address – see roadmap
Step 5 – Launch Govern Scheduler
Double-click on the shortcut to install the Govern Scheduler
- Verify there are no error messages and that the service is listed on the second tab
Step 6 – Test Service
In order to ensure the Batch Scheduler Service is installed properly:
Setup and execute the standard Batch Test Process
- Setup the Batch Process Test Service GNA > Editors > Batch Process Definition
- Setup Batch Definition
- Email Notification: TIP: Use groups for email alerts
- Report
- Schedule: in 5 minutes
- Setup Second Batch Definition
- Schedule: in 15 minutes
Uninstalling the Govern Scheduler Service
In version 6.0, you need to run the Command Prompt CMD as ADMINISTRATOR to uninstall.
- sc delete [service name]
- NOTE: The service name listed may not be the actual service name, check in TASK MANAGER, SERVICES and right-click for PROPERTIES or to OPEN SERVICE to validate. The name listed there is the name to use in the command.
- SERVICE NAME = GovernSchedulerService_DEPLOYMENT NAME
- example: C:\Windows\System32> sc delete GovernSchedulerService_ARVADA_MTL-SQL2014
Troubleshooting
Verify that no other Service is running
- Open Task Manager, Services and click on the name column to sort the services by name.
- Check if any other services for GovernSchedulerService …
Verify that the Windows Service is running
- Open Task Manager, Services and find the Service Name
Verify Services Tab in Scheduler
- Verify Error Messages in Govern Schedule (History Log)
Firewall
- If the server is protected by a firewall, verify that incoming traffic is allowed on the port you have configured in GNA
Path for Files
- If you get an error during the batch execution for ‘Access to the Path is denied’ you need to make sure the folder has Read/Write access.
VERSION 5 Installation
For more detail information, see the following extract from the Govern Scheduler Guide [pdf] Getting Started and Installation – to be reviewed
See Also
106-install