PowerApps-Samples DataverseSDK 예제설명 2 - CreateUpdateDelete

PowerApps-Samples DataverseSDK 예제설명 2 - CreateUpdateDelete

Dataverse SDK의 Core 3.1 이상을 지원하기 위한 SDK의 공식 사용예제에 대해 설명한다. 해당 소스는 Github 사이트에서 직접 받아볼 수 있다. Dataverse의 CURD를 해볼 수 있는 CreateUpdateDelete 프로젝트에 대해 알아본다.

프로젝트 세팅 확인

여기서는 Visual Studio 2022가 설치되어 있다는 가정하에 설명한다. VSCode등을 사용하는 사용자와는 조금 차이가 있을 수 있다.

1. 우선 한가지 이상의 인증을 갖추어야 해당 SDK를 사용가능하다. Azure AD를 이용한 것은 Azure AD App등록에서 확인하자
2. Visual Studio 사용자라면 CreateUpdateDelete.sln 파일을 열어 Visual Studio를 실행한다.
3. 프로젝트 세팅 파일로 사용할 appsettings.json 파일을 확인하면 프로젝트를 빌드시 생성이 가능하도록 '출력 디렉토리로 복사'가 새 버전이면 복사로 되어 있는 것을 확인 가능하다. 만약 Visual Studio를 사용하지 않는다면 .csproj 파일을 열어 <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>가 되어있는것을 확인하면 된다.
   
   
   
4. 해당 프로젝트의 'Nuget 패키지 관리자'를 열어 Dataverse의 연결을 위한 Microsoft.PowerPlatform.Dataverse.Client 와 설정을 위한 Microsoft.Extensions.Configuration, Microsoft.Extensions.Configuration.Json 이 설치되어있는 것을 확인한다.
   
   
   
5. appsettings.json 파일을 열어보자. 다음과 같이 되어있다.

{
  "ConnectionStrings": {
    "default": "AuthType=OAuth;Url=https://myorg.crm.dynamics.com;Username=someone@myorg.onmicrosoft.com;RedirectUri=http://localhost;AppId=51f81489-12ee-4a9e-aaae-a2591f45987d;LoginPrompt=Auto"
  },
  "Logging": {
    "LogLevel": {
      "Default": "Trace"
    }
  }
}

6. 위의 Json에서 ConnectionStrings의 default를 살펴보자 여기서 설정한 보안 정책에 맞는 Dataverse 연결문자열을 입력한다. Oauth와 ClinetSecret 중에 사용하자 참조
7. Logging 의 설정은 Ilogger의 설정에 사용된다.

소스코드

1. using 문
   • Dataverse SDK에서 반환하는 메시지를 호출하는 Microsoft.Crm.Sdk.Message
   • 설정을 관리할 수 있는 Microsoft.Extensions.Configuration
   • Dataverse의 인증을 위한 Microsoft.PowerPlatform.Dataverse.Client
   • ColumSet 을 정의하는 Microsoft.Xrm.Sdk.Query

using Microsoft.Crm.Sdk.Messages;
using Microsoft.Extensions.Configuration;
using Microsoft.PowerPlatform.Dataverse.Client;
using Microsoft.Xrm.Sdk.Query;

2. 생성자 Program()
   • 생성자에서는 appsetting.json에서 설정을 Configuration에 등록하는 과정을 갖는다. 환경설정 DATAVERSE_APPSETTINGS을 설정하지 않았다면 appsettings.json파일을 사용하게 될 것이다.
   • 설정을 지정하기 위한 IConfiguration Configuration { get; } 을 생성자 위에 설정함으로써 해당 클래스에서 생성자를 만들시 입력하도록 지정해 두었다.

Program()
{
    // 만약 환경설정에 설정 경로를 설정했다면 path에 가져온다 아니면
    // 아니면 경로를 직접 설정한 파일을 사용합니다.
    string? path = Environment.GetEnvironmentVariable("DATAVERSE_APPSETTINGS");
    if (path == null) path = "appsettings.json";

    // JSON파일을 통해 Configuration을 설정합니다.
    Configuration = new ConfigurationBuilder()
        .AddJsonFile(path, optional: false, reloadOnChange: true)
        .Build();
}

3. 메시지요청 Main()
   • ServiceClinet를 선언하고 선언시 설정값에 있는 연결문자열을 사용한다.
   • 메모리에 Entity 를 만든다. 해당 형식은 Dataverse 테이블의 행에 해당되는 정보가 담기게 된다. 생성시 account를 입력해 해당 테이블에서 사용될 것을 명시한다.
   • name에 해당되는 열에 값을 입력하고 Create를 요청해서 account에 새로운 행을 추가한다. 이때 반환되는 ID값을 저장해둔다.
   • 기존 값을 변경, 추가후 Update 를 요청해 업데이트를 한다.
   • 행을 검색하기 위해 Retrive를 요청한다. 이때 파라매터는 테이블명, 행의 GUID, 반환받을 열의 이름을 담은 ColumnSet 이 입력된다.
   • Delete를 요청해 데이터를 지운다.
   • 접속을 종료시에는 Dispose를 이용해 종료한다.

static void Main(string[] args)
{
    Program app = new();

    // default에 설정된 연결문자열을 가져와 serviceClient를 생성.
    ServiceClient serviceClient =
        new( app.Configuration.GetConnectionString("default") );

    // 메모리에 account 테이블에 해당되는 행을 만들고 name 열에 Nightmare Coffee 입력.
    Entity account = new("account");
    account["name"] = "Nightmare Coffee";

    // Dataverse의 account 테이블에 생성. 
    // 생성시 반환값 account에 새로 생성한 열의 ID를 저장해둔다.
    // 나중에 Update()를 할때 행의 ID를 이용한다.
    account.Id = serviceClient.Create(account);

    // 데이터 버스에 Update를 요청한다. name과 address2_postalcode 를 변경.
    account["name"] = "Fourth Coffee";
    account["address2_postalcode"] = "98052";
    serviceClient.Update(account);

    // Dataverse에서 업데이트 된 행 검색.
    Entity retrievedAccount = serviceClient.Retrieve(
        entityName: account.LogicalName,
        id: account.Id,
        columnSet: new ColumnSet("name", "address2_postalcode")
    );

    Console.WriteLine("Retrieved account name: {0}, postal code: {1}",
        retrievedAccount["name"], retrievedAccount["address2_postalcode"]);

    // 잠시 확인시간을 갖기 위해 멈춤
    Console.WriteLine("Press any key to undo environment data changes.");
    Console.ReadKey();

    // Dataverse에서 Delete 작업을 실행 후 클라이언트를 종료.
    serviceClient.Delete(account.LogicalName, account.Id);
    serviceClient.Dispose();
}

결론

1. 인증에대한 정책이 바뀌면서 .Net core 3.1 이상의 버전에서 SDK를 사용하도록 제공하려는 것으로 보인다.
2. Client package를 받은 것 만으로 기존 Xrm, Crm SDK가 같이 설치된다. 기존의 .NET Framework때 사용되는 SDK를 통합하여 새로운 .NET 버전에서도 돌아가게 하도록 만드는 것으로 보인다. 하지만 .NET Framework 기반으로 만들어졌던 SDK라 리눅스 등의 OS에서 사용시에는 주의해야할 것이다.
   
   
   
3. 아쉽게도 기존 Xrm, Crm SDK는 파라메터 입력이나 반환값을 튜플을 사용하지 않는다. 만약 사용하려면 별도의 라이브러리를 만들어 튜플을 이용할 수 있도록 만들어야할 것으로 보인다.