The Import/Export definitions overview screen in ReflexBlue
The Import/Export Definitions overview screen in ReflexBlue allows you to manage import and export definitions. Here, you can create, edit, search, filter, and sort definitions.
You can open the Import/Export Definitions overview screen in one of the following ways:
- Open the menu in ReflexBlue using the Ctrl+~ keyboard shortcut. Then select Management > Imports/Exports > Import/Export definitions.
- Or select this link to open the screen directly.
Screen layout
In the Import/Export Definitions overview screen, you see a list of all created import and export definitions. You can sort the list by selecting a column header.
| Name | Description |
|---|---|
| Name | The name of the import/export definition. |
| Type | The type of the definition. |
| Description | A short description of the definition. |
Select Refresh to update the list with the most recent data.
Creating a new import or export definition
Follow these steps to create a new definition:
-
Select Add Import/Export Definition in the overview screen.
-
Choose the type of definition based on the data you want to import or export.
-
The detail screen opens. Enter the details of the definition here.
-
Fill in the required fields on the General tab:
Name Description Name The name of the definition. Description A description. Is active Indicates whether the definition is active. Depending on the type of definition, there may be additional fields or settings you can fill in or adjust. For each block definition of the import/export, there is a separate tab, often with additional settings.
Some definitions contain a script in the C# programming language that is executed during the import or export of data. This allows you, for example, to adjust the format of the export file and the exported data. By default, a script is present, but you may modify it yourself.
-
Select Save to save the definition.
Editing a definition
Follow these steps to edit an existing definition:
- In the Import/Export Definitions overview screen, select the definition you want to edit.
- Select Change Import/Export Definition.
- The detail screen opens. Adjust the desired data.
- Select Save to save the changes.
When editing import/export definitions, a revision history is automatically maintained. If something goes wrong, you can always revert to a previous revision.
Deleting a definition
Follow these steps to delete a definition:
- In the Import/Export Definitions overview screen, select the definition you want to delete.
- Select Remove Import/Export Definition.
- Confirm that you want to delete the definition.
- The definition is deleted (deactivated) and is no longer visible in the overview.
Exporting a definition
You can export definitions to save them, share them, or reuse them in other ReflexBlue administrations. Definitions are exported as a JSON file. Follow these steps:
- In the Import/Export Definitions overview screen, select the desired definition.
- Select Export Definition.
- Save the exported file.
Importing a definition
You can import definitions to quickly apply settings and ensure consistency. Follow these steps:
- In the Import/Export Definitions overview screen, select Import Definition.
- Select the JSON file containing the definition’s settings.
- Select Save to save the definition.
Creating an export
Follow these steps to create an export based on an existing export definition:
- In the Import/Export Definitions overview screen, select the export definition for which you want to create an export.
- Select Create export.
- The export is created and the Imports/Exports overview screen opens.
- Start the export in the Imports/Exports overview screen.
Managing revisions
If you want to restore a previous version of a definition, follow these steps:
- In the Import/Export Definitions overview screen, select the desired definition.
- The detail screen opens.
- Go to the Revision history tab.
- Select Open revision on the desired revision.
- Check Is active to activate this revision.
- Select Save.
- Confirm that you want to set this revision as the current version.
Managing notifications
Would you like to send a notification to one or more users after importing or exporting? Then set up an email template:
- In the Import/Export Definitions overview screen, select the desired definition.
- The detail screen opens.
- Go to the Notifications tab.
- Select an Email template for the notification.
- Select Add user to add users.
- Select Delete users to remove users.
- Select Save to save the changes.
Filtering data
In the Import/Export Definitions overview screen, you can filter or search based on various criteria. The table below gives an overview of the filters available for filtering import/export definitions.
| Name | Description |
|---|---|
| Active/Inactive filter | Filters based on active or inactive definitions. |
| Name | Filters based on the name of the definition. |