Login
    Contenu x
    reportExecute (Command)
    • 18 Dec 2024
    • 3 Minutes à lire
    • Sombre
      Lumière
    • PDF
    Contenu

    reportExecute (Command)

    • Mis à jour le 18 Dec 2024
    • 3 Minutes à lire
    • Sombre
      Lumière
    • PDF
    The content is currently unavailable in French. You are viewing the default English version.
    Résumé de l’article

    The reportExecute command performs report–related administrative operations.

      Table:  reportExecute commands
    CommandDescription
    REPORTCMD_CHANGE_OWNERTransfers the ownership of a report to another administrator (see  REPORTCMD_CHANGE_OWNER).
    REPORTCMD_CREATECreates a new report definition (see  REPORTCMD_CREATE).
    REPORTCMD_DELETEDeletes the specified report definition (see  REPORTCMD_DELETE).
    REPORTCMD_RUNGenerates the specified report (see  REPORTCMD_RUN).
    REPORTCMD_UPDATEUpdates the specified report definition (see  REPORTCMD_UPDATE).
    REPORTCMD_VIEWRetrieves the settings of the specified report definition (see  REPORTCMD_VIEW).

    Parameters

      Table: reportExecute input parameters
    Parameter nameData typeDescription
    sessionIDStringRequired. The session identifier of the current administrative session. The logon command returns this identifier after a successful logon (see  logon (Command)).
    cmdReportCmdIDEnumRequired. The operation to be executed. See Table: reportExecute commands.
    attributeSetReportAttributeSetRequired. A set containing zero or more attribute fields.
      Table: reportExecute output parameters
    Parameter nameData typeDescription
    resultsReportResultsResult 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 nameData typeDescription
    REPORTFLD_ATTACH_REPORTBooleanIndicates that the report should be attached to the email notification. This applies to scheduled reports.
    REPORTFLD_CHANGE_PERMISSIONSString

    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_TIMEDateTime

    The date and time the data record was created.

    REPORTFLD_DATA_SOURCEString

    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_DOMAINStringUp to 255 characters.
    REPORTFLD_FORMAT_NAMEString

    The report output format.

    Possible values:

    • PDF

    • HTML

    • XML

    REPORTFLD_GROUP_LEVELString

    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_TIMEDateTime

    The date and time the data record was last modified.

    REPORTFLD_QUERY_DEFINITIONString

    One ore more XML-formatted report queries.

    Up to 1024 characters.

    REPORTFLD_QUERY_FORString

    The record types to query for. Applicable for certain queries only.

    Possible values:

    • change
    • run
    REPORTFLD_REPORT_DATAStringContains the actual report.
    REPORTFLD_REPORT_DESCStringUp to 64 characters.
    REPORTFLD_REPORT_FILE_NAMEStringUp to 255 characters.
    REPORTFLD_REPORT_IDStringUp to 255 characters.
    REPORTFLD_REPORT_NAMEStringUp to 64 characters.
    REPORTFLD_REPORT_TYPEString

    Possible values:

    • Detail
    • List
    • Trend
    • Distribution
    • Query
    REPORTFLD_RUN_PERMISSIONSString

    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_SCHEDULEBoolean

    Indicates whether the report is scheduled.

    Possible values:

    • true
    • false
    REPORTFLD_SCHEDULE_DATEString

    Format: DD/MM/YYYY

    Example: 20/07/2013

    REPORTFLD_SCHEDULE_MONTH_DAYString

    Day of the month for which the report task is scheduled, if recurring monthly.

    Possible values: 1–31

    REPORTFLD_SCHEDULE_MONTHSStringScheduled month for the recurring report task. Space-separated list of applicable months.
    REPORTFLD_SCHEDULE_NOTIFYString

    Method of notification.

    Possible values:

    • None
    • SMS
    • Email
    REPORTFLD_SCHEDULE_RECURRENCEString

    Recurrence type.

    Possible values:

    • None
    • Daily
    • Monthly
    REPORTFLD_SCHEDULE_TIMEDateTime

    Format: hh:mm

    Use 24-hour time. For example: 21:00

    REPORTFLD_SCHEDULE_WEEKDAYSStringThe scheduled day of the week for a recurring report task. Space-separated list of applicable days.
    REPORTFLD_TIME_FREQUENCYString

    Possible values:

    • Hour
    • Day
    • Month
    • Year
    REPORTFLD_TIMEZONEStringTimes displayed in the report are converted to this timezone
    REPORTFLD_USERIDStringUp 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 nameOptionality
    REPORTFLD_CHANGE_PERMISSIONSMandatory
    REPORTFLD_DATA_SOURCEMandatory
    REPORTFLD_DOMAINMandatory
    REPORTFLD_GROUP_LEVELMandatory
    REPORTFLD_QUERY_DEFINITIONMandatory
    REPORTFLD_REPORT_IDMandatory
    REPORTFLD_REPORT_NAMEOptional
    REPORTFLD_REPORT_DESCMandatory
    REPORTFLD_REPORT_TYPEMandatory
    REPORTFLD_RUN_PERMISSIONSMandatory
    REPORTFLD_TIME_FREQUENCYMandatory
    REPORTFLD_USERIDMandatory

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

      Table: REPORTCMD_CREATE (Supported output attributes)
    Attribute nameReturned?
    REPORTFLD_CHANGE_PERMISSIONSAlways
    REPORTFLD_CREATE_TIMEAlways
    REPORTFLD_DATA_SOURCEAlways
    REPORTFLD_DOMAINAlways
    REPORTFLD_GROUP_LEVELAlways
    REPORTFLD_MODIFY_TIMEAlways
    REPORTFLD_QUERY_DEFINITIONAlways
    REPORTFLD_REPORT_DESCIf defined
    REPORTFLD_REPORT_IDAlways
    REPORTFLD_REPORT_NAMEIf defined
    REPORTFLD_REPORT_TYPEAlways
    REPORTFLD_RUN_PERMISSIONSAlways
    REPORTFLD_TIME_FREQUENCYAlways
    REPORTFLD_USERIDAlways

    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 nameOptionality
    REPORTFLD_DOMAINMandatory
    REPORTFLD_REPORT_IDMandatory

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

      Table: REPORTCMD_VIEW (Supported output attributes)
    Attribute nameReturned?
    REPORTFLD_CHANGE_PERMISSIONSAlways
    REPORTFLD_CREATE_TIMEAlways
    REPORTFLD_DATA_SOURCEAlways
    REPORTFLD_DOMAINAlways
    REPORTFLD_GROUP_LEVELAlways
    REPORTFLD_MODIFY_TIMEAlways
    REPORTFLD_QUERY_DEFINITIONAlways
    REPORTFLD_REPORT_DESCIf defined
    REPORTFLD_REPORT_IDAlways
    REPORTFLD_REPORT_NAMEIf defined
    REPORTFLD_REPORT_TYPEAlways
    REPORTFLD_RUN_PERMISSIONSAlways
    REPORTFLD_TIME_FREQUENCYAlways
    REPORTFLD_USERIDAlways

    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 nameOptionality
    REPORTFLD_CHANGE_PERMISSIONSOptional
    REPORTFLD_DATA_SOURCEOptional
    REPORTFLD_DOMAINMandatory
    REPORTFLD_GROUP_LEVELOptional
    REPORTFLD_QUERY_DEFINITIONOptional
    REPORTFLD_REPORT_DESCOptional
    REPORTFLD_REPORT_IDMandatory
    REPORTFLD_REPORT_NAMEOptional
    REPORTFLD_REPORT_TYPEOptional
    REPORTFLD_RUN_PERMISSIONSOptional
    REPORTFLD_TIME_FREQUENCYOptional
    REPORTFLD_USERIDOptional

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

      Table: REPORTCMD_UPDATE (Supported output attributes)
    Attribute nameReturned?
    REPORTFLD_CHANGE_PERMISSIONSAlways
    REPORTFLD_CREATE_TIMEAlways
    REPORTFLD_DATA_SOURCEAlways
    REPORTFLD_DOMAINAlways
    REPORTFLD_GROUP_LEVELAlways
    REPORTFLD_MODIFY_TIMEAlways
    REPORTFLD_QUERY_DEFINITIONAlways
    REPORTFLD_REPORT_DESCIf defined
    REPORTFLD_REPORT_IDAlways
    REPORTFLD_REPORT_NAMEIf defined
    REPORTFLD_REPORT_TYPEAlways
    REPORTFLD_RUN_PERMISSIONSAlways
    REPORTFLD_TIME_FREQUENCYAlways
    REPORTFLD_USERIDAlways

    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 nameOptionality
    REPORTFLD_DOMAINMandatory
    REPORTFLD_REPORT_IDMandatory

    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 nameOptionality
    REPORTFLD_DOMAINMandatory
    REPORTFLD_REPORT_IDMandatory
    REPORTFLD_USERIDMandatory

    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 nameReturned?
    REPORTFLD_CHANGE_PERMISSIONSAlways
    REPORTFLD_CREATE_TIMEAlways
    REPORTFLD_DATA_SOURCEAlways
    REPORTFLD_DOMAINAlways
    REPORTFLD_GROUP_LEVELAlways
    REPORTFLD_MODIFY_TIMEAlways
    REPORTFLD_QUERY_DEFINITIONAlways
    REPORTFLD_REPORT_DESCIf defined
    REPORTFLD_REPORT_IDAlways
    REPORTFLD_REPORT_NAMEIf defined
    REPORTFLD_REPORT_TYPEAlways
    REPORTFLD_RUN_PERMISSIONSAlways
    REPORTFLD_TIME_FREQUENCYAlways
    REPORTFLD_USERIDAlways

    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 input attributes)
    Attribute nameOptionality
    REPORTFLD_DOMAINMandatory
    REPORTFLD_FORMAT_NAMEOptional
    REPORTFLD_QUERY_DEFINITIONOptional
    REPORTFLD_REPORT_IDMandatory
    REPORTFLD_SCHEDULEOptional
    REPORTFLD_SCHEDULE_DATEOptional
    REPORTFLD_SCHEDULE_MONTH_DAYOptional
    REPORTFLD_SCHEDULE_MONTHSOptional
    REPORTFLD_SCHEDULE_NOTIFYOptional
    REPORTFLD_SCHEDULE_RECURRENCEOptional
    REPORTFLD_SCHEDULE_TIMEOptional
    REPORTFLD_SCHEDULE_WEEKDAYSOptional

    Only the REPORTFLD_REPORT_FILE_NAME attribute will be specified in the results output parameter of this command. This attribute is always returned.

    Cet article vous a-t-il été utile ?
    What's Next
    Change password!
    Changing your password will log you out immediately. Use the new password to log back in.
    Change profile
    Success!
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.
    Logout
    ESC

    Ozzy, facilitant la découverte de connaissances grâce à l’intelligence conversationnelle