Refresh Local Macro Template Definitions API

Last updated
Save as PDF

The IIMACRFSH CL-based API provides a low-touch, on-demand macro template synchonization mechanism, which can be directly called from a command line or submitted to batch. The utility works as follows...

Initialization & Re-synchronization - All the toolkit's local macro template definitions may be initialized as part of the toolkit's post installation initialization (or anytime for that matter) by calling the new IIMACRFSH utility. The utility will call a web service to retrieve the list of all the customer's macros currently defined on the portal and then another web service to retrieve the macro template definition details for each one before storing them locally in the toolkit's database.
Ad Hoc - If desired, the utility may also be used at any time to synchronize the template for a single specific macro, although this is not expected to be a common use case.

The calling interface for the utility is as follows:

API Name: IIMACRFSH

Parameter Interface:

Parameter	Direction	Type	Length	Precision	Description
Macro Direction	Input	Character	1	n/a	"F" = Forward, 'R" = Return, "A" = All (forward and return)
Macro Number	Input	Character	2	n/a	Macro number "1" to "63" or "0" if macro direction "A" (All) specified
Completion Status String	Output	Character	200	n/a	Blank if successful or error string if failure encountered

Parameter

Direction

Type

Length

Precision

Description

Macro Direction

Input

Character

n/a

"F" = Forward, 'R" = Return, "A" = All (forward and return)

Macro Number

Input

Character

n/a

Macro number "1" to "63" or "0" if macro direction "A" (All) specified

Completion Status String

Output

Character

200

n/a

Blank if successful or error string if failure encountered