System Parameters Travel

System Parameters Travel

System parameters apply across the entire Travel module. They should be changed only if the business rule cannot be modeled by a historized configuration or a trip type. The available parameter list depends on the installed variant and the enabled modules.

Some parameters of the bean TmOptions are only the system-wide default value: if a value is set in the client settings (tab "Travel management"), it takes precedence (noted below).

Currency and trip ID

• TmOptions.leadCurrencyIsoCode and leadCurrencyName define the base currency (default: EUR / Euro). They are evaluated at startup: if the currency does not exist yet, it is created with rate 1. These parameters used to be in the bean TmCurrencyServiceTarget; the values were adopted automatically during the update.
• TmCurrencyServiceTarget.useRecordDateForLookupOfExchangeRate (default: false): if true, the exchange rate is determined as of the receipt date, if false as of the end date of the trip. Applies only if no cutoff date for the exchange rate is set in the trip type (always for mileage allowance receipts).
• TmOptions.currencyLayerApiKey is the API key for the exchange rate provider CurrencyLayer when importing exchange rates.
• TmTravelServiceImpl.travelIdGeneratorImpl selects the generator for trip IDs (default: TmTravelIdGeneratorDefault). This parameter used to be in the bean TmTravelServiceTarget.
• For TmTravelIdGeneratorFormattedDateNumber, the parameters travelIdTemplate (default: {0}{1}), simpleDateFormatPattern (date format, default: yyDDD) and decimalFormatPattern (number format, default: 00) control the structure of the trip ID.

Travel options

• TmOptions.adminRoleDelete and adminRoleUpdate determine administration rights (default in each case: Webdesk Administrator).
• TmOptions.showColumnAmountTaxFree (default: false) and showColumnAmountTaxable (default: true) control tax-free and taxable columns, respectively. The client settings "Show the tax-free column/row ..." and "Show the taxable column/row ..." take precedence.
• TmOptions.routePlanningURLPattern defines the URL template for route planning (placeholders e.g. ${sourceLocation} and ${targetLocation}). If the parameter is empty (default), an outdated Map24 address is used.
• TmTravelServiceImpl.costCenterOrgHierarchy specifies from which organization hierarchy cost centers are determined (default: empty). This parameter used to be in the bean TmTravelServiceTarget.
• TmOptions.allowedAttachmentsMimeTypes: file types that may be uploaded to a travel expense report (default: jpg, jpeg, png, pdf, rtf, zip as well as Word, Excel and PowerPoint formats). The client setting "Select the file types that may be uploaded to a travel expense report" takes precedence.
• TmOptions.allowedVatTaxes: selectable VAT rates in percent (default: 7, 10, 20).
• TmOptions.useFirstTravelTypeAsDefault (default: true): the first available trip type is preselected for a new travel expense report. The client setting of the same name takes precedence.
• TmOptions.useItinerarySegments (default: false): users can record routes and intermediate destinations including private stays. The client setting "Allow the user to record routes and intermediate destinations including private stays" takes precedence.
• TmOptions.validateKmBillClashesPerVehicle (default: true): for mileage allowance receipts, it is checked that the odometer readings (Km from/to) do not overlap with an earlier receipt of the same vehicle. The client setting takes precedence.
• TmOptions.travelFolderAutoCreation (default: false): users may enable the automatic creation of travel folders. The client setting "Allow users to automatically create travel folders" takes precedence.
• TmOptions.travelTypesToExcludeFromTimeRangeValidation: short names of trip types whose trips are not checked for appointment conflicts (default: empty).
• TmOptions.authorMayUploadAdditionalFilesAtAnyTime (default: false): the traveler may upload additional files at any time.
• TmOptions.showClientInTravelFolder (default: true): the client is displayed in the travel folder.
• TmTravelServiceImpl.copyAttachmentsFromRequest2Expense (default: false): attachments of the travel request are carried over to the travel expense report (only with document management).

Calculation and rounding

• TmCalculatorDefaults.roundingPrecision defines the default precision for rounding (default: 100).
• TmOptions.useTaxfreeAllowanceCalDefinitionIfNoCorporateExists (default: true): if a settlement definition for the company view is missing, the tax-free settlement definition is used for both views.
• The parameters of TmAllowanceCalc24HourImpl and TmAllowanceCalcCalDayImpl control, among other things, tax-free reductions and the handling of international legs.
• Further calculator parameters can concern factors, rounding, tax-free portions or additional fields. They may only be changed together with the respective settlement definition.

Procedure and verification

1. Document the previous values and identify the affected trip types or settlement definitions.
2. Change the parameter and wait for the cache/cluster refresh.
3. Check a domestic and an international trip and, if affected, receipt, mileage allowance, time correction and export.

Business calculation rules preferably belong in settlement definitions, not in uncommented global parameters.