Resident data extraction

This tool allows you to extract data from all residents for a client.

Prerequisite

A user with access to the SOFI API whose “access key” and “secret” you know is required, otherwise you can create this API user yourself.

Make sure that the user for the API has the Login to API Authorized checkbox checked and that the access group for that user has all the rights required to use this tool, see below.
For security reasons, create a different user in the residence(s) for each tool with access rights limited to that tool only.

Installation

Download the tool, in zip format:

Access the gm-sofi-data-extact project packages in Git (https://gitlab.telemedic.ca/client-tools/gm-sofi-data-extract/-/packages).
Select the desired version of the tool.
Select the desired package (this will download the tool in zip format).
Create a folder tree (ex: c:\telemedic\dataextracttool), then :
Extract the tool into this folder.

Configuration

In the sub-folder config, create the file local.json.

Edit the local.json file to configure:

The SOFI address of the residence website (url).
The user's API key (apiaccesskey).
The user's API secret (apisecret).

ex. :

{
"Companies":[
                {
                    "url": "https://clientsite1.telemedic.ca",
                    "apiUsername": "COMPANY1_API_ACCESS_KEY",
                    "apiPassword": "API_SECRET",
                },
                {
                    "url": "https://clientsite2.telemedic.ca",
                    "apiUsername": "COMPANY1_API_ACCESS_KEY",
                    "apiPassword": "API_SECRET",
                }
            ]
}

Configuration examples are available in the local.example.json file.

Use

Run the file run.cmd.

The results are exported in a file which is put in the sub-folder “output”.

Required rights

Module	Right
Admin	View
Residence Admin	View
Archive	View
Evaluation	View
Incident Accident	View
Work plan	View
General info	View
User Account Management	View