Exporting ShareDo Configuration

Gain insight into how to export ShareDo configuration and use it to apply settings across multiple systems.

Introduction

Within the ShareDo work type modeller, you can create work type definitions, participants, and many other items to suit your unique needs. You can then export your unique configuration as a solution export package using the Solution modeller.

A typical solution package might contain items such as those listed in the table below.

The items listed here are some of the typically selected configurations but not all possible items. Exporting everything is not recommended. The recommended items to export would be those configurations you have made that are unique to your implementation.

 
Package item Item description
Work Types Configuration of the work types (hierarchy of your work types: matters/cases), including portal definitions, phase plans and other associated items.
Forms Configuration of relevant data capture elements for a specific work item.
Workflows Includes any work type, specific workflows and triggers.
Feature Configuration Configuration of specific features.
Documents Related document and email templates.

Other items commonly exported are:

  • Option sets
  • Participants
  • Permissions and new permission sets
  • Personas
  • Service portfolios
  • Search scopes that you created or changed
  • List views
  • Calculated fields
  • Developer IDE: any custom work done here
  • Allocation rules/approvals
  • Matching rules
  • Maintenance plans
  • Notification types
  • Themes

Document Template Source Files

Source files for document templates cannot be chosen in the package configuration column. They are shown as recommended dependencies when you choose a document template that contains files like Microsoft Word files (.docx). If you choose to include them in your export package, they will show in the package contents column.

 

How to use Export Configuration

The Export Configuration screen allows you to select configurations in your system to export as a package or load export sets stored previously to edit and reexport.

Load stored export sets

You can load an existing export set by selecting one from the drop-down menu and clicking the load export definition icon .

You can delete the stored set using the red trash icon and rename and save the loaded set with the green save icon. Once you have a loaded set, you can edit the items in the package and export this new package.

Selecting export package items

As you select items for the package configuration in the left-hand column, the package contents column in the middle shows what will be included in the export package. The right-hand column shows mandatory and recommended dependencies

Use the add all link to add dependencies for each group

Select an item in the package contents column to see only its dependencies on the right. Add all mandatory dependencies and any recommended dependencies you choose to the package.

Package export success is not dependent on all the mandatory dependencies being included. Items listed as mandatory dependencies are listed as such for the import to another ShareDo environment to be complete.

 

Export configuration ribbon

Ribbon button Description
Show All Dependencies Clicking this toggle button shows or hides both mandatory and recommended dependencies.
Upload Selections You can load a set of selected package configuration items that are stored as a JSON file by clicking the Upload Selections button and choosing the JSON file you saved using the Download Selections function.
Download Selections Use the Download Selections button to save a copy of your package configuration selections as a JSON file that you can reload later using the Upload Selections function. This is useful, for example, when you have made a selection but need to exit the solution modeller for a time.
View Jobs This opens a blade listing previously performed export jobs. Selecting a job opens its Job Progress blade, showing the status and allowing you to view full details, run the export again, or download the package.
Execute  Starts the package export and opens the Job Progress blade, showing the status and allowing you to view full details, run the export again, or download the package.

Important considerations

  • Carefully consider what has changed in your system and how those changes may have affected anything else. You need to include something affected by changes like this to avoid problems importing the package.
  • It is good practice to save a copy of the export package. That way, when you next need to do the export, you can compare them to see if there are any differences.

Like everything else in ShareDo, this functionality can be accessed via APIs and can be integrated with Continuous Deployment processes if required.