get channel-parameter(a, [withContact b], [MapName c])
Gruppe |
Liefert die Parameter des Partner-Kanals a als CSV-Textzeile zurück. Als CSV-Trennzeichen wird ein Komma (,) verwendet. Die Felder haben folgende Bedeutung.
<channel>,<localid>,<remoteid>,<remoteaddress>,<type> |
Durch den optionalen Parameter b=true kann das Ergebnis der Funktion um die Kontakt-Daten des Partner-Kanals erweitert werden. Das Ergebnis enthält dann folgende Felder.
<channel>,<localid>,<remoteid>,<remoteaddress>,<type>,<error>,<name>,<phone>,<fax>,<email>,<language> |
Die Ermittlung der Kontaktdaten fordert mehr Ressourcen. Wenn dabei ein Fehler auftritt, bricht die Funktion nicht ab, sondern in diesem Fall enthält das Feld <error> eine Fehlermeldung. Andernfalls ist <error> leer und die folgenden Felder enthalten die Kontaktdaten, falls diese für den Kanal gepflegt wurden.
Wird kein Kanal mit angegebener ID gefunden, wird ein leerer String zurückgegeben.
Wenn Parameter a=header ist, werden die Header zurückgegeben, anstelle der Werte.
Mit a=h werden alternative Header ausgegeben, die jeweils nur aus einem Kleinbuchstaben bestehen. Sowohl die Langform, als auch die Kurzform der Header kann als Key für den Zugriff auf die Einzelwerte der optionalen Map c verwendet werden.
Als optionaler Parameter c kann der Name einer Map angegeben werden, die den Zugriff auf die einzelnen Werte unter dem Header-Namen als Key erlauben. Die Map wird vorher geleert. Bei leerem Parameter c wird keine Map verwendet.
Wenn in Parameter a ein nicht-leerer Wert übergeben wird, der weder eine positive Ganzzahl ist, noch einer der beiden Schlüssel header bzw. h, erfolgt ein Abbruch mit Fehler.
Parameterbeschreibung
Parameter |
Beschreibung |
a |
Kanal-ID. |
b |
(optional) true, wenn auch Kontaktinformationen geliefert werden sollen. |
c |
(optional) Name einer Map, die den Zugriff auf einzelne Felder des Ergebnisses unter dem Header-Namen des Feldes als Key erlaubt. |
Beispiele
In der Partnerverwaltung seien für den Partner Lobster zwei Kanäle mit folgenden (vereinfacht dargestellten) Eigenschaften definiert.
Kanal-ID |
Name |
1 |
Lobster:FTP |
2 |
Lobster:AS2 |
Damit werden folgende Ergebnisse geliefert.
Parameter a |
Parameter b |
Parameter c |
Ergebnis |
1 |
|
|
Lobster:FTP,Lobster_Test,Partner,ftp://example.com:21 |
2 |
|
|
Lobster:AS2,L_AS2_P,Other_AS2,https://other.example.net:443/partner/AS2Retrieve/ |