Getting Started Tutorial
This tutorial will familiarize you, a data engineer user, with the key features of Bornio Studio.
Bornio Studio is a web-based application that let’s users generate data privacy policies and implement them in the context of a Job which is a type of Bornio Data Privacy Filter.
This tutorial will walk the user step by step through the way the Bornio Studio User Interface (UI) is organized and also through it’s core features through a simple example.
Before you start using Bornio, it is important to understand a few key concepts that will fast track your use of Bornio. Please read the Concepts and Terms section to get familiar with some frequently used terms.
Organization of the Bornio Studio
The Bornio Studio comprises a set of main tabs organized such that it allows a user to perform their most frequent tasks easily. To this end the user drops into an operational Dashboard upon initial sign in. This dashboard will display some useful statistics about the operational state of Bornio and the artifacts created within Bornio.
The available main tabs and their function are described below. Note that, at this time, Data Stores and Jobs are likely to be the most frequently used tabs while labels and models help with one time or infrequent setup actions.
Sample Demo Data
Before we get started with the tutorial it is important to understand the sample demo data that will be used for the tutorial. The demo data is available as part of the Bornio installation at the following folder location in your AWS or GCP instance where Bornio is installed.
The sample data is a csv file that has the following rows of dummy patient profile schema and data with several sensitive data fields in it to illustrate Bornio:
NOTE: While the sample schema and data is fake and doesn’t reflect real life data, it has been constructed to include many of the common data elements seen in applications that store and process patient data.
01-23-98,John,Garimi,123-45-6789,02/03/1954,M,email@example.com,123-456-5589,”123, Oak St.”,Dublin,CA,87391,6 ft. 2 in.,225 lbs,Dr. Able Bodee,Great Samaritan Hospital,Jane Garimi,firstname.lastname@example.org,567-890-1234,Blue Cross,PPO,AQI78450N0821,”$3,456.00″,4234567890123456,Visa,123
17-89-45,Faye,Nguyen,234-56-7890,09/18/1996,F,email@example.com,789-012-3456,”87334, Summer Glen Terrace”,Fremont,CA,27898,5 ft. 1 in.,113 lbs,Dr Kim Reiser,St. Thomas,David Nguyen,firstname.lastname@example.org,654-321-0987,Kaiser Permanente,HMO,18765439X,”$25,598.32″,5345678901234567,MasterCard,98
04-22-67,Susan,Wright,345-67-8901,07/07/1988,F,email@example.com,234-567-8901,”22, Tobey Ave”,Ramon,CA,23456,5 ft. 3 in.,123 lbs,Dr Kim Reiser,St. Thomas,Jack Wright,firstname.lastname@example.org,678-901-2345,Kaiser Permanente,HMO,10098267Z,”$2,786.00″,3 456789011 34567,Amex,1234
44-85-76,Gopi,Nath,456-78-9012,04/14/1999,M,email@example.com,890-123-4567,”234, Fell St.”,Oakland,CA,45623,5 ft. 11 in.,175 lbs,Dr Able Bodee,St. Thomas,Shree Nath,firstname.lastname@example.org,765-432-1098,UnitedHealth,HMO,UH-002315-CA-0004,”$21,483.00″,3 456789012 45678,Amex,5678
05-87-23,Jim,Bender,567-89-0123,08/23/1992,M,email@example.com,345-678-9012,”45631, Twisting Terrace”,Los Altos,CA,77452,5 ft. 10 in.,167 lbs,Dr. Able Bodee,Great Samaritan Hospital,Joanee Bender,firstname.lastname@example.org,210-987-6543,Blue Cross,PPO,AQI84451N0092,”$1,234.00″,4.6789E+15,Visa,456
23-88-44,Kim,Lee,678-90-1234,05/05/1997,F,email@example.com,901-234-5678,”87, Persimmon St.”,Santa Clara,CA,98764,5 ft. 3 in.,124 lbs,Dr Able Bodee,Great Samaritan Hospital,Mike Lee,firstname.lastname@example.org,876-543-2109,Cigna,HMO,C98761002,”$159,247.45″,4789012345678901,Visa,789
05-87-24,Joanne,Bender,789-01-2345,05/20/1995,F,”joannebender95@yahoo,com”,456-789-0123,”45631, Twisting Terrace”,Los Altos,CA,77452,5 ft. 4 in.,128 lbs,Dr Kim Reiser,Great Samaritan Hospital,Jim Bender,email@example.com,321-098-7654,Blue Cross,PPO,AQI84933N0092,”$45,678.00″,4890123456789012,Visa,12
23-88-45,Mike,Lee,890-12-3456,07/11/1995,M,firstname.lastname@example.org,876-543-2109,”87, Persimmon St.”,Santa Clara,CA,98764,5 ft. 8 in.,153 lbs,Dr Able Bodee,Great Samaritan Hospital,Kim Lee,email@example.com,901-234-5678,UnitedHealth,HMO,UH-765432-CA-0179,”$8,743.92″,5901234567890123,MasterCard,765
01-23-99,Jane,Garimi,901-23-4567,03/04/1956,F,firstname.lastname@example.org,567-890-1234,”123, Oak St.”,Dublin,CA,87391,5 ft. 5 in.,135 lbs,Dr Kim Reiser,Great Samaritan Hospital,John Garimi,email@example.com,432-109-8765,Blue Cross,PPO,AQI78450N0821,”$12,356.00″,5012345678901234,MasterCard,432
17-89-44,David,Nguyen,012-34-5678,11/25/1992,M,firstname.lastname@example.org,654-321-0987,”87334, Summer Glen Terrqace”,Fremont,CA,27898,5 ft. 3 in.,138 lbs,Dr Able Bodee,Great Samaritan Hospital,Faye Nguyen,email@example.com,789-012-3456,Kaiser Permanente,HMO,18765439X,”$18,432.00″,3 712345678 90123,Amex,9012
04-22-68,Jack,Wright,987-65-4321,06/18/1984,M,firstname.lastname@example.org,678-901-2345,”22, Tobey Ave”,Ramon,CA,23456,5 ft. 8 in.,157 lbs,Dr. Able Bodee,St. Thomas,Susan Wright,”swright@yahoo,com”,234-567-8901,Kaiser Permanente,HMO,10098267Z,”$9,453.21″,4098765432109876,Visa,109
Tutorial Walkthrough Steps
1. Signing in to Bornio
- Sign in as admin user
- Create a user with password
- Login as new user
- All users are admin users in Bornio (in current version)
- You can be logged into multiple sessions with same user/pw
- You will drop into a dashboard. At first, there will be no data to display on the dashboard. Overtime, it may be populated with useful operational summary data.
2. Creating a Data Store
- First step is to know where your data sources are. Our sample tutorial file (tutorial_sample.csv) is a local file in a shared folder in the Bornio install directory.
- Create Data Store
- Click on Data Store tab to the left
- Click on + Data Store button at top right
- A pop up window will appear
- Enter a Data Store name, optional description and select the type of source it is – Local File.
- Next select the file type as CSV.
- Click on Save to create and save the Data Store. You’ve successfully created a Data Store.
- You can click on the down arrow next to the Data Store name to see the details of the newly created Data Store.
You may check out other types of Data Stores (and file types) supported by Bornio later – a file in S3, Google Storage or Microsoft Azure Blob object store or a relational database table accessible via JDBC or a Kafka stream/topic.
You can click on the down arrow next to the Data Store name to see the details of the newly created Data Store.
3. Importing Schemas from Data Source
The next step is to import the definitions or structure of the files in the Data Source created. In the case of a database source, these will be table and column definitions.
NOTE: Bornio does not import data (ie. make copies of the data in the data source). It only imports the metadata or structural definition of the columns or fields in the source data tables or files. In the case of more complex objects such as a JSON object containing semi-structured fields, Bornio automatically infers and flattens the structure.
- Click on the Data Store name in the Data Stores listing page
- Click on Import Schema button
- Click on Source folder in the pop up window, select tutorial_sample.csv file and click on Import Schemas.
- You’ve imported the structure of the tutorial_sample.csv file successfully.
Use the full screen icon to go into full screen mode to view all the columns in the source data store file.
Note the label and sensitivity assignments. These are driven by a predefined set of labels in a Bornio Dictionary. Bornio also allows you to create custom labels and define matching criteria for these labels in terms of name and value patterns. More on this later.
Note the following about Bornio’s auto labeling feature:
- One or more labels can be mapped to a given column
- There is a possibility of false positives during label mapping.
- The user has full control to override auto labels or to manually remove false positive labels and related sensitivity and protection method values.
Above is an example of correct multi-label automatic mapping. The following are examples of a false positive auto-label mapping.
You can manually remove, add or override labels by clicking on the pencil icon next to each label and subsequently clicking on the tick mark icon. Similarly, you can change the sensitivity value and also protection method assignment. These map be necessary for false positives as well as for those columns for which Bornio is unable to find a suitable sensitive data label to map to. In all such cases the label, sensitivity values will show Not Set.
You can create one or more Privacy Policies for a Data Store. For example for our sample data store, we can create a policy to adhere to HIPAA regulation, We can also have a policy for sharing the data in this source with the Analytics Team. A third policy can combine one or more regulations that need to be adhered to with one or more target user roles with whom data is to be shared. In all cases, Bornio will come back with appropriate initial recommendations on how to protect each column in the source file to fulfill the intended purpose of regulatory compliance and/or sharing with a specific role.
To create a policy:
- Select Create action.
- This will open a pop up window. Give the policy a name – HIPAA Policy
- Add an optional description for the policy
- From the drop down list under Regulation select HIPAA
- For Default Protection select Retain.
- Click on Create. You’ve successfully created a policy with an initial Bornio recommendation on how to protect each column per HIPAA regulation. Note the different methods recommended for different columns
- You can preview the data to see how the resulting data will look based on the recommended protection method for each column.
- You can optionally download the sample preview data to a csv file to be shared with other collaborators such as your legal team or security team prior to gaining final approval on the policy.
A file with the data store and policy name will be downloaded into your default downloads folder on your local machine from where you’re accessing the Bornio Studio. You may open the file with a text editor or excel to review the data.