Overview of rule commands

Abort Transaction

Stops the processing of the current EDI transaction and proceeds to the next one

Arithmetic

Performs arithmetic operations, including addition, subtraction, division, and multiplication

Assignment

Assigns a constant value or the value of a field to a variable or another field. Enables data to be moved from a source to a destination

Binary Data Placement

Stores the contents of a BIN segment in either:

• A file predefined in ECMap

• A file and directory combination that is stored in a memory variable.

Check Point

The Check Point (and associated Back out Point) are used to mark the location of processing at various points in the program, and pull out portions of sequential files that are being written

Clear Record

Clears all the fields in a record

Comment

Holds informational or explanatory text. (This field is for documentation purposes only and does not perform any action.)

Concatenate Strings

Allows two data strings to be combined into a single string

Do Nothing

Performs no action. Used in specific instances when a rule is required but no operation needs to take place. (For example, flow requires a Before Rule and an After Rule.) May also be used as a placeholder when testing commands

File Management

Allows file maintenance activities to take place within the RTP.

• Copy Append Copies data from the source file and appends it to the destination file

• Copy Overwrite Copies data from the source file and overwrites the destination file

• Rename Renames the source file to the destination file

• Close Closes the source file

• Delete Deletes the source file

HTML I/O

Allows you to read and write HTML files.

• Read HTML Data Reads HTML-coded data

• Write HTML Form Creates an HTML form.

If Condition

Allows you to enter “if.. then” logic (“If” a specified condition is true, “then” a specified rule is performed.) and “if.. then.. else” logic into rules. (“If” a specified condition is true, “then” a specified rule is performed. Otherwise, the rule in “else” is performed.)

Keyed Record I/O

Used to read and write dBase-compatible files

• Keyed Read Reads the next record in the file

• Keyed Write Writes or appends the record to the file. (If the file does not exist, it is created)

• Keyed Rewrite Rewrites the record in the file

Map Level

Executes all of the rules and mapping associated with the segments in a specified level

NDO File Commands

Used to read and write NDO files to and from memory, or pass an NDO files from memory to the Adapter Runtime Environment for EDI.

• Put NDO File Converts an NDO sequential memory file to an NDO data tree.

• Read NDO File On first use, converts an NDO data tree acquired from the Adapter to a sequential memory file. For subsequent uses, the program reads a record in the NDO sequential memory file.

• Write NDO File Writes a record to an NDO sequential memory file

Perform Rule

Executes the specified rule number either one time or multiple times, based on a condition

Put File to Queue

Flags a file to be used in place of the queue file specified in the Adapter for EDI configuration file.

Sequential I/O

Allows you to read and write to ASCII text files, also called flat files

• Read Record Reads the next record in the file

• Read Record Once The read command is executed one time per execution of the map. (The next time this rule is encountered for the same record, no action is taken.)

• Write Record Write or append the record to the file. (If the file does not exist, it is created.)

• Rewrite Record Rewrite the record to the file. (Used for one-record files, such as counter type records.)

SQL

Allows you to perform operations on ODBC databases

• Close Connection for File Closes the connection to the ODBC database

• Close Cursor for File Record Closes the cursors (buffers). Each cursor represents a row or a group of rows from a Select or a Select and Update statement

• Commit All Files Commits the inserted or updated rows for all databases. This physically writes the rows into the database so that they cannot be lost, making all changes to the database permanent.

• Commit One File Commits the inserted or updated rows for the specified database. This physically writes the row to the database so that it cannot be lost, making changes to the database permanent

• Execute SQL Command Executes an SQL command stored in a memory variable.

• Fetch after Procedure Call Fetches the row after a Select statement is executed by a stored procedure.

• Fetch after Prior Select Moves a single row from the cursor (buffer) to the record definition buffer. This command executes once per map execution.

• Fetch Once after Prior Select Moves a single row from the buffer to the record definition buffer after a Select statement. Fetches a new row each time the rule is invoked.

• Insert Record into Table Writes the row to the database buffer.

• Rollback All Files Backs out all data to the last COMMIT command for all databases.

• Rollback One File Backs out current data to the last COMMIT command for one database.

• Select and Update Updates row(s) in the database table based on criteria for identifying a row.

• Select for Retrieval Queries the ODBC database and creates a cursor (buffer) containing the rows that match the selection (“where”) criteria. Selects different rows each time the rule is invoked

• Select Once for Retrieval Queries the database and creates a cursor (buffer) containing the rows that match the selection (“where”) criteria. This command executes once per map execution.

• Stored Procedure Call Invokes specialized routines that are inside the database.

Stop Run

Stops the running of the run-time engine

String Operations

Used to check string type, length, and position; to find, move, or replace a string; or to convert the case

• String Type Used to identify whether a field or variable is alpha or numeric

• String Move Used to move a field, variable, or record to a destination field, variable, or record, based on start position and length

• String Find Used to find a specific string

• String Length Used to return the length of the string in a source field or variable.

• String Replace Performs search and replace functions within a field or variable. Used to find the positions of a group of characters in a string

• String Justification Used to left- or right-justify a field or variable

• String Case Conversion Used to convert a field or variable string from upper- to lower-case or lower- to upper-case

Substring

Allows strings to be extracted from strings

Table Conversion

Allows data to be passed through a cross-reference table for conversion in a rule

User Exit

Allows data to be passed to and from routines that are performed outside of ECMap

Write Log

Writes user-defined messages to the Transaction Log (Translog) files.

XML I/O

Allows you to read and write XML files:

• Write XML Writes XML-coded data (includes start-of-record tag, data, and end-of-record tag) and attributes (within the start-of-record tag)

• Write XML w/No End Record Tag Writes XML-coded data without an end-of-record tag (includes start-of-record tag and data) and attributes (within the start-of-record tag)

• Write XML End Record Tag Only Writes only the XML end-of-record tag (includes only end-of-record tag)

• Write XML Text Writes XML processing instructions, doctypes, comments, etc.

• Read XML Reads XML-coded data