Table des matières

Count of active residents

Application to count active residents for a SOFI instance.

Prerequisite

The installation of Installation Node.js is required for the import tool to work properly.

The operation of this tool requires a user with the rights and key to have the authorization to access SOFI.

You must create employee well identified in the SOFI instance with the key API and the secret used in the application needing access.

Installation

Extract the contents of the compressed file into a subdirectory at the root of the disk C:
(ex: c:\telemedic\Billing)

Create a directory “telemedic” in which you can extract the contents of the file and name the created directory “Billing”.

Configuration

A file named “ export-resident-count.config.js ” contains the residence configuration for the program.

Edit the export-resident-count.config.js file to add the key and secret and the SOFI address to access the residence. (Maintain the structure) ex. :

const config = {
  residences: [
    {
      _name: "Manoir",
      url: "https://siteduclient1.telemedic.ca",
      apiUsername: "COMPANY1_API_ACCESS_KEY",
      apiPassword: "API_SECRET",
      query:
        "/api/v2/Residents/$count?$filter=IsActive eq true and not(Id in (2139))",
    } ( , <- use a comma to add residencess )
  ]
}

In a DOS window (Command Prompt: CMD.exe) access the directory of the extraction tool ( c:\telemedic\Facturation) to execute the following command :

  npm install

Utilisation

To execute the program, execute the following instruction :
ex:

npm run export-resident-count

Droits requis

Module Right
General info View the module