Upgrade ADM SharePoint On Premise

This guide describes the steps what you need to do in order to work with ADM and Case Management.

Minimum Requirements

Make sure you meet the minimum requirements when using ADM.

SharePoint 2013 and SharePoint 2016

Select Correct WSP

Install the WSPs from the Deliverables installation directory:

  • Ometa.ApplicationDataManager.wsp
  • Ometa.ContextManager.wsp

SharePoint Management Shell

To update a WSP you follow the next steps:

  1. Launch the SharePoint 20XX Management Shell as administrator, where XX is replaced by the SharePoint version.

  2. Run the following command to uninstall the existing solution from the web applications it is currently deployed to. Refer to the Microsoft Documentation for more information.

    Uninstall-SPSolution -Identity "Name of WSP" -AllWebApplications

  3. Run the following command to remove the existing solution from the solution catalog. Refer to the Microsoft Documentation for more information.

    Remove-SPSolution -Identity "Name of WSP"

  4. Run the following command to add the new solution to solution catalog. Refer to the Microsoft Documentation for more information.

    Add-SPSolution -LiteralPath "Absolute path to the file location"

  5. Run the following command to install the solution. Refer to the Microsoft Documentation for more information.

    # Install for all web applications 
Install-SPSolution -Identity "Name of WSP" -AllWebApplications -GACDeployment

# Optional command if you do not know the name of the wsp (-identity)
Get-SPSolution | Select Name

# Install for specific web application
Install-SPSolution -Identity "Name of WSP" -WebApplication "URL of the web app" -GACDeployment

SharePoint 2019

Comming soon.

Update SharePoint Building Blocks Profile

Update the profile used when executing the Ensure ADM or Ensure CM building blocks in the template provisioner. The default profile for executing state actions is SharePoint Building Blocks.

  1. Go to the Profiles in the Ometa Business Connector.
  2. Update the correct profile(s). The default profile is SharePoint Building Blocks.
  3. Update the following profile fields:
    • Preferred Provider
    • Core Service Url
    • Adm Version

The preferred provider is the default provider used when multiple authentication providers like Facebook, Active Directory, Google, ... are configured. Specify idp:Windows if ADM should default try to login with Active Directory.

Deprecated Fields

The following fields are deprecated and are no longer used in building blocks.

  • BC Server
  • BC Port
  • BC User
  • BC Password
  • Rest Service Url

Building Block Configuration

Here you'll get an overview of everything which needs to be filled out when using ADM or Kendo ADM. If you're planning to use Kendo ADM please consider to use ADM instead. ADM is the latest supported version.

ADM

ADM uses the "Generic REST Service" which is secured with OpenID Connect, an implementation of OAuth 2.0.

Ensure ADM Page Manager

Only applies to Kendo ADM. ADM does not need to have a ADM Page Manager!

The Ensure ADM Page Manager building block has some new fields which need to be filled out. There are also deprecated fields which are ignored.

Warning

BREAKING: The Ometa ADM Settings list is no longer ensured by the ADM Page Manager building block.

New Fields
  • Version
  • Core Service Url

The version is set default on {$Profile.AdmVersion}. If your solution only uses Kendo ADM you can set the Adm Version profile field on KendoAdm.

The core service URL replaces the rest service URL.

Deprecated Fields
  • REST Service Url
  • Kendo

The Kendo checkbox is replaced by the version field. It is advisable to use the version field instead of the Kendo checkbox. If the Adm Version profile field is left empty, the Kendo flag is still leading.

Ensure ADM

Ometa ADM Settings List

The Ometa ADM Settings list is ensured when executing this building block. If there is no Ometa ADM Settings list a new list is created with the following columns:

  • Title: contains the core service URL
  • Label: contains the core service URL or core service URL label if filled out in the building block
  • RedirectUrl: contains the redirect URL, this page is needed to save the access token
  • SilentRenewUrl: contains the silent renew URL to try a silent sign in without redirect
  • ADMVersion: contains the version of ADM to use. Will be set to 'angular' when Kendo ADM is used.
  • ListVersion: needed for future upgrade reasons

The Ometa ADM Settings list item is updated every time based on the label.

On SharePoint Online, the page manager finds the first entry in the Ometa ADM Settings list where the column ADM Version contains angular or kendo adm and where the redirect url column is not empty.

New Fields
  • Version
  • Core Service Url
  • Preferred Provider
  • Hidden When Unauthorized
  • Redirect Page Name
  • Silent Renew Page Name
  • Silent Renew And Redirect Library
  • Core Service Url Label

The version is set default on {$Profile.AdmVersion}. If your solution only uses Kendo ADM you can set the Adm Version profile field on KendoAdm.

The core service URL replaces the rest service URL.

The preferred provider is the default provider used when multiple authentication providers like Facebook, Active Directory, Google, ... are configured. Specify idp:Windows if ADM should default try to login with Active Directory.

The hidden when unauthorized hides the ADM when the user is not authorised to execute the view.

The redirect page name contains the name of the page needed to obtain access tokens.

The silent renew page name contains the name of the page needed to silently sign in.

The silent renew and redirct library contains the name of the library to save the redirect and silent renew pages. The building block performs an ensure page library building block action.

The core service url label is currently ignored when using Kendo ADM. However, it is advisable to configure a label since this identifies a record in the Ometa ADM Settings list. The label is a friendly name like "Development Service".

Deprecated Fields
  • Server
  • Port
  • ADM Username
  • ADM Password
  • REST Service Url
  • Kendo

Ensure CM

Refer to Ensure ADM.