AgileApps Support Wiki Pre Release

Difference between revisions of "Export Data"

From AgileApps Support Wiki
imported>Aeric
imported>Aeric
Line 20: Line 20:


To view the data on a local computer, uncompress the .zip file, using any standard data compression program. The uncompressed data file is in {{^CSV}} format, which can be viewed using a standard database or spreadsheet application.
To view the data on a local computer, uncompress the .zip file, using any standard data compression program. The uncompressed data file is in {{^CSV}} format, which can be viewed using a standard database or spreadsheet application.
<!--
===Export Folder in Documents===
{{permissions|Import and Export Data|view this folder and contents}}


To download the exported data .zip file:
#Click the link in the email notification message. (The link is good for seven days.)
#Click the [Download] button to download a copy of the compressed .zip file
#Optionally, click the [Email] button to send a copy of the compressed .zip file via email
;Consideratons:
*An option exists to email a document from this folder
:*Be aware that a backup file can be unusually large
:*Choose an email address that can receive file attachments of such a large size
:*The data in this file does not include data from received email messages
*The .zip file is available for download for a period of seven days
;Visibility:
By default, access to the ''Export Data'' folder in [[Documents]] is set as follows:
:Share with: System Administrator
:Access Rights: Administrator (full rights)
Optionally, set the [[Folder Visibility]] options to allow other users to view and edit the ''Export Data'' folder.
-->
==Monitoring Export Status==
==Monitoring Export Status==


Line 53: Line 31:


;Considerations:
;Considerations:
*''Exported data will be automatically deleted from the '''Export Data''' folder in the [[Documents]] object after 7 days''
*''Exported data will be automatically deleted after 7 days
*One export per week is permitted
*One export per week is permitted
*Initiating a data export schedules the job for immediate execution (there is no automated scheduling mechanism)
*Initiating a data export schedules the job for immediate execution (there is no automated scheduling mechanism)

Revision as of 21:25, 25 June 2013

GearIcon.png > Administration > Data Management > Export Data

The Export Data option provides a means to download a copy of the database, creating a compressed (.zip) backup file.

Lock-tiny.gif

Users that have the Import and Export Data permission can import or export data 

To export data and create a backup file:

  1. Click GearIcon.png > Administration > Data Management > Export Data
  2. In the Export Detail section, complete the following information:
    Encoding Type
    Choose from ISO-8859-1, UTF-8 or UTF-16.
    (If you are not sure which to choose, contact your System Administrator)
    Include Notes/Attachments/Documents
    Optionally, click the checkbox to include associated Notes, Attachments, and Documents in the export file. Besides including the documents and attachments, this will create a file (Documents.csv) with meta information about the documents, attachments, and notes.
  3. In the Email Address for Sending Notification section, complete the following information:
    Email Address
    Select the email address that will receive the link to the backup files
  4. In the Objects for Data Export section, complete the following information:
    Include All Data
    Checkbox, selected by default
    Optionally, uncheck the Include All Data checkbox Checkboxicon.gif icon, and select individual object(s) to export
  5. Click [Save] to trigger the export process, or click the [Cancel] button to stop the action

When the export is complete, an email message is sent to the specified address. A link to a .zip file is included in the message. The recipient can download the compressed file by following the link. (A login to the platform is required.)

To view the data on a local computer, uncompress the .zip file, using any standard data compression program. The uncompressed data file is in CSV format, which can be viewed using a standard database or spreadsheet application.

Monitoring Export Status

The export process is tracked in the Export Queue. To monitor its progress, click the Refresh icon. RefreshIcon.png

As the export progresses, you may see the following status conditions:

  • In Processing Queue is displayed when you start the export
  • When a file has been exported successfully, it's status will be Completed
  • An export that fails will show an error message, for example: Data Export - Error encountered while processing Accounts
Considerations
  • Exported data will be automatically deleted after 7 days
  • One export per week is permitted
  • Initiating a data export schedules the job for immediate execution (there is no automated scheduling mechanism)
  • The exported data will be counted as part of the document storage space used (be sure to empty the Recycle Bin periodically, in case storage is an issue); When Documents (file attachments) are included in the export, storage management is especially important
  • User and Team identifiers are included in the file (Role information is not exported)
  • Date Created, Date Modified, Created Id and Modified Id will be exported
  • Exporting the audit log generates two .csv files:
  1. A database dump of all the logs (AuditLog.csv)
  2. A database dump of all the log codes (LogCodes.csv). This file is for auxiliary information.

Both files have common columns (type, operation) which can be used in a defined join to get more information