Preface
Introduction to PowerExchange Utilities
- PowerExchange Utilities Overview
- PowerExchange Utilities by Operating System
- PowerExchange Utilities Syntax Conventions
- Environment Variable Incompatibilities Between PowerExchange and PowerCenter
  - Setting the PowerExchange Environment and Starting a Utility
- PowerExchange Sample JCL
createdatamaps - Data Map Creation Utility
- createdatamaps Utility Overview
- Requirements and Considerations for COBOL Copybooks and DBDs
- createdatamaps Command Syntax
- Creating, Editing, and Testing a Data Map
- Control Files for Data Map Generation
  - Rules for Control Files
  - Control File Structure
- Schema File for Describing Control Files
- Schema File Reference
- Log File for Data Maps Creation Utility
  - JAXB Error Messages
- Redefinitions and Record IDs in COBOL Copybooks
- Copybook and DBD Metadata for IMS Data Maps
- Column Name Filters
- Unavailable Data Map Properties
- Examples
DTLCCADW - Adabas PCAT Utility
- DTLCCADW Utility Overview
- DTLCCADW Utility Functions
DTLCUIML - IMS Log Marker Utility
- DTLCUIML Utility Overview
- DTLCUIML Utility Parameters
- DTLCUIML Utility Reports
DTLINFO - Release Information Utility
- DTLINFO Utility Overview
- Supported Operating Systems for the DTLINFO Utility
- Control Statement Syntax for the DTLINFO Utility
- Control Statement Parameters for the DTLINFO Utility
- Running the DTLINFO Utility on i5/OS
- Running the DTLINFO Utility on Linux, UNIX, and Windows
- Running the DTLINFO Utility on z/OS
- DTLINFO Utility on i5/OS Examples
  - DTLINFO Utility on i5/OS - Example 1
  - DTLINFO Utility on i5/OS - Example 2
- DTLINFO Utility on Linux, UNIX, and Windows Examples
  - DTLINFO Utility on Linux, UNIX, and Windows - Example 1
  - DTLINFO Utility on Linux, UNIX, and Windows - Example 2
- DTLINFO Utility on z/OS Examples
  - DTLINFO Utility on z/OS - Example 1
  - DTLINFO Utility on z/OS - Example 2
DTLINFOX - Enhanced Release Information Utility
- DTLINFOX Utility Overview
- Supported Operating Systems for the DTLINFOX Utility
- Control Statement Syntax for the DTLINFOX Utility
- DTLINFOX Utility Parameters
- Running the DTLINFOX Utility
- Reporting on Remote Programs by Using a PowerExchange Listener Task
- DTLINFOX Utility Examples
DTLREXE - Remote Execution Utility
- DTLREXE Utility Overview
- Supported Operating Systems for the DTLREXE Utility
- Control Statement Syntax for the DTLREXE Utility
- Control Statement Parameters for the DTLREXE Utility
- Running the DTLREXE Utility on i5/OS
- Running the DTLREXE Utility on Linux and UNIX
- Running the DTLREXE Utility on Windows
- Running the DTLREXE Utility on z/OS
- DTLREXE Utility Usage Notes
- DTLREXE Utility on z/OS Example
  - DTLREXE Utility on z/OS Example JCL
  - DTLREXE Utility on z/OS Output Data Set
DTLUAPPL - Restart Token Utility
- DTLUAPPL Utility Overview
- Supported Operating Systems for the DTLUAPPL Utility
- DTLUAPPL Control Statement Syntax
- Connection Statement
- ADD and MOD Statements
- END APPL Statement
- PRINT APPL Statement
- Running the DTLUAPPL Utility on i5/OS
- Running the DTLUAPPL Utility on Linux, UNIX, and Windows
- Running the DTLUAPPL Utility on z/OS
- DTLUAPPL Utility Examples
DTLUCBRG - Batch Registration Utility
- DTLUCBRG Utility Overview
- Supported Operating Systems for the DTLUCBRG Utility
- DTLUCBRG Utility Parameters
- DTLUCBRG Code Page Processing
  - Code Page Processing for DB2 Registrations in Local Mode on z/OS
- Running the DTLUCBRG Utility
- DTLUCBRG Utility Example Reports
  - DTLUCBRG Utility with RPTCOLS=N Report Description
  - DTLUCBRG Utility with RPTCOLS=Y Report Description
- DTLUCBRG Utility Usage Notes
DTLUCDEP - CDEP Maintenance Utility
- DTLUCDEP Utility Overview
- Supported Operating Systems for the DTLUCDEP Utility
- Control Statement Syntax for the DTLUCDEP Utility
- Control Statement Parameters for the DTLUCDEP Utility
  - CDEP Definition Examples
- Running the DTLUCDEP Utility on i5/OS
- Running the DTLUCDEP Utility on Linux, UNIX, and Windows
- Running the DTLUCDEP Utility on z/OS
- DTLUCDEP Utility on i5/OS Example
- DTLUCDEP Utility on Linux, UNIX, and Windows Example
- DTLUCDEP Utility on z/OS Example
DTLUCSR2 - IDMS SR2 and SR3 Records Utility
- DTLUCSR2 Utility Overview
- Running the DTLUCSR2 Utility
DTLUCUDB - DB2 for Linux, UNIX, and Windows CDC Utility
- DTLUCUDB Utility Overview
- Running the DTLUCUDB Utility
  - DTLUCUDB Utility Syntax
  - Command Options for the DTLUCUDB Utility
- Gathering Diagnostic Information to Resolve a DB2 Capture Problem
DTLULCAT and DTLULOGC - IDMS Log Catalog Utilities
- DTLULCAT and DTLULOGC Utilities Overview
- Running the DTLULCAT Utility
- Running the DTLULOGC Utility
- Manually Manipulating the Log Catalog
- Guidelines for Adding Logs to the Catalog with the DTLULCAT and DTLULOGC Utilities
DTLURDMO - Data Map Utility
- DTLURDMO Utility Overview
- Supported Operating Systems for the DTLURDMO Utility
- Control Statement Overview for the DTLURDMO Utility
- Control Statement Syntax for the DTLURDMO Utility
- Control Statements and Parameters for the DTLURDMO Utility
- Scope of Operands
- Running the DTLURDMO Utility on i5/OS
- Running the DTLURDMO Utility on Linux, UNIX, and Windows
- Running the DTLURDMO Utility on z/OS
- DTLURDMO Control Statement Examples
- DTLURDMO Report Examples
DTLUTSK - Task Control Utility
- DTLUTSK Utility Overview
- DTLUTSK Command Line Utility on i5/OS
- DTLUTSK Command Line Utility on Linux, UNIX, and Windows
  - Displaying DTLUTSK Utility Help
- DTLUTSK Job on z/OS
  - Example JCL for a DTLUTSK Job on z/OS
  - Example Output from a DTLUTSK Job on z/OS
- DTLUTSK Command Line Utility on z/OS
- Running the DTLUTSK Utility in the PowerExchange Navigator
- DTLUTSK Utility Security
EDMLUCTR - Log Scan and Print Utility
- EDMLUCTR Utility Overview
- Supported Operating Systems for the EDMLUCTR Utility
- Control Statement Syntax for the EDMLUCTR Utility
- Control Statement Parameters for the EDMLUCTR Utility
  - -SEL Statement
  - -MASK Statement
- Running the EDMLUCTR Utility
- EDMLUCTR Utility Usage Notes
- EDMLUCTR Utility Examples
EDMUOPTS - Service Aid Utility
- EDMUOPTS Utility Overview
- Supported Operating System for the EDMUOPTS Utility
- EDMUOPTS Utility Reports
- Running the EDMUOPTS Utility
  - EDMUOPTS Utility Example JCL
  - Example EDMSDIR and EDMUPARM Reports
EDMXLUTL - Event Marker Utility
- EDMXLUTL Utility Overview
- Creating an Event Marker in Batch Mode
- EDMXLUTL Utility JCL Statements
- EDMXLUTL Utility Control Statements
- EDMXLUTL Utility EVENT Command
  - EVENT Command Syntax
  - EVENT Command Usage
- Keyword Sets for the BASEEDM Category
  - MARK Keyword Set
  - NOTIFY Keyword Set
- EDMXLUTL Utility Example
HOSTENT - TCP/IP Address Reporter Utility
- HOSTENT Utility Overview
- Supported Operating Systems for the HOSTENT Utility
- Running the HOSTENT Utility on i5/OS
- Running the HOSTENT Utility on Linux and UNIX
- Running the HOSTENT Utility on z/OS
- HOSTENT Utility Usage Notes
  - HOSTENT Utility Resolver Details
- HOSTENT Utility Output
- HOSTENT Utility on i5/OS Example
- HOSTENT Utility on Linux and UNIX Example
- HOSTENT Utility on z/OS Example
PWXCATMY - MySQL Catalog Utility
- PWXCATMY Utility Overview
- Supported Operating Systems for the PWXCATMY Utility
- PWXCATMY Operation Types
- Command Syntax and Parameters
PWXUCCLPRT - Print Log Summary Utility
- PWXUCCLPRT Utility Overview
- Supported Operating Systems for the PWXUCCLPRT Utility
- Command Syntax for the PWXUCCLPRT Utility
- PWXUCCLPRT Utility Parameters
  - PWXUCCLPRT INPUT Statement Parameters
  - PWXUCCLPRT OUTPUT Statement Parameters
- Example PWXUCCLPRT Parameter File
- Examples of PWXUCCLPRT Output
PWXUCDCT - Logger for Linux, UNIX, and Windows Utility
- PWXUCDCT Utility Overview
- Supported Operating Systems for the PWXUCDCT Utility
- Control Statement Syntax for PWXUCDCT Commands
- PWXUCDCT Commands and Parameters
  - Commands
  - Parameter Descriptions
- Running the PWXUCDCT Utility
- Usage Notes for the PWXUCDCT Utility
- Examples of PWXUCDCT Utility Commands
PWXUCREG - Capture Registration Utility
- PWXUCREG Utility Overview
- Supported Operating Systems for the PWXUCREG Utility
- Registration Statuses
- Deleting Registrations That Are No Longer Active
- Displaying Registration Summary Information
- Suspending Change Data Capture by z/OS ECCRs
  - PWXUCREG Usage Considerations
  - Suspending Change Capture for Registered Sources Temporarily
- General Syntax for PWXUCREG Commands
- PWXUCREG Commands and Parameters
- Running the PWXUCREG Utility
- Examples of PWXUCREG Utility Commands
PWXUMAP - Map List Utility
- PWXUMAP Utility Overview
- Supported Operating Systems for the PWXUMAP Utility
- General Syntax for the PWXUMAP Utility
- PWXUMAP Commands and Parameters
- Running the PWXUMAP Utility
- Examples of PWXUMAP Reports
- PWXUMAP Utility Usage Notes
PWXUCRGP - Capture Registrations Print Utility
- PWXUCRGP Utility Overview
- Supported Operating Systems for the PWXUCRGP Utility
- Control Statement Syntax for the PWXUCRGP Utility
- PWXUCRGP Parameters
- Running the PWXUCRGP Utility
- PWXUCRGP Report Levels of Detail
- Examples of PWXUCRGP Reports
PWXUDMX - Data Maps Update Time ECSA Memory Utility
- PWXUDMX Utility Overview
- Supported Operating Systems for the PWXUDMX Utility
- Running the PWXUDMX Utility on z/OS
- PWXUDMX Commands and Parameters
PWXUGSK - SSL Reporting Utility
- PWXUGSK Utility Overview
- Supported Operating Systems for the PWXUGSK Utility
- PWXUGSK Control Statement Syntax
- PWXUGSK Commands and Parameters for IBM i
- PWXUGSK Commands and Parameters for z/OS
- Running the PWXUGSK Utility on IBM i
- Running the PWXUGSK Utility on z/OS
- PWXUGSK Utility Reports
PWXUSSL - PowerExchange SSL Reporting Utility
- PWXUSSL Utility Overview
- Supported Operating Systems for the PWXUSSL Utility
- Control Statement Syntax for PWXUSSL Commands
- PWXUSSL Commands and Parameters
- Running the PWXUSSL Utility
- PWXUSSL Utility Reports
WRKJRNLCKE- Journal Lock Table Utility for IBM i
- WRKJRNLCKE Utility Overview
- Supported Operating Systems for the WRKJRNLCKE Utility
- WRKJRNLCKE Utility Command Syntax
- Running the WRKJRNLCKE Utility on IBM i
- WRKJRNLCKE Usage Considerations
ZOSTOUCH - Set Last Referenced Date Utility for z/OS
- ZOSTOUCH Utility Overview
- Supported Operating Systems for the ZOSTOUCH Utility
- Running the ZOSTOUCH Utility
- ZOSTOUCH Utility Report
  - Example SYSPRINT Output

Utilities Guide

10.5.5
- 10.5.4
- 10.5.3
- 10.5.2
- 10.5.1
- 10.5
- 10.4.1
- 10.4.0 HotFix 1
- 10.4.0

Back Next

DTLDESCRIBE Command

The DTLDESCRIBE command returns CAPXRT or NRDB metadata for the selected schemas or maps. The information can be filtered by access method, schema-name mask, map-name mask, and table-name mask.

Syntax

The command has the following syntax:

PWXUMAP COMMAND=DTLDESCRIBE
TYPE={ALL|CRX|DMX}
OUTPUT_FILE=file_name
LOCATION={node_name|local} 
[UID=user_name]
[PWD=password|EPWD=encrypted_password]  
[AMLIST=access_method_list]
[DESCRIBETYPE=metadata_type]
[MAPMASK=map_mask] 
[NULLLITERAL=literal]
[OVERRIDE_CRX_FILE=extraction_maps_file]
[OVERRIDE_DMX_FILE=data_maps_file]
[RETLOGINFOMSG={Y|N}]
[SCHEMAMASK=schema_mask] 
[TABLEMASK=table_mask] 
[TIMESTAMPS={Y|N}]
[USESEQUENCEFIELDS={Y}N}

Parameters

The following parameters are specific to this command:

DESCRIBETYPE=metadata_type: The metadata to include in the report. Only one option can be specified for the DESCRIBETYPE parameter. Options are:
COLUMNS
. Include column metadata.
CKEYS
. Include foreign-key metadata for IMS sources.
DELEMS
. Include Datacom element metadata for Datacom sources.
FIELDS
. Include field metadata for relational sources.
MAPS
. Include metadata for data maps and extraction maps.
PKEYS
. Include primary-key metadata.
RECORDS
. Include record metadata for nonrelational sources.
SCHEMAS
. Include schema metadata.
TABLES
. Include table metadata
TPATHS
. Include PATH metadata for IDMS sources.

Default is
SCHEMAS
.

The MAPS, SCHEMAS, and TABLES options can run unqualified even when the report includes large numbers of data maps or extraction maps. If you specify other DESCRIBETYPE options, use the MAPMASK, SCHEMAMASK, or TABLEMASK parameters to filter the report results and improve the utility performance.
NULLLITERAL=literal: A value to use to replace any null columns that are included in the report. Options are:
EMPTY
. Set the null literal to an empty string.

string
. Enter a string that replaces the null value. The string can be up to 12 characters long.

Default is no replacement value for null columns.
RETLOGINFOMSG={ Y |N}: Specifies whether to include messages from the map log files in the report. Options are:
Y
. Include logged messages.
N
. Do not include logged messages.

Default is
Y
.
USESEQUENCEFIELDS={Y| N }: Specifies whether to use sequence fields in the source metadata. Set this parameter to
Y
if the data or extraction maps include multiple-record writes to IMS or sequential VSAM sources
Default is
N
.

For descriptions of the global parameters in the syntax, see PWXUMAP Global Parameters.

Rename Saved Search

Table of Contents

Utilities Guide

Utilities Guide

DTLDESCRIBE Command

DTLDESCRIBE Command

Syntax

Parameters