Skip to content

Latest commit

 

History

History
149 lines (119 loc) · 6.79 KB

import-export-json-files.md

File metadata and controls

149 lines (119 loc) · 6.79 KB
id title date version lastAuthor mimeType links source wikigdrive
13Oulcj0nZoB3rk_Fc-Fd4FxrUr5Di_UXZM45NP3tde4
Import/Export JSON Files
2021-08-26T12:03:20.282Z
76
text/x-markdown
0008bcbb1563384efe0a28ada6f97e9432e65f10

The {{% system-name %}} system allows users to create, import, and export JSON files from one database to another. Users with the appropriate permissions can create JSON files from the system, using the System Configuration tab of the Control Panel. This allows administrators to easily review, approve, and export a JSON file from one {{% system-name %}} system (e.g., DEV, QA, etc.) and easily import into another  {{% system-name %}} system (e.g, PROD), avoiding duplicative work and ensuring consistency. For example, if a client needs several document types created (e.g., 2 Forms, 2 Word templates, 1 Consent doctype, and 1 HIPAA doctype) for an interface, these documents can be created and tested in a Development or QA environment and then easily migrated into a Production database using the JSON export/import tool, also known as the System Configurator.

Users with proper permissions can create JSON files of the following sections/modules:

Abbreviations Document Types Health Surveillance Observation Flowsheets Scripted Logic & Scripted Rules
Apt Types Drug Aliases Kits Order List Security Roles
AutoComplete Fields Drug Indications Language Translations Order Pick List Stations
Chart Tabs Drug Reactions Layouts Partitions System Files
Chart Types Encounter Exams Libraries Print Definitions System Reports
Common Scripts Encounter Types Locations Refer to Systems System Settings
Common Sigs Esign Rules Menu Editor Restriction Types Tasklist Events
Custom Allergies Fast Tasks My Settings Scheduled Jobs Term Replacement
Departments Frequencies Observation Codes Schedules User Portlets

Creating a JSON File for Export

In order to create a JSON file for export, the logged-in user must have the appropriate permissions to access and utilize the System Configuration tab of the Control Panel. Once access has been granted, the user may perform the following:

  1. From the export database (i.e., the database from which the JSON file is being exported), navigate to the Control Panel.
  2. Go to the System Configuration tab.

  1. Select the module(s) needed for export from the database. It is permissible to select multiple modules for one JSON file.

  1. After selecting the module(s), click the Search button.
  2. A ListView will display for each of the modules selected. Users may choose to scroll through the page, marking each individual item for export, as needed; otherwise, there are two quick links available to Jump to Bottom of each ListView, or jump to the Bottom of Page.

  1. Unless all items within each module need to be exported, be sure to click the Uncheck All [Module Name]' button and select all of the items to be exported, individually.

{{% tip %}} For larger lists, use Ctrl + F to find specific words/phrases/spellings in the page. {{% /tip %}}

  1. When finished selecting all of the items for export, go to the bottom of the page and provide a meaningful name for the export file and click the Export button.

  1. A message will display at the bottom of the screen, prompting the user to Save the file, or Cancel. Select Save to create the file for export.

If the file has been saved, another message will display at the bottom of the screen allowing the user to open the file, or containing folder, once the file finishes saving.

{{% note %}} The user who creates the file for export must test the file in another system to ensure the correct data is contained therein. Testing the import file should always be done prior to adding the file to the work ticket. {{% /note %}}

Import a JSON File

Once the necessary JSON file has been created and exported from the {{% system-name %}} system, any user with the proper security permissions may import the file to the new, or alternative, system. The JSON file should be copied to the computer; however, the file does not have to be created on the computer. For this reason, the file may be delivered via a Redmine ticket, sent via email, available on a share drive, etc.

{{% warning %}} There can be issues if exporting and importing to different database versions. Always check with the Subject Matter Expert, if unsure. {{% /warning %}}

  1. From the import database (i.e., the database into which the JSON file is being imported), navigate to the Control Panel.

  2. Go to the System Configuration tab.

  3. Click the Import link in the upper-right corner of the page.

There are several import options available. The following instructions will focus on the process for importing a saved file.

  1. After navigating to the Import screen, click the Choose File button and browse to the JSON file.

  1. Select and Open the JSON file. A status window will appear, briefly.

  1. Once the file has loaded, users will want to select the link to Jump to Bottom.
  2. With all of the necessary files selected, click the Import Selected button at the bottom of the page.
  3. A status window will appear, displaying the progress of the importing of the JSON file. When all columns are green, the import is complete.

  1. Test the import, immediately upon completion, to ensure proper functionality.