Руководство по подключению к SOAP веб-сервисам Microsoft Dynamics 365 for Operations

Описание

В D365O, как и в AX2012, доступна возможность развертывания SOAP веб-сервисов, выполняющих заданную программистом логику. Эти веб-сервисы могут принимать от подключенных к ним клиентов некоторые данные, после чего выполнить работу с таблицами D365O и вернуть результат.

Логика таких веб-сервисов написана на языке X++, но клиентские программы, подлючающиеся к веб-сервису, не зависят от языка программирования, так как они видят только генерируемый при развертывании SOAP веб-сервиса XML документ, в котором дается полное описание всех доступных методов веб-сервиса и их переменных.

Клиентские программы при работе с SOAP веб-сервисами должны настроиться на адрес сгенерированного XML документа, после чего просто вызывать один из доступных в веб-сервисе методов, используя переменные требуемых типов для передачи входных параметров и считывания результата.

Вызов веб-сервиса D365O из Desktop приложения

Подготовительный этап

Так как вызывается веб-сервис D365O, необходимо пройти процесс авторизации. Для этого сначала необходимо получить авторизационный хедер, в будущем прикрепляемый к запросу, вызывающему метод веб-сервиса:

1. Создать новый C# проект.
2. Если нет зарегистрированного приложения в Azure, зарегистрировать его, как описано в статье «Регистрация приложения в Azure».
3. Если в D365O еще не развернут сервис, к которому нужно подключиться, развернуть его, как описано в статье «Развертывание SOAP и JSON веб-сервисов в D365O».
4. Добавить Service reference на веб-сервис D365O, как описано в статье «Добавление Service reference на SOAP веб-сервис».
5. Подключить ссылку на проект с классами AuthenticationUtility из статьи «Создание классов AuthenticationUtility».

Основной код

Copy to Clipboard

Как видно, при этом используется класс из AuthenticationUtility Microsoft. При возникновении ошибки авторизации (логин или пароль введен неверно, или пользователь не имеет прав использования приложения Azure), программа прекратит работу.

Далее создается клиент. Для этого используется класс клиента веб-сервиса, на который была создана ссылка при подготовке к работе. Название класса выглядит следующим образом: «NAMESPACE СЕРВИСА В C#».«НАЗВАНИЕ СЕРВИСА В MSD»Client.

Copy to Clipboard

Так как SOAP веб-сервисы D365O требуют неразрывного подключения для своей работы, создается канал подключения. Все дальнейшие действия производятся внутри этого канала.

Copy to Clipboard

Далее создается и настраивается контекст запроса к веб-сервису. В нем мы можем указать, с какой компанией D365O мы будем работать. Представляет собой класс с названием вида «NAMESPACE СЕРВИСА В C#». CallContext.

Copy to Clipboard

После этого устанавливаются авторизационные хедеры запроса, без которых D365O не даст право использовать веб-сервис. При этом используется полученый ранее хедер.

Copy to Clipboard

Создаются входные и выходные переменные для передачи в веб-сервис.

В случае, если веб-сервис на входе или на выходе использует класс контракта, необходимо создать переменную этого класса. При этом используется имя класса вида «NAMESPACE СЕРВИСА В C#».«НАЗВАНИЕ КЛАССА КОНТРАКТА В D365O».

Copy to Clipboard

После этого можно присваивать значение переменным контракта, указав через точку выбранное в контракте имя. Например:

Copy to Clipboard

Создав все необходимые переменные, можно вызвать метод веб-сервиса командой вида «ПЕРЕМЕННАЯ КЛИЕНТА СЕРВИСА». «НАЗВАНИЕ МЕТОДА»(«КОНТЕКСТ», «ВХОДНЫЕ ДАННЫЕ (МОЖЕТ БЫТЬ НЕСКОЛЬКО)», «РЕЗУЛЬТАТ»). При чем вызывать метод нужно в try-catch, потому что программа выдаст ошибку, если пользователь имеет доступ к зарегистрированому в Azure приложению, но не имеет доступа к D365O.

Copy to Clipboard

Так как последние действия происходили в канале подключения клиента, необходимо закрыть клиент (снаружи канала).

Copy to Clipboard

Пример

В качестве примера приведено подключение к сервису для создания записи в складском журнале перемещений из статьи «Развертывание SOAP и JSON веб-сервисов в D365O» с помощью приложения Windows forms.

Copy to Clipboard

using InventJourMovementGeneratorServiceSOAP.InventJourMovementGeneratorService;
using System;
using System.Windows.Forms;

namespace InventJourMovementGeneratorServiceSOAP
{
    public partial class ServiceConnectorForm : Form
    {
        public ServiceConnectorForm()
        {
            InitializeComponent();
        }

private void generateInventJourButton_Click(
            object sender,
            EventArgs e)
        {
            try
            {
                InventJourMovementGeneratorServiceInputContract[] inputContracts = ServiceInputContractBuilder.generateInputContractsFromLines(
                    inputTextBox.Text.Split(
                        new string[]
                        {
                            "\r\n",
                            "\n"
                        },
                        StringSplitOptions.None));

this.printOutputTextFromString("Connecting D365O. Please wait...");

ServiceConnector serviceConnector = new ServiceConnector();

InventJourMovementGeneratorServiceOutputContract outputContract = serviceConnector.callService(
                    inputContracts,
                    companyTextBox.Text);

this.printOutputTextFromString(
                    outputContract.InventJournalId != "" ?
                        outputContract.InventJournalId :
                        outputContract.ErrorText);
            }
            catch (Exception ex)
            {
                this.printOutputTextFromString(ex.Message);
            }
        }

private void printOutputTextFromString(string outputText)
        {
            outputTextBox.Clear();

outputTextBox.AppendText(outputText);
        }

private void printOutputTextFromArray(string[] outputTextArray)
        {
            outputTextBox.Clear();

foreach (string outputText in outputTextArray)
            {
                outputTextBox.AppendText(
                    string.Format(
                        "{0}\r\n",
                        outputText));
            }
        }
    }
}

using InventJourMovementGeneratorServiceSOAP.InventJourMovementGeneratorService;
using System;

namespace InventJourMovementGeneratorServiceSOAP
{
    static class ServiceInputContractBuilder
    {
        public static InventJourMovementGeneratorServiceInputContract[] generateInputContractsFromLines(string[] lines)
        {
            InventJourMovementGeneratorServiceInputContract[] inputContracts = new InventJourMovementGeneratorServiceInputContract[lines.Length];

string errorText = "";

for (int i = 0; i < lines.Length; i++)
            {
                try
                {
                    InventJourMovementGeneratorServiceInputContract inputContract = ServiceInputContractBuilder.generateInputContractFromLine(lines[i]);

inputContracts[i] = inputContract;
                }
                catch (Exception ex)
                {
                    errorText += string.Format(
                        "Error in line {0}. {1}\r\n",
                        i + 1,
                        ex.Message);
                }
            }

if (errorText != "")
            {
                throw new Exception(errorText);
            }

return inputContracts;
        }

public static InventJourMovementGeneratorServiceInputContract generateInputContractFromLine(string line)
        {
            InventJourMovementGeneratorServiceInputContract inputContract = new InventJourMovementGeneratorServiceInputContract();

string[] elements = line.Split(
                new string[]
                {
                    ", "
                },
                StringSplitOptions.None);

if (elements.Length == 5)
            {
                inputContract.ItemId = elements[0];

try
                {
                    decimal qty = decimal.Parse(elements[1]);

if (qty >= 0)
                    {
                        inputContract.Qty = qty;
                    }
                    else
                    {
                        throw new Exception("Quantity must be greater than zero");
                    }
                }
                catch (FormatException)
                {
                    throw new Exception("Quantity must be a number");
                }

try
                {
                    DateTime date = Convert.ToDateTime(elements[2]);

inputContract.TransDate = date;
                }
                catch (FormatException)
                {
                    throw new Exception("Date must be in format: m/d/yyyy");
                }

inputContract.InventLocationId = elements[3];
                inputContract.WMSLocationId = elements[4];
            }
            else
            {
                throw new Exception("Line format must be: Item ID, Quantity, Date, Warehouse, Location");
            }

return inputContract;
        }
    }
}

using InventJourMovementGeneratorServiceSOAP.InventJourMovementGeneratorService;
using AuthenticationUtility;
using System;
using System.ServiceModel;
using System.ServiceModel.Channels;

namespace InventJourMovementGeneratorServiceSOAP
{
    class ServiceConnector
    {
        public InventJourMovementGeneratorServiceOutputContract callService(
            InventJourMovementGeneratorServiceInputContract[] inputContracts,
            string company)
        {
            InventJourMovementGeneratorServiceOutputContract outputContract = null;

string oauthHeader;

try
            {
                oauthHeader = OAuthHelper.GetAuthenticationHeader();
            }
            catch (Exception ex)
            {
                throw new Exception(
                    string.Format(
                        "Error. Authorization failed with exception '{0}'",
                        ex.Message));
            }

InventJourMovementGeneratorServiceClient serviceClient = new InventJourMovementGeneratorServiceClient();

var channel = serviceClient.InnerChannel;

using (OperationContextScope operationContextScope = new OperationContextScope(channel))
            {
                CallContext context = new CallContext();

HttpRequestMessageProperty requestMessage = new HttpRequestMessageProperty();

requestMessage.Headers[System.Net.HttpRequestHeader.Authorization] = oauthHeader;

OperationContext.Current.OutgoingMessageProperties[HttpRequestMessageProperty.Name] = requestMessage;

try
                {
                    serviceClient.createInventJournal(
                        context,
                        company,
                        inputContracts,
                        out outputContract);
                }
                catch (Exception ex)
                {
                    throw new Exception(
                        string.Format(
                            "Error. SOAP request failed with exception '{0}'",
                            ex.Message));
                }
            }

serviceClient.Close();

return outputContract;
        }
    }
}

Подготовил статью:

ДыкухаБорис Александрович

Senior Software Developer, OntargIT

Published On: 16 апреля, 2021 / Рубрики: ERP /

Развивайте бизнес с нами!

OntargIT является официальным партнером Microsoft по внедрению технологий Dynamics 365. С нашим опытом в различных отраслях, мы обеспечим индивидуальный подход и эффективные решения, которые будут идеально соответствовать потребностям вашей компании. Оставьте заявку сейчас, и наша команда экспертов поможет вам воспользоваться всеми преимуществами Dynamics 365.

Отправляя свои данные, я даю согласие на то, чтобы со мной связались

Развивайте бизнес с нами!

Отправляя свои данные, я даю согласие на то, чтобы со мной связались

Индустрии

Услуги

Партнеры

Описание

Вызов веб-сервиса D365O из Desktop приложения

Подготовительный этап

Основной код

Пример

Подготовил статью:

Развивайте бизнес с нами!

Развивайте бизнес с нами!

Статус Microsoft Solutions Partner с бизнес-приложений, опыт внедрения и поддержки решений Microsoft Dynamics 365, Power Platform и AI.

Статус Microsoft Solutions Partner с бизнес-приложений, опыт внедрения и поддержки решений Microsoft Dynamics 365, Power Platform и AI.

Индустрии

Услуги

Партнеры

Руководство по подключению к SOAP веб-сервисам Microsoft Dynamics 365 for Operations

Описание

Вызов веб-сервиса D365O из Desktop приложения

Подготовительный этап

Основной код

Пример

Подготовил статью:

Related Posts

Цифровая трансформация с Microsoft Dynamics 365

7 шагов для построения плана миграции на SaaS

Как достичь большей эффективности, а не объема данных в 2024 году

Развивайте бизнес с нами!

Развивайте бизнес с нами!

Статус Microsoft Solutions Partner с бизнес-приложений, опыт внедрения и поддержки решений Microsoft Dynamics 365, Power Platform и AI.

Статус Microsoft Solutions Partner с бизнес-приложений, опыт внедрения и поддержки решений Microsoft Dynamics 365, Power Platform и AI.