System Parameters

Overview

FreeBalance applications are designed to support configuration rather than code customization as the main approach to support unique country needs. Parameters are part of the configuration capabilities of the FreeBalance Accountability Platform.

 

Objectives and Benefits

Parameters provide the ability to define specific values that impact in one or several modules of the Platform. These values are used for calculations, validations, processes, and display purposes. For example: Default Language is a global parameter that allows you to define the default language for a specific system installation.

Some Parameters are required for a proper Platform operation therefore is necessary to define them before to start using the Platform or a specific Module. Parameters definition is divided by module or scope, for example: Global, Base Entities, Procurement, Human Resources, Assets, Budgeting, etc.

Assets

ID Generation

Generate Asset Item ID?
This is a setup parameter to determine if the code in the asset item is entered by a user or system generated. When set to false, this value will be manually entered by the user. If set to true, this value will be generated by the system and it will be left padded with zeros.
Generate Asset Transaction Type ID?
This is a setup parameter to determine if the code in the asset transaction type is entered by a user or system generated. When set to false, this value will be manually entered by the user. If set to true, this value will be generated by the system and it will be left padded with zeros.

Other Parameters

Linked with FA
This is a parameter regarding the integration of the Asset Accountability module with FreeBalance Accountability. Setting the parameter to true will link the Asset Accountability with FreeBalance Accountability. When Asset Accountability is used as a stand alone application, the application will be used solely for managing fixed assets and therefore parameter will be forced to be false.
Bar Code Mandatory in Assets?This is a setup parameter which determines whether the barcode configuration number will be a mandatory function in the application or a non-mandatory function in the application
Asset Transactions Cash AccountThis parameter is the GL Coding Block associated with the Cash Account. Asset transactions may affect this account when a revenue or expense occurs by the result of an asset transaction.
Asset Transaction Gain AccountThis parameter is the GL Coding Block which must be used to credit/debit gains obtained by the result of the sale/exchange/auction of an asset or group of assets.
Asset Transaction Loss AccountThis parameter is the GL Coding Block used for credit/debit losses as the result of a disposal of an asset transaction over an asset item or group of asset items.
Allow Subclass Validation in Asset Item?
Depending on complexity of the organization and aims of the Asset Accountability implementation, validating components within a class could add difficulty to the class/subclass model, therefore if this parameter is set to false; components in an asset will not enforce the class component validation rules. If this parameter value is true, the user cannot associate components to an asset item whose asset class doesn't have class components.
Handles Depreciation Process in Asset Item?
This is a parameter that relies on the need of the Asset Accountability to handle the depreciation of assets. If the parameter is set to true, Asset Accountability will handle depreciation process in accordance with the set process. If set to false, in the case that depreciation is not needed, all attributes related to the depreciation process will be optional.
Enforce entering a Goods Services Request Group?This is a parameter which specifies whether the user registering the Material Request has to select a particular Material Request Group, if this parameter value is 'true' the attribute will be mandatory, otherwise will remain as optional.
Asset Item in Count Mandatory Reason for DifferenceThe parameter is to determine if a reason for difference is mandatory in asset item count discrepancies. If set to 'true' the system will require attributes ‘Asset Item in Count Reason for difference’. The default value is ‘false’.
File name prefix for Asset Count Request file while uploadingThis is a 'string' parameter with no value by default and specifies the file name 'prefix' to be used for files uploaded for Asset Count Request. The system will apply a filter based on this prefix to prevent uploading files not related to this process.
Acquisition Information Mandatory in Asset Item

The parameter is to determine if information regarding the acquisition of asset item is mandatory. If true the system will require 'Acquisition Information' attribute mandatory when creating an Asset Item. If false such attribute will be optional.

Financial Coding Blocks Mandatory in Asset Item
This is a boolean parameter 'true' by default, which determines if the following attributes in Asset Item must be mandatory or not:
 
Asset Item Coding Block
Revaluation Surplus Coding Block
Expense Coding Block
Accumulated Depreciation Account
 
If parameter is set to false, the attributes are not mandatory.
Catalogue Item Mandatory in Asset Item

The parameter is to determine if information regarding the catalogue item is mandatory. If true the system will require 'Catalogue Item Reference' attribute as mandatory when creating an Asset Item.  And the system will provide the search options to the mentioned catalogue by relevant criteria. If false such attribute will be optional. The default value is false.

Allow Duplicated Barcodes in Asset Item

The parameter is to determine if barcodes can be entered more than once. When true, the system will allow duplicated Bar codes. The default value is false.

 

Allow Imbalance Financial Operation AmountThis parameter determines if an Asset Financial Operation can be posted without ensuring the balance equals zero between debits and credits in the Financial Operation details. If set to true, a balance is not required. If set to false, a zero balance is mandatory. The default value is false.
Asset Financial Operation SourceThis is an integer parameter that will be used to reference a particular Financial Operation Source already registered in the system. This is a nullable integer and cannot have a default value, when the interface with FA is enabled, the implementer must manually create a Financial Operation Source and thereafter assign the application Id value to this parameter.
Is Lookup Tree for Asset ClassThis is a boolean parameter. If set to true the lookup functionality for Asset Class must be in a tree hierarchical structure or not. If set to false, otherwise.
Allow Only Lowest Level Institution Selection in Asset ItemThis is a boolean parameter 'false' by default, which determines if an Asset Item can be associated to a 'leaf' type Institution only (the lowest level in the institution hierarchy) or not.
Allow Only Lowest Level Region Selection in Asset ItemThis is a boolean parameter, 'false' by default and determines if a 'Region' associated to an Asset Item must be a 'leaf' type Region (lowest level in the Region tree) or not.
Allow Only Lowest Level Asset Class Tree Selection in Asset ItemThis is a boolean parameter, 'false' by default and determines if an 'Asset Class Tree' associated to an Asset Item must be a 'leaf' type Class Tree (lowest level in the Class tree) or not.
Validate Asset Transaction Asset Item Acquisition DateThis is a boolean parameter, 'true' by default which specifies if a validation on the Asset Transaction that ensures that an Asset Transaction cannot be posted in a date prior to the Asset Item 'Acquisition Date' is applicable or not.
Validate Asset Transaction Asset Item Already Depreciated In Future Fiscal PeriodsThis is a boolean parameter, 'true' by default and specifies if a validation in the Asset Transaction that ensures that depreciation cannot occur in a fiscal period prior to a fiscal period already depreciated, e.g. fiscal period March cannot apply if April has been already depreciated.

Social Security Management

Other Parameters

Maximum Salary Subject to ContributionThis parameter will handle the Maximum Salary subject to contributions for Contribution Payroll
Notification to User AdminThis parameter will direct to what user acting as User Admin an alert, notification or warning will be sent
Notification to Contribution Management AnalystThis parameter will direct to what user acting as Contribution Management Analyst an alert, notification or warning will be sent
Is Mandatory to attach documentation on terminationThis parameter will handle the need to attach or not at least one document as support documentation on member assignment termination.

 

Procurement

Id Generation

NameDescriptionValue TypeDefault Value
Generate Bid Evaluation Criteria Id?It defines if Bid Evaluation Criteria Id will be generated by the system or manually enter by the user.
If it value is TRUE the system will automatically assign a next number to the Bid Evaluation Criteria Id.
If it is FALSE it will allow an alphanumeric manual entry in the Bid Evaluation Criteria Id field.
Boolean or Null True
 Generate Claim Reason Type Id?It defines if Claim Reason Type Id will be generated by the system or manually enter by the user.
If it value is TRUE the system will automatically assign a next number to the Claim Reason Type Id.
If it is FALSE it will allow an alphanumeric manual entry in theClaim Reason Type Id field.
 Boolean or Null True
 Generate Process Id?It defines if Process Id will be generated by the system or manually enter by the user.
If it value is TRUE the system will automatically assign a next number to the Process Id.
If it is FALSE it will allow an alphanumeric manual entry in the Process Id field.
 Boolean or Null True
 Generate Process Type Id? It defines if Process Type Id will be generated by the system or manually enter by the user.
If it value is TRUE the system will automatically assign a next number to the Process Type Id.
If it is FALSE it will allow an alphanumeric manual entry in the Process Type Id field.
 Boolean or Null True
Generate Document Id?It defines if Document Id will be generated by the system or manually enter by the user.
If it value is TRUE the system will automatically assign a next number to the Document Id.
If it is FALSE it will allow an alphanumeric manual entry in the Document Idfield.
 Boolean or Null True
 Generate Procurement Document Response Type Id? It defines if Procurement Document Response Type Id will be generated by the system or manually enter by the user.
If it value is TRUE the system will automatically assign a next number to the Procurement Document Response Type Id.
If it is FALSE it will allow an alphanumeric manual entry in the Procurement Document Response Type Id field.
 Boolean or Null True
Performance Rating Id Limit It represents the maximum value the system must allow to enter in Performance Rating Id field.Long or Null 999
 Generate Performance Evaluation Id? It defines if Performance Evaluation Id will be generated by the system or manually enter by the user.
If it value is TRUE the system will automatically assign a next number to the Performance Evaluation Id.
If it is FALSE it will allow an alphanumeric manual entry in the Performance Evaluation Id field.
 Boolean or Null True
 Generate Vendor Validation Rule Id? It defines if Vendor Validation Rule Id will be generated by the system or manually enter by the user.
If it value is TRUE the system will automatically assign a next number to the Vendor Validation Rule Id.
If it is FALSE it will allow an alphanumeric manual entry in the Vendor Validation Rule Id field.
 Boolean or Null True
Generate Vendor Catalogue Item Id? It defines if Vendor Catalogue Item Id will be generated by the system or manually enter by the user.
If it value is TRUE the system will automatically assign a next number to the Vendor Catalogue Item Id.
If it is FALSE it will allow an alphanumeric manual entry in the Vendor Catalogue Item Id field.
 Boolean or Null True

Other Parameters

NameDescriptionValue TypeDefault Value
 Apply Reference Price In Process?If this value is TRUE, then you could enter the price of reference related to the procurement process. If this parameter is FALSE, then the system do not show/request the Price of Reference attribute. Boolean or Null True
 Apply Unit of Measure Conversion? This parameter indicates if Unit of Measure conversion will be performed automatically by the system when creating a Vendor Catalogue Item. Boolean or Null True
 Only Requisition Items from Purchasing Allowed? It defines if according to the organization policies, only Requisitions Items from Purchasing can be added in the Procurement Document. Boolean or Null True
 Allowed Classification Levels Indicates the number of levels in the Catalogue Item Classification that will be used in your organization. Integer 2
 Allowed Classification Characters It represents the maximum number of characters that can be defined in each level of the Catalogue Item structure or classification. Integer 5
 Maximum Vendor Rating Value It is an integer value, which represents the maximum number of elements the system must allow to enter as part of the Vendor Performance Rating entity, such number will be used to calculate the overall average of the Vendor Performance Rating. Integer 5
 Validate Document Response Time?If Purchasing vehicle entity has a value in attribute ‘Purchasing Vehicle RFP Period for Responses’, the system validates that such period (number of days) of time is respected within the range: Procurement Document Publishing Date and Procurement Document Expected Response Date. Boolean or NullTrue 
 Validity End Notification (Days)It is the number of days to send automatic notifications to the Bid Manager before the Validity Date has been reached. Integer 5
 Mandatory Attachments in Response?If True, the system will require an attachment when creating a Procurement Document Response Detail. Boolean False
 Default Price Condition for BidsIt defines the price condition that will be used by default in the procurement documents.   Such value must be selected from the entity Price Conditions. Integer 1
 Intend To Award Period This parameter is a period expressed in calendar days, which must be used for calculation of the ‘Intend to Award Closing Date’ for Procurement Document Types that require the ‘Intend to Award & Dispute Management’ stage. This parameter applies only if the ‘Intend to Award Period’ attribute in the ‘Procurement Document Type’ entity is not specified. Integer or Null 2
 Maximum Days To Resolve a ClaimThis parameter refers to the maximum number of days available to respond to the bidder’s claim by the public service. Integer or Null 2
 Days Left Alert for Claim Resolution Expiration DateIt is the number of days to send automatic notifications to the Bid Manager before the Claim Resolution Expiration Date has been reached. Integer or Null 2
Bidder Accepting or Rejecting the Contract AwardThis parameter allows to Bidder to choose between accept or reject to the terms of the intention of contract award or just accept them. The two possible values are: 'Bidder accept' and 'Bidder choose'. String Bidder Accept
Maximum Days to Present Additional InformationThis parameter value is the maximum days that the Claim Resolution Committee can wait in order to continue with the Claim Resolution Process, when additional information is required the Expiration Date to Resolve Claim must be calculated based on the Last Response Date submitted by the Vendor. Integer or Null 2
Number Of Bids Calculation Type This parameter defines what attribute will be taken in consideration for Minimum Number of Bid calculation. Options: Minimum Score, Responses Received, Technical Evaluation String Responses Received
Allow ineligible Vendors in Bid EvaluationThis parameter defines according to the organization policies, if ineligible vendors will be accepted or not for Bid Evaluation and Vendor Award. Boolean True
 Mandatory Justification for Technical Evaluation Score?If 'True' the system will require a value on attribute 'Evaluation Score Justification'. If 'False' the system will not require it. Boolean False
Notify Days Before Bid Security Valid DateIt is the number of days to send automatic notifications to the Bid Manager before the Bid Security Valid Until Date has been reached. Integer 0
File name prefix for VendorCatalogueItem CSV file while uploadingThis parameter is used to create the names of the upload CSV files generated by the Buyers. String FB-Vendor-Catalogue-Item
Notification Subject on Questions Approval
Value in this parameter represents the default subject that the system uses to create automatic notifications to Vendors and Other Stakeholders in a Procurement Process, after  Questions & Answers Document has been approved.StringQuestions & Answers Document has been updated
Notification description on Questions ApprovalValue in this parameter represents the default description that the system uses to create automatic notifications to Vendors and Other Stakeholders in a Procurement Process, after Questions & Answers Document has been approved.StringPlease find attached Questions & Answers Document recently updated.
Procurement Document Subject on Questions ApprovalValue in this parameter represents the default subject that the system uses to publish  Questions & Answers Document to E-Procurement Site after it has been approved.StringQuestions & Answers Document has been updated
Procurement Document description on Questions ApprovalValue in this parameter represents the default description that the system uses to publish  Questions & Answers Document to E-Procurement Site after it has been approved.StringPlease find attached Questions & Answers Document recently updated.
File name prefix for Amendment PDF fileValue in this parameter defines a standard prefix that the system will use when creating a PDF Amendment Document. This prefix is followed by a consecutive number.StringFB-Amendment
Validate Period Of Time For The Vendors To Present Proposals BooleanTrue
Notification Subject on Procurement ClaimDefault subject to be used in system automatic Procurement Claim notificationsStringProcurement Claim updated
Notification Description on Procurement ClaimDefault description to be used in system automatic Procurement Claim notificationsStringPlease review the Procurement Claim updated recently
Notification Subject on AmendmentDefault subject to be used in system automatic Amendment notificationsStringAmendment Document updated
Notification Description on AmendmentDefault description to be used in system automatic Amendment notificationsStringPlease review the Amendment Document updated recently
Procurement Purchase Order Subject On ApprovalDefault subject to be used in system automatic Procurement Purchase Order notificationsStringProcurement Purchase Order has been updated
Procurement Purchase Order Description On ApprovalDefault description to be used in system automatic Procurement Purchase Order notificationsStringProcurement Purchase Order recently updated
Claim Resolution Description On ApprovalDefault description to be used in system automatic Claim Resolution notificationsStringPlease review the Claim Resolution updated recently
Claim Resolution Subject On ApprovalDefault subject to be used in system automatic Claim Resolution notificationsStringClaim Resolution updated

 

Base Entities

ID Generation Parameters

NameDescriptionValue TypeDefault Value
Generate Catalogue Item Id?It defines if Catalogue Items ID will be generated by the system or manually enter by the user.
If it value is TRUE the system will automatically assign a next number to the Catalogue Item ID.
If it is FALSE it will allow an alphanumeric manual entry in the Catalogue Item ID field.
Boolean or NullTRUE
Generate Institution Id?It defines if Institution ID will be generated by the system or manually enter by the user.
If it value is TRUE the system will automatically assign a next number to the Institution ID.
If it is FALSE it will allow an alphanumeric manual entry in the Institution ID field.
Boolean or NullFALSE
Generate Vendor Set Aside Id?It defines if Vendor Set Aside Id will be generated by the system or manually enter by the user.
If it value is TRUE the system will automatically assign a next number to the Vendor Set Aside Id.
If it is FALSE it will allow an alphanumeric manual entry in the Vendor Set Aside Idfield.
Boolean or NullFALSE
Generate Business Type Id(Vendor)?It defines if Business Type Id will be generated by the system or manually enter by the user.
If it value is TRUE the system will automatically assign a next number to the Business Type Id.
If it is FALSE it will allow an alphanumeric manual entry in the Business Type Id field.
Boolean or NullTRUE
Generate Business Ownership Type Id?It defines if Business Ownership Type Id will be generated by the system or manually enter by the user.
If it value is TRUE the system will automatically assign a next number to the Business Ownership Type Id.
If it is FALSE it will allow an alphanumeric manual entry in the Business Ownership Type Id field.
Boolean or Null FALSE
Business Ownership Type Id LimitIt defines maximum size for Business Ownership Type Id field.Long or Null 99
Generate Spoken Language Id?It defines if Spoken Language Id will be generated by the system or manually enter by the user.
If it value is TRUE the system will automatically assign a next number to the World Language Id.
If it is FALSE it will allow an alphanumeric manual entry in the Spoken Language Id field.
Boolean or Null TRUE
Generate Marital Status Id?It defines if Marital Status Id will be generated by the system or manually enter by the user.
If it value is TRUE the system will automatically assign a next number to the Marital Status Id.
If it is FALSE it will allow an alphanumeric manual entry in the Marital Status Id field.
Boolean or Null  TRUE
Generate Employee Application ID?It defines if Employee Application ID will be generated by the system or manually enter by the user.
If it value is TRUE the system will automatically assign a next number to the Employee Application ID.
If it is FALSE it will allow an alphanumeric manual entry in the Employee Application ID field.
Boolean or Null  TRUE 
Generate Financial Operation Source Application IDIt defines if Financial Operation Source Application ID will be generated by the system or manually enter by the user.
If it value is TRUE the system will automatically assign a next number to the Financial Operation Source Application ID.
If it is FALSE it will allow an alphanumeric manual entry in the Financial Operation Source Application ID field.
Boolean or NullTrue
Generate Payment Location Id?It defines if Payment Location Id will be generated by the system or manually enter by the user.
If it value is TRUE the system will automatically assign a next number to the Payment Location Id.
If it is FALSE it will allow an alphanumeric manual entry in the Payment Location Id field.
Boolean or NullTrue
Generate Payment Mode Id?It defines if Payment Mode Id will be generated by the system or manually enter by the user.
If it value is TRUE the system will automatically assign a next number to the Payment Mode Id.
If it is FALSE it will allow an alphanumeric manual entry in the Payment Mode Id field.
Boolean or NullTrue
Generate Content Category Id?It defines if Content Category Id will be generated by the system or manually enter by the user.
If it value is TRUE the system will automatically assign a next number to the Content Category Id.
If it is FALSE it will allow an alphanumeric manual entry in the Content Category Id field.
Boolean or NullTrue
Generate Customer Id?It defines if Customer Id will be generated by the system or manually enter by the user.
If it value is TRUE the system will automatically assign a next number to the Customer Id.
If it is FALSE it will allow an alphanumeric manual entry in the Customer Id field.
Boolean or NullTrue
Generate Performance Rating Id?It defines if Performance Rating Id will be generated by the system or manually enter by the user.
If it value is TRUE the system will automatically assign a next number to the Performance Rating Id.
If it is FALSE it will allow an alphanumeric manual entry in the Performance Rating Id field.
Boolean or NullTrue
Generate Country Time Zone Id?It defines if Country Time Zone Id will be generated by the system or manually enter by the user.
If it value is TRUE the system will automatically assign a next number to the Country Time Zone Id.
If it is FALSE it will allow an alphanumeric manual entry in the Country Time Zone Id field.
Boolean or NullTrue
Generate Content Application IDIt defines if Content Application ID will be generated by the system or manually enter by the user.
If it value is TRUE the system will automatically assign a next number to the Content Application ID.
If it is FALSE it will allow an alphanumeric manual entry in the Content Application ID field.
Boolean or NullTrue
Generate Customer Type Application IDIt defines if Customer Type Application ID will be generated by the system or manually enter by the user.
If it value is TRUE the system will automatically assign a next number to the Customer Type Application ID.
If it is FALSE it will allow an alphanumeric manual entry in the Customer Type Application ID field.
Boolean or NullTrue

Other Parameters

 

NameDescriptionValue TypeDefault Value
Catalogue Applies?It defines if the organization will use Catalogue Item functionality.Boolean or Null   TRUE 
Apply Category to Catalogue Items?It defines if the organization will require an Item Category when creating a Catalogue Item. In case this Parameter is TRUE an Item Category must be previously defined.
If TRUE the system will require Item Category attribute Mandatory when creating a Catalogue Item.
If FALSE the Item Category attribute will not be required when creating a Catalogue Item 
Boolean or Null   TRUE 
Purchasing Vehicle Custom Domain TypeCustom domain Code to be used when creating a Purchasing Vehicle Custom Domain TypeStringpurchaseVehicle
Vendor Custom Domain TypeCustom domain Code to be used when creating a Vendor Custom Domain TypeStringVENDOR
Institution Custom Domain TypeCustom domain Code to be used when creating a Vendor Custom Domain TypeStringINSTITUTION
Maximum Length for Offset Code IdIt defines the maximum lenght for the Offset code. The system validates such length when creating Offset Codes.Integer 4
Allow Costing Method For Item Class And InventoryIf TRUE the user could assign a value different than the one specified in Parameter 'Default Inventory Costing Method' for the following fields: ‘Item Class Costing Method’ and ‘Inventory Item Costing Method’ BooleanFALSE
Accept Multi Currency TransactionsIf TRUE the organization will use multi-currency transactions. If the user switches it to FALSE, then the system will not allow any functionality related to multi-currency. BooleanTRUE 
User can change Exchange Rate ValueIf TRUE the system will still post the default exchange rate for the foreign currency selected, but it will allow the user to modify such default exchange rate in individual transactions.BooleanFALSE 
Apply Different Rates for Revenues and Expenses If TRUE then system will request two exchange rates per day (one for revenue transactions and one for expenditure transactions).   If FALSE, then system will request only one exchange rate and it will be applied in both transaction types. BooleanFALSE
Alpha Numeric Employee Application IDIf 'Generate Employee Application ID?' parameter is set to TRUE, then this parameter determines if alphanumeric or only numeric values can be entered. Boolean or Null  TRUE
Alpha Numeric Employee Social NumberThis parameter determines if alphanumeric or only numeric values can be entered for Employee Social Number. Boolean or Null  FALSE 
Alpha Numeric Bank Account NumberThis parameter determines if alphanumeric or only numeric values can be entered for Bank Account Number. Boolean or Null  TRUE
Bank Account Number Maximum LengthIt defines the maximum lenght for Bank Account field (used in Employee Payment Information).Integer50
Bank Account Number Minimum LengthIt defines the minimum lenght for Bank Account field (used in Employee Payment Information).Integer0
Bank Acccount Iban Maximum LengthIt defines the maximum lenght for Iban field (used in Employee Payment Information).Integer50
Bank Acccount National Transfer Code Maximum LengthIt defines the maximum lenght for National Transfer Code field (used in Employee Payment Information).Integer50
Employee Custom Domain TypeCustom domain Code to be used when creating an Employee Custom Domain TypeStringEMPLOYEE
Allow Multiple Budget Preparation Groups
If value in this  parameter is 'true', the system will allow to have more than one Budget Preparation Group per COA ID.
If 'false' the system will only allow to have one Budget Preparation Group per COA ID.
 
BooleanFalse
Region Mandatory in Institution?If TRUE, Region field will be mandatory when creating an Institution. If the user switches it to FALSE, then the system will not require Region field when creating an Institution.BooleanTrue
Institution Type Mandatory in Institution?If TRUE, Institution Type field will be mandatory when creating an Institution. If the user switches it to FALSE, then the system will not require Institution Type field when creating an Institution.BooleanTrue
Allow to use other institutions?

It will be TRUE when the government will handle procurement process for more than one Institution. (For  centralized procurement process)

It will be FALSE, if each ministry handles only their own process.

In this case Institution information will be defaulted by the system when required.

BooleanFalse
Allow COA Planning And Execution For Active Fiscal Year

If 'True' the system will allow the user to select a different COA for the Fiscal Year (in Admin>Chart of Accounts>Charts of Accounts option), this means that 1 COA may have 'Budget Preparation' checkbox on and a different COA may have 'Budget Execution' checkbox on, still the user may select same COA structure with  'Budget Preparation' and 'Budget Execution' checkbox on.

If 'False' the system will not allow the user to select a different COA for the Fiscal Year (in Admin>Chart of Accounts>Charts of Accounts option), this means that the user must select the same COA structure with 'Budget Preparation' and 'Budget Execution' checkbox on, if the user tries to select different COA for 'Budget Preparation' and 'Budget Execution' the system will display the following message:

'Different COA for Planning and Execution for the Active Fiscal Year is not allowed'.

In both cases (True or False), when there is already an active COA for the Active Fiscal Year defined for 'Budget Preparation' and/or 'Budget Execution' and the user tries to set another COA as active for the Active Fiscal Year (for either one that is already active  'Budget Preparation' and/or 'Budget Execution') the system will display the following message depending on each case:

'There is already an Active COA for 'Budget Preparation' for Fiscal Year XXXX ( Fiscal Year Code)

'There is already an Active COA for 'Budget Execution' for Fiscal Year XXXX ( Fiscal Year Code)

'There is already an Active COA for 'Budget Preparation'and 'Budget Execution' for Fiscal Year XXXX ( Fiscal Year Code)

BooleanFalse
Organization Segment Mandatory?If TRUE, Organization Segment will be mandatory when creating a Chart of Accounts. If the user switches it to FALSE, then the system will not require Organization Segment when creating a Chart of Accounts.BooleanTrue
Swift Code Mandatory In Financial InstitutionIf TRUE, Swift Code will be mandatory when creating a Financial Institution. If the user switches it to FALSE, then the system will not require Swift Code when creating a Financial Institution.BooleanFalse

User Interface Parameters

NameDescriptionValue TypeDefault Value
Country Code Maximum LenghtIt defines the maximum lenght for Country Code. The system validates such length when creating Countries.Integer3
Vendor Set Aside Id Maximum LenghtIt defines the maximum lenght for the Vendor Set Aside Id. The system validates such length when creating Vendor Set Asides.Integer3
Business Ownership Type Id Maximum LenghtIt defines the maximum lenght for the Business Ownership Type Id. The system validates such length when creating Business Ownership Types.Integer20
Unit Of Measure Id Maximum LengthIt defines the maximum lenght for the Unit Of Measure Id. The system validates such length when creating a Unit Of Measure.Integer10

 


 

Global

Global

 

NameDescriptionValue TypeDefault Value
LocationThis parameter defines the Financial Accountability location.  Integer1
Default LanguageIt defines the language that the system will prompt by default. The user can select one value available from the 'Application Languages' entries.Stringen
Fiscal Year FormatIt defines the format when creating Fiscal Year.String 
Characters not allowed in input fieldsIn this parameter you can specify characters that system users will not be able to use in alphanumeric fields.String 
Allow Sending Email?This parameter defines if e-mails can be sent from the system.Boolean or NullFALSE
Number Of Results Displayed Per PageYou can specify the number of registers that will be displayed in search screens.Integer5

 

Accounts and Passwords

 

NameDescriptionValue TypeDefault Value
Idle Accounts Life Span (Days)This value is the number of days where if a user shows no logins such user is automatically set to inactive.   Integer or Null60
Requires Numeric Character?It defines if the user's password requires a numeric characterBoolean or NullNull
Minimum Number of CharactersIt defines user's password minimum Number of CharactersInteger or Null 
Password Life Span (Days)This value is the number of days that a password will be valid. When life span has been reach the system prompts for a new password.   Integer or Null30
Number of Retained PasswordsValue in this parameter represents the number of previous passwords that the system will validate that are not duplicated when entering a new password.Integer5
Requires Special Character?It defines if the user's password requires a special characterBoolean or NullNull
Maximum number of login attemptsIf the user has reached the number of consecutively failed Logins that as defined in this parameter, the system will automatically cancel the user password.Integer or NullNull
Reset passwordIf password reset method is set as 'Default Password', when a new user is created or a password is reset, the system automatically allocates the password that is defined in this parameter. The user will be forced to change the password upon next login.String123465
Reset password method

 

The FreeBalance Accountability Platform supports three different methods to manage password generation and distribution as per this parameter by selecting one of the three following options:

  • Use Default Password
  • Use Generated Password
  • Use Admin Selected Password

Use Default Password
When a new user is created or a password is reset, the system automatically allocates the password that is defined in the parameter “Reset Password”. In both cases the user will be forced to change the default password upon the next login.

Use Generated Password
When a new user is created or a password is reset, the system automatically allocates a password that is generated according to the definitions set in the parameters “Minimum Number of Characters”, “Requires Numeric Character” and “Requires Special Character”.  The generated password in emailed to the user. If the user does not have a valid email address this operation cannot be finalized.  Upon the next user login the system will force the user to modify the new password if the value of the parameter “Requires to Change Password after Login on Generated Passwords” is set to true.

Use Admin Selected Password
When a new user is created or a password is reset, the Administrator will be required to enter a new password for the user. This password will be validated according to the definitions set in the parameters “Minimum Number of Characters”, “Requires Numeric Character” and “Requires Special Character”.  The Administrator will have the possibility to email the new password to the user by selecting the appropriate check box in the user interface. If the user does not have a valid email address the new password will be allocated to the user but the email will not be sent.  The user will be forced to change the now allocated password upon the next login.

StringUSE_ADMIN_SELECTED_PASSWORD
Requires to change password after login on generated passwords?If a user password is reset using the password reset method 'Use Generated Password', the system will force the user to modify the new password upon the next user login if the value of this parameter is set to true.BooleanFalse
Allow derived passwords from username?If this parameter is set to false, the username cannot be used as part of password valueBooleanFalse
Rechallenge Password Enabled?If this parameter is set to true, the system will require password retyping according to Password Rechallenge ConfigurationBooleanTrue

 

Web Services

 

NameDescriptionValue TypeDefault Value
Base URL It indicates the root URL where synchronization web services are located (this depends where FA application was installed )String 
Web Services UserIt indicates which user should the aplication use when working with web services. This way it’s possible to see all data manipulated by web services.
 
Stringfb

 

Web Services Defaults

 

NameDescriptionValue TypeDefault Value
Web Services Default Country

 It indicates the country used by web services, when  that information is not available from remote application on synchronization process. For instance on Vendor synchronization, where FA hasn’t this information.

StringENG
Web services password encryption cipher

 Password encryption is the process of transforming plain text information using an algorithm (called cipher) to make the password unreadable to anyone except those possessing special knowledge usually a key.

StringA1B2C3D4E5F6G7H8
Default synchronization functional class

If there is a value in this parameter the system will use it as a default functional class  when synchronizing users

The system displays a drop down list with all functional classes available.

String or NullNull
Default synchronization vendor languageValue in this parameter is used as a default language when synchronizing vendorsStringDefaulted from the mandatory application language
User Synchronization Default Restricted User Ids Stringfb
Cash Sales Default Web Service Version

Defines the Cash Sales Web Service version to be executed.

Options are: Version 6.3 Version 6.5

StringSIXPOINTTHREE
Web Services Time Out (Milliseconds)Limit time in milliseconds after which the system will throw a time out error during web services execution, whenever there is not a response from the Web ServiceLong300000

 

Authentication

 

NameDescriptionValue TypeDefault Value
Authentication Type

It indicates the type of used authentication. In LOCAL authentication, user accounts are stored on same database as application. LDAP authentication user accounts are retrieved from an LDAP server. And  TRUSTED authentication type is a way that user authentication is guaranteed by operation system ( just in Windows).

String LOCAL
Trusted Domains Is the list of domains trusted for authentication when authentication type is set to TRUSTEDString 

 

SMTP Configuration

 

NameDescriptionValue TypeDefault Value
Hostname The hostname of IP address of SMTP server.String 
PortThe port number that SMTP server is listening.Integer25
Authentication RequiredIt indicates if SMTP server requires authentication.BooleanTrue
UsernameIt indicates the SMTP server user.String 
Password It indicates the SMTP server password.
 
String 
Default Vanity E-Mail Address

The default email to show when sending an email itcan be different from your real email.

String 
Default From E-Mail AddressThe default email address to use on from field.
 
String 
Default To E-Mail AddressThe default recipient email address to use.
 
String 
TLS EncryptionIf the organisation uses TLS Encryption to connect to SMTP server, this parameter must be set to True.BooleanTrue
SSL ConnectionIf the organisation uses SSL connection to connect to SMTP server, this parameter must be set to True.BooleanTrue

Licensing Configuration

 

NameDescriptionValue TypeDefault Value
Licenses File FolderIt indicates the folder location where license files are sotred. This folder should be accessible from application server. String/gov-licenses/
License Notification Email Addresses

It indicates the email address to use when license is configured to send an email when a user exceeds available licenses.

String 
License Notification Emails LanguageIt indicates the language to use on email message set on license exceed.
 
Stringen

 

Help Configuration

 

NameDescriptionValue TypeDefault Value
Form Help Base URLIt indicates the root URL of help systemString 
Help Root PageIt indicates the root page of help (Form Help Base URL + Help Root Page) should be a valid and reachable URLStringhome

 

Data Type Configuration

 

NameDescriptionValue TypeDefault Value
Main Date PatternThe main date format to use on date values. Stringd/M/yyyy
Secondary Date PatternThe secondary date format to use on date values Stringyyyy/M/d
Main Date Time PatternThe main datetime format to use on datetime values.Stringd/M/yyyy hh:mm:ss
Secondary Date Time PatternThe secondary datetime format to use on datetime values Stringyyyy/M/d hh:mm:ss
Time FormatThe time format to use on time values. Stringhh:mm:ss
Grouping And Decimal Separators

Available options are:

Blank as grouping separator and comma as decimal separator

Blank as grouping separator and dot as decimal separator

Comma as grouping separator and dot as decimal separator

Dot as grouping separator and comma  as decimal separator

No grouping and comma  as decimal separator

No grouping and dot  as decimal separator

StringBLANK_AND_DOT

 

Synchronization Settings

 

NameDescriptionValue TypeDefault Value
JMS Domain Synchronization

 Indicates if JMS synchronization (FA synchronization) is active.

BooleanFalse

 

Audit Settings

 

NameDescriptionValue TypeDefault Value
Audit Enabled?

 This parameter defines if Audit functionality is Active.

If TRUE the system will create entries in Audit Entry entity, according to Audit Settings definitions.

If FALSE, the system will not create such entries.

BooleanFalse
Login Audit Enabled?This parameter defines if Login Audit functionality is Active.

If TRUE the system will create entries in Login Audit entity.

If FALSE, the system will not create such entries.
BooleanFalse
Enable Default Audit Settings?This parameter defines if Default Audit Settings is Active.

If TRUE the system will use default Audit Settings.

If FALSE, the system will not use such defaults.
BooleanFalse

Users

 

NameDescriptionValue TypeDefault Value
Is functional class mandatory?This parameter defines if functional class is required when creating a User.

If TRUE the system will require a Functional Class when creating a user.

If FALSE, the system will not require  such field.
BooleanFalse
Use delegated security validation?If this parameter is set to true, the User can only allocate to
other Users a set of Functional Classes that result in the same or a subset of their own allowed features.
BooleanFalse

Customer Settings

 

NameDescriptionValue TypeDefault Value
Organization Logo

It is the customer image file name, which will be displayed at the top of the FreeBalance Accountability Login screen.

This file must exists in folder \tomcat_instalation\webapps\gov-web\images

String 


 

Framework

Framework

 

Name Description Value Type Default Value
Is Region Mandatory in Address?  This parameter defines if Region field will be mandatory when entering Address information. Boolean or Null True
Is Zip Code Mandatory in Address?  This parameter defines if Zip Code field will be mandatory when entering Address information. Boolean True
Allow Blanks In Zip Code? This parameter defines if blank spaces will be allowed when entering Zip Code information. Boolean True
Allow SpecialCharacters In Zip Code? This parameter defines if special characters will be allowed when entering Zip Code information. Boolean True


 

Human Resources

ID Generation

NameDescription
Starting Number for Employee IDThis value is system generated. This is the starting value of the first employee that will be entered into the system. The first number will be 000000000000001
Generate Certificate IDThis is a setup parameter to determine if the code in the certificate catalogue is entered by a user or system generated. When set to false, this value will be manually entered by the user. If set to true, this value will be generated by the system and it will be left padded with zeros
Generate Work Location IDThis is a setup parameter to determine if the code in the work location catalogue is entered by a user or system generated. When set to false, this value will be manually entered by the user. If set to true, this value will be generated by the system and it will be left padded with zeros
Generate Education IDThis is a setup parameter to determine if the code in the education catalogue is entered by a user or system generated. When set to false, this value will be manually entered by the user. If set to true, this value will be generated by the system and it will be left padded with zeros
Generate Skill IDThis is a setup parameter to determine if the code in the skill catalogue is entered by a user or system generated. When set to false, this value will be manually entered by the user. If set to true, this value will be generated by the system and it will be left padded with zeros
Generate Association IDThis is a setup parameter to determine if the code in the association catalogue is entered by a user or system generated. When set to false, this value will be manually entered by the user. If set to true, this value will be generated by the system and it will be left padded with zeros
Generate School IDThis is a setup parameter to determine if the code in the school catalogue is entered by a user or system generated. When set to false, this value will be manually entered by the user. If set to true, this value will be generated by the system and it will be left padded with zeros
Generate Degree IDThis is a setup parameter to determine if the code in the degree catalogue is entered by a user or system generated. When set to false, this value will be manually entered by the user. If set to true, this value will be generated by the system and it will be left padded with zeros
Generate Pay Agent IDThis is a setup parameter to determine if the code in the pay agent catalogue is entered by a user or system generated. When set to false, this value will be manually entered by the user. If set to true, this value will be generated by the system and it will be left padded with zeros
Generate Departure Reason IDThis is a setup parameter to determine if the code in the departure reason catalogue is entered by a user or system generated. When set to false, this value will be manually entered by the user. If set to true, this value will be generated by the system and it will be left padded with zeros
Generate Association Type IDThis is a setup parameter to determine if the code in the association type catalogue is entered by a user or system generated. When set to false, this value will be manually entered by the user. If set to true, this value will be generated by the system and it will be left padded with zeros
Generate Major Field IDThis is a setup parameter to determine if the code in the major field catalogue is entered by a user or system generated. When set to false, this value will be manually entered by the user. If set to true, this value will be generated by the system and it will be left padded with zeros
Generate Medical Form IDThis is a setup parameter to determine if the code in the medical form catalogue is entered by a user or system generated. When set to false, this value will be manually entered by the user. If set to true, this value will be generated by the system and it will be left padded with zeros
Generate Position Category IDThis is a setup parameter to determine if the code in the position category catalogue is entered by a user or system generated. When set to false, this value will be manually entered by the user. If set to true, this value will be generated by the system and it will be left padded with zeros
Generate Task IDThis is a setup parameter to determine if the code in the task catalogue is entered by a user or system generated. When set to false, this value will be manually entered by the user. If set to true, this value will be generated by the system and it will be left padded with zeros
Generate Leave Type IDThis is a setup parameter to determine if the code in the leave type catalogue is entered by a user or system generated. When set to false, this value will be manually entered by the user. If set to true, this value will be generated by the system and it will be left padded with zeros
Generate Leave Request IDThis is a setup parameter to determine if the code in the leave request is entered by a user or system generated. When set to false, this value will be manually entered by the user. If set to true, this value will be generated by the system and it will be left padded with zeros
Generate Situation IDThis is a setup parameter to determine if the code in the situation catalogue is entered by a user or system generated. When set to false, this value will be manually entered by the user. If set to true, this value will be generated by the system and it will be left padded with zeros
Generate Generic Position IDThis is a setup parameter to determine if the code in the generic position catalogue is entered by a user or system generated. When set to false, this value will be manually entered by the user. If set to true, this value will be generated by the system and it will be left padded with zeros
Generate Employee Position IDThis is a setup parameter to determine if the code in the employee position catalogue is entered by a user or system generated. When set to false, this value will be manually entered by the user. If set to true, this value will be generated by the system and it will be left padded with zeros
Generate Accumulated Benefit IDThis is a setup parameter to determine if the code in the accumulated benefit catalogue is entered by a user or system generated. When set to false, this value will be manually entered by the user. If set to true, this value will be generated by the system and it will be left padded with zeros
Generate Cost Item Reason IDThis is a setup parameter to determine if the code in the cost item reason catalogue is entered by a user or system generated. When set to false, this value will be manually entered by the user. If set to true, this value will be generated by the system and it will be left padded with zeros
Generate Training Course Type IDThis is a setup parameter to determine if the code in the training course type catalogue is entered by a user or system generated. When set to false, this value will be manually entered by the user. If set to true, this value will be generated by the system and it will be left padded with zeros
Generate Training Course Catalogue IDThis is a setup parameter to determine if the code in the training course catalogue is entered by a user or system generated. When set to false, this value will be manually entered by the user. If set to true, this value will be generated by the system and it will be left padded with zeros
Generate Training Course Provider IDThis is a setup parameter to determine if the code in the training course provider catalogue is entered by a user or system generated. When set to false, this value will be manually entered by the user. If set to true, this value will be generated by the system and it will be left padded with zeros
Generate Deduction IDThis is a setup parameter to determine if the code in the deduction catalogue is entered by a user or system generated. When set to false, this value will be manually entered by the user. If set to true, this value will be generated by the system and it will be left padded with zeros
Generate Training Course Application IDThis is a setup parameter to determine if the code in the training course application is entered by a user or system generated. When set to false, this value will be manually entered by the user. If set to true, this value will be generated by the system and it will be left padded with zeros
Generate Training Course IDThis is a setup parameter to determine if the code in the training course catalogue is entered by a user or system generated. When set to false, this value will be manually entered by the user. If set to true, this value will be generated by the system and it will be left padded with zeros
Generate Training Feedback Criteria IDThis is a setup parameter to determine if the code in the training feedback criteria catalogue is entered by a user or system generated. When set to false, this value will be manually entered by the user. If set to true, this value will be generated by the system and it will be left padded with zeros
Generate Training Feedback Template IDThis is a setup parameter to determine if the code in the training feedback template catalogue is entered by a user or system generated. When set to false, this value will be manually entered by the user. If set to true, this value will be generated by the system and it will be left padded with zeros 
Generate Training Feedback Criteria Group IDThis is a setup parameter to determine if the code in the training feedback criteria group catalogue is entered by a user or system generated. When set to false, this value will be manually entered by the user. If set to true, this value will be generated by the system and it will be left padded with zeros
Generate Performance Appraisal Criteria Group IDThis is a setup parameter to determine if the code in the performance appraisal criteria group catalogue is entered by a user or system generated. When set to false, this value will be manually entered by the user. If set to true, this value will be generated by the system and it will be left padded with zeros
Generate Performance Appraisal Feedback Criteria IDThis is a setup parameter to determine if the code in the performance appraisal feedback criteria catalogue is entered by a user or system generated. When set to false, this value will be manually entered by the user. If set to true, this value will be generated by the system and it will be left padded with zeros
Generate Performance Appraisal Score Rate IDThis is a setup parameter to determine if the code in the performance appraisal score rate catalogue is entered by a user or system generated. When set to false, this value will be manually entered by the user. If set to true, this value will be generated by the system and it will be left padded with zeros
Generate Performance Appraisal Score Rate Scale IDThis is a setup parameter to determine if the code in the performance appraisal score rate scale catalogue is entered by a user or system generated. When set to false, this value will be manually entered by the user. If set to true, this value will be generated by the system and it will be left padded with zeros
Generate Performance Appraisal Scoring Criteria IDThis is a setup parameter to determine if the code in the performance appraisal scoring criteria catalogue is entered by a user or system generated. When set to false, this value will be manually entered by the user. If set to true, this value will be generated by the system and it will be left padded with zeros
Generate Performance Appraisal Template IDThis is a setup parameter to determine if the code in the performance appraisal template catalogue is entered by a user or system generated. When set to false, this value will be manually entered by the user. If set to true, this value will be generated by the system and it will be left padded with zeros
Generate Performance Appraisal Schedule IDThis is a setup parameter to determine if the code in the performance appraisal schedule catalogue is entered by a user or system generated. When set to false, this value will be manually entered by the user. If set to true, this value will be generated by the system and it will be left padded with zeros
Generate Performance Appraisal Schedule Period IDThis is a setup parameter to determine if the code in the performance appraisal schedule period catalogue is entered by a user or system generated. When set to false, this value will be manually entered by the user. If set to true, this value will be generated by the system and it will be left padded with zeros
Generate Performance Appraisal Organization Control IDThis is a setup parameter to determine if the code in the performance appraisal organization control catalogue is entered by a user or system generated. When set to false, this value will be manually entered by the user. If set to true, this value will be generated by the system and it will be left padded with zeros
Generate Promotion Proposal IDThis is a setup parameter to determine if the code in the promotion proposal is entered by a user or system generated. When set to false, this value will be manually entered by the user. If set to true, this value will be generated by the system and it will be left padded with zeros
Generate Promotion Reason IDThis is a setup parameter to determine if the code in the promotion reason catalogue is entered by a user or system generated. When set to false, this value will be manually entered by the user. If set to true, this value will be generated by the system and it will be left padded with zeros
Generate Promotion Reviewer IDThis is a setup parameter to determine if the code in the promotion reviewer catalogue is entered by a user or system generated. When set to false, this value will be manually entered by the user. If set to true, this value will be generated by the system and it will be left padded with zeros
Generate Promotion Policy IDThis is a setup parameter to determine if the code in the promotion policy catalogue is entered by a user or system generated. When set to false, this value will be manually entered by the user. If set to true, this value will be generated by the system and it will be left padded with zeros
Generate Career Standing IDThis is a setup parameter to determine if the code in the career standing catalogue is entered by a user or system generated. When set to false, this value will be manually entered by the user. If set to true, this value will be generated by the system and it will be left padded with zeros
Generate Employee Career Path IDThis is a setup parameter to determine if the code in the employee career path catalogue is entered by a user or system generated. When set to false, this value will be manually entered by the user. If set to true, this value will be generated by the system and it will be left padded with zeros
Generate Succession Weight IDThis is a setup parameter to determine if the code in the succession weight catalogue is entered by a user or system generated. When set to false, this value will be manually entered by the user. If set to true, this value will be generated by the system and it will be left padded with zeros
Generate Succession Weight Component IDThis is a setup parameter to determine if the code in the succession weight catalogue is entered by a user or system generated. When set to false, this value will be manually entered by the user. If set to true, this value will be generated by the system and it will be left padded with zeros
Generate Tribe IDThis is a setup parameter to determine if the code in the tribe catalogue is entered by a user or system generated. When set to false, this value will be manually entered by the user. If set to true, this value will be generated by the system and it will be left padded with zeros
Generate Race IDThis is a setup parameter to determine if the code in the race catalogue is entered by a user or system generated. When set to false, this value will be manually entered by the user. If set to true, this value will be generated by the system and it will be left padded with zeros
Generate Religion IDThis is a setup parameter to determine if the code in the religion catalogue is entered by a user or system generated. When set to false, this value will be manually entered by the user. If set to true, this value will be generated by the system and it will be left padded with zeros
Generate Salary Transition IDThis is a setup parameter to determine if the code in the salary transition catalogue is entered by a user or system generated. When set to false, this value will be manually entered by the user. If set to true, this value will be generated by the system and it will be left padded with zeros
Generate Exit Interview IDThis is a setup parameter to determine if the code in the exit interview catalogue is entered by a user or system generated. When set to false, this value will be manually entered by the user. If set to true, this value will be generated by the system and it will be left padded with zeros
Generate Recruitment Requisition IDThis is a setup parameter to determine if the code in the recruitment requisition catalogue is entered by a user or system generated. When set to false, this value will be manually entered by the user. If set to true, this value will be generated by the system and it will be left padded with zeros
Generate Business Trip IDThis is a setup parameter to determine if the code in the business trip catalogue is entered by a user or system generated. When set to false, this value will be manually entered by the user. If set to true, this value will be generated by the system and it will be left padded with zeros

 

Other Parameters

NameDescription
Allow Direct Deposit in Multiple AccountWhen ‘Allow Direct deposit’ value is set to TRUE then the employee may have more than one payment information on the Manage Employee screen. By setting the value to FALSE this allows on direct deposit for an employee
Employee Position ID Numeric OnlyWhen the setup parameter ‘Employee Position Id Numeric Only’ value is TRUE this restricts the user to enter numeric values into the Employee Position ID field. When the Value is set to FALSE the user is able to enter a mix of alphabetic and numerical values into the Employee Position ID field
Base Salary Earning CodeThe setup parameter ‘Base Salary Earning Code’ deals directly with cost items. The value of the Base Salary Earning Code entered is the Cost Item Code. In this example below the value ‘BASESALARY’ entered refers to the Basic salary that is paid on each pay period
Overtime Earning CodeThe setup parameter ‘Overtime Earning Code’ deals directly with cost items. The VALUE of the Overtime Earning Code entered refers to the Cost Item Code. Values entered for Overtime Earning Code can be ‘OVERTIMECR’ or ‘OVERTIMETK.’ OVERTIMECR deals with employee entitlement for overtime hours and the OVERTIMETK deals with the cost item used when an employee is paid overtime
Allow Integration with HCAThis parameter is used to determine whether or not the application allows integration with the FreeBalance Human Capital Accountability (HCA) module
Maximum Concurrent Employee AssignmentThis is the maximum number of assignments which can be delegated to a specific employee during a specified period of time. For example, if the value is set to five (5), the workload needs to be split 20% for each assignment in order to make contributions to each assignment everyday. Deadlines for assignments will be adjusted accordingly by the project manager. For Uganda, this value should initially be set to one (1), so that 100% of an employee’s attention is focused on the first task delegated by the project manager
Mandatory Work LocationThis parameter defines whether the work location checkbox will appear in the employee position screen. If set to true, the checkbox will become available. If set to false, the checkbox will not be available
Social Number UniqueThis is a setup parameter that determines whether a unique social number is recorded in the application for specific employees
Business Start and End DateThis is a setup parameter that determines whether the business start and end date is used in the application
Generic Position ID Numeric OnlyThis parameter defines whether the generic position ID code can be entered as numerical only or any characters (letters and numbers). If set to true, it will be numeric only. If set to false, it will be any character (letters or numbers)
Generic Position Id Leading Alpha CharactersThis parameter defines whether the generic position ID code will lead off with specific alphabetical characters. For example, if the value is set to ABC, all generic position ID codes will lead off with ABC followed by the rest of the code. For this parameter to be in effect, the Generic Position ID Numeric Only parameter must be set to false
Number Of Decimals For Salary Scale StepThis parameter defines how many digits can be entered into the salary scale step. For example, eighteen (18) digits will be available, as well as two (2) decimal places (999,999,999,999,999,999.99)
Modify Automatic Cost ItemThis parameter defines whether the user will or will not be able to modify an automatic cost item. If set to true, the user will be able to modify the automatic cost item. If set to false, the user will not be able to modify the automatic cost item
Number of Days For Last Working DayThis parameter defines how many days until an employee’s last working day. This could be due to an employee giving in two weeks notice before resignation or the completion of a contractual agreement. For example, if the value is entered as three (3), the employee will work for three days until their last working day
Highest Situation Code Level Display OrderThis parameter determines the highest situation code level display order for the application. Generally, this parameter will be set to 4
Notify Automatic Deduction For EmployeeThere will be a central boolean Parameter for Automatic Deductions for sending notification, true by default, in the application, to indicate if the employee and user's superior should be notified when the user ends an automatic deduction
Time For Closing Training CourseThis parameter defines the amount of days it takes to close the training course which mainly includes the training feedback process. If the value is set to ten (10), it is expected to take ten days for the training course closing process to be completed. On average, it should take approximately ten days
Alert Course CreatorThis parameter determines whether or not the course creator will be alerted when the training course reaches full capacity. If set to true, the course creator will be alerted. If set to false, the course creator will not be alerted
Time For Advance Registration Of CourseSome training courses may be defined and set well into the future. This parameter indicates the allowed lead time in advance of the actual planned training course start date that an employee may register for a training course. If set to zero (0), there is no restriction and employees may register for the course at any time in advance
Default Value for Non Assessed CriteriaThis is a setup parameter which determines the default value for any non-assessed criteria. Generally, this value should be set to 100
Value for Standard Notification OffsetThis is a setup parameter which determines the value for a standard notification offset in days. Generally, this value should be set to 10 days
Value for Probation Notification OffsetThis is a setup parameter which determines the value for a probation notification offset in days. Generally, this value should be set to 30 days
Notify Appraiser When New PA is OpenedThis parameter will send out a notification to the appraiser when a new performance appraisal is opened if set to true. If set to false, the notification will not be sent out
Minimum Weight for Scoring CriteriaThis parameter defines the minimum weight value for the scoring criteria. This is based on a percentage basis (0%-100%). The minimum is the smallest possible value it can be
Maximum Weight for Scoring CriteriaThis parameter defines the maximum weight value for the scoring criteria. This is based on a percentage basis (0%-100%). The maximum is the largest possible value it can be
Is Information Came From Government?This is a setup parameter which determines whether or not information came from the government
Trainer Identification Lead TimeA training course can be set up without a trainer identified, up to a certain point. This parameter identifies the advance lead time that a scheduled training course can have a non-specified trainer before an alert is sent to the Training Manager. This value can be defined as any number that the user wishes. Recommended value would be two weeks (14 days) before the training course
Time For Sending Notification Message For Starting Of CourseThis parameter defines the number of days ahead of time that a trainee will receive a notification message about when the training course will commence. For example, if the value is set to seven (7), a notification will be sent out to the trainee seven days in advance of the start date of the training course. On average, it should take approximately seven days
Notification Message To Be Send For Starting Of Course?This parameter defines whether a trainee will receive a notification message about when the training course will commence. If set to true, the trainee will receive a notification. If set to false, the trainee will not receive a notification
Default Notification OffsetThis is a setup parameter which determines the value for a default notification offset in days. Generally, this value should be set to 10 days
Default Probation OffsetThis is a setup parameter which determines the value for a default probation offset in days. Generally, this value should be set to 100 days
Recruitment Requisition Custom Domain TypeThis feature enables the application to configure and add custom attributes for the recruitment requisition as part of additional information that can be required for a group of instances or all instances of the recruitment requisition
Time To Notify Trainee To Provide FeedbackOnce a scheduled training course is finished, the system will send notifications to all trainees to provide their feedback on the course using the template associated with the course. This parameter sets the number of days following the end of the course to notify trainees to provide course feedback (if the feedback has not been provided yet). If set to zero (0), the notification will be sent immediately upon completion of the training course
Notification Need To Be Send For Trainee To Provide FeedbackOnce a scheduled training course is finished, the system will send notifications to all trainees to provide their feedback on the course using the template associated with the course. This parameter defines whether or not the notification will be sent out at all. If set to true, the notifications will be sent out to the trainees for feedback. If set to false, the notifications will not be sent out to the trainees for feedback
Time To Notify Trainer To Provide EvaluationOnce a scheduled training course is finished, the system will send notifications to all trainers to provide evaluations on the trainees using the template associated with the course. This parameter sets the number of days following the end of the course to notify trainers to provide an evaluation (if the evaluation has not been provided yet). If set to zero (0), the notification will be sent immediately upon completion of the training course
Notification Need To Be Send For Trainer To Provide EvaluationOnce a scheduled training course is finished, the system will send notifications to all trainers to provide evaluations on the trainees using the template associated with the course. This parameter defines whether or not the notification will be sent out at all. If set to true, the notifications will be sent out to the trainers for evaluation. If set to false, the notifications will not be sent out to the trainers for evaluation
Default Interview Evaluation WeightInterview Evaluation Weight is a system of units used to express the weight of the interview evaluation. The value field is required
Auto Email Generation For Automatic DeductionThere will be a central boolean Parameter for Automatic Deductions for sending notification, true by default, in the application, to indicate if the employee and user's superior should be notified when the user ends an automatic deduction
Exemption Percentage Threshold For Automatic DeductionBased on the central global Parameter for Automatic Deductions exceeding the percentage threshold set, if that parameter is populated with a percentage amount greater than zero (for example, 5 %), a notification e-mail will be sent to the employee
Number Of Days Before Job Offer Goes To External SiteDate posting available for external applicants - must be greater then requisition system date - Need a parameter how many days the job will be posted internally before it goes to external site
Prioritize Wailisted Trainees By Creation DateWailisted Trainees are defined as trainees on the waiting list for a training course. This parameter determines whether or not these wailisted trainees will be prioritized by the creation date
Type Of CalendarThis is a setup parameter which determines the type of calendar used in the application. This value should be set to the Gregorian Calendar for most applications, depending on the calendar which is used in the country of the government using this application
Pay Change RequestWhen Pay Change Request value is false the checkbox within the HR application is not checked by default. When the Pay Change Request value is True the checkbox is checked automatically by default. The checkbox asks the user if he/she would like to ‘Create Pay Change Report
Cutoff Date Can Be Modified By Another Person Than The Originator?Cutoff date refers to the date by which a certain task must be completed. When the Value is True another person other than the original user who created the cutoff date can modify the date entered. When the cutoff date value is False no other user can modify the cutoff date except the original author of the cutoff date
Disable Default CutOff Date And Approval CutOff Date?

The data entry cutoff date and the approval cutoff date are initially entered in the pay period application. A general parameter will exist to say if this cutoff date can be modified by another person than the originator

Is The Employee Name Format - FirstName LastName?This is a setup parameter to determine how the employee’s names are displayed in the application. When the value is True the employee’s first name will be displayed before the last name. When the value is False the employee’s last name will be displayed before the first name
Allow To Create Employees ManuallyThis is a setup parameter that checks if an employee can be entered manually or not. When 'Allow to CREATE EMPLOYEES MANUALLY' is TRUE, this means that an EMPLOYEE can be created two ways either manually or created based on a Job offer. When 'Allow to CREATE EMPLOYEES MANUALLY' is FALSE, this means that an EMPLOYEE can only be created one way, created based on a job offer only
Is Periods Based On Months Worked?This is a setup parameter that calculate the periods of service based on months worked or between two dates. When the value is true, then the periods are based on months worked but between two dates. When the value is false, then the periods are not based on months worked but between two dates
Number of Days as a Month of ServiceThis is a setup parameter that is mandatory if the system parameter ‘Method used for months of service’ is based on months worked
Enable the Payroll Calculation Engine to Automatically Apply Salary Step IncreaseThis is a setup parameter that enables the payroll calculation engine to automatically apply salary step increases. Salary steps refer to a specific rate in a salary of the consecutive rates that comprise a salary range. Salary range is series of consecutive salary steps that comprise the rates of pay for a classification. When the value is False the payroll calculation engine does not automatically apply salary step increases
Is Race Required In Employee?The setup parameter “Is Race Required In Employee,” changes the race field in the Manage Employee screen. When the value is set to TRUE then the race field will become mandatory, when the value is set to FALSE then the race field is no longer available in the Manage Employee screen
Is Tribe Required In Employee?The setup parameter “Is Tribe Required In Employee,” changes the tribe field in the Manage Employee screen. When the value is set to TRUE then the tribe field will become mandatory, when the value is set to FALSE then the tribe field is no longer available in the Manage Employee screen
Is Religion Required In Employee?The setup parameter “Is Religion Required In Employee,” changes the religion field in the Manage Employee screen. When the value is set to TRUE then the religion field will become mandatory, when the value is set to FALSE then the religion field is no longer available in the Manage Employee screen
Mandatory Tax Identification NumberThis is a setup parameter which determines whether the tax identification number will be a mandatory function in the application or a non-mandatory function in the application

 

Configure External Data Source

NameDescription
HostnameHostname is a label that is assigned to a device connected to a computer network and that is used to identify the device on the network
PortPort refers to computer names to differentiate one machine from another and to allow for such activities as network communication
UsernameThis is a setup parameter which determines the username for the application
PasswordThis is a setup parameter which determines the password for the application
SchemaThe schema is used to refer to a graphical depiction of the database structure and it defines the tables, the fields, relationships, views, indexes, packages, procedures, functions, queues, triggers, types, sequences, materialized views, synonyms, database links, directories, Java, XML schemas, and other elements in databases
Accumulated BenefitThe Accumulated Benefit records are maintained by the payroll calculation and are available for view by HR or PAYROLL
Gregorian CalendarThis is a setup parameter which allows the system to either follow or not follow the Gregorian Calendar
Medical Form Expiration DateMedical Form Expiration Date is a setup parameter that automatically calculates the Medical Expiry Date field in the Medical Form under Manage Employees. When the value is set to 12 months like the example below the system will automatically set the Medical Expiry Date one year from the date the Medical Form is created
Enter Clock Hours for Time and Attendance?This is a setup parameter that allows entering clock hours for Time and Attendance. When the value is true, the user is able to enter Clock hours in this form: 8:00AM - 5:00PM. When the value is false, the user is able to enter Clock hours in this form: 7.5 hours per day
Default Time Record Source for Time and AttendanceDefault Time Record Source for Time and Attendance is a setup parameter that sets the initial default value of the Time Record Source on Time and Attendance Assignment Settings screen. When the Options and Value is set to MANUAL then the Time and Attendance can be entered manually, when its set to EXTERNAL then the Time and Attendance is automatically entered
Default Cost Item for Time and AttendanceA cost item is any element that can be used to predict and calculate future developments of organizational departments such as basic salary, vacation pay and full-time salaries at the assignment level. This parameter determines the value used for the default cost item for time and attendance

 

Entitlement Codes

NameDescription
Entitlement PayCode

Entitlement PayCode is a setup parameter that influences the Accumulated Benefit Entitlement screen fields directly. When the Entitlement PayCode value is TRUE then the Pay Code field becomes mandatory on the Accumulated Benefit Entitlement screen, when the value is set to FALSE the Pay Cod field is no longer mandatory

Entitlement Position Category

Entitlement Position Category is a setup parameter that influences the Accumulated Benefit Entitlement screen fields directly. When the Entitlement Position Category value is TRUE then the Position Category field becomes mandatory on the Accumulated Benefit Entitlement screen, when the value is set to FALSE the Position Category field is no longer mandatory

Entitlement Classification

Entitlement Cost Item Scale is a setup parameter that influences the Accumulated Benefit Entitlement screen fields directly. When the Entitlement Cost Item Scale value is TRUE then the Cost Item Scale field becomes mandatory on the Accumulated Benefit Entitlement screen, when the value is set to FALSE the Cost Item Scale field is no longer mandatory

Entitlement SituationEntitlement Situation Code Combination is a setup parameter that influences the Accumulated Benefit Entitlement screen fields directly. When the Entitlement Situation Code Combination value is TRUE then the Situation Code Combination field becomes mandatory on the Accumulated Benefit Entitlement screen, when the value is set to FALSE the Situation Code Combination field is no longer mandatory
Entitlement InstitutionEntitlement Institution is a setup parameter that influences the Accumulated Benefit Entitlement screen fields directly. When the Entitlement Institution value is TRUE then the Situation Code Combination field becomes mandatory on the Accumulated Benefit Entitlement screen, when the value is set to FALSE the Institution field is no longer mandatory
Entitlement Not Based On Years Of ServiceEntitlement Not Based on Years of Service is a setup parameter that influences the Accumulated Benefit Entitlement screen fields directly. When the Entitlement Not Based on Years of Service value is TRUE then the Not Based on Years of Service field becomes mandatory on the Accumulated Benefit Entitlement screen, when the value is set to FALSE then the Not Based on Years of Service field is no longer mandatory

Contract Management

 

ID Generation

  • Generate Managed Contract ID: This is a setup parameter which indicates the procedure to generate the Contract ID attribute to determine if the code in the Managed Contract is entered by a user or System generated.  When set to false, this value will be manually entered by the user.  If set to true, this value will be generated by the System and it will be left padded with zeros (subject to change if a Customized Algorithm is applied.)
  • Customized Algorithms: Will be created during Implementations to fulfill customer specific requirements.  Such algorithms will be stored in a System library, so those can be reusable in other implementations.

Other Parameters

  • Mandatory Goods Services Receive Notes: This is a parameter which indicates if Goods/Services Receive Notes (GSRN) is mandatory.  If set to true GSRN are mandatory; then the client must have the FB Purchasing System.  If set to false GSRN are non mandatory.
  • Procurement System Installed ?:  This parameter indicates if the client has installed the FreeBalance Procurement System.  If set to true, the Procurement System Module is installed; If set to false the Module is not installed.
  • Days Left Alert for Claim Inspection Expiration Date:  This parameter indicates the number of days before a claim inspection expires.  If an Integer value is selected the System will alert with anticipation about the soon planned inspections.  The alert will be sent a number of days before, this number of days is defined as the integer entered into the System.  If Null then no alert will be sent.
  • FB Budgeting Module Installed: This parameter indicates if the client has installed the FB Budget Module.  If true, the FB Budgetting Module is installed; if false, the Module is not installed.
  • Validate Payments Against Drops: This parameter indicates whether the System validates each Payment (amounts and status) against its respective Drops associated.  If true, the System will validate the association.  If false, the System won’t validate anything.
  • Maximum Tolerance for Payment Amounts: This parameter indicates the maximum percentage of tolerance that the System allows for Payment Amounts against Drops Amounts.  If a value is entered for the Maximum Tolerance for Payment Amounts, then Payment Amounts are subject to this restriction.  If value is not entered than there is no maximum tolerance for Payment Amounts.
  • Financial Accounting System Installed: This parameter indicates if the client has installed the FB Financial Accounting (FA) System.  If true FB Financial Accounting System has been in installed, if false then System has not been installed.
  • Mandatory Inspections: This parameter indicates if Inspections Registry is mandatory.  If true, Inspections are mandatory.  If false they are not mandatory.
  • Planned Information Required to set Contracts as In Execution: This parameter indicates if a Contract can change status to In Execution with or without Planned Information recorded in the System. If true means that a Contract can only change to In Execution status if it has planned information recorded in the System.  If true at least one Drop, one Planned Inspection, and one Planned Payment is required prior to change status.  If false, the Contract can be changed with just Line Items, without planned information.
  • Financial Operation Source for Contract Management: This is an Integer parameter that will be used to reference a particular Financial Operation Source already registered in the system. This is a nullable integer and cannot have a default value, when the interface with FA is enabled, the implementer must manually create a Financial Operation Source and thereafter assign the applicationId value to this parameter.

 

Expenditures Accountability

ID Generation

NameDescription
Generate Perishable Lot IDThis is a setup parameter to determine if the code in the perishable lot catalogue is entered by a user or system generated. When set to false, this value will be manually entered by the user. If set to true, this value will be generated by the system and it will be left padded with zeros
Generate Asset Item IDThis is a setup parameter to determine if the code in the asset item catalogue is entered by a user or system generated. When set to false, this value will be manually entered by the user. If set to true, this value will be generated by the system and it will be left padded with zeros
Generate Asset Transaction Type IDThis is a setup parameter to determine if the code in the asset transaction type catalogue is entered by a user or system generated. When set to false, this value will be manually entered by the user. If set to true, this value will be generated by the system and it will be left padded with zeros
Generate Inventory Item Count Request IDThis is a setup parameter to determine if the code in the inventory item count request catalogue is entered by a user or system generated. When set to false, this value will be manually entered by the user. If set to true, this value will be generated by the system and it will be left padded with zeros

 

Other Parameters

NameDescription
Linked with FAIf set to true, this parameter will be linked with the fixed assets
Bar Code Mandatory in Inventory Item?

It is a boolean parameter with 'False' as default value. If the user switches it to 'true' the system must enforce an entry in the attribute titled Bar Code, within the Inventory Item screen

Bar Code Mandatory in Assets?

It is a boolean parameter with 'False' as default value. If the user switches it to 'true' the system must enforce an entry in the attribute titled Bar Code, within the Asset Item screen

Default Inventory Costing MethodThis parameter is used to set a default inventory costing method to be used within the inventory screens (ex. Weighted Average, FIFO, LIFO, etc.)
Reorder Point Notification PeriodThis parameter is used to set the number of days before a notification warning is displayed in the system to remind the user when it is time to reorder new items
Perishable Lot Expiration Notification DaysThis parameter is used to set the number of days before a notification warning is displayed in the system to remind the user when the perishable lot will expire
Location in Warehouse Mandatory?This parameter is used to make the location in the warehouse screen a mandatory field
Asset Transaction Cash Account 
Asset Transaction Gain AccountThis parameter is the GL Coding Block which must be used to credit/debit gains obtained by the result of the sale/exchange/auction of an asset or group of assets
Asset Transaction Loss AccountThis parameter is the GL Coding Block used for credit/debit losses as the result of a disposal of an asset transaction over an asset item or group of asset items
Inventory Income Coding BlockThis parameter is the GL Coding Block which must be used to credit/debit adjustment income to register an increase in physical inventory due to additional quantities found
Inventory Expense Coding BlockThis parameter is the GL Coding Block used for credit/debit adjustment expenses to register a decrease in physical inventory due to missing quantities
Allow Subclass Validation In Asset Item?This parameter makes it so the system will allow a subclass validation to appear for the asset item
Handles Depreciation Process In Asset Item?This is a Boolean parameter that relies on the need of the Asset Accountability to handle the depreciation of assets or not, in the case that depreciation is not needed, this parameter will be false and all attributes related to the depreciation process which are mandatory will be optional
Enforce entering a Goods Services Request Group?This parameter will make it mandatory to enter a goods/services request group in any screen which has the field present
Maximum Default Goods Services Request DaysThis parameter defines the maximum days for a goods/services request should take place. It sets up the default value for this parameter
Asset Item In Count Mandatory Reason For DifferenceThis parameter defines whether the asset item in count field is mandatory in the reason for difference screen
Mandatory Inventory Item In Count Status ReasonThis parameter defines whether the inventory item field is mandatory in the in count status reason screen
File name prefix for Asset Count Request file while uploading 
Inventory Expensive Account Coding Block 

Modify Parameters (General)

Navigation: 

 

In order to modify Parameters system defaults:

 

  1. Click on the Parameter you want to modify.

  1. A new window will be displayed.

  1. Modify Value field as required and click on Update icon . This window will be automatically closed.
  2. You may update one or more parameters if required.
  3. Then click on the Update icon  at the bottom of the main Parameters screen.
  4. The system will display the following message to confirm that one or more parameters have been updated:

 

NOTE

It is important to click on the Update icon  for every parameter being modified, as well as the Update icon at the bottom of the main Parameters screen, so changes are done.