Configuration Key Table

Last updated:

    Overview

    The system provides a number of configuration keys that allows a practice to modify the application to suit their operating practices. Access the configuration keys from Maintenance > User Defined > Configuration. It is strongly recommended that you read How to customise the application before adding or modifying any of the keys. Otherwise, the application may fail.

    Billing

    Keys

    KeyName

    KeyValue

    Description of what is or does

    BillingAllocation

    FIFO

    Add this key if the client wants to default to FIFO. If the client wants both FIFO and Pro Rata then do not add.

    BillingAllocation

    Prorata

    If the client wants to default to Pro Rata then add this key. If the client wants both FIFO and Pro Rata then do not add.

    BillingDefaultFont

    Arial

    Default Billing Font (case sensitive)

    BillingDefaultFontSize

    12

    Default Billing Font Size

    DisableFIFOBilling

    1

    Hard coded Pro Rata

    DisableFIFOBilling

    0

    Hard coded FIFO

    EnableFIFOBilling

    1

    Either Pro Rata or FIFO  billing can be used depending on whether pro-rate box is ticked

    DisableMultiCompanyBilling

    1

    This will default the client company value (held in the contact table) in the Company field on the Billing Wizard and will not allow the user to change the value or to browse to the available company entries

    DisableMultiCompanyBilling

    0

    This will leave the Company field blank on the Billing Wizard and the wizard will not allow the user to proceed without browsing for an appropriate company value

    MatchBillToAssignmentCompany

    1

    If it is set for true the user can not choose the company through which they would like to bill the client for the assignment.  The company will default to the company set up for the ?????????

    Requestforpaymentdefault

    1

    This will tick the RFP checkbox on the Billing screens by default.

    Requestforpaymentdefault

    0

    This will Untick the RFP checkbox on the Billing screens and default bills to be invoice transactions

    UnspecBillingEmployee

    1

    Misc charges and Estimates to Complete invoices will go against unspec employee

    UnspecBillingEmployee

    0

    Misc charges and Estimates to Complete invoices will go against employee who created the bill

     

    Cash Posting Ledger

    Keys

    KeyName

    KeyValue

    Description of what is or does

    Cash Allocation Date

     

    1

     

    System will use the latest of either the bill or cash dates as the allocation date. If the date of this later transaction falls within a closed tax period, then the allocation date will default to the current system date.

    CTI Application

    Keys

    KeyName

    KeyValue

    CTI_SingleViewClientKey

    Client

    CTI_SingleViewContactKey

    Cont

    CTI_SingleViewURL

    http://w2k3ad01/Singleview/contacts/...actdetails.asp.  This is the default page that will open through the CTI system.

     

    Document Creation Settings

    Keys

    KeyName

    KeyValue

    Description of what is or does

    DocumentCreationAssignment

    [AC]\[AN]\[AD]

    A valid set of document creation codes. See How to define Document Creation Settings.

    DocumentCreationBillingStartupPath

    C:\data\Services\Accounts

    The initial path for all billing documents. See How to define Document Creation Settings.

    DocumentCreationClient

    TM]\[DD-MMMyy]\[CC-1]

    \[CC]\[CB]-[PP]

    A valid set of document creation codes. See How to define Document Creation Settings.

    DocumentCreationContact

    [TM]\[DD-MMMyy]\[LN-1]

    \[LN]\[Filename]

     

    A valid set of document creation codes. See  How to define Document Creation Settings.

    DocumentCreationStartUpPath

    C:\VPMDOCS

    The initial path for all general documents. See How to define Document Creation Settings.

    DocumentCreationTemplatesPath

    C:\Program Files\Microsoft Office\Templates\*.dot

    The path to look for templates for document creation. See How to define Document Creation Settings.

    DocumentCreationWordBilling

    [CC-1][CC-2]\[CC-3]\[CC]

    A valid set of document creation codes. See How to define Document Creation Settings.

    MailingFormalName

    [FN-1/1][LN][Esq]

    Additional algorithm to be used in preference to the standard if the contact is a male.

    MailingInitials

    FN-1/1][LN][Esq]

    Additional algorithm to be used in preference to the standard if the contact is a male.

    rMailingName

    PR][FN-1/1][MN-1/1][LN]

    Prefix, First Name, Middle Name and Last Name formats

    MailingNameSeparator

    [.]

    This key determines the character that is used as the name or initial separator.

    This most commonly used will be a full-stop or space.

    MailingSalutation

    [FN]

    Basis on which contact's salutation is created from the available contact name fields.

    WordBillingPath

    C:\IT Folder\VPM files\Bills\

    No longer valid. See How to define Document Creation Settings.

    Counter Character

    a

    Document Creation Counter Character.

    Document Creation

    The path to save files consists of the DocumentCreationStartUpPath and any of the DocumentCreationAssignment / DocumentCreationClient / DocumentCreationContact values. The DocumentCreationStartUpPath should not have a trailing backslash. The DocumentCreationAssignment value etc. should have neither a leading or trailing backslash.

    Billing Document Creation

    The path to save files consists of the DocumentCreationBillingStartupPath and the DocumentCreationWordBilling values. The DocumentCreationBillingStartupPath would typically be the root directory of a non-changing network location for all document creation. The DocumentCreationWordBilling value would then specify the variable section of the directory structure (i.e. the section that contains the document creation codes for word billing).

    The paths to save/retrieve documents are formed by using the above method to retrieve the correct path

    e.g.       Assignment documents will be created in C:\ VPMDOCS\[AC]\[AN]\[AD]

    When the path is generated for use the codes in square brackets are replaced for actual values if available (all characters are removed from data other then a-z, 0-9, -, , &.

    e.g.       Assignment Code: J107/ AUD

                Assignment Name: James Brown/Audit

                Assignment Description: Audit

    Assignment documents will be created in C:\VPMDOCS\J107AUD\James BrownAudit\Audit.

    The valid document creation codes are as follows:

     

    Activity / Task Document Creation

    Billing Doc Creation

    Document Code

    Description

    Available from Client

    Available from Contact

    Available from Assignment

    Available from Billing

    [DD]

    Todays Date

    Yes

    Yes

    Yes

    Yes

    [PP]

    Partners Name

    Yes

    Yes

    Yes

    Yes

    [CC]

    Client Code

    Yes

    Yes

    Yes

    Yes

    [CO

    Client Office

    Yes

    Yes

    Yes

    Yes

    [CB]

    Created By Username

    Yes

    Yes

    Yes

    Yes

    TM]

    Template Name

    Yes

    Yes

    Yes

     

    [LN]

    Client Last Name

    Yes

    Yes

    Yes

    Yes

     

    [FN]

    Client First Name

    Yes

    Yes

    Yes

    Yes

    [CD]

    Client Department

    Yes

    Yes

    Yes

    Yes

    [ CN]

    Contact Name

    Yes

    Yes

    Yes

     

    [ CF]

    Contact Full Name

    Yes

    Yes

    Yes

     

    [AN]

    Assignment Name

     

     

    Yes

     

    [AC]

    Assignment Code

     

     

    Yes

     

    [AD]

    Assignment Description

     

     

    Yes

     

    [AP]

     

    Assignment Department

     

     

    Yes

     

    [ AO]

    Assignment Office

     

     

    Yes

     

    [ Xxxxxx]

    User Defined

     

     

    Yes

     

     

    By using the above code and a length portion i.e. [CC-1] the appropriate number of characters will be used from the left of the value in this case the client code.

    For example:    

    If the client code is ABC123456 then [CC-1] will return A

    If the client code is ABC123456 then [CC-3] will return ABC

    If the client code is ABC123456 then [CC] will return ABC123456

     

    If a specific portion of the data is required, then the following syntax can be used (the first number is the starting position and the second number is the number of characters to be returned from the starting character, 1/3):

    For example:.     

    If the client code is ABC123456 then [CC-1/3] will return ABC

    If the client code is ABC123456 then [CC-2/3] will return BC1

    If the client code is ABC123456 then [CC-3/2] will return C1

    If the client code is ABC123456 then [CC-4/1] will return 1

     

    If alphabetical characters are required in only a portion of the returned data, then using the @ character will ensure that all other characters are ignored:

    For example:

    If the client code is ABC123456 then [ CC-@] will return ABC

    If the client code is ABC123456 then [CC-@2/1] will return B

    If the client code is ABC123456 then [CC-@3/2] will return

    If the client code is ABC123456 then [CC-@1/3] will return ABC

    Launching Applications

    Applications such as VAP, Trust, Tax

    KeyName

    KeyValue
    Example shown only

    Description of what is is or does

    CorTaxProgLoc

    C:\CTSA.EXE

    Path of the CorTax executable file

    PerTaxProgLoc

    WTAXMP\WTAXMP32.EXE

    Path of the PerTax executable file

    PerTaxYear

    2007

    Default tax year that will open for a client.  If the tax return has not been started the focus will remain on the client search

    SecTAXProgLoc

    C:\WSECMP32.EXE

    Path of the SecTax executable file

    TAProgLoc

    WTRUMP\WTRUMP32.EXE

    Path of the Trust Accounts executable file

    TaxPackProgLoc

    C:\Taxpack.EXE

    Path of the Taxpack executable file

    VAPDataLoc

    C:\Viza

    Location of the VAP data

    VAPProgLoc

    C:\Program Files\Viztopia32\Viztopia.EXE

    Path of the VAP executable file

     

    Miscellaneous

    Keys

    KeyName

    KeyValue

    Description of what is or does

    CalendarAgeing

    1

    Changes the ageing method on ledgers and reports to a calendar month.  This will override any user defined aged debt bands defined within the system.

    Cash Accounting Method

    Accruals

    Method of accounting for VAT on an invoice.  This key sets the system to account for the organization to be liable for the tax component of the invoice once created. This is created when VAT reports are first run.

    Cash Accounting Method

    Cash

    Method of accounting for VAT on an invoice.  This key sets the system to account for the organization to be liable for the tax component of the invoice once cash is received and allocated against it. This is created when VAT reports are first run,

    Bookkeeping Export Default

    1

    Export to Bookkeeping detail default

    RichTextDisabled

    1

    This will disable rich text if necessary i.e. restrict font settings to those used in the template.

    StandingOrderDisabled

    1

    This stops the Standing Order from loading on login

    Screen Text

    1

    This enables the Screen Text menu under Maintenance > System > Screen Text. Users can use this option to amend the existing terminology used throughout the application.

    DisbursementsOn

    0

    This activates the Expenses Ledger option within VPM

    DisbursementsOn

    1

    This activates the Disbursement option within VPM

    DisbursementsOn

    2

    This activates both Expenses and Disbursements within VPM

    SchedulesOnClientWizard

    1

    Adds schedule creation steps to Client wizard and Add assignment from template

    Homepage

    N (where N is the number of homepage views required)

    Allows the user to define a number of views available in the application

    EnforceEmailUniqueness
    1 Prevents an email address from being used on more than one contact/client with the same type. For example ian.wilson@wolterskluwer.co.uk could not be added as the primary email for two contacts but it could be added to a second contact/client as another type e.g. alternate email address (Note Email types are created under Maintenance, Address/Phone, Phone number and Email address
    DUMP -ma -e 1 Enables program debugging info within the Support Centre, Advanced tab, System Trace File option.

     

    Replication

    Bill Sequencing Keys

    KeyName

    KeyValue

    Description of what is or does

    BillSequenceType

    Office/Partner/Company/Department

    Determined the basis for which each bill sequence will be set up

    UniqueBillNo

    1

    Does not allow duplicate bill numbers

    UniqueBillNo

    0

    Allows duplicate bill numbers

    UniqueBillSequence

    1

    Will NOT allow bill sequence ranges of overlap

    UniqueBillSequence

    0

    Will allow bill sequence ranges of overlap

    Combining the keys

    Unique Bill #

    Unique Bill Sequence

    Notes

    1

    0

    This is not a recommended combination.

    Attempts to post a bill with a duplicate bill number will fail on Column 1.

    0

    0

    Each entity/office could maintain the same range of bill numbers in their bill sequences.

    No checks would be made on the uniqueness of the bill number.

    1

    1

    This combination guarantees a unique bill number and discrete bill number sequences.

    0

    1

    Whilst the sequences would be discrete, a user could still enter a duplicate bill number by resetting the bill counter.

     

    Subscriber/Publisher Keys

    KeyName

    KeyValue

    Description of what is or does

    Subscriber

    1

    Establishes the current database as the Subscriber database in the replication process.

    Publisher

    1

    Establishes the current database as a Publisher database in the replication process.

     

    PerTAX

    Link to ​PerTAX keys

    KeyName

    KeyValue

    Description of what is or does

    PerTaxDBName

    PERTAXSVR

    Name of the PerTax database

    PerTaxServerName

    PERTAX

    Name of the PerTax server

    Purchase Invoices

    Keys

    KeyName

    KeyValue

    Description of what is or does

    BillAuthOn

    1

    Enforces supplier invoices to be submitted and authorized via the authorization model prior to posting.

    BillAuthOn

    0

    Allows users to enter and post supplier invoices without having to submit and authorize them before posting.

    UseInvoiceSuspense

    1

    Enforce the use of an Invoice Suspense nominal account when posting a purchase invoice.  Note: this will override the default expense nominal as set on the supplier record.

    SupplierInvoiceDateWarning

    1

    The system should prompt user message to indicate that the date entered falls outside the current account period.

     

    Secondary Authorisation

    Keys

    KeyName

    KeyValue

    Description of what is or does

    SecondAuthApplyClientPartner

    1

    Absence of this key or a value other than 1 will result in the initial secondary authorisation model being applied.

    BillWriteOffAuthorisationValue

    500

    Absolute loss amount to establish secondary billing authorisation

    BillWriteOffAuthorisationPercent

    30

    Absolute loss percentage to establish secondary billing authorisation

     

    Reporter Professional

    Keys

    KeyName

    KeyValue

    Description of what is or does

    Smart Reports

    Eg: MGIP-4OGB-0GKG-E77F

    Key Value will be generated from a pin code generator.  The RegName from the Config table should be used as the basis for generating this pin.

    VIZ Essentials

    Keys

    KeyName

    KeyValue

    Description of what is or does

    AdvancedAssignments

     

    1

     

    Only a value is added if advanced assignment is required as part of Viz Essentials

    AdvancedBilling

    1

    Only a value is added if advanced assignment is required as part of Viz Essentials (not really used currently)