Export
The Export page on the Admin Portal allows you to export documents, schedule templates, export templates, and system settings to a zip (compressed) folder along with its associated files. This is extremely helpful when migrating Wyn Enterprise to a different environment or creating a backup of the Wyn Enterprise Server data.
For an easy and smooth migration process, Wyn Enterprise provides you with import and export functionalities. These functionalities differ from the document upload and download functions where only the selected documents are uploaded or downloaded. In this article, you will learn about the different items you can export through the Export page and the basic steps involved.
Tabs
On the Export page, there are several tabs listing different items you can export. See the below table to learn more about each tab on the Export page.
Tab | Description |
|---|---|
Document | Includes the Wyn Enterprise documents organized based on their types and categories. See the Manage Documents by Type and Manage Documents by Category for more information. |
Schedule Templates | Consists of schedule templates available on the server, both built-in and custom. Note that only users with the admin role can create custom templates in Wyn Enterprise. For more information on how to create a custom schedule template, see this article. |
Export Templates | Consists of export templates that are specifically designed for managing the exporting capabilities of reports. It includes both built-in and custom export templates. Note that only users with the admin role can create custom export templates in Wyn Enterprise. For more information on how to create a custom export template, see this article. |
Custom Theme | Lists the custom themes used to enhance the overall appearance of reports and dashboards. For more information on how to create a custom theme, see this article. |
System Settings | Contains the system-level configuration settings which are responsible for the smooth functioning of the Wyn Enterprise Server. These settings include UI settings (includes portal and login page settings), dashboard settings, reports settings, worker queue settings, schedule settings, security providers, categories, default document theme, roles, and security settings. |
User Functions | Consists of user functions defined in CSharp and Visual Basic. For more information, please see User Functions article. |
To Export
Use the below steps to export item(s) using the Export page on the Admin Portal.
On the Admin Portal, navigate to System Management >> Export page.
From the Export Documents window, select a tab i.e. Documents, System Settings, Schedule Templates, Export Templates, Custom Themes, Custom Language Packages, and User Functions.
Like in the Documents tab, click the Select Documents option. Select Documents popup will appear on your screen.
You can export the documents based on their assigned category or type from the Select Documents popup. On the Select Documents popup, navigate to the Categories or Types tab from the left sidebar and use the checkbox to select one or more categories or document types. Use the search bar to find a specific document, select it, and click Ok.
Now on the Export page, select the referenced documents to be exported with the selected documents from the Export referenced documents dropdown. By default, All referenced documents are selected. You can uncheck the checkboxes corresponding to the referenced documents that you do not want to export along with the selected documents.
To export the permissions along with the selected document(s), enable the Export document permissions using the checkbox and click the Export button on the bottom-left corner of the page. By default, the Export document permissions option is unchecked. The selected documents and their referenced documents along with their permissions and the referenced documents are downloaded to a zip (compressed) folder.
Note: The reference relationships of the exported documents will always be exported even if the referenced documents are not exported.
Also, if one type of reference document is set not to be exported, then the referenced documents of this type of document will also not be exported. For example, if the customer specifies that don't export the referenced datasets, then the referenced data sources of these datasets also will not be exported.
In the unzipped folder, export.manifest file provides information regarding the exported item(s).
Export Scheduled Task
From Wyn release 8.0 onwards, you can export the scheduled tasks along with the document. When exporting the scheduled tasks, the resources they depend on like users, roles, all organizations, schedule templates (Pre-defined templates, and User-defined templates), context, and others will be exported together. You can export the scheduled tasks for the following documents:
Dashboard
Report
Document Binder
Cached Data Model (Refresh)
Cached Dataset (Refresh, Cleanup)
To export the scheduled task(s) related to the selected document, perform the following steps:
Select the document that you want to export.
Enable the Export scheduled tasks using the checkbox and click the Export button on the bottom-left corner of the page. By default, the Export scheduled tasks option is unchecked.
The resources such as scheduled templates associated with documents, all organizations, users, roles, contexts, and others will be exported together to a zip (compressed) folder.
Note: User tokens in the old tasks that were not migrated, will be migrated now when exporting.
Pagination Support for Document List
The Export feature supports pagination for the documents list. Documents are listed page-wise to help with easy navigation. You can select the number of documents to be displayed per page from the drop-down. Like here, we have selected 20 documents per page. If you want to go to a particular page, enter the page number in Go to and press Enter or click the page number, or you can use the Next Page/Previous Page arrows for navigation. This feature is available from Wyn version 6.1 onwards.
Navigate to the desired tab i.e. documents, system settings, schedule templates, export templates, custom themes, custom language packages, and user functions.
Like in the Documents tab, click the Select Documents option. Select Documents screen is displayed.
Click the document type. The list of the documents will be displayed on the right side. Select the checkboxes corresponding to the documents that you want to export. You can use the search box to find a specific item, select it, and then click OK.
Note: It supports pagination for the documents list. Documents are listed page-wise, so it helps in terms of overall navigation and the process of listing the documents is also faster. You can specify the number of documents to be displayed per page from the drop-down list. Like here, we have selected 20 documents per page. If you want to go to a particular page, you can enter the page number in Go to and press Enter or click the page number, or you can use the Next Page/Previous Page arrows. This feature is available from Wyn 6.1 onwards.
Now on the Export page, click the dropdown list Export referenced documents.
By default, All referenced documents are selected. You can uncheck the checkboxes corresponding to the referenced documents that you do not want to export along with the selected documents.
Note: The reference relationships of the exported documents will always be exported even if the referenced documents are not exported.
Also, if one type of reference document is set not to be exported, then the referenced documents of this type of document will also not be exported. For example, if the customer specifies that don't export the referenced datasets, then the referenced data sources of these datasets also will not be exported.
Select the checkbox Export document permissions, to export the permissions related to the selected document(s). By default, this option is not selected. Now, click the Export button on the bottom-left corner of the page.
The selected documents and their associated files along with their permissions and the referenced documents are downloaded to a zip (compressed) folder.
You can Unzip the folder if required.
Note: The unzipped folder contains an export.manifest file that provides information regarding the exported item(s).