Professional Documents
Culture Documents
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.
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.
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
Contents
Glossary ..................................................................................................................................................... 35
Index ........................................................................................................................................................... 41
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.
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.
SECTION 1
In This Section
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).
10
SECTION 2
In This Section
11
12
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
13
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
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.
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.
15
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.
16
17
18
SECTION 3
In This Section
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
19
20
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.
21
22
SECTION 4
In This Section
23
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.
24
Tab
Parameter
Default
Comments
General
Description
None
Optional.
Scheduling
Run Limit
Job Defaults
Scheduling Priority
31
Parameter
Default
Comments
Security
Queue Access
Authorized Groups
and Users
None
Shells
Destinations
25
You must have manager privileges on the batch server to set the default shell for a batch
26
You must have manager privileges on the batch server to add a destination to a pipe
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.
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.
27
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.
28
SECTION 5
In This Section
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.
29
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
Scheduling
Sets the parameters associated with scheduling the job for execution.
Notification
Output
Resources
File Staging
Advanced
The following sections describe basic operational parameters found in the Job Submit dialog,
along with brief instructions for using them when submitting a job.
30
31
32
33
34
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.
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.
36
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.
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
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.
39
Glossary
40
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
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
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
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
43