User Guide

10.1
- 10.5 HotFix 2
- 10.5 HotFix 1
- 10.5
- 10.2 HotFix 1
- 10.2
- 10.0 HotFix 1
- 10.0

Back Next

User-Step-Definition

Each

User-Job-Definition

is associated with one or more

User-Step-Definitions

. They are equivalent to Job Steps added with the

Add Step

button in the Console and contain the following parameters:

Field	Description
COMMENT=	This is a text field that is used to describe step’s purpose.
JOB=	This is the name of the User-Job-Definition that this step belongs to.
NUMBER=	This field is used to order steps within a User-Job-Definition. NUMBER is a printable numeric value starting from 0. That is, the first step has NUMBER = 0 . There must be no gaps in the numbering of steps.
NAME=	This is the type of Job step. A list of valid types is visible in the Console dialog when you click New Step . Names containing spaces should be enclosed in quotes (").
TYPE=	This is the type of step. A list of valid job types and their associated parameters can be generated by running %SSABIN%\pdf -ddce reportFileName or $SSABIN/pdf -ddce reportFileName
PARAMETERS=	This is a list of parameters and values required by the step (if any). A list of valid job types and their associated parameters can be generated by running %SSABIN%\pdf -ddce reportFileName or $SSABIN/pdf -ddce reportFileName

For example:


user-job-definition
*==================
NAME=                          RunClustering1AndDupFinder
*
user-step-definition
*===================
COMMENT=                       "First step"
JOB=                           RunClustering1AndDupFinder
NUMBER=                        0
NAME=                          "Reinitialize DB"
TYPE=                          "Reinitialize DB"
*
user-step-definition
*===================
COMMENT=                       "Second step"
JOB=                           RunClustering1AndDupFinder
NUMBER=                        1
NAME=                          "Run Clustering 1"
TYPE=                          "Run Clustering"
PARAMETERS=                    ("Clustering Definition",
                                       clustering-1)
*
user-step-definition
*===================
COMMENT=                       "Third step"
JOB=                           RunClustering1AndDupFinder
NUMBER=                        2
NAME=                          "Run DupFinder"
TYPE=                          DupFinder
PARAMETERS=                    ("Output File","dup00.rep"),
                               ("Search Definition",
                                        clustering-1),
                               ("Output Format",0),
                               ("Append New Line",true),
                               ("Trim Trailing Blanks",true),
                               ("Return Search Records Only",
                                       false),
                               ("Remove Search Record",false)

Rename Saved Search

Table of Contents

User Guide

User Guide

User-Step-Definition

User-Step-Definition