Resident data extraction

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

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.

Download the tool, in zip format:

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.

Run the file run.cmd.

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

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