project QadFinancials > class BDDocument
business class
inherited from Database Component
business area Payment Instruments
Description
This component handles all details about debtor's payments
List of controlled database tables:
- DDocument - header of payment containing details about debtor, currency, company's bank account and amount of payment.
- DDocumentInvoiceXRef - allocated lines of payment document. There is reference to debtor (creditor) invoices and also allocated amount
- DDocumentInvoiceXrefStage - more details about staged payment of one payed debtor (creditor) invoice.
- DDocumentPostingLine - refernece record which points to posting line created during payment process. During payment life multiple stages are know - initial, allocated, for collection, payed ...)
...
public data items
other data items
- 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.
- vcActivityDDocCodeChoosen
- vcAllowedDDocStatusUptoActivity
- vcAllowedDDocStatusUptoActTR
- vcAllowedDDocStatusUptoForVal
- vcAllowedStatus
- vcBankImpLineRowID
- vcClientPrincipalObject
- vcCompanyCC
Consolidation currency code of active company.
- vcCompanyCode
- vcCompanyLC
Local currency code of active company.
- vcCompanyMC
Code of the management currency as defined on system-level
- vcComponentsWithFS
- vcCurrencyDecimalsList
comma seperated list of currency codes and number of decimals
- vcCurrentExternalUniqueIDInBDD
- vcDaybookCode
- vcDDocumentMsg
Generic message variable for DDocument component.
- vcDeductionCatCodeDesc
- vcDeductionCatCodeType
- vcDomainCode
The domain code of the domain to which this session is logged in.
- vcDomainLngCode
session value
- vcDPaySelRecordsIDChanged
Comma delimited list of DPaySel records that were unassigned from the DDocument.PaySel_ID - if that paysel is no longer referenced by any DDocument it will be deleted.
- vcDraftClass
- vcExternalControlItems
Items to lock in external control
- vcFcComponentName
Short name of the target business class.
- 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
- vcForceDeleteRowids
A comma separated list of rowids of the records that have a forced delete status (tc_status = "D" coming from the input dataset from an external party)
- 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
- vcObjectSecurityLoaded
- vcPaymentFormatPayInstruments
- vcPaymentReferenceDDoc
Payment Reference
- vcPostingRowidDDoc
- vcTableType
S if SharedSet_ID fields in main table
C if Company_ID field in main table
N if no SharedSet_Id and Company_ID in main table
- vcUserLogin
Current User login ID
- vcUserName
Current user name
- vcValidationExceptionList
Comma separated list of business field names.
This data item should be initialised in method MainBlock.
Method ValidateComponent will check this data item. If updates available in the class temp-tables are limited to updates to fields listed in the data item, ValidateComponent will be skipped.
- vcXmlNewStatus
- vcXmlOldStatus
- vdDInvoiceAmountLC
- vdDInvoiceAmountTC
Used in ApiLoadDeductionDetail method.
- vdDInvoiceAmtCC
- vdNonDiscAmtTC
Non Disc Amount TC
- vhBuffer
handle to the table
- 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.
- vhField
handle to the field of the table
- viCompanyCCDec
Number of decimals for the consolidation currency of active company.
- viCompanyCCId
Internal ID of the consolidation currency of active company.
- viCompanyLCDec
Number of decimals for the local currency of active company.
- viCompanyLCId
Internal ID of the local currency of active company.
- viCompanyMCDec
Number of decimals of the management currency as defined on system-level
- viCompanyMCID
ID of the management currency as defined on system-level
- viCompanyPriceDec
Number of decimals for prices in active company.
- viCompanyQtyDec
Number of decimals for quantities in active company.
- viCurrentDraftInstanceId
when opening a draft instance, this data item contains the original instance ID of the draft
- 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
- viFcIncludeReturn
Return status used by the standard includes. Avoid using this data item !
- viFcMaxInstancesInTransaction
The maximum instances in 1 transaction.
- viFcNumberForNew
Keep a unique (negative) number for new records in the generated temp-tables for database maintenance.
- 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.
- viIncSelCount
- viIncSelLineRowid
- viInvoiceVoucher
- viInvoiceYear
- viLogger
Logger
- viRowIdDDoc
- 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
- vlBDCollectionDDocWasStartedHer
- vlBDebtorIsStartedFromDoc
- vlBDInvoiceDDocWasStartedHere
- vlBDPayDDocWasStartedHere
- vlBDPaySelectionWasStartedHere
- vlBJournalEntryDDocWasStartedHe
- vlCBFActive
Custom Business Fields
- vlCBFActiveCache
- vlDataLoadKeepPrevious
Keeps the value of parameter ilKeepPrevious of method DataLoad for usage by submethods of DataLoad.
- vlDataLoadSkipCalculate
When set to true, method DataLoad will not run the Calculate method.
This is useful in case method DataLoad is run inside a loop, and you will run method Calculate yourself after this loop.
- vlDomainIsStatutory
Flag to indicate if the statutory-currency mechanism is activated on the current domain or not
- vlDraftsActive
- vlDraftsActiveCache
- vlEnablePersistentCache
- vlEventPublishingActive
Flag indicates if event publishing is active.
If not, skip all time consuming queries on event publishing.
- vlEventPublishingActiveCache
- vlEventPublishingNeeded
- vlEventsPublished
This data item will be set to true as soon as one event is published from AdditionalUpdates (and so an instance of class BEventDaemonqueu is open and must be closed).
- vlFcDataValidated
This flag indicates whether or not the data in the class temp-tables has already been validated.
- 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.
- vlFieldSecurityActive
Indicates whether the field security is active on system level.
- vlFieldSecurityActiveCache
- vlFieldSecurityActiveOnBC
- vlGLVerificationActive
- vlGLVerificationActiveCache
- vlInitializeTranslations
Load default value for active language codes without translation.
- 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.
- vlIsInExternalControl
When a database object is in external control, this flag will be set to true in method CheckActivityEnabling.
- vlIsQStartedDInvoiceById
- vlIsQStartedGLByBankInfo
- vlIsQStartedMfgTaxCodeByTaxC
- vlIsQStartedPostingVatByPosti
- 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".
- vlPartialUpdate
Indication whether the execution of the logic in MaintainByDataset* is done in a partial update mode.
In that case, variablele vcNeglectableFields andvc vcForceDeleteRowids need to be used to "correct" the S buffers before validation.
- vlSkipAdditionalUpdatesDDoc
When using the ApiStdMaintainTTWithoutAddUpd method to create documents (the people from conversion will use it), it should be possible to create just the documents with its invoice links, but without any other updates to the linked invoices or the postings... We will use this variable to check it.
* In InitInstance, it will be set to false.
* In ApiStdMaintainTTWithoutAddUpd, it will be set to true.
- vlSkipDueDateValidationDDoc
Normally, the due date of a document must be at least today. It cannot be in the past. However, when using the ApiStdMaintainTT method (the people from conversion will use it), it should be possible to have the due date in the past. We will use this variable to check it.
* In InitInstance, it will be set to false.
* In ApiStdMaintainTT, it will be set to true.
- 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
- vlUseExtUniqueIDInDDForSetMsg
- vlWorkFlowActive
workflow active
- vlWorkFlowActiveCache
API queries
API methods
public methods
other methods
activities
- Change Status
- Create
- Create upto Accepted status
- Create upto Initial status
- Create upto Portfolio status
- DDocumentGOTODDocumentPostingSelect
- Delete
- Modify
- Modify upto Accepted status
- Modify upto Initial status
- Modify upto Portfolio status
- ReturnToSender
This activity cannot be actually performed on an object, but must be defined in the system anyway so it can be assigned to the system role 'Workflow user'.
- View