Atria Documentation
website·Indexed 32 days ago
https://docs.getatria.comDocumentation for Atria, a platform for service providers to manage the assignment of resources, customer plans, and workspace items. Includes guides on Workspace Automation, Workspace Analytics, and a developer API featuring a modern REST API and PowerShell wrapper for managing workspace users, roles, and customer relationships.
What's inside Atria
- When customers are created in Atria, a corresponding Organizational Unit (OU) is automatically created in Active Directory. All AD objects related to that customer are stored within this OU to ensure permissions are appropriately scoped, allowing customers to see only their own or their child customers' objects.
Overview of Microsoft Online identity configuration options
The Microsoft Online service supports several identity models to handle user management and authentication across Microsoft 365 tenants. Supported configurations include:
- Stand-Alone Azure AD: Default configuration for cloud-only users.
- Microsoft Active Directory Federation Services (ADFS): For domains using an external federation service for authentication.
- Microsoft Azure Active Directory Connect (AAD Connect): For synchronizing users between on-premises Active Directory and Azure AD.
- Third-party Identity Services: Services like Okta or Citrix Netscaler, which generally operate similarly to ADFS.
Note: Ensure a connection to the Microsoft PartnerCenter is created before attempting to create a customer plan.
Overview of Atria and Kaseya BMS Integration
The Atria Kaseya BMS integration synchronizes billing data from Atria to update corresponding recurring services contracts in Kaseya BMS. This ensures Kaseya can generate accurate invoices based on provisioning changes tracked in Atria (e.g., customer creation, service assignments, or plan changes).
Key Constraints:
- Mapping: Uses a 1:1 mapping between an Atria customer and a Kaseya account; reseller billing is not directly supported.
- Prerequisites: Atria does not create Accounts or Contracts in Kaseya; these must be pre-configured in Kaseya BMS.
- Contract Logic: The integration targets a 'Recurring Services Contract' per Kaseya account. Multiple contracts of the same type for one customer may lead to inconsistent results.
Overview of Atria Billing Rules
Atria Billing Rules allow service providers to systematically exclude specific data from billing. By default, all entities (Customers, Users, Service Plans, Services, Domains, and Workspace Items) are marked as billable. When a billing rule matches an entity, it disables the 'Billable' flag for that item. Rules are automatically triggered at the end of the billing period, but can be manually re-triggered using theReprocess Billing Recordslink on the Service Billing Rule Configuration page.Overview of Workspace Automation
Workspace Automation allows developers to attach custom PowerShell scripts to Workspace Items or Workspace Item Types. These scripts trigger automatically based on specific events, such as when an item is assigned to or removed from a customer or user. This is used for tasks like preparing application containers, creating users in databases, managing storage, or archiving data. Scripts are managed via the Script Upload feature.Overview of Citrix DaaS extension for Atria
The Citrix DaaS extension for Atria allows Service Provider service desks, Resellers, and End-Customer administrators to view and terminate active Citrix sessions directly within Atria without requiring administrative access to Citrix servers. It is dependent on the Atria Workspace service, which must be enabled and provisioned to the customer first. This extension is compatible with Citrix Cloud (multi-tenant or Private) and Citrix Virtual Apps and Desktops (CVAD).Overview of the Cortex API
The Cortex API is Atria's legacy XML API used to query and update customers, users, services, provisioning requests, and other core objects. For new integrations, the REST API is the preferred interface. The Cortex API should be used primarily for maintaining existing XML integrations or when specific operations are unavailable via REST. It uses HTTP Basic authentication and an XML contract that varies by object and installed service.Overview of the Database Maintenance Extension in Atria
The Database Maintenance Extension in Atria provides tools for performing critical database health tasks, including trimming logs, managing requests, shrinking databases, and optimizing indexes.Overview of Atria Workspace service
Atria Workspace is a management layer for Service Providers to abstract the administration of user desktops, applications, access, and resources. It simplifies operational management for systems using group-based access control, allowing providers to manage end-customers and enabling customers to self-manage their users. It supersedes the Hosted Apps and Desktops service and the original Citrix Service, and can often replace Custom Services modules.
Key capabilities include:
- Managing users in Entra ID (Azure AD/Microsoft 365) and local Active Directory Security Groups.
- Setting Terminal Server and Remote Desktop Services (RDP) properties.
- Applying standardized roles to ensure correct user access.
- Bulk modification of user access.
- Implementing custom automation for application setup and removal.
Overview of Entra-only management
Entra-only management allows you to connect a Microsoft Entra tenant to an Atria customer and manage users directly through the Atria UI. This is specifically designed for customers whose identities are managed in Microsoft Entra ID and do not require corresponding users or organizational units (OUs) in Active Directory (AD). By selecting the Entra directory, the system uses a specific provisioning and synchronization flow that skips AD-specific processing (such as AD usernames or OU selection).Overview of the Atria Notifications System
The Atria Notifications System allows Service Providers, Resellers, and Customers to automate communications for critical events such as customer provisioning, subscription changes, and service updates. Notifications can be targeted to internal teams, customers, or third parties based on the event type and configured recipients.Overview of Managed Exchange Objects during Migration
Atria manages several Exchange objects that behave differently during a version migration:
- Mailboxes (User & Resource): Tracked in the Atria database. If a mailbox is found on a datastore not approved by its assigned User Plan, Atria will automatically trigger a move to a valid one. It is recommended to move these using Exchange directly to avoid Atria's slower sequential process.
- Addresses (Address Lists & OAB): Address Lists are stored in AD and require no migration. Offline Address Books (OAB) must be recreated when migrating from Exchange 2010.
- Contacts & Distribution Groups: Stored in AD; no migration required.
- Public Folders: Tracked in the DB. Modern PFs (Exchange 2013–2019) are interchangeable, but Exchange 2010 PFs must be migrated.
- Org-wide Configuration: Mail Disclaimers, Active Sync Policies, and Mailbox permissions are pulled directly from Exchange and are not impacted by the migration process.