Page Comparison

, navigate to

the Company directory >> click on

Import or sync HRMS data >> Import data tab.

• By default Auto sync toggle is turned off. Turn on this toggle and you will notice more options to set up the SFTP connection.

• Import file option is always available. When Auto sync option is turned on, clicking on Import file will display options to import files as shown in the below images.

Image Added

Once you turn on the Auto-sync option, below fields are displayed.

• Auto-sync -

• On/off, dictates whether UpRaise will connect to the SFTP server daily night 11 o'clock to retrieve the JSON files.

• SFTP Server -

• Hostname or IP address

• Port -

• Usually SFTP is configured at 22

• username & password -

• To connect with the SFTP server

• Directory -

• Relative path to the directory where the JSON/excel files will be available

Add the above information & click on

Save

. On a successful connection, the configuration will be saved. Otherwise, a relevant error message will be displayed.

Image Added

How does Auto Sync work?

Once the above setup is done UpRaise will reach out to this SFTP server daily night 11 o’clock & pick up the file/s generated that day.

After processing, all UpRaise administrators will be notified via email

and sync status will be updated under Logs tab.

Do note that name of the file to be picked up by the system should have the following pattern -

• Syntax -

• • UsersData<filename>.json

    • Eg. UserData20230422.json

• • UsersData<filename>.xls/xlsx

    • Eg. UserData20230422.xls/xlsx

  • TeamsData<filename>.json

    • Eg. TeamsData20230422.json

  • TeamsData<filename>.xls/.xlsx

    • Eg. TeamsData20230422. xls/xlsx

The first time around, it may take a few

trials & errors to get the JSON format right.

For incremental updates, the process will be completed fairly quickly based on the updates.

You can download sample templates from the links provided on the Import or sync HRMS data tab as shown in the image below -

Image Added

Once completed, UpRaise will generate a file with execution status in the same SFTP (for which it needs Write permissions on the SFTP).

The standard format & content of

the files should be as explained below

Employee data JSON structure

UpRaise expects to receive only the user records in which one or more of the following attributes have been updated - designation, manager, team, UpRaise role. If there are updates to other user attributes in the external system, UpRaise doesn't need to know.

Employee Data JSON Structure

{ 
 "users":[   
      {   
         "id":"11081", 
         "jirausername":"Jane.Doe", 
         "designation":{   
            "id":"94", 
            "name":"Consultant, eLearning & Systems" 
         }, 
         "userrole":"USER", 
         "manager":{   
            "id":"9195", 
            "jirausername":"John.Doe" 
         }, 
         "teams":[   
            {   
               "id":"10017", 
               "name":"HR" 
            } 
         ] 
      } 
   ] 
} 

Parameter details

Team data JSON structure

UpRaise expects to receive team records in which one or more of the following attributes have been updated - team name, team id, team lead id & name, parent team name & id, team type & description. If there are updates to other team attributes in the external system, UpRaise doesn't need to know.

Employee Data JSON Structure

{
  "teams": [
    {
      "id": "741",
      "name": "Sales",
      "teamLead": {
        "id": "1",
        "jirausername": "John.Doe"
      },
      "parentTeam": {
        "id": "249",
        "name": "Business Development"
      },
      "teamType": {
        "name": "Department"
      },
      "description": {
        "name": "Team responsible for bringing in Dollars."
      }
    }
  ]
}

Parameter details

Manual update via SFTP

Sometimes it is possible that you want to sync date immediately instead of waiting for the UpRaise job that runs every day. Or for the first-time sync, it may take some time to update files so you can also go for the manual update of the file.

• Click on Import file

• Select SFTP server (your SFTP server) here SFTP server (amoeboids10.files.com)

• Update the File name

• Click on Fetch

Image Added

This will trigger the manual sync of the file from the SFTP server and the system will immediately retrieve the file on the SFTP server and start the sync.

You can check logs for the status.