Routines for d_calout.kb


CreateControlPDBRecords

File Name

d_calout.kb

Syntax

CreateControlPDBRecords( VAL CustomData: VRType, REF ExtDataList: List Of ExtendedData, VAL os390_prob_id: STRING, VAL transType: INTEGER ):INTEGER

Parameters

CustomData - VRType with data to load into ExtendedData

ExtDataList - list Of ExtendedData to be loaded

Returns

Nothing

Side Effects

None

Description

This procedure packages VRType data as extendedData to be passed on to the External API.

Dialog Forms Called

None


DistApiCall

File Name

d_calout.kb

Syntax

DistApiCall( REF CustomData: VRType, VAL transType: INTEGER, VAL site_id: STRING, REF retCode: INTEGER )

Parameters

site_id - site ID for the final destination of the transfer

transType - tells the function how to formulater equest to the API

CustomData - VRType data record containing the body of the request message

retCode - Success/Failure result of the API callout routine

Returns

Nothing

Side Effects

This procedure is used with the Tivoli Script CallFunction. It is important that all four arguements are passed to this function through the call function. Failure to do so will not cause parse errors, but creates run-time errors.

Description

This procedure accepts custom data, packages it, and passes it on to the external API. This function is mainly to allow the mapping configuration utility to get data from the host-dedicated AppServers.

Dialog Forms Called

None


DistApiTest

File Name

d_calout.kb

Syntax

DistApiTest( REF CustomData: VRType, VAL transType: INTEGER, VAL site_id: STRING, REF retCode: INTEGER )

Parameters

site_id - site ID for the final destination of the transfer

transType - tells the function how to formulate a request to the API

dataview - name of the dataview to which the request applies

ExtDataList - list of extended data records containing the body of the request message

retCode - Success/Failure result of the API callout routine

Returns

Nothing

Side Effects

This procedure is used with the Tivoli Script CallFunction. It is important that all four arguements are passed to this function through the call function. Failure to do so will not cause parse errors, but creates run-time errors.

Description

This procedure accepts extended data, packages it, and passes it on to the external API. This function allows the mapping configuration utility to get data from the host-dedicated AppServers meta.ini. This is to be used for testing and documentation only.

Dialog Forms Called

None


GetOS390RNID

File Name

d_calout.kb

Syntax

GetOS390RNID( VAL CustomData: VRType, REF OS390_USER_ID: STRING, REF OS390_PROB_ID: STRING )

Parameters

CustomData - VRType with data to load into ExtendedData

OS390_USER_ID - unique ID for user on TSD/OS390

OS390_PROB_ID - unique ID for problem on TSD/OS390

Returns

None

Side Effects

None

Description

This function gets the OS390 RNID from the problem record.

Dialog Forms Called

None


HostApiCall

File Name

d_calout.kb

Syntax

HostApiCall( REF CustomData: VRType, VAL transType: INTEGER, VAL site_id: STRING, REF retCode: INTEGER )

Parameters

site_id - site ID for the final destination of the transfer

transType - tells the function how to formulate a request to the API

CustomData - VRType data record containing the body of the request message

retCode - Success/Failure result of the API callout routine

Returns

Nothing

Side Effects

This procedure is used with the Tivoli Script CallFunction. It is important that all four arguements are passed to this function through the call function. Failure to do so will not cause parse errors, but creates run-time errors.

Description

This procedure will accept extended data, package it, and pass it on to the external API.

Dialog Forms Called

None


HostApiTest

File Name

d_calout.kb

Syntax

HostApiTest( REF CustomData: VRType, VAL transType: INTEGER, VAL site_id: STRING, REF retCode: INTEGER )

Parameters

site_id - site ID for the final destination of the transfer

transType - tells the function how to formulate a request to the API

dataview - name of the dataview to which the request applies

ExtDataList - list of extended data records containing the body of the request message

retCode - Success/Failure result of the API callout routine

Returns

Nothing

Side Effects

This procedure is used with the Tivoli Script CallFunction. It is important that all four arguements are passed to this function through the call function. Failure to do so will not cause parse errors, but creates run-time errors.

Description

This procedure accepts extended data, packages it, and passes it on to the external API. This is to be used for testing and documentation only.

Dialog Forms Called

None