Automation Services Application Program Interface › $RMDBAPI SERVICE=SET

$RMDBAPI SERVICE=SET

This API procedure function call changes field values in a system image definition. The SET function is not available to other definitions in the knowledge base.

Syntax

This API procedure function call has the following format:

$RMDBAPI SERVICE=SET
        [TRUNCATE={YES|NO}]
         CLASS=01
         SYSNAME=system-name
         VERSION=version
        [field-name-1=field value-1]
        [field-name-2=field value-2]
        …
        [field-name-n=field value-n]

Operands

This API procedure function call has the following operands:

SERVICE=SET

Specifies that you want to change the specified definition.

TRUNCATE={YES|NO}

Specifies whether a field value is truncated if it is longer than the field length.

YES

Specifies that long values are truncated and the definition is changed.

NO

Specifies that no truncation is allowed. If a long value is encountered, the definition is not changed.

CLASS=01

Specifies that you want to change a system image definition.

SYSNAME=system-name

Specifies the name of the system image definition to be changed.

VERSION=version

Specifies the version of the system image definition.

field-name-n=field-value-n

Specifies the values of the fields to be changed in the definition.

You cannot delete a field value.

Return Variable

This API procedure function call returns the following variable:

&SYSMSG

Contains the returned message.

Return Codes

Return codes indicate the success or failure of processing. This API procedure function call returns the following return codes in the &RETCODE variable:

0

Indicates that processing was successful.

4

Indicates that processing was successful, but truncation has occurred.

8

Indicates that processing failed.

16

Indicates that error occurred in the call syntax.

Example: Change the Long Description

This example changes the value of the fourth line of the Long Description field in the EASTPRD1 version 2 system image definition (class 1), with truncation allowed:

&LDESC4=&STR (Upgrade in progress)

&CALL PROC=$RMDBAPI +
      PARMS=(SERVICE=SET,+
             CLASS=01,+
             SYSNAME=EASTPRD1,+
             VERSION=0002,+
             LDESC4=&LDESC4)