BUILD—Build a Member

The BUILD service compiles, links, and integrates software components according to a project's architecture definition. Before a member is built, the member's dependency information must exist in the project database. For this reason, either the STORE or SAVE service must complete successfully for the member before you call the BUILD service.

Command invocation format


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

                            .-N-.    .-C-.    .-Y-.    .-Y-.   
>--,member--,-+--------+--,-+---+--,-+---+--,-+---+--,-+---+---->
              '-userid-'    +-E-+    +-F-+    '-N-'    '-N-'   
                            +-L-+    +-R-+                     
                            '-S-'    +-U-+                     
                                     '-I-'                     

>--,-+---------------+--,-+------------+--,-+------------+------>
     '-prefix_userid-'    '-dd_bldmsgs-'    '-dd_bldrept-'   

>--,-+------------+--,-+------------+--------------------------><
     '-dd_bldlist-'    '-dd_bldexit-'

Call invocation format


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

>--,member--,-+-userid-+--,-+-E-+--,-+-C-+--,-+-Y-+--,-+-Y-+---->
              '-'--'---'    +-L-+    +-F-+    '-N-'    '-N-'   
                            +-N-+    +-R-+                     
                            '-S-'    +-U-+                     
                                     '-I-'                     

>--,-+---------------+------------------------------------------>
     +-prefix_userid-+   
     '-'--'----------'   

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

ISPF interface panel

Figure 1. BUILD Service panel

   Menu  SCLM  Utilities  Options  Help
 ──────────────────────────────────────────────────────────────────────────────
                  SCLM FLMCMD BUILD Service - Entry Panel
Command ===>

SCLM Library:
   Project . . . SCLMTEST
   Alternate . .         
   Group . . . . DEV1    
   Type  . . . . SOURCE  
   Member  . . .         

Enter "/" to select option
/  Error listings only
/  Create build report

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

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

DD Names for output data sets:
   Messages  . .           (Blank to write messages to the terminal)
   Report  . . .           (Blank to write report to the terminal)
   Listings  . .           (Blank to write list to the terminal)
   Exit  . . . .           (Blank if no exit or no output required)

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 used for the build. It defaults to the project parameter. 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 SCLM ID is generated by the INIT service. The maximum parameter length is 8 characters. This parameter is used for FLMLNK only.
group: The group in which the build occurs. The maximum parameter length is 8 characters.
type: The type containing the member to be built. The maximum parameter length is 8 characters.
member: The member to be built. The maximum parameter length is 8 characters.
userid: The user ID of the person requesting the build. 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|L|N|S: Indicates the build scope (E=extended, L=limited, N=normal, S=subunit). For the FLMCMD interface, the default is N. There is no default for FLMLNK. The maximum parameter length is 24 characters.
C|F|R|U|I: Indicates the build mode (C=conditional, F=forced, R=report, U=unconditional, I=Information). For FLMCMD, the default is C. There is no default for FLMLNK. The maximum parameter length is 24 characters.
Y|N: Y indicates that 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.
Y|N: Y indicates that a build report is to be produced and routed to the dd_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.
prefix_userid: 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.
dd_bldmsgs: 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. The maximum parameter length is 8 characters.
dd_bldrept: 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.
dd_bldlist: 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.
dd_bldexit: 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.

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.

Possible return codes are:

0: Normal completion. See the SCLM messages for more information.
4: Warning condition. See the SCLM messages for more information.
8: Error condition. See the SCLM messages for more information.
12: Severe error condition. SCLM does not produce messages because there was an error invoking the build module.
16: Severe error condition. SCLM does not produce messages because it was unable to retrieve SCLM ID information.

Example of command invocation

FLMCMD BUILD,PROJ1,,USER1,ARCHDEF,FLM01CMD,,,U,,N

This service command builds the FLM01CMD member of the ARCHDEF type in the USER1 group. The project name is PROJ1. The build mode is unconditional and SCLM does not generate a build report. SCLM sends messages and listings to the terminal. All other parameters are defaults.

Example of call invocation

This example shows general syntax. Call invocations are language-specific. See Sample programs using SCLM services for specific examples.

lastrc := FLMLNK('BUILD   ',                      (* service               *)
                 sclm_id,                         (* SCLM ID               *)
                 'USER1   ',                      (* group                 *)
                 'ARCHDEF ',                      (* type                  *)
                 'FLM01CMD',                      (* member                *)
                 '        ',                      (* user ID               *)
                 'N                       ',      (* scope                 *)
                 'F                       ',      (* mode                  *)
                 'N                       ',      (* listings              *)
                 'Y                       ',      (* report                *)
                 'PROJECT.WORKFILE ',         (* temp high-level qualifier *)
                 'BLDMSGS ',                      (* dest. of messages     *)
                 'BLDREPT ',                      (* dest. of report       *)
                 'BLDLIST ',                      (* dest. of listings     *)
                 'BLDEXIT ');                     (* exit routine          *)

The service call builds the FLM01CMD member of the ARCHDEF type in the USER1 group. The sclm_id parameter contains a valid SCLM ID returned from the INIT service. The build scope is normal and the build mode is forced. SCLM copies all build listings to the build listings data set and generates a build report. All temporary data sets are allocated with the high-level qualifier of PROJECT.WORKFILE. The ddnames for the messages, report, listings, and user exit data set (BLDMSGS, BLDREPT, BLDLIST, and BLDEXIT, respectively) must be allocated before calling FLMLNK.