Admin: Download Organizations
  • 4 Minutes to read
  • Dark
    Light

Admin: Download Organizations

  • Dark
    Light

Article Summary

Download existing organizations that you want to copy to another system, tenant, or organization.

The columns downloaded do not match the columns that display in the list view.
You can change the columns that display in the list view using the customize columns feature but the file that downloads on this page will include special columns needed for uploading organizations, regardless of what displays in the list view.

lightbulbIf you want to UPLOAD several organizations along with their properties (other than dictation topic), download the organization levels one at a time so that the properties will be included in your downloaded file. (TIP: Companies have no properties, and division properties are not applicable if your organization signs in with SSO accounts, so you may just need group properties.)


  1. Go to the Organizations page in nVoq.Administrator.
    UploadOrgs-go-to-organization-page

  2. Click on the parent organization of the one that you want to download in the organization list. For example, if you want to download companies, click on the tenant. If you want to download groups, click on the division.
    DownloadOrgs-select-parent

  3. Select the organization level that you want to download from the View Organization Level menu. For example, if you want to download companies, make sure "company" is selected on this menu. If you want to download groups, make sure "group" is selected.
    DownloadOrgs-select-level

  4. In the list view select the organization(s) that you want to download.
    DownloadOrgs-select-orgs

  5. Click the Download Organizations icon in the blue toolbar.
    DownloadOrgs-select-download-icon

  6. In the Download dialog box that opens, select the radio button for the organizations that you want to download.
    DownloadOrgs-select-download-option
    • All organizations listed - This will download a file that includes all of the organizations in the list view. The file will include properties that are configured for the organizations at the level your are viewing. 
    • All organizations listed and children - This will download a file that includes all of the organizations in the list view and their child organizations.
    • Selected organizations - This will download a file of only the selected organization(s). The file will include properties that are configured for the organizations at the level you are viewing. 
    • Selected organizations and children - This will download a file of the selected organization(s) and all of their child organizations.

  7. Click the Download button.
    DownloadOrgs-select-download-button

  8. A CSV (organizations.csv) file is downloaded in the browser.
    DownloadOrgs-download-file

  9. The downloaded includes the following columns:
    DownloadOrgs-download-file-divisions
    • Don't change any of these headers! - This is just information letting you know not to remove or change any of the column names in the top row. 
    • Unique index (use any number) - Numbers assigned to each organization
    • Name - The name of the organization
    • Level - The level of the organization (company, division, or group)
    • Parent index (point to unique index) - The number (from the Unique Index column) assigned to the organization that should be the parent of this organization. If you downloaded only one organization level this field will be blank.
    • Enabled - This lists whether or not the organization is enabled (yes or no).
    • Properties (optional) -What is listed here depends on the organizations that were downloaded. 
      • If you downloaded one organization level at a time (by selecting "All organizations listed" or "Selected organizations," you will see the properties configured for the organizations at that level. 
      • If you downloaded "All organizations listed and children" or "Selected organizations and children," you will only see the Topic configured for the groups here.
  10. Make any necessary changes to the file before you upload it, such as changing organizations names or properties. For information about how to use the columns in the file, see Upload Organizations: How to Use the Organization Template

  11. Next, upload your file!
The Voice Shortcut Hotkey property is not included in the downloaded file for groups.
Voice shortcuts are not used by any nVoq application at this time and are not included in the downloaded file for group organizations. However, if you want to include that property when uploading group organizations, the property is 

"qnHotKey":"F3".  If you wanted to also include a modifier key such as the Ctrl key, that is "qnHotKeyModifiers":"ctrl". You can include more than one modifier, such as "ctrl alt". If you do that, users will have to press three keys (the hotkey and two modifiers) to record dictation. For more information about these properties, see Upload Organizations: Group Level Properties.