project BLF > class BScanDaemonProcessor
business class
inherited from BBaseDaemonProcessor
business area Daemon Setup
Description
Scan-daemon processor component.
This component implements the real daemon loop.
The scan daemon will load documents from an input folder into the application database, and store them as draft objects (see class BDraftInstance). The document itself is linked to the newly created draft object by standard document linking (see class BDocumentLink).
public data items
other data items
- sLogs
Logging stream
- spid
Stream to read the process id in case of a unix OS
- tFcMessages
Contains a list of messages to display on the client side. Records in the table should not be created directly, but by using method SetMessage.
- vcClientPrincipalObject
- vcCompanyCode
- vcComponentsWithFS
- vcDomainCode
The domain code of the domain to which this session is logged in.
- vcDomainLngCode
session value
- vcDraftClass
- vcFcComponentName
Short name of the target business class.
- vcFcDaemonLogFile
The log file in which the daemon generates its log.
- vcFcDaemonLogin
The account to be used for login by the daemon
- vcFcDaemonName
Name of the daemon for wich this processor is running
- vcFcDaemonPassword
The password that has to be used for the login of the daemon process.
- vcFcDaemonProcessHostName
- vcFcDateFormat
Display format for dates to be used in all displayable strings.
- vcFcMaskList
Data item to temporarily store the returned values of a value list method (or any other use).
- vcFcNumericFormat
Display format for decimal values to be used in all displayable strings.
- vcFieldSecurityDisabledFields
- vcGlobalSessionId
This data item holds the global session token. This is set in CheckLogin on QADFC level and passed with ApplicationLogin in Login. Is also set in ApplicationLogin.
- vcLocalisationCode
- vcMsgScanPro
MsgScanPro
- vcUserLogin
Current User login ID
- vcUserName
Current user name
- vhCacher
Handle to the technical class
- vhFcComponent
field of t_FC_active_components.
Also a normal data item used for all direct calls from business to business components.
- vhFcPersistence
In a stateless setup, when the server component is started, an instance of the persistence component is started automatically, which will stay active for the complete session.
That way, each Loadstate of any component can use the same instance of the persistence component.
- vhFcStateDataSet
This is the handle to the dynamic dataset that holds all temp-tables defined in the business class making up the state of this business class.
You can add your own temp-table to this dataset to enable you to persist the contents of that temp-table, using the add-buffer() method on vhFcStateDataSet in method DefineState.
- vhFcSuper
Handle to the component at the top of the inheritance tree (the server component), as it is used to run iStartComponent.
- viCurrentDraftInstanceId
when opening a draft instance, this data item contains the original instance ID of the draft
- viExternalDebugLevel
ExternalDebugLevel
- viFcCount1
Counter variable for general use.
- viFcCount2
Counter variable for general use.
- viFcCount3
Counter variable for general use.
- viFcCount4
Counter variable for general use.
- viFcCount5
Counter variable for general use.
- viFcCurrentInstanceId
instance ID
- viFcDaemonId
Id of the daemon record.
- viFcDaemonInterval
Time the daemon has to "sleep" in case that it does not have any work to do.
- viFcDaemonProcessId
Process id of the progress session in which this daemon is running.
- viFcIncludeReturn
Return status used by the standard includes. Avoid using this data item !
- viFcMaxInstancesInTransaction
The maximum instances in 1 transaction.
- viFcQueryReturn
Return status used by query calls. Avoid using this data item !
- viFcReturnSuper
General purpose data item that can be used for the return status of any method call.
- viLogger
Logger
- viMaxNumberOfRetriesPerQueue
- viSessionDebugLevel
- viTimeOffset
Specifies the time offset in minutes between local time and UTC.
This value will be assigned to the session:timezone attribute to be able to control the output of the progress functions today and time.
- viUsrId
Current user identifier
- vlCBFActive
Custom Business Fields
- vlCBFActiveCache
- vlDaemonNeedsToEnd
- vlDoIKeepProcessedItems
- vlDraftsActive
- vlDraftsActiveCache
- vlEnablePersistentCache
- vlEventPublishingActive
Flag indicates if event publishing is active.
If not, skip all time consuming queries on event publishing.
- vlEventPublishingActiveCache
- vlFcOk
Logical data item for general use.
- vlFcQueryRecordsAvailable
Support query existance calls. Returns true if at least one record has been found.
- vlFcStarted
Used in BC_run.i.
If the component was started in BC_run, it must also be ended in BC_run. If the component was already running before BC_run, it should stay running.
- vlFcStopDaemon
Logical value indicating whether the daemon should stop running
- vlFieldSecurityActive
Indicates whether the field security is active on system level.
- vlFieldSecurityActiveCache
- vlFieldSecurityActiveOnBC
- vlInstanceDataIsLoaded
This flag indicates if the instance data of current instance was loaded from the state database.
This is true when :
- Any instance is opened in stateless mode.
- A draft instance is opened in state-reset mode.
- vlObjectSecurityActive
Flag indicates if row security is in use.
If not, skip all time consuming queries on row security.
- vlObjectSecurityActiveCache
- vlObjectTranslationsActive
Value of system setting "Use Language Specific Object descriptions".
- vlTransactionActive
This flag will be true if current instance started an instance of another business class as a subtransaction, but current instance is not part of a transaction.
In this case, current instance already started a transaction of it's own. Now it must also commit this transaction of it's own.
- vlTransactionMainInstance
Role-based security is mandatory on main instance in transaction (= first instance added) and optional on all others.
- vlTransactionOpen
A special-purpose flag for the transaction class only.
- vlTranslationTracing
- vlUICustomizationActive
user setting = instance dependent
- vlUseWriteDirectInLockWorkItem
Set this data-item to false if LockWorkItem has to use the instance method BBaseDaemonQueue.LockWorkItem.
If left true, the work item wil be locked by calling WriteDirect in the persistence
- vlUseWriteDirectInSetWorkResult
Set this data-item to false if LockWorkItem has to use the instance method BBaseDaemonQueue.SetWorkItem.
If left true, the work item wil be locked by calling WriteDirect in the persistence
- vlWorkFlowActive
workflow active
- vlWorkFlowActiveCache
API methods
public methods
other methods