The reportformatExecute command executes the report format–related administrative operations.
| Command | Description |
|---|---|
| REPORTFORMATCMD_CREATE | Creates a new report format definition (see REPORTFORMATCMD_CREATE). |
| REPORTFORMATCMD_VIEW | Retrieves the settings of the specified report format (see REPORTFORMATCMD_VIEW). |
| REPORTFORMATCMD_UPDATE | Modifies an existing report format definition (see REPORTFORMATCMD_UPDATE). |
| REPORTFORMATCMD_DELETE | Deletes a report format definition (see REPORTFORMATCMD_DELETE). |
Parameters
| Parameter name | Data type | Description |
|---|---|---|
| sessionID | String | Required. The session identifier of the current administrative session. The logon command returns this identifier after a successful logon (see logon (Command)). |
| cmd | ReportFormatCmdIDEnum | Required. The operation to be executed. See Table: reportformatExecute commands. |
| attributeSet | ReportFormatAttributeSet | Required. A set containing zero or more attribute fields. |
The following field attributes are available for the operations of this command:
| Attribute name | Data type | Description |
|---|---|---|
| REPORTFORMATFLD_CREATE_TIME | DateTime | The date and time the data record was created. |
| REPORTFORMATFLD_FORMAT_DEFINITION | String | The report format definition. Cannot be null if specified. PDF reports use a custom XML template format, HTML reports use XSLT as templates (see Customizing reports). Up to 65535 characters. |
| REPORTFORMATFLD_DOMAIN | String | The domain where the report is located. Up to 255 characters. |
| REPORTFORMATFLD_FORMAT_NAME | String | Report format display name. Up to 64 characters. |
| REPORTFORMATFLD_MODIFY_TIME | DateTime | The date and time the data record was last modified. |
| REPORTFORMATFLD_QUERY_FOR | String | Use this attribute to query the report format definitions that the administrator currently logged on can update or run. Possible values:
|
| REPORTFORMATFLD_REPORT_ID | String | The unique report identifier. Up to 64 characters. |
REPORTFORMATCMD_CREATE
Creates a new report format definition.
The following attributes can be specified in the attributeSet input parameter of this command:
The following attributes will be specified in the results output parameter of this command:
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:
| Attribute name | Optionality |
|---|---|
| REPORTFORMATFLD_DOMAIN | Mandatory |
| REPORTFORMATFLD_FORMAT_NAME | Mandatory |
| REPORTFORMATFLD_REPORT_ID | Mandatory |
The following attributes will be specified in the results output parameter of this command:
REPORTFORMATCMD_UPDATE
Modifies an existing report format definition.
The following attributes can be specified in the attributeSet input parameter of this command:
The following attributes will be specified in the results output parameter of this command:
REPORTFORMATCMD_DELETE
Deletes a report format definition.
The following attributes can be specified in the attributeSet input parameter of this command:
| Attribute name | Optionality |
|---|---|
| REPORTFORMATFLD_DOMAIN | Mandatory |
| REPORTFORMATFLD_FORMAT_NAME | Mandatory |
| REPORTFORMATFLD_REPORT_ID | Mandatory |
This command returns no result attributes.