Command Reference > pmrep Command Reference > ListObjects
  

ListObjects

Returns a list of objects in the repository. When you list objects, pmrep returns object metadata. Use the following list operations:
Use ListObjects in a shell script to return the object metadata, parse the metadata, and then use the parsed data in another pmrep command.
For example, use ListObjects to list all Sequence Generator transformations in the repository. Create a shell script that uses ListObjects to return Sequence Generator transformation information, parse the data ListObjects returns, and use UpdateSeqGenVals to update the sequence values.
pmrep returns each object in a record and returns the metadata of each object in a column. It separates records by a new line by default. You can enter the characters to use to separate records and columns. You can also enter the characters to indicate the end of the listing.
The ListObjects command uses the following syntax:
listobjects

-o <object_type>

[-t <object_subtype>]

[-f <folder_name>]

[-c <column_separator>]

[-r <end-of-record_indicator>]

[-l <end-of-listing_indicator>]

[-b (verbose)]

[-y (print database type)]

[-s <dbd_separator>]
The following table describes pmrep ListObjects options and arguments:
Option
Argument
Description
-o
object_type
Required. Type of object to list.
  • - When you enter folder, you do not need to include any other option. pmrep ignores the -t and -f options.
  • - When you enter objects other than folders, you must include the -f option.
  • - When you enter transformation or task, you must include the -f option, and you can optionally include the -t option.
For more information about object types to use with ListObjects, see Listing Object Types.
-t
object_subtype
Optional. Type of transformation or task to list. When you enter transformation or task for the object type, you can include this option to return a specific type.
For more information about object types to use with ListObjects, see Listing Object Types.
-f
folder_name
Required if you list objects other than folders. Folder to search. Use this option for all object types except deployment group, folder, label, and query.
-c
column_separator
Optional. Character or set of characters used to separate object metadata columns. Use a character or set of characters that is not used in repository object names. If any repository object name contains spaces, you might want to avoid using a space as a column separator.
If you omit this option, pmrep uses a single space.
-r
end-of-record_indicator
Optional. Character or set of characters used to specify the end of the object metadata. Use a character or set of characters that is not used in repository object names.
Default is newline /n.
-l
end_of_listing_indicator
Optional. Character or set of characters used to specify the end of the object list. Enter a character or set of characters that is not used in repository object names.
If you omit this option, pmrep uses a period.
-b
-
Optional. Verbose. Display more than the minimum information about the objects. If you omit this option, you display a shorter format including the object type, the word reusable or non-reusable, the object name and path. Verbose format includes the object status, version number, folder name, and checked out information.
The short format for global objects, such as label, query, deployment group, and connection, includes the object type and object name. Verbose format includes the label type, query type, deployment group type, creator name, and creation time.
-y
-
Optional. Displays the database type of sources and targets.
-s
dbd_separator
Optional. If an ODBC source has a period (.) in the name, define a different separator character when you define the source object. For example, instead of database_name.source_name, define the source object as database_name\source_name, and define the dbd_separator as backslash (\).

Listing Object Types

Use the object_type option to define the objects you want to list. The command lists the latest versions or checked out versions of objects, including shortcuts, but excluding objects according to the rules for object types.
The following table describes the object types and rules you use with ListObjects:
Object Type
Rule
Deploymentgroup
List deployment groups in the repository.
Folder
List folders in the repository.
Label
List labels in the repository.
Mapplet
List mapplets with latest or checked out version in a folder, including shortcuts but excluding instances of reusable mapplets.
Mapping
List mappings with latest or checked out version in a folder, including shortcuts but excluding instances of reusable mapplets.
Query
List queries in the repository.
Scheduler
List reusable and non-reusable schedulers with latest or checked out version in a folder.
Session
List reusable and non-reusable sessions with latest or checked out version in a folder, excluding instances of reusable sessions.
Sessionconfig
List the session configurations with latest or checked out version in a folder.
Source
List sources with latest or checked out version in a folder, including shortcuts but excluding source instances.
Target
List targets with latest or checked out version in a folder, including shortcuts but excluding target instances.
Task
List reusable and non-reusable tasks with latest or checked out version in a folder.
Transformation
List reusable and non-reusable transformations with latest or checked out version in a folder, including shortcuts and excluding instances of reusable transformations.
“User Defined Function”
List user-defined functions in the repository.
Workflow
List the workflows with latest version or checked out version in a folder.
Worklet
List reusable and non-reusable worklets with latest version or checked out version in a folder, excluding instances of reusable worklets.
The following table describes the object types and values to use with pmrep commands:
Object Type
Subtype Value
Description
Query
personal
Personal
Query
shared
Shared
Task
assignment
Assignment
Task
command
Command
Task
control
Control
Task
decision
Decision
Task
email
Email
Task
event_raise
Event-raise
Task
event_wait
Event-wait
Task
start
Start
Task
timer
Timer
Transformation
aggregator
Aggregator
Transformation
application_source_qualifier
Application Source Qualifier
Transformation
app_multi-group_source_qualifier
Application Multi-Group Source Qualifier
Transformation
custom_transformation
Custom
Transformation
custom_transformation
HTTP
Transformation
custom_transformation
SQL
Transformation
custom_transformation
Union
Transformation
custom_transformation
XML Generator
Transformation
custom_transformation
XML Parser
Transformation
expression
Expression
Transformation
external_procedure
External Procedure
Transformation
filter
Filter
Transformation
input_transformation
Input
Transformation
java
Java
Transformation
joiner
Joiner
Transformation
lookup_procedure
Lookup
Transformation
mq_source_qualifier
MQ Source Qualifier
Transformation
normalizer
Normalizer
Transformation
output_transformation
Output
Transformation
rank
Rank
Transformation
router
Router
Transformation
sequence
Sequence Generator
Transformation
sorter
Sorter
Transformation
source_qualifier
Source Qualifier
Transformation
stored_procedure
Stored Procedure
Transformation
transaction_control
Transaction Control
Transformation
update_strategy
Update Strategy
Transformation
xml_source_qualifier
XML Source Qualifier

Listing Folders

Use ListObjects to return each folder in the repository. When you enter folder for the object type, pmrep ignores the subtype and folder name.
For example, to list all folders in the repository, use the following syntax:
listobjects -o folder
Alternatively, you can enter a different column separator and end of listing indicator:
ListObjects -o folder -c “**” -l #

Listing Objects

Use ListObjects to list reusable and non-reusable objects in the repository or in a folder. pmrep does not include instances of reusable objects. When you list objects, you must include the folder name for all objects that are associated with a folder.
pmrep returns the name of the object with the path when applicable. For example, when a transformation is in a mapping or mapplet, pmrep returns mapping_name.transformation_name or mapplet_name.transformation_name.
For more information about a list of transformation or task return values, see Listing Object Types.
For example, to list all transformation types in a folder, enter the following text at the prompt:
listobjects -o transformation -f myfolder
pmrep returns the following information:
stored_procedure reusable sp_sproc1
expression reusable exp1
stored_procedure non-reusable mapping1.sp_nsproc
sequence non-reusable smallmapplet.seqgen_empid
.listobjects completed successfully.
To list all Stored Procedure transformations in a folder, enter the following text at the prompt:
listobjects -o transformation -t stored_procedure -f myfolder
pmrep returns the following information:
stored_procedure reusable sp_sproc1
stored_procedure non-reusable mapping1.sp_nsproc
.listobjects completed successfully.
To list all sessions in a folder, enter the following text at the prompt:
listobjects -o session -f myfolder
pmrep returns the following information:
session reusable s_sales_by_CUSTID
session non-reusable wf_sales.s_sales_Q3
session non-reusable wf_orders.wl_shirt_orders.s_shirt_orders
.listobjects completed successfully.