You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* Verification that records are created or updated in the destination system
227
231
228
-
## 9. Contacts
232
+
## 9. Configuration Considerations
233
+
When implementing this interoperability solution for a new Primero/Progres instances, implementers and system administrators should consider the following:
234
+
235
+
* Every PING API call carries three identifiers, `ShippingProcessId`, `PartnerId`, and `InteropId`, that are specific to this UNHCR-UNICEF deployment. Before deploying elsewhere, all of these need to be replaced with values issued by PING for the new environment. The partner ID also appears directly in the ingestion endpoint URL (`/api/ingestion/v2/PNR-1363/data`), so it needs updating there too, not just in the request body.
236
+
237
+
* Two mappings translate service types between Primero and proGres. Both directions are hardcoded with proGres GUIDs that belong to this specific proGres installation. A
238
+
different country's proGres instance will have different GUIDs, and there's no validation wrong values will be accepted silently. These need to be verified against
239
+
the target environment before go-live.
240
+
241
+
* Flow 1-1 only accepts five proGres intervention type descriptions. Anything outside that list throws an error. If the new deployment's proGres uses different terminology,
242
+
this map needs updating or referrals will fail on arrival.
243
+
244
+
* The language lookup keys (e.g. `language1`, `language2`) are specific to this Primero instance's configuration. A different Primero deployment will almost certainly use
245
+
different keys. Both the inbound and outbound language maps need replacing.
246
+
247
+
* Four values also need a human decision before go-live: the fallback CPIMS admin email hardcoded in Flow 2-1, the two proGres organization GUIDs hardcoded in Flow 2-1
248
+
(`progres_businessunit` and `progres_organizationfrom`), and the `module_id` set to `primeromodule-cp` in Flow 1-1. None of these will cause an immediate error if left
249
+
unchanged, they'll just behave incorrectly in production.
250
+
251
+
## 10. Security & Compliance
252
+
253
+
The OpenFn platform complies with the **UNICEF CLASS I System Security Requirements**. Beyond meeting these baseline requirements, we would like to draw the attention to the
254
+
fact that OpenFn is not a standalone system, but rather a system which is carefully configured by UNICEF, OpenFn, or UNICEF's partners to comply with project-level security requirements and to connect with other systems in the UNICEF ecosystem (such as Primero). OFG implementation consultants must support these partners to ensure the
255
+
OpenFn implementation is in compliance with relevant security requirements and adhering to best practices. See the below checklist for project-specific implementation &
256
+
security considerations.
257
+
258
+
These workflows transmit refugee PII across three systems, full name, date of birth, sex, UNHCR ID, phone, address, and protection concerns including SGBV indicators.
259
+
Confirm that data processing agreements between UNHCR and UNICEF cover the specific fields in scope, and that OpenFn's role as a data processor is reflected in those
260
+
agreements.
261
+
262
+
## 11. Solution Assumptions
263
+
264
+
**Flow 1-1**: The PING endpoint SHP-2358 may return multiple rows per intervention due to joins on language and specific needs. The workflow deduplicates these before sending to Primero. If SHP-2358 changes its response structure, deduplication will produce incorrect results without erroring.
265
+
266
+
If more than one Primero case matches on `unhcr_individual_no`, only the first result is used with no warning.
267
+
268
+
**Flow 1-2**: If a service's `progres_interventionnumber` doesn't follow the expected comma-delimited format (intervention number, LP intervention ID, business unit), the
269
+
record is dropped with a log message and never retried. This will quietly discard any referral created before the composite format was introduced.
270
+
271
+
**Flow 2-1**
272
+
273
+
Cases are filtered to those where at least one service has `service_implementing_agency === 'UNHCR'`, exact case match. A Primero instance
274
+
configured with lowercase or mixed-case values will result in all referrals being
275
+
silently excluded.
276
+
277
+
When a caseworker's Primero profile is incomplete, the workflow silently substitutes the CPIMS admin's contact details — name, email, and phone — in the referral sent to
278
+
proGres. The receiving party in proGres has no indication that this substitution
279
+
occurred.
280
+
281
+
If a Primero `service_type` value isn't found in the service map, the workflow sends the legal support GUID to proGres with no warning. A misconfigured or extended Primero
282
+
lookup list will produce silent mismatch in proGres.
283
+
284
+
**Flow 2-2**: The `statusText()` function defaults anything that isn't explicitly `125080002` to `"accepted"`. If proGres introduces a new status code, it will be written to Primero as an acceptance.
0 commit comments