Creazione di funzioni di formula personalizzate

Se la funzione viene creata utilizzando solo codice XML, il file deve avere la stessa struttura dell'esempio che segue:

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

L'elemento NumParams ha un attributo variable impostato su False, perché la funzione accetta solo un numero di parametri prestabilito. Se la funzione viene creata utilizzando solo codice XML, può accettare solo un numero di parametri fisso.

L'elemento Formula contiene la formula che esegue l'operazione vera e propria. Il contenuto non è visibile all'utente e i parametri sono sempre referenziati come P1, P2, P3 e così via, indipendentemente dal testo inserito nel campo InsertText.

Per aggiungere una seconda funzione allo stesso file XML, devi creare un altro elemento Function all'interno dell'elemento FormulaAddIn.

Se vuoi utilizzare una DLL, scrivi la funzione desiderata, quindi esportala dalla DLL. Presupponendo che la funzione esportata sia definita come segue:

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
};

La funzione esportata presenta questa firma:

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

nNumArgs contiene il numero di argomenti effettivamente incluso nella chiamata.

pArgs punta a una matrice con gli argomenti effettivi.

La funzione deve restituire 1 se ha esito positivo e 0 se ha esito negativo.

pReturnValue restituisce il risultato calcolato, se la chiamata ha esito positivo, o un messaggio di errore in formato stringa, se ha esito negativo. Tutte le stringhe restituite devono essere allocate con GlobalAlloc, mentre la loro liberazione viene gestita da Alteryx Designer.

Dopo aver configurato correttamente la DLL, devi referenziarla dal file 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>

L'elemento NumParams ha un attributo variable L'attributo è impostato su True perché la funzione accetta un numero di parametri variabile. Quando il numero dei parametri è variabile, il valore deve indicare il numero minimo richiesto.

L'elemento Dll contiene due elementi figlio che forniscono le informazioni necessarie sulla DLL.

Se desideri che le tue funzioni siano disponibili in Alteryx Designer, accedi alla sottocartella RuntimeData nella cartella di installazione di Alteryx Designer. Cerca una cartella di nome FormulaAddIn. Se non esiste, creala manualmente.

C:\Program Files\Alteryx\bin\RuntimeData\FormulaAddIn

Salva il file XML nella directory \FormulaAddIn. Se utilizzi una DLL, salva il file DLL correlato nella stessa posizione. In base alla convenzione di denominazione standard, i file DLL e XML devono avere lo stesso nome.

Se nello stesso sistema vengono eseguite due istanze di Designer contemporaneamente (una amministrativa e una non amministrativa), il file XML della funzione di formula personalizzata viene visualizzato nella GUI di Designer solo se ogni versione utilizza un file specifico inserito in un percorso specifico.