How to apply updates to Atria v15.x

How to apply updates to Atria v15.x


Each release of Atria may have updates to one or more Atria components.  You only need to update the components that you have changed.

The PowerShell Module, Atria Tools is used to manage the download and installation of the Atria Nuget packages.

Use this KB to learn how to identify components with updates available.

Applies to

Atria V15 and newer.


There can be dependencies between components, we hence recommend deploying in the order outlined in this document.

Note - if a component has not changed, you will not need to update that component.
Older components will be updated infrequently (For example, SharePoint web service).  More recent or common components (Such as Microsoft Online, or the Atria Database) are likely to have more frequent updates.

Identifying Components with Updates

Use the command "Get-AtriaComponent -ListOutOfDate ".

This connects to the Atria NuGet feed, and compares what is available, with the currently installed components.

It is important that the updates are installed in the recommended order.
1. Identify the components that need updating using the command above.
2. Apply the updates using the appropriate Update command.

For the WebServices - These will be for example Update-AtriaMSOL for the Microsoft Online service, or Update-AtriaADFS for the ADFS component. For a full list of these, please see the "Notes" section at the bottom of the page.

If you run the Update- command on a component which doesnt need updating, the process will retrieve and redeploy the same version.  This can be handy for solving problems, but it will slow the update down
if the component hasnt been deployed, and you attempt to run the update command, the process will likely fail (this is logged for improvement)

Start on the Platform provisioning server 
(Typically it has most of the back-end components which are more likely to change,  (i.e. components 1 through 8 above))
Find the components that need updating, update them in the above order
Update any web services on the machine at the same time
Move to the Web Server
this will also have more frequent changes
Repeat the same process


Setting up the Atria Tools Module if not installed

Install Atria.Tools.Setup-Bootstrap from Powershell Gallery 
  1. [Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12
  2. Install-Script Atria.Tools.Setup-Bootstrap

Update the Atria.Tools.Setup-Bootstrap Script to point to Public Beta Feed 

  1. notepad 'C:\Program Files\WindowsPowerShell\Scripts\Atria.Tools.Setup-Bootstrap.ps1'
  2. Update the $RepositoryLocation value
    $RepositoryLocation = ''

Install Atria.Tools module from the script

  1. Atria.Tools.Setup-Bootstrap.ps1 -username  'any username'  -PersonalAccessToken  'access token provided by Automate101'

Setting the Web Service credential

If this is the first time you are performing an upgrade, there is chances that the Atria Service Schema credential hasn't been set. Please run the below to set this (It is a one time configuration)
  1. $Creds = (Get-Credential)
  2. Set-AtriaServiceSchemaCredential - AtriaPortalCredential $Creds
Please note - If you have Atria MFA enabled, this will need to be disabled during the upgrade as the Service Schema doesn't support MFA at this stage.

Web Service Commands

Atria Web Service
PowerShell Command
Microsoft ADFS

Atria Schema Command

The below command will import all service schemas that are installed, or you can specify individual schema's with the '-service' parameter. We recommend doing the -Installed parameter to speed the process up.
  1. Import-AtriaServiceSchema -Installed

Atria Extension Command

The below command will import all Atria extensions that are installed, or you can specify individual extension with the '-Extension' parameter. We recommend doing the -Installed parameter to speed the process up.
  1. Import-AtriaExtension -Installed

Optional: Update All Out-of-Date Components

Attached is a custom script that can be used to update all Atria components that are out-of-date on the Primary Environment only. By default, this will download the latest available package from the feed.
If planning to update into a specific version (not the latest), kindly do the components individually instead.

Download and Extract the Attached Script on this Article to the Primary Provisioning Server

Different Options to run Update-AtriaOutOfDate Script

Using PowerShell, navigate to the folder location where the script has been copied/exported.
Note that this should be executed first on the Primary Provisioning Server
a. Use the existing FeedUrl that was set on previous upgrade
  1. \Update-AtriaOutOfDateComponents.ps1
b. Use a specific FeedUrl
  1. .\Update-AtriaOutOfDateComponents.ps1 -UserName 'username' -PersonalAccessToken 'access token given by Automate101' -FeedUrl ''
c. Use Update-AtriaOutOfDate with the -AlternateConfigFile (usually used for debugging an issue on the configuration file of the installer)
Example: connection feed and alternate config file for Provisioning component:
  1. Update-AtriaOutOfDateComponents.ps1 -UserName 'username' -PersonalAccessToken 'accesstoken given by Automate101' -FeedUrl '' -AlternateConfigFiles @{'Provisioning' = 'C:\config.json'}

After the components on the Provisioning Server is updated, it will prompt a command for the Atria Web Components

Run the command that will be shown on the PowerShell Window on the specific Web Server where the components are installed

After the Atria Web Components are updated, go back to the Provisioning Server and press Enter to continue the update

Import Schema will be done next

    • Related Articles

    • Atria Billing Setup User Guide

      Objective This article describes how to configure Atria to utilize the latest billing features. This document outlines the billing setup attributes that should be configured.    Applies to Introduced in Atria version 12.0.0 Billing Setup Overview To ...
    • Microsoft Online - How does GDAP apply to Atria?

      Objective This guide is to outline how GDAP applies within Atria, as well as the changes introduced by the migration to MG Graph. What's GDAP? GDAP is a change introduced by Microsoft which improved security by Microsoft Partner Center. To sum this ...
    • Billing Rules Engine User Guide

      Objective This article describes how to use the Atria billing rules engine to identify specific Atria entities as non-billable.   Applies to Introduced in Atria version 12.0.0 Billing Rule Feature Overview Many entities - customers, services, users, ...
    • Atria API User Guide (CortexAPI)

      Overview The application programming interface (API) is a powerful interface that allows you to interact directly with Atria without using the ATRIA Web User Interface (UI).  The API grants a user, with some development knowledge, the ability to ...
    • Billing Process Overview

      Objective This article outlines, at a high level, the billing features available in Atria.  The billing feature provides transparency of Atria billable services that have been consumed, down to the day.      Applies To Introduced in Atria version ...