Vous êtes sur la page 1sur 43

Intergraph Batch Services

Quick Start Guide

Version 2010 Service Pack 1 (6.1.7)


June 2013
DPDS3-PE-200050C

Copyright

Copyright 1994-2013 Intergraph Corporation. All Rights Reserved. Intergraph is part of Hexagon.
Including software, file formats, and audiovisual displays; may be used pursuant to applicable software license agreement;
contains confidential and proprietary information of Intergraph and/or third parties which is protected by copyright law, trade
secret law, and international treaty, and may not be provided or otherwise made available without proper authorization from
Intergraph Corporation.
Portions of the user interface copyright 2012-2013 Telerik AD.

U.S. Government Restricted Rights Legend


Use, duplication, or disclosure by the government is subject to restrictions as set forth below. For civilian agencies: This was
developed at private expense and is "restricted computer software" submitted with restricted rights in accordance with
subparagraphs (a) through (d) of the Commercial Computer Software - Restricted Rights clause at 52.227-19 of the Federal
Acquisition Regulations ("FAR") and its successors, and is unpublished and all rights are reserved under the copyright laws of
the United States. For units of the Department of Defense ("DoD"): This is "commercial computer software" as defined at DFARS
252.227-7014 and the rights of the Government are as specified at DFARS 227.7202-3.
Unpublished - rights reserved under the copyright laws of the United States.
Intergraph Corporation
P.O. Box 240000
Huntsville, AL 35813

Terms of Use
Use of this software product is subject to the End User License Agreement ("EULA") delivered with this software product unless
the licensee has a valid signed license for this software product with Intergraph Corporation. If the licensee has a valid signed
license for this software product with Intergraph Corporation, the valid signed license shall take precedence and govern the use
of this software product. Subject to the terms contained within the applicable license agreement, Intergraph Corporation gives
licensee permission to print a reasonable number of copies of the documentation as defined in the applicable license agreement
and delivered with the software product for licensee's internal, non-commercial use. The documentation may not be printed for
resale or redistribution.

Warranties and Liabilities


All warranties given by Intergraph Corporation about equipment or software are set forth in the EULA provided with the software
or applicable license for the software product signed by Intergraph Corporation, and nothing stated in, or implied by, this
document or its contents shall be considered or deemed a modification or amendment of such warranties. Intergraph believes
the information in this publication is accurate as of its publication date.
The information and the software discussed in this document are subject to change without notice and are subject to applicable
technical product descriptions. Intergraph Corporation is not responsible for any error that may appear in this document.
The software discussed in this document is furnished under a license and may be used or copied only in accordance with the
terms of this license. No responsibility is assumed by Intergraph for the use or reliability of software on equipment that is not
supplied by Intergraph or its affiliated companies. THE USER OF THE SOFTWARE IS EXPECTED TO MAKE THE FINAL
EVALUATION AS TO THE USEFULNESS OF THE SOFTWARE IN HIS OWN ENVIRONMENT.
Intergraph is not responsible for the accuracy of delivered data including, but not limited to, catalog, reference and symbol data.
Users should verify for themselves that the data is accurate and suitable for their project work.

Trademarks
Intergraph, the Intergraph logo, PDS, SmartPlant, FrameWorks, I-Convert, I-Export, I-Sketch, SmartMarine, IntelliShip, INtools,
ISOGEN, MARIAN, SmartSketch, SPOOLGEN, SupportManager, and SupportModeler are trademarks or registered trademarks
of Intergraph Corporation or its subsidiaries in the United States and other countries. Microsoft and Windows are registered
trademarks of Microsoft Corporation. Oracle, JD Edwards, PeopleSoft, and Retek are registered trademarks of Oracle
Corporation and/or its affiliates. MicroStation is a registered trademark of Bentley Systems Inc, all rights reserved. Other brands
and product names are trademarks of their respective owners.

Contents
Preface .......................................................................................................................................................... 5
Batch Services Overview ............................................................................................................................ 7
Batch Services Defined ........................................................................................................................... 8
Batch Services Features ......................................................................................................................... 8
Batch Services Components................................................................................................................... 9
Getting Started ........................................................................................................................................ 9
Installing and Configuring Batch Services ............................................................................................. 11
Batch Services Hardware/Software Recommendations ....................................................................... 11
Installing Intergraph Batch Services ..................................................................................................... 12
Command Line Installation (Silent Install) ............................................................................................ 15
Starting and Stopping Batch Services .................................................................................................. 16
Granting Jobs Access to the Desktop ................................................................................................... 17
Removing the Batch Service................................................................................................................. 18
Using Batch Manager ................................................................................................................................ 19
Understanding the Batch Manager Interface ........................................................................................ 19
Granting Batch Service Privileges ........................................................................................................ 20
Understanding Account Mapping .......................................................................................................... 22
Creating and Managing Queues .............................................................................................................. 23
Creating and Deleting Queues.............................................................................................................. 23
Creating a Batch Queue ................................................................................................................. 23
Creating a Pipe Queue ................................................................................................................... 24
Deleting a Queue............................................................................................................................ 24
Changing Queue Properties ................................................................................................................. 24
Setting the Default Queue ..................................................................................................................... 25
Adding Shells to a Batch Queue ........................................................................................................... 26
Adding Destinations to a Pipe Queue ................................................................................................... 26
Enabling and Disabling a Queue .......................................................................................................... 27
Starting and Stopping a Queue............................................................................................................. 27
Displaying Queue Status ...................................................................................................................... 28
Submitting a Batch Job ............................................................................................................................ 29
Creating a Script ................................................................................................................................... 29
Submitting a Job ................................................................................................................................... 30
Setting Basic Job Information ......................................................................................................... 30
Setting Job Scheduling Information................................................................................................ 31
Creating Recurring Jobs ................................................................................................................. 31
Specifying Job Notification Preferences ......................................................................................... 32
Specifying How to Handle Job Output............................................................................................ 32
Specifying Job Resource Requirements ........................................................................................ 33
Saving and Restoring Named Batch Jobs ............................................................................................ 33
Creating a Named Job.................................................................................................................... 34
Submitting a Named Job ................................................................................................................ 34

Intergraph Batch Services Quick Start Guide

Contents
Glossary ..................................................................................................................................................... 35
Index ........................................................................................................................................................... 41

Intergraph Batch Services Quick Start Guide

Preface
The Batch Services Quick-Start Guide describes how to install, configure, and use Intergraph
Batch Services on a computer running the Microsoft Windows operating system.

About This Document


This document is organized as follows:
The Preface introduces you to the Quick-Start Guide, describes document conventions, and
provides information on related documentation, product support, and contacting Intergraph.
Section 1, Batch Services Overview, provides an introduction to the basic concepts and
features of Intergraph Batch Services.
Section 2, Installing and Configuring Batch Services, describes how to install, configure,
and run Batch Services on your system.
Section 3, Using Batch Manager, describes the Batch Manager graphical interface, and
describes how to use it to grant batch service privileges for your system, and handle account
mapping.
Section 4, Creating and Managing Queues, describes how to use the Batch Manager
graphical interface to create, manage, and monitor queues.
Section 5, Submitting a Batch Job, describes how to use the Batch Manager graphical
interface to submit a batch job.
The Glossary defines terms used in this document.
This document assumes that you understand basic networking concepts, and that you have a
working familiarity with the Transmission Control Protocol/Internet Protocol (TCP/IP), Internet
addressing, and Windows services.

Finding Additional Batch Services Information


Additional Batch Services documentation is available online through Batch Services Help, which
is delivered when you install the Batch Services software. Batch Services Help provides
detailed information on the following subjects:
Batch Services terminology.
Accomplishing tasks with Batch Services.
Using the graphical user and command-line interfaces to Batch Services.
Using the Batch Services application programming interface (API).

Finding Operating System Information


If you need more detailed information on an aspect of the Windows operating system, you can
refer to the documentation delivered with the Windows operating system software.

Getting Documentation and Training


In the United States, contact your sales account representative, or call the Intergraph at
1-800-766-7701.
At international locations, contact the Intergraph subsidiary or distributor from which you
purchased your Intergraph software to place an order.
To find information on training for Intergraph products, or to enroll for an available class, go to
http://www.intergraph.com.

Intergraph Batch Services Quick Start Guide

Preface
Getting Telephone Support
If you experience problems with your Intergraph system or software, or have questions about
the information in this document, you can contact Intergraph for help.
In the United States, call the Customer Response Center at 1-800-766-7701.
At international locations, contact the Intergraph subsidiary or distributor from which you
purchased your Intergraph system or software.
Have the following information readily available when you call:
Your name and telephone number.
The products name.
A brief description of the problem.

Finding Intergraph on the Internet


You can find Intergraph on the Internet at http://www.intergraph.com.

Intergraph Batch Services Quick Start Guide

SECTION 1

Batch Services Overview


Intergraph Batch Services is a system service that provides tools for the management and
execution of non-interactive tasks. The batch system is fully networked, and provides
connectivity to other batch servers.
The batch system is useful to both system administrators and users. Delayed execution of tasks
allows maintenance- and compute-intensive tasks, such as backups or compilation of large
programs, to be scheduled for times when the system is not in use. The batch system also
allows several client computers to use a multiprocessor server as a "compute engine" for CPU
intensive tasks. A large task can be spread out among several systems available on the
network.
The Batch Server service requires System Account privileges on the system. Use the
Services icon in the Control Panel to configure the Batch Server service.
The complete batch system consists of several pieces, including a batch Server, pipe and batch
queues, and an API set, as shown in the following diagram:

In This Section

Batch Services Defined ................................................................. 8


Batch Services Features ................................................................ 8
Batch Services Components ......................................................... 9
Getting Started ............................................................................... 9

Intergraph Batch Services Quick Start Guide

Batch Services Overview

Batch Services Defined


Batch Services is a Windows system service that allows you (or an application) to manage and
perform non-interactive tasks on your computer system. Batch Services gives users and
applications a means of submitting compute-intensive tasks as processes that will run in the
background (non-interactively), and provides notification when the tasks complete.
To perform tasks using Batch Services, you submit a batch job to the system running Batch
Services (the batch server). The batch job provides information to the batch server about the
tasks you want to accomplish and how you want the batch job to run. When a job is successfully
submitted, it gets a unique job ID, enters a queue (a waiting list for processing), and then runs
on the batch server system as if you were logged in to the system and executing the task
yourself.
Batch Services is useful to both system administrators and users. Delayed execution of tasks
allows maintenance- and compute-intensive tasks, such as system data backups or compilation
of large programs, to be scheduled for times when the system is not in use. Batch Services also
allows several client computers to use a multiprocessor server as a compute engine for
compute-intensive tasks. A large task can be spread out among several batch server systems
available on the network.
Batch Services can be used with several Intergraph products, including SmartPlant 3D,
SmartMarine 3D, Plant Design System (PDS), and SmartPlant Review Publisher.

Batch Services Features


With Batch Services, time-consuming, resource-consuming, and repetitive tasks can be run
automatically. By making these tasks execute automatically, you can spend your time and
resources on other tasks. Benefits of automating tasks with Batch Services include the following:
You can submit compute-intensive jobs into the background, and then go on to other tasks
or exit the application or session, while the batch job continues to process.
You can set up jobs to repeatedly execute at any interval you choose.
You can set up a list of jobs to run in a specific order.
You can set the times you want your jobs to run.
You can specify that certain jobs have priority over other jobs awaiting execution.
You can submit jobs directly to a remote queue if Batch Services is present on that system.
Batch Services can continue processing tasks even after a system interruption. Batch Services
manages the tasks so that you do not have to restart them yourself, providing the following
features:
Batch Services resubmits jobs when the network is down, or the remote host is unavailable.
Batch Services automatically restarts jobs if the system crashes while a job is running, or if
the system is down when a job is scheduled to run.
With Batch Services, you control the processing of tasks submitted as batch jobs. The following
features allow you to manage task processing:
You can use Batch Manager for managing batch jobs.
You can manage batch and pipe queues on remote computers from one location.
You can determine which jobs run at a given time, and in what order.
You do not have to monitor jobs. Batch Services supports SMTP mail or event log
notification when a batch job completes successfully or encounters errors.
Batch Services provides the following additional features:

Intergraph Batch Services Quick Start Guide

Batch Services Overview

An application programming interface (API).


Support for multiprocessor systems.
A command-line interface that can be used with scripts.
Job submission to or from Windows systems.

Batch Services Components


Batch Services software consists of the following components:
A batch server program (BATSERV.EXE).
Windows Batch Provider, including an API library (BATCHAPI.DLL).
The Batch Manager graphical interface (BATCHMGR.EXE).
A command-line interface (QSUB.EXE, QSTAT.EXE, QMGR.EXE, QDEL.EXE).

Getting Started
Begin by following the instructions in the next section to install and configure the Batch Services
software on your system. Then refer to the rest of the document as follows:
To remove Batch Services software from your system, see Removing the batch service (on
page 18).
To learn about the Batch Manager interface, see Understanding the Batch Manager
Interface (on page 19).
To grant batch services privileges on your system, see Granting Batch Service Privileges
(on page 20).
To create queues on your system, see Creating and Deleting Queues (on page 23).
To manage and monitor queues on your system, see Specifying Job Notification
Preferences (on page 32).
To learn about scripts, see Creating a Script (on page 29).
To submit a batch job, see Submitting a Job (on page 30).
To manage batch jobs, see Creating and Managing Queues (on page 23).

Intergraph Batch Services Quick Start Guide

Batch Services Overview

10

Intergraph Batch Services Quick Start Guide

SECTION 2

Installing and Configuring Batch


Services
This section describes how to install and configure Intergraph Batch Services on a system
running the Windows operating system.

In This Section

Batch Services Hardware/Software Recommendations ................ 11


Installing Intergraph Batch Services .............................................. 12
Command Line Installation (Silent Install) ..................................... 15
Starting and Stopping Batch Services ........................................... 16
Granting Jobs Access to the Desktop ........................................... 17
Removing the Batch Service ......................................................... 18

Batch Services Hardware/Software


Recommendations
Before installing Intergraph Batch Services software, verify that the computer on which you want
to use the software has the following:
Intel-compatible processor
At least 512 MB of RAM, 1 GB is recommended.
At least 3.5 MB of free space on the systems hard disk.
A Windows-compatible network adapter.
Microsoft Windows XP SP3, Windows Vista SP2, Windows 2003 Server R2 (32-bit and
64-bit), Windows 2008 Server R1 and Microsoft Windows 7 Professional or Enterprise with
UAC 'On' at Level 3 (Default) (32-bit and 64-bit). For the most up-to-date listing of supported
operating systems, visit the Intergraph knowledge base (www.intergraph.com) and look at
the compatibility matrix.
If you want Intergraph Batch Services to run batch jobs as 64-bit processes, the batch
server machine must run the 64-bit version of the operating system. It must also have the 64-bit
version of the designated Intergraph software installed.
Batch Services software can work with any network adapter supported by Windows. The
network adapter you use must be properly installed and configured for your computer before you
install Batch Services software. Refer to your Windows documentation for a list of compatible
network adapters, and to the documentation for your network adapter for installation and
configuration instructions.
Running batch jobs on the Citrix server is not supported. However, you can pipe queue
the batch processes from the Citrix server to a batch queue on another computer.

Intergraph Batch Services Quick Start Guide

11

Installing and Configuring Batch Services

Installing Intergraph Batch Services


1. Open Control Panel > Administrative Tools > Services and determine the current status
of the TCP/IP NetBIOS Helper service on your computer. Start that service if it is not already
running.
2. Insert the Intergraph Batch Services CD into your computer's drive.
3. To start setup, do one of the following:
Press the Windows key + R to activate the Run dialog box. Type drive:\setup, where
drive is the drive letter for the CD/DVD drive.
In Windows Explorer, select the CD/DVD drive; then double-click setup.exe.
4. Select Batch Services Installation.
5. Click Next on the Welcome page.

12

Intergraph Batch Services Quick Start Guide

Installing and Configuring Batch Services


6. Type your name and organization name, and then click Next.

7. On the License Agreement page, select your country from the list, and then click Display.

8. Read the license agreement, and then close the PDF file.
9. Click Yes to accept the license agreement.
10. To accept the default destination folder ($WindowsDrive:\Win32App\Ingr\Batch), click Next.
-ORClick Change, and specify a new installation folder.
If you plan to use this installation of Intergraph Batch Services with Plant
Design System (PDS), do not install Intergraph Batch Services to a folder path that contains

Intergraph Batch Services Quick Start Guide

13

Installing and Configuring Batch Services


spaces, such as c:\Program Files (x86)\Batch. While Intergraph Batch Services does
support spaces in folder paths, PDS does not.
If the destination folder already contains a version of Intergraph Batch Services, a warning
message displays. You can install the new version of the Batch Services over the currently
installed version, or you can install the new version in another folder.

11. Select whether you want jobs to have access to the desktop. If you allow jobs to have
access to the desktop, an iconified and non-active window will appear on the screen when a
job runs. These windows will only appear when a user is logged on to the system.
Windows Vista, Windows 2008 Server, Windows 7, and later operating systems do
not allow jobs to have access to the desktop. Therefore, you will not see this dialog when
installing Batch Services in these operating systems.

14

Intergraph Batch Services Quick Start Guide

Installing and Configuring Batch Services


If your site is one where batch jobs might require some user input, you should select Yes. If
your site is one where security is a major concern, you should select No; a logged-on user
will be able to interact with running batch jobs, even if the job is running as a different user.
You can change whether you want jobs to have access to the desktop later. See Granting
Jobs Access to the Desktop (on page 17) for details. Jobs that try to access the desktop will
not run unless the user running the job is a member of the Administrators group.
12. Setup asks if you want to run all jobs as the same user.

If you select Yes to configure account mapping, define the username and username
password under which jobs should run.
If you select No, setup warns you that you must configure account mapping before you can
submit jobs. Use Batch Manager to configure account mapping after setup is complete.
13. Click Next, and then click Install.
Intergraph Batch Services is installed on your computer. This might take a few minutes.
14. Click Finish.
15. After setup completes, restart your computer.

Command Line Installation (Silent Install)


To install Batch Services from the command line, run Setup.exe in the BatchServices folder.
Setup.exe automatically runs the Windows Installer setup, Intergraph Batch Services.msi.
The following command-line arguments are available:

Required Arguments
SLAACCEPT=yes - Accepts the Software License Agreement.
/v"<arguments>" - Passes options to the Windows Installer setup, Intergraph Batch
Services.msi. There are no spaces after the v.

Optional Arguments
/s - Runs Setup.exe in silent mode.

Intergraph Batch Services Quick Start Guide

15

Installing and Configuring Batch Services


/qn - Runs the Windows Installer setup, Intergraph Batch Services.msi, in silent mode.
INSTALLDIR=<path> - By default, the product is installed to
the<WindowsVolume>\Win32App\INGR\BATCH folder. To change the location, enter a different
path. For example, enter INSTALLDIR=D:\Intergraph\BatchServices. If spaces exist in the
path, you must add \" before and after the path. For example, enter
INSTALLDIR=\"D:\Intergraph\Batch Services\".
INTERACTIVE_DESKTOP=0 - By default, on Windows XP, the Batch Server service is setup
to interact with the desktop. To disable this behavior, include INTERACTIVE_DESKTOP=0. This
setting is not valid with Vista, Windows 7, or later operating systems, and is ignored.
ACCTMAP_USERNAME=domain\username - To run all jobs as the same user, enter an
existing domain\username.
ACCTMAP_PWD - Password for the username. Used in conjunction with
ACCTMAP_USERNAME.
/Lv*x <path>\Logfilename - Creates a Windows Installer installation log file. If the path or file
name contains spaces, you must put \" in front of the path and after the file name, for example:
/Lv*x \"C:\Installer Log Files\InstallLog.log\". The path must already exist.

Example Command-lines
C:\>"\BatchServices\Setup.exe" /s /v"SLAACCEPT=yes /qn"
Installs the setup to the default location without account mapping. By default, on Windows XP,
the Batch Server service is set up to interact with the desktop.
C:\>"\BatchServices\Setup.exe" /s /v"INSTALLDIR=\"C:\Batch Services\"
SLAACCEPT=yes INTERACTIVE_DESKTOP=0 /qn"
Installs the setup to C:\Batch Services without account mapping. On Windows XP, the Batch
Server service is not set up to interact with the desktop.
C:\>"\BatchServices\Setup.exe" /s /v"INSTALLDIR=\"C:\Batch Services\"
SLAACCEPT=yes INTERACTIVE_DESKTOP=0 ACCTMAP_USERNAME=domain\username
ACCTMAP_PWD=password /qn"
Installs the setup to C:\Batch Services with account mapping. On Windows XP, the Batch Server
service is not set up to interact with the desktop.
C:\>"\BatchServices\Setup.exe" /s /v"SLAACCEPT=yes INTERACTIVE_DESKTOP=0
ACCTMAP_USERNAME=domain\username ACCTMAP_PWD=password /Lv*x \"C:\Install
Log Files\install.log\" /qn"
Installs the setup to the default location with account mapping, and creates a Windows Installer
installation log file. On Windows XP, the Batch Server service is not set up to interact with the
desktop.
C:\>"\BatchServices\Setup.exe" /s /x /v"/qn"
Uninstalls Batch Services in silent mode.

Starting and Stopping Batch Services


When you install Intergraph Batch Services software, the batch server service is configured to
start automatically each time you restart your computer. No further configuration is required.
Intergraph recommends leaving the batch server service as configured. However, if you want
to configure Intergraph Batch Services to be started manually instead of automatically, do the
following:
1. Open Control Panel > Administrative Tools > Services.
2. In Services, right-click on Intergraph Batch Server, and select Properties.

16

Intergraph Batch Services Quick Start Guide

Installing and Configuring Batch Services


3. Set Startup type to Manual, and then click OK.
4. Close the Services window.
Batch Services also delivers an Intergraph NQS Listener service that is configured to
start automatically. If your site is not using Intergraph NQS, you can configure the NQS
Listener service to be started manually. Repeat steps 1-3, selecting Intergraph NQS
Listener from the Service list.
If you configure Batch Services to be started manually, you must start the batch server each
time you restart your system, or each time you want to run Batch Services.
To start Batch Services manually:
1. Open Control Panel > Administrative Tools > Services.
2. In Services, select Intergraph Batch Server from the list, and then click Start.
To stop Batch Services:
1. Open Control Panel > Administrative Tools > Services.
2. In Services, select Intergraph Batch Server from the list, and then click Stop.

Granting Jobs Access to the Desktop


If required, batch jobs can have access to the desktop. If jobs are allowed to have access to the
desktop, a window that is iconified and non-active displays on the screen while a job is running.
These windows will only be seen when a user is logged in.
Windows Vista, Windows 7, and Windows 2008 Server do not allow jobs access to the
desktop.
Granting jobs access to the desktop depends on your site's security requirements. If jobs are
granted access to the desktop, a logged in user will be able to interact with batch jobs that are
running, even if the batch job is running as a different user. If security is not a concern, sites
where batch jobs may require some user input should configure Batch Services to allow jobs to
have access to the desktop. Sites where security is a main concern should configure Batch
Services not to allow jobs to have access to the desktop. When you install Batch Services
software, you are given the option of whether or not jobs may have access to the desktop. After
installation, if you want to change the way Batch Services is currently configured, do the
following:
1. Open Control Panel > Administrative Tools > Services.
2. Right-click on Intergraph Batch Server in the list, and then click Properties.
3. Select the Log On tab.
4. The Allow service to interact with desktop checkbox determines whether or not jobs may
access the desktop. If you want jobs to have access to the desktop, make sure the
checkbox is selected. If you do not want jobs to access the desktop, make sure the
checkbox is cleared.
5. Click Apply to reconfigure the startup parameters.
The Intergraph Batch Server service must be stopped and restarted for the change to take
effect.
6. Select the General tab.
7. Click Stop.
8. Click Start to restart Batch Services.
9. Click OK to close the properties window.
10. Exit the Services window.

Intergraph Batch Services Quick Start Guide

17

Installing and Configuring Batch Services

Removing the Batch Service


To remove the batch services:
1. As an administrator, go to the Control Panel and then Add or Remove Programs
(Windows XP and some Windows Server versions) or Programs and Features (Windows
Vista, Windows 7, and some Windows Server versions).
2. Select Intergraph Batch Services.
3. Click Change/Remove or Uninstall depending on your version of Windows.
4. Click Yes.

18

Intergraph Batch Services Quick Start Guide

SECTION 3

Using Batch Manager


This section briefly describes the Intergraph Batch Manager windows interface and how to use it
to grant batch service privileges on your computer. This section also briefly describes how Batch
Services handles account mapping. For more detailed information on the Batch Manager
interface, or for information on using the command-line interface, refer to Batch Services Help or
the Batch Services User's Guide.

In This Section

Understanding the Batch Manager Interface ................................. 19


Granting Batch Service Privileges ................................................. 20
Understanding Account Mapping .................................................. 22

Understanding the Batch Manager Interface


Intergraph Batch Manager provides a graphical interface for viewing and managing batch
services. Batch Manager allows you to create queues and connect to remote queues, and to
submit and manipulate jobs within queues. Connection to remote servers allows you to manage
other Windows batch servers on the network.
Click Start > All Programs > Intergraph Batch Services > Intergraph Batch Manager.

Figure 1: Batch Manager

The Batch Manager toolbar, located below the Batch Manager menus, provides shortcuts to the
following tasks. Position the cursor over a toolbar button to display a tip describing the command
associated with that button. Buttons are provided for the following tasks:
Submitting and deleting jobs
Holding and releasing jobs
Creating and deleting queues
Enabling and disabling queues

Intergraph Batch Services Quick Start Guide

19

Using Batch Manager


Starting and stopping queues
Batch Manager provides two types of views in the main window:
The server view displays information about the server and its queues. Information on each
queue in the server view includes its name and type, its priority, its inflow and outflow state,
and the number of jobs currently in the queue. When the server view is active, you can
create, delete, and manage queues. Double-clicking on a queue listed in a server view
displays the queue view of that queue.
The queue view displays information about the jobs contained in a specific queue.
Information on each job in a queue includes its ID and status, its priority, its name, and the
username of the jobs submitter. When the queue view is active, you can manipulate specific
jobs in that queue. Double-clicking on a job listed in a queue view displays the properties of
that job.
The status bar, at the bottom of the main window, displays information about the active view.
For an active server view, the status bar displays the server name. For an active queue view,
the status bar displays the queues name and type, its description, and its inflow and outflow
states.

Granting Batch Service Privileges


Before you begin using Batch Services, you should use Intergraph Batch Manager to ensure
that users on your system (and users on other systems if appropriate) are granted the proper
privileges for access to Batch Services.
A user with manager privileges can use all the commands that affect batch server configuration
and operation, including granting and removing privileges, and creating and deleting queues. A
user with operator privileges can manage jobs, including those belonging to other users, and
can start and stop batch server queues. Users or groups without privileges can only submit
requests to queues to which they have been granted access; most users or user groups are
non-privileged users.
On Windows 7 and Windows Vista with User Account Control turned on to level 3, the
Administrators group on your system has manager privileges. From an account belonging to the
Administrators group, you can add users and groups of users, on your system or other systems,
to the manager and operator privilege lists.
1. Open Start > All Programs > Intergraph Batch Services > Intergraph Batch Manager.
2. Select your computer name in the tree view on the left.
3. Click Server > Properties.
4. Select the Security tab.

20

Intergraph Batch Services Quick Start Guide

Using Batch Manager


Users and groups, and their Batch Service privileges, display in the Managers and
Operators list.

Figure 2: Server Properties Dialog: Security Page

5. Click Add, and then type the username of a user into the Add Names box, or the group
name of a group, to which you want to grant privileges.
6. Specify local users and groups (on your computer) by username or group name only. Use
one of the following formats when keying in a username or group name:
domain_name\username or system_name\username
domain_name\group_name or system_name\group_name
Separate multiple users or groups with a semicolon (;).
7. Select the type of privilege you want to grant the user or group (Manager or Operator).
8. Click OK.
9. Repeat steps 5 through 8 for each user or group to which you want to grant privileges.
10. When you have finished assigning privileges to users or groups, click OK on the Server
Properties dialog box.

To remove privileges from a user or group:


Open Start > All Programs > Intergraph Batch Services > Intergraph Batch Manager.
Select your computer name in the tree view on the left.
Click Server > Properties.
Select the Security tab.
The current users and groups with Batch Service privileges are displayed in the Managers
and Operators list.
5. In the Managers and Operators list, select the user or group for which you want to remove
privileges.
6. Click Remove.
1.
2.
3.
4.

Intergraph Batch Services Quick Start Guide

21

Using Batch Manager


7. Repeat steps 5 and 6 for each user or group from which you want to remove privileges.
8. When you have finished removing privileges from users and groups, click OK.
To change a users or groups privileges, first remove the current privileges from the user or
group; then re-add the user or group to the privilege list with the new privilege.

Understanding Account Mapping


Batch Services requires an account name and password to use when running jobs. The process
of determining the account name to use is called account mapping. You can use Batch Manager
to enter and modify account-mapping information for your system. An account mapping entry
comprises two parts: the user information to match (the from user), and whom that user maps
to (the to user). Account mapping entries allow users submitting a job to assume the
environment and permissions of the user to whom they are mapped.
To perform account mapping, the batch server tries to match the job owner with an account
mapping entry, using the following order (items are listed on the account mapping dialog in the
order in which they are applied):
1. The batch server first tries to find an exact match, matching the job owners domain or
computer name and username with the from user in the account mapping entries.
2. If the batch server cannot find an exact match, the batch server then searches the account
mapping entries using the job owners domain or computer name, with * (meaning any
user) as the username.
3. If no match is found, the batch server then searches the account mapping entries using *
(meaning any computer or domain) as the domain name, with the job owners username.
4. Finally, if a match still has not been found, the batch server searches with * as the domain
name and * as the username.
How you configure account mapping depends on the security needs and configuration of your
site. For more information on configuring account mapping, see Configure Account Mappings in
the Installation Guide.

22

Intergraph Batch Services Quick Start Guide

SECTION 4

Creating and Managing Queues


This section describes how to use the Intergraph Batch Manager graphical interface to create
and manage queues on a system running Batch Services. For more information on the Batch
Manager interface, or for information on using the command-line interface, refer to Batch
Services Help.

In This Section

Creating and Deleting Queues ...................................................... 23


Changing Queue Properties .......................................................... 24
Setting the Default Queue ............................................................. 25
Adding Shells to a Batch Queue .................................................... 26
Adding Destinations to a Pipe Queue ............................................ 26
Enabling and Disabling a Queue ................................................... 27
Starting and Stopping a Queue ..................................................... 27
Displaying Queue Status ............................................................... 28

Creating and Deleting Queues


Before you can submit a batch job, you must create and enable a batch queue. The batch
queue accepts requests to execute shell scripts, commands, or executables non-interactively.
You may also want to create one or more pipe queues on your system. A pipe queue accepts
requests to send batch jobs to another queue. Typically, you create a pipe queue when you
need access to a batch queue on another system.
Note the following limitations on creating queues:
You must have manager privileges to create a queue.
When naming a queue, you can use any alphanumeric and punctuation characters, except
for the punctuation characters [@ \ ( ) = ,]. The first character cannot be - or /.

Creating a Batch Queue


To create a batch queue on your system, take the following steps:
1. Open Intergraph Batch Manager.
2. Select the server on which you want to create the queue.
on the toolbar.
3. Select Queue > Create, or click Create Queue
4. Key the queue name into the Queue Name box.
5. Optionally, key a description of the batch queue into the Description box.
6. Under Queue Type, select Batch.
7. Click OK.
Refer to Adding Shells to a Batch Queue (on page 26) for more information on batch queues.

Intergraph Batch Services Quick Start Guide

23

Creating and Managing Queues

Creating a Pipe Queue


To create a pipe queue on your system, take the following steps:
1. Open Intergraph Batch Manager.
2. Select the server on which you want to create the queue.
from the toolbar.
3. Select Queue > Create, or click Create Queue
4. Key the queue name into the Queue Name box.
5. Optionally, key a description of the batch queue into the Description box.
6. Under Queue Type, select Pipe.
7. Click OK.
Refer to Adding Destinations to a Pipe Queue (on page 26) for more information about pipe
queues.

Deleting a Queue
Before you can delete a queue, the queue may not contain any jobs and must be disabled and
stopped. You must have manager privileges to delete a queue. You can delete queues on
remote Windows computers. To delete a queue from your system:
1. Open Intergraph Batch Manager.
2. Click on the queue listed in the server view, or select the queue view for that queue.
from the toolbar.
3. Select Queue > Delete, or click Delete Queue
4. When prompted, click Yes to confirm that you want to delete the queue.

Changing Queue Properties


A queue is created with its operational parameters set at default values. You can change these
default values by selecting a queue listed in the server view and pressing ALT+ENTER, or by
selecting the queue view for that queue, and then selecting Properties from the Queue menu.
Select the tabs in the Queue Properties dialog to display the current values for a queues
parameters. The following are basic operational parameters found in the Queue Properties
dialog, along with their default values and brief descriptions of changes you can make.

24

Tab

Parameter

Default

Comments

General

Description

None

Optional.

Scheduling

Run Limit

Determines the maximum number of jobs


that can run in the queue at the same time.
Specify a number of jobs from 1 to 60.

Job Defaults

Scheduling Priority

31

Determines the default priority of execution


of a job relative to other jobs in the queue.
Raise (as high as 1023) to increase the
priority; lower (as low as -1024) to lower the
priority.

Intergraph Batch Services Quick Start Guide

Creating and Managing Queues


Tab

Parameter

Default

Comments

Security

Queue Access

Unrestricted Determines who can gain access to the


queue. To restrict access to specific users or
groups of users, select Restricted. To open
access to the queue to all users, select
Unrestricted.

Authorized Groups
and Users

None

Lists users or groups of users that can gain


access to the queue if it is restricted. Select
Add to add users or groups to the access
list. Select a user or group, and then select
Remove, to remove that user or group from
the access list.
When keying in a username or group name,
use the format for usernames and group
names described in Granting Batch Service
Privileges (on page 20).

Shells

For a complete description, see Adding


Shells to a Batch Queue (on page 26).

Destinations

Order dependent. For a complete


description, see Adding Destinations to a
Pipe Queue (on page 26).

Setting the Default Queue


The default queue on a server is the queue to which batch jobs are submitted when the user
does not explicitly request a queue. The default queue cannot be a remote queue; it must exist
on the server.
Manager privileges are required to set a default queue.

Using Batch Manager:


1. Select the server.
2. Select Server > Properties.
The Server Properties Dialog Box displays.
3. Key a queue name into the Default Queue box, or select a queue from the dropdown list.
4. Click OK.

Using the command line:


1. Start qmgr.
2. Use the set default batch_request queue command to set the default queue for the server.

Using the Batch API:


1. Use the BatchGetServerInfo function to obtain the current BATCH_SERVER_INFO
structure.
2. Modify the BATCH_SERVER_INFO defaultqueue field.
3. Use the BatchSetServerInfo function with the modified BATCH_SERVER_INFO structure to
set the default queue.

Intergraph Batch Services Quick Start Guide

25

Creating and Managing Queues

Adding Shells to a Batch Queue


A shell is a program that can run a specific type of script; for example, cmd.exe is a shell that
can run .bat scripts. You can associate a list of shells with each batch queue. The shell list
allows you to specify a shell from the list without knowing where the actual shell resides on the
computer.
When you associate a list of shells with a batch queue, users can choose one of these
shells from the list, specify a full path to another shell, or use a shell in the PATH environment
variable for the user to whom the job is mapped.
To add a shell to a batch queue:
1. Open Intergraph Batch Manager.
2. Click on the batch queue listed in the server view, or select the queue view for that queue.
3. Select Queue > Properties.
The Queue Properties dialog displays.
4. Select the Shells tab.
5. Under Shell Configuration, key the name of the shell into the Name box; then key the path
to the shell into the Location box.
6. Click Add.
The name and location of the shell display in the Shell box. If you want to set a default shell
for the queue, proceed to the next step. Otherwise, skip to step 8.
You may want to specify the default shell for a batch queue on your system. The
default shell is the one run when a user submits a job, but does not explicitly request a shell.
When you set a default shell for a batch queue, you must explicitly select another shell if you
want to submit a job to run a script that uses another shell. If you want to submit
executable programs (.EXE files) to a batch queue, do not set a default shell for that queue,
or set the default shell to be CMD.EXE.
7. Select the shell in the Shell List box; then select Default.
The name of the shell displays in the Default Shell box.
8. Click OK.
queue.

You must have manager privileges on the batch server to set the default shell for a batch

Adding Destinations to a Pipe Queue


Destinations are used with pipe queues. Pipe queues are normally used to create a connection
to a remote batch queue. A pipe queue interprets a batch job request, and pipes it to the first
available queue in its destination list that will accept the request. The destination list may contain
any queue type.
To add a destination to a pipe queue:
1. Open Intergraph Batch Manager.
2. Click on the pipe queue listed in the server view, or select the queue view for that queue.
3. Select Queue > Properties.
The Queue Properties dialog displays.
4. Select the Destinations tab.
5. Key the new destination queue into the Destination edit box; then click Add.
The destination displays in the List box.

26

Intergraph Batch Services Quick Start Guide

Creating and Managing Queues


6. A destination can be a local queue (on your system) or a remote queue (on other systems).
Specify a local queue by its queue name. To specify a remote queue, use one of the
following format: \\system_name\queue_name
If you list more than one destination for a pipe queue, the pipe queue will send a job
to the first available queue in its destination list that will accept the job.
7. Repeat step 5 for each destination you want to add to the pipe queue.
8. When you have finished adding destinations to the pipe queue, click OK.
queue.

You must have manager privileges on the batch server to add a destination to a pipe

Enabling and Disabling a Queue


A newly created queue has a disabled inflow state; it will not accept new jobs that are submitted
or transferred to it. A queue must be enabled to accept new jobs.
You must have at least operator privileges on the batch server to enable or disable a queue.

To enable a queue:
1. Open Intergraph Batch Manager.
2. Click on the queue listed in the server view, or select the queue view for that queue.
from the toolbar.
3. Select Queue > Enable, or click Enable Queue
The queue should now show as ENABLED in its listing in the server view.
The availability of the Enable and Disable menu and toolbar commands toggles,
depending on the current inflow state of the queue.

To disable a queue:
1. Open Intergraph Batch Manager.
2. Click on the queue listed in the server view, or select the queue view for that queue.
3. Select Queue > Disable, or click Disable Queue
from the toolbar.
The queue should now show as DISABLED in its listing in the server view.

Starting and Stopping a Queue


A newly created queue has a stopped outflow state; it will not run any jobs it contains. A queue
must be started to run jobs.
You must have at least operator privileges on the batch server to start or stop a queue.

To start a queue:
1. Open Intergraph Batch Manager.
2. Click on the queue listed in the server view, or select the queue view for that queue.
3. Select Queue > Start, or click Start Queue
from the toolbar.
The queue should now show as STARTED in its listing in the server view.

Intergraph Batch Services Quick Start Guide

27

Creating and Managing Queues


The availability of the Start and Stop menu and toolbar commands toggles, depending on the
current outflow state of the queue.

To stop a queue:
1. Open Intergraph Batch Manager.
2. Click on the queue listed in the server view, or select the queue view for that queue.
from the toolbar.
3. Select Queue > Stop, or click Stop Queue
The queue should now show as STOPPED in its listing in the server view.
The availability of the Start and Stop menu and toolbar commands toggles, depending on the
current outflow state of the queue.

Displaying Queue Status


You can display the status of any queue on the batch server on your computer, and of any
queues on any batch servers on remote computers. Queue status information includes queue
type, queue priority, inflow state, outflow state, and a count of the jobs currently in the queue.
To display the status of a queue on your computer, double-click on the queue listed in the server
view, or select the queue view for that queue in the Intergraph Batch Manager window.
To display the status of a queue on another system:
1. Open Intergraph Batch Manager.
2. Select Server > Connect.
3. Key in the name of the server (\\system_name) on which the queue resides; then click OK.
Batch Manager displays a server view for the selected server, listing the queues currently
available on that server.
You can also use Queue > Connect To to display a queue view for a particular queue on
a remote computer.

28

Intergraph Batch Services Quick Start Guide

SECTION 5

Submitting a Batch Job


This section describes how to submit a batch job, and monitor the status of submitted jobs, on a
system running Batch Services. For more information on the Batch Manager interface, or for
information on using the command-line interface, refer to Batch Services Help.
You can use Batch Services to run an executable program on your system, or to perform a set
of tasks on your system. To perform a set of tasks, you can create a script, a file containing
instructions that can be interpreted by a shell. The following section describes scripts; the rest of
the chapter describes how to submit and monitor batch jobs.

In This Section

Creating a Script ............................................................................ 29


Submitting a Job ............................................................................ 30
Saving and Restoring Named Batch Jobs ..................................... 33

Creating a Script
A batch job reads a script and performs the instructions in it, using the appropriate shell (the
program that runs the instructions in the script). Scripts can take many forms, including .bat files
and Perl scripts. A script can also be an executable program (.EXE file) if the queue has no
default shell, or if the shell is set to CMD.EXE.
The following example is a .bat script that backs up a directory on the batch server to a shared
drive that has been locally mounted from a remote system. To use the script, ensure that a local
batch queue has been created, enabled, and started, and that the queues default shell is the
cmd.exe program.
REM This script will do the following:
REM
REM
1. Mount the shared drive \\machine\share
REM
2. Copy everything in c:\users\default to the shared drive.
REM
3. Unmount the shared drive.
REM
net use p: \\machine\share
xcopy c:\users\default p: /e /i
net use /delete p:

The following example is a .bat script that prints all PostScript files in the c:\temp directory on
the batch server to a printer on a remote Windows system. To use the script, ensure that a local
batch queue has been created, enabled, and started; that the queues default shell is the
cmd.exe program; and that your system has access to the printer on the remote Windows
system.
REM This script will do the following:
REM
REM
1. Associate a remote printer on a Windows system
REM
(\\machine\printer) with a local printer port.
REM
2. Copy files in c:\temp that end in .ps to the local printer
REM
port.
REM
3. Remove the printer association.

Intergraph Batch Services Quick Start Guide

29

Submitting a Batch Job


REM
net use lpt1: \\machine\printer
cd c:\temp
for %%I in (*.ps) do copy %%I lpt1:
net use /delete lpt1:

Submitting a Job
To submit a job to be run on the batch server on your system:
1. Open Intergraph Batch Manager.
2. Select a queue listed in the server view, or select the queue view for that queue.
3. Ensure that the selected queue is enabled and started.
on the toolbar.
4. Select Job > Submit, or click Submit Job
Intergraph Batch Manager provides tabbed pages in the Job Submit dialog for the following job
parameter categories:
General

Sets basic information about the job.

Scheduling

Sets the parameters associated with scheduling the job for execution.

Notification

Sets the notification preferences for the job.

Output

Specifies how output should be handled for the job.

Resources

Configures job resources needed for the batch job.

File Staging

Describes how necessary files for the job are handled.

Advanced

Sets advanced job parameters.

The following sections describe basic operational parameters found in the Job Submit dialog,
along with brief instructions for using them when submitting a job.

Setting Basic Job Information


Displays the following basic information about the job.
Job ID - Shows the ID of the job.
Owner - Specifies the user who has submitted the job.
State - Shows the status of the job.
Queue - Specifies the queue to which the job is submitted.
Job Name - Specifies a user-defined name for the job.
Script File - Specifies the shell script submitted for execution.
Account Name - Specifies a user-defined string describing the account.
Size - Shows the size of the shell file.
Shell - Displays the currently selected shell for the job. A blank value indicates the default shell
for the queue. This value can be set only at job submission.
Restartable - Controls whether the job is restarted after a system crash, system shutdown, or
batch service shutdown while the job is running.

30

Intergraph Batch Services Quick Start Guide

Submitting a Batch Job

Setting Job Scheduling Information


Describes the various parameters associated with scheduling the job for execution.
Job Occurs - Sets the execution frequency of a job. Jobs can be scheduled to run once or at
regular intervals. If you choose to run jobs at regular intervals, additional recurring job frequency
controls (Minutes, Hourly, Daily, Weekly, Monthly, or Yearly) appear to the right of this field.
These controls allow you to enter more specific scheduling information. The scheduling controls
can be changed at job submission, and the recurring jobs frequency controls can be modified for
recurring jobs already submitted.
Time Ranges / Range Times - Sets a period of time within a day for the recurring job to run.
This option is available only with Minute(s) and Hourly settings. The Range Times controls are
shown after you click Time Ranges. For example, if you want to schedule an hourly recurring
job to run from 15:30 to 22:00, specify 15 Hours, 30 Minutes for the From field and 22 Hours,
00 Minutes for the To field.
Start Date - Specifies the date when a one-time job should be run or when the execution series
of a recurring job should begin. This setting can be changed at any time before the end date.
End After - Specifies how many times the job is run before its execution series ends
No End Date - Sets the recurring job to run indefinitely.
End By - Specifies an end date for the execution series of the job.
Start Time - Specifies the time the job is allowed to start. These fields can be changed at job
submission and at any time before the end date for submitted recurring jobs.
Current Time - Uses the submission time of the job as its start time. This field can be changed
at job submission and at any time before the end date for submitted recurring jobs.
Next Occurrence - Shows the date and time of the next occurrence of the recurring job. This
read-only field appears only for recurring jobs (on page 38). It is calculated by Batch Services.

Creating Recurring Jobs


If you have a task that recurs on a regular basis, such as a nightly backup, you can schedule it
as a recurring job. You only schedule recurring jobs once, and then Batch Services
automatically runs all future occurrences of the job for you.
As an example, we will schedule a system backup to run every Tuesday and Thursday at 7:00
PM, starting on the first of September 2011. To do this:
1. Open Intergraph Batch Manager and select the queue to which you want to submit the
recurring job.
2. Select Job > Submit.
3. Browse for and select the backup script that you want to run.
4. Select the Scheduling tab.
5. Select weekly job frequency by choosing the Weekly radio button.
6. Select a weekly frequency of every 1 week.
7. Select the Tuesday and Thursday checkboxes, making sure that no other checkboxes are
selected.
8. Set the effective date to September 1, 2011.
9. Set the start time to 19:00 (7:00 PM). The Next Occurrence field will note that the first
occurrence of the backup job will be run on Thursday, September 1, 2011 at 7:00 PM.

Intergraph Batch Services Quick Start Guide

31

Submitting a Batch Job

Specifying Job Notification Preferences


Describes the notification preferences for the job. Notification preferences can be set only at job
submission.
Job Start / Job Completion / Job Abort - Specifies the notification option. You can be notified
for the following events:
The job begins execution (Job Start).
The job completes execution (Job Completion).
The job is aborted (Job Abort).
By default, Job Abort is selected.
Output File / Error File - Sets whether output files and error files are included with the
notification.
Address - Lists mail addresses in the form \\host (event log notification) or user@host (see
Configuring SMTP Mail). Mail will be sent to each recipient. To add an address to the list, type in
the mail address and click Add. You can specify more than one recipient by typing in addresses
separately, and clicking Add after each address. By default, job notification messages are
placed in the event log of the batch server where the job is run.
Address Book - Opens the address book for you to select mail addresses.
Add - Adds the specified recipient to the list box.
Move Up - Moves the selected recipient up in the list of mail addresses.
Remove - Removes the highlighted recipient from the list of mail addresses.
Remove All - Removes all existing recipients from the list of mail addresses.

Specifying How to Handle Job Output


Specifies how the output is handled for the job. This information can be changed only at job
submission.
Output Pathname - Specifies a path and file name indicating where the standard output files
are stored. For local files, type in the complete pathname. You can specify a network pathname
using the \\host\pathname\filename format.
Error Pathname - Specifies a path and file name indicating where the standard error files are
stored. For local files, type in the complete pathname. You can specify a network pathname
using the \\host\pathname\filename format.
Keep Output on Execution Host - Specifies whether the output is kept on the execution host.
No Spooling - Specifies whether output is to be created directly in the specified pathname,
rather than spooling (on page 38) the output and waiting until the job is completed. Spooling is
not supported on remote computers.
Join Output in One File - Disables the Standard Error group box and sends all output to the
standard output.

32

Intergraph Batch Services Quick Start Guide

Submitting a Batch Job

Specifying Job Resource Requirements


Configures the various job resources needed for the batch job.
Execution Priority - Sets the run time priority. The default run time priority is set by the queue.
This value cannot be greater than the execution priority for the queue.
Environment - Enters and updates environment variables. These values can be specified only
at job submission.
Variable - Specifies the environment variable name.
Value - Specifies the environment variable value.
Set - Adds the selected environment variable name to the batch environment of the job.
Remove - Deletes the selected environment variable from the batch environment of the job.
Remove All - Deletes all environment variables from the batch environment of the job.
Add Current Environment Variables - Adds all environment variables in the current
environment to the name list. This option is available only at job submission.

Saving and Restoring Named Batch Jobs


A batch job can be saved to a file for later recall, modification, and submission. This is especially
useful if you want to set up certain job parameters to be used again and again.
For example, you might have a certain set of people you want to notify whenever a backup runs.
You could create a named job that contains the name of your backup script, the queue in which
it should run, and the notification list and save it as BACKUP.NJOB. To run a backup job, you
would then open the named job using the Job Submit dialog, make any necessary changes
(perhaps the start time of the job), and then submit the job. Using this method, you do not have
to re-enter the job's parameters each time you want to run the job.
After you have created a named job, you can access it in a variety of ways. Any of the following
methods open the named job and fill in the Job Submit dialog with all of its parameters:
1. Click Open on the Job Submit dialog box, browse for the named job, and click OK.
2. Drag the named job file from Windows Explorer into the Batch Manager window.
3. Enter the command batchmgr named_job.NJOB at the command prompt, where
named_job is the name of the job file.
4. Double-click on the named job file in Windows Explorer.
The last two methods will not work if Batch Manager is already active since only one
Batch Manager session at a time is allowed.

To create a named job:


1. Select Job > Submit.
The Job Submit dialog displays.
2. Enter the job parameters that you want to save as a named job.
3. Click Save As to name and save your job.

To recall and submit a previously saved named job:


1. Select Job > Submit.
The Job Submit dialog displays.
2. Click Open to browse for previously saved named jobs.

Intergraph Batch Services Quick Start Guide

33

Submitting a Batch Job


3. Choose the named job you want to recall, and click OK.
Batch Manager loads the saved job parameters into the Job Submit dialog and displays the
name of the job in the title of the Job Submit dialog box.
4. You can submit the job exactly as it was stored in the named job file, or you can make
modifications. If you want to save changes you make, click Save to overwrite the existing
named job, or click Save As to choose a new name for the modified job.
5. Click Submit to submit the job.

Creating a Named Job


To create a named job:
1. Select Submit from the Job menu to display the Submit dialog box. See Submitting a Job
(on page 30) for more information about the Submit dialog box.
2. Enter the job parameters that you wish to save as a named job.
3. Select Save As to name and save your job.

Submitting a Named Job


To recall and submit a previously saved named job:
1. Select Submit from the Job menu to display the Submit dialog box.
2. Select Open to browse for previously saved named jobs.
3. Choose the named job you wish to recall, and select OK. Batch Manager loads the saved
job parameters into the Job Submit dialog, and displays the name of the job in the title of the
Job Submit dialog box.
4. You may submit the job exactly as it was stored in the named job file, or you can make
modifications. If you wish to save changes you make, select Save to overwrite the existing
named job, or select Save As to choose a new name for the modified job.
5. Select Submit to submit the job.

34

Intergraph Batch Services Quick Start Guide

Glossary
A
account mapping
The process of determining the account name to use when running jobs. Batch Services
requires an account name and password to use when running jobs. To perform account
mapping, the server tries to match the job owner with an account mapping entry.

B
batch job
A batch job is the full set of instructions to Batch Services to perform a given task or set of tasks
on a computer system. The job itself is identified with a script, or a file that can be interpreted by
some program to perform a set of instructions. An example of a script is a .BAT file, which is
interpreted by the CMD.EXE program.
A unique job identifier or jobid identifies each job. No two jobs will have the same jobid. See also
job and shell.

batch queue
A batch queue accepts requests to execute scripts or commands from the keyboard as if the
user submitting the request were logged in to the system. Jobs are executed in a batch queue.
The resulting output returns to the directory from which the original requestor submitted the job.
You can request the output to remain on the executing node or return to a remote node.
Batch queues can also have a list of shells associated with them, allowing an administrator to
configure a queue to run certain types of scripts. For example, a batch queue may be set up to
run scripts for the Perl program. See also queue.

batch server
A Windows service that processes batch jobs, and maintains queue and job information. A
Batch Server is also the system on which Batch Services runs. The SmartPlant Batch Server is
a system service that may be controlled using the Services icon on the Control Panel.

D
default queue
The queue to which a job is assigned when a user does not specify a queue.

default shell
The shell that is used to run a job submitted to a queue when a user does not specify a shell for
that job.

Intergraph Batch Services Quick Start Guide

35

Glossary
disabled
A queue state in which the queue will not accept new jobs.

E
enabled
A queue state in which the queue will accept new jobs.

execution host
The computer where a batch job is run.

H
hold
A delay in running a job submitted to a queue. A held job will not run until the hold is released, or
the job is deleted from the queue.
A user hold may be placed on a job submitted by that user when the job is submitted. A user
hold can be released either by the submitting user, or by a user with operator or manager
privileges on the server.
A user with operator or manager privileges may place an operator hold on a job, after the job is
submitted but before it runs. Only a user with operator or manager privileges can release an
operator hold.
When a job is being held, the job will remain in the queue until it is deleted or released. It will not
run while the hold is in place. See also privilege.

I
inflow state
The state of a queue with regard to accepting jobs. See also queue state, enable, disable.

J
job
A set of instructions needed to perform a given task or set of tasks on a computer system. See
also batch job and shell.

job identifier (job ID)


A unique alphanumeric string that identifies a job. A batch job ID is in the form jobid.orighost,
where jobid is a sequentially assigned number up to 5 digits in length, and orighost is the name
of the system from which the batch job originated.
When a job is successfully submitted, it is assigned a unique job-id. The job-id can be used to
reference the job. No two jobs will have the same job-id.

36

Intergraph Batch Services Quick Start Guide

Glossary
M
manager
See privilege.

O
operator
See privilege.

outflow state
The state of a queue with regard to processing jobs. See also queue state, started, stopped.

P
per-process file size limit
The file size limit indicates the maximum total file size used by a request. This value is not used
in Windows.

pipe queue
A pipe queue routes requests to another queue. Pipe queues can accept either a batch request,
or a request from another pipe queue. A pipe queue receives the request and sends it to the first
available queue in its destination list that will accept the request. The destination list may contain
any queue type. Pipe queues are normally used to create a connection to a remote batch
queue.

privilege
An operational permission level assigned to every Batch Services user. Non-privileged users
can submit jobs to queues to which they have been granted access; operators can issue
commands that directly affect queue management; and managers can control all aspects of
Batch Service operation.

Q
queue
A queue is a waiting line in which job requests reside until they are processed. A queue can
control the number of jobs submitted to it, the number of simultaneous jobs, and the execution
priority of those jobs. A queue can also restrict the users and groups that have access to it. The
batch system supports batch queue and pipe queue.

queue state
A queue has two states: the inflow state and the outflow state.
Inflow State - The inflow state is either enabled or disabled. An enabled queue will accept new
jobs that are submitted or transferred to it; a disabled queue will not.

Intergraph Batch Services Quick Start Guide

37

Glossary
Outflow State - The outflow state is either stopped, started, or stopping. A stopped queue will
not run the jobs it contains. A queue must be started in order to run jobs.
Example
An "enabled/stopped queue" is a queue that will accept jobs but not run them.
See also enabled, disabled, started, stopped.

queue view
The view in Batch Manager that shows information on the jobs in a queue.

R
recurring jobs
Jobs scheduled to run more than once at a regular interval. Use the Job Submit\Scheduling tab
in Batch Manager to submit recurring jobs. Hourly, daily, weekly, monthly, and yearly intervals
are available.

S
scheduling priority
The scheduling priority, or "intra-queue priority," is used for scheduling the order of job execution
within the queue. The priority value must be in the range of [-1024..1023].

script
A file that contains instructions for the execution of a batch job.

server view
The view in Batch Manager that shows information about the operation of one or more queues.

shell
An executable program that can be used to run a script. For example, cmd.exe is a shell that
can be used to run .bat scripts. See also script.

spooling
The process of storing a file internally by Batch Services until a batch job ends, and then
returning the files to the intended directories. Spooling is not supported on remote computers.

started
A queue state in which the queue will run jobs submitted to it.

38

Intergraph Batch Services Quick Start Guide

Glossary
stdin, stderr, stdout
These are standard streams for input, output, and error output.
By default, standard input (stdin) is read from the keyboard, while standard output (stdout) and
standard error output (stderr) are printed to the screen.

stopped
A queue state in which the queue will not run jobs submitted to it.

Intergraph Batch Services Quick Start Guide

39

Glossary

40

Intergraph Batch Services Quick Start Guide

Index
A
access to desktop 12
account mapping 12, 22, 35, 39
basic information 30
job output 32
notification 32
resources 33
scheduling 31
submitting 30
adding destinations 26
batch 23
pipe 24
Adding Destinations to a Pipe Queue 26
adding shells 26
basic information 30
job output 32
notification 32
resources 33
scheduling 31
submitting 30
Adding Shells to a Batch Queue 26

B
batch job 35
basic information 30
batch 23
creating named 34
job output 32
named 33, 34
notification 32
pipe 24
resources 33
creating 23, 34
submitting 34
scheduling 31
script 29
default 25
submitting 30
adding destinations 26
adding shells 26
creating 23
default shell 26
deleting 24
disabling 27
enabling 27
modifying 24
starting 27
status 28

Intergraph Batch Services Quick Start Guide

stopping 27
Batch Manager
account mapping 12, 22, 39
adding destinations 26
adding shells 26
default shell 26
disabling 27
enabling 27
modifying 24
starting 27
status 28
stopping 27
adding destinations 26
adding shells 26
batch job 35
creating queues 23
default shell 26
deleting queues 24
disabling queues 27
enabling queues 27
granting privileges 20
named batch job 33
overview 19
queue status 28
queue view 39
queues 23
removing privileges 20
server view 39
setting default queue 25
starting queues 27
status bar 19
stopping queues 27
submitting named batch job 34
using 19
views 19
batch queue 35, 39
batch server 35, 39
Batch Services
account mapping 12, 22, 39
batch job 35
compatibility with network adapters 11
components 9
configuring desktop access 17
destination directory for product files 12
getting started using 9
installation requirements 11
installing 12
named batch job 33
privileges 20

41

Index
queues 23
removing 19
setting default queue 25
starting 12, 16
stopping 16
using Batch Manager 19
Batch Services Components 9
Batch Services Defined 8
Batch Services Features 8
Batch Services Hardware/Software
Recommendations 11
Batch Services Help 5
Batch Services Overview 7

C
Changing Queue Properties 24
Command Line Installation (Silent Install)
15
Creating a Batch Queue 23
creating a named batch job 34
Creating a Named Job 34
Creating a Pipe Queue 24
Creating a Script 29
Creating and Deleting Queues 23
Creating and Managing Queues 23
Creating Recurring Jobs 31
creating script 29

D
default queue 35, 39
default shell 26, 35, 39
Deleting a Queue 24
desktop access 12, 17
disabled 36
disabling queues 27
Displaying Queue Status 28
DNS 11

E
enabled 36
Enabling and Disabling a Queue 27
enabling queues 27
execution host 36, 39

G
Getting Started 9
Getting started using Batch Services 9
Granting Batch Service Privileges 20
Granting Jobs Access to the Desktop 17

42

H
hold 36

I
inflow state 36, 39
disabled 39
enabled 39
installation requirements 11
Installing and Configuring Batch Services
11
installing Batch Services 12
Installing Intergraph Batch Services 12
Intergraph
finding on the Internet 7
Internet
finding Intergraph 7

J
job 36, 39
job hold 39
job ID 39
job identifier (job ID) 36

M
manager 37

N
named batch job 33
creating 23
submitting 34
network adapters and Batch Services 11

O
online documentation 5
operator 37
outflow state 37, 39
started 39
stopped 39

P
per-process file size limit 37
pipe queue 37, 39
Preface 5
privilege 37, 39
privileges
granting 20
removing 20
product directory for Batch Services 12

Intergraph Batch Services Quick Start Guide

Index

Q
queue 37, 39
inflow state 39
outflow state 39
queue state 37, 39
queue status 28
queue view 38, 39
queues 23
adding destinations 26
adding shells 26
creating 23
default shell 26
deleting 24
disabling 27, 28
enabling 27
modifying 24
properties 24
setting default 25
starting 27
stopping 27

submitting a batch job 30


Submitting a Batch Job 29
Submitting a Job 30
submitting a named batch job 34
Submitting a Named Job 34
support 5

T
TCP/IP 11
training 5

U
Understanding Account Mapping 22
Understanding the Batch Manager Interface
19
Using Batch Manager 19

V
views 19

R
recurring jobs 38
removing Batch Services 19
Removing the Batch Service 18

S
Saving and Restoring Named Batch Jobs
33
scheduling priority 38
script 38, 39
server view 38, 39
Setting Basic Job Information 30
Setting Job Scheduling Information 31
Setting the Default Queue 25
shell 38, 39
Specifying How to Handle Job Output 32
Specifying Job Notification Preferences 32
Specifying Job Resource Requirements
33
spooling 38, 39
started 38
Starting and Stopping a Queue 27
Starting and Stopping Batch Services 16
starting Batch Services 12, 16
starting queues 27
status bar 19
stdin, stderr, stdout 39
stopped 39
stopping Batch Services 16
stopping queues 27

Intergraph Batch Services Quick Start Guide

43