SUPPORTED CALLS TO XPAREDIT ICR (2336)

Name

Value

NUMBER

2336

IA #

2336

DATE CREATED

1998/05/11

CUSTODIAL PACKAGE

TOOLKIT

CUSTODIAL ISC

San Francisco

USAGE

Supported

TYPE

Routine

DBIC APPROVAL STATUS

APPROVED

ROUTINE

XPAREDIT

NAME

SUPPORTED CALLS TO XPAREDIT

GENERAL DESCRIPTION

This DBIA contains a list of calls which are supported
for use.  The calls are part of the Parameter Tools component of Toolkit.
Parameter Tools is a generic method of handling parameter definition,
assignment, and retrieval.  See DBIA 2263 for the main entry points to this
module.  This DBIA contains calls to XPAREDIT which contain some additional
utilities to for editing parameters.

STATUS

Active

XPAREDIT

COMPONENT/ENTRY POINT

COMPONENT DESCRIPTION

VARIABLES

This entry point can be called to prompt the user for
a parameter to edit.  This is provided more as a tool for developers and not
for exported calls as it allows editing of ANY parameter.

TED(Template,ReviewFlags,AllEntities)

TED^XPAREDIT(Template,ReviewFlags,AllEntities) allows
editing of parameters defined in a template.  The parameters in the template
are prompted in more of a FileMan style - prompt by prompt.  No dashed line
dividers are displayed between each parameter.  Since the dashed line headers
are suppressed, it is important to define the VALUE TERM for each parameter in
the template, as this is what is used to prompt for the value.

VARIABLES

TYPE

VARIABLES DESCRIPTION

Template

Input

REQUIRED

The IEN or NAME of an entry in the Parameter Template file (#8989.52).

ReviewFlags

Input

OPTIONAL

There are 2 flags (A and B) that can be used individually, together, or not at
all.  An 'A' indicates that the new values for the parameters in the template
are displayed AFTER the prompting is done.  'B' indicates that the current
values of the parameters will be displayed BEFORE editing.

AllEntities

Input

OPTIONAL

This is a variable pointer that should be used as the entity for all
parameters in the template.  If left blank, prompting for the entity is done
as defined in the PARAMETER TEMPLATE file.

TEDH(Template,ReviewFlags,AllEntities)

This is similar to the TED^XPAREDIT call, except that
the dashed line headers ARE shown between each parameter.

For input variable definitions, see TED component/entry point.

VARIABLES	TYPE
Template	Input
ReviewFlages	Input
AllEntities	Input

EDITPAR(Parameter)

This entry point can be used to edit a single
parameter.

VARIABLES	TYPE	VARIABLES DESCRIPTION
Parameter	Input	Pass as the IEN or the NAME of the entry in the PARAMETER DEFINITION file (#8989.51) which you want to be edited.

GETPAR(.Variable)

Allow user to select PARAMETER DEFINITION file entry.

VARIABLES	TYPE	VARIABLES DESCRIPTION
OutputValue	Output	Returns the value Y in standard DIC look-up format.

GETENT(.Entity,Parameter,.OnlyOne?)

Interactively prompts for an entity, based on the
definition of a parameter.

VARIABLES

TYPE

VARIABLES DESCRIPTION

Entity

Output

REQUIRED

Returns the selected entity in variable pointer format.

Parameter

Input

REQUIRED

Specifies the parameter for which an entity should be selected.  Parameter
should contain two pieces: IEN^DisplayNameOfParameter.

OnlyOne?

Output

OPTIONAL

Returns "1" if there is only one possible entity for the value. For example,
if the parameter can only be set for the system, OnlyOne?=1.  If the parameter
could be set for any location, OnlyOne?=0.

EDIT(Entity,Parameter)

Interactively edits the instance (if multiple
instances are allowed) and the value for a parameter associated with a given
entity.

VARIABLES

TYPE

VARIABLES DESCRIPTION

Entity

Input

REQUIRED

Identifies the specific entity for which a parameter may be edited. Entity
must be in variable pointer format.

Parameter

Input

REQUIRED

Identifies the parameter that should be edited.  Parameter should contain two
pieces:  IEN^DisplayNameOfParameter.

BLDLST(.List,Parameter)

This entry point will return, in the array List, all
entities allowed for the input Parameter.

VARIABLES	TYPE	VARIABLES DESCRIPTION
List	Input	Name of array to receive output.
Parameter	Input	IEN of entry in the PARAMETER DEFINITION file.