BILLmanager Documentation

Localization

ISPSystem

Localization allows you to set up the billing system according to your country document system. 

In order to add a localization for your language, complete the following steps:

  • Select currencies for payments
  • Add document languages
  • Add document types
  • Create a list of required information that a payer should enter to make a payment
  • Add document templates associated with documents you will use

Currencies


The administrator of the control panel can enable or disable currencies used by the billing system — DirectoriesCurrencies. The active (enabled) currencies will be available for selection in all menus where currency is requested: setting of payment methods, provider etc.

kur.png

Example of a panel with enabled/disabled currencies

Currency exchange rate

To set your currency exchange rate, go to DirectoriesCurrencies → select the currency → Currencies → select the target currency → RateAdd.

For example, to set your own Euro exchange rate to the US dollar:

  1. Specify the Date from which the exchange rate will apply. In this example, the date is March 13, 2020.
  2. Specify the Number of currency, i.e. how many units of currency are converted to another currency. In this example, it is 1 unit.
  3. Specify the currency Rate. In this example it is 2. Press Ok to save the changes.

    How to set your own currency exchange rate

According to the rate set by you, from March 13, 2020, 1 EUR will be equal to 2 US dollar 00 cents. This rate will be used until you create a new rate or enable automatic currency rate updates. When the currency rate is updated automatically, BILLmanager receives the values set by the Central Bank (CB) of the state.

To enable automatic downloading of the current rate for the selected currency, go to DirectoriesCurrencies → select the currency → Currencies → select the target currency → RateUpload:

  1. Enable the option Upload automatically. The currency rate will be uploaded automatically at a specified time.
  2. Set the currency exchange rate Upload time.
  3. If necessary, enable the Upload now option. The currency exchange rate will be updated with the specified parameters.
  4. You can specify the Correction factor. The uploaded exchange rate will be multiplied by the value indicated in this field.
  5. In the Increase by field you can enter the value to be added to the downloaded exchange rate. To reduce the exchange rate, you can enter a negative value in this field.
  6. If the Upload now option is enabled, the Overwrite existing values option appears. If this option is enabled, the values stored in the system will be overwritten Start date specified in the corresponding field.

    Note:

    Overwriting the exchange rate values will not affect the payments and expenses in which these values were used.

  7. Press Ok to save the changes.

    Setting automatic currency exchange rate download

For example, to automatically download the EUR/USD exchange rate, the administrator of the panel needs to go to Directories → Currencies → EuroCurrenciesUS DollarRateUpload. In the settings you need to enable the Upload automatically option and set the Upload time to 00:01. After saving the settings, the EUR/USD exchange rate will be downloaded every day at a given time.

Language


In Settings → Localizations you can manage languages available in the billing panel. By default, only translated interface languages are displayed.

Localization states:

ImageDefinition

Localization by default

Built-in localization

Localization is active

Localization is not used

Localization by default — localization that was selected in the initial configuration wizard. If there is no localized name, description or message template, the default system language will be used.

For example, in the system, there are two localizations — English and German. The default localization is English. For every localization, you can configure notification templates. If a client uses the German localization, then all received notifications will be structured according to the template. If the German localization template isn't configured, then notifications will be structured according to the default template, which is English.

Built-in localization — localization that is available out of the box from BILLmanager. It includes full interface translation. Russian and English localizations also have additional translated document templates.

Localization is active — location can be used. 

Localization is not used — localization is created, however, it isn't available yet.  

If the required language is missing, you can always create it. The new language won't be build-it in a billing system, but you can use it in document and message templates. At this moment, you can't change the interface language to the one that you have just created.

When you add or activate a localization, many forms (e.g. a tariff or product type add/edit form) will contain a new field where you can enter names in the selected language. These names will be used in documents.

Example of the localized tariff name:

On the authorization page, you can select your interface language. You can choose only active localization that has the translated interface: 

To make the connected localization available at authorization page, add a corresponding entry to the BILLmanager database:

  1. Connect to BILLmanager server via SSH and enter the command:

    mysql billmgr -e 'update locale set embedded="on" where id="locale_id"'

    locale_id — localization ID in BILLmanager. To find out the localization id, enable the id column display on the localization management page: SettingsLocalizationDisplay fields: → enable Id option → Ok.

  2. Clear BILLmanager database cache:

    rm /usr/local/mgr5/var/.db.cache.* -f
  3. Restart BILLmanager control panel:

    /usr/local/mgr5/sbin/mgrctl -m billmgr exit

Document types


In DirectoriesCountries, you can set types of documents that are available for a specific country. The following types of documents are available: 

  • Reconciliation report 
  • Invoice 
  • Envelope

When you create a company, you need to select a country in the Legal address field. Depending on that company, specific documents will be available to your clients.

If you do not select any document types for a certain country, companies from that country won't be able to generate documents of those types.

If you disable the document type that you have used, you won't be able to print documents of that type.

Document templates


A list of the documents templates available is located in Settings → Document templates. You can add your own templates or use the existing ones.

To connect a template to localization, you need to set the language in template parameters. If you don't clarify the language, you won't be able to select it in your company settings. 

Document localizations have to be configured for every company. You can select a language while creating a company and editing company configuration in "Print options". List of the available languages is generated depending on active localizations. 

Note:

Clients will be able to see the document language that has been clarified in your company settings.

We do not recommend that you create templates unless you have enough knowledge of EJS-templates. It is better to use a pre-defined template and edit it according to your needs.

Payer information


In DirectoriesCountriesParameters button you can select the information that a payer from a certain country will be asked to provide. The data will be used in documents.


Note:

 Changing company details will also change data in documents that you provide to your clients.

For example, if you add a new parameter "Registration date " for your users, you will be able to use it in documents (you will need to add it to your document template). When a client tries to make a payment, BILLmanager will ask those clients who didn't provide that parameter to enter it for the payer on the payment form.

However, it works also in the other way. If you have deleted a parameter, e.g. "Vat number", new clients won't be asked to enter it. If you didn't edit the document template where this parameter was used, then an empty field will be displayed instead of "VAT" unless you delete it from the template.

Thank you for your feedback!
Was the article useful?
Tell us why not:

it does not match the title

it was hard to understand

I didn't find the answer

recommendations from the article did not help

other

Tell us what you didn't like in the article: