This section explains how to manage users, groups, API users, and document permissions in UNCIA.
It is divided into two independent sections, each aligned with a dedicated video.
📹 Video - Account Management: Users, Groups and Deployment Team
Log in to your UNCIA tenant.
Log in to your UNCIA tenant
Open Account Management Settings.
Navigate to User Management.
You will see several subsections:
Users
Groups
Deployment Team (API users)
Managing Users
View Existing Users
The Users section displays all users in your organization.
Each user is listed with their assigned permissions.
Create a New User
Click Create User.
Fill in:
First Name
Last Name
Email Address
Group
Configure permissions:
Operations Team
Enables involvement in design-to-build and deployment processes (notifications included).
Organization Owner
Grants full administrative rights on the UNCIA tenant.
⚠️ Organization Owner = full admin access.
Edit an Existing User
You can modify user details, group assignment, and permissions at any time.
Managing Groups (Review Process) - Groups are used during document review and approval workflows.
Create a Group
Go to Groups.
Create a new group.
Assign a role:
Approver
Users can approve or reject document versions.
Commenter
Users can comment during the review process.
Group Participation Rules
A user cannot belong to multiple review groups at the same time.
Groups can be marked as Included by Default:
If enabled, the group is automatically involved in reviews.
If disabled, you manually choose whether to include the group per review.
Assign Users to Groups
Users can be assigned to groups:
From the Users view
Or directly from the Groups view
Both entry points provide the same result.
Deployment Team (API Access) - The Deployment Team is designed for users who consume UNCIA content via API only.
Purpose
These users do not access the UNCIA UI.
They retrieve document content using the UNCIA API.
Add a Deployment Team User
Go to Deployment Team.
Add:
Email address
First name
Last name
The user receives a notification email.
API Token Management
From this section, you can:
Revoke or renew API tokens
Activate or deactivate notifications per user
🔔 Notifications can also be disabled for Organization Owners if required.
This section explains how permissions are applied per document.
📹 Video - Document-Level Permission Management
1. Default Permission Model
Organization Owner
Automatically has Application Owner rights on all documents.
These permissions cannot be modified.
Standard Users
Permissions must be explicitly assigned.
2. Available Document Roles
Application Owner
Highest permission level on a document.
Can:
Modify document metadata
Remove or manage document versions
Manage document permissions
Editor
Can:
Edit document content
Cannot:
Remove versions
Manage advanced document settings
⚠️ A user cannot be both Application Owner and Editor on the same document.
Reader (Default)
Users without assigned roles have:
Read-only access
3. Assign Permissions on a New Document
Create a new document.
Assign users as:
Application Owner or
Editor
Save the document.
4. Modify Permissions on an Existing Document
Open the document.
Access Document Permissions.
Update user roles as needed.
Changes are applied immediately.
Rules allow you to define technical, architectural, and security constraints that apply to your documents, diagrams, and reviews. They ensure consistency with your design principles, security policies, and internal guidelines.
All rule configuration is managed from the Rules section in the UNCIA menu.
📹 Video - Managing Rules and Design Standards
1.1 Network Zones
Network Zones represent the logical segmentation of your information system.
Typical examples include:
Internet Zone
DMZ
Intermediary Zone
Internal Services Zone
These zones are used to define allowed or forbidden network flows between components.
How to configure Network Zones:
Open Rules → Network Management → Network Zones
Create zones that match your internal urbanization model
Use these zones later to enforce flow rules in diagrams
1.2 Network Flow Rules
Network rules define which protocols are allowed or forbidden between two zones.
Example:
HTTP and SSH traffic forbidden between Internet and DMZ
How to create a network rule:
Select a source zone
Select a destination zone
Choose one or more protocols (or all)
Set the rule as Allowed or Forbidden
These rules are automatically applied to diagrams and validations.
1.3 Protocol List
UNCIA includes a predefined list of common protocols.
What you can do:
View existing protocols
Modify default protocol definitions
Add custom protocols if needed
Location:
Rules → Network Management → Protocol List
Drawing Objects define the building blocks used in UNCIA diagrams.
They are processed by the UNCIA backend to generate:
Architecture diagrams
Flow cartography
Infrastructure views
2.1 Internal Modules
Internal Modules represent components within your application or service.
Examples:
Front-end web application
Backend API
Internal service
2.2 Complex Modules (Hierarchy)
Complex Modules allow you to model parent-child relationships.
Use cases:
A main application composed of multiple services
Functional decomposition of a system
The parent module contains several child “bricks”.
2.3 External Modules
External Modules represent systems outside the scope of your application.
Examples:
External APIs
Third-party services
Other internal applications managed by different teams
UNCIA allows you to:
Define exposed internal modules
Map interactions across applications
2.4 Users and Flows
User objects represent actors interacting with the system
Flows represent technical interactions between components
Flows inherit:
Network zone constraints
Protocol rules
Security parameters
2.5 Object Parameters
You can associate common parameters to all objects, such as:
Confidentiality level
Traffic volume
Security attributes
These parameters are global and reusable, not object-specific.
2.6 Reusable Blocks
Reusable Blocks allow you to:
Combine multiple modules into a single reusable component
Drag and drop them into documents
This will be detailed further in practical examples.
UNCIA allows you to define standard prefixes for diagram objects.
Examples:
User flow: U
Internal flow: I
External flow: E
Module: M
User: P
This ensures consistency across all diagrams.
Location:
Rules → Naming Convention
The Review Process allows you to validate documents directly in UNCIA, avoiding email-based reviews.
4.1 Review Workflow Configuration
You can configure:
Number of review rounds
Round duration (used for reminders)
Automatic validation (when all groups approve)
Manual validation by document owner
4.2 Review Scope by Version Type
You can decide to:
Enforce reviews for major versions
Skip reviews for minor or intermediate versions
In skipped cases, the document owner validates the document.
4.3 Flags Management
Flags allow reviewers to mark comments as:
Blocking (approval is locked)
Non-blocking
Blocking flags must be resolved before approval can continue.
Document Metadata allows you to add optional contextual information, such as:
Application owner
Service owner
Business context
Metadata is not mandatory but strongly recommended for governance.
UNCIA supports multiple environments in a single document.
Examples:
Development
Testing
Production
Each diagram layer can be linked to a specific environment.
UNCIA supports CIAT criteria:
Confidentiality
Integrity
Availability
Traceability
You can define:
Your own numerical scale (e.g. 1–5)
The meaning of each level (documented internally)
UNCIA supports parent-child document structures.
Example:
Parent document: Project
Child documents: Design documents
UNCIA provides a built-in notification system designed to help users track actions, updates, and required follow-ups throughout the document lifecycle, including creation, review, validation, and approval.
Notifications ensure that no action is missed and that collaboration remains efficient.
UNCIA notifications are delivered through two channels:
1.1 In-App Notifications (UNCIA UI)
Notifications appear in the notification menu inside UNCIA
A red dot indicator is displayed when:
An action is required from the user
Important information needs attention
This visual indicator helps users quickly identify pending tasks
1.2 Email Notifications
Notifications are also sent by email to ensure visibility outside the platform.
UNCIA supports:
Customer SMTP mail platform
Default UNCIA mail service
The mail platform can be configured in the UNCIA Settings.
All in-app notifications are automatically forwarded by email, ensuring redundancy and traceability.
Users can receive notifications for:
Document creation updates
Review requests
Comments and replies
Approval or rejection decisions
Validation steps
Required actions (e.g. changes, confirmations)
Notifications clearly indicate whether:
Information is provided for awareness
An action is expected from the user
All notifications include clickable links.
What happens when you click a notification:
You are redirected directly to the relevant document
The context of the action is immediately visible
No manual navigation is required
Examples:
Replying to a comment
Fixing a blocking review point
Updating a document before approval
The Infrastructure layer is a key component in UNCIA. It allows you to link applications and design documents to real infrastructure assets, ensuring traceability between architecture design and actual deployment.
All infrastructure configuration is managed from the Infrastructure menu.
📹 Video - Infrastructure Asset Management
Open the UNCIA main menu
Click on Infrastructure
You will find three main subsections:
Infrastructure Templates
Attributes
Infrastructure View
Infrastructure Templates define the structure and attributes used to describe infrastructure assets.
UNCIA supports three types of infrastructure templates.
2.1 Virtual Infrastructure
Used for virtual assets, such as:
Virtual machines
Cloud resources
Virtual services
Key characteristics:
No hardware family is required
Fully flexible structure
Attributes are freely defined
2.2 Hardware Infrastructure
Used for physical assets, which must be linked to a hardware family.
Available hardware families include:
Computing devices (servers, mobile devices)
Storage solutions
Network equipment (routers, firewalls, switches)
Data center hardware
Specialized hardware
Configuration steps:
Select Hardware as the infrastructure type
Choose a hardware family
Assign attributes from the attribute list
Define a reference used across UNCIA views
2.3 Third-Party Infrastructure
Used to link UNCIA infrastructure to external providers.
Typical use cases:
Cloud providers (Azure, AWS)
External platforms
CMDB integrations (e.g. ServiceNow)
This type is critical for Design-to-Build traceability.
Attributes define the metadata associated with infrastructure assets.
Each attribute has a type, such as:
Product (explored during lifecycle)
Single-select list
Multi-select list
Text or numeric value
Attribute scope:
Global attributes: available for all infrastructure templates
Local attributes: specific to a given template
You can also define default values for attributes.
Once a template is defined, you can create infrastructure assets.
Common configuration elements:
Infrastructure type (Virtual / Hardware / Third-Party)
Attributes and default values
Reference, used in:
Infrastructure views
Information system mapping
These assets are later linked to modules in diagrams.
5.1 Cloud Provider Integration (Example: Azure)
When using a Third-Party template, you must define:
A resource type (e.g. Azure Virtual Machine)
A primary key, used to identify assets between UNCIA and the provider
Example:
Azure VM size property:
properties.hardwareProfile.vmSize
This mapping allows UNCIA to:
Match design assets with real cloud resources
Perform compliance and consistency checks
Identification between UNCIA and Azure relies on the subscription reference, which is detailed in a later section.
5.2 ServiceNow (CMDB) Integration
If connected to ServiceNow:
Define a ServiceNow primary key
Map UNCIA attributes to ServiceNow properties
This enables:
CMDB checks
Compliance validation
Alignment between documentation and operational data
The Attributes menu provides:
A consolidated view of all attributes
Visibility into:
Global attributes
Locally created attributes
This helps maintain consistency and governance across templates.
The Infrastructure View defines how infrastructure is displayed inside documents.
It allows you to:
Configure the infrastructure schema
Select which attributes are visible
Control the level of detail shown
This configuration is applied per document and is explained further in a dedicated section of the Help Center.
Summary
Infrastructure templates define how assets are modeled
Three infrastructure types are supported: Virtual, Hardware, Third-Party
Attributes provide structured metadata
Third-party integrations enable Design-to-Build traceability
Infrastructure views control how assets are displayed in documents
The Lifecycle feature is a core capability in UNCIA. It allows you to track products and hardware over time, monitor end-of-life (EOL), end-of-support (EOS), and assess security and compliance risks across your architecture and infrastructure.
📹 Video - Lifecycle Management
By default, lifecycle management in UNCIA is manual, meaning you can define and maintain lifecycle data according to your own internal standards.
UNCIA also offers an optional service called Dynamic Lifecycle, which automatically provides:
Product and hardware lifecycle data
Release versions
EOS / EOL dates
Vulnerability information
In this guide, the environment already has Dynamic Lifecycle enabled.
Open the UNCIA main menu
Click on Lifecycle
You will find two main sections:
Products
Hardware
3.1 What Is a Product?
A Product is any component that has a release lifecycle, such as:
Software
Middleware
Operating systems
Agents
Products are directly linked to Infrastructure Attributes, allowing lifecycle data to be inherited by infrastructure assets.
3.2 Creating a Product
There are two ways to create a product.
Option 1 – Manual Product Creation
You define all versions, dates, and statuses manually
Suitable for internal or custom software
Option 2 – Dynamic Product Creation (Recommended)
Click Add Product
Select a product from the predefined catalog (e.g. Red Hat Enterprise Linux)
UNCIA automatically fetches:
All major releases
EOS / EOL dates
Provider status
Lifecycle data is updated monthly.
3.3 Product Status Types
Each product version includes:
Organization Status
Custom status defined by your organization
Dynamic Status
Status provided by the vendor
You can also define:
Extended End-of-Support
Extended End-of-Contract
3.4 Version and Release Management
You can:
Add custom sub-releases (manually or dynamically)
Filter products by version or status
Track upcoming lifecycle updates (next update date is displayed)
3.5 Vulnerability Analysis (Products)
UNCIA continuously analyzes vulnerabilities for products.
Data sources include:
NIST
ENISA (Europe)
ANSSI (France)
For each product:
Detected CVEs are listed
Vulnerability evolution is tracked over time
3.6 Product Compatibility Rules
You can define incompatibility rules between products.
Example:
A specific version of a robot agent is not compatible with a specific MySQL version
These rules are later used for compliance checks.
4.1 What Is Hardware?
Hardware represents physical infrastructure, such as:
Servers
Network devices
Firewalls
Storage equipment
Hardware is associated with a hardware family (e.g. networking, compute).
4.2 Creating Hardware Entries
You can:
Add hardware brands manually
Add models under each brand
Assign each model to a hardware family
Example:
Palo Alto firewall → Networking Equipment family
HPE server → Computing family
4.3 Dynamic Hardware Lifecycle
When available, UNCIA fetches:
EOS / EOL dates
Vendor status
Vulnerability data
If the vendor does not provide lifecycle data, the status may appear as undefined.
4.4 Hardware Vulnerability Tracking
Hardware vulnerabilities are tracked in the same way as products, using:
NIST
ENISA
ANSSI
You can identify:
Devices already out of support
Devices approaching end-of-life
5.1 EOS / EOL Change History
UNCIA tracks:
Status changes
Date updates
Example:
A new End-of-Support date added for a product
A lifecycle status change
This provides full historical traceability.
5.2 Vulnerability Evolution Tracking
UNCIA displays:
Day-by-day vulnerability trends
Increase or decrease of detected CVEs
Affected products or hardware
Filters allow you to focus on specific assets or severity levels.
Lifecycle data is tightly integrated with Infrastructure Management.
When an infrastructure asset:
Uses a product attribute → it inherits product lifecycle data
Belongs to a hardware family → it inherits hardware lifecycle data
When lifecycle data is linked to infrastructure:
Compliance reports automatically reflect lifecycle status
Alerts are generated if assets are:
Out of support
End-of-life
Affected by vulnerabilities
This ensures continuous design-to-build compliance monitoring.
Summary
Lifecycle management can be manual or dynamic
Products and hardware are managed separately
Lifecycle data feeds infrastructure and compliance reports
Vulnerabilities are continuously analyzed and tracked
Changes and risks are fully traceable over time
The Information System (IS) Mapping feature in UNCIA allows you to aggregate and visualize all information collected across documents into a simplified, consolidated view.
It provides a global understanding of applications, services, infrastructure, and flows across your information system.
Open the UNCIA main menu
Navigate to IS Mapping
The IS Mapping section is divided into multiple subsections, each focusing on a different level of aggregation.
The first subsection focuses on document-level relationships.
Individual documents
Relationships between:
Documents
Applications
Services
External modules
Each document is displayed independently, allowing you to:
Understand its specific dependencies
Identify external interactions
Analyze isolated architectural scopes
Example:
A document may show a relationship between an application module and an external service used only in that context.
The Global View aggregates all relationships across all documents.
Key elements:
Each node (dot) represents:
An application
An external service
Each link represents:
A relationship between two applications
A relationship between an application and an external service
This view provides:
A holistic view of the information system
Cross-application dependency mapping
Reuse visibility across multiple documents
Another subsection focuses on Infrastructure Assets, acting as a CMDB-like view.
What it provides:
Relationship between applications and infrastructure references
Consolidated infrastructure data sourced directly from documentation
Lifecycle and product data inherited from infrastructure definitions
This results in a documentation-driven CMDB, which is often more accurate and up to date than traditional manual CMDB approaches.
UNCIA also consolidates intermediate objects, which represent:
Network security components
Traffic control elements
Flow mediation between applications
This allows you to:
See which flows pass through which intermediate objects
Understand how applications interact across network zones
Identify security dependencies at the network level
UNCIA maintains a centralized list of external services.
Capabilities:
External services defined in one document can be reused in others
Services are consolidated across documents
All reused services appear in the global IS Mapping view
This avoids duplication and ensures consistent representation of third-party dependencies.
UNCIA will introduce automatic urbanization, which will:
Automatically identify and digitize intermediate objects
Automatically map external services
Further reduce manual modeling effort
This enhancement will enrich IS Mapping with automated discovery capabilities.
Summary
IS Mapping in UNCIA provides:
Document-level architectural visibility
A global view of application and service relationships
A documentation-driven CMDB
Network and security flow consolidation
Reusable external service definitions
The Synthesis Document is a structured description view available in all UNCIA documents.
It allows you to document your architecture in a textual, structured format, similar to a Word document, while remaining fully integrated with UNCIA’s design and governance capabilities.
Synthesis Documents can be exported as PDF or Word files.
📹 Video - Synthesis Document Management
The Synthesis Document is used to:
Describe architecture and design decisions
Structure documentation consistently across projects
Enforce documentation standards
Generate exportable deliverables (PDF / Word)
Open the UNCIA main menu
Navigate to Synthesis Document
This menu allows you to manage Synthesis Document templates.
3.1 Creating Templates
You can create multiple templates, each adapted to a specific document type.
Supported use cases:
Project / Parent documents
Child documents
Template documents
You can force a specific template to be applied automatically when a document of a given type is created.
3.2 Template Enforcement at Document Creation
When creating a new document:
UNCIA applies the default template associated with the document type
This ensures consistency across similar documents
Templates are fully customizable.
Available actions:
Rename the template
Add sections
Add sub-sections
Rename sections
Define section requirements
Add predefined content
4.1 Required Sections
You can mark a section as Required.
Behavior:
If the section is empty or not updated
UNCIA displays a notification before document submission
The document cannot proceed to approval until the content is completed
This ensures documentation completeness.
4.2 Predefined Content
Each section can include predefined content, such as:
Document owner
Editor
Reviewer
Standard explanations or placeholders
This content is inherited by all documents using the template.
Once a template is saved:
New documents will inherit the latest version
If the template is defined as default, it is applied automatically
What is Template Sync?
Template synchronization allows you to:
Apply template updates to all existing documents using that template
How it works:
Modify the template
Trigger Sync Template
Confirm the synchronization
Result:
All documents referencing this template receive the updated structure and content
Inside a document:
You can modify the Synthesis Document content individually
These changes apply only to that document
Template synchronization is required if you want changes applied globally.
Summary
The Synthesis Document feature allows you to:
Standardize documentation across projects
Enforce mandatory content
Maintain consistency through templates
Export documentation in PDF and Word formats
Balance global standards with local flexibility
The General Settings section in UNCIA allows you to configure global platform options that are outside the document design context, such as display preferences, notifications, authentication, integrations, and API access.
Only users with the Organization Owner role can manage these settings.
Open the UNCIA main menu
Navigate to Settings
Select General Settings
UNCIA allows you to customize how information is displayed in the Document List.
2.1 Metadata Display in Document List
Go to the Metadata configuration
Select the metadata fields you want to display (e.g. Metadata 1, Metadata 2)
Use drag and drop to arrange the columns in the document lis
Click Save to apply changes
This allows you to create a single consolidated view containing all relevant document information.
3.1 Email Notifications (SMTP Configuration)
By default, UNCIA uses its built-in SMTP service.
You can configure UNCIA to forward all notification and subscription emails through your own email gateway.
Supported authentication modes:
Basic authentication
SMTP host
Username
Password
Microsoft 365 (Extended options)
OAuth2
Microsoft Graph
This allows full integration with corporate email infrastructure.
3.2 Single Sign-On (SSO)
Instead of managing users manually, UNCIA supports SSO authentication.
Supported identity providers:
Okta
Microsoft Entra ID
Others
Required configuration:
Issuer URL
Client ID
Client Secret
Once configured, user authentication is delegated to your identity provider.
3.3 Dynamic Lifecycle Feature
UNCIA supports an optional Dynamic Lifecycle service.
Enables automatic lifecycle data for products and hardware
Can be enabled or disabled in General Settings
Requires a service token provided by UNCIA
This feature was detailed in the Lifecycle section.
3.4 Logs
The Logs section provides access to:
System logs related to General Settings
Configuration and integration events
This is useful for troubleshooting and auditing.
4.1 Microsoft Azure Integration
UNCIA can be connected to Microsoft Azure to link design documentation with cloud infrastructure.
Required configuration:
Tenant ID
Client ID
Client Secret
Usage:
Once the infrastructure design is completed in UNCIA
Assign an Azure subscription to the document
This creates the link between design and build
4.2 ServiceNow Integration
UNCIA can integrate with ServiceNow for CMDB and compliance use cases.
Authentication options:
API URL + Username + Password
OAuth2
Additional configuration parameters are available and detailed in a dedicated section.
UNCIA provides a REST API for automation and integration.
Key points:
Only Organization Owners can manage API access
Each authorized user can generate an API token
The API documentation is accessible directly from the platform
This enables:
Automation
Data extraction
Integration with external systems
Summary
The General Settings and Integrations section allows you to:
Customize document list views
Configure email notifications
Enable SSO authentication
Activate advanced features like Dynamic Lifecycle
Integrate with Azure and ServiceNow
Securely access the UNCIA API
🚧
Find support on the following topics