GetFormulaEditorInfo: Операция

GetFormulaEditorInfoResult GetFormulaEditorInfo(MbId tMb, GetFormulaEditorInfoArg tArg)

Параметры

Описание

Операция GetFormulaEditorInfo получения списка функций, которые могут использоваться для составления выражений в различных инструментах продукта «Форсайт. Аналитическая платформа».

Комментарии

Для выполнения операции укажите в поле tMb моникёр соединения с репозиторием и в поле tArg.pattern шаблон, в соответствии с которым будет получена информация о функциях. Моникёр может быть получен при выполнении операции OpenMetabase.

Результатом операции будет список функций. Для каждой функции будут доступны, наименование, описание, синтаксис и другие дополнительные параметры. Полученные функции могут использоваться для составления различных выражений в текстовом виде или в операции SetExp. Для использования функции в выражении задайте необходимые параметры в соответствии с синтаксисом, который будет доступен в поле item.arguments.

Пример

Ниже приведён пример использования операции GetFormulaEditorInfo для получения списка функций, которые могут быть использованы в выражениях при работе с ADOMD-кубами.

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">

</tMb>

<formulaEditorFunctions>Adomd</formulaEditorFunctions>

</pattern>

</tArg>

</GetFormulaEditorInfo>

</s:Body>

</s:Envelope>

SOAP-ответ:

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

<soapenv:Body>

<its>

<Item>

<category>Время</category>

<description>Возвращает набор элементов с общим родителем, находящихся на том же уровне, что и данный элемент, начиная с первого такого элемента и заканчивая данным элементом, в соответствии с ограничениями уровня Year в измерении Time.</description>

<arguments>Ytd( [ Member_Expression*] )</arguments>

</Item>

<Item>

<category>Время</category>

<arguments>Qtd( [ Member_Expression ] )</arguments>

</Item>

<Item>

<category>Время</category>

<arguments>Mtd( [ Member_Expression ] )</arguments>

</Item>

<Item>

<category>Время</category>

<name>PARALLELPERIOD</name>

<description>Возвращает элемент предыдущего периода, расположенный в той же относительной позиции, что и заданный элемент. Несмотря на сходство с функцией Cousin, функция ParallelPeriod более тесно связана с временным рядом. Функция ParallelPeriod берет предок указанного выражения на заданном уровне, находит родственный элемент предка, отстающий на заданное число периодов, и возвращает параллельный период среди потомков этого родственного элемента.</description>

<arguments>ParallelPeriod( [ Level_Expression [ ,Index [ , Member_Expression ] ] ])</arguments>

</Item>

<Item>

<category>Время</category>

<name>PERIODSTODATE</name>

<description>Возвращает набор элементов с общим родителем, находящихся на том же уровне, что и данный элемент, начиная с первого такого элемента и заканчивая данным элементом, в соответствии с ограничениями заданного уровня в измерении Time.</description>

<arguments>PeriodsToDate( [ Level_Expression [ ,Member_Expression ] ] )</arguments>

</Item>

<Item>

<category>Время</category>

<name>LASTPERIOD</name>

<description>Возвращает набор элементов до указанного элемента включительно.</description>

<arguments>LastPeriods(Index, [Member_Expression ] )</arguments>

</Item>

<Item>

<category>Время</category>

<name>OPENINGPERIOD</name>

<description>Возвращает первый родственный элемент среди потомков указанного уровня; по желанию можно указать элемент, потомок которого будет возвращаться.</description>

<arguments>OpeningPeriod( [ Level_Expression ] , [ Member_Expression ] )</arguments>

</Item>

<Item>

<category>Время</category>

<name>CLOSINGPERIOD</name>

<description>Возвращает последний элемент среди потомков указанного элемента на указанном уровне.</description>

<arguments>ClosingPeriod( [ Level_Expression ] , [ Member_Expression ] )</arguments>

</Item>

<Item>

<category>Множества</category>

<name>TOPCOUNT</name>

<description>Сортирует набор по убыванию и возвращает заданное число элементов с самыми высокими значениями.</description>

<arguments>TopCount(Set_Expression,Count, [ Numeric_Expression ] )</arguments>

</Item>

<Item>

<category>Множества</category>

<name>BOTTOMCOUNT</name>

<description>Сортирует набор в порядке возрастания и возвращает указанное число кортежей набора с минимальными значениями.</description>

<arguments>BottomCount(Set_Expression,Count, [ Numeric_Expression ] )</arguments>

</Item>

<Item>

<category>Множества</category>

<name>CROSSJOIN</name>

<description>Возвращает перекрестное произведение двух или нескольких наборов.</description>

<arguments>Standard syntax: Crossjoin(Set_Expression1 ,Set_Expression2 [,...n] ); Alternate syntax: Set_Expression1 * Set_Expression2 [* ...n]</arguments>

</Item>

<Item>

<category>Множества</category>

<name>DESCENDANTS</name>

<description>Возвращает набор потомков элемента на указанном уровне или расстоянии, по желанию включая или исключая потомков на других уровнях.</description>

<arguments>Descendants(Member_Expression , [ Level_Expression] ,Desc_Flag ] ); Descendants(Member_Expression , [Distance ] ,Desc_Flag ] ); Descendants(Set_Expression , [Level_Expression] ,Desc_Flag ] ); Descendants(Set_Expression , [ Distance ], Desc_Flag ] ); Distance - Допустимое числовое выражение, указывающее расстояние от заданного элемента. Desc_Flag** - Допустимая строка выражения, указывающая описание флага, коррелирующего с возможными наборами потомков.</arguments>

</Item>

<Item>

<category>Множества</category>

<name>DISTINCT</name>

<description>Вычисляет заданный набор, удаляя из него повторяющиеся кортежи, и возвращает результирующий набор.</description>

<arguments>Distinct(Set_Expression)</arguments>

</Item>

<Item>

<category>Множества</category>

<name>EXCEPT</name>

<description>Обрабатывает два набора и удаляет кортежи из первого набора, существующие во втором наборе, сохраняя при необходимости одинаковые элементы.</description>

<arguments>Except(Set_Expression1, Set_Expression2, [ ALL ] )</arguments>

</Item>

<Item>

<category>Множества</category>

<name>EXISTING</name>

<description>Указывает, что заданный набор должен вычисляться принудительно в текущем контексте.</description>

<arguments>Existing Set_Expression</arguments>

</Item>

<Item>

<category>Множества</category>

<name>EXISTS</name>

<description>Возвращает набор кортежей первого указанного набора, которые один или более раз встречаются во втором наборе. Эта функция вручную выполняет операцию автоматической проверки. Если указан необязательный аргумент [имя группы="" мер=""], функция возвращает кортежи, встречающиеся один или несколько раз во втором наборе и имеющие соответствующие строки в таблице фактов заданной группы мер.</description>

<arguments>Exists( Set_Expression1 , Set_Expression2 , [ MeasureGroupName] ); MeasureGroupName - Допустимое строковое выражение, обозначающее имя группы мер.</arguments>

</Item>

<Item>

<category>Множества</category>

<name>EXTRACT</name>

<description>Возвращает набор кортежей из извлеченных элементов иерархии.</description>

<arguments>Extract(Set_Expression, Hierarchy_Expression1 [,Hierarchy_Expression2, ...n] ); Hierarchy_Expression - допустимое многомерное выражение, которое возвращает иерархию.</arguments>

</Item>

<Item>

<category>Множества</category>

<name>FILTER</name>

<description>Возвращает набор, получающийся в результате фильтрации заданного набора на основе условия поиска.</description>

<arguments>Format(Set_Expression, Logical_Expression ); Logical_Expression - Допустимое многомерное выражение иерархии, принимающее значение «true» или «false».</arguments>

</Item>

<Item>

<category>Множества</category>

<name>GENERATE</name>

<description>Применяет набор к каждому элементу другого набора и соединяет результирующие наборы. В качестве альтернативы эта функция также возвращает объединенную строку, созданную путем вычисления строкового выражения по набору.</description>

<arguments>Generate( Set_Expression1 , Set_Expression2, [ ALL ] ); Generate( Set_Expression1 , String_Expression ,[ Delimiter ] ); Delimiter - Допустимый разделитель в виде строкового выражения."</arguments>

</Item>

<Item>

<category>Множества</category>

<description>Возвращает указанное количество первых элементов набора, сохраняя повторяющиеся элементы.</description>

<arguments>Head(Set_Expression , [Count ] )</arguments>

</Item>

<Item>

<category>Множества</category>

<name>HIERARCHIZE</name>

<description>Упорядочивает элементы набора в иерархии.</description>

<arguments>Hierarchize(Set_Expression ,[ POST ] )</arguments>

</Item>

<Item>

<category>Множества</category>

<name>INTERSECT</name>

<description>Возвращает пересечение двух входных наборов, при необходимости сохраняя повторяющиеся элементы.</description>

<arguments>Intersect(Set_Expression1 , Set_Expression2 ,[ ALL ] )</arguments>

</Item>

<Item>

<category>Множества</category>

<name>NONEMPTY</name>

<description>Возвращает набор непустых кортежей из заданного набора, основываясь на прямом произведении заданного набора со вторым набором.</description>

<arguments>NONEMPTY(set_expression1 , [set_expression2])</arguments>

</Item>

<Item>

<category>Множества</category>

<name>ORDER</name>

<description>Упорядочивает элементы указанного набора, по выбору сохраняя или нарушая иерархию.</description>

<arguments>Order(Set_Expression, Numeric_Expression [ , { ASC | DESC | BASC | BDESC } ] ); Order(Set_Expression, String_Expression [ , { ASC | DESC | BASC | BDESC } ] )</arguments>

</Item>

<Item>

<category>Множества</category>

<description>Возвращает подмножество из конца набора.</description>

<arguments>Tail(Set_Expression [ ,Count ] )</arguments>

</Item>

<Item>

<category>Множества</category>

<name>UNION</name>

<description>Возвращает набор, порожденный объединением двух наборов, по желанию сохраняя повторяющиеся элементы.</description>

<arguments>Union(Set_Expression1, Set_Expression2 [,...n][, ALL]) или Set_Expression1 + Set_Expression2 [+...n] или {Set_Expression1 , Set_Expression2 [,...n]}</arguments>

</Item>

<Item>

<category>Статистика</category>

<description>Возвращает сумму числового выражения, вычисленную по указанному набору.</description>

<arguments>Sum( Set_Expression [ , Numeric_Expression ] )</arguments>

</Item>

<Item>

<category>Статистика</category>

<name>COALESCEEMPTY</name>

<description>Преобразовывает значения пустых ячеек в заданные непустые значения, которые могут быть числами или строками.</description>

<arguments>CoalesceEmpty( Numeric_Expression1 [ ,Numeric_Expression2,...n] ) или CoalesceEmpty(String_Expression1 [ ,String_Expression2,...n] )</arguments>

</Item>

<Item>

<category>Статистика</category>

<name>COUNT</name>

<description>Возвращает количество ячеек в наборе.</description>

<arguments>Count(Set_Expression [ , ( EXCLUDEEMPTY | INCLUDEEMPTY ) ] ) или Set_Expression.Count</arguments>

</Item>

<Item>

<category>Статистика</category>

<name>DISTINCTCOUNT</name>

<description>Возвращает количество неодинаковых, непустых кортежей в наборе.</description>

<arguments>DistinctCount(Set_Expression)</arguments>

</Item>

<Item>

<category>Статистика</category>

<description>Возвращает ранг (начиная с единицы) указанного кортежа в указанном наборе.</description>

<arguments>Rank(Tuple_Expression, Set_Expression [ ,Numeric Expression ] ); Tuple_Expression - Допустимое многомерное выражение, возвращающее кортеж.</arguments>

</Item>

<Item>