User-Written Edit Modules › Overview

Overview

Definition

A user-written edit module is a program module that can be used to supplement or replace automatic editing and error handling on mapin and/or mapout. A user-written edit module should be used only when it performs an operation that is not available through the automatic editing and error handling features that the CA IDMS mapping facility provides.

Steps

The following steps are involved in writing and using a user-written edit module:

1. Planning and coding the module
2. Preprocessing, compiling, and link editing the module
3. Specifying the module for use by the CA IDMS mapping facility

Specifying an Existing Module

An existing module is specified for use during runtime mapping by using either the online compiler or the batch compiler of the CA IDMS mapping facility:

• The online mapping compiler User-Defined Edit Module screen can be used to specify a user-written edit module, as explained in the documentation of that screen in "Batch Compiler Statements".
• The batch compiler MFLD (for MAP AUTOPANEL) and MFLD statements can be used to specify a user-written edit module, as explained in the documentation of either statement in “Batch Compiler Statements".

User-written edit modules must be written in Assembler. Preprocessing, compiling, and link editing of Assembler modules is detailed in the CA IDMS DML Reference Guide for Assembler. Planning and coding considerations that apply to all user-written edit modules are presented as follows, followed by considerations that apply specifically to either mapin or mapout operations.