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
• Manage Organization details
• 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
• Assign or Unassign Permissions to a User Role
• Delete a User Role
• Understand default Roles
• Sign out from the application

Global Features

• Understand the navigation bar
• Use the search 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
• Understand warnings and errors
• Hide warnings
• Understand the available functions in the tables
• Use available keyboard shortcuts

Solutions

• Understand Solutions and Projects overview
• Create a Solution
• Edit a Solution
• Set or unset a Solution as favorite
• Delete a Solution
• Assign a User to a Solution
• Remove a User from a Solution

Projects

• Create a Project
• Use a Demo Project provided by biGENIUS
• Import a Project
• Use a Project example provided by biGENIUS
• Edit a Project
• Delete a Project
• Clear the local Git cache for a Project
• Understand the Project Metadata Repository content
• Understand the Project YAML file content

Branches

• Understand Branch overview
• Understand Git Workflow in biGENIUS-X
• Create a Branch
• Start modeling in a Branch
• Check out a Remote Branch
• Activate a Branch
• 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
• Start a pull request for a Local Branch
• Rebase a Local Branch to the Main Branch
• Delete a Local Branch

Source Systems

• Understand Source Systems overview
• Manage Discoveries
• Understand the Discovery YAML file content
• Add a Source System
• Edit a Source System
• Delete a Source System
• Add a Discovery
• View a Discovery
• Delete a Discovery
• Switch to another Discovery
• Update Source Model Objects from a new Discovery
• Create Source Objects from a Discovery
• Manage Linked Projects
• Export a Project to be used as a Linked Project
• Re-export a Project already exported
• Delete a Project export
• Import a Project to be used as a Linked Project
• Edit an imported Project
• Create Linked Model Objects from a Linked Project
• Delete an imported Project

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
• Create a Model Object with the wizard
• Duplicate a Model Object
• Edit 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

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

• Understand Terms overview
• Add a Term
• Edit a Term
• Edit a Term - Multi-edit
• Arrange the order of a Term
• Delete a Term
• Delete a Term - Multi-delete

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
• Replace a Dataflow Set Model Object
• Add a Dataflow
• Edit 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 Term Mapping - Multi-edit
• Show Term-Based Data Lineage
• Delete a Term Mapping

Dataflow Modeling - Relationships

• Understand Relationships overview
• Add a Relationship
• Edit a Relationship
• Delete a Relationship
• Have several Relationships to the same Model Object
• Handle missing Foreign Key in a Relationship
• Show Relationship diagram

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

• Understand Generation overview
• Generate artifacts
• Download generated artifacts
• Push the generated artifacts to repository
• Generate documentation
• Generate code for a specific Model Object

Project Settings

• Manage Project settings and Generator configuration
• Upgrade the Generator version
• Understand the Advanced Settings overview
• Import Advanced Settings
• Export Advanced Settings
• 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
• Create a Template Module
• 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
• Manage documentation
• Download documentation
• Understand documentation template
• Upload documentation
• Reset documentation
• Understand the Config YAML file content

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
• Assign a biGENIUS-X Project to a data product
• Remove a biGENIUS-X Project from a data product