Use the Dependency Based Build (DBB) User Build wizard to configure and start a user
build operation.
About this task
A user build is a build operation that runs a DBB script to build a single source file in a
local z/OS project. Restriction: User build does not work with refactored COBOL source
files.
Procedure
To configure and start a user build:
-
From the Remote Systems view, connect to the remote system.
-
In a local z/OS project that is enabled for DBB, right-click the file to be built and then
select .
The Dependency Based Build User Build wizard
opens to guide you through the process of constructing a user build.
-
After completing each page, click Finish to start the user build.
See the following page descriptions for information about each user build option:
- Configure User Build Operation
- Choose the build script to run and the target remote system for the user build operation.
Select the z/OS system to use: Select the remote system to be used by
Dependency Based Build (DBB). The remote system must have DBB installed and configured. If you are
unsure which remote system to use, ask your system or build administrator.
Select the build script to use: Enter the build script used by DBB. Click
Browse to select a build script from the local workspace or the remote
system. Consult your system or build administrator for the script name.
Enter the build sandbox folder: Specify the directory on the remote system
that is used by DBB for builds. A sandbox folder is a location where build source files are uploaded
and build output files are created during user builds. Click Browse to find
or add a directory on the z/OS UNIX System Services file system.
Enter the build destination HLQ: Specify the high-level qualifier for
build output files on the remote system.
Use this configuration as the project default: Select the check box if you
want to save and apply the configuration as the project default.
- File Attributes
- Choose how the user build operation obtains information about the files to be transferred to the
remote system for the build.
Use project traversal to compose attributes: Git computes the attributes
by traversing the version history of the files in the project.
Use the project attribute file: Git uses the project's
.gitattributes file to gather file attribute information.
Use a selected attribute file: To use a specified attribute file, click
Browse and navigate to the file location.
Do not use an attributes file: No file attribute information is used for
the build operation.
Important: The attribute file must have the format defined by Rocket Software, such as
*.cbl working-tree-encoding=ibm-1047 git-encoding=utf-8
. In z/OS projects, the
working-tree-encoding
attribute has the format
zos-working-tree-encoding
. IBM® Developer for z/OS® uses the
zos-working-tree-encoding to differentiate between Git and Rocket Git. Git itself uses
working-tree-encoding
, which EGit tries to interpret.
- Log File
- Set the log file name and location for the user build operation.
Choose one of these options:
Member name based: This option constructs the log file name from the
member name on which the build operation is run and using the options you specify in the
Prefix, Suffix, File extension,
and Member name modifiers fields.
Other: Specify a log file name in the text field.
No log file: No log file is used for the build operation.
Enter the log file location: Click Browse to
navigate to the location where the log file is stored after the build completes.
- Script Parameters
- Specify additional parameters for the build script command.
Create the Dependency Based Build command: Add, edit, remove, and arrange
the order for the parameters in the table that are used in the script command, including some
default parameters that are generated from settings you defined in the
Configure User
Build wizard:
- --sourceDir: The build sandbox folder on the remote system. The folder
name is specified on page 1 of the wizard.
- --workDir: The location of the remote log file on the remote system. The
folder name is specified on the Configure User Build Operation Log File page of
the wizard.
- --hlq: The high-level qualifier for the build output files on the remote
system. The high-level qualifier is specified on page 1 of the wizard.
You can add the
--dependencyFile parameter to pass discovered
dependencies to zAppBuild DBB. If you add this parameter, also use the
${dependencyFile}
variable to generate a
.userbuilddependencies file on the host to contain the dependencies that were
discovered on the client. The combination of the
--dependencyFile parameter
and the
${dependencyFile}
variable provides a script command parameter
--dependencyFile .userbuilddependencies
. Without this script command parameter,
discovery of dependencies occurs during the DBB build on the host.
Note: If you are using IBM Developer for z/OS version 15.0.4 or
later, you must also use zAppbuild version 2.2.1 or later on the host. Beginning with version
15.0.4, the --dependencyFile .userbuilddependencies
parameter is not compatible
with zAppBuild version 2.2.0 or earlier.
Groovy parameters: The entry field contains parameters to pass to the
Groovy build script. For more information, see IBM Dependency Based Build
documentation.
Command Preview: Preview the command in the field after you finish editing
and entering the parameters.
- Additional files to load
- Add or remove files from the list of files to upload to the remote system.
Note: If you run a
user build for the DBB sample code, all the build files need to be uploaded at least once. If no
build files are selected, the user build operation uploads all the build scripts.
Discover the dependencies to load for building: Select this option to
cause DBB to search for include files used by the file being built. All files to be included in the
user build operation are identified by the language editors. Ensure that the source file has been
opened in an editor before the user build is run so that dependencies can be detected. Discover
dependencies supports Enterprise COBOL copybooks and Enterprise PL/I include files. Discover
dependencies for files that are not in the same Git repository are uploaded but not used.
Note: You
might want to include other dependencies in these circumstances:
- The dependencies have not been changed locally.
- The dependencies have been populated on the host by a team build. In this case, you need to
specify the Team build HLQ in the Create the Dependency Based Build
command table.
Show file transfer information: Select this option to add the file
transfer information, binary or text, to the items that are selected in the files view. The
information is also available in the user build summary page.
Preferences: Click this link to open the Dependency Based Build
Preferences page.
- Summary
- Verify the user build settings and submit the build.
Results
- The selected files are uploaded to the build sandbox folder on z/OS UNIX System Services. The DBB working folder is created directly under the build sandbox
folder and is named work.
- The chosen build script is started with the parameters set in the wizard and in the
preferences.
- The output of the DBB build scripts is written to the DBB Console.
- The log file is generated by the build in the location you specified.
- To see the build results in the Completion window, click
Details.
- You can also check for build errors in the Remote Error List view, which is
available if you enabled error feedback in the Preferences page or the property
group.