SSN Configuration

Email the Public Key to the Client Support Specialist Team

Once you have the public key as a .txt file, email it to the Client Support Specialist team at webadmitsupport@liaisonedu.com and identify the CAS and cycle it can be used for.

Retrieving Your User Identity ID

Make the following API call to retrieve your User Identity ID.

Use CURL or POSTMAN to make the below API calls:

PRODUCTION

$ curl -n https://api.webadmit.org/api/v1/user_identities \

  -H "x-api-key: <ENTER YOUR API KEY>"

PRELAUNCH

$ curl -n https://prelaunch.webadmit.org/api/v1/user_identities \
-H "x-api-key: <ENTER YOUR API KEY>"

Make sure to use the correct API Keys for PRELAUNCH and PRODUCTION.

A successful API call should generate a status code of “200” with the following example response body:           

{
"href": "/api/v1/user_identities",
"user_identities": [
{
"id": 42,
"type": "Admissions User",
"association": "SOPHAS",
"institution": "Demo University",
"organization": "Demo University School of Public Health",
"cycle": "2014 - 2015"
}
]
}

Make note of the number after "id":. Corresponding to the cycle for which you want to extract SSN, this is the Identity ID and is needed for prelaunch and production. This “id” will be used in the swagger file required for setting up this integration.

If the API call is unsuccessful, then it will return a status code of 401. This means the user is not authorized to gain access to the API. Verify the user’s permissions in WebAdMIT and ensure the user has the correct organization and program assignments.

Initial Setup

1. Create a few test applications in the Prelaunch environment that would have SSNs.
2. Download the SSNinformaticaSwagger.json file.
3. Make two copies of the SSNinformaticaSwagger.json file and place them on your Informatica server in the CAS\dropbox location.
4. Rename them to PrelaunchSSNinformaticaSwagger.json and ProdSSNinformaticaSwagger.json.
5. Edit both the JSON files.
6. For the line “/user_identities/[user_identity_id]/social_security_numbers”, replace the value with the user identity id generated for Prelaunch and Production in the step Retrieving Your User Identity ID.
7. Save both JSON files.

Setting Up the Rest V2 Connector in Informatica

1. Login to your Informatica instance.
2. Navigate to Administrator > Connections.
3. Click New Connection in the top right corner.
4. Give your connection a name to identify it to be a prelaunch connection.
   1. Type: REST V2 (Informatica).
   2. Runtime Environment: use the dropdown to select your runtime environment.
   3. Authentication: select “API Key” from the dropdown.
   4. Key: set this to “x-api-key”.
   5. Value: set this to be your API key for Prelaunch which was identified in the section WebAdMIT User Identities.
   6. Add API Key to: set this to “Request Header”.
   7. Swagger File Path: set this to be the path to your prelaunch swagger file. Like: “C:\Informatica\CAS\dropbox\ PrelaunchSSNinformaticaSwagger.json”
5. Leave the rest of the values as is and click Test Connection in the top right corner.
6. A successful connection results in this message: The test for this connection was successful.
7. Repeat steps 2-6 to create a production connection with the difference being the Value field and the Swagger File Path, both of which should be production-based.
8. Save both connections.

Informatica Mapping Import

1. Download the SSN_Import_Informatica_Mappings.zip file.
2. Login to your Informatica instance.
3. Click Explore > Your Project folder.
4. Click Import in the top right corner.
5. Choose the SSN_Import_Informatica_Mappings.zip file in the next step.
6. On the import screen select the following values for in and out parameters:

7. In the Review Locations section, select your folder in the Target Project 1 dropdown.
8. In Review Connections set Target Connection 1 as your Rest V2 connector for Prelaunch setup in the step Rest V2 connector setup in Informatica.
9. Set Target Connection 2 as your Sandbox Salesforce Connector.
10. In the Review Runtime Environments section, select your Target Runtime Environment.
11. Click Test in the top right corner to make sure the import parameters are correct.
12. If it shows successful, click Import in the top right corner.

Setting Up Informatica Mappings and Sandbox Testing

1. If the imported mappings do not show in your desired folder, you will need to move them there.
2. You should see the following 3 mappings:

3. Click the SSN Data Mapping, which opens the mapping.
4. Click APISource.
5. In the Properties section, click Source.
6. For Connection, select your REST V2 connection for prelaunch.
7. For Operation, click  Select,  and choose the GetSSN2 object.
8. Click Save in the top right corner.
9. Under Request Options configure the Request Message

{
"x-api-key" : "InsertValueForPreLaunchAPIkey"
}

10. Click Save.
11. Click Field Mapping within the source.
12. Under Response Structure, map all the descendants of the Element Name GETSSN2_OUTPUT.
13. The result should look like below:

15. Click Save.
16. Next, click fields and change the precision value of the field Response_200 to 50000:

17. Click Save.
18. Click Java transformation.
19. Click Java under Properties.
20. Select your runtime environment in the top right corner.
21. In the Java code, under Helper code, change the following:
    1. filePath: this should be the path to your key file, similar to “C:\\Informatica\\CAS\\dropbox\\privateKeyFile.txt”. Note: Double slashes are required for the file path.
    2. passphraseText: If your private key has a passphrase then that value should be captured here. If it does not then you can leave it blank:
22. After making this change you must compile the Java code by clicking on Compile in the top right corner of the Properties screen.
23. If there are no errors based on the changes you made, the compilation results were successful.
24. Click Save.
25. Run a Preview on the Java Transformation. The result should look like below: 

26. This shows that the decryption process was successful.
27. Click the Lookup Transformation.
28. Under Properties > Lookup Object, change the connection to reflect your Sandbox Salesforce connector.
29. Click Save.
30. Click Target.
31. Under Properties > Target, change the connection to reflect your Sandbox Salesforce Connector.
32. Click Save.
33. Close the mapping.
34. Edit the SSN Data Mapping Task.
35. Verify your Target value points to your Sandbox Salesforce connection.
36. Verify your Input Parameters are validated.
37. Click Save.
38. Run the SSN Data Mapping Task.

Note: applicants must exist in the sandbox environment before running this task.

39. Login to your Sandbox Salesforce environment and check the applicants for which you expected to see SSN.

Moving to Production

1. Copy over the following tasks from your Sandbox testing folder in Informatica to your production folder:

2. Click the SSN Data Mapping to open the mapping.
3. Click APISource.
4. In the Properties section, click Source.
5. For Connection, select your REST V2 connection for Production.
6. For Operation, click Select and choose the GetSSN2 object.
7. Click  Save in the top right corner.
8. Under Request Options, configure the Request Message:

{
"x-api-key" : "InsertValueForProductionAPIkey"
}

9. Click Save.
10. Click Field Mapping within the source.
11. Under Response Structure, map all the descendants of the Element Name GETSSN2_OUTPUT.
12. The result should look like below:

13. Click Save.
14. Click the fields and change the precision value of the field Response_200 to 50000:

15. Click Save.
16. Click Lookup Transformation.
17. Under Properties > Lookup Object, change the connection to the connection for your Production Salesforce connector.
18. Click Save.
19. Click Target.
20. Under Properties > Target, change the connection to the connection for your Production Salesforce Connector.
21. Click Save.
22. Close the mapping.
23. Edit the SSN Data Mapping Task.
24. Verify your Target value points to your Production Salesforce connection.
25. Verify the Input Parameters are validated.
26. Click Save.
27. You can now include this mapping task in your Linear flow that runs the other tasks to load Contact/Application/Enrollment History etc. The SSN task should be the last task to run in such a linear flow.
28. Continue post-launch monitoring.

Create a copy of the Swagger file

1. On your Informatica server in the “C:\Informatica\CAS\dropbox\” you will find the file ProdSSNinformaticaSwagger.json. Create a copy of that file.
2. Rename the copy to be ProdSSNinformaticaSwagger_NewCycleYear.json.
3. Edit the ProdSSNinformaticaSwagger_NewCycleYear.json file using Notepad or Notepad++.
4. For the line /user_identities/[user_identity_id]/social_security_numbers, replace the value with the user identity id for your new cycle.
5. Save the ProdSSNinformaticaSwagger_NewCycleYear.json file.

Set up a new Rest V2 Connector in Informatica

1. Log in to your Informatica instance.
2. Navigate to Administrator > Connections.
3. Click New Connection in the top right corner.
4. Give your connection a name to identify it to be the new cycle connection:
   1. Type: REST V2 (Informatica)
   2. Runtime Environment: use the dropdown to select your runtime environment
   3. Authentication: select “API Key” from the dropdown
   4. Key: set this to “x-api-key”
   5. Value: set this to be your API key for production which was identified in the section WebAdMIT User Identities
   6. Add API Key to: set this to “Request Header”
   7. Swagger File Path: set this to be the path to your new swagger file. Like: “C:\Informatica\CAS\dropbox\ ProdSSNinformaticaSwagger_NewCycleYear.json”
5. Leave the rest of the values and click Test Connection in the top right corner.
6. A successful connection results in this message: The test for this connection was successful.
7. Save the connection.

Create a Copy of existing Informatica Mappings

1. Create a copy of your existing SSN Data Mapping and SSN Data Mapping Task.
2. Rename the SSN Data Mapping - Copy to be SSN Data Mapping -NewCycleYear.
3. Rename the SSN Data Mapping Task – Copy to be SSN Data Mapping Task-NewCycleYear.
4. Click the SSN Data Mapping-NewCycleYear, which opens the mapping.
5. Click APISource.
6. In the Properties section, click Source.
7. For Connection, select your REST V2 connection, previously set up in the section Setting Up a new Rest V2 Connector in Informatica.
8. Leave the Operation as GETSSN2.
9. Expand the Request Options menu and click Configure next to Request Message.
10. Replace the user api key with the updated key for this cycle. It will look like this:

{ 

"x-api-key" : "InsertValueForProductionAPIkey" 

} 

11. Click Ok.
12. Click Save.
13. Click Field Mapping within the source.
14. Under Response Structure, map all the descendants of the Element Name GETSSN2_OUTPUT.NOTE: This may already be mapped
15. The result should look like below:

16. Click Save.
17. Next, click fields and change the precision value of the field Response_200 to 50000. Note: This may already be updated.:

18. Click Save.
19. Run a Preview of the Java Transformation. The result should look like the following: 

20. This confirms that the decryption process was successful.
21. You can now include this mapping task in your linear flow, which runs the other tasks to load Contact/Application/Enrollment History, etc., for the new cycle. The SSN task should be the last to run in such a linear flow.