Imports

Learn how to import Configuration and Data items

What can you import?

DICEFlow allows you to import 2 sets of information:

  1. Configuration (Workflow Types, Report Types, Language definitions) items &

  2. Datasets (Locations, Users, Members, Groups)

Import of various Configuration items is explained below. Language import is defined in this page.

Configuration

Here, we will explain how you can import Configuration items. The following Configuration items are allowed to be exported/imported

  1. Workflow Types

  2. Report Types

  3. Language Translations

Before we go into the details

Note the highlighted icons oh the left hand side image, which you will see sprinkled across the Configuration pages which is an indication whether that entity is export-able or import-able

Only PUBLISHED version of the Workflow is exported; If your flowchart is still in TEST (Beta) state, export will prompt if you want to export the Beta version

Export Workflow Type

Who: Superuser and Users with Write permissions in the Workflows Configuration permission

How to: Go to Workflows > Configuration page; Click on the More (vertical 3-dots button) in the Workflow Type card which you are interested in > Click on Export icon

What happens: Selected Workflow type gets exported in the form of a .json file; Save it so you can import it into another Organisation/Project

What is included in the .json file: Defined Description, Statuses, Customfields, Flowchart of the Workflow type. Also, included is ANY affiliated Member or Group type of the selected Workflow type; If there is a reference to a Static Data structure, that is also included in the .json file

When not to use: If you just want to duplicate a workflow type in the same account, you should use the Duplicate action in the Workflow type More button

Hit Add to add the Workflow type as defined in the selected .json file

Import Workflow Type

Who: Superuser and Users with Write permissions in the Workflows Configuration permission

How to: Go to Workflows > Configuration page; Click on the Import button near the Workflow Types title of the LHS Panel

What happens: You will be asked to select a file from your system; Assuming you have previously exported a .json file; Select the correct Workflow Type .json file from your system; You will be presented with a form as shown in the left; Lets understand the same:

  1. Name: Name of the Workflow type you are going to create via the import; This must not be the same as any existing Workflow type

  2. Project: Project in which the Workflow type is to be created; We have selected I4We Urban

  3. Link to existing member type: The workflow type we have chosen to import is affiliated to a Member type; So, it will show ALL Member Types defined in the selected Project type;

  4. Member Type (or Group Type): We have selected Family Member (Urban); This field will not be shown if you chose an Unaffiliated workflow to be imported; If you disable this field in case of an Affiliated workflow, the Member or Group Type included in the .json file will be newly created

  5. Static Data: This Workflow type has a linked Static Data structure which is a list of Schemes; You can chose to import that as well

Hit Show link next to Validation

Import done, what now?

Say, you imported a Workflow type of one project into another project in the same or different Organisation account. Some points to check would be:

  1. Validate the flowchart using the Validation > Show button under More menu on top right hand corner

  2. Fix all the errors shown in the Validation result; There will be adjustments you will have to make wherever the flowchart refers to entities of the source project; For example, Flowchart might be referring to a Member type of the source project and you will have to fix it to use Member type of target project

  3. Make sure affiliated Member/Group type (if newly created during the import) is correctly defined as per your needed in the target project

  4. Make sure permissions to this newly imported Workflow type is set properly

  5. Finally, test the Workflow type as a user role who will be executing that Workflow; You can catch any other errors in this way

Marketplace on the extreme right

What more can you do with the Workflow type .json (export) file?

The .json file can be shared with other Organisations via the DICEFlow Marketplace. This way, you can share your Workflow logic and data with the other users in the DICEFlow world. You can access Marketplace from the Shopping Cart icon on the Workflows page when you are logged in as Superuser.


Import and Export buttons in Reports > Configuration > Selected Report Type

Export Report Type

Who: Superuser and Users with Write permissions in the Reports Configuration permission

How to: Go to Reports > Configuration page; Click on the More (vertical 3-dots button) in the Report Type card which you are interested in > Click on Export icon

What happens: Selected Report type gets exported in the form of a .json file; Save it so you can import it into another Organisation/Project

What is included in the .json file: Report Name and Report flowchart

When not to use: If you just want to duplicate a Report type in the same account, you should use the Duplicate action in the Report type More button

Hit Add to add the Report type as defined in the selected .json file

Import Report Type

Who: Superuser and Users with Write permissions in the Reports Configuration permission

How to: Go to Reports > Configuration page; Click on the Import button near the Report Types title of the LHS Panel

What happens: You will be asked to select a file from your system; Assuming you have previously exported a .json file; Select the correct Report Type .json file from your system; You will be presented with a form as shown in the left; Lets understand the same:

  1. Name: Name of the Report type you are going to create via the import; This must not be the same as any existing Report type

  2. Project: Project in which the Report type is to be created; We have selected Education

  3. Hit Add to add the Report type as defined in the selected .json file

Hit Add to add the Report type as defined in the selected .json file

Import done, what now?

Say, you imported a Report type of one project into another project in the same or different Organisation account. Some points to check would be:

  1. Validate the Report flowchart using the Go to Flowchart > Validation > Show button under More menu on top right hand corner

  2. Fix all the errors shown in the Validation result; There will be adjustments you will have to make wherever the flowchart refers to entities of the source project; For example, Flowchart might be referring to a Member type of the source project and you will have to fix it to use Member type of target project

  3. Make sure permissions to this newly imported Workflow type is set properly

  4. Finally, test the Report type as a user role who will be adding a Report; You can catch any other errors in this way