RecordSet

Datensätze

Implementiert

• AsyncIterable<Record>
• AsyncDisposable

Eigenschaften

CurrentRecord

get CurrentRecord(): Promise<Record>

Liefert den aktuellen Datensatz als Objekt vom Typ Record zurück.

Rückgabewert

Promise<Record>

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:12415

---

HasMultipleRecords

get HasMultipleRecords(): Promise<boolean>

Gibt true zurück, wenn das RecordSet mehr als einen Datensatz beinhaltet. Diese Methode ist deutlich effizienter als die Abfrage von RecCount , insofern bei einem Filter genau ein Treffer erwartet wird, aber auch der Fall mit mehreren Treffern sauber behandelt werden soll.

Rückgabewert

Promise<boolean>

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:12377

---

IsDisposed

get IsDisposed(): boolean

Gibt an, ob das Objekt bereits Freigegeben wurde

Rückgabewert

boolean

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:12434

---

RecCount

get RecCount(): Promise<number>

Liefert die Anzahl der Datensätze im aktuellen RecordSet Objekt zurück.
Sollte das RecordSet Objekt zuvor gefiltert worden sein, dann wird die Anzahl der im Filter befindlichen Datensätze zurückgeliefert. Ohne aktiven Filter erhält man die Gesamtzahl der Datensätze

Rückgabewert

Promise<number>

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:12387

---

SortOrder

get SortOrder(): Promise<number>

Gibt die aktuell gesetzte Sortierung zurück
0 = Ohne Sortierung

Rückgabewert

Promise<number>

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:12397

---

ViewName

get ViewName(): string

Gibt den Namen des übergeordneten View Objektes zurück.

Rückgabewert

string

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:12406

Methoden

CalcAggregationValues()

CalcAggregationValues(sqlExpression): Promise<DataItem>

Erlaubt die Berechnung von Aggregationsergebnissen basierend auf dem aktuellen Filter.

Parameter

Parameter	Type	Description
sqlExpression	string	Übergabe des SQL-Ausdrucks. Ergebnis sollten Spalten sein, die beispielsweise auch bei der Nutzung von SELECT den Rückgabewert darstellen. Etwaige Spaltendatentypen bleiben, soweit möglich, erhalten. Unbenannte Spaltennamen ohne Alias erhalten die Namen $Field1 bis $FieldN.

Rückgabewert

Promise<DataItem>

Example

Beispielaufruf

CalcAggregationValues("count(1) as Counter, min(\"Birthday\") as Oldest, max(\"Birthday\") as Youngest");

Remarks

Version 12.0.0

Die Methode/Eigenschaft wird erst ab dieser Version unterstützt. Bei vorherigen Versionen führt der Aufruf zu einer Exception.

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:12473

---

CreateCopy()

CreateCopy(cursorMode?): Promise<RecordSet>

Erstellt eine Kopie des aktuellen RecordSet Objekts, um dieses beispielsweise per Filter weiter einzugrenzen, ohne dafür das zugrundeliegende RecordSet Objekt verändern zu müssen.

Parameter

Parameter	Type	Description
cursorMode?	CRMCursorMode	Optional Voreinstellung: SolutionDefault - Ermöglicht die Spezifikation des Datenbankcursormodells, das für den zurückgegebenen RecordSet genutzt werden soll. ForwardOnly ist das schnellste Model, hierbei gilt jedoch die Einschränkung das keine Verzögerung durch zum Beispiel Dialoge, MessageBoxen, Mailversand oder Druck bei der Iteration über das RecordSet stattfinden darf. Für diese Anwendungsfälle empfiehlt es sich FullDynamic zu setzen

Rückgabewert

Promise<RecordSet>

Remarks

Version 12.0.0

Verhaltensänderung. Der Standardparameter forwardOnly wurde von false auf SolutionDefault geändert

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:12497

---

DeleteAllRecords()

DeleteAllRecords(): Promise<boolean>

Löscht alle Datensätze im Filter des aktuellen RecordSet -Objektes

Rückgabewert

Promise<boolean>

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:12532

---

DialogEditFormula()

DialogEditFormula(
   windowTitle, 
   formula, 
   useRealData?, 
   allowedResultType?, 
parentHandle?): Promise<CRMDialogResultExt<string>>

Stellt den Formel-Assistenten basierend auf den Feldern des aktuellen RecordSet dar

Parameter

Parameter	Type	Description
windowTitle	string	Titel des Dialogs inklusive des Anhangs" bearbeiten". Wenn eine leere Zeichenkette übergeben wird, wird "Formel bearbeiten" verwendet.
formula	string	Zu bearbeitende Formel.
useRealData?	boolean	Optional - true : Es wird in der Formelergebnis-Vorschau mit den aktuellen Werten des aktuellen Datensatzes gearbeitet. false : Es werden keine Echtdaten verwendet.
allowedResultType?	FormulaResultType	Optional. Standardwert: Text + Numerisch
parentHandle?	number	Optional Standardwert: Aktuell aktives cRMFenster - Ermöglicht die Übergabe eines Handles für das Elternfenster

Rückgabewert

Promise<CRMDialogResultExt<string>>

Enthält die Formel in Value .
Bei Benutzerabbruch ist IsCanceled gesetzt.
Bei einem Fehler ist HasError gesetzt und genauere Informationen zum Fehler befinden sind in Error .

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:12552

---

DialogFilterAssistant()

DialogFilterAssistant(
   windowTitle, 
   filterStatementFile, 
   disableAskString?, 
parentHandle?): Promise<CRMDialogResultExt<string>>

Stellt den Dialog des Filter-Assistenten dar. Es besteht die Möglichkeit eine .crmshare-Datei zu übergeben, welche einen bereits erstellten, zum Dialog passenden, Filterausdruck enthält. Als Rückgabewert erhält man eine .crmshare-Datei, welche den zusammengestellten Filterausdruck enthält. Das anschließende Bereinigen der erstellten .crmshare-Datei wird nicht vom cRM durchgeführt.

Parameter

Parameter	Type	Description
windowTitle	string	Fenster Titel. Aktuell reserviert
filterStatementFile	string	Pfad zu einer .crmshare-Datei, welche einen bereits erstellten, zum Dialog passenden, Filterausdruck enthält. Falls eine solche Datei nicht vorhanden ist kann eine leere Zeichenkette übergeben werden.
disableAskString?	boolean	Optional Standardwert false - true Benutzereingabe als Filter-Element wird nicht angeboten
parentHandle?	number	Optional Standardwert: Aktuell aktives cRMFenster - Ermöglicht die Übergabe eines Handles für das Elternfenster

Rückgabewert

Promise<CRMDialogResultExt<string>>

Enthält den Pfad zur .crmshare-Datei in Value .
Bei Benutzerabbruch ist IsCanceled gesetzt.
Bei einem Fehler ist HasError gesetzt.

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:12623

---

DialogFilterGeneral()

DialogFilterGeneral(
   windowTitle, 
   filterStatementFile, 
   disableAskString?, 
parentHandle?): Promise<CRMDialogResultExt<string>>

Stellt den Dialog des Filter-Allgemein dar. Es besteht die Möglichkeit eine .crmshare-Datei zu übergeben, welche einen bereits erstellten, zum Dialog passenden, Filterausdruck enthält. Als Rückgabewert erhält man eine .crmshare-Datei, welche den zusammengestellten Filterausdruck enthält. Das anschließende Bereinigen der erstellten .crmshare-Datei wird nicht vom cRM durchgeführt.

Parameter

Parameter	Type	Description
windowTitle	string	Fenster Titel. Aktuell reserviert
filterStatementFile	string	Pfad zu einer .crmshare-Datei, welche einen bereits erstellten, zum Dialog passenden, Filterausdruck enthält. Falls eine solche Datei nicht vorhanden ist kann eine leere Zeichenkette übergeben werden.
disableAskString?	boolean	Optional Standardwert false - true Benutzereingabe als Filter-Element wird nicht angeboten
parentHandle?	number	Optional Standardwert: Aktuell aktives cRMFenster - Ermöglicht die Übergabe eines Handles für das Elternfenster

Rückgabewert

Promise<CRMDialogResultExt<string>>

Enthält den Pfad zur .crmshare-Datei in Value .
Bei Benutzerabbruch ist IsCanceled gesetzt.
Bei einem Fehler ist HasError gesetzt.

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:12677

---

DialogFilterSQLQuery()

DialogFilterSQLQuery(
   windowTitle, 
   filterStatementFile, 
   disableAskString?, 
parentHandle?): Promise<CRMDialogResultExt<string>>

Stellt den Dialog des Filter-SQL-Abfrage dar. Es besteht die Möglichkeit eine .crmshare-Datei zu übergeben, welche einen bereits erstellten, zum Dialog passenden, Filterausdruck enthält. Als Rückgabewert erhält man eine .crmshare-Datei, welche den zusammengestellten Filterausdruck enthält. Das anschließende Bereinigen der erstellten .crmshare-Datei wird nicht vom cRM durchgeführt.

Parameter

Parameter	Type	Description
windowTitle	string	Fenster Titel. Aktuell reserviert
filterStatementFile	string	Pfad zu einer .crmshare-Datei, welche einen bereits erstellten, zum Dialog passenden, Filterausdruck enthält. Falls eine solche Datei nicht vorhanden ist kann eine leere Zeichenkette übergeben werden.
disableAskString?	boolean	Optional Standardwert false - true Benutzereingabe als Filter-Element wird nicht angeboten
parentHandle?	number	Optional Standardwert: Aktuell aktives cRMFenster - Ermöglicht die Übergabe eines Handles für das Elternfenster

Rückgabewert

Promise<CRMDialogResultExt<string>>

Enthält den Pfad zur .crmshare-Datei in Value .
Bei Benutzerabbruch ist IsCanceled gesetzt.
Bei einem Fehler ist HasError gesetzt.

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:12731

---

DialogSelectRecord()

DialogSelectRecord(
   windowTitle, 
   allowUserDefinedSortOrder?, 
parentHandle?): Promise<Record>

Ermöglicht die Auswahl eines Datensatzes basierend auf dem aktuellen Filter des RecordSet Objektes. Das Ergebnis ist ein Objekt vom Typ Record .
Wenn kein Datensatz ausgewählt wurde, wird null zurückgegeben.

Parameter

Parameter	Type	Description
windowTitle	string	Fenstertitel des erzeugten Dialoges. Der Titel kann auch leer übergeben werden, dann wird eine Grundeinstellung genommen.
allowUserDefinedSortOrder?	boolean	true : Eine etwaige vom Benutzer in diesem Dialog zuletzt eingestellte Sortierung wird verwendet. Standardmäßig wird die erste Sortierung aktiviert, die in der zum RecordSet gehörenden Ansicht definiert wurde. false : Es wird die im RecordSet eingestellte Sortierung verwendet. Ist keine eingestellt, so wird die erste Sortierung aktiviert, die in der zum RecordSet gehörenden Ansicht definiert wurde.
parentHandle?	number	Optional. Handle eines Fensters, das als Parent-Fenster für den Dialog verwendet werden soll.

Rückgabewert

Promise<Record>

Rückgabe: Record wenn ein Datensatz ausgewählt wurde, andernfalls null

Remarks

Version 12.0.0

Das zurückgegebene Record-Objekt wird als Referenz zurückgegeben, ein nachträgliche Aufruf von z.B. MoveNext kann das zurückgegebene Record-Objekt aktiv verändern.
Diese Methode steht nicht zur Verfügung wenn das RecordSet per forwardOnly(true) erzeugt wurde.
Ab dieser Version sollte als Basis dieser Methode ein RecordSet mit der SortOrder 1 zugrundeliegen.

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:12790

---

DialogSelectRecordMultiple()

DialogSelectRecordMultiple(
   windowTitle, 
   allowUserDefinedSortOrder?, 
parentHandle?): Promise<RecordSet>

Ermöglicht die Auswahl mehrerer Datensätze basierend auf dem aktuellen Filter des RecordSet Objektes. Das Ergebnis ist ein neues unabhängiges Objekt vom Typ RecordSet , welches die gefiltertern Datensätze enthält.
Wenn ohne Setzen eines Häkchens einer Checkbox für die Datensatzauswahl der Dialog mit OK bestätigt wird, wird der blau hinterlegte und selektierte Datensatz an das RecordSet übergeben. Dies kann ebenso mit einem Doppelklick auf den gewünschten Datensatz erreicht werden, sofern noch keine anderen Datensätze angehakt wurden.
Wenn kein Datensatz ausgewählt werden soll, muss die Abbrechen-Schaltfläche betätigt werden – es wird dann null zurückgegeben.

Parameter

Parameter	Type	Description
windowTitle	string	Fenstertitel des erzeugten Dialoges. Der Titel kann auch leer übergeben werden, dann wird eine Grundeinstellung genommen.
allowUserDefinedSortOrder?	boolean	true : Eine etwaige vom Benutzer in diesem Dialog zuletzt eingestellte Sortierung wird verwendet. Standardmäßig wird die erste Sortierung aktiviert, die in der zum RecordSet gehörenden Ansicht definiert wurde. false : Es wird die im RecordSet eingestellte Sortierung verwendet. Ist keine eingestellt, so wird die erste Sortierung aktiviert, die in der zum RecordSet gehörenden Ansicht definiert wurde.
parentHandle?	number	Optional. Handle eines Fensters, das als Parent-Fenster für den Dialog verwendet werden soll.

Rückgabewert

Promise<RecordSet>

Rückgabe: RecordSet wenn Datensätze ausgewählt wurden, andernfalls null

Remarks

Version 12.0.0

Diese Methode steht nicht zur Verfügung wenn das RecordSet per forwardOnly(true) erzeugt wurde.
Ab dieser Version sollte als Basis dieser Methode ein RecordSet mit der SortOrder 1 zugrundeliegen.

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:12849

---

DisposeAsync()

DisposeAsync(): Promise<void>

Standardimplementierung des AsyncDispose

Rückgabewert

Promise<void>

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:13525

---

ExecuteInstantReportByName()

ExecuteInstantReportByName(name): Promise<boolean>

Führt einen abgespeicherten Sofortbericht anhand seines Namens aus.

Parameter

Parameter	Type	Description
name	string	Name des Sofortberichts. Groß- / Kleinschreibung wird beachtet!

Rückgabewert

Promise<boolean>

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:12896

---

Export()

Export(format): Promise<boolean>

Startet den Export-Assistenten und führt das übergebene Benutzerformat aus. Es werden alle Einstellungen dieses Formates verwendet.

Parameter

Parameter	Type	Description
format	string	Name des Exportformates. Es kann sich dabei um einen kompletten Dateipfad auf eine .etp Format-Datei handeln, alternativ um den Formatnamen, so wie er im Assistenten dargestellt wird, dabei werden zuerst die benutzerspezifischen Formate durchsucht, anschließend die globalen Formate. Bitte beachten Sie die Großkleinschreibung.

Rückgabewert

Promise<boolean>

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:12907

---

FindRecordByDupeCheckCriteria()

FindRecordByDupeCheckCriteria(
   recordId, 
   fieldContent1, 
   fieldContent2?, 
   fieldContent3?, 
   fieldContent4?, 
   fieldContent5?, 
   fieldContent6?, 
   fieldContent7?, 
   fieldContent8?, 
useCurrentQuery?): Promise<boolean>

Führt den Online-Dublettencheck anhand der übergebenen Werte und den definierten Kriterien für Dubletten aus.

Parameter

Parameter	Type	Description
recordId	string	ID des Datensatzes, welcher vom DublettenCheck ausgeschlossen werden soll. Wenn dieser Parameter leer übergeben wird, dann werden alle Datensätze einbezogen.
fieldContent1	string	Inhalt des ersten Kriteriums für den Dublettencheck.
fieldContent2?	string	Optional, Inhalt des zweiten Kriteriums für den Dublettencheck.
fieldContent3?	string	Optional, Inhalt des drittens Kriteriums für den Dublettencheck.
fieldContent4?	string	Optional, Inhalt des vierten Kriteriums für den Dublettencheck.
fieldContent5?	string	Optional, Inhalt des fünften Kriteriums für den Dublettencheck.
fieldContent6?	string	Optional, Inhalt des sechsten Kriteriums für den Dublettencheck.
fieldContent7?	string	Optional, Inhalt des siebten Kriteriums für den Dublettencheck.
fieldContent8?	string	Optional, Inhalt des achten Kriteriums für den Dublettencheck.
useCurrentQuery?	boolean	Optional Voreinstellung: false - gibt an, ob lediglich innerhalb des aktuellen Filters gesucht werden soll.

Rückgabewert

Promise<boolean>

true Es gab Treffer, für das RecordSet ist nun der entsprechende Filter aktiv

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:12928

---

FindRecordByEmail()

FindRecordByEmail(
   email, 
   reduceEmail, 
useCurrentQuery?): Promise<boolean>

Sucht alle Datensätze, bei denen in einem eMail-Feld eine bestimmte eMail-Adresse vorhanden ist. Diese unscharfe Suche findet auch eMail-Adressen derselben Domain falls kein direkter Treffer vorhanden ist.

Parameter

Parameter	Type	Description
email	string	Die eMail-Adresse, nach der in allen eMail-Feldern gesucht werden soll.
reduceEmail	boolean	Wenn true , dann wird die eMail-Adresse schrittweise in bis zu vier Durchläufen durch Auslassen von Top-Level-Domain, Domain, Lokalteil gesucht, falls es nicht bereits Treffer gab. So können auch eMails unterschiedlicher Domains gefunden werden
useCurrentQuery?	boolean	Optional Voreinstellung: false - gibt an, ob lediglich innerhalb des aktuellen Filters gesucht werden soll.

Rückgabewert

Promise<boolean>

true Es gab Treffer, für das RecordSet ist nun der entsprechende Filter aktiv

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:12970

---

FindRecordByPhoneNumber()

FindRecordByPhoneNumber(
   phoneNumber, 
   reducePhoneNumber, 
useCurrentQuery?): Promise<boolean>

Sucht alle Datensätze, bei denen in einem Telefon-Feld eine bestimmte Telefonnummer vorhanden ist, analog zur Rufnummernerkennung durch den phone manager.

Parameter

Parameter	Type	Description
phoneNumber	string	Die Telefonnummer, nach der in allen Telefonfeldern gesucht werden soll. Die Telefonnummer darf telefonspez.Sonderzeichen wie zum Beispiel '/', '+', '-' enthalten
reducePhoneNumber	boolean	Wenn true , dann wird die Telefonnummer schrittweise um bis zu 4 Stellen verkürzt, falls es nicht bereits Treffer gab.So können auch unterschiedliche Durchwahl-Nummern gefunden werden.
useCurrentQuery?	boolean	Optional Voreinstellung: false - gibt an, ob lediglich innerhalb des aktuellen Filters gesucht werden soll.

Rückgabewert

Promise<boolean>

true Es gab Treffer, für das RecordSet ist nun der entsprechende Filter aktiv

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:12991

---

Import()

Import(format): Promise<boolean>

Startet den Import-Assistenten und führt das übergebene Benutzerformat aus. Es werden alle Einstellungen dieses Formates verwendet.

Parameter

Parameter	Type	Description
format	string	Name des Importformates. Es kann sich dabei um einen kompletten Dateipfad auf eine .itp Format-Datei handeln, alternativ um den Formatnamen, so wie er im Assistenten dargestellt wird, dabei werden zuerst die benutzerspezifischen Formate durchsucht, anschließend die globalen Formate. Bitte beachten Sie die Großkleinschreibung.

Rückgabewert

Promise<boolean>

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:13009

---

MoveFirst()

MoveFirst(): Promise<boolean>

Bewegt den Datensatz-Zeiger auf den Anfang des RecordSet .

Rückgabewert

Promise<boolean>

true wenn der Pointer auf den ersten Datensatz gewechselt werden konnte, andernfalls false

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:13020

---

MoveLast()

MoveLast(): Promise<boolean>

Bewegt den Datensatz-Zeiger auf das Ende des RecordSet .

Rückgabewert

Promise<boolean>

true wenn der Pointer auf den letzten Datensatz gewechselt werden konnte, andernfalls false

Remarks

Version 12.0.0

Diese Methode steht nicht zur Verfügung wenn das RecordSet per forwardOnly(true) erzeugt wurde.

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:13035

---

MoveNext()

MoveNext(): Promise<boolean>

Bewegt den Datensatz-Zeiger um einen Datensatz vorwärts.

Rückgabewert

Promise<boolean>

true wenn der Pointer auf den nächsten Datensatz gewechselt werden konnte, andernfalls false

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:13046

---

MovePrevious()

MovePrevious(): Promise<boolean>

Bewegt den Datensatz-Zeiger um einen Datensatz rückwärts.

Rückgabewert

Promise<boolean>

true wenn der Pointer auf den vorherigen Datensatz gewechselt werden konnte, andernfalls false

Remarks

Version 12.0.0

Diese Methode steht nicht zur Verfügung wenn das RecordSet per forwardOnly(true) erzeugt wurde.

Deprecated

Diese Methode sollte aus Performance Gründen nicht mehr verwendet werden.

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:13062

---

NewRecord()

NewRecord(): Promise<Record>

Erzeugt einen neuen Datensatz und liefert diesen als Objekt vom Typ Record zurück.

Rückgabewert

Promise<Record>

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:13071

---

PrintCard()

PrintCard(
   media, 
   fileName, 
   silent, 
   range, 
   outputFileName?, 
   useModalPreviewWindow?, 
exportOptions?): Promise<boolean>

Druckt ein Karteikartenprojekt aus. Neben dem Druckziel muss u.a. der Name des gewünschten Druckprojektes angegeben werden.

Parameter

Parameter	Type	Description
media	PrintOutputMedia	Ausgabe-Medium
fileName	string	Dateiname inkl. Pfad der Druckvorlage
silent	boolean	Legt fest, ob der Druck (nach Möglichkeit) ohne Benutzerinteraktion erfolgen soll.
range	boolean	true : Es werden alle Datensätze im aktuellen Filter/Datenbank ausgegeben, entspricht dem Seriendruck. false : Es wird nur der aktuelle Datensatz ausgegeben, entspricht dem Einzeldruck
outputFileName?	string	Evtl. Name und Pfad der zu erzeugenden Ausgabe-Datei bei Ausgabe-Medien wie z.B. "RTF" oder "HTML". In allen anderen Fällen kann ein leerer String übergeben werden.
useModalPreviewWindow?	boolean	Optional Voreinstellung true - Legt fest, ob der Druck auf Vorschau (PRV) in das normale Vorschaufenster gedruckt wird oder in die Berichtsansicht( false ).
exportOptions?	string	Export-Optionen für Print-Methoden siehe SDK

Rückgabewert

Promise<boolean>

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:13097

---

PrintLabel()

PrintLabel(
   media, 
   fileName, 
   silent, 
   range, 
   outputFileName?, 
   useModalPreviewWindow?, 
exportOptions?): Promise<boolean>

Druckt ein Etikettenprojekt aus. Neben dem Druckziel muss u.a. der Name des gewünschten Druckprojektes angegeben werden.

Parameter

Parameter	Type	Description
media	PrintOutputMedia	Ausgabe-Medium
fileName	string	Dateiname inkl. Pfad der Druckvorlage
silent	boolean	Legt fest, ob der Druck (nach Möglichkeit) ohne Benutzerinteraktion erfolgen soll.
range	boolean	true : Es werden alle Datensätze im aktuellen Filter/Datenbank ausgegeben, entspricht dem Seriendruck. false : Es wird nur der aktuelle Datensatz ausgegeben, entspricht dem Einzeldruck
outputFileName?	string	Evtl. Name und Pfad der zu erzeugenden Ausgabe-Datei bei Ausgabe-Medien wie z.B. "RTF" oder "HTML". In allen anderen Fällen kann ein leerer String übergeben werden.
useModalPreviewWindow?	boolean	Optional Voreinstellung true - Legt fest, ob der Druck auf Vorschau (PRV) in das normale Vorschaufenster gedruckt wird oder in die Berichtsansicht( false ).
exportOptions?	string	Export-Optionen für Print-Methoden siehe SDK

Rückgabewert

Promise<boolean>

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:13132

---

PrintReport()

PrintReport(
   media, 
   fileName, 
   silent, 
   range, 
   outputFileName?, 
   useModalPreviewWindow?, 
exportOptions?): Promise<boolean>

Druckt ein Listenprojekt aus. Neben dem Druckziel muss u.a. der Name des gewünschten Druckprojektes angegeben werden.

Parameter

Parameter	Type	Description
media	PrintOutputMedia	Ausgabe-Medium
fileName	string	Dateiname inkl. Pfad der Druckvorlage
silent	boolean	Legt fest, ob der Druck (nach Möglichkeit) ohne Benutzerinteraktion erfolgen soll.
range	boolean	true : Es werden alle Datensätze im aktuellen Filter/Datenbank ausgegeben, entspricht dem Seriendruck. false : Es wird nur der aktuelle Datensatz ausgegeben, entspricht dem Einzeldruck
outputFileName?	string	Evtl. Name und Pfad der zu erzeugenden Ausgabe-Datei bei Ausgabe-Medien wie z.B. "RTF" oder "HTML". In allen anderen Fällen kann ein leerer String übergeben werden.
useModalPreviewWindow?	boolean	Optional Voreinstellung true - Legt fest, ob der Druck auf Vorschau (PRV) in das normale Vorschaufenster gedruckt wird oder in die Berichtsansicht( false ).
exportOptions?	string	Export-Optionen für Print-Methoden siehe SDK

Rückgabewert

Promise<boolean>

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:13167

---

RecCountWithoutGeoCoordinates()

RecCountWithoutGeoCoordinates(aliasName): Promise<number>

Gibt die Anzahl der unkodierten Datensätze für eine Adress-Definition zurück. Die Geokodierung der Adresse ist Voraussetzung für den Umkreis-Filter, siehe auch SetFilterByGeo(filterType: GeoFilterType, filterOperation: GeoFilterOperation, notGeocodedRecordAction: NotGeocodedRecordAction, multipleResultAction: GeoMultipleResultAction, aliasName: string, address: string, distance: number, useCurrentQuery?: boolean) .

Parameter

Parameter	Type	Description
aliasName	string	Name der Adresse (siehe Ansichtskonfiguration > Adressen)

Rückgabewert

Promise<number>

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:13195

---

RelationalAppend()

RelationalAppend(name): Promise<boolean>

Führt eine abgespeicherte Vorlage für relationales Ergänzen über den Namen aus. Diese kann über den Menüpunkt Organisieren > Relational Ergänzen > Allgemein erzeugt werden.

Parameter

Parameter	Type	Description
name	string	Name der abgespeicherten Vorlage. Hinweis: Bitte beachten Sie, dass nicht die Bezeichnung des Filterausdrucks verwendet wird, sondern der 'Name für Scripte'

Rückgabewert

Promise<boolean>

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:13206

---

RelationalAppendDirect()

RelationalAppendDirect(relation, parameter): Promise<boolean>

Direktes relationales Ergänzen in einer Relationsansicht. Die Übergabe der Werte erfolgt in folgendem Format:
{FeldName1}={Inhalt/Formel1}\t{FeldName2}={Inhalt/Formel2}\t...

Parameter

Parameter	Type	Description
relation	Relation	Relationsobjekt
parameter	string	Wertepaar

Rückgabewert

Promise<boolean>

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:13218

---

SendBulkMail()

SendBulkMail(
   templatePath, 
   errorTagFilePath, 
   silent?, 
   mailsSentTagFilePath?, 
   files?, 
showDialog?): Promise<boolean>

Sendet eine Serien-eMail. Der Mailversand über diese Methode verhält sich analog zum Serien-Mailversand in der Anwendung.

Parameter

Parameter	Type	Description
templatePath	string	Pfad zur Mailvorlage
errorTagFilePath	string	Pfad zur .tag-Datei für manuelles Filtern. Diese wird erstellt, wenn es im RecordSet Datensätze mit leeren eMail-Feldern gibt und enthält alle diese Datensätze. Falls ein leerer String übergeben wird, wird eine Datei im temp-Verzeichnis mit Standardnamen angelegt.
silent?	boolean	Optional Voreinstellung: false - true Hinweisdialoge werden ausgeblendet
mailsSentTagFilePath?	string	Optional - Pfad zur .tag-Datei für manuelles Filtern. Diese Datei enthält alle Datensätze, an die eine eMail versendet werden konnte. Über diesen Parameter kann der Pfad und Name der Datei geändert werden. Ohne Angabe dieses Parameters wird die Datei in %TEMP%\MailsSentTo.tag gespeichert und bei jedem Serienmailing (auch mittels „Ausgeben > SerieneMail“) überschrieben.
files?	string[]	Optional - Liste von eMail-Anhängen. Beachten Sie bitte, dass die übergebenen Anhänge stets zusätzlich zu den evtl. bereits in einer über den Parameter " templatePath " definierten Mailvorlage hinterlegten Anhängen versendet werden. Dies gilt auch dann, wenn ein übergebener eMail Anhang denselben Pfad hat wie in der Mailvorlage.
showDialog?	boolean

Rückgabewert

Promise<boolean>

true Der Versand war erfolgreich und es waren keine Datensätze mit leeren eMail-Feldern enthalten, andernfalls false

Remarks

Version 12.0.0

Diese Methode steht nicht zur Verfügung wenn das RecordSet per forwardOnly(true) erzeugt wurde.

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:13247

---

SendMAPIMail()

SendMAPIMail(
   subject, 
   content, 
   toEmailAddresses?, 
   ccEmailAddresses?, 
   bccEmailAddresses?, 
   files?, 
showDialog?): Promise<boolean>

Sendet eine eMail über die MAPI-Schnittstelle.

Parameter

Parameter	Type	Description
subject	string	Betreff der eMail.
content	string	Text der eMail.
toEmailAddresses?	string[]	Empfänger E-Mail-Adressen
ccEmailAddresses?	string[]	CC E-Mail-Adressen
bccEmailAddresses?	string[]	BCC E-Mail-Adressen
files?	string[]	Optional - Liste von eMail-Anhängen.
showDialog?	boolean	Optional Voreinstellung: true - Gibt an ob der Dialog angezeigt wird

Rückgabewert

Promise<boolean>

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:13329

---

SendMailDialog()

SendMailDialog(emailAddress, subject, content, files)

SendMailDialog(
   emailAddress, 
   subject, 
   content, 
files?): Promise<boolean>

Sendet eine eMail. Der Mailversand über diese Methode verhält sich analog zum Kontextmenü.

Parameter

Parameter	Type	Description
emailAddress	string	Empfänger eMail-Adresse
subject	string	Betreff der eMail.
content	string	Text der eMail.
files?	string[]	Optional - Liste von eMail-Anhängen. Hinweis: Wenn in den allgemeinen Einstellungen "Mail per Kontextmenü über" auf "auf 'mailto:' registrierten Mail-Client" gestellt ist, hat dieser Parameter keine Auswirkung.

Rückgabewert

Promise<boolean>

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:13277

SendMailDialog(subject, content, toEmailAddresses, ccEmailAddresses, bccEmailAddresses, files)

SendMailDialog(
   subject, 
   content, 
   toEmailAddresses?, 
   ccEmailAddresses?, 
   bccEmailAddresses?, 
files?): Promise<boolean>

Sendet eine eMail. Der Mailversand über diese Methode verhält sich analog zum Kontextmenü.

Parameter

Parameter	Type	Description
subject	string	Betreff der eMail.
content	string	Text der eMail.
toEmailAddresses?	string[]	Empfänger E-Mail-Adressen
ccEmailAddresses?	string[]	CC E-Mail-Adressen
bccEmailAddresses?	string[]	BCC E-Mail-Adressen
files?	string[]	Optional - Liste von eMail-Anhängen. Hinweis: Wenn in den allgemeinen Einstellungen "Mail per Kontextmenü über" auf "auf 'mailto:' registrierten Mail-Client" gestellt ist, hat dieser Parameter keine Auswirkung.

Rückgabewert

Promise<boolean>

Remarks

Version 12.4.0

Die Methode/Eigenschaft wird erst ab dieser Version unterstützt. Bei vorherigen Versionen führt der Aufruf zu einer Exception.

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:13294

---

SetFilter()

SetFilter(filter, useCurrentQuery?): Promise<boolean>

Erstellt einen Filter auf Basis des übergebenen Filter-Ausdruckes.
Der Filter kann immer nur für die jeweilige Ansicht/RecordSet ausgeführt werden.

Parameter

Parameter	Type	Description
filter	string	Filterausdruck, entspricht den Formeln unter Filtern > Allgemein.Weitere Informationen finden Sie dort.
useCurrentQuery?	boolean	Optional Voreinstellung: false - true : Der Filter basiert auf dem aktuell bestehenden Filter. false : Es wird ein neuer Filter erstellt

Rückgabewert

Promise<boolean>

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:13361

---

SetFilterByGeo()

SetFilterByGeo(
   filterType, 
   filterOperation, 
   notGeocodedRecordAction, 
   multipleResultAction, 
   aliasName, 
   address, 
   distance, 
useCurrentQuery?): Promise<boolean>

Setzt einen Filter anhand eines bestimmten geographischen Punktes.

Parameter

Parameter	Type	Description
filterType	GeoFilterType	Gibt den Suchtyp an
filterOperation	GeoFilterOperation	Gibt den Filtertyp an
notGeocodedRecordAction	NotGeocodedRecordAction	Wie sollen für die Umkreissuche unkodierte Datensätze behandelt werden
multipleResultAction	GeoMultipleResultAction	Gibt die Aktion an wenn mehrere Ergebnisse zurückgeliefert werden
aliasName	string	Name der Feldliste der Adresse
address	string	Adresse des Umkreispunkt
distance	number	Umkreis in Kilometern, in dem gesucht werden soll
useCurrentQuery?	boolean	Optional Voreinstellung: false - true : Der Filter basiert auf dem aktuell bestehenden Filter. false : Es wird ein neuer Filter erstellt

Rückgabewert

Promise<boolean>

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:13386

---

SetFilterByName()

SetFilterByName(name, useCurrentQuery?): Promise<boolean>

Führt einen abgespeicherten Filterausdruck über den Namen aus.

Parameter

Parameter	Type	Description
name	string	Name des abgespeicherten Filters. Hinweis: Bitte beachten Sie, dass nicht die Bezeichnung des Filterausdrucks verwendet wird, sondern der "Name für Scripte". Alternativ kann der vollständige Pfad zu einer .crmshare-Datei, welche einen Filterausdruck beinhaltet, angegeben werden.Diese Datei kann über die Funktion „Filter teilen“ erstellt werden
useCurrentQuery?	boolean	Optional Voreinstellung: false - true : Der Filter basiert auf dem aktuell bestehenden Filter. false : Es wird ein neuer Filter erstellt

Rückgabewert

Promise<boolean>

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:13427

---

SetFilterByPrimaryKey()

SetFilterByPrimaryKey(primaryKeyContent): Promise<boolean>

Setzt einen Filter basierend auf dem Primärschlüssel des RecordSets.
Diese Methode funktioniert nur, wenn ein Primärschlüssel vorhanden ist, der genau aus einem Feld besteht.

Parameter

Parameter	Type	Description
primaryKeyContent	string	Inhalt des Primärschlüsselfeldes.

Rückgabewert

Promise<boolean>

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:13445

---

SetFilterDirectSQL()

SetFilterDirectSQL(sqlQuery, useCurrentQuery?): Promise<boolean>

Erstellt einen Filter auf Basis des übergebenen freien Filterausdruckes.

Parameter

Parameter	Type	Description
sqlQuery	string	Freier SQL Filterausdruck.
useCurrentQuery?	boolean	Optional Voreinstellung: false - true : Der Filter basiert auf dem aktuell bestehenden Filter. false : Es wird ein neuer Filter erstellt

Rückgabewert

Promise<boolean>

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:13457

---

SetFilterDynamic()

SetFilterDynamic(
   type, 
   filter, 
useCurrentQuery?): Promise<boolean>

Erstellt einen Filter auf Basis des übergebenen Filterausdrucks je nach Filtertyp.

Parameter

Parameter	Type	Description
type	RecordSetFilterType	Filtertyp
filter	string	Filtercontext
useCurrentQuery?	boolean	Optional Voreinstellung: false - true : Der Filter basiert auf dem aktuell bestehenden Filter. false : Es wird ein neuer Filter erstellt

Rückgabewert

Promise<boolean>

Rückgabe: View wenn der Zugriff erfolgreich war, andernfalls null

Remarks

Version 12.0.0

Verhaltensänderung. Die Sortierung wird ab dieser Version direkt im SQL ausgeführt und löst keine erneute Datenbankabfrage mehr aus.

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:13483

---

SortOrderSet()

SortOrderSet(sortOrder): Promise<void>

Setzt eine definierte Sortierung über den Index

Parameter

Parameter	Type	Description
sortOrder	number	Index der Sortierung 0 = Ohne Sortierung

Rückgabewert

Promise<void>

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:12451

---

Synchronize()

Synchronize(format): Promise<boolean>

Startet den Abgleich-Assistenten und führt das übergebene Benutzerformat aus. Es werden alle Einstellungen dieses Formates verwendet.

Parameter

Parameter	Type	Description
format	string	Name des Abgleichformates. Es kann sich dabei um einen kompletten Dateipfad auf eine .itp Format-Datei handeln, alternativ um den Formatnamen, so wie er im Assistenten dargestellt wird, dabei werden zuerst die benutzerspezifischen Formate durchsucht, anschließend die globalen Formate. Bitte beachten Sie die Großkleinschreibung.

Rückgabewert

Promise<boolean>

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:13506

---

[asyncDispose]()

asyncDispose: Promise<void>

Standardimplementierung des AsyncDispose Symbols

Rückgabewert

Promise<void>

Implementierung von

AsyncDisposable.[asyncDispose]

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:13531

---

[asyncIterator]()

asyncIterator: AsyncIterator<Record, any, undefined>

Standardimplementierung des asynchronen Iterators

Rückgabewert

AsyncIterator<Record, any, undefined>

Implementierung von

AsyncIterable.[asyncIterator]

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:13512

---

[hasInstance]()

static hasInstance: boolean

Symbol.hasInstance welches eine benutzerdefinierte Überprüfung der 'instanceof'-Operation für Objekte ermöglicht.

Parameter

Parameter	Type
value	any

Rückgabewert

boolean

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:13539