RIPS-Duplicate-Merger-CExt

RIPS Duplicate Client Merger - Chrome Extension

Built in Fall 2018, for use by StARS

How it works

Identify Duplicate Client Records

To begin working with this program, you should have identified at least 2 RIPS client records that are for the same client - a.k.a. duplicate client records. You can be confident that the two client records are for the same person if the following data matches:

UNHCR number
First and last name (some spelling mistakes are ok)
Nationality
Gender
Phone number
Date of birth

Sometimes two client records may have 3 or 4 of the above fields matching, but a few may be different. In this case, it's best to ask caseworkers of the clients if the records are for the same person. It's possible that there are mutiple people on the same UNHCR card with similar names and genders, and same nationality - so you must be 100% sure the client records are duplicates before moving to the next steps.

Enter StARS Numbers

Once you have identified duplicate client records, obtain the StARS number of each client. The StARS number is a unique number that identifies each client record in RIPS. It cannot be duplicated between accounts.

Now that you have the StARS numbers for each client record, open "The Merger" and enter the StARS numbers into the appropriate fields at the top of the page.

Note: StARS numbers must be entered 100% accurately! Each StARS number is a 9 digit number, starting with a valid year (2017, 2018, etc...). The final 5 numbers represent which order the clients were created in. You will not be able to merge clients if you do not enter the StARS numbers in the proper format. Also, you do not need to enter any number into the 3rd client StARS box, unless you have 3 RIPS client records for the same person.

Click Import

By this time, you should have already opened RIPS (in only one tab), and logged in. The import will not work correctly if you haven't logged in to RIPS or if RIPS is open in more than one tab.

Now that you have entered all of the StARS numbers you want to merge, click "Import".

The program will now reach out to RIPS and gather all of the information saved on each client profile.

How You Know Import has Finished

You will know the import has finished once you see a popup on the import page stating that the import has finished, and that you should now select the data that should be merged into one final client record.

You will also see a few tables appear lower down on the page with each client's data. Now move on to the next section, Select Data to Merge.

Select Data to Merge

Now that you see each client's data next to each other, select the data you want to be merged into the final client's profile.

In these tables, you will only be able to select one cell per row:

Client Basic Information
Client Vulnerabilities
Notes

In these other tables, you will be able to select multiple groups of cells per row:

Actions (in the History table)
Relatives
Contacts
Files
Addresses

Any field selected (with a green background) will be added to the merged client in the end. Rows with a green cell in the far left indicate that some data has been selected for that field. If the row does not have selected data, the far left cell will be yellow, indicating no data from this row will be added / merged to Client #1. It is recommended to select at least one item per row to make sure no data is missed!

Once you're ready to merge, move on to the next step.

Note 1: Some fields (Action Name / Caseworker) may not be imported exactly as they appear. This is because these types of data are changing most often. Actions can be renamed or removed, and Caseworkers leave relatively often. Here is how you can deal with either of these scenarios:

Missing Action:
- The auto-merge utility will advise the user to check for the valid action, so the user should first open the Actions dropdown box and check if a different action with a slightly different name is appropriate at this moment. If there is no action, the user needs to re-run the auto merger (Clear data first), then make sure not to slect that action in the merge stage.
Missing Caseworker:
- There's really nothing to be done here, just let the auto-merge utility keep yourself as the caseworker for any new services / actions.

Note 2: Some actions will not be able to be merged to new clients. These are actions related to service closed / reopened, such as: "Service closed" [6] and "Service was closed - reopened at the later date" [333]. These actions are not be mergable so if a Service is closed, and you want to merge it AND keep it closed, you have to manually close that service after the auto merger creates it.

Click Merge

Click the "Merge" button at the bottom of the page!

Now you will see a popup that serves to remind you (the user) to make sure you're 100% confident that the data you selected is 100% accurate. Remember that all of the data you select will be added to a client in RIPS, and all other RIPS profiles will be archived!! So please be as accurate as possible!! You don't always have to merge data between clients, as sometimes other staff members have already transferred one or more actions between profiles! So pay close attention!

Important Note: You may also see an error starting with "ERROR: You selected at least 1 file that needs to be moved to the target client...". This merger program cannot move files (like Microsoft Word, PDFs, images, etc.) from one client to another, so if you see (and select) a file that needs to be moved from one client record to another, this must be done manually. The merger will not allow you to begin merging until you are confident that the files have been moved already, and you do not select extra files that need to be merged.

Note 2: you may see a Warning in the popup, which shows a list of tables that do not have at least one field selected in each group. This warning doesn't necessarily require any action, but it gives users another chance to check if the selected data is accurate or if they missed something. If the user wants to check everything again, they can just click "Take me back", and they will return to the page where they can select / de-select client data. If the user is 100% sure they're ready to merge the clients, they can click Merge and the merge process will begin!

Which Client Gets the New Data?

This program assumes the first client StARS number (entered into the box "Client StARS #1") is the client with the most accurate information, and therefore this client will receive all new, "Merged" data.

Note: this is also why all of this first client's data is selected by default. You can still un-select any of this data if you know it is incorrect and needs to be changed.

The Merger will not completely delete any client data!! If any field has data that needs to be replaced (like wrong nationality, or a misspelled name), the target client (Client StARS #1) will get the updated information. However, if there is incorrect data (like actions with the wrong notes), this data will need to be changed manually.

How You Know Merge has Finished

Once the merge process finishes, "The Merger" will archive clients #2 and #3. Once this is all done, the process has finished and a popup will display in the main page, explaining that everything has completed successfully!

Note: At this stage, it is highly recommended to check the newly merged client (Client StARS #1) and make sure all of the correct data has been added here.

Got more clients to merge? Go back to the top of the page and click "Clear", then repeat the steps above!

Common Issues

As always, let "the RIPS Guy" know if anything goes wrong or if you have any questions.

If you're running into any issues while using this RIPS Duplicate Merger, check the list below for solutions to common issues! If you do not find the issue / solution you are looking for, contact the developer (rips@stars-egypt.org) for assistance.

RIPS stops doing anything (infinite spinning)
- Sometimes RIPS will stop loading, and you will be stuck watching one page infinitely load. If this happens to you, try stopping the page from loading, then click refresh.

Developer Notes

The Purpose

Input a list of StARS numbers and this extension will show the user any mis-matching data, the user will select which data is correct, then all of the correct data will be merged into the oldest client. Finally, the newer client(s) will be archived.

Some potential shortcomings:

The Relatives / Contacts pages can only import the basic data that shows up in tables, for now
Action notes that are very long only display up to around 270 characters in the History page. Sometimes long notes even display less characters, if more HTML is stored in the note (especially when text has styling). In order to not need the import to click on EVERY action, I set a threshold of 150 characters. If the note has over 150 characters (showing - not including html characters), the merger will click on the row & import / merge the entire attendance note.
- This can also happen when there are duplicate actions! If an action is being added and 'Save' is clicked multiple times very quickly, sometimes multiple actions are created.

Getting Started

Run npm install to install the node packages in package.json
Run npm run build to "build" the React app
Load the built app into Google Chrome
- Open chrome://extensions in your browser
- Open "Developer Mode" (click switch in rop-right corner of the page)
- Click Load Unpacked.
- Navigate to your build directory that was created in the previous step.
- Finally, click 'ok'.

Now you should have a new, working chrome extension!

Updating Extension Locally

Let's say you made some change (fixed a bug or something), and you want the change to be running on the local version of your Chrome Extension.

After you make your changes and want to test, follow these steps:

Make sure everything is saved.
Run npm run build to add your changes to the build folder
Open chrome://extensions and find the Extension listing. It should look something like this:
Click the refresh icon in the extension listing

Now you're pretty good to go, but I'd always recommend refreshing the RIPS page you have open, as this clear the previous import state :)

You're good to go! Happy coding :)

Common errors:

Error with service-worker:
- Found in background.js
- Error: service-worker.js:1 Uncaught (in promise) TypeError: Request 'chrome-extension' is unsupported at service-worker.js:1
- Resolution: Make the following changes to index.js:
  1. comment out import registerServiceWorker...
  2. comment out registerServiceWorker();
  3. delete registerServiceWorker.js
chrome not available:
- Found in App.js
- Resolution: Remember to add /*global chrome*/ to the top of the js file.
In Jan 2019 I found that create-react-app wasn't playing nicely with chrome extensions. I found this error: "Refused to execute inline script because it violates the following Content Security Policy directive: "script-src 'self' blob: filesystem: chrome-extension-resource:". Either the 'unsafe-inline' keyword, a hash ('sha256-GgRxrVOKNdB4LrRsVPDSbzvfdV4UqglmviH9GoBJ5jk='), or a nonce ('nonce-...') is required to enable inline execution."
- Found in index.html (after doing npm run build)
- Resolution: Created a .env file in the root directory with the line INLINE_RUNTIME_CHUNK=false
  - Found this resolution on Github here

To "exclude" url matches from chrome extension manifest:

https://developer.chrome.com/extensions/content_scripts#matchAndGlob

AliyahHA / RIPS-Duplicate-Merger-CExt