The PROMOTE service moves data, that is, promotes data through the project database according to a project's architecture definition and project definition. Before SCLM can promote a member, it must have a blank access key and must have successfully completed the BUILD service. If a member has an access key, you must call the UNLOCK service to reset the access key before you can promote the member.

Command invocation format

>>-FLMCMD--PROMOTE,project--,-+---------+--,group--,type-------->
                              '-prj_def-'                  

                            .-N-.    .-C-.                      
>--,member--,-+--------+--,-+---+--,-+---+--,-+-------------+--->
              '-userid-'    +-E-+    +-U-+    '-dd_prommsgs-'   
                            '-S-'    '-R-'                      

>--,-+-------------+--,-+-------------+--,-+------------+------->
     '-dd_promrept-'    '-dd_promexit-'    '-dd_copyerr-'   

>--,-+------------+--,-+-------------+--,-+---------------+----->
     '-error_list-'    '-create_rept-'    '-prefix_userid-'   

>--,-+------------+--,-+------------+--,-+------------+--------->
     '-dd_bldmsgs-'    '-dd_bldrept-'    '-dd_bldlist-'   

>--,-+-------------+-------------------------------------------><
     '-dd_bldexitr-'   

Call invocation format

>>-lastrc--:=--FLMLNK('PROMOTEb',sclm_id--,group,type,member---->

                                    (1)                    
>--,-+-userid-+--,-+-E-+--,-+-C-+------,-+-------------+-------->
     '-'--'---'    +-N-+    +-U-+        '-dd_prommsgs-'   
                   '-S-'    '-R-'                          

>--,-+-------------+--,-+-------------+--,-+------------+------->
     '-dd_promrept-'    '-dd_promexit-'    '-dd_copyerr-'   

>--,-+-Y-+--,-+-Y-+--,-+-prefix_userid-+--,-+------------+------>
     '-N-'    '-N-'    '-'--'----------'    '-dd_bldmsgs-'   

>--,-+------------+--,-+------------+--,-+------------+-);-----><
     '-dd_bldrept-'    '-dd_bldlist-'    '-dd_bldexit-'      

1. Comma separators are only required up to and before the last optional parameter specified.

ISPF interface panel

   Menu  SCLM  Utilities  Help
 ──────────────────────────────────────────────────────────────────────────────
                   SCLM FLMCMD PROMOTE Service - Entry Panel
                                                                    More:     +
 SCLM Library:
    Project . . . SCLMTEST
    Alternate . .         
    Group . . . . DEV1    
    Type  . . . . SOURCE  
    Member  . . .         

 User id . . . . . . . . . . . . .           (If blank, your user id is used)
 Prefix for temporary data sets              (Blank to default to user id)

 Mode  . .    1. Conditional       Scope . .    1. Limited
              2. Unconditional                  2. Normal
              3. Forced                         3. Subunit
              4. Report                         4. Extended

 DD Names for output data sets:
    Error message data set           (Blank to write messages to the terminal)
 Command ===>                                                                  
  F1=HELP      F2=          F3=END       F4=DATASETS  F5=FIND      F6=CHANGE
  F9=SWAP     F10=LEFT     F11=RIGHT    F12=SUBMIT                              

Parameters

project

The project name. The maximum parameter length is 8 characters. This parameter is used for FLMCMD only.

prj_def

The project definition name to be used for the promote. It defaults to project. The maximum parameter length is 8 characters. This parameter is used for FLMCMD only.

sclm_id

An SCLM ID associated with a given project and project definition. The INIT service generates the SCLM ID. The maximum parameter length is 8 characters. This parameter is used for FLMLNK only.

group

The group the promote occurs from. The maximum parameter length is 8 characters.

type

The type containing the member to be promoted. The maximum parameter length is 8 characters.

member

The name of the architecture member or source member to be promoted. The maximum parameter length is 8 characters.

userid

The user ID of the person requesting the promote. If no value is specified for FLMCMD or a blank (' ') is specified for FLMLNK, it defaults to your TSO prefix or user ID if no TSO prefix has been created. The maximum parameter length is 8 characters.

E|N|S

Indicates the promote scope (E=extended, N=normal, S=subunit). The maximum parameter length is 24 characters. The default value for FLMCMD is N. There is no default value for FLMLNK.

C|R|U

Indicates the promote mode (C=conditional, R=Report, U=Unconditional). The maximum parameter length is 24 characters. The default value for FLMCMD is C. There is no default value for FLMLNK.

dd_prommsgs

The ddname indicating the destination of the promote messages. If you specify a blank ddname, SCLM routes the promote messages to the default output device, such as your terminal. Otherwise, before you call the PROMOTE service, you must allocate the ddname. The following attributes should be used: DISP=MOD, RECFM=F, LRECL=80, BLKSIZE=80. The maximum parameter length is 8 characters.

dd_promrept

The ddname indicating the destination of the promote report. If you specify a blank ddname, SCLM routes the promote report to the default output device, such as your terminal. Otherwise, before you call the PROMOTE service, you must allocate the ddname. The following attributes should be used: RECFM=FBA, LRECL=80, BLKSIZE=3120. The maximum parameter length is 8 characters.

dd_promexit

The ddname indicating the destination of the promote user exit data. Specify this parameter only if your project administrator defined a promote user exit routine in your project definition. Ask your project manager if your project is using a promote user exit routine. If you specify a blank ddname, SCLM routes the promote user exit data to NULLFILE. Otherwise, before you call the PROMOTE service, you must allocate the ddname. The following attributes should be used: RECFM=FB, LRECL=160, BLKSIZE=3200. The maximum parameter length is 8 characters.

dd_copyerr

The ddname indicating the destination of the promote copy error information. The promote copy error information consists of system messages indicating the cause of copy errors during promote processing.

If you specify a blank ddname, SCLM routes the promote copy error information to the default output device, such as your terminal. Otherwise, before you call the PROMOTE service, you must allocate the ddname. The maximum parameter length is 8 characters.

Y|N

Y indicates that build translator listings are to be copied to the dd_bldlist ddname only if errors occur. N indicates that all translator listings are to be copied to the dd_bldlist ddname. For FLMCMD, the default is Y. There is no default for FLMLNK. The maximum parameter length is 24 characters. This parameter only applies if the project definition requests automatic rebuild when a member is promoted into the 'to group'.

Y|N

Y indicates that a build report is to be produced and routed to the bldrept ddname. N indicates that a build report is not to be produced. For FLMCMD, the default is Y. There is no default for FLMLNK. The maximum parameter length is 24 characters. This parameter only applies if the project definition requests automatic rebuild when a member is promoted into the 'to group'.

prefix_userid

This is the data set name prefix to be used when locating and cataloging temporary data sets. If no value is specified for FLMCMD or a blank (' ') is specified for FLMLNK, it defaults to the user Id parameter. The maximum parameter length is 17 characters. This parameter only applies if the project definition requests automatic rebuild when a member is promoted into the 'to group'.

dd_bldmsgs

This is the ddname indicating the destination of the build messages. If you specify a blank ddname, SCLM routes the build messages to the default output device, such as your terminal. Otherwise, before you call the BUILD service, you must allocate the ddname. The following attributes should be used: RECFM=F, LRECL=80, BLKSIZE=80. You cannot specify a blank ddname for FLMLNK. This parameter only applies if the project definition requests automatic rebuild when a member is promoted into the 'to group'. The maximum parameter length is 8 characters.

dd_bldrept

This is the ddname indicating the destination of the build report. If you specify a blank ddname, SCLM routes the build report to the default output device, such as your terminal. Otherwise, before you call the BUILD service, you must allocate the ddname. The following attributes should be used: RECFM=FBA, LRECL=80, BLKSIZE=3120. The maximum parameter length is 8 characters. This parameter only applies if the project definition requests automatic rebuild when a member is promoted into the 'to group'.

dd_bldlist

This is the ddname indicating the destination of the build listings. If you specify a blank ddname, SCLM does not generate the build listings. Otherwise, before you call the BUILD service, you must allocate the ddname. The following attributes should be used: DISP=MOD, RECFM=VBA, LRECL=137, BLKSIZE=3120. The maximum parameter length is 8 characters. This parameter only applies if the project definition requests automatic rebuild when a member is promoted into the 'to group'.

dd_bldexit

This is the ddname indicating the destination of the build user exit data. Specify this parameter only if your project definition defines a build user exit routine. Ask your project manager if your project is using a build user exit routine. If you specify a blank ddname, SCLM routes the build user exit data to NULLFILE. Otherwise, before you call the BUILD service you must allocate the ddname. The following attributes should be used: RECFM=FB, LRECL=160, BLKSIZE=3200. The maximum parameter length is 8 characters. This parameter only applies if the project definition requests automatic rebuild when a member is promoted into the 'to group'.

Return codes

Additional special services messages are written to the FLMMSGS ddname. See SCLM service messages for more information.

Other return codes might be produced by the FLMCMD or the FLMLNK processor. See SCLM service return codes for more information.

Example of command invocation

FLMCMD PROMOTE,PROJ1,,USER1,ARCHDEF,FLM01CMD,,,U

This service command promotes the FLM01CMD member of the ARCHDEF type and all of its dependent members from the USER1 group to the next group in the hierarchy. The project name is PROJ1. The promote scope is normal (by default) and the promote mode is unconditional. SCLM sends messages, reports, and listings to the terminal.