Proc types

Click Add Proc to open the New Proc dialog box. The New Proc dialog box is also available from the right-click menu. Click the Proc Type arrow to select a procedure-type template from the menu.

This table shows the available templates:
Template Description
code_set A HIPAA code set Tcl procedure template that gives an example of querying a lookup table for a particular key. This uses the dflt= specification in the lookup table. This determines the value to be returned if there is no table entry matching the input key value.

This default value is set to _non-existent_ in all HIPAA code set lookup tables.

ibdir A TPS template that gets the IBDir path from NetConfig. This accepts a TPS keyed list that contains the keys MODE, MSGID, and ARGS, and returns a TPS disposition list.
ibin A TPS template that parses ibmime and retrieves the message data. This accepts a TPS keyed list that contains the keys MODE, MSGID, and ARGS, and returns a TPS disposition list.
ibout A TPS template that wraps the message data into ibmime format. This accepts a TPS keyed list that contains the keys MODE, MSGID, and ARGS, and returns a TPS disposition list.
marp Used by the hcimsgarchive command to modify the message data to be saved to the external database.
other Selects any type of Tcl procedure.
routetest Uses end procedures to process messages produced by the Testing Tool. For example, display message contents, save them to files, or test them for correctness. This is a prototype for end procedures used with hciroutetest.
tclalert The template for custom alerts that are written in Tcl.
tpstest Uses end procedures to process messages produced by the Testing Tool. For example, display message contents, save them to files, or test them for correctness. This is a prototype for end procedures used with hcitpstest.
tps Uses a list of Tcl procedures, invoked in sequence.
trxid Determines a message’s transaction ID.
xltCall

Contains a process method that has no return and is given no input values. To do anything, the implementation of this method must use the methods of the XPM object that is passed in.

xltObjects

XLTObjects has an XlateObjects method, taking a vector of object input values and returning a Vector of Object output values. Conversion between system field types and Java classes is performed automatically as specified in the API documentation of the Datum class.

xltString

XLTString has an xlateString method, taking a single string input value and returning a single object output.

xltStrings

XLTStrings has an xlateStrings method, taking a vector of string input values and returning a Vector of Object output values.

X12MetaData Contains code for all the fields in the ISA and GS segments. These are commented out initially. Uncomment the code in the fields and fill in the appropriate values.
xltp_func_string A special template of the xltp proc that handles a string within an XLT.
xltp Receives input through a certain set of variables, and returns data through another set. This proc style only works when called from a code fragment of an XLT.

Text editor

With every new Tcl procedure, Script Editor performs three steps before it opens the editor:

  1. It looks for a Visual environment variable.
  2. If one does not exist, then it looks for an editor environment variable.
  3. If one of these variables exists, then the Script Editor opens the editor specified within the variable.

If the specified editor does not exist, then:

  • UNIX opens vi
  • Windows opens Notepad