Skip to main content

Fonctions spécialisées

Ces fonctions effectuent une variété d'actions spécialisées. Vous pouvez les utiliser avec tous les types de données.

Coalesce

Coalesce(v1,v2,v3,…,vn) : renvoie la première valeur non nulle.

Important

Les valeurs transmises à la fonction Coalesce doivent toutes être du même type (à savoir toutes de type chaîne, numérique ou spatial).

Exemple

Coalesce(null, "oranges", "apples", null, "grapes") renvoie oranges.

Coalesce(oranges, apples, grapes) renvoie une erreur.

Coalesce("1", "2", "3") renvoie 1.

Coalesce(null, null, null) renvoie une valeur nulle.

Coalesce(toDateTime("apples"), toDateTime(1)) renvoie 1899-12-31 00:00:00, car toDateTime("apples") renvoie une valeur nulle.

EscapeXMLMetacharacters

EscapeXMLMetacharacters(String): remplace les métacaractères XML par leurs versions avec échappement. 5 caractères possèdent une version avec échappement.

Caractère

Version avec échappement

"

"

'

'

<

&lt;

>

&gt;

&

&

Exemple

EscapeXMLMetacharacters("2>1&1<2") renvoie 2&gt;1&1&lt;2

GetVal

GetVal(index, v0,...vn): renvoie la valeur (v0, ..., vn) spécifiée par l'index en base 0.

GetEnvironmentVariable

GetEnvironmentVariable(Name): renvoie la variable d'environnement spécifiée dans Name. Pour obtenir la liste des variables d'environnement, accédez à Panneau de configuration > Système et sécurité > Système > Paramètres système avancésVariables d'environnement. La liste des variables système apparaît. Vous pouvez utiliser n'importe quelle valeur de cette liste.

Prise en charge de Server

Alteryx ne prend pas en charge GetEnvironmentVariable dans les applications enregistrées dans Server.

Exemple

GetEnvironmentVariable(CommonProgramFiles) renvoie C:\Program Files\Common Files.

GetEnvironmentVariable(OS) renvoie Windows_NT.

Message

Message(messageType, message, returnValue) : utilisez une instruction conditionnelle pour générer un message dans le journal des messages et mettre à jour les données de la colonne avec la valeur spécifiée lorsqu'une condition est satisfaite.

Le type et le texte du message sont indiqués dans la fenêtre Résultats. Si la journalisation est activée, le fichier journal de sortie est également similaire à ces informations. Consultez les pages Fenêtre Résultats et Fichier journal de sortie pour plus d'informations.

Paramètres

messageType : un nombre indiquant le type de message :

  • 1 : Messages

  • 2 : Avertissements

  • 3 : Erreurs

  • 5 : Erreurs de conversion (erreurs de conversion de champ)

  • 8 : Fichiers (entrée)

  • 9 : Fichiers (sortie)

message : le texte du message, exprimé par une chaîne entre guillemets.

returnValue : une valeur à générer dans les données de la colonne. Il peut s’agir d’une valeur numérique (par exemple, 0), null ou d’une chaîne de texte entre guillemets (par exemple, "False").

Exemple

Dans cet exemple, la fonction Message est utilisée dans une expression conditionnelle pour générer un message d'erreur de conversion de champ et mettre à jour les données de la colonne avec la valeur « False » si les valeurs de date/heure indiquées ne contiennent pas des données temporelles valides.

If [Hour] = "0" and [Minutes] = "0" then Message(5, "Invalid time in DateTime", "False") Else "True" Endif

NULL

NULL(): renvoie une valeur nulle.

RangeMedian

RangeMedian(...): calcule la médiane à partir d'une série de plages agrégées. Consultez la page Médiane de la plage pour plus d'informations.

ReadRegistryString

ReadRegistryString(Key, ValueName, DefaultValue="): renvoie une valeur du registre.

Soundex

SOUNDEX(String) : renvoie la clé Soundex de la chaîne. Soundex crée un code basé sur le premier caractère de la chaîne, plus 3 caractères en fonction des éléments suivants :

Caractère

Soundex

Caractères non alphabétiques (nombres et ponctuation)

-1

a, e, i, o, u, y, h, w

Ignorés sauf s'il s'agit du premier caractère de la chaîne.

b, f, p, v

1

c, g, j, k, q, s, x, z

2

d, t

3

l

4

m, n

5

r

6

Exemple

Si le code obtenu ne contient que 2 ou 3 caractères, Soundex utilise des zéros pour atteindre les 4 caractères. Par exemple, dans le prénom Lauren, seuls le L, le r et le n sont traduits (Lrn) ; la clé Soundex est donc L650.

Si le code obtenu possède plus de 4 caractères, tous les caractères situés après le quatrième sont ignorés. Par exemple, dans le prénom Patrick, le P, le t, le r, le c et le k peuvent être traduits (Ptrck), mais la clé Soundex ne contient que 4 caractères : P362.

Soundex_Digits

Soundex_Digits(String): renvoie les 4 premiers chiffres ou la clé Soundex si la chaîne n'en contient aucun.

  • Si la chaîne comporte des chiffres (numéros), les 4 premiers sont renvoyés.

  • Si la chaîne ne contient aucun chiffre, la clé Soundex est renvoyée.

Exemple de chaîne

Soundex_Digits

3825 Iris

3825

55555 Main

5555

14L Broadway

14

Commerce Street

C562

L Street

L236

TOPNIDX

TOPNIDX(N, v0, v1, ..., vn): renvoie la position d'index initiale en base 0 du Nième à partir de la valeur maximale lors du tri des champs indexés (v0 à vn) dans l'ordre décroissant. Les valeurs nulles sont ignorées et N doit être inférieur aux paramètres non nuls. Avec N==0, cette fonction est identique à MaxIdx(...).

  • N : Nième de la valeur maximale des champs indexés.

  • v0, v1, …, vn sont les champs indexés

Exemple

TOPNIDX(1, [IndexedField1], 5, 7) renvoie…

  • 0 si 5<[IndexedField1]<7

  • 1 si [IndexedField1] < 5 ou [IndexedField1] est nul

  • 2 si [IndexedField1] > 7

UrlEncode

UrlEncode(String): encode une chaîne UTF-16 en tant qu'URL web valide pour le moteur d'origine et l'AMP.

Important

Please note that this method is no longer recommended. We recommend the new UrlEncodeUTF8 function instead.

Exemple

C:\temp\Alteryx URL Encode renvoie C:/temp/Alteryx%20URL%20Encode

UrlEncodeUTF8

UrlEncodeUTF8(String): Encodes a string using the RFC 3986-compliant* percent-encoding. The function converts characters into UTF8-based units and it skips characters defined in the unreserved character set. Unlike the above UrlEncode function, this function doesn't skip the common URL delimiters like "/", so it's not suitable for encoding full path URLs. You should use this function to encode specific URL components, like query component parameters.

Note

*RFC 3986 is the standard for URL encoding and defines a method for encoding Unicode characters by converting them into a UTF-8 byte sequence and then representing each byte with a % (percent) sign followed by two hexadecimal digits.

Example

UrlEncodeUTF8("C:\temp\Alteryx URL Encode") returns C%3A%5Ctemp%5CAlteryx%20URL%20Encode.