Construir funções de fórmulas personalizadas

Ao criar uma função usando apenas XML, a estrutura do arquivo segue a do exemplo abaixo:

<?xml version="1.0" encoding="utf-8"?>
<FormulaAddIn>
  <Function>
    <Name>Sample_XML</Name>
    <NumParams variable="false">3</NumParams>
    <Category>Sample</Category>
    <InsertText>Sample_XML(Num1, Num2, Num3)</InsertText>
    <Description>Obtains the average of three numbers.</Description>
    <Formula>((P1+P2+P3)/3)</Formula>
  </Function>
</FormulaAddIn>

O elemento NumParams tem um atributo variável. O atributo é definido como falso porque o número de parâmetros aceitos é fixo. Ao usar apenas XML para criar uma função, o número de parâmetros aceitos é sempre fixo.

O elemento Fórmula contém a fórmula que realmente executa o trabalho. O conteúdo não é visível para o usuário. Os parâmetros são sempre referenciados como P1, P2, P3 e assim por diante, independentemente do texto apresentado em InsertText.

Para adicionar uma segunda função ao mesmo arquivo XML, crie outro elemento Função dentro do elemento FormulaAddIn.

Para usar uma DLL, grave a função desejada e, em seguida, exporte-a da DLL. Supondo que a função exportada esteja definida como:

struct FormulaAddInData{
        int nVarType;           // 1 for double, 2 for wchar_t
        int isNull;             // 1 if NULL, 0 if valid
        double dVal;            // valid if nVarType==1 && isNull==0
        const wchar_t * pVal;   // valid if nVarType==2 && isNull==0
};

A função exportada tem a assinatura:

typedef long ( _stdcall * FormulaAddInPlugin)(int nNumArgs, FormulaAddInData *pArgs, FormulaAddInData *pReturnValue);

nNumArgs contém o número real de argumentos na chamada.

pArgs aponta para uma matriz dos argumentos reais.

A função deve retornar 1 para sinal de sucesso e 0 para sinal de falha.

pReturnValue retorna o resultado calculado se a chamada for bem-sucedida ou uma mensagem de erro de cadeia de caracteres se a chamada não for bem-sucedida. Todas as cadeias de caracteres retornadas devem ser alocadas com GlobalAlloc e Alteryx Designer gerencia a liberação da cadeia de caracteres.

Com a DLL configurada com sucesso, você precisa fazer referência à DLL a partir do arquivo XML.

<?xml version="1.0" encoding="utf-8"?>
<FormulaAddIn>
  <Function>
    <Name>AddInData</Name>
    <NumParams variable="true">3</NumParams>
    <Category>Sample</Category>
    <InsertText>AddInData(VarType, isNull, double)</InsertText>
    <Description>Verifies data type before adding data.</Description>
    <Dll>
        <Name>AddInData</Name>
        <EntryPoint>FormulaAddInData</EntryPoint>
    </Dll>
  </Function>
</FormulaAddIn>

O elemento NumParams tem um atributo variável. O atributo é definido como verdadeiro porque o número de parâmetros aceitos é variável. Ao usar um número variável de parâmetros, o valor deve ser igual ao número mínimo necessário.

O elemento DLL contém dois elementos filhos que fornecem as informações necessárias sobre a DLL.

Para disponibilizar as funções no Alteryx Designer, vá para a pasta RuntimeData na instalação do Alteryx Designer. Verifique se há uma pasta intitulada \FormulaAddIn. Se a pasta não existir, crie-a.

C:\Arquivos de Programas\Alteryx\bin\RuntimeData\FormulaAddIn

Salve o arquivo XML no diretório \FormulaAddIn. Se estiver usando DLL, salve o arquivo DLL relacionado no mesmo lugar. A convenção de nomenclatura padrão é nomear os arquivos DLL e XML de forma correspondente.

No caso de duas instâncias do Designer em execução simultaneamente em uma máquina (administrador e não administrador), o arquivo XML com funções de fórmula personalizadas deve ser separado para ambas as versões por meio de caminhos diferentes para que seja exibido na interface gráfica do usuário (GUI) do Designer.