ControlM

JobNamingStandardsGuide

Contents

Chapter 1

General parameters

NN

Application..............................................................1
AutoEdit..............................................................2
ControlM............................................................... 3
Description.............................................................. 4
DocLib.................................................................. 5
DocMem................................................................ 6
FileName/MemName.................................................... 7
Group...................................................................8
JobName................................................................9
Maxwait................................................................ 10
Owner ..................................................................11
TaskType ..............................................................12

Chapter

General parameters

Theparametersdescribedinthischaptercontainbasicinformationthatidentifiesthe
job,describeswhatitdoes,andgivesthelocationofthejobscript.

Table 2

General parameters summary (part 1 of 2)

Parameter

Description

Application

Name of the application to which the jobsgroupbelongs.

Mustbea3characterApplicationID
Used toassign values to user variables tobereferenced in the job
scriptorinotherparametersofthejob.ItisalsocalledSetVar.

AutoEdit
ControlM

MainframeorDistributed Server to whichthejobbelongs.

Description

Free text description of the jobisoptional

DocLib

Name of a library or directory containingthejobdocumentation file.

DocMem

Name of the file containing job documentation.

FileName/Mem
Name

ShouldbeidenticaltoJobname

Table 2

General parameters summary (part 2 of 2)

Parameter

Description

GroupName

StartswithApplicationIDfollowedbydash()
Example:STU,CAR,BFSxxxxxxxxx
Upto64characterinlength(bothDistributedandMainframe)
(DevelopercanchoosenameaftertheapplicationID)
Startwitha3characterApplicationID(distributed)lowercaseand
upto10charactersinlength.
Mainframeupto8charactersmax.
Nospecialcharacters(no:,_,etc.)Onlyalphanumeric(AZ),09)

JobName

Maxwait

=3days

Owner

Ownermustcontain PROplus the3characterapplicationId

PROXXX

TaskType

TaskTypeshouldbeJOB(distributedandmainframe)requirement
TaskTypeCommand(thisisanexception)Requiresrunningascript

Application

Application

Providesalogicalnameforsortinggroupsofjobs.Thisparameterisusedtosupplya
commondescriptivenametoasetofrelatedgroupsofjobs.

Format

Usage

Mandatory

Default

None

Length

3characters

CaseSensitive

Yes,Upper

Invalid
Characters

Blanks
Singlequotationmarks.

General information

RecoveryDocumentationisrequired.Listinstructionsandoractions.

TheApplicationparameterfacilitatesmoreconvenientandorderlymanagementof
groupsofproductionjobs.

ThevalueassignedtotheApplicationparametercanbeusedtodeterminethe
placementofjobsintheControlMflowdiagram.

Example: Identifying jobs by business department

ToidentifyalljobscreatedfortheBusinessFinanceSystemsteam:
Application:BFS

Description

Description

Providesadescriptionofthejobinfreetext.

Format

Usage

Mandatory

Length

14000characters

Casesensitive

Yes

Invalid
Characters

[]()*

General information

TheDescriptionparameterisusedtodescribethejob.Awellwrittendescriptioncan
helpyoudeterminewhythejobwasdefinedandhowitfitsintoyourbusiness
environment.

Example: Description of a job for producing a yearly report

Thedescriptionofareportdetailingtheyearsrevenuesandexpenditures.

BFSYearlyFinancialReportforBoardofDirectors

File Name/Mem Name

File Name/Mem Name

Indicatesthenameofafilecontainingthecontrollanguagestatementsforthejob
(script/JCL)tobeexecuted.

Format

Usage

Mandatory

Length

CaseSensitive

Microsoft Windows, UNIX: 410 characters(plusextension)

z/OS:18characters

Yes
MicrosoftWindows,UNIX:Lowercaseonly
z/OS:Uppercaseonly

Invalid
Characters

Blanks, \, /, or *

General information

TheFileNameparametershouldcontainonlythenameofthefile,notthefullpath.
ThePathparameterisusedtospecifytheremainderofthepath.

TheFileNamewillbethesameasthejobname.Eachmembercontainsonly
onejob.

NOTE
Charactermasksarenotsupported.Forexample,ajobwithabfs*.batFileName
valueisinvalid.

Computer-specific information

Thecommandmustconformtothefollowingconventions:
Computer

Information

Microsoft
Windows

Nameofabatchcommand file.

UNIX

NameofaUNIX shell script file.

z/OS

Nameofamember whose contents are determined bytheTaskType

parameter.

JCLofthejob
Startedtaskprocedure

File Name/Mem Name

Example 1: Microsoft Windows

ctmexample.bat,ctmexample.cmd

Example 2: UNIX

ctmexample.sh, ctmexample.ksh, ctmexample.csh

Example 3: z/OS

CTMEXMPL

Group

Group

Indicatesthenameofthegrouptowhichthejobbelongs.

Format

Usage

Mandatory

Length

364characters,muststartwithAppID

CaseSensitive

Yes,Uppercaseonly

Invalid
Characters

Blanks; single quotation marks

General information

TheGroupparameterfacilitatesmoreconvenientandorderlymanagementofgroups
ofproductionjobs.

ThevalueassignedtotheGroupparameterdeterminesthejobsplacementinthe
structureoftheControlM/EMflowdiagram.

Example 1: BFS Report jobs

BFS-GL-REPORTS

Example 2: BFS jobs that perform file transfers

BFS-FILE-TRANSFERS

Example 3: BFS jobs that update database records

BFS-GL-DB-UPDATES

Job Name

Job Name

Nameofthejob.

Format

Usage

Mandatory

Length

310 characters
z/OS:38characters

CaseSensitive

Yes

InvalidCharacters

MicrosoftWindows,UNIX:Lowercaseonly
z/OS:Uppercaseonly
Blanks
Singlequotationmarks
\,/,or*

General information

TheJobNameparameterappearsalongwiththeFileNameparameterinvariousjob
definitionandjobtrackingwindows.

TheJobNamecanalsobedisplayedinthejobnodedisplayedintheControlM/EM
window.

Thisparameterisusedwhenorderingorforcingajob,eitherusingtheDoForcejob
parameterorwhenusingtheOrder/Force windows.

TheJobNameparametermustbeunique.