UMT360.Client 5.18.2020.1007

UMT360.Client

UMT360 offers this CSOM (client side object model) library for clients using UMT360.

This is a very short tutorial to let you get started fast. We will create a simple console application with .Net Framework and connect to the product to list project entities available in product.

Prerequisites

• UMT360 Solution deployed and configured
• Credentials and permissions to access application
• Visual Studio and .Net Framework v4.5

CSOM Client Test application

1. Create a new console app.

2. Opent Tools > NuGet Package Manager > Manage NuGet Packages for Solution…

3. Select Browse tab and insert UMT360.Client in search box.

4. Click on our package then look in the right side panel and select the project where you want to install the library.
   Click install button and review packages that will be installed, then accept the license.
   In a few seconds we are ready to go.

5. Add a CSOMConfig.cs class to project.

6. Import libraries:

    using UMT360.Client;
    using UMT360.Client.Application;
   

7. Add class member variables to hold server url to pwa and context.

    private string _serverUrl = "http://<server>/sites/pwa/";
    private UMT360Context _appOnlyContext;
   

8. If you have credentials, go to SharePoint Central Admin <server_url>:<port> and grab you client_id, client_secret, realm, certificate.cer informations.
   If you don't have, ask your administrator.

9. Initialize the class with credentials

    public CSOMConfig()
    {
        TokenHelper.InitializeAppConfiguration(
                "<client_id>",		//clientid
                "",					//clientSecret
                "<realm>",			//realm
                "<issuer_id>",		//issuerId
                @"C:\<path>\certificate.pfx",	//get it from: http://<server>:<port>/ Central Admin
                "<certificate_password>",       //certificate password
                "AAD for UMT360Online"          //trusted provider name  
            );
    }
   

   Configure a property with CSOM elevated context to be used later in CSOM calls.

    /// <summary>
    /// Gets an elevated, app-only CSOM context 
    /// </summary>
    protected UMT360Context AppOnlyContext
    {
    	get
    	{
    		if (_appOnlyContext == null)
    		{
    			_appOnlyContext = new UMT360Context(_serverUrl);
    			_appOnlyContext.AuthenticateWithClaims();
    		}
    		return _appOnlyContext;
    	}
    }
   

10. Create a new class, let's say FinancialEntities.cs, that inherits CSOMConfig. In this class we will add a method that reads all project entities from current pwa.
    Notice! From now on, you don't need using UMT360.Client.Application; reference anymore.

    using UMT360.Client;
    
    namespace CSOM_client_test
    {
    	public class FinancialEntities : CSOMConfig
    	{
    		/// <summary>
    		/// Reads the Financial Entities Collection from CSOM server
    		/// </summary>
    		/// <returns></returns>
    		public FinancialEntityCollection ReadFinancialEntities()
    		{
        		AppOnlyContext.ClearCache();
        		FinancialEntityCollection entities = AppOnlyContext.FinancialEntities;
        		AppOnlyContext.Load(entities);
        		AppOnlyContext.ExecuteQuery();
    
        		return entities;
    		}
    	}
    }
    

11. Back to main class, Program.cs and add using UMT360.Client; reference and create am instance of FinancialEntities than Use the method to read collection and iterate it to console output.

    // My class instance: FinancialEntities 
    FinancialEntities csom = new FinancialEntities();
    
    // Read collection of financial entities from CSOM
    FinancialEntityCollection entities = csom.ReadFinancialEntities();
    
    //List entities
    foreach(FinancialEntity entity in entities)
    {
        Console.WriteLine($"Entity: {entity.Name}");
    }