business class
inherited from Database Component
business area General Ledger
Description
This component contains all functionality required to create, validate and save postings
It also contains a number of instance-less methods that can be called and that return a default posting that can be modified and completed before storing it.
API annotation
Currency and Amounts
-----------------------------------------------------
Depending on the GL definition, currency amounts, other than local currency, can be used. The following set-ups are possible (see Maintenance / General Ledget Account / Currency tab) :
* Base currency (LC=local currency) only: the 'Base Currency Only' box is checked. Only amount fields with suffix LC can be filled in and those fields are mandatory.
* Single transaction currency (TC): This is the currency entered in the 'Currency Code' field. The 'Local Currency Only' box must not be checked. The amount fields with suffix TC must be filled in. The amount fields with suffix LC are not mandatory. When the LC Amount fields are filled in, they are used as is. If left empty the system calculates them using the applicable exchange rate.
* All currencies allowed: the 'Base Currency Only' box is not checked and the 'Currency Code' field is left empty. The amount fields with suffix TC must be filled in. The amount fields with suffix LC are not mandatory. When the LC Amount fields are filled in, they are used as is. If left empty, the system calculates them using the applicable exchange rate.
Note: In a local currency posting, the system sets the TC value equal to the LC value.
Amounts can also be entered in statutory currency (CC= statutory currency). Statutory Currency fields are not mandatory. When supplied, they are used as is. If left empty, the system calculates them based on the LC values and the applicable exchange rate.
If the statutory currency is not activated, the fields with suffix CC are discarded.
Debit and Credit fields exist for LC, TC, CC and PC amounts. However, only one of the two can be entered. Normally, amounts are entered with a + sign, but it is possible to enter a negative amount, which is then considered to be a correction.
Exchange Rates
-----------------------------------------------------
The exchange rate converts TC amounts to LC amounts as follows:
Amount LC = Amount TC * Exchange Rate (TC/LC) * Scale Factor.
The Scale Factor is a decimal number that has to be multiplied by the exchange rate to get the real exchange rate. The Scale Factor format is 9999999.9999999 and it was introduced to extend the accuracy of the exchange rate.
The exchange rate parameters are not mandatory. If no exchange rate parameters are specified, the applicable Financials exchange rates are used.
Note: Exchange rates to convert from LC to CC cannot be specified. The rates defined in the Financials exchange rates table are always used.
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.
- vcAddGLNbrMsg
- vcAutoBalancePostingRowIds
Comma separated list of the Row_ids of automatically generated posting lines to Auto-balance GL account
- vcAutoLoadReversingPostingIDs
List of Postings automatically loaded during processing of the changes linked to counterpart posting
- 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
- vcControlGLCode
Control GL Account
- vcCurrencyDecimalsList
comma seperated list of currency codes and number of decimals
- vcDomainCode
The domain code of the domain to which this session is logged in.
- vcDomainLngCode
session value
- 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
- vcOwnTaxIdFederal
Own Tax ID Federal
- vcOwnTaxIdMisc1
Own Tax ID Misc 1
- vcOwnTaxIdMisc2
Own Tax Id Misc2
- vcOwnTaxIdMisc3
Own Tax Id Misc3
- vcOwnTaxIdState
Own Tax ID State
- vcPostingVatTaxIdFederal
Tax ID Federal
- vcPostingVatTaxIdMisc1
Posting Vat Tax Id Misc1
- vcPostingVatTaxIdMisc2
Posting Vat Tax Id Misc2
- vcPostingVatTaxIdMisc3
Posting Vat Tax Id Misc3
- vcPostingVatTaxIdState
Tax ID State
- 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
- vcTemplateLoadedList
Assign vcTemplateLoadedList :
chr(4) separated list of the Company-id and Template-codes that have been loaded into postings
of current business-class-instance. The Company-id and Template-code are chr(2) separated.
(this is used for saving updated template). Example: 001<chr(2)>TemplateA<chr(4)>002<chr(2)>TemplateB
- 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
- 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
- viApiQPostingLineID
- viApiQPostingSafID
- 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.
- viLogger
Logger
- viOwnTaxDeclaration
Own tax declaration
- viSessionDebugLevel
- viTempPostingVoucher
- 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
- vlBGLOpenItemIsStartedFromPost
Is instance of GL Open Item started from here ?
- vlBPostingIsStartedFromBYrClose
- 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.
- vlIsOnlyTemplateCodeModified
Before, journal entry cannot be modified in many case. In the 2014 enhancement, it is allowed to modify the template code in the most cases. In those case, only the template code could be modified. This field is used to store the check.
- vlModify
- 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.
- 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
- vlWorkFlowActive
workflow active
- vlWorkFlowActiveCache
API queries
API methods
public methods
other methods
activities
- ExternalCreate
EXTERNALCREATE_ACTIVITY: this activity will only be used to secure the creation via ApiStdMaintainTT and will never be shown in the menu (seq = 0).
This was needed because every externaly called api-method should cpesify the current activity.
- 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'.