PlanSource API

The PlanSource API Developer Hub

Welcome to the PlanSource API developer hub. You'll find comprehensive guides and documentation to help you start working with PlanSource API as quickly as possible, as well as support if you get stuck. Let us help you jump right in!

Data Field Security

What is data field security used for?

Data field security is used to make sure data is flowing properly from an authoritative system to another receiving system. If an employee makes a change to their personal information (a change of address, marital status, etc.), the information should flow from the authoritative system they made the change on to another system. The system that receives the data should not allow changes to be made because that information will not be able to flow back up to the authoritative system. This prevents discrepancies from occurring.

Accessing

To access Data Field Security, log into your client on PlanSource's Benefits Admin site.

PlanSource's Benefits Admin Site

The hyperlink above (and throughout the documentation) links to Plansource's Partner-Dev site. This is the environment used when accessing the sandbox. To learn more about the different PlanSource sites, read about it in Information on Production & Partner-Dev Sites.

  1. Click on the Configure tab on the top row.
  2. Click on the Data Field Security tab on the left column.

Five Default Data Field Security Roles

  1. Update All
  2. Read Only
  3. Subscriber
  4. Import
  5. Batch Import

What do the five default roles control?

  1. Update All
    Controls fields when editing an employee directly in PlanSource.
  2. Read Only
    Controls section of the system where data is displayed for read only.
  3. Subscriber
    Controls what fields an employee/subscriber can see/update when going through the enrollment experience.
  4. Import
    Controls what fields appear and which fields are required when making a mass update to employees. The import files are found under the Data tab. When a link is opened, there are red data fields that denote a required response from the administrator. The other fields that are not red are okay to be left empty. For more information on API related imports, see Batch Import below.
  5. Batch Import
    Controls what fields are accessible via the PlanSource batch import process.

What do the four field access columns do?

When clicking on any existing or created roles, administrators will be able to manage 4 field access columns per each data field. They can also change the name and/or description of the data field security role.

  1. View
    Selecting the View checkbox allows the administrator and employee to view the data field when managing the employee's information.
  2. Update
    Selecting the Update checkbox allows the administrator and employee to view and update the specific data field when managing the employee's information.
  3. Insert
    Selecting the Insert checkbox allows the administrator and employee first view and insert the specific data field when originally inputting the employee's information.
  4. Required
    Selecting the Required checkbox forces the administrator and employee to input the specific data field's employee information before moving on to the next page.