Content Export Import Tool

  0 rating
8/24/2017 9:00:30 PM
2/19/2020 1:51:40 PM
Source: Github

About

Latest version is 8.0


The latest release may not yet be available here; Download the .zip file from Github to make sure you have the most recent version.


This module allows Sitecore users to easily export large amounts of data from the Sitecore content tree. Use this tool to easily find the locations of all items of a particular template type; retrieve the fields values of thousands of items at once; get all of the items that exist in a particular folder; and more.   


Content Audits

The Content Export/Import Tool offers many options for running custom and highly specified content exports, as well as template and component audits as well. Numerous options for filtering and selecting data to report allows users to easily generate detailed reports and audit Sitecore content.


Content Editing/Creation made easy

With the latest update to the Content Export/Import Tool, you can now edit and create Sitecore content easily by simply uploading a CSV file!


Package Export (7.0+)

The new Package Export feature introducted in version 7 allows the user to generate a package using the item selection/filtering options provided by the Content Export. This makes it easy to package a large amount of items based on specific parameters without having to manually select all items (e.g. package all items of a certain template), and provides the option to also package all related items of all items selected for the package.

What can you do with the Content Export/Import Tool?
* Comprehensive audits of Sitecore content:
* All of the items under a particular path
        * All of the items of a particular template (multiple templates can be selected in one report)
        * All of the items that contain a word or phrase in specified fields or any field (this can be done
           using the Advanced Search feature) (can be used in tandem with the starting path and
           template filter)
        * The content of particular (or all) fields of all items (under the specified starting path and/or
           of the specified template types)

* Search Sitecore content
        * Use the advanced search to find the Sitecore path of an item you are looking for by searching
           by title, or by keywords in the item's fields


* Edit, create, or delete Sitecore content in bulk

        * Edit/create/delete/publish huge numbers of items at once by uploading a CSV file


* Create a package of all exported items, with option to include related items and subitems


* Edit rendering positions, placeholders, and rendering parameter field values


* Audit usage of Sitecore components and templates


Download the latest version, Content Export/Import Tool 8.0

** As of version 7.0, the Sitecore Item API is no longer needed for improved Browse performance!



Testimonial:


"I used the Content Export Tool to update field values quickly on over 80 Sitecore forms and their sub-items. Multiple different value changes needed to be made to hundreds of fields over more than 80 forms. The Content Export Tool was exceptionally useful in this scenario because a specific set of fields and their values, tied to the value of another field on the item, needed to be updated where updating Standard Values would've updated all of them. We were looking to apply CSS classes to this specific subset of Forms items. I was able to use the filters available on through the tool to target just the items I needed to change, export just the field values I needed to change, update the values quickly in the CSV, and then upload the updated CSV to update the field values for all those items. Doing the change by hand would've required at least several hours and greatly increased the risk of a mistake. I subsequently used the tool to make structure changes to the forms. We had a a specific Form field type that needed to be wrapped in a Forms Section. I used the tool to create the new sections (create), create duplicate items under the new section (move), and remove the old items (delete)."


- Matt Richardson, Principal Business Systems Analyst at Velir



*Important* If you are installing the latest version (8.0) and you currently have saved settings, install with the *merge* option or else your saved settings will be lost.

Tested with Sitecore 6.5 - 9.0*

*The latest release has not been tested on versions before Sitecore 8.2; if the installed module does not work for your Sitecore version, try an older release and please report the issue.


Documentation

Documentation
  • Documentation > DOWNLOAD AND INSTALLATION
    DOWNLOAD AND INSTALLATION

    Download Content Export Tool Update 7.6 for the latest version.

     

    In Sitecore, use the Installation Wizard to install Content Export Tool Update 20190924.zip


    Overwrite all static files.

     

    Merge all items when prompted.*


    *If you have previously installed the module, use Merge instead of Overwrite to preserve saved settings


    Once installed, the Content Export Tool icon will appear in the right side of the Start menu in Sitecore

    0
  • Documentation > HOW TO USE
    HOW TO USE 

    Visit https://ericastockwellalpert.wordpress.com/ to find the most up-to-date documentation, or watch my tutorials on Youtube.

    The tool allows the user to run exports ranging from minimal data to hundreds of fields. If the user clicks the Run Export button with no fields filled out/checked off, it will return a spreadsheet with the item path of every item in the Sitecore content tree. The following fields can be used to further customize the data:

    • Database – Select which database to retrieve content from. The Database dropdown is populated with all of the available databases for the website.
    • Include Ids – Check this box to include the Guid IDs of each item
    • Start Item – If this field is blank, the entire content tree will be scanned. If this field is populated, then the export will only include items beneath and including the item specified. Start Item can be specified by path or ID. The Start Item can be manually entered, or you can use the Browse button to search the content tree for the item you want (Browse can take a while to load).
    • Fast Query – Enter a fast query to select the items you want to export. This field overrides the Start Items. The tool will only export items returned by the fast query. You can use the Test button to see whether the query works and how many items it will return.
    • Templates – If this field is blank, all items under the start node will be included. If templates are selected, only items of the selected template types will be included. Templates can be specified by name or ID; if name is used, then if multiple templates have the same name, items of all templates with that name will be included. You can use the Browse button to choose template names from the Sitecore tree, or enter names or IDs manually.
    • Include Template Name – Check this box to include the template name of each item in the spreadsheet
    • Fields – Enter the names or IDs of all the fields that you want to get the values of. The tool determines the type of each field and handles the data accordingly; this can handle string, rich text, image, link, droplist, multilist, and checkbox fields. Fields names or IDs can be manually entered, or you can use Browse to select fields. If the Templates field is populated, then Browse will only suggest fields that belong to selected templates.
    • All Fields - Check this box to get all fields (not included __fields) of each item
    • Include linked item IDs – This will include the item ID for any field that links to an item, such as images, links, droplists, and multilists (the linked item path is returned by default).
    • Include raw HTML – This will include the raw HTML that is returned by image and link fields
    • Workflow – This includes the workflow that each item uses
    • Workflow State – This includes the current workflow state that the item is in
    • Get All Language Versions – This includes the language of each item
    Update 10182017
    • Multiple Start Items  This field allows multiple starting nodes to be selected, so that the user can retrieve content from two separate parts of the content tree in the same report
    • Include Templates that Inherit Selected Template – Check this box to include all items with a template type that inherits any of the selected templates. e.g. If 'Custom Page' and 'Event Page' both inherit 'Page,' if you select the 'Page' template and check this box, it will return all items of type Page, Custom Page, and Event Page
    • Date Created, Created By, Date Modified, Modified By, Never Publish – Returns the values of these standard Sitecore fields
    • Include Name​​ – ​Includes the item name

    Settings can be saved in case you want to run the same export multiple times. The Save Settings button will save the current configuration (you must enter a name to save as first). Selecting settings from the dropdown will populate all of the fields based on the saved configuration. You can delete a saved configuration when it is currently selected using the Delete button. You cannot save multiple configurations with the same name, but if you want to overwrite an existing configuration, you can enter the name of that configuration and click Save Settings (you will be prompted to confirm whether you want to overwrite).

    Advanced Search
    Export all items that contain the search text in a field. 
    By default, this will check ALL fields on each item.
    Advanced search will use the starting node specified in the Start Item box.

    IMPORT

    The Edit Items button will only edit existing items (found using the Item Path) and will ignore items that are not found. 

    Required CSV column: Item Path

    The Create Items button will create new items under the Item Path. An item will be created even if an item with the same path already exists, unless you check off "Do not create duplicates"

    Required CSV columns: Item Path, Template, Name

    Item Path and Template can contain a sitecore path or Guid ID

    Example:

    Item Path  Template Name Navigation Title
     /sitecore/content/products /sitecore/templates/pages/product page

    New Product New Product!  
     {C4C4E8A7-0AAB-44E3-A6B7-B50CDBA2D8C8}  {C4C4E8A7-0AAB-44E3-A6B7-B50CDBA2D8C8} New Product 2 Another New Product  

     

     

    • Files must be uploaded in csv format
    • Add a column for every field that you want to add/change content for with the field name or ID (e.g. replace Field1 in the example template with a valid field name)
    • Field names must be an exact match (not case sensitive)
    • If you are editing content, it is recommended to export all the items with all fields you want to modify first, edit that file and then upload it
    • If you are modifying existing content, for best results run an export on that content first, make your changes in the downloaded file and re-upload that file to import.

    • To edit content, Item Path must be the path of the item you with to edit.
    • To create content, the Item Path must be the path of the parent item you wish to create the new item under (parent item must already exist);
      • Name and Template must be specified for creating items
      • Name and Template are not necessary for editing items
    • Note: The import function currently supports string, image, and link fields. It does not support more complex field types, such as droplists or multilists.

     

    RENDERING PARAMETERS IMPORT

    Files must be uploaded in csv format

    Supported CSV Headers:

    • Item Path - This column should contain the item path or ID. 
    • Apply to All SubitemsApply the changes on this line to the item and all subitems, defaults to false (TRUE/FALSE)
    • Template - With Apply to All Subitems, apply the changes only to items with the specified template name or ID. This field is ignored when Apply to All Subitems is not true
    • Component Name - The name or ID of the component to modify. If this is not specified, no changes will be made
    • When Placeholder Equals - Modify a component within this particular placeholder
    • Nth of Type - Modify the Nth component with the specified name (NUMERIC, STARTS AT 1)
      • With When Placeholder Equals, modify the Nth component within the specified placeholder with the specified name
    • Parameter Name - The name of the rendering parameter to modify or add
    • Value - The value to set for the rendering parameter
    • Placeholder - The placeholder to move the rendering to
    • Position - The position to put the rendering in relative to all other renderings (NUMERIC, STARTS AT 0)
    • Position in Placeholder - The position to put the rendering in relative to its placeholder (NUMERIC, STARTS AT 0)
    • Before - The name of the FIRST rendering to put this rendering before
    • After - The name of the LAST rendering to put this rendering after

    1
  • Documentation > DEPENDENCIES
    DEPENDENCIES
    The Content Export tool references the following assemblies: 
    • System
    • System.Collections.Generic
    • System.IO
    • System.Linq
    • System.Net
    • System.Text
    • System.Web
    • System.Web.Script.Serialization
    • Sitecore
    • Sitecore.Collections
    • Sitecore.Data
    • Sitecore.Data.Fields
    • Sitecore.Data.Items
    • Sitecore.Data.Managers
    • Sitecore.Globalization
    2
  • Documentation > VIDEO TUTORIAL
    VIDEO TUTORIAL
    3
Back
Release notes
Revision 1.0 - improvements to Saved Settings functionality

Revision 1.5 - Added option for multiple start nodes, checkbox to only include items that have a layout 

Revision 2.0 - Added Sitecore Item API to improve performance with the Browse feature. This requires enabling the Sitecore Item API in your App_Config/Include in order to use, however the Browse feature will still work without making this change

Revision 3.0 - Bug fix to Browse Templates feature

Revision 4.0 - Added Language Selection option to get items of one selected language version

Revision 4.5 - Added loading spinner to improve user experience

Revision 5.0 - New features: Advanced Search and "All Fields" checkbox; Moved path to resolve issue with security permissions on admin folder

Revision 5.1 - New feature: Date range filters for created and modified dates. Improved browse functionality: enabled double-clicking to select items in browse modal. Fixed bug with Multiple Starting Paths

Revision 5.2 - Critical bug fix - tool broken in 6.5 by the new data fields, update 5.2 fixes this issue as well as an issue with the API-enabled browse

Release 6.0 (Content Export/Import Tool) - added importing functionality to create/edit items using a CSV file; fixed a few bugs with Raw HTML, Workflow checkboxes

Update 6.1 - Removed Sitecore Item API and made improvements to browse performance; updated Saved Settings to use a Sitecore Item to store settings rather than a txt file;
added language specification ability to Import tool

Release 7.0 - New features: Package Export, Component Audit, Template Audit

Update 7.1 - Restructured page layout; Author filters

Update 7.2 - Bug fix for browse feature; improved browse feature

Update 7.3 - Bug fix for CSV output when multiple fields share the same text

Update 7.4 - Added Exclude Templates field; bug fix for selected database in Browse modals

Update 7.6 - Added Publish and Delete Import methods, plus option to publish items during the Edit/Create Imports; additional standard field options

Update 7.7 - Added support for Branch Templates to the Import process

Release 8.0 - New Feature: Rendering Parameters Import

Read more Back
Code examples

Solution screenshots(0)

Upload

Reviews (0)

Sort by: Date Most votes
  • Profile Avatar
    [fullName]

    Level: 0

    x0 x0 x0

    [date]

    [title]

    [text]

    Was this helpful?

    0

Comments (0)

Sort by: Date  Most votes

Leave a Comment

Comment must be field in
Post comment
loader

Write a review

Title can't be empty
Review can't be empty
Post review

Download

Title Description Download Action

Add File