You are here: Available Utilities > L > LBYPROC > Filtering Resources

Filtering Resources

The LBYPROC utility lets you filter lists of resources so you can select only the resources you want to work with. This table defines the XML tags used in the following example and in the Filter section of Promoting Resources: Example 4.

XML tag

Description

LIBRARY

Enter the name of the library that contains the resources you want to include. Here is an example:

<LIBRARY VALUE="DEFLIB\MASTER.LBY"/>

LO

Use this option if your script contains multiple Filter scripts. The LO tag tells the utility what to do with the matching records for this script.

If you use the Library Search wizard in Documaker Studio to create the library script, it automatically sets the LO option to the appropriate value.

The possible values are:

0 - Replace all current results with matching records.

1 - Search within current results only.

2 - Add matching records to current results.

3 - Remove matching records from current results.

NAME

Enter the name of the file you want to include, without the extension or path. You can include asterisks (*) as wildcards.

The default is "", which tells the utility to select all files in the source library.

DESC

Enter a description assigned to the resources you want to include. Here is an example

<DESC VALUE="Added using LBYPROC"/>

TYPE

 

Enter the file extension, such as FAPThis lets you promote only specific types of files, like FAP files or LOG files.

The default is "", which tells the utility to select all types of files in the source library.

VERSION

You can enter the version number, such as 00001, or you can set this tag to (last) to indicate you only want to include the latest version of each resource to disk.

The default is "", which tells the utility to select all versions in the source library.

REVISION

You can enter a revision number, such as 00001, or you can set this tag to (last) to indicate you only want to include the latest revision of each resource to disk.

The default is "", which tells the utility to select all revisions in the source library.

USERID

Enter a specific user ID or enter "" for any user ID. This lets you promote include resources assigned to a specific user.

EFFDATE

Enter the effective date of the resources you want to include.

Here is an example which shows an effective date of January 1, 2011

<EFFDATE VALUE="20110101"/>

LOCKED

Enter No if you do not want to include locked resources. Enter Yes if you want to promote only locked resources. The default is "", which tells the utility to promote both locked and unlocked resources.

MODE *

This specifies the mode value the source library resources must have to be included in the operation. The default is "", which tells the utility to select all modes in the source library.

Here is an example:

<MODE VALUE="DEVELOPMENT"/>

STATUS *

This specifies the status value the source library resources must have to be included in the operation. The default is "", which tells the utility to select all statuses in the source library.

Here is an example:

<STATUS VALUE="PROMOTED"/>

CLASS *

This specifies the class value the source library resources must have to be included in the operation. The default is "", which tells the utility to select all classes in the source library. Here is an example:

<CLASS VALUE="GA"/>

PROJECT *

This specifies the project value the source library resources must have to be included in the operation. The default is "", which tells the utility to select all projects in the source library. Here is an example:

<PROJECT VALUE="PROJECT1"/>

OBJECTTYPE

 

Enter an object type or enter "" for any type of object. Here is an example:

<OBJECTTYPE VALUE="TEXT"/>

OBJECTNAME

 

Enter the name of the resource or enter "" for any resource. Here is an example:

<OBJECTNAME VALUE=""/>

OBJECTTEXT

 

Enter the text contained in the resource to filter on or enter "" for any text. Here is an example:

<OBJECTTYPE VALUE="TEXT"/>

<OBJECTTEXT VALUE="POLICY"/>

This tells the utility to filter for text objects that contain the word POLICY.

OBJECTTEXTCASE

 

Enter the case of the text in the resource you want to filter on or enter ""for any case. Here is an example:

<OBJECTTEXTCASE VALUE="UPPERCASE"/>

* You define modes, statuses, classes, and projects when you check in a resource using Documaker Studio. See the Documaker Studio User Guide for more information.

See Filtering Resources Example of how you can filter resources.