BatchExec: Операция

Операция BatchExec предназначена для пакетного выполнения других операций.

Комментарии

Данная операция позволяет выполнять несколько операций за один раз. Результатом операции BatchExec являются результаты выполнения всех операций. Для пакетного выполнения задайте в поле tArg.its коллекцию параметров выполнения отдельных операций, сериализованных в JSON/XML. Результатом выполнения операции BatchExec будет коллекция результатов выполнения отдельных операций, также представленных в JSON/XML. Для дальнейшей работы с результатами потребуется их десериализация из JSON/XML. Если при выполнении какой-либо операции возникает ошибка, то информация об ошибке будет доступна в результате вместо фактического результата выполнения. Режим выполнения операций при возникновении ошибки в какой-либо отдельной операции определяет поле tArg.bIgnoreError.

Пример

Для выполнения примера на C# используются две процедуры расширения, позволяющие произвести сериализацию и десериализацию из XML.

    public static class Extensions
    {
        /// Сериализация объекта в XML
        public static System.Xml.XmlElement ObjectToXml(this object o)
        {
            var serializer = new System.Xml.Serialization.XmlSerializer(o.GetType());
            var writer = new System.IO.StringWriter();
            serializer.Serialize(writer, o);
            var doc = new System.Xml.XmlDocument();
            doc.LoadXml(writer.ToString());
            writer.Close();
            var xml = doc.DocumentElement;
            return xml;
        }
        /// Десериализация объекта из XML
        public static Object XmlToObject(Type type, System.Xml.XmlElement xml)
        {
            var reader = new System.IO.StringReader(xml.OuterXml);
            var serializer = new System.Xml.Serialization.XmlSerializer(type);
            return serializer.Deserialize(reader);
        }
    }

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

SOAP-запрос:

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">

<s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

<its>

<it>

<tEax>

</tEax>

<tArg>

</pattern>

</tArg>

</GetEaxMd>

</it>

<it>

<tEax>

</tEax>

<tArg>

</pattern>

</tArg>

</GetEaxMd>

</it>

</its>

</tArg>

</BatchExec>

</s:Body>

</s:Envelope>

SOAP-ответ:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">

<soapenv:Body>

<it>

<id>

</id>

<meta>

EXPRESS_1

<n>Экспресс-отчет</n>

182

</obDesc>

</obInst>

<its>

<it>

<n>Куб (элементы)</n>

<cube>

OBJ183

<n>Куб (элементы)</n>

182

</obDesc>

<dest>

</dest>

</cube>

</it>

</its>

</dataSources>

<windowsPosition>Maximized</windowsPosition>

</meta>

</GetEaxMdResult>

</it>

<it>

<id>

</id>

<meta>

EXPRESS_1

<n>Экспресс-отчет</n>

182

</obDesc>

</obInst>

<its>

<it>

<id>SHEET1</id>

<eax>

</eax>

</it>

</its>

</sheets>

<windowsPosition>Maximized</windowsPosition>

</meta>

</GetEaxMdResult>

</it>

</its>

</BatchExecResult>

</soapenv:Body>

</soapenv:Envelope>

JSON-запрос:

{
 "BatchExec" : 
  {
   "tArg" : 
    {
     "its" : 
      {
       "it" : 
        [
          {
           "GetEaxMd" : 
            {
             "tEax" : 
              {
               "id" : "S2!M!S!E1"
              },
             "tArg" : 
              {
               "pattern" : 
                {
                 "obInst" : "true",
                 "dataSources" : "Get"
                }
              }
            }
          },
          {
           "GetEaxMd" : 
            {
             "tEax" : 
              {
               "id" : "S2!M!S!E1"
              },
             "tArg" : 
              {
               "pattern" : 
                {
                 "obInst" : "true",
                 "sheets" : "Get"
                }
              }
            }
          }
        ]
      },
     "bIgnoreError" : "true"
    }
  }
}

JSON-ответ:

{
 "BatchExecResult" : 
  {
   "its" : 
    {
     "it" : 
      [
        {
         "GetEaxMdResult" : 
          {
           "id" : 
            {
             "id" : "S2!M!S!E1"
            },
           "meta" : 
            {
             "obInst" : 
              {
               "obDesc" : 
                {
                 "@isShortcut" : "0",
                 "@isLink" : "0",
                 "i" : "EXPRESS_1",
                 "n" : "Экспресс-отчет",
                 "k" : "189",
                 "c" : "2561",
                 "p" : "182",
                 "h" : "0"
                },
               "openArgs" : ""
              },
             "dataSources" : 
              {
               "its" : 
                {
                 "it" : 
                  [
                    {
                     "k" : "1",
                     "id" : "OBJ183",
                     "n" : "Куб (элементы)",
                     "vis" : "1",
                     "cube" : 
                      {
                       "obDesc" : 
                        {
                         "@isShortcut" : "0",
                         "@isLink" : "0",
                         "i" : "OBJ183",
                         "n" : "Куб (элементы)",
                         "k" : "186",
                         "c" : "1287",
                         "p" : "182",
                         "h" : "0"
                        },
                       "dest" : 
                        {
                         "k" : "1",
                         "id" : "OBJ183"
                        }
                      }
                    }
                  ]
                }
              },
             "windowsPosition" : "Maximized",
             "hasPivot" : "1"
            }
          }
        },
        {
         "GetEaxMdResult" : 
          {
           "id" : 
            {
             "id" : "S2!M!S!E1"
            },
           "meta" : 
            {
             "obInst" : 
              {
               "obDesc" : 
                {
                 "@isShortcut" : "0",
                 "@isLink" : "0",
                 "i" : "EXPRESS_1",
                 "n" : "Экспресс-отчет",
                 "k" : "189",
                 "c" : "2561",
                 "p" : "182",
                 "h" : "0"
                },
               "openArgs" : ""
              },
             "sheets" : 
              {
               "active" : "0",
               "its" : 
                {
                 "it" : 
                  [
                    {
                     "k" : "189",
                     "id" : "SHEET1",
                     "n" : "Лист1",
                     "vis" : "1",
                     "eax" : 
                      {
                       "id" : "S2!M!S!E1"
                      },
                     "isActive" : "1"
                    }
                  ]
                }
              },
             "windowsPosition" : "Maximized",
             "hasPivot" : "1"
            }
          }
        }
      ]
    },
   "bSucceeded" : "1"
  }
}

public static BatchExecResult BatchExec(EaxId eax)
{
    //Параметры выполнения первой операции
    var tGet1 = new GetEaxMd()
    {
        tArg = new GetEaxMdArg()
        {
            pattern = new EaxMdPattern()
            {
                dataSources = ListOperation.Get
            }
        },
        tEax = eax
    };
    //Параметры выполнения второй операции
    var tGet2 = new GetEaxMd()
    {
        tArg = new GetEaxMdArg()
        {
            pattern = new EaxMdPattern()
            {
                sheets = ListOperation.Get
            }
        },
        tEax = eax
    };
    //Сериализация параметров в XML
    var tGetXml1 = tGet1.ObjectToXml();
    var tGetXml2 = tGet2.ObjectToXml();
    //Пакетное выполнение операций
    var somClient = new SomPortTypeClient(); //Прокси-объект для выполнения операций
    //Параметры выполнения операции
    var tExec = new BatchExec()
    {
        tArg = new BatchExecArg()
        {
            bIgnoreError = true,
            //Указание параметров операций, которые будут выполнены в рамках одного запроса
            its = new System.Xml.XmlElement[2] { tGetXml1, tGetXml2 }
        }
    };
    //Выполнение метода
    var result = somClient.BatchExec(tExec);
    return result;
}

BatchExec

Синтаксис

Параметры

Описание

Комментарии

Пример

SOAP-запрос:

SOAP-ответ:

JSON-запрос:

JSON-ответ: