reportformatExecute (Command)

  • Published on Jul 7, 2025
  • 1 minute(s) read
Prev Next

The reportformatExecute command executes the report format–related administrative operations.

  Table:  reportformatExecute commands
CommandDescription
REPORTFORMATCMD_CREATECreates a new report format definition (see  REPORTFORMATCMD_CREATE).
REPORTFORMATCMD_VIEWRetrieves the settings of the specified report format (see  REPORTFORMATCMD_VIEW).
REPORTFORMATCMD_UPDATEModifies an existing report format definition (see  REPORTFORMATCMD_UPDATE).
REPORTFORMATCMD_DELETEDeletes a report format definition (see  REPORTFORMATCMD_DELETE).

Parameters

  Table: reportformatExecute input parameters
Parameter nameData typeDescription
sessionIDString

Required. The session identifier of the current administrative session. The logon command returns this identifier after a successful logon (see  logon (Command)).

cmdReportFormatCmdIDEnumRequired. The operation to be executed. See Table: reportformatExecute commands.
attributeSetReportFormatAttributeSetRequired. A set containing zero or more attribute fields.
  Table: reportformatExecute oputput parameters
Parameter nameData typeDescription
resultsReportFormatResultsResult structure containing return and status codes and a list of zero or more result attribute fields.

The following field attributes are available for the operations of this command:

  Table:  reportformatExecute field attributes
Attribute nameData typeDescription
REPORTFORMATFLD_CREATE_TIMEDateTime

The date and time the data record was created.

REPORTFORMATFLD_FORMAT_DEFINITIONStringThe report format definition name.
REPORTFORMATFLD_DOMAINString

The domain where the report is located.

Up to 255 characters.

REPORTFORMATFLD_FORMAT_NAMEString

Report format display name.

Up to 64 characters.

REPORTFORMATFLD_MODIFY_TIMEDateTime

The date and time the data record was last modified.

REPORTFORMATFLD_QUERY_FORString

Use this attribute to query the report format definitions that the administrator currently logged on can update or run.

Possible values:

  • update
  • run
REPORTFORMATFLD_REPORT_IDString

The unique report identifier.

Up to 255 characters.

REPORTFORMATCMD_CREATE

Creates a new report format definition.

The following attributes can be specified in the attributeSet input parameter of this command:

  Table: REPORTFORMATCMD_CREATE (Supported input attributes)
Attribute nameOptionality
REPORTFORMATFLD_DOMAIN_NAMEMandatory
REPORTFORMATFLD_FORMAT_DEFINITIONMandatory
REPORTFORMATFLD_FORMAT_NAMEMandatory
REPORTFORMATFLD_REPORT_IDMandatory

The following attributes will be specified in the results output parameter of this command:

  Table: REPORTFORMATCMD_CREATE (Supported output attributes)
Attribute nameReturned?
REPORTFORMATFLD_CREATE_TIMEAlways
REPORTFORMATFLD_DOMAIN_NAMEAlways
REPORTFORMATFLD_FORMAT_DEFINITIONAlways
REPORTFORMATFLD_FORMAT_NAMEAlways
REPORTFORMATFLD_MODIFY_TIMEAlways
REPORTFORMATFLD_REPORT_IDAlways

REPORTFORMATCMD_VIEW

Retrieves the settings of the specified report format definition.

The following attributes can be specified in the attributeSet input parameter of this command:

  Table: REPORTFORMATCMD_VIEW (Supported input attributes)
Attribute nameOptionality
REPORTFORMATFLD_DOMAIN_NAMEMandatory
REPORTFORMATFLD_FORMAT_NAMEMandatory
REPORTFORMATFLD_REPORT_IDMandatory

The following attributes will be specified in the results output parameter of this command:

  Table: REPORTFORMATCMD_VIEW (Supported output attributes)
Attribute nameReturned?
REPORTFORMATFLD_CREATE_TIMEAlways
REPORTFORMATFLD_DOMAIN_NAMEAlways
REPORTFORMATFLD_FORMAT_DEFINITIONAlways
REPORTFORMATFLD_FORMAT_NAMEAlways
REPORTFORMATFLD_MODIFY_TIMEAlways
REPORTFORMATFLD_REPORT_IDAlways

REPORTFORMATCMD_UPDATE

Modifies an existing report format definition.

The following attributes can be specified in the attributeSet input parameter of this command:

  Table: REPORTFORMATCMD_UPDATE (Supported input attributes)
Attribute nameOptionality
REPORTFORMATFLD_DOMAIN_NAMEMandatory
REPORTFORMATFLD_FORMAT_DEFINITIONOptional
REPORTFORMATFLD_FORMAT_NAMEMandatory
REPORTFORMATFLD_REPORT_IDMandatory

The following attributes will be specified in the results output parameter of this command:

  Table: REPORTFORMATCMD_UPDATE (Supported output attributes)
Attribute nameReturned?
REPORTFORMATFLD_CREATE_TIMEAlways
REPORTFORMATFLD_DOMAIN_NAMEAlways
REPORTFORMATFLD_FORMAT_DEFINITIONAlways
REPORTFORMATFLD_FORMAT_NAMEAlways
REPORTFORMATFLD_MODIFY_TIMEAlways
REPORTFORMATFLD_REPORT_IDAlways

REPORTFORMATCMD_DELETE

Deletes a report format definition.

The following attributes can be specified in the attributeSet input parameter of this command:

  Table: REPORTFORMATCMD_DELETE (Supported input attributes)
Attribute nameOptionality
REPORTFORMATFLD_FORMAT_DEFINITIONOptional
REPORTFORMATFLD_DOMAIN_NAMEMandatory
REPORTFORMATFLD_FORMAT_NAMEMandatory
REPORTFORMATFLD_REPORT_IDMandatory

This command returns no result attributes.