imsclean

Description

Cleans all the IMS build artefacts generated by the ims task.

Parameters

Attribute	Description	Required
configuration	The name of the build configuration.	No
destdir	The name of the directory where the generated IMS build artefact(s) to be cleaned are located.	No
failonerror	If true, stops the build process if the task exits with a return-code other than 0. Defaults to false.	No
genfiledir	The name of the directory where the generated file(s) that are to be cleaned are located.	No
gentype	The type of generated files to clean. The value of this attribute must be one of "dbd", "mfs" or "psb".	Yes
removegeneratedfiles	If true, removes ".DAT" files generated by the ims task that are located in the directory genfiledir and are of type gentype. Defaults to false.	No
verbose	If true, causes additional informational messages to be displayed by the task. Defaults to false.	No

Parameters specified as nested elements

mfdirlist: Use nested <mfdirlist> elements to specify directives to be used to compile the program(s). See mfdirlist.
fileset: Use nested <fileset> elements to specify the source file name(s) whose artefacts should be cleaned.
mffilelist: Use nested <mffilelist> elements to specify the source file name(s). See mffilelist.
mfdestfilelist: Use nested <mfdestfilelist> elements to specify any additional build artefact(s) that need to be cleaned. See mfdestfilelist.

Errors and return codes

By default, the return code of an <imsclean> task is ignored. When you set failonerror="true", any non-zero response is treated as an error and means the build exits.

Examples

Remove all IMS build artefacts of type dbd for a referenced mffilelist element using the directives in a referenced mfdirlist element:

<mfdirlist id="dbd_directive_set_1">
    <directive name="LIST" value="Listing/DBD/*.lst"/>
</mfdirlist>

<mffilelist id="dbd_file_set_1" srcdir="${basedir}" type="srcfile">
    <file name="DEMO01.dbd"/>
</mffilelist>

<mffilelist id="imscpy.locations">
    <path type="imscpy" name="${basedir}/imscpybooks"/>
</mffilelist>

<imsclean destdir="${basedir}" removegeneratedfiles="false" verbose="false" failonerror="true" genfiledir="${basedir}" gentype="dbd">
    <mfdirlist refid="dbd_directive_set_1"/>
    <mffilelist refid="imscpy.locations"/>
    <mffilelist refid="dbd_file_set_1"/>
</imsclean>

Remove all IMS build artefacts of type psb for a referenced mffilelist element using the directives in a referenced mfdirlist element:

<mfdirlist id="psb_directive_set_1">
    <directive name="LIST" value="Listing/PSB/*.lst"/>
</mfdirlist>

<mffilelist id="psb_file_set_1" srcdir="${basedir}" type="srcfile">
    <file name="DEMO02.psb"/>
</mffilelist>

<mffilelist id="imscpy.locations">
    <path type="imscpy" name="${basedir}/imscpybooks"/>
</mffilelist>

<imsclean destdir="${basedir}" removegeneratedfiles="false" verbose="false" failonerror="true" genfiledir="${basedir}" gentype="psb">
    <mfdirlist refid="psb_directive_set_1"/>
    <mffilelist refid="imscpy.locations"/>
    <mffilelist refid="psb_file_set_1"/>
</imsclean>

Remove all IMS build artefacts of type mfs for a referenced mffilelist element using the directives in a referenced mfdirlist element:

<mfdirlist id="mfs_directive_set_1">
    <directive name="LIST" value="Listing/MFS/*.lst"/>
</mfdirlist>

<mffilelist id="mfs_file_set_1" srcdir="${basedir}" type="srcfile">
    <file name="DEMO03.mfs"/>
</mffilelist>

<mffilelist id="imscpy.locations">
    <path type="imscpy" name="${basedir}/imscpybooks"/>
</mffilelist>

<imsclean destdir="${basedir}" removegeneratedfiles="false" verbose="false" failonerror="true" genfiledir="${basedir}" gentype="mfs">
    <mfdirlist refid="mfs_directive_set_1"/>
    <mffilelist refid="imscpy.locations"/>
    <mffilelist refid="mfs_file_set_1"/>
</imsclean>

Remove additional IMS build artefacts using a nested mfdestfilelist element:

<imsclean destdir="${basedir}" verbose="false" failonerror="true" genfiledir="${basedir}" gentype="dbd">
    <mfdestfilelist>
        <file name="${basedir}/DBDGEN01.dat"/>
        <file name="${basedir}/DBDGEN02.dat"/>
        <file name="${basedir}/IMSCONFIG.dat"/>
    </mfdestfilelist>
</imsclean>