Die Komponente KSR_TimeReg_ActiveX
Die Komponenten KSR_TimeReg_ActiveX stellt via ActiveX den Zugriff auf die Zeiterfassungsschnittstelle von KSR zur Verfügung. Die Hauptklasse, die hierbei genutzt wird, ist die Klasse clsTimeReg.
Die öffentlichen Methoden von clsTimeReg
AddComingGoing
AddMissTime
AddStamp
AddUnproductiveTime
AssigJob2Proj
BeginTrans
CalcActualValues
CalcSetTime
ChangeComingGoing
ChangeGuideNumber
ChangeMissTime
ChangeStamp
ChangeUnproductiveTime
CommitTrans
Connect
GetComingGoings
GetMissTimes
GetOrder
GetProjInfo
GetRuleDirections
GetStamps
GetUnproductiveTimes
ReReadCGU
ReReadCGUDone
ReReadMissTimes
ReReadMTDone
Rollback
SetSilentMode
Die öffentlichen Eigenschaften von clsTimeReg
blnConnected
blnIgnoringCompanyID
DefaultCompanyID
ProjAssign
Die Methode Connect
Mittels der Methode Connect wird die Verbindung zur Datenbank von VxS aufgebaut. Diese Verbindung muss hergestellt sein, um irgendeine andere Methode der Klasse ausführen zu können. Den Status können Sie über die Eigenschaft blnConnected ermitteln.
Die Deklaration
Sub Connect(ConnectionSetupType As enmConnectionSetupType, [strConnectString As String])
Die Parameter
Parametername |
Pflichtpar. |
Beschreibung |
ConnectionSetupType |
Ja |
Siehe weiter unten |
strConnectString |
Nein |
Connectstring für VxS-Datenbank |
Der Enumerator enmConnectionSetupType
Die Werte des Enumerators enmConnectionSetupType sind:
Const cstUseConnectstring = 1
Const cstUseDBConnect = 2
Ist Ihre Applikation in der Lage, einen gültigen Connectstring zur VxS-Datenbank zu übergeben, ist der Parameter ConnectionSetupType = cstUseConnectstring zu setzen und im Parameter strConnectString dieser zu übergeben.
Andernfalls müssen Sie die Methode Connect mit ConnectionSetupType = cstUseDBConnect rufen. Ist noch keine Datenbankverbindung konfiguriert, wird diese vom Benutzer mittels Dialogen erfragt.
Die Methode AddComingGoing
Mit der Methode AddComingGoing wird eine Kommen- oder Gehen-Stempelung in die Tabelle TimeControlComingGoing geschrieben.
Die Deklaration
Public Function AddComingGoing(strStaffNumber As String, datDate As Date, datTime As Date, blnComing As Boolean, [lngCompanyID As Long = 0], [lngIndentifier As Long = 0]) As Boolean
Die Parameter
Parametername |
Pflichtpar. |
Beschreibung |
strStaffNumber |
Ja |
Mitarbeiternummer |
datDate |
Ja |
Datum der Stempelung |
datTime |
Ja |
Zeitpunkt der Stempelung |
blnComing |
Ja |
TRUE, wenn es sich um eine Kommenstemp. handelt. |
lngCompanyID |
Nein |
Mandantennummer, wenn verwendet |
lngIndentifier |
Nein |
Externe Kennung |
Die Methode ChangeComingGoing
Mit der Methode ChangeComingGoing wird eine bestehende Kommen- oder Gehen-Stempelung geändert.
Die Deklaration
Public Function ChangeComingGoing(lngIdentifier As Long, strStaffNumber As String, datDate As Date, datTime As Date, blnComing As Boolean, [lngCompanyID As Long = 0]) As Boolean
Die Parameter
Parametername |
Pflichtpar. |
Beschreibung |
lngIndentifier |
Ja |
Externe Kennung |
strStaffNumber |
Ja |
Mitarbeiternummer |
datDate |
Ja |
Datum der Stempelung |
datTime |
Ja |
Zeitpunkt der Stempelung |
blnComing |
Ja |
TRUE, wenn es sich um eine Kommenstemp. handelt. |
lngCompanyID |
Nein |
Mandantennummer, wenn verwendet |
Die Methode ReReadCGU
Mit der Methode ReReadCGU kann ermittelt werden, ob über einen bestimmten Zeitraum die Kommen-, Gehen- und Unproduktivstempelungen erneut eingelesen werden müssen. Das ist der Fall, wenn die Funktion TRUE liefert.
Die Deklaration
Public Function ReReadCGU(ByRef ret_date_PeriodStart As Date, ByRef ret_Date_PeriodEnd As Date, [ByRef ret_lng_CompanyID As Long]) As Boolean
Die Parameter
Parametername |
Pflichtpar. |
Beschreibung |
ret_date_PeriodStart |
Ja |
Parameter zur Rückgabe des eingestellten Startdatums für den Zeitraum, befüllt bei Rückgabe TRUE |
ret_Date_PeriodEnd |
Ja |
Parameter zur Rückgabe des eingestellten Enddatums für den Zeitraum, befüllt bei Rückgabe TRUE |
ret_lng_CompanyID |
Nein |
Parameter zur Rückgabe der Mandanten-Nr. bei Rückgabe TRUE |
Die Methode ReReadCGUDone
Mit dieser Methode signalisieren Sie der Komponente, dass der Zeitraum erneut eingelesen wurde.
Die Deklaration
Public Function ReReadCGUDone() As Boolean
Die Parameter
-Keine-
Die Methode AddMissTime
Die Methode AddMissTime trägt einen Fehlzeit-Datensatz in die Tabelle AddMissTime ein.
Die Deklaration
Public Function AddMissTime(strStaffNumber As String, blnWholeDay As Boolean, datDate As Date, dblTime As Double, [lngCompanyID As Long = 0], [datTimeStart As Date = #00:00:00#], [datTimeEnd As Date = #00:00:00#], [strReason As String = ""], [strDescriptionShort As String = ""], [strDescription As String = ""], [lngIndentifier As Long = 0]) As Boolean
Die Parameter
Parametername |
Pflichtpar. |
Beschreibung |
strStaffNumber |
Ja |
Mitarbeiternummer |
blnWholeDay |
Ja |
TRUE, wenn Fehlzeit ganztägig |
datDate |
Ja |
Datum der Fehlzeit |
dblTime |
Ja |
Fehlzeit in Stunden |
lngCompanyID |
Nein |
Mandantennummer |
datTimeStart |
Nein |
Beginn der Fehlzeit |
datTimeEnd |
Nein |
Ende der Fehlzeit |
strReason |
Nein |
Fehlgrund |
strDescriptionShort |
Nein |
Kennung Fehlgrund (Art) |
strDescription |
Nein |
Fehlgrund Beschreibung |
lngIndentifier |
Nein |
Externe Kennung |
Die Methode ChangeMissTime
Mit der Methode ChangeMissTime wird ein Fehlzeiten-Datensatz geändert
Die Deklaration
Public Function ChangeMissTime(lngIdentifier As Long, strStaffNumber As String, blnWholeDay As Boolean, datDate As Date, dblTime As Double, [lngCompanyID As Long = 0], [datTimeStart As Date = #00:00:00#], [datTimeEnd As Date = #00:00:00#], [strReason As String = ""], [strDescriptionShort As String = ""], [strDescription As String = ""]) As Boolean
Die Parameter
Parametername |
Pflichtpar. |
Beschreibung |
lngIndentifier |
Ja |
Externe Kennung |
strStaffNumber |
Ja |
Mitarbeiternummer |
blnWholeDay |
Ja |
TRUE, wenn Fehlzeit ganztägig |
datDate |
Ja |
Datum der Fehlzeit |
dblTime |
Ja |
Fehlzeit in Stunden |
lngCompanyID |
Nein |
Mandantennummer |
datTimeStart |
Nein |
Beginn der Fehlzeit |
datTimeEnd |
Nein |
Ende der Fehlzeit |
strReason |
Nein |
Fehlgrund |
strDescriptionShort |
Nein |
Kennung Fehlgrund (Art) |
strDescription |
Nein |
Fehlgrund Beschreibung |
Die Methode ReReadMissTimes
Mit der Methode ReReadMissTimes kann ermittelt werden, ob über einen bestimmten Zeitraum Fehlzeiten erneut eingelesen werden müssen. Das ist der Fall, wenn die Funktion TRUE liefert.
Die Deklaration
Public Function ReReadMissTimes(ByRef ret_date_PeriodStart As Date, ByRef ret_Date_PeriodEnd As Date, [ByRef ret_lng_CompanyID As Long]) As Boolean
Die Parameter
Parametername |
Pflichtpar. |
Beschreibung |
ret_date_PeriodStart |
Ja |
Parameter zur Rückgabe des eingestellten Startdatums für den Zeitraum, befüllt bei Rückgabe TRUE |
ret_Date_PeriodEnd |
Ja |
Parameter zur Rückgabe des eingestellten Enddatums für den Zeitraum, befüllt bei Rückgabe TRUE |
ret_lng_CompanyID |
Nein |
Parameter zur Rückgabe der Mandanten-Nr. bei Rückgabe TRUE |
Die Methode ReReadMTDone
Mit dieser Methode signalisieren Sie der Komponente, daß der Zeitraum erneut eingelesen wurde.
Die Deklaration
Public Function ReReadMTDone() As Boolean
Die Parameter
-Keine-
Die Methode AddStamp
Mit der Methode AddStamp wird eine Stempelung in die Tabelle TimeControlIn geschrieben.
Die Deklaration
Function AddStamp(lngJobID As Long, datDate As Date, dblTime As Double, [lngCompanyID As Long = 0], [lngJobIDOrg As Long = 0], [strStaffname As String = ""], [strStaffNumber As String = ""], [strGroup As String = ""], [strFunction As String = ""], [datTimeStart As Date = #00:00:00#], [datTimeEnd As Date = #00:00:00#], [dblTimeCalculated As Double = 0], [dblCosts As Double = 0], [dblCostsCalculated As Double = 0], [lngIndentifier As Long = 0], [dblBaseCosts As Double = 0], [dblBaseCostsCalculated As Double = 0]) As Boolean
Die Parameter
Parametername |
Pflichtpar. |
Beschreibung |
lngJobID |
Ja |
Auftragsnummer |
datDate |
Ja |
Datum der Stempelung |
dblTime |
Ja |
Zählzeit in Stunden |
lngCompanyID |
Nein |
Mandantennummer |
lngJobIDOrg |
Nein |
Bei Verwendung eines Leitnummern-Systems die Pseudo-Auftrags-Nummer (Leitnummer) |
strStaffname |
Nein |
Mitarbeitername |
strStaffNumber |
Nein |
Mitarbeiternummer |
strGroup |
Nein |
Arbeitsgruppe |
strFunction |
Nein |
Tätigkeit |
datTimeStart |
Nein |
Beginn der Stempelung |
datTimeEnd |
Nein |
Ende der Stempelung |
dblTimeCalculated |
Nein |
Bewertete Zeit |
dblCosts |
Nein |
Kosten |
dblCostsCalculated |
Nein |
Bewertete Kosten |
lngIndentifier |
Nein |
Externe Kennung |
dblBaseCosts |
Nein |
Basiskosten |
dblBaseCostsCalculated |
Nein |
bewertete Basiskosten |
Die Methode ChangeStamp
Mit der Methode ChangeStamp wird eine bestehende Stempelung geändert.
Die Deklaration
Function ChangeStamp(lngIdentifier As Long, lngJobID As Long, datDate As Date, dblTime As Double, [lngCompanyID As Long = 0], [lngJobIDOrg As Long = 0], [strStaffname As String = ""], [strStaffNumber As String = ""], [strGroup As String = ""], [strFunction As String = ""], [datTimeStart As Date = #00:00:00#], [datTimeEnd As Date = #00:00:00#], [dblTimeCalculated As Double = 0], [dblCosts As Double = 0], [dblCostsCalculated As Double = 0], [dblBaseCosts As Double = 0], [dblBaseCostsCalculated As Double = 0]) As Boolean
Die Parameter
Parametername |
Pflichtpar. |
Beschreibung |
lngIndentifier |
Ja |
Externe Kennung |
lngJobID |
Ja |
Auftragsnummer |
datDate |
Ja |
Datum der Stempelung |
dblTime |
Ja |
Zählzeit in Stunden |
lngCompanyID |
Nein |
Mandantennummer |
lngJobIDOrg |
Nein |
Bei Verwendung eines Leitnummern-Systems die Pseudo-Auftrags-Nummer (Leitnummer) |
strStaffname |
Nein |
Mitarbeitername |
strStaffNumber |
Nein |
Mitarbeiternummer |
strGroup |
Nein |
Arbeitsgruppe |
strFunction |
Nein |
Tätigkeit |
datTimeStart |
Nein |
Beginn der Stempelung |
datTimeEnd |
Nein |
Ende der Stempelung |
dblTimeCalculated |
Nein |
Bewertete Zeit |
dblCosts |
Nein |
Kosten |
dblCostsCalculated |
Nein |
Bewertete Kosten |
dblBaseCosts |
Nein |
Basiskosten |
dblBaseCostsCalculated |
Nein |
Bewertete Basiskosten |
Die Methode AddUnproductiveTime
Mit der Methode AddUnproductiveTime wird eine Unproduktiv-Stempelung in die Tabelle TimeControlIn geschrieben.
Die Deklaration
Function AddUnproductiveTime(datDate As Date, dblTime As Double, [lngCompanyID As Long = 0], [strStaffname As String = ""], [strStaffNumber As String = ""], [strGroup As String = ""], [strFunction As String = ""], [datTimeStart As Date = #00:00:00#], [datTimeEnd As Date = #00:00:00#], [dblTimeCalculated As Double = 0], [dblCosts As Double = 0], [dblCostsCalculated As Double = 0], [dblBaseCosts As Double = 0], [dblBaseCostsCalculated As Double = 0], [lngIndentifier As Long = 0]) As Boolean
Die Parameter
Parametername |
Pflichtpar. |
Beschreibung |
datDate |
Ja |
Datum der Stempelung |
dblTime |
Ja |
Zählzeit in Stunden |
lngCompanyID |
Nein |
Mandantennummer |
strStaffname |
Nein |
Mitarbeitername |
strStaffNumber |
Nein |
Mitarbeiternummer |
strGroup |
Nein |
Arbeitsgruppe |
strFunction |
Nein |
Tätigkeit |
datTimeStart |
Nein |
Beginn der Stempelung |
datTimeEnd |
Nein |
Ende der Stempelung |
dblTimeCalculated |
Nein |
Bewertete Zeit |
dblCosts |
Nein |
Kosten |
dblCostsCalculated |
Nein |
Bewertete Kosten |
dblBaseCosts |
Nein |
Basiskosten |
dblBaseCostsCalculated |
Nein |
bewertete Basiskosten |
lngIndentifier |
Nein |
Externe Kennung |
Die Methode ChangeUnproductiveTime
Mit der Methode ChangeUnproductiveTime wird eine bestehende Unproduktiv-Stempelung geändert.
Die Deklaration
Function ChangeUnproductiveTime(lngIdentifier As Long, datDate As Date, dblTime As Double, [lngCompanyID As Long = 0], [strStaffname As String = ""], [strStaffNumber As String = ""], [strGroup As String = ""], [strFunction As String = ""], [datTimeStart As Date = #00:00:00#], [datTimeEnd As Date = #00:00:00#], [dblTimeCalculated As Double = 0], [dblCosts As Double = 0], [dblCostsCalculated As Double = 0], [dblBaseCosts As Double = 0], [dblBaseCostsCalculated As Double = 0]) As Boolean
Die Parameter
Parametername |
Pflichtpar. |
Beschreibung |
lngIndentifier |
Ja |
Externe Kennung |
datDate |
Ja |
Datum der Stempelung |
dblTime |
Ja |
Zählzeit in Stunden |
lngCompanyID |
Nein |
Mandantennummer |
strStaffname |
Nein |
Mitarbeitername |
strStaffNumber |
Nein |
Mitarbeiternummer |
strGroup |
Nein |
Arbeitsgruppe |
strFunction |
Nein |
Tätigkeit |
datTimeStart |
Nein |
Beginn der Stempelung |
datTimeEnd |
Nein |
Ende der Stempelung |
dblTimeCalculated |
Nein |
Bewertete Zeit |
dblCosts |
Nein |
Kosten |
dblCostsCalculated |
Nein |
Bewertete Kosten |
dblBaseCosts |
Nein |
Basiskosten |
dblBaseCostsCalculated |
Nein |
Bewertete Basiskosten |
Die Methode BeginTrans
Sollen Stempelungen in einer Transaktion geschrieben oder geändert werden, kann mit der Methode BeginTrans die Transaktion eröffnet werden. Es sind keine geschachtelten Transaktionen möglich.
Die Deklaration
Function BeginTrans() As Boolean
Die Methode CommitTrans
Die Methode CommitTrans schließt eine mit der Methode BeginTrans eröffnete Transaktion. Werden vom Datenbank-Server Fehler ausgelöst, werden diese unbehandelt weiter gegeben.
Die Deklaration
Sub CommitTrans()
Die Methode Rollback
Die Methode Rollback macht eine mit der Methode BeginTrans eröffnete Transaktion rückgängig. Werden vom Datenbank-Server Fehler ausgelöst, werden diese unbehandelt weiter gegeben.
Die Deklaration
Sub Rollback()
Die Methode SetSilentMode
Die Methode SetSilentMode bewirkt, dass die ActiveX-Komponente keinerlei User-Interaktion verlangt, d.h. z.B. wird bei Auftreten eines Fehlers dieser nicht als Meldung ausgegeben, sondern in einem Logfile festgehalten. Die Aktivierung des Silent-mode ist zum Beispiel bei Einsatz der ActiveX-Komponente in einem Dienst notwendig, da dort ein Intervenieren des Users unmöglich ist (genauer: Bei der Verwendung der Komponente in einem Dienst ohne Aktivierung des Silent-Modus würde bei Auftreten eines Fehlers der Dienst komplett lahmgelegt).
Die Deklaration
Public Function SetSilentMode(blnSilentMode As Boolean, strLogFilePath As String) As Boolean
Die Parameter
Parametername |
Pflichtpar. |
Beschreibung |
blnSilentMode |
Ja |
TRUE, wenn der Silent-Modus aktiviert werden soll |
strLogFilePath |
Ja |
Pfad zum Log-Verzeichnis (Schreibrecht muss vorhanden sein!) |
Die Methode GetComingGoings
Mit der Methode GetComingGoings können für einen Zeitraum die Kommen- und Gehen-Stempelungen eines bestimmten Mitarbeiters ausgelesen werden.
Die Deklaration
Public Function GetComingGoings(ComingGoings As clsComingGoings, strStaffNr As String, datPeriodBegin As Date, datPeriodEnd As Date, [lngCompanyID As Long = 0]) As Boolean
Die Parameter
Parametername |
Pflichtpar. |
Beschreibung |
ComingGoings |
Ja |
Auflistung der Kommen- und Gehen-Stempelungen |
strStaffNr |
Ja |
Mitarbeiternummer |
datPeriodBegin |
Ja |
Beginn des Zeitraums |
datPeriodEnd |
Ja |
Ende des Zeitraums |
lngCompanyID |
Nein |
Mandantennummer |
Die Klasse clsComingGoings
Die Klasse clsComingGoings listet die einzelnen Kommen- und Gehen-Stempelungen als Objekte der Klasse clsComingGoing auf.
Die Klasse clsComingGoing
Die Klasse clsComingGoing hat die folgenden Eigenschaften, die den Feldern eines Datensatzes der Tabelle TimeControlComingGoing entsprechen.
Eigenschaftsname |
Beschreibung |
lngCompanyID |
Mandanten-Nr. |
strStaffNr |
Mitarbeiternummer |
datDate |
Datum der Stempelung |
datTime |
Uhrzeit der Stempelung |
blnComing |
TRUE ó Kommen-Stempelung |
lngState |
Status des Datensatzes |
blnDeleted |
TRUE ó Datensatz gelöscht |
lngIdentifier |
Externe Kennung |
Die Methode GetMissTimes
Mit dieser Methode werden die einzelnen Fehlzeiten über einen angegebenen Zeitraum für einen bestimmten Mitarbeiter aufgelistet werden.
Die Deklaration
Public Function GetMissTimes(MissTimes As clsMissTimes, strStaffNr As String, datPeriodBegin As Date, datPeriodEnd As Date, [lngCompanyID As Long = 0]) As Boolean
Die Parameter
Parametername |
Pflichtpar. |
Beschreibung |
MissTimes |
Ja |
Auflistung der Fehlzeiten |
strStaffNr |
Ja |
Mitarbeiternummer |
datPeriodBegin |
Ja |
Beginn des Zeitraums |
datPeriodEnd |
Ja |
Ende des Zeitraums |
lngCompanyID |
Nein |
Mandantennummer |
Die Klasse clsMissTimes
Die Klasse clsMissTimes listet die einzelnen Fehlzeiten als Objekte der Klasse clsMissTime auf.
Die Klasse clsMissTime
Die Klasse clsMissTime hat die folgenden Eigenschaften, die den Feldern eines Datensatzes der Tabelle TimeControlMissTime entsprechen:
Eigenschaftsname |
Beschreibung |
lngCompanyID |
Mandanten-Nr. |
strStaffNr |
Mitarbeiternummer |
datFrom |
Uhrzeit von |
datTo |
Uhrzeit bis |
blnWholeDay |
TRUE ó Fehlzeit = ganzer Tag |
strReason |
Fehlgrund |
datDate |
Datum der Fehlzeit |
dblTime |
Fehlzeit in Stunden |
strDescriptionShort |
Kürzel Fehlgrundart |
strDescription |
Fehlgrundart |
lngState |
Status des Datensatzes |
blnDeleted |
TRUE ó Datensatz gelöscht |
lngIdentifier |
Externe Kennung |
Die Methode GetStamps
Mittels der Methode GetStamps können die Stempelungen zu einem Auftrag abgerufen werden.
Die Deklaration
Function GetStamps(Stamps As clsStamps, ByVal lngJobID As Long, [lngCompanyID As Long = 0]) As Boolean
Die Parameter
Parametername |
Pflichtpar. |
Beschreibung |
Stamps |
Ja |
Auflistung der Stempelungen |
lngJobID |
Ja |
Auftragsnummer |
lngCompanyID |
Nein |
Mandantennummer |
Die Klasse clsStamps
Die Klasse clsStamps listet die einzelnen Stempelungen als Objekte der Klasse clsStamp auf.
Die Klasse clsStamp
Die Klasse clsStamp hat die folgenden Eigenschaften, die den Feldern eines Datensatzes der Tabelle TimeControlIn entsprechen:
Eigenschaftsname |
Beschreibung |
datChangeDate |
Zeitpunkt der letzten Änderung |
datCreateDate |
Anlagezeitpunkt des Datensatzes |
datDate |
Tag für den die Stempelung gilt |
datTimeEnd |
Ende der Stempelung |
datTimeStart |
Beginn der Stempelung |
dblCosts |
Angabe von Kosten für diese Stempelung |
dblCostsCalculated |
Angabe von bewerteten Kosten für diese Stempelung |
dblBaseCosts |
Angabe Basiskosten der Stempelung |
dblBaseCostsCalc |
Angabe bewerteter Basiskosten der Stempelung |
dblDBCosts |
Angabe Deckungskosten der Stempelung |
dblDBCostsCalc |
Angabe bewerteter Deckungskosten der Stempelung |
dblTime |
Zeit in Stunden |
dblTimeCalculated |
Bewertete Zeit |
lngCompanyID |
Mandantennummer |
lngIdentifier |
Externe Kennung |
lngJobID |
Auftragsnummer |
lngJobIDOrg |
Bei Verwendung eines Leitnummern-Systems die Pseudo-Auftrags-Nummer (Leitnummer) |
lngState |
Status über Verarbeitung des Datensatzes in VxS 0: von VxS noch nicht verarbeitet 1: von KSR verarbeitet -1: nach KSR Verarbeitung nochmals geändert |
strFunction |
Tätigkeit |
strGroup |
Arbeitgruppe |
strStaffname |
Mitarbeitername |
strStaffNumber |
Mitarbeiternummer |
strRuleName |
Bezeichnung der angewandten Regel |
Die Methode GetUnproductiveTimes
Mittels der Methode GetUnproductiveTimes können Unproduktiv-Stempelungen für einen Zeitraum abgerufen werden.
Die Deklaration
Public Function GetUnproductiveTimes(Stamps As clsStamps, datPeriodBegin As Date, datPeriodEnd As Date, [strStaffname As String = ""], [strStaffNr As String = ""], [strGroup As String = ""], [strFunction As String = ""], [lngCompanyID As Long = 0]) As Boolean
Die Parameter
Parametername |
Pflichtpar. |
Beschreibung |
Stamps |
Ja |
Auflistung der Unproduktiv-Stempelungen |
datPeriodBegin |
Ja |
Beginn des Zeitraums |
datPeriodEnd |
Ja |
Ende des Zeitraums |
strStaffName |
Nein |
erweiterte Einschränkung der Rückgabe auf Mitarbeitername |
strStaffNr |
Nein |
erweiterte Einschränkung der Rückgabe auf Mitarbeiternummer |
strGroup |
Nein |
erweiterte Einschränkung der Rückgabe auf Gruppe |
strFunction |
Nein |
erweiterte Einschränkung der Rückgabe auf Funktion |
lngCompanyID |
Nein |
Mandantennummer |
Die Klasse clsStamps
Diese entspricht der Klasse in der Methode GetStamps. Abweichend bei der Rückgabe ist, dass logischerweise keine Auftragsnummern geliefert werden.
Die Methode CalcActualValues
Die Methode CalcActualValues berechnet die Ist-Zeiten zu einem Auftrag. Da diese Funktion zum internen Gebrauch bei KSR bestimmt ist, wird diese hier nicht näher erläutert.
Die Methode GetRuleDirections
Diese Methode liefert, welche Arten von Regeln im System hinterlegt sind. Dies ist z.B. notwendig, um das Ergebnis von CalcActualValues auszuwerten. Auch diese Methode ist für den internen Gebrauch bei KSR bestimmt.
Die Methode CalcSetTime
Die Methode CalcSetTime berechnet die Sollzeiten für einen Auftrag anhand der Auftragsdaten in VxS und erzeugt die resultierenden Datensätze in den Tabellen TimeControlOut und TimeControlOutDetails.
Die Deklaration
Function CalcSetTime(ByVal lngCompanyID As Long, ByVal lngJobID As Long, ByVal blnMasterCurrency As Boolean) As CalcSetTimeResult
Die Parameter
Parametername |
Pflichtpar. |
Beschreibung |
lngCompanyID |
Ja |
Mandantennummer |
lngJobID |
Ja |
Auftragsnummer |
blnMasterCurrency |
Ja |
Angabe, ob mit der Hauptwährung gearbeitet wird |
Der Enumerator CalcSetTimeResult
Der Enumerator CalcSetTimeResult hat folgende Werte:
Const NoError = 0
Const NoExportableStatusFound = 1
Const ReadingProcessAmountsFailed = 3
Const ReadingSubProcessFailed = 2
Const WritingProcessAmountsFailed = 5
Const WritingSubProcessFailed = 4
Die Methode GetOrder
Mit der Methode GetOrder können die Sollzeiten für einen Auftrag abgerufen werden.
Die Deklaration
Function GetOrder(clsOrder As clsOrder, ByVal lngJobID As Long) As Boolean
Die Parameter
Parametername |
Pflichtpar. |
Beschreibung |
clsOrder |
Ja |
Objekt, das die Sollzeiten enthält. |
lngJobID |
Ja |
Auftragsnummer |
Die Klasse clsOrder
Die Klasse clsOrder hat folgende Eigenschaften die den Feldern der Tabelle TimeControlOut entsprechen :
Eigenschaftsname |
Beschreibung |
clsOrderDetails |
Objektauflistung der Auftragsdetails |
datChangeDate |
Letzter Änderungszeitpunkt des Datensatzes |
datCreateDate |
Anlagezeitpunkt des Datensatzes |
datIDChangeDate |
Enthält das Datum an dem der Leitnummerntausch durchgeführt wurde |
dblTotalAmountNet |
Gesamtumsatz Netto des Auftrages |
lngClosed |
0: Auftrag aktiv -1: Auftrag wurde abgeschlossen (Rechnung gedruckt) |
lngCompanyID |
Mandantennummer |
lngIDChange |
Enthält nach Leitnummerntausch die ursprüngliche Leitnummer |
lngJobID |
Auftragsnummer |
lngState |
0: Info wurde von Zeiterfassung noch nicht abgerufen 1: Info wurde durch Zeiterfassung verarbeitet -1: Info wurde nach Verarbeitung nochmals aktualisiert -2: Daten zu Auftrag wurden verworfen u. sollen neu übernommen werden -3: Stempelungen sofort synchronisieren |
strDescription |
Bezeichnung des Auftrages |
Die Klasse clsOrderDetail
Die Eigenschaften der Klasse clsOrderDetail entsprechen den Feldern der Tabelle TimeControlOutDetails:
Eigenschaftsname |
Beschreibung |
dblAmount |
Währungsbetrag |
dblTime |
Arbeitszeit in Stunden |
lngCompanyID |
Mandantennummer |
lngIdentifier |
Externe Referenz |
lngJobID |
Auftragsnummer |
strFunction |
Tätigkeit |
strGroup |
Mitarbeitergruppe |
strStaffNr |
Mitarbeiternummer |
Die Methode ChangeGuideNumber
Mittels der Methode ChangeGuideNumber kann der Leitnummerntausch vollzogen werden. Diese Methode wird normalerweise nur von VxS aufgerufen.
Die Deklaration
Function ChangeGuideNumber(lngGuideNumber As Long, lngJobID As Long, ByVal blnMasterCurrency As Boolean, ByVal lngCompanyID As Long) As Boolean
Die Parameter
Parametername |
Pflichtpar. |
Beschreibung |
lngGuideNumber |
Ja |
Leitnummer |
lngJobID |
Ja |
Auftragsnummer |
blnMasterCurrency |
Ja |
Angabe, ob mit der Hauptwährung gearbeitet wird |
lngCompanyID |
Ja |
Mandantennummer |
Die Methode AssigJob2Proj
Diese Methode wird KSR-intern zur außerordentlichen Zuweisung von Aufträgen zu Projekten verwendet. Auch hier wird auf eine ausführliche Dokumentation verzichtet.
Die Methode GetProjInfo
Mit dieser Methode kann die Definition eines bestimmten Projektes von der Zeiterfassung abgerufen werden.
Die Deklaration
Public Function GetProjInfo(ByVal lngProjID As Long, [ByRef strProjectName As String], [ByRef strProjectKey As String], [ByRef blnCreateFlag As Boolean], [ByRef blnSyncFlag As Boolean], [ByRef blnCompanyIndFlag As Boolean], [ByRef lngDef4Comp As Long], [ByRef vntAdditionaInfo As Variant]) As Boolean
Die Parameter
Parametername |
Pflichtpar. |
Beschreibung |
lngProjID |
Ja |
zum Auftrag zugeordnete Projekt-ID, >(=) 0, Wert aus dem Feld TCOuAssignedProj der Tabelle TimeControlOut. |
strProjectName |
Nein |
Rückgabeparameter*: In diesen Parameter wird der in der VxS-Definition vergebene Projektname geschrieben. |
strProjectKey |
Nein |
Rückgabeparameter*: In diesen Parameter wird der in der VxS-Definition angegebene Zugriffs-schlüssel in der Zeiterfassung für das Projekt geschrieben. |
blnCreateFlag |
Nein |
Rückgabeparameter*: Flag, das angibt, ob die Erzeugung des Projektes bei Nicht-Existenz in der Zeiterfassung vom Benutzer gewünscht wird. |
blnSyncFlag |
Nein |
Rückgabeparameter*: Flag, das angibt, ob die Synchronisierung des Projektes bei Existenz in der Zeiterfassung vom Benutzer gewünscht wird. |
blnCompanyIndFlag |
Nein |
Rückgabeparameter*: Flag, das angibt, ob die Projektdefinition mandantenunabhängig gültig sein soll |
lngDef4Comp |
Nein |
Rückgabeparameter*: In diesen Parameter wird die MandantenID geschrieben, bei dem das Projekt definiert wurde (= Mandant, für den das Projekt gilt, sofern blnCompanyIndFlag = 0) |
vntAdditionaInfo |
Nein |
Rückgabeparameter*: In diesen Parameter werden in Form eines String-Array (mit Basis 0) weitere Informationen zum Projekt geliefert. Auszulesen sind diese nur für den Fall UBound > 0. Derzeitige Informationen: vntAdditionaInfo(1) = Erstellt von vntAdditionaInfo(2) = Erstellt am vntAdditionaInfo(3) = Geändert von vntAdditionaInfo(4) = Geändert am |
Rückgabeparameter*: Diese Werte enthalten dann und nur dann verwertbare Informationen, wenn die Rückgabe der Funktion = TRUE ist. Diese Werte können aber auch bei Rückgabe = FALSE von den übergebenen Werten abweichen.
Die Eigenschaft blnConnected
Nach Aufruf der Methode Connect zeigt die Eigenschaft blnConnected an, ob auf die Datenbank erfolgreich verbunden wurde.
Die Deklaration
Property blnConnected As Boolean
Die Eigenschaft blnIgnoringCompanyID
Diese Methode gibt zurück, ob mandantenabhängig oder mandantenunabhängig gearbeitet wird. Dies wird auf Seite von VxS eingestellt.
Die Deklaration
Public Property blnIgnoringCompanyID As Boolean
Die Eigenschaft DefaultCompanyID
Wird mandantenabhängig gearbeitet, kann mit der Eigenschaft DefaultCompanyID ein Standardwert für die Mandantennummer hinterlegt werden. Wird bei einem Methodenaufruf für die Mandantennummer eine Null übergeben, wird der Wert der Eigenschaft DefaultCompanyID als Mandantennummer verwendet.
Die Deklaration
Public Property DefaultCompanyID As Long
Die Eigenschaft ProjAssign
Mit dieser Eigenschaft wird ermittelt, ob in der Datenbank die Projektzuordnung aktiviert ist. Die Eigenschaft ist schreibgeschützt.
Voraussetzungen
Um mit der Komponente KSR_TimeReg_ActiveX entwickeln zu können, muss das Produkt VCS, VTS oder VIS installiert sein.
Erstellt: 01.03.2004 09:17:03 Author: Ringhut (Zach) Geändert: 31.03.2008 09:57:16 Geändert von: Zach ArtikelID: 4981