Application Modules
How-to documentation .... for the modules of the application
Administration
- Manage account settings
- Reset your password
- Manage Connections
- Create a Connection
- Edit a Connection
- Delete a Connection
- Show License plan details
- Manage Users
- Add a User
- Block or Unblock a User
- Edit a User
- Delete a User
- Manage User Roles
- Add a User Role
- Edit a User Role
- Delete a User Role
- Sign out from the application
- Understand default Roles
- Assign or Unassign Permissions to a User Role
- Manage Organization details
Solutions
Global Features
- Understand the navigation bar
- Understand the status bar
- Manage the task list
- Add a Model Object to the task list
- Manage Notifications
- Know which user is logged in
- Use the search bar
- Understand warnings and errors
- Hide warnings
- Understand the available functions in the tables
- Use available keyboard shortcuts
Projects
Branches
- Understand Branch overview
- Understand Git Workflow in biGENIUS-X
- Validate a Local Branch
- Push changes from a Local Branch to a Remote Branch
- Pull changes from a Remote Branch to a Local Branch
- Fetch changes from a Remote Branch to a Local Branch
- Delete a Local Branch
- Rebase a Local Branch to the Main Branch
- Reset a Local Branch
- Start a pull request for a Local Branch
- Activate a Branch
- Check out a Remote Branch
- Start modeling in a Branch
- Create a Branch
Data Connections
- Understand Data Connections overview
- Understand the Discovery YAML file content
- Create Source Objects from a Discovery
- Add a Source System
- Delete a Discovery
- View a Discovery
- Delete a Source System
- Update Source Model Objects from a new Discovery
- Add a Discovery
- Edit a Source System
- Switch to another Discovery
- Manage Linked Projects
- Manage Source Systems
- Export a Project to be used as a Linked Project
- Import a Project to be used as a Linked Project
- Delete an imported Project
- Re-export a Project already exported
- Create Linked Model Objects from a Linked Project
- Edit an imported Project
- Delete a Project export
Dataflow Modeling - Overview
- Understand Dataflow Modeling overview
- Understand the View YAML file content
- Create a Dataflow Modeling View
- Manage Dataflow Modeling Views
- Generate artifacts for a specific Dataflow Modeling View
- Display a Dataflow Modeling View / Switch between Dataflow Modeling Views
- Set a Dataflow Modeling View as the default
- Delete a Dataflow Modeling View
- Edit a Dataflow Modeling View
- Collapse or expand a Layer in a Dataflow Modeling View
- Add a Model Object to the current Dataflow Modeling View
- Create a Model Object with the wizard
- Duplicate a Model Object
- Delete a Model Object
- Delete a Model Object - Multi-delete
- Understand the Model Object YAML file content
- Remove a Model Object from a Dataflow Modeling View
- Remove a Model Object from a Dataflow Modeling View - Multi-remove
- Show Data Lineage
- Edit a Model Object
- Create a Model Object
Dataflow Modeling - Wizard Steps
- Wizard step - Create Model Object
- Wizard step - Create Dataflow
- Wizard step - Create Relations
- Wizard step - Create Multiple Relations
- Wizard step - Create Relations with Role
- Wizard step - Create Relations Driving or Not Driving
- Wizard step - Map Foreign Key Terms
- Wizard step - Map selected Terms
- Wizard step - Map selected Business Keys
- Wizard step - Add to View
Dataflow Modeling - Terms
Dataflow Modeling - Term Mapping
- Understand Term Mapping overview
- Understand Dataflow, Dataflow Set and Dataflow Set Model Object
- Create a Dataflow Set
- Edit a Dataflow Set
- Delete a Dataflow Set
- Add a Model Object to a Dataflow Set
- Add a Dataflow
- Delete a Dataflow
- Arrange Sets
- Edit a Dataflow Model Object
- Remove a Model Object from a Dataflow Set
- Map or unmap a Source Term with a Target Term
- Create a Term Mapping
- Edit a Term Mapping
- Edit a Dataflow
- Show Term-Based Data Lineage
- Edit a Term Mapping - Multi-edit
- Delete a Term Mapping
- Replace a Dataflow Set Model Object
Dataflow Modeling - Relationships
Relationship Modeling
- Understand Relationship Modeling overview
- Create a Relationship Modeling View
- Add a Relationship in the current Relationship Modeling View
- Manage Relationship Modeling Views
- Display a Relationship Modeling View / Switch between Relationship Modeling Views
- Set a Relationship Modeling View as the default
- Delete a Relationship Modeling View
- Edit a Relationship Modeling View
- Add a Model Object to a Relationship Modeling View
- Save the layout of a Relationship Modeling View
Generate Artifacts
Project Settings
- Manage Project settings and Generator configuration
- Understand the Advanced Settings overview
- Upgrade the Generator version
- Manage Default Values
- Edit a Default Value
- Reset a Default Value
- Manage Custom Default Terms
- Create a Custom Default Term
- Edit a Custom Default Term
- Delete a Custom Default Term
- Manage Naming Rules
- Edit a Naming Rule
- Reset a Naming Rule
- Manage Default Terms
- Edit a Default Term
- Reset a Default Term
- Manage Custom Properties
- Create a Custom Property
- Edit a Custom Property
- Delete a Custom Property
- Manage Template Modules
- Preview a Template Module
- Display the Architecture Model for a Model Object in a Template Module
- Edit a Template Module
- Delete a Template Module
- Understand API Documentation
- Manage warnings
- Unhide a warning
- Understand the Config YAML file content
- Delete a custom documentation template
- Export Advanced Settings
- Create a Template Module
- Edit a custom documentation template
- Understand documentation template
- Manage documentation templates
- Import Advanced Settings
- Add a custom documentation template
Data Marketplace
- Understand the Data Marketplace overview
- Add a product
- Edit a product
- Delete a product
- Understand the data product overview
- Understand the Source System product overview
- Understand the detail page of a product
- Request access to a product
- Review a request for access to a product
- Understand the output port overview
- Understand the detail page of an output port
- Add an output port
- Edit an output port
- Delete an output port
- Add a data contract
- Edit a data contract
- Download a data contract
- Delete a data contract
- Check the Data Governance rules for a data contract
- Add example data
- Edit example data
- Delete example data
- Assign a biGENIUS-X Project to a data product
- Remove a biGENIUS-X Project from a data product
- Manage the Data Marketplace settings
- Understand the Data Governance overview
- Add a Data Governance rule
- Edit a Data Governance rule
- Delete a Data Governance rule