combitCRMHelper
Definiert in: lib/cosmolink.Lib.combitCRM.Helper.v13.ts:57
Implementiert
Disposable
Konstruktoren
Konstruktor
new combitCRMHelper(crm?): combitCRMHelper;
Definiert in: lib/cosmolink.Lib.combitCRM.Helper.v13.ts:65
Parameter
| Parameter | Type |
|---|---|
crm? | CRMApplication |
Rückgabewert
combitCRMHelper
Methoden
[dispose]()
dispose: void;
Definiert in: lib/cosmolink.Lib.combitCRM.Helper.v13.ts:721
Rückgabewert
void
Implementierung von
Disposable.[dispose]
dispose()
dispose(): void;
Definiert in: lib/cosmolink.Lib.combitCRM.Helper.v13.ts:690
Gibt alle von dieser Instanz verwendenten Objekte frei.
Rückgabewert
void
executeSqlProcedureAsync()
executeSqlProcedureAsync(procedure, ...params): Promise<boolean>;
Definiert in: lib/cosmolink.Lib.combitCRM.Helper.v13.ts:452
Führt die angebene Prozedur via SqlShell aus.
Parameter
| Parameter | Type | Description |
|---|---|---|
procedure | string | Name der Prozedur |
...params | ( | SqlParameterValue | SqlProcedureParameter)[] | Parameter der Prozedur vom Typ SqlParameterValue oder SqlProcedureParameter |
Rückgabewert
Promise<boolean>
truewenn die Prozedur erfolgreich ausgeführt wurdefalsewenn es bei der Ausführung zu einem Fehler kam, die Fehler Informationen kann man dann über sqlShell.LastError erhalten.
Example
Beispiel 1: Standard
await cRMContext.executeSqlProcedureAsync("test", "Das ist ein Text.", true, false, 123, new Date(2023, 10, 9, 15, 20, 19)); //> Exec test 'Das ist ein Text.', 1, 0, 123, '20231009 15:20:19'
Beispiel 2: Array soll an die Funktion übergeben werden.
const args = ["Das ist ein Text.", true, false, 123, new Date(2023, 10, 9, 15, 20, 19)];
await cRMContext.executeSqlProcedureAsync("test", ...args); //> Exec test 'Das ist ein Text.', 1, 0, 123, '20231009 15:20:19'
Beispiel 3: Übergabe von benannten Parametern an eine Prozedur
await cRMContext.executeSqlProcedureAsync("test", {name: "@ParamName", value: "Das ist ein Text."}, {name: "test", value: true}); //> Exec test ＠ParamName = 'Das ist ein Text.', ＠test = 1
expandCRMPathVariableAsync()
expandCRMPathVariableAsync(path): Promise<string>;
Definiert in: lib/cosmolink.Lib.combitCRM.Helper.v13.ts:730
Gibt den aufgelösten Pfad Ersetzungstexte wie z.B. %PRJDIR% zurück
Parameter
| Parameter | Type | Description |
|---|---|---|
path | string | Pfad |
Rückgabewert
Promise<string>
getActiveViewAsync()
getActiveViewAsync(): Promise<View>;
Definiert in: lib/cosmolink.Lib.combitCRM.Helper.v13.ts:161
Gibt die aktive geoeffnete Ansicht als Objekt vom Typ View zurück.
Rückgabewert
Promise<View>
Example
const view = fastCRM.activeView;
getActiveViewsAsync()
getActiveViewsAsync(): Promise<ListViews>;
Definiert in: lib/cosmolink.Lib.combitCRM.Helper.v13.ts:140
Gibt die aktiven geoeffneten Ansichten als Objekt vom Typ ListViews zurück
Rückgabewert
Promise<ListViews>
getContainerAsync()
getContainerAsync(containerName): Promise<Container>;
Definiert in: lib/cosmolink.Lib.combitCRM.Helper.v13.ts:295
Gibt einen Container der aktiven Ansicht zurück.
Parameter
| Parameter | Type | Description |
|---|---|---|
containerName | string | Der Name des Containers |
Rückgabewert
Promise<Container>
Example
Das Container Objekt sollte nach der Verwendung freigeben werden.
const container = fastCRM.getContainer('ID.FakturaBelege.Firmen_Recordid#{E7ACF3C9-7641-442B-9EF1-18BCFAC7A4B7}');
//...
container.dispose();
getContainersAsync()
getContainersAsync(): Promise<ListContainers>;
Definiert in: lib/cosmolink.Lib.combitCRM.Helper.v13.ts:271
Gibt die Container der aktuellen Eingabemaske zurück
Rückgabewert
Promise<ListContainers>
getCurrentInputFormAsync()
getCurrentInputFormAsync(mode?): Promise<InputForm>;
Definiert in: lib/cosmolink.Lib.combitCRM.Helper.v13.ts:242
Liefert die InputForm der offenen Ansicht.
Parameter
| Parameter | Type | Description |
|---|---|---|
mode? | InputFormMode | Der InputFormMode in dem die Ansicht gesetzt werden soll. Default: InputFormMode.KeepCurrentMode |
Rückgabewert
Promise<InputForm>
getCurrentRecordAsync()
getCurrentRecordAsync(): Promise<Record>;
Definiert in: lib/cosmolink.Lib.combitCRM.Helper.v13.ts:223
Gibt das aktuelle Record der aktiven Ansicht zurück.
Rückgabewert
Promise<Record>
getCurrentRecordSetAsync()
getCurrentRecordSetAsync(): Promise<RecordSet>;
Definiert in: lib/cosmolink.Lib.combitCRM.Helper.v13.ts:206
Gibt das RecordSet der aktuell aktiven Ansicht zurück.
Rückgabewert
Promise<RecordSet>
getCurrentUserAsync()
getCurrentUserAsync(): Promise<string>;
Definiert in: lib/cosmolink.Lib.combitCRM.Helper.v13.ts:113
Gibt den aktuellen Benutzernamen zurück
Rückgabewert
Promise<string>
getEmptyRecordSetAsync()
getEmptyRecordSetAsync(viewName, cursorMode): Promise<RecordSet>;
Definiert in: lib/cosmolink.Lib.combitCRM.Helper.v13.ts:377
Erzeugt ein leeres RecordSet für den übergebenen Ansichten-Namen.
Parameter
| Parameter | Type | Default value | Description |
|---|---|---|---|
viewName | string | undefined | Name der Ansicht |
cursorMode | CRMCursorMode | CRMCursorMode.ForwardOnly | Default CRMCursorMode.ForwardOnly - CursorMode |
Rückgabewert
Promise<RecordSet>
Rückgabe: RecordSet wenn der Zugriff möglich ist, andernfalls null
Throws
Löst einen Fehler aus, wenn das ViewConfig-OBjekt nicht erzeugt werden konnte
getEscapedSqlParameter()
getEscapedSqlParameter(param): string;
Definiert in: lib/cosmolink.Lib.combitCRM.Helper.v13.ts:517
Funktion zum Wandeln von SqlParameterValue im Sql aktzeptierte Werte
-
String wird String.ToSqlString
-
Date wird Date.ToSqlString
Parameter
| Parameter | Type | Description |
|---|---|---|
param | SqlParameterValue | Wert |
Rückgabewert
string
Example
const result: string = cRMContext.getEscapedSqlParameter("Te'st") //=> 'Te''st'
const result: string = cRMContext.getEscapedSqlParameter(true) //=> 1
getFieldValueAsync()
getFieldValueAsync(
viewName,
filterType,
filter,
fieldName): Promise<string>;
Definiert in: lib/cosmolink.Lib.combitCRM.Helper.v13.ts:609
Gibt den Inhalte des angeforderden Feldes für den ersten zurück gegeben Datensatz zurück, wurde kein Datensatz gefunden wird null zurück geben.
Parameter
| Parameter | Type | Description |
|---|---|---|
viewName | string | Name der Ansicht |
filterType | RecordSetFilterType | Filtertype |
filter | string | Filter |
fieldName | string | Feldname |
Rückgabewert
Promise<string>
Example
const result : string = fastCRM.getFieldValue("FakturaWährungen", RecordSetFilterType.SetFilterDirectSQL, "SELECT Recordid FROM Factura_Waehrungen WHERE Standard = 1", 'ID');
getFieldValuesAsync()
getFieldValuesAsync(
viewName,
filterType,
filter, ...
fields): Promise<{
[Key: string]: string;
}>;
Definiert in: lib/cosmolink.Lib.combitCRM.Helper.v13.ts:555
Gibt die Inhalte der angeforderden Felder für den ersten zurück gegeben Datensatz zurück, wurde kein Datensatz gefunden wird null zurück geben.
Parameter
| Parameter | Type | Description |
|---|---|---|
viewName | string | Name der Ansicht |
filterType | RecordSetFilterType | Filtertyp |
filter | string | Filtercontext |
...fields | string[] | Felder |
Rückgabewert
Promise<{
[Key: string]: string;
}>
Throws
> Error - Wenn der Filter micht ausgeführt werden konnte.
Example
const result : IDictionary<string> = await cRM_Context.getFieldValuesAsync('Firmen', RecordSetFilterType.SetFilterByPrimaryKey, '00b32d845e35c548b0b457d8dcc16b3d', 'Company', 'Company2', 'Company3');
result['Company'];
result['Company2'];
result['Company3'];
getFullRecordSetAsync()
getFullRecordSetAsync(viewName, options?): Promise<RecordSet>;
Definiert in: lib/cosmolink.Lib.combitCRM.Helper.v13.ts:397
Erzeugt ein RecordSet mit allen Datensätzen für die Ansicht.
Parameter
| Parameter | Type | Description |
|---|---|---|
viewName | string | Name der Ansicht |
options? | { cursorMode?: CRMCursorMode; sortOrder?: number; } | Optionale Parameter |
options.cursorMode? | CRMCursorMode | Default CRMCursorMode.SolutionDefault - CursorMode |
options.sortOrder? | number | Default 0 - Sortierung |
Rückgabewert
Promise<RecordSet>
Throws
Löst einen Fehler aus, wenn das ViewConfig-OBjekt nicht erzeugt werden konnte
getGlobalPropertySafeAsync()
getGlobalPropertySafeAsync(propertyName, defaultValue?): Promise<string>;
Definiert in: lib/cosmolink.Lib.combitCRM.Helper.v13.ts:843
Gibt den Inhalt eines Globalen Parameters zurück.
Hierbei wird die Maximallänge eines Parameters beachtet in dem die Abfrage automatisch sofern notwendig mehrere Parameternamen mit dem Schema Parameter, Parameter_2, usw. überprüft.
Parameter
| Parameter | Type | Description |
|---|---|---|
propertyName | string | Name des Parameters |
defaultValue? | string | Der Standartwert der Einstellung, welcher zurückgegeben wird, wenn keine Einstellung mit dem angegebenen Namen existiert |
Rückgabewert
Promise<string>
Example
const paramValue : string = fastCRM.getGlobalPropertySafe('Parameter','Standardwert');
getHasActiveViewAsync()
getHasActiveViewAsync(): Promise<boolean>;
Definiert in: lib/cosmolink.Lib.combitCRM.Helper.v13.ts:176
Gibt an, ob eine Aktive Ansicht vorhanden ist.
Rückgabewert
Promise<boolean>
getProjectAsync()
getProjectAsync(): Promise<Project>;
Definiert in: lib/cosmolink.Lib.combitCRM.Helper.v13.ts:96
Gibt das aktuelle Projekt zurück
Rückgabewert
Promise<Project>
getProjectDirAsync()
getProjectDirAsync(): Promise<string>;
Definiert in: lib/cosmolink.Lib.combitCRM.Helper.v13.ts:128
Gibt das aktuelle Projektverzeichnis zurück
Rückgabewert
Promise<string>
getRecordSetAsync()
getRecordSetAsync(
viewName,
filterType,
filter,
options?): Promise<RecordSet>;
Definiert in: lib/cosmolink.Lib.combitCRM.Helper.v13.ts:348
Erzeugt ein Objekt vom Typ RecordSet für den übergebenen Ansichten bei Name.
Parameter
| Parameter | Type | Description |
|---|---|---|
viewName | string | Name der Ansicht |
filterType | RecordSetFilterType | Filtertyp |
filter | string | Filtercontext |
options? | { cursorMode?: CRMCursorMode; sortOrder?: number; } | Optionale Parameter |
options.cursorMode? | CRMCursorMode | - |
options.sortOrder? | number | - |
Rückgabewert
Promise<RecordSet>
Rückgabe: RecordSet wenn der Zugriff möglich ist, andernfalls null
Throws
Löst einen Fehler aus, wenn das ViewConfig-OBjekt nicht erzeugt werden konnte
getViewConfigByNameAsync()
getViewConfigByNameAsync(viewName): Promise<ViewConfig>;
Definiert in: lib/cosmolink.Lib.combitCRM.Helper.v13.ts:331
Liefert eine Ansicht mit dem übergebenen Namen als Objekt zurück
Parameter
| Parameter | Type | Description |
|---|---|---|
viewName | string | Name der Ansicht |
Rückgabewert
Promise<ViewConfig>
Rückgabe: ViewConfig wenn der Zugriff möglich ist, andernfalls null
Example
Das ViewConfig Objekt sollte nach der Verwendung freigeben werden.
const viewConfig = fastCRM.getViewConfigByName('FakturaBelege');
//...
viewConfig.dispose();
getViewConfigsAsync()
getViewConfigsAsync(): Promise<ListViewConfigs>;
Definiert in: lib/cosmolink.Lib.combitCRM.Helper.v13.ts:307
Gibt das ListViewConfigs Objekt des aktuellen Projektes zurück.
Rückgabewert
Promise<ListViewConfigs>
isActiveViewAsync()
isActiveViewAsync(name): Promise<boolean>;
Definiert in: lib/cosmolink.Lib.combitCRM.Helper.v13.ts:188
Prueft ob die Aktive Ansicht den Namen hat.
Parameter
| Parameter | Type | Description |
|---|---|---|
name | string | Name der Ansicht |
Rückgabewert
Promise<boolean>
openFilteredView()
openFilteredView(
viewName,
filterType,
filter,
options?): Promise<void>;
Definiert in: lib/cosmolink.Lib.combitCRM.Helper.v13.ts:778
Öffnet eine Ansicht mit dem übergebnen Filter als aktive Ansicht im combit CRM. Der CRMContext wird hierbei zurückgesetzt.
Parameter
| Parameter | Type | Description |
|---|---|---|
viewName | string | Name der zu öffnenden Ansicht |
filterType | RecordSetFilterType | Filtertyp |
filter | string | Filter |
options? | { forceNewView?: boolean; viewMode?: ViewMode; } | optionale Parameter |
options.forceNewView? | boolean | Gibt an ob in jedem Fall eine neue Ansicht geöffnet werden soll. Default: false |
options.viewMode? | ViewMode | Gibt den Anzeigemodus der Ansicht an. |
Rückgabewert
Promise<void>
Throws
Löst einen Fehler aus, wenn die Ansicht nicht geöffnet werden konnte.
refreshContext()
refreshContext(): void;
Definiert in: lib/cosmolink.Lib.combitCRM.Helper.v13.ts:647
Gibt den aktuell geladenen Context wieder frei.
Rückgabewert
void
setGlobalPropertySafe()
setGlobalPropertySafe(propertyName, value): Promise<void>;
Definiert in: lib/cosmolink.Lib.combitCRM.Helper.v13.ts:893
Setzt den Inhalt eines Globalen Parameters.
Hierbei wird die Maximallänge eines Parameters beachtet in dem die Abfrage automatisch sofern notwendig den Wert auf mehrere Parameternamen mit dem Schema Parameter, Parameter_2, usw. aufteilt.
Parameter
| Parameter | Type | Description |
|---|---|---|
propertyName | string | Name des Parameters |
value | string | Wert des Parameters |
Rückgabewert
Promise<void>
Example
fastCRM.setGlobalPropertySafe('Parameter','Wert');
shrinkCRMPathVariable()
shrinkCRMPathVariable(path): Promise<string>;
Definiert in: lib/cosmolink.Lib.combitCRM.Helper.v13.ts:750
Gibt den Pfad verkürzt durch Ersetzungstexte wie z.B. %PRJDIR% zurück
Parameter
| Parameter | Type | Description |
|---|---|---|
path | string | Pfad |
Rückgabewert
Promise<string>