Process command reference

This section describes the commands available in the Command field drop down menu on the Process – New window.

The table below contains a brief description of each command; you can find detailed information for each individual command in the remainder of this chapter.

Command

Summary description

Archive

Moves files to a destination folder. This command copies the file to archive and puts a timestamp in the file name.

Arithmetic

Performs mathematical calculations within a process.

Assign

Assigns a value to a variable within a process.

BuildAcknowledgement

Builds a functional acknowledgement transaction. This transaction can be sent using other process commands.

Comment

This command is used to comment code that may be ambiguous. Comments are not part of executable code and therefore will not affect the running of the script file.

ComplianceCheck

Initiates an X.12 compliance check on the transaction currently being processed.

CreateDirectory

This option allows the user to create a directory and location that fits their specifications.

Decrypt

Decrypts and interprets encrypted messages. This command is used in conjunction with the Encrypt command.

Display

Allows you to display a message to the window during execution of a process.

Do

Enables you to run processes within other processes. Control of the process is handed to the nested process when it is invoked by this command.

DoNothing

This command is inserted into the script file for use when testing a condition. It functions as a pause while the execution control is passed to a testing module of the script file.

DoWhile

Extends the capabilities of the Do command, enabling you to specify conditional running of processes.

Email

Generates an e-mail message that can include an attached file. This e-mail message can transmit a user-specified file to a user-specified e-mail address.

Encrypt

Enables you to send securely encrypted EDI communications. This command is used in conjunction with the Decrypt command.

ExecuteRemoteProcess

Allows users to run a process on a remote machine.

Exit

Forces the process to end.

Fax

Passes a facsimile message containing user-specific files to a fax management engine.

FileCommand

Performs file manipulation commands within a process.

FileExists

Tests for the existence of files.

FileNotLocked

Tests to see if a file is locked before accessing the specified file.

FileSize

Checks the size of a file.

GetFile

Opens a communications channel and retrieves a file by playing back the script associated with that channel.

GetMessage

The GetMessage command gets a copy of the first message in the Get Channel queue. Note that it does not actually delete the message, as it did in release 2.8.3. Instead, the user's script has to manage the deletion of the message, by using either the RemoveMessage command or manage the restoration of the message, by using the RestoreMessage command.

GetMessagePutReply

The GetMessagePutReply command places a response to the message received from the queue.

GetNextFile

Obtains next sequential file in the queue.

GoTo

Allows branching of process execution. Any label within a process can be referenced by this command.

IfThenElse

Provides support for conditional branching of sub-processes and process execution. You can set a condition, with results for both true and false testing of the condition, and optionally include an else statement.

LoadMemory

Allocates memory and loads an input file into the shared memory or a Messages variable.

Log

Enables the EC Gateway to write a message to its log file.

NumericType

Examines an input string and determines if it is numeric or non-numeric.

Page

Generates a pager message for external notification of events.

PrintEDI

A shortcut for the RunMapIn command with the Print only option. Executes a print map.

PutMessage

The PutMessage command places a message on a queue for an application to pick up. This command supports the integration of EC Gateway with other electronic commerce applications.

PutMessageGetReply

The PutMessageGetReply command sends a message to a message queue and waits for a reply.

RemoveMessage

The RemoveMessage command removes all messages received in this script from any queue since the first GetMessage command, or from the previous RemoveMessage or RestoreMessage commands.

Report

Supports runtime execution of any of the reports contained within the EC Gateway application.

Resource

Allows you to run multiple processes simultaneously. This command inquires about other processes that could be running and locks or releases resources for allocation to individual processes.

RestoreMessage

This command restores all the messages received in this script from any queue since the first GetMessage command, or from the previous RemoveMessage or RestoreMessage commands such that subsequent GetMessage commands will be able to reread the same messages.

RestoreProcessVariables

Restores all the process variables from a file.

Return

Forces the currently executed process to terminate.

RouteEDI

Calls the ECMap engine and executes the inbound map corresponding to the communications channel and system you are currently using.

Run

Calls executable programs from within the EC Gateway application.

RunAdapter

Calls the specified NNSYadapter. The NNSYadapter reads the configuration file that you specify on this window.

RunMapIn

Calls the ECMap engine and executes the inbound map corresponding to the communications channel and system you are currently using.

RunMapOut

Calls the ECMap engine and executes the outbound map corresponding to the communications channel and system you are currently using.

RunThread

Forks a specified thread to run simultaneously.

RunWait

Calls executable programs from within the EC Gateway application, and waits for the execution to finish.

SaveMemory

Specifies the object to be saved to memory.

SaveProcessVariables

Saves all the process variables into a file.

SendFile

Opens a communications channel and plays back the script associated with that channel.

StartLocalProcessServer

Starts the socket server, configures the ports to be used and what type of data to expect on those ports.

StopProcessServer

Stops the socket server from processing data.

StringCaseConvert

Converts all of the characters in an input string into upper or lower case.

StringConcatenate

Concatenates strings while processing transactions. This command permits the concatenation of up to four strings at a time.

StringFind

Searches for a specified string within an input string.

StringLength

Returns the length of a specified string.

StringReplace

Finds and replaces a specified string of characters with the input string.

StringTrim

Removes any leading and trailing blank characters from the input string.

Substring

Parses the input string allowing the specified string to be used during the running of a process.

SystemCommand

Sends commands directly to the shell process that is controlling the EC Gateway.

TimeDelay

Inserts a delay into a process execution.

TraceOnOff

Writes a tracked line to an ASCII file for each command in the script.

WhileDo

The WhileDo command embeds processes within other processes.