How To’s¶
Framework & Integration Guides¶
These goal-oriented guides help you accomplish specific tasks with OAA-runner integrations. Each guide assumes you know what you want to achieve and provides step-by-step instructions.
Getting Started (Setup and installation guides):
Framework Guides (General patterns used across integrations):
- How to Add a REST API Source
- How to Authenticate with API Keys
- How to Authenticate with Client Credentials (OAuth 2.0)
- How to Handle API Pagination
- How to Enable Common Hooks
- How to Use PRE_TRANSFORM Hooks
- How to Use RECORD_TRANSFORM Hooks
- How to Create User-to-Role Relationships
- How to Flatten and Reshape Source Streams
- How to Configure Field Mappings
- How to Map User Identities
- How to Add a New Transform
- How to Use Generators to Create Groups and Roles from Field Values
- How to Set the Application Datasource Name
- How to Use Multiple Datasources
- How to Mock API Responses for Local Development
- How to Use
required_envfor Environment Variable Management - How to Use Environment Variables in Jinja2 Templates
- How to Enrich Existing Veza Entities with Custom Properties
- How to Profile Memory Usage
Application Type Guides (Choose and configure your integration type):
OAA Runner Connector Packaging:
Additional How-To Guides:
- How to Validate an Integration Config File
- How to split a large config.yaml with !include
- How do I use Hooks to Filter the Stream of Data?
- How To Write a Fetch Function?
- How to Use Priority Push for Faster Processing
- How to Check the OAA Runner Version
- How to use oaa-runner utility modules
- How to Use CLI Commands
BongaWonga Training Series¶
The BongaWonga step-by-step tutorial series has moved to the Tutorials section. See BongaWonga Training Series.
Using These Guides¶
Each guide:
Focuses on a specific goal or task
Assumes you know what you want to achieve
Provides step-by-step instructions
Includes real examples from production integrations
Links to reference documentation for deeper understanding
Choose the guide that matches your current task and follow the steps. If you need conceptual understanding, refer to the main framework documentation.