Scenario: Administration
Support: full-sdk
The reportExecute command performs report–related administrative operations.
Table: reportExecute commands | Command | Description |
|---|
| REPORTCMD_CHANGE_OWNER | Transfers the ownership of a report to another administrator (see REPORTCMD_CHANGE_OWNER). |
| REPORTCMD_CREATE | Creates a new report definition (see REPORTCMD_CREATE). |
| REPORTCMD_DELETE | Deletes the specified report definition (see REPORTCMD_DELETE). |
| REPORTCMD_RUN | Generates the specified report (see REPORTCMD_RUN). |
| REPORTCMD_UPDATE | Updates the specified report definition (see REPORTCMD_UPDATE). |
| REPORTCMD_VIEW | Retrieves the settings of the specified report definition (see REPORTCMD_VIEW). |
Parameters
Table: reportExecute input 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 | ReportCmdIDEnum | Required. The operation to be executed. See Table: reportExecute commands. |
| attributeSet | ReportAttributeSet | Required. A set containing zero or more attribute fields. |
Table: reportExecute output parameters | Parameter name | Data type | Description |
|---|
| results | ReportResults | Result 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: reportExecute field attributes | Attribute name | Data type | Description |
|---|
| REPORTFLD_ATTACH_REPORT | Boolean | Indicates that the report should be attached to the email notification. This applies to scheduled reports. |
| REPORTFLD_CHANGE_PERMISSIONS | String | The permission to modify a specific report. Possible values: - Private. Only the report owner can modify the report definition.
- Domain. Only administrators that are in the same domain as the report can modify the report definition.
- Public. All administrators in all domains can modify the report definition.
|
| REPORTFLD_CREATE_TIME | DateTime | The date and time the data record was created. |
| REPORTFLD_DATA_SOURCE | String | Defines the source where to collect the data from when running a specific report. Possible values: - Users.
- Users + Audit.
- Digipass.
- Digipass + Audit.
- Clients.
- Audit.
- Users + Digipass.
|
| REPORTFLD_DOMAIN | String | Up to 255 characters. |
| REPORTFLD_FORMAT_NAME | String | The report output format. Possible values: |
| REPORTFLD_GROUP_LEVEL | String | Defines how the report data will be grouped. Possible values: - Clients. Each (physical) client connected will be represented individually.
- Domains.
- Organizational Units. If you set this value for detailed or list reports, the data for all the users in that organizational unit will be added together and represented only once under the organizational unit.
- Users. If you set this value for detailed or list reports, each user will be represented individually.
- Digipass.
|
| REPORTFLD_MODIFY_TIME | DateTime | The date and time the data record was last modified. |
| REPORTFLD_QUERY_DEFINITION | String | One ore more XML-formatted report queries. Up to 1024 characters. |
| REPORTFLD_QUERY_FOR | String | The record types to query for. Applicable for certain queries only. Possible values: |
| REPORTFLD_REPORT_DATA | String | Contains the actual report. |
| REPORTFLD_REPORT_DESC | String | Up to 64 characters. |
| REPORTFLD_REPORT_FILE_NAME | String | Up to 255 characters. |
| REPORTFLD_REPORT_ID | String | Up to 255 characters. |
| REPORTFLD_REPORT_NAME | String | Up to 64 characters. |
| REPORTFLD_REPORT_TYPE | String | Possible values: - Detail
- List
- Trend
- Distribution
- Query
|
| REPORTFLD_RUN_PERMISSIONS | String | The permission to run a specific report. Possible values: - Private. Only the report owner can run the report.
- Domain. Only administrators that are in the same domain as the report can run the report.
- Public. All administrators in all domains can run the report.
|
| REPORTFLD_SCHEDULE | Boolean | Indicates whether the report is scheduled. Possible values: |
| REPORTFLD_SCHEDULE_DATE | String | Format: DD/MM/YYYY Example: 20/07/2013 |
| REPORTFLD_SCHEDULE_MONTH_DAY | String | Day of the month for which the report task is scheduled, if recurring monthly. Possible values: 1–31 |
| REPORTFLD_SCHEDULE_MONTHS | String | Scheduled month for the recurring report task. Space-separated list of applicable months. |
| REPORTFLD_SCHEDULE_NOTIFY | String | Method of notification. Possible values: |
| REPORTFLD_SCHEDULE_RECURRENCE | String | Recurrence type. Possible values: |
| REPORTFLD_SCHEDULE_TIME | DateTime | Format: hh:mm Use 24-hour time. For example: 21:00 |
| REPORTFLD_SCHEDULE_WEEKDAYS | String | The scheduled day of the week for a recurring report task. Space-separated list of applicable days. |
| REPORTFLD_TASK_ID | String | The ID of the server task that generated the report. This is required to download generated report files. Up to 255 characters. Availability: 3.28 and later |
| REPORTFLD_TIME_FREQUENCY | String | Possible values: |
| REPORTFLD_TIMEZONE | String | Times displayed in the report are converted to this timezone |
| REPORTFLD_USERID | String | Up to 1024 characters. |
REPORTCMD_CREATE
Creates a new report definition.
The following attributes can be specified in the attributeSet input parameter of this command:
Table: REPORTCMD_CREATE (Supported input attributes) | Attribute name | Optionality |
|---|
| REPORTFLD_CHANGE_PERMISSIONS | Mandatory |
| REPORTFLD_DATA_SOURCE | Mandatory |
| REPORTFLD_DOMAIN | Mandatory |
| REPORTFLD_GROUP_LEVEL | Mandatory |
| REPORTFLD_QUERY_DEFINITION | Mandatory |
| REPORTFLD_REPORT_ID | Mandatory |
| REPORTFLD_REPORT_NAME | Optional |
| REPORTFLD_REPORT_DESC | Mandatory |
| REPORTFLD_REPORT_TYPE | Mandatory |
| REPORTFLD_RUN_PERMISSIONS | Mandatory |
| REPORTFLD_TIME_FREQUENCY | Mandatory |
| REPORTFLD_USERID | Mandatory |
The following attributes will be specified in the results output parameter of this command:
Table: REPORTCMD_CREATE (Supported output attributes) | Attribute name | Returned? |
|---|
| REPORTFLD_CHANGE_PERMISSIONS | Always |
| REPORTFLD_CREATE_TIME | Always |
| REPORTFLD_DATA_SOURCE | Always |
| REPORTFLD_DOMAIN | Always |
| REPORTFLD_GROUP_LEVEL | Always |
| REPORTFLD_MODIFY_TIME | Always |
| REPORTFLD_QUERY_DEFINITION | Always |
| REPORTFLD_REPORT_DESC | If defined |
| REPORTFLD_REPORT_ID | Always |
| REPORTFLD_REPORT_NAME | If defined |
| REPORTFLD_REPORT_TYPE | Always |
| REPORTFLD_RUN_PERMISSIONS | Always |
| REPORTFLD_TIME_FREQUENCY | Always |
| REPORTFLD_USERID | Always |
REPORTCMD_VIEW
Retrieves the settings of the specified report definition.
The following attributes can be specified in the attributeSet input parameter of this command:
Table: REPORTCMD_VIEW (Supported input attributes) | Attribute name | Optionality |
|---|
| REPORTFLD_DOMAIN | Mandatory |
| REPORTFLD_REPORT_ID | Mandatory |
The following attributes will be specified in the results output parameter of this command:
Table: REPORTCMD_VIEW (Supported output attributes) | Attribute name | Returned? |
|---|
| REPORTFLD_CHANGE_PERMISSIONS | Always |
| REPORTFLD_CREATE_TIME | Always |
| REPORTFLD_DATA_SOURCE | Always |
| REPORTFLD_DOMAIN | Always |
| REPORTFLD_GROUP_LEVEL | Always |
| REPORTFLD_MODIFY_TIME | Always |
| REPORTFLD_QUERY_DEFINITION | Always |
| REPORTFLD_REPORT_DESC | If defined |
| REPORTFLD_REPORT_ID | Always |
| REPORTFLD_REPORT_NAME | If defined |
| REPORTFLD_REPORT_TYPE | Always |
| REPORTFLD_RUN_PERMISSIONS | Always |
| REPORTFLD_TIME_FREQUENCY | Always |
| REPORTFLD_USERID | Always |
REPORTCMD_UPDATE
Updates the specified report definition.
The following attributes can be specified in the attributeSet input parameter of this command:
Table: REPORTCMD_UPDATE (Supported input attributes) | Attribute name | Optionality |
|---|
| REPORTFLD_CHANGE_PERMISSIONS | Optional |
| REPORTFLD_DATA_SOURCE | Optional |
| REPORTFLD_DOMAIN | Mandatory |
| REPORTFLD_GROUP_LEVEL | Optional |
| REPORTFLD_QUERY_DEFINITION | Optional |
| REPORTFLD_REPORT_DESC | Optional |
| REPORTFLD_REPORT_ID | Mandatory |
| REPORTFLD_REPORT_NAME | Optional |
| REPORTFLD_REPORT_TYPE | Optional |
| REPORTFLD_RUN_PERMISSIONS | Optional |
| REPORTFLD_TIME_FREQUENCY | Optional |
| REPORTFLD_USERID | Optional |
The following attributes will be specified in the results output parameter of this command:
Table: REPORTCMD_UPDATE (Supported output attributes) | Attribute name | Returned? |
|---|
| REPORTFLD_CHANGE_PERMISSIONS | Always |
| REPORTFLD_CREATE_TIME | Always |
| REPORTFLD_DATA_SOURCE | Always |
| REPORTFLD_DOMAIN | Always |
| REPORTFLD_GROUP_LEVEL | Always |
| REPORTFLD_MODIFY_TIME | Always |
| REPORTFLD_QUERY_DEFINITION | Always |
| REPORTFLD_REPORT_DESC | If defined |
| REPORTFLD_REPORT_ID | Always |
| REPORTFLD_REPORT_NAME | If defined |
| REPORTFLD_REPORT_TYPE | Always |
| REPORTFLD_RUN_PERMISSIONS | Always |
| REPORTFLD_TIME_FREQUENCY | Always |
| REPORTFLD_USERID | Always |
REPORTCMD_DELETE
Deletes the specified report definition.
The following attributes can be specified in the attributeSet input parameter of this command:
Table: REPORTCMD_DELETE (Supported input attributes) | Attribute name | Optionality |
|---|
| REPORTFLD_DOMAIN | Mandatory |
| REPORTFLD_REPORT_ID | Mandatory |
This command returns no result attributes.
REPORTCMD_CHANGE_OWNER
Transfers the ownership of a report to another administrator.
The following attributes can be specified in the attributeSet input parameter of this command:
Table: REPORTCMD_CHANGE_OWNER (Supported input attributes) | Attribute name | Optionality |
|---|
| REPORTFLD_DOMAIN | Mandatory |
| REPORTFLD_REPORT_ID | Mandatory |
| REPORTFLD_USERID | Mandatory |
In this case, REPORTFLD_USERID specifies the new report owner.
The following attributes will be specified in the results output parameter of this command:
Table: REPORTCMD_CHANGE_OWNER (Supported output attributes) | Attribute name | Returned? |
|---|
| REPORTFLD_CHANGE_PERMISSIONS | Always |
| REPORTFLD_CREATE_TIME | Always |
| REPORTFLD_DATA_SOURCE | Always |
| REPORTFLD_DOMAIN | Always |
| REPORTFLD_GROUP_LEVEL | Always |
| REPORTFLD_MODIFY_TIME | Always |
| REPORTFLD_QUERY_DEFINITION | Always |
| REPORTFLD_REPORT_DESC | If defined |
| REPORTFLD_REPORT_ID | Always |
| REPORTFLD_REPORT_NAME | If defined |
| REPORTFLD_REPORT_TYPE | Always |
| REPORTFLD_RUN_PERMISSIONS | Always |
| REPORTFLD_TIME_FREQUENCY | Always |
| REPORTFLD_USERID | Always |
REPORTCMD_RUN
Generates the specified report. The generated report can be downloaded using the reportfiledownloadmtom command (see reportfiledownloadmtom (Command)).
The following attributes can be specified in the attributeSet input parameter of this command:
Table: REPORTCMD_RUN (Supported output attributes) | Attribute name | Returned |
|---|
| REPORTFLD_REPORT_FILE_NAME | Always |
| REPORTFLD_TASK_ID | Always |