CRMContext

Stellt Objekte bereit die im aktuellen CRM Kontext zur Verfügung stehen.

Implementiert

• AsyncDisposable

Eigenschaften

ActiveView

get ActiveView(): Promise<View>

Gibt die aktuell aktive Ansicht View zurueck.

Example

const view = await cRM_Context.ActiveView;

Rückgabewert

Promise<View>

Definiert in

lib/CRMContext.ts:161

---

ActiveViews

get ActiveViews(): Promise<ListViews>

Gibt die aktiven geoeffneten Ansichten als Objekt vom Typ ListViews zurueck

Rückgabewert

Promise<ListViews>

Definiert in

lib/CRMContext.ts:139

---

CurrentContainers

get CurrentContainers(): Promise<ListContainers>

Rückgabewert

Promise<ListContainers>

Definiert in

lib/CRMContext.ts:264

---

CurrentRecord

get CurrentRecord(): Promise<Record>

Gibt den Record des aktuell aktiven Datensatzes zurueck.

Rückgabewert

Promise<Record>

Definiert in

lib/CRMContext.ts:220

---

CurrentRecordSet

get CurrentRecordSet(): Promise<RecordSet>

Gibt das RecordSet der aktuell aktiven Ansicht zurueck.

Rückgabewert

Promise<RecordSet>

Definiert in

lib/CRMContext.ts:201

---

CurrentUser

get CurrentUser(): Promise<string>

Gibt den aktuellen Benutzernamen zurück

Rückgabewert

Promise<string>

Definiert in

lib/CRMContext.ts:103

---

Project

get Project(): Promise<Project>

Gibt das geladene Projekt als Objekt vom Typ Project zurueck (leer, wenn kein Projekt geladen).

Example

const project = await cRM_Context.Project;

Rückgabewert

Promise<Project>

Definiert in

lib/CRMContext.ts:85

---

ProjectDir

get ProjectDir(): Promise<string>

Gibt das aktuelle Projektverzeichnis zurück

Rückgabewert

Promise<string>

Definiert in

lib/CRMContext.ts:120

---

ViewConfigs

get ViewConfigs(): Promise<ListViewConfigs>

Gibt das ListViewConfigs Objekt des aktuellen Projektes zurück.

Rückgabewert

Promise<ListViewConfigs>

Definiert in

lib/CRMContext.ts:299

---

cRM

get cRM(): cRMApplication

Rückgabewert

cRMApplication

Definiert in

lib/CRMContext.ts:66

Konstruktoren

new CRMContext()

new CRMContext(cRM): CRMContext

Parameter

Parameter	Type
cRM	cRMApplication

Rückgabewert

CRMContext

Definiert in

lib/CRMContext.ts:71

Methoden

CurrentInputForm()

CurrentInputForm(mode?): Promise<InputForm>

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>

Definiert in

lib/CRMContext.ts:242

---

DisposeAsync()

DisposeAsync(): Promise<void>

Gibt alle von dieser Instanz verwendenten Objekte frei.

Rückgabewert

Promise<void>

Definiert in

lib/CRMContext.ts:632

---

ExecuteSqlProcedur()

ExecuteSqlProcedur(procedure, ...params): Promise<boolean>

Parameter

Parameter	Type
procedure	string
...params	(SqlParameterValue | SqlProcedureParameter)[]

Rückgabewert

Promise<boolean>

Deprecated

ExecuteSqlProcedure verwenden

Definiert in

lib/CRMContext.ts:403

---

ExecuteSqlProcedure()

ExecuteSqlProcedure(procedure, ...params): Promise<boolean>

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>

• true wenn die Prozedur erfolgreich ausgeführt wurde
• false wenn 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.ExecuteSqlProcedure("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.ExecuteSqlProcedure("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.ExecuteSqlProcedure("test", {name: "@ParamName", value: "Das ist ein Text."}, {name: "test", value: true}); //> Exec test ＠ParamName = 'Das ist ein Text.', ＠test = 1

Definiert in

lib/CRMContext.ts:431

---

ExpandCRMPathVariable()

ExpandCRMPathVariable(path): Promise<string>

Parameter

Parameter	Type
path	string

Rückgabewert

Promise<string>

Definiert in

lib/CRMContext.ts:653

---

GetContainer()

GetContainer(containerName): Promise<Container>

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 = await cRM_Context.GetContainer('ID.FakturaBelege.Firmen_Recordid#{E7ACF3C9-7641-442B-9EF1-18BCFAC7A4B7}');
//...
await container.DisposeAsync();

Definiert in

lib/CRMContext.ts:290

---

GetEmptyRecordSet()

GetEmptyRecordSet(viewName, cursorMode): Promise<RecordSet>

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

Definiert in

lib/CRMContext.ts:358

---

GetEscapedSqlParameter()

GetEscapedSqlParameter(param): string

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

Definiert in

lib/CRMContext.ts:481

---

GetFieldValue()

GetFieldValue(
   viewName, 
   filterType, 
   filter, 
fieldName): Promise<string>

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 = await cRM_Context.GetFieldValue("FakturaWährungen", RecordSetFilterType.SetFilterDirectSQL, "SELECT Recordid FROM Factura_Waehrungen WHERE Standard = 1", 'ID');

Definiert in

lib/CRMContext.ts:558

---

GetFieldValues()

GetFieldValues(
   viewName, 
   filterType, 
   filter, ...
fields): Promise<IDictionary<string>>

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<IDictionary<string>>

Throws

> Error - Wenn der Filter micht ausgeführt werden konnte.

Example

const result : IDictionary<string> = await cRM_Context.GetFieldValues('Firmen', RecordSetFilterType.SetFilterByPrimaryKey, '00b32d845e35c548b0b457d8dcc16b3d', 'Company', 'Company2', 'Company3');

result['Company'];
result['Company2'];
result['Company3'];

Definiert in

lib/CRMContext.ts:514

---

GetFullRecordSet()

GetFullRecordSet(
   viewName, 
   sortOrder, 
cursorMode): Promise<RecordSet>

Erzeugt ein RecordSet mit allen Datensätzen für die Ansicht.

Parameter

Parameter	Type	Default value	Description
viewName	string	undefined	Name der Ansicht
sortOrder	number	0	Default 0 - Sortierung
cursorMode	CRMCursorMode	CRMCursorMode.SolutionDefault	Default CRMCursorMode.SolutionDefault - CursorMode

Rückgabewert

Promise<RecordSet>

Throws

Löst einen Fehler aus, wenn das ViewConfig-OBjekt nicht erzeugt werden konnte

Definiert in

lib/CRMContext.ts:389

---

GetGlobalPropertySafe()

GetGlobalPropertySafe(propertyName, defaultValue): Promise<string>

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	Default value	Description
propertyName	string	undefined	Name des Parameters
defaultValue	string	null	Der Standartwert der Einstellung, welcher zurückgegeben wird, wenn keine Einstellung mit dem angegebenen Namen existiert

Rückgabewert

Promise<string>

Example

const paramValue : string = await cRM_Context.GetGlobalPropertySafe('Parameter','Standardwert');

Definiert in

lib/CRMContext.ts:717

---

GetRecordSet()

GetRecordSet(
   viewName, 
   filterType, 
   filter, 
   sortOrder, 
cursorMode): Promise<RecordSet>

Erzeugt ein Objekt vom Typ RecordSet für den übergebenen Ansichten bei Name.

Parameter

Parameter	Type	Default value	Description
viewName	string	undefined	Name der Ansicht
filterType	RecordSetFilterType	undefined	Filtertyp
filter	string	undefined	Filtercontext
sortOrder	number	0	-
cursorMode	CRMCursorMode	CRMCursorMode.SolutionDefault	-

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

Definiert in

lib/CRMContext.ts:339

---

GetViewConfigByName()

GetViewConfigByName(viewName): Promise<ViewConfig>

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 = await cRM_Context.GetViewConfigByName('FakturaBelege');
//...
await viewConfig.DisposeAsync();

Definiert in

lib/CRMContext.ts:325

---

HasActiveView()

HasActiveView(): Promise<boolean>

Rückgabewert

Promise<boolean>

Definiert in

lib/CRMContext.ts:175

---

IsActiveView()

IsActiveView(name): Promise<boolean>

Prueft ob die Aktive Ansicht den Namen

Parameter

Parameter	Type	Description
name	string	Name der Ansicht

Rückgabewert

Promise<boolean>

Definiert in

lib/CRMContext.ts:184

---

OpenFilteredView()

OpenFilteredView(
   targetViewName, 
   filterType, 
   filterContent, 
forceNewView?): Promise<void>

Öffnet eine Ansicht mit dem übergebnen Filter, als aktive Ansicht im combit CRM.

Parameter

Parameter	Type	Description
targetViewName	string	Name der zu öffnenden Ansicht
filterType	RecordSetFilterType	Filtertyp
filterContent	string	Filter
forceNewView?	boolean	Gibt an ob in jedem Fall eine neue Ansicht geöffnet werden soll. Default: false

Rückgabewert

Promise<void>

Definiert in

lib/CRMContext.ts:674

---

RefreshContext()

RefreshContext(): Promise<void>

Gibt den aktuell geladenen Context wieder frei.

Rückgabewert

Promise<void>

Definiert in

lib/CRMContext.ts:597

---

SetGlobalPropertySafe()

SetGlobalPropertySafe(propertyName, value): Promise<void>

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

await cRM_Context.SetGlobalPropertySafe('Parameter','Wert');

Definiert in

lib/CRMContext.ts:760

---

[asyncDispose]()

asyncDispose: Promise<void>

Rückgabewert

Promise<void>

Implementierung von

AsyncDisposable.[asyncDispose]

Definiert in

lib/CRMContext.ts:788