Select Parameters - Fields and controls
Use the Select Parameters window to add system parameters and systems
tokens to your program definition.
Available Parameters list
Depending on your selection in the Type area, this list
displays the system parameters or system tokens that you can add to a
program definition. To learn more about system parameters and tokens,
click one of the links below.
- A number of system parameters
are available for your program definition. The following list
shows the system parameters in the order that they are displayed in
the Available Parameters list and provides a brief description of
each parameter.
- Step name
- Passes the name of the step to the user-defined program.
- Process
name
- Passes to the user-defined program the name of the process that
this step is associated with.
- End time
- Passes the timestamp of the completion of the last run of the
step to the user-defined program.
- Start time
- Passes the last scheduled timestamp of the step to the
user-defined program.
- Return
code
- Passes the return code that is generated when the parent step
either runs successfully or fails.
- Return
code message
- Passes the return code message that is generated when the parent
step either runs successfully or fails.
- Number
of retries
- Passes the number of retries that occurred for this step to the user-defined
program.
- Total
number of rows retrieved
- Passes the number of rows that were retrieved during processing.
- Number
of rows retrieved on last attempt
- Passes the number of rows that were pulled for the last pull of
the step.
- SELECT
statement
- Passes a SELECT statement that you configure on the Parameters
page of the SQL Step notebook to the user-defined program. Each token
of the SELECT statement will be passed to the user-defined program as
an individual argument. The user-defined program then reassembles the
arguments into an SQL statement.
- Warehouse
target database name
- Passes the target database name to the user-defined program.
- Warehouse
target user ID
- Passes to the user-defined program the user ID of the person who
has access to the target database.
- Warehouse
target password
- Passes to the user-defined program the password of the person who
has access to the target database.
- Warehouse
target table or file name
- Passes to the user-defined program the name of the table or flat
file where the data will be stored.
- Warehouse
target tablespace name
- Passes the DB2 tablespace name, if one exists. A tablespace must
exist in DB2 before it can be used by the Data Warehouse Center.
- Warehouse
target table index space name
- Passes the name of the DB2 tablespace name for the index of the
target table, if one exists. The index tablespace must exist before
it can be used by the Data Warehouse Center.
- Warehouse
target information
- Passes the name of the target database and the user ID and
password of the person who has access to that database. This
parameter passes all the information that is contained in the
Warehouse target database name, Warehouse target user ID, and
Warehouse target password parameters. You can use the Warehouse
target information parameter any time you want to pass the
information contained in these three parameters.
- Number
of warehouse sources
- Passes the number of warehouse sources to the user-defined
program. A target can have multiple sources.
- Warehouse
source database name
- Passes the name of the warehouse source to the user-defined program.
- Warehouse
source user ID
- Passes to the user-defined program the user ID of the person who
has access to the warehouse source.
- Warehouse source password
- Passes to the user-defined program the password used to access
the warehouse source.
- Number of warehouse source tables
- Passes the number of tables in the warehouse source to the user-defined
program.
- Warehouse source table or file names
- Passes the table names in the warehouse source to the
user-defined program.
- Warehouse
source information
- Passes the name of the source database and the user ID and
password of the person who has access to that database. This
parameter passes all the information contained in the Warehouse
source database name, Warehouse source user ID, and Warehouse source
password parameters.
- You can use the Warehouse source information parameter any time
that you want to pass the information contained in these three parameters.
- Run ID for warehouse target table
- Passes the Run ID number of the target table to the user-defined program.
- Run ID for warehouse source tables
- Passes the run ID numbers for source tables to the user-defined program.
- Number of run IDs for warehouse source
- Passes the number of run IDs of a warehouse source to the user-defined
program.
- CONNECT string for warehouse source
- Passes the ODBC connect string that is associated with a
warehouse source. The connect string syntax differs depending upon
the warehouse source.
- Program Managed Output
- Passes the list that contains the tables to which the program or
transformer (if applicable) will write.
- Number
of Parameters
- Determines the number of parameters and tokens, including itself,
that are passed to the user-defined program. This parameter counts
all parameters that are created by users to pass to a user-defined
program as a single parameter.
- For example:
- x+y = number of parameters passed to a program
- where
- x = total number of Data Warehouse Center parameters and tokens,
including the Number of Parameters parameter.
- y = user-created parameters. This number is always either 1 or 0.
- Agent Site Name
- Passes the name of the agent site associated with the step.
- A number of system tokens are
available for your program definition. The following list
provides a brief description of each token. Tokens that do not have
an N in the beginning of the their name are passed as character
strings. Tokens that have an N in the beginning of their names are
passed as Integers.
- cur_mm
- Passes the current month, in numerical form (01 through 12).
- cur_month
- Passes the current month, in abbreviated form (Jan through Dec).
- cur_dd
- Passes the current day of the month, in numerical form (01
through 31).
- cur_ddd
- Passes the current day of the year, in numerical form (001
through 366).
- cur_yy
- Passes the last two digits of the current year, in numerical form
(00 through 99).
- cur_yyyy
- Passes the current year, in numerical form (0000 through 9999).
- cur_mmyy
- Passes the current month and year, in numerical form (for
example, 0600).
- cur_qtryy
- Passes the quarter and last two digits of the current year, in
numerical form (1 through 4 and 00 through 99).
- cur_qtr
- Passes the current quarter, in numerical form (1 through 4).
- cur_ddmmyy
- Passes the current day, month, and year, in the following form:
- 29/06/00
- cur_mmddyy
- Passes the current month, day, and year, in the following form:
- 06/29/00
- cur_edtn
- Retrieves the last set of successfully extracted rows into a step
when multiple editions of step data are supported.
- cur_yyyy_mm_dd
- Passes the current year, month, and date, in the following form:
- 2000-06-29
- cur_yyyymmdd
- Passes the current year, month, and date, in the following form:
- 20000629
- cur_yy_mm_dd
- Passes the current year, month, and date, in the following form:
- 00-06-29
- cur_mmddyyyy
- Passes the current month, date, and year, in the following form:
- 06/29/2000
- cur_yyyymm
- Passes the current year and month, in the following form:
- 200006
- cur_ddmmyyyy
- Passes the current day, month, and year, in the following form:
- 29.06.2000
cur_DB2TimeStamp
Passes the DB2 TimeStamp
Ncur_mm
- Passes the current month, in numerical form (01 through 12).
Ncur_dd
- Passes the current day of the month, in numerical form (01
through 31).
Ncur_ddd
- Passes the current day of the year, in numerical form (001
through 366).
Ncur_yy
- Passes the last two digits of the current year, in numerical form
(00 through 99).
Ncur_yyyy
- Passes the current year, in numerical form (0000 through 9999).
Ncur_mmyy
- Passes the current month and year, in numerical form (for
example, 0600).
Ncur_qtr
- Passes the current quarter, in numerical form (1 through 4).
Ncur_yyyymmdd
- Passes the current year, month, and date, in the following form:
- 2000-06-29
Ncur_yyyymm
- Passes the current year and month, in the following form:
- 200006
Ncur_minute
Passes the current minute in
numerical form ( 00 through 60)
Ncur_hour
Passes the current hour in
numerical form ( 00 through 23)
Ncur_second
Passes the current second in
numerical form ( 0 through 60)