What is an OAA Config File?

The config.yaml file is the core component of any integration built with this framework. Every integration will have a config.yaml.

The config.yaml file is a means of:

• providing information about the application

• listing various sources of data and how the fields in the sources map to Veza Template objects

• connecting sources to connections

Here is a base sample of configuration. This configuration file would load a file sample_users.csv file located relative to the configuration file.

The name of the application created in Veza will be ACME Application. This connetion only has one source, users, which creates Veza LocalUser records. From the csv file, we map the fields:

• identity to unique_id

• full_name to name

• email to email

• active to is_active

• manager_id to manager_id

In addition, the field active is converted to a boolean field with a built-in transform called validate_boolean.

manager_id is a custom field.

version: v2
app:
  name: ACME Application
  application_type: ACME Application
sources:
  users:
    destination: LocalUser
    source_type: csv
    csv_filepath: sample_users.csv
    field_mapping:
      identity:
        destination_field: unique_id
      full_name:
        destination_field: name
      email:
        destination_field: email
      active:
        destination_field: is_active
        transforms:
          - name: validate_boolean
      manager_id:
        destination_field: manager_id
        is_custom: True
        veza_field_type: string

Running the Config file

After installing the OAA runner Run the config file like this:

oaa custom_app run --config-file=./config.yaml