[Index]

Model: data/DashboardExport

Dashboard exports

Full HTML Help

This procedure adds or updates a dashboard export instance.

Note

Automate allows for dashboards, including dashboard data, to be exported to an email address and/or to a target SFTP destination.

  1. Go to Dashboard Exports to open the list view of existing dashboard exports.

    Note

    Dashboard export instances can only be modified by the user who created it or by the upper level user.

  2. To add a dashboard export instance, click the toolbar Plus icon (+).

  3. At Name, fill out a name for the export instance.

  4. In the Available transfer box, select one or more dashboards to export, then click the right-pointing arrows to move these dashboards to the Selected transfer box.

  5. Select export format, either of the following: Excel or CSV

  6. Choose an target destination, either SFTP and/or SMTP (email) destinations:

    Note

    At least one destination is required, either SMTP/SFTP. To export to SMTP, set up email. See Email.

    To export to SFTP, you'll need to have a SFTP server set up. See:

Add a SMTP Server in the Licensing and Subscriber Data Export Guide 7. Click Save to add the dashboard export. 8. You can execute the export or add a schedule for the export.

Note

Dashboard export is executed in the RBAC context of the user who created it (in accordance with the hierarchy at which the export instance is created).

Related topics

Export Dashboard Data to destination

Model Details: data/DashboardExport

Title Description Details
Default Group Assigned by FDP
  • Field Name: Default
  • Type: Object
Name * Name of the Dashboard Export
  • Field Name: Default.name
  • Type: String
  • MaxLength: 1024
Dashboards List of dashboards to export
  • Field Name: dashboards.[n]
  • Type: Array
  • Cardinality: [1..n]
Owner Owner of the Dashboard Export - used for RBAC when export is scheduled.
  • Field Name: Default.owner
  • Type: String
  • Target: data/User
  • MaxLength: 1024
  • Format: uri
Export format * Format of the file that will contain exported data.
  • Field Name: Default.export_format
  • Type: String
  • MaxLength: 1024
  • Choices: ["Excel", "CSV"]
SFTP Destinations
  • Field Name: sftp_destinations.[n]
  • Type: Array
Name * Name for this SFTP file transfer destination.
  • Field Name: Default.sftp_destinations.[n].name
  • Type: String
  • MaxLength: 1024
Hostname * Hostname of the SFTP server.
  • Field Name: Default.sftp_destinations.[n].host
  • Type: String
  • MaxLength: 253
  • Format: host-name
Port Port number for the SFTP server.
  • Field Name: Default.sftp_destinations.[n].port
  • Type: Integer
  • Minimum: 1
  • Maximum: 65535
Username * User name for authenticating with SFTP server.
  • Field Name: Default.sftp_destinations.[n].username
  • Type: String
  • MaxLength: 1024
Password Password for authenticating to SFTP server.
  • Field Name: Default.sftp_destinations.[n].password
  • Type: String
  • Is Password: True
  • Store Encrypted: True
  • MaxLength: 1024
Destination directory Directory path on SFTP server.
  • Field Name: Default.sftp_destinations.[n].directory
  • Type: String
  • MaxLength: 1024
SMTP Destinations
  • Field Name: smtp_destinations.[n]
  • Type: Array
Name * Friendly name for this SMTP destination
  • Field Name: Default.smtp_destinations.[n].name
  • Type: String
  • MaxLength: 1024
SMTP Server * SMTP Server (instance of data/Email)
  • Field Name: Default.smtp_destinations.[n].server
  • Type: String
  • Target: data/Email
  • MaxLength: 1024
  • Format: uri
From address * From address
  • Field Name: Default.smtp_destinations.[n].from
  • Type: String
  • MaxLength: 1024
  • Format: email
To Recipient email addresses.
  • Field Name: to.[n]
  • Type: Array
  • Cardinality: [1..n]
  • Format: email
Copy to CC email addresses.
  • Field Name: cc.[n]
  • Type: Array
Blind copy BCC email addresses.
  • Field Name: bcc.[n]
  • Type: Array
Subject * Subject line for outgoing emails.
  • Field Name: Default.smtp_destinations.[n].subject
  • Type: String
  • MaxLength: 1024