New Project Importer from File new-project-importer-from-file
This section describes a functionality to bulk-import a set of locations from a CSV/XLS spreadsheet to your AEM Screens project.
Introduction introduction
When you are setting up an AEM Screens project for the first time in your organization, create all the locations too. If your project involves many locations, it results in a tedious task that involves much selecting and waiting in the UI.
The goal of this feature is to reduce the time required to set up the project and thus resolve budgeting issues.
By letting the author provide a spreadsheet as an input file, and letting the system automatically create the location tree in the back-end, this feature:
- achieves way better performance than manually selecting through the UI
- lets customer export the locations they have from their own system and easily import them directly in AEM
This saves both time and money during initial project setup or when extending the existing AEM Screens to new locations.
Architectural Overview architectural-overview
The following diagram showcases the architectural overview for Project Importer feature:
Data Model data-model
The data model for Project Importer is described below:
path {string*}[./jcr:title] {string*}template {string}[./jcr:description] {string}The spreadsheet (CSV/XLS) file thus requires the following columns:
- path {string} – The path for the location to be imported, where the root of the path is the location folder for the project (that is,
/foois imported to/content/screens/<project>/locations/foo) - template {string} – The template to use for the new location, for now the only allowed value is “location”, but this will be extended to all the Screens templates in the future (
display,sequencechannel, and so on) - [./*] {string} – Any optional property to be set on the location (that is,
./jcr:title,./jcr:description,./foo, ./bar). The current release allows no filtering.
Using Project Importer using-project-importer
The following section describes how the Project Importer is used in an AEM Screens project.
- Files other than CSV/XLS/XLSX extensions are not supported in the current release.
- No filtering of the properties exists for imported files and anything starting with “./” is imported.
Prerequisites prerequisites
-
Create a project titled as DemoProjectImport
-
Use a sample CSV or Excel file that you must import.
For demo purposes, you can download an excel file from the section below.
Importing the file with minimum required fields importing-the-file-with-minimum-required-fields
Follow the steps below to import a file to a location folder with minimum required fields:
-
Navigate to your AEM Screens project (DemoProjectImport).
-
Click the project,** DemoProjectImporter > Create > Import Locations** from the side bar.
-
The Import wizard is displayed. Click the file for your project with locations or click the file (minimal-file.xls) you downloaded from the Prerequisites section.
After you have selected the file, click Next.
-
Verify the content of the file (locations) from the Import wizard and click Import.
-
As a result, you can now view all the locations imported to your project.
