Skip to end of banner
Go to start of banner

Platform

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 7 Next »

On this page

Overview

The Platform module enables the user to configure software attributes which are related with system functionality rather than business rules, such as currencies, VAT and tax rates formatting and date settings.

Major features

  • Handle system license
  • Set up your tax and VAT rates according to the locations handled by your business
  • Set up address completion automation and verification
  • Setup your default currency and update currency rates
  • Setup general, formatting, and numbering system settings
  • Translate and use CRM.COM in your native language
  • Monitor and control batch processes to ensure 
  • Create and maintain an attachments library to be used by third party systems integrating with CRM.COM, such as a mobile app or a web portal

 

Setting Up Regional Settings

 Foundation > Platform > Regional Settings

Countries


Countries module is used to configure countries available in the system. The default country to be used across the CRM.COM is set in General Settings and it is automatically set when creating contact information and users. A dialing code available for each country is used as a prefix on phone numbers registered in the system.

Currencies


Currencies module is used to configure all supported currencies. The default currency to be used across the CRM.COM Software is set in General Settings and denotes the currency of prices and rates configured in price plans, usage service catalogs, reward offers and additive discounts. 
Accounts receivable use the default currency unless the account owner requests an alternative currency, specified during the creation of the account.

Currency fields

This table contains an explanation of the sections of the Currency Data Entry page, a description of the usage of its fields and additional information, accessed by 'Modify Information' link

 Mandatory   Configurable

Main Information

Prefix Symbol: The prefix symbol for the specified Currency i.e. 10,00

Suffix Symbol: The suffix symbol for the specified Currency i.e. 10,00

Integer Part Name: The name of the integer part. i.e. Euros

Decimal Part Name: The name of the decimal part i.e. Cents.

Rounding Options: Defines the rounding option when amounts in the default Currency is recalculated based on an alternative Currency. Rounding should be manually enabled (Apply Rounding) for the Rounding Method (Round-up, Round-down, Round Half-up) to be applied. The integer and decimal scale can be optionally defined.

Minimum Required Number of Exchange Rate Decimals : Defines the minimum required number of decimals that have to be defined when specifying an alternative Currency's exchange rate.

Rates

Define currency rate periods which are compared to the CRM.COM default currency.
Multiple currency rate periods can be configured per currency. Each currency rate period includes:

Rate*: The alternative currency's rate compared to the System's default currency.

Inverse rate: Defines the inverse rate of the default currency compared to the alternative currency's rate. This is dynamically calculated and not editable.

From Date*: Defines the date from which the rate is valid and will be used for billing customers.

To Date: Defines the date up to which for which the rate will be applicable.

On adding a new currency period rate,

  • The period's start date is set to the system's current date and the end date is left empty to indicate that the rate period is applicable from that point onward.
  • The end date of the open period is set to the system's current date as well so as to define it as closed.
  • The currency's Inverse Rate is calculated based on the rate that is manually specified by the User.

 

Prerequisites

  • The currency which is defined as the system's default in 'General Settings' can not be assigned currency rate periods
  • Each currency can only be defined one time within the list of currencies.
  • Only one currency rate period can be applicable at a time. 

Back to top

Address registry


CRM.COM integrates with Melissa Data to facilitate users to register correct addresses within the software and ensure the integrity and accuracy of address data.  The Melissa Data Address Registry provides search and verification of addresses from all over the world.  This integration is performed either dynamically while users type-in an address, or manually when users request for an address verification.  The following address registry functions are available once they are setup in the system and can be accessed from contact information, jobs , subscriptions, accounts receivable and rewards participants when registering addresses:

  • Auto-suggestion of addresses while typing in an address field.
  • Quick or advanced searches directly in an address registry.
  • Verification of addresses based on address registry information.

Address registry settings fields

This table contains an explanation of the sections of the address registry settings page, a description of the usage of its fields and additional information

 Mandatory   Configurable

Main Information

Address Registry :The address registry with which CRM.COM integrates in order to provide address auto-completion and verification. Currently only Melissa Data is available.

Account ID : A unique account ID provided by the Address Registry system.

State: Determines whether address registry is enabled.

Logging Method: Defines the method that will be used to log the requests sent to the Address Registry system. The options are the following:

  • Log Request Calls only (default option): If selected, then only calls to the Address Registry will be logged, together with the user and the date/time of the request. 
  • Log Requests and Responses: If selected, then the responses from the Address Registry system will also be logged together with the request, user and date/time.

Auto-Suggestion Settings

GeneralEnabled: If enabled, it define how users will be supplied with suggestions while typing in address-related fields.
Applicable Address Fields

Defines a set of address fields which when typed into will trigger the address auto-suggestion process. At least one address field must be specified. The address-related fields are:

Allowed Organisational UnitsA list of Organisational Units for which the auto-suggestion feature is available for users that belong to those units.

Address Lookup Settings

GeneralEnabled: If enabled determines whether the address lookups are enabled for users.
Allowed Organisational UnitsA list of Organisational Units for which the lookups are available for users that belong to those units.

Address Verification Settings

GeneralEnabled: If enabled, the Address Verification Settings define whether an address will be automatically verified whenever an address is created or updated, or if users must request a verification to ensure the address is correct. Manual verification is selected by default. Address Verification Settings are applied only if they are 'Enabled'.
Verification Method  

Determines whether addresses will be verified automatically whenever created or edited, or whether users will have to request verification. Available options are:

  • Automatic Verification
  • Manual Verification
Allowed Organisational UnitsA list of Organisational Units for which the verification settings are available for users that belong to those units.

Allowed Application Servers

'Allowed Application Servers' is available only if there are more than one Application Servers registered in the System. Multiple Application Servers can be added, although it is not mandatory to have any 'Allowed Application Servers'. If no Application Server is added in the 'Allowed Application Servers', then all the registered Application Servers are allowed.

Application Server: The Application Server that will be allowed. The Application Servers are filtered based on the Organisation Group of the logged in User.

Added By: The User that added the Application Server. This information is set automatically.

Added On: The date on which the added server was restricted. This information is set automatically.

Using auto-suggestion

Auto-Suggestions are used to automatically provide possible address values while the User is typing an address in CRM.COM. The system uses the user input and forwards it to the address registry system which in turn provides available address suggestions. Proposed addresses are automatically presented to the User in a pop-up while they are typing. Once one of the suggested addresses is selected by the User, all of the address-related fields are filled in automatically, using the address information provided by the Address Registry System.

  1. While in edit mode of the entity you are modifying, go to the related ADDRESSES Tab.
  2. Type the value in Auto-Suggestion enabled fields and press enter.
    1. If the value corresponds to only one match in the Melissa Database, then it is applied automatically.
    2. If multiple matches are found then the required address must be selected from the modal window.

Using address registry verification

Address verification is used to verify addresses registered in CRM.COM by comparing them to those in an address registry system. Check can either be performed automatically by the system or manually by users. In automatic verification, address information is sent and verified by the address registry system whenever address information is saved (for new or modified addresses).  In manual verification, it is up to the User to request verification by the Address Registry System. 


Manual address registry verification

  1. While in edit mode of the entity you are modifying, go to the related ADDRESSES Tab.
  2. Provide all the related address fields.
  3. Click on the VERIFY ADDRESS link.
    The system will forward the provided address fields and compare them with those in Melissa Data using either the default country defined in General Settings or the country provided in the country field (if applicable). If the address is not correct, the user is informed, and the correct address information must be manually supplied. Addresses can be saved even if they are incorrect.

Automatic address registry verification

  1. While in edit mode of the entity you are modifying, go to the related ADDRESSES Tab.
  2. Provide all the related address fields.
  3. Click on SAVE from the TOP MENU.
    The system will forward the provided address fields and compare them with those in Melissa Data using either the default country defined in General Settings or the country provided in the Country field (if applicable).
    Addresses cannot be saved until a correct one is provided.

Using address registry lookups

Address lookup settings enable Users to perform either Quick or Advanced Searches for addresses registered in the Address Registry System. 

Quick search address registry lookup

  1. While in edit mode of the entity you are modifying, go to the related ADDRESSES Tab.
  2. Provide all the related address fields.
  3. Click on the Quick Search link to open the address modal.
    1. Full Address: Provide the Full Address in free text.
      For the Full Address, any of the fields of the address can be provided, and all matches will be returned. Each field should be separated by a comma "," (e.g. Elia Papakyriakou, Lefkosia, Cyprus).

    2. Click on Search.
      The System will return a list of addresses that match the one provided.
    3. Click on Select next to the wanted contact address.

Advanced search address registry lookup

  1. While in edit mode of the entity you are modifying, go to the related ADDRESSES Tab.
  2. Provide all the related address fields.
  3. Click on the Advanced Search link to open the address modal.
    1. Provide the information for the known fields.
    2. Click on Search.
      The System will return a list of addresses that match the address fields provided.
    3. Click on Select next to the wanted contact address.

Back to top


 

Setting Up Glossary

 Foundation > Platform > Translate Glossary Terms

 

The CRM.COM Glossary consists of the terms displayed through the CRM.COM user interface and which can be translated to any language that is supported by CRM.COM so that you can use the system in your native language. Glossary terms include labels, instructions, tips, warnings and error messages included in Summary and Data Entry pages, search modals, and dashboards

The Glossary Utility is comprised of a number of actions which can be used for the creation and maintenance of translated terms. Downloade the XLIFF Template which includes all the CRM.COM terms (in the English language). Translate the terms using an external Computer Assisted Translation (CATtool for example, matecat. Once the terms are translated, import them in CRM.COM by Adding a new Language Translation.  The Glossary which has already been translated and uploaded in the system can be kept up to date by a procedure involving Exporting Glossary Terms, making the necessary corrections and additions, andImporting Glossary Terms again.  You can also Deleting Language Translation if it is not needed

Downloading the XLIFF template

This action is used to download an XLIFF Template to be translated. The source values (which are always in English) are automatically populated in the downloaded file. If the 'Download Template Translated in English' is selected then the source value and the target value in the file are equal to the English translation value of each term. If the 'Download Template with no Translation' is selected then the source value in the file is set to the English translation value of each term and the target value in the file is empty.

  1. From the Actions Menu click on Actions > Download Xliff Template
  2. From the modal select the type of the Template you would like to download and click on SUBMIT
  3. Click on the HTML icon
    The selected XLIFF file will be downloaded

 

Using CAT tools to translate the Glossary Terms

Several Computer Assisted Translation (CAT) tools can be used to translate terms into your language of preference.

We recommend MATECAT which is directly available through Chrome or Safari browsers.

Once the terms are translated, they must be uploaded back into CRM.COM. Refer to Adding Language Translation.

Adding a new language 

This action is used to add a new language translation, by selecting one of the languages that were not already translated and the XLIFF file that contains the translation for that language. Once the new language is added the user must logout and login again to view the changes.

  1. From the Actions Menu click on Actions > Add Language Translation
  2. From the modal window:
    1. Select Language from the drop-down
    2. Click on Upload File
      1. Either drag and drop your translated file or click anywhere in the Upload modal to select the file manually
      2. Wait until the name of the file appears in the Upload Modal and click on DONE
  3. Click on SUBMIT
    The updated XLIFF file including the new translated language will be saved and made available

Exporting glossary terms

This action is used to export Glossary Terms already translated in the XLIFF format, so as to make corrections and/or additions. There are three available export options:

  • All Terms: Translated or not
  • Non Translated Terms: Only the terms that have not been translated yet will be exported
  • Translated Terms: Only the terms that have already been translated will be exported

 

  1. From the Language Tab select the language whose terms should be modified
  2. Click on Export Glossary Translation
  3. Select the Export Type from the modal
  4. Click on SUBMIT 
    1. The selected type of XLIFF file will be downloaded

Using CAT tools to translate the Glossary Terms

Several Computer Assisted Translation (CAT) tools can be used to translate terms into your language of preference. We recommend MATECAT which is directly available through Chrome or Safari browsers.

Importing glossary terms of a translated language

This action is used to import the Glossary Terms of a language that has already been translated into the XLIFF format, so as to make corrections to translated terms or to amend the list by adding or removing terms. There are two available options:

  • Replace Existing Translation: Use this type to remove all of the current terms and add new translated terms.
  • Amend Existing Translation: Use this type to add new or correct existing terms. 

  1. From the Language Tab, select the language whose terms should be modified
  2. Click on Import Glossary Translation
  3. From the Import Glossary modal select:
    1. Import Type: Select the Type of Import from the drop-down
    2. Click on Upload File
      1. Either drag and drop your translated file or click anywhere in the Upload modal to select the file manually
      2. Wait until the name of the file appears in the Upload Modal and click on DONE
  4. Click on SUBMIT

Deleting a language 

This action is used to delete an existing translated language.

  1. From the Actions Menu click on Actions > Delete Language Translation
  2. From the modal select the language to delete
  3. Click on SUBMIT
    The selected language will not be available on the next login

Back to top


 

Setting Up Admin Settings

 Foundation > Platform > Manage Admin Settings

VAT and Tax Rates


VAT and/or tax rates are applied to products during billing. According to the country you reside, you may only have tax rate or VAT rate or you can have both. Additionally, you may have products that have different VAT and tax rates, for example medicines don't have the same VAT rate as the rest of the products, and according to the location you are different taxes may be applicable.
Various tax and VAT rates can be defined and used across the software. Each rate can have more than one value applicable over non-overlapping periods while multiple rates may be configured for the same period and applied on different products or applied on the same product but based on a location conditions, i.e. each account owner is taxed based on his billing address.

Setup the tax definition where you can define overall business rules related to taxing and proceed by creating all the required tax and VAT rates.

Tax definition fields

This table contains an explanation of the sections of the tax definition page, a description of the usage of its fields and additional information

 Mandatory   Configurable

Main Information

Rates Tax Model Defines whether the rates/prices defined in Price Plans and Usage Service Catalogs are including the tax or not. (both tax and VAT rates).

By default, all rates configured are tax inclusive.

Tax Codes

Create your tax codes. Each tax code, groups together a set of tax and VAT rates. For each tax code, exceptions can be specified based on accounts receivable classifications, on which taxes will not be applied during billing. For example, a hospital on which tax should not be applied, could be of a specific classification that will be excluded from taxing.

Tax Codes are mandatory if at least one tax rate should be applied during billing of a service or physical good. Add the respective tax code on the tax rates when creating them

Matching Criteria

Defines the minimum required address-related fields which must be specified as location conditions for VAT and tax rates. The available location conditions that can be chosen are, Country, District, Area.

VAT and Tax rate fields

This table contains an explanation of the sections of the tax and VAT rates page, a description of the usage of its fields and additional information

 Mandatory   Configurable

Main Information

Tax Code: Can be used for financial reporting. They are required when the same type of tax differs when in a different location. For example, you have the Sales Tax which is 9.98% in Louisiana, and 8.92% in Washington. In this case you would configure 2 different tax rates both of which would have the same tax code. Check tax definition for additional options on tax codes.

Apply VAT Rate: Indicates whether a VAT rate will be additionally applied on the taxed amount. This field is only available in Tax rate

Period Rates

For each tax rate you can define different rate per period. You can add multiple periods , but the From and To dates cannot overlap. The following information is available for each period

Tax Period Percentage

 Tax Period From Date

Tax Period To Date

    • Valid from and Onward: no specific date for the end of the period is required.
    • Valid To Specific Date: a specific date for the end of the period is required.
Location Conditions

The list of conditions that should be met in order for the tax rate to be applied. The system will check the location conditions and compare against the billing address of the customer and decide which tax and or VAT rate(s) should be applied.
Multiple sets of conditions can be specified and at least one of them should be met in order for the rate to be applied.

Each condition set includes a value for one or more of the following, Country, Area, District while the values that must be specified for each period rate, depend on how they are configured in the tax definition.

Applied on Products

You can select products, product types or product families the rate should be applied to.

Back to top

General Settings


General settings are used to provide system information and to configure settings and restrictions which are applied across the software, either through the UI or Web API. If general settings are not configured, only Super Users can access the software.

General settings fields

This table contains an explanation of the sections of the General Settings page, a description of the usage of its fields and additional information

 Mandatory   Configurable

System Settings

Contact Information:  A 'Company' Contact Information that represents your organisation.

Company Logo: The logo of the organisation displayed across the system on the right of the Top Menu.
The logo is also used in reports and printouts. Valid Dimensions: 130px width * 70px height. A photo editor (such as Paint) can be used to adjust the size of a logo. A transparency layer can be added to retain the logo's ratio.

Default Country: The country adopted by the system when no alternative is specified by the user during the creation of records which require a country.

Default Currency: The currency adopted by the system when no alternative is specified by the user during the creation of records which require a currency.
Currency can only be set during the first time configuring the General Settings. the currency can only be set once, and then it becomes Read-only.

Default Home Page: The page that will be displayed after log in when no alternative is specified by the user. The default home page is applied to all users having the 'Organisation Home page' as their preferred home page.

Enable Hot Keys: Defines whether Hot Keys should be enabled. The following Hot Keys are supported:

  • New (CTRL+ALT+N): Triggers the NEW button. Applicable on both Summary and Data Entry pages.
  • Save (CTRL+ALT+S): Triggers the SAVE button. Applicable only on Data Entry pages.
  • Edit (CTRL+ALT+E): Triggers the EDIT button. Applicable only on Data Entry pages.
  • Back (CTRL+ALT+B): Triggers the BACK button. Applicable only on Data Entry pages.
  • Home (CTRL+ALT+H): Triggers the HOME button.
  • Close (CTRL+ALT+X): Triggers the CLOSE button. Applicable only on modal windows.
  • Cancel (CTRL+ALT+C): Triggers the CANCEL button. Applicable only on Data Entry pages.

Disable Automatic Search: Defines whether the quick search results should be automatically triggered within a period after the last keystroke.

Automatic Search Delay Time (msec): Defines the duration of the pause between the last keystroke and the display of search results.

Time Zone: The time zone of the organisation. Time zones are defined as a combination of UTC (Universal Time Coordinated) offset and DST (Daylight Saving Time). The supported options are populated based on the Olson Time Zone IDs.
The default option is UTC; the time zone can only be set once, and then it becomes Read-only.

Language Settings
Default System Language: Used to set up the language that will be used to translate all labels, tips, warnings and error messages across CRM.COM software, including the values of select boxes and radio buttons, if those elements include fixed (configurable values) values.
The Default System Language is applied on all users having the Organisation System Language as their preferred System Language.

Default Native Language: Used to set up the language that will be used to translate additional information for each label (displayed when the mouse is placed over a specific label) across CRM.COM software.
The Default Native Language is applied on all users having the Organisation Native Language as their preferred Native Language.

Supported Languages: Select the languages that will be available for selection when setting a language for users or contact information

System Restrictions

Default Number of Threads for Batch Processes*:The number of threads used by multi-threaded batch processes, where the number is not explicitly defined by the batch process.

Max Number of Records for Super Users*: The maximum number of rows that can be retrieved per call, either through the UI or Web API, by users which are classified as Super Users.  This restriction does not apply to Reports or Printouts.

Max Number of Records for Normal Users*: The maximum number of rows that can be retrieved per call, either through the UI or Web API, by users which are classified as Normal Users (i.e. not Super Users). This information is also validated during the configuration of the rows that can be retrieved per Summary page.  This restriction does not apply to Reports or Printouts.

Upload Max File Size (KB): The maximum size allowed when uploading a file in the Attachments section of an entity.

Allowed File Types: The types of files which can be uploaded to the System.

System Information


This is a section with Read-only information related to the database.

Organisation Name

Database Name

Database Type

Database Version Number

Application Version Number

Back to top

Formatting Settings


Formatting settings are used to define restrictions in formatting when entering data into the system, such as on:

  • Date and Time
  • Numbers (e.g. separators)
  • Personal Contact Information Addresses, Phones, ID, Passport, Social Security Number
  • Company Contact Information Addresses, Phones, Registration, VAT and Tax Reference Number

Formatting settings fields

This table contains an explanation of the sections of the Formatting Settings page, a description of the usage of its fields and additional information

 Mandatory   Configurable

Number Formatting Settings

Decimal and Thousands Symbols: Defines the symbols that will be used to separate decimals and thousands. The supported options are:

  • Dot Comma (e.g. 1.000,00)
  • Comma Dot (e.g. 1,000.00)
  • Dot (e.g. 1000.00)
  • Comma (e.g. 1000,00)

Number of Decimal Digits: Defines the number of digits for various numerical fields. The following types of numerical fields are supported:

  • Price rates
  • Quantities
  • VAT percentages
  • Discount percentages
  • Other amounts
Date Formatting Settings

Date Format: Defines how date values should be formatted within CRM.COM. The supported options are the following:

  • DD/MM/YYYY
  • MM/DD/YYYY
  • YYYY/MM/DD

where DD is the day, MM the month and YYYY the year

Time Format: Defines how time values should be formatted within CRM.COM. The supported options are the following: 

  • HH:MM:SS
  • HH:MM

Contact Information Formatting Settings

Addresses

Defines a list of formatting rules that new or existing Contact Information Addresses should comply with when edited. Formatting Settings for Contact Information Addresses are defined per Country and can only be applied to Postal Codes (including PO BOX Postal Codes). There are two methods in which validations are performed, Simple and Advanced, each with its own rule settings:

  • Simple Formatting
    • Minimum and Maximum Number of characters.
  • Advanced Formatting
    • Regular expression against which the postal code will be validated. The regular expression specifies the pattern that the value must follow to be accepted by the system.

Phones

Defines a list of formatting rules that new or existing Contact Information Phone Numbers should comply with when edited. Only the Phone number is validated, and the allowed format is defined per Country. There are two methods in which validations are performed, Simple and Advanced, each with its own rule settings:

  • Simple Formatting: Minimum and Maximum Number of characters
  • Advanced Formatting: Regular expression against which the phone number will be validated. The regular expression specifies the pattern that the value must follow to be accepted by the system.
Demographic Information

Defines a list of formatting rules that new or existing Contact Information Demographics should comply with when edited. The information that is validated is the ID Number, Passport Number and Social Security Number, and the Formatting Setting rules are validated per country. There are two methods in which validations are performed, Simple and Advanced, each with its own rule settings:

  • Simple Formatting: Minimum and Maximum Number of characters
  • Advanced Formatting: Regular expression against which the ID, Passport and Social Security Number will be validated. The regular expression specifies the pattern that the value must follow to be accepted by the system.
Company Information

Defines a list of formatting rules that new or existing Contact Information Company Profiles should comply with when edited. The information that is the Registration Number, VAT Number and Tax Reference Number and the Formatting Setting rules are validated per country. There are two methods in which validations are performed, Simple and Advanced, each with its own rule settings:

  • Simple Formatting
    • Simple Formatting
  • Advanced Formatting
    • Regular expression against which the Registration, VAT and Tax Reference Number will be validated. The regular expression specifies the pattern that the value must follow to be accepted by the System.

Instructions on the construction of regular expressions can be found at: https://en.wikipedia.org/wiki/Regular_expression

Regular expressions for each country's post code can be found at: http://www.grcdi.nl/gsb/global%20sourcebook.html

Back to top

Numbering Schemes


Numbering Schemes are used to control and maintain Sequences which are used by the System to automatically generate numbers that identify entities in CRM.COM. The Numbering Schemes are predefined by the System; new ones cannot be created. All available Numbering Schemes can be configured to modify the format of each number, by specifying its prefix and the number of digits of the generated number.

Numbering scheme fields

This table contains an explanation of the sections of the Numbering Schemes page, a description of the usage of its fields and additional information

 Mandatory   Configurable

Main Information

Sequence Name:  The name of the sequence, as provided by the system which can be selected from a list.

Custom Sequence Name: A sequence name that can be provided for custom entities.

Sequence Code: The code which can be used to identify the Sequence.

Prefix: The prefix that will be used as part of the auto-generated number. i.e. S10000

Number of Numerical Digits: The number of numerical digits that will be used as part of the auto-generated number.

Latest Used Number: The last number that was used in the system for an entity in the sequence

Back to top

License


License is used to define information related to an organisation's CRM.COM License, such as the number of allowed active users, subscribers, rewards participants, as well as its access to CRM.COM application areas and modules. 

The following limitations apply to unlicensed use (i.e. no License details or key exists or the License key is not correct) of the CRM.COM software:

  • Only the Foundation > Platform > Admin Settings Menu (and sub-menus) can be accessed
  • System access is limited to Super Users.

License fields

This table contains an explanation of the sections of the license page, a description of the usage of its fields and additional information

 Mandatory   Configurable

License Information

Type*: The type of the License, which can be:

  • DEMO
  • COMMERCIAL
  • COMMERCIAL PREMIUM

Organisation Group: The Organisation Group for which the License is issued, which can have multiple organisations.


Effective Date*: The date on which the license was applied.

Expiration Date*: The date on which the license expires.


Number of Allowed Organisations: The number of organisations that can be used by the organisation Group.
For example, an organisation group such as AluxSat may have 2 organisations, AluxSat UK and AluxSat USA. The number of allowed organisations should be set to two to apply the same license to both organisations.

Number of Existing Organisations: The number of organisations that are already used by the specific organisation group.


Number of Allowed Active Users: The number of active users that can be used by each organisation of the specific organisation group. Restrictions to system usage apply if the number is exceeded.

Number of Existing Active Users*: The number of already active users of each organisation of that specific organisation group.


Number of Allowed Active Subscribers: The number of active subscribers that can be managed by each organisation of that specific organisation group. Restrictions  to system usage apply if the number is exceeded.
Active subscribers are the distinct accounts receivable owning at least one subscription with at least one effective subscription service.

Number of Existing Active Subscribers:The number of active subscribers that are already managed by each organisation of that specific organisation group.


Number of Allowed Active Rewards Participants: The number of active rewards participant that can be managed by each organisation of that specific organisation group.Restrictions  to system usage apply if the number is exceeded.
Active rewards participants are the distinct rewards participants that are participating to at least one effective reward scheme.

Number of Existing Active Rewards Participants: The number of active rewards participants that are already managed by each organisation of that specific organisation group.

Areas Controlled By License

If the license provides unrestricted access to the software without any restrictions on the applications or modules, then these sections are not displayed.

Applications: Controls access to CRM.COM applications.

Modules: Controls access to CRM.COM Modules.

If an application or module is restricted through the license, then:

  • The features of the related modules are not accessible through the UI or Web API.
  • The menus of the related modules and applications are not visible.

Applied restrictions based on license type

The number of active reward participants, subscribers and users is calculated and evaluated per Organisation (not per Organisation Group). If the number of allowed organisations, active users, active rewards participants or active subscribers is exceeded, then restrictions to system usage are applied, based on the license type: 

License TypeRestriction
DEMO
  • Users belonging to the organisation that breached the license agreement cannot access the software through the UI or Web API.
COMMERCIAL
  • If the number of active users, subscribers or rewards participants exceeds 110% of the allowed value, then users belonging to the organisation that breached the license agreement cannot access the software through the UI or Web API.
COMMERCIAL PREMIUM
  • Users can still access the software through the UI or Web API.
  • Super users and developer users of the organisation that breached the license agreement get a warning each time they log into the system.


Updating license

If your license is about to expire and you would like to update it then you can do so, through the respective page.

  1. Navigate to License.
  2. From the menu, click on Update License
  3. Provide the information sent to your Organisation by CRM.COM.
    1. License Key: Applicable and visible only if a license key doesn't exist for the specific organisation.
    2. License Details: Text area for the encrypted text.
  4. From the Actions Menu, click on SUBMIT.
    1. The updated License information is now available in the View License screen.

Back to top

Scheduler Settings


Scheduler settings are used to define the rules to be applied while running batch processes through the scheduler engine.  If more than one application server is used to connect to an organisation, it is possible to define which application server will be responsible for running each process.  It is also possible to 'Enable' or 'Disable' the scheduler per application server, as well as define if the scheduler will be started automatically on certain servers.

Scheduler settings fields

This table contains an explanation of the sections of the Scheduler Settings page, a description of the usage of its fields and additional information

 Mandatory   Configurable

Main Information
Organisation: The organisation related with the scheduler settings.

Scheduler Enabled Application Servers

A list of the application servers which are registered for the specific organisation and are 'Enabled' to run scheduled processes through the scheduler engine. All the registered servers (which share the same ECENTER) are loaded automatically. Server registrations are created automatically whenever the specified user, logs into the server using the specific organisation.

Application Server: The registered server. Only the servers related with the organisation of the logged in user are loaded.

Enabled: If checked, the specific server will be 'Enabled' to run scheduled processes through the scheduler engine. At least one registered application server must be 'Enabled'.

Start Automatically on Starting the System: If checked, the scheduler will start automatically on the server whenever it is restarted.
This option can be 'Enabled' only if the application server is 'Enabled' as well.

Default: If checked, the server will be considered as the default server for running scheduled processes through the scheduler engine. This information is available only if the application server is 'Enabled'.
Only one 'Enabled' server can be set as the default and it is mandatory to have at least one default server.

Allowed Scheduler Processes

A set of business rules which define the scheduled processes that can be performed by each Application Server. Scheduled processes which are not included in the list will be processed by the Application Server which is registered as the default server.

Application Server: The registered Application Server that is allowed to perform the specified process. Only the Application Servers related with the organisation of the logged in user can be defined.

Module: Specific module to determine the processes available for scheduling, for example, Billing

Process: The process that will be allowed to be performed by the specified registered server, for example, Normal Billing Run


Compatibility Settings


Compatibility settings are used to define settings that will make the behavior of features compatible with the behavior that used to be applied in previous releases.

If the legacy subscription actions are enabled then they will be available. Legacy subscription actions are replaced by 'Amend Services and Installed Items' subscription action These actions are:

  • Add Service
  • Remove Service
  • Add Installed Item
  • Remove Installed Item
  • Change Subscription Distributions


Attachments


You can attach various files or URLs either on specific entities, i.e. attach a contract to a subscription, or centrally for example a contract template which can be accessed and downloaded by all users.

Attachment classification

Classifications are used to group attachments with similar business usage. Classifications can be configured in the system, and then every time an attachment is added to the system, a classification can be provided. 

Attachment library

You can maintain an attachments library in which users will be able to upload various attachments. These attachments are not customer specific but organisation specific, and can be used through third party systems that integrate with CRM.COM such as a mobile app or web portals. Attachments can either be a file or a URL.

Attachments library settings fields

This table contains an explanation of the sections of the Attachment Library page, a description of the usage of its fields and additional information

 Mandatory   Configurable

Name

Description

Attachment: The attachment to be uploaded into the system. The user can select whether to Upload File or URL.

 

For both scenarios, when a user opens the modal of an existing attachment, the attachment name should be displayed (below the Attachment label) and once clicked, the attachment content should be opened in a new tab (similar behaviour when clicking on an attachment from a Contact Information page). This preview feature won't be available during the process of adding a new attachment or editing an existing one.

Classification: The classification of the attachment

Uploading an attachment to the library

Specific to a record attachments can be uploaded almost from all modules. In the attachments library, upload files or URLs that are of global usage 

  1. Navigate to the attachments library
  2. From the Actions menu click on Actions > Upload File or Actions > Add URL
  3. Click on the Upload File link and either drag and drop the file or click in the box to browse your computer for the file to upload
    OR
    Specify a URL
  4. Select a classification for the attachment and click SAVE

Back to top


Setting Up Health Monitoring Utility

 Foundation > Platform > System Health Monitoring Utility

 

Health Monitoring Utility is used to detect damaged batch processes whose execution stopped unexpectedly, recurring batch processes that were not scheduled to be executed as well as batch processes that for some reason cannot be executed, to prevent any erroneous and unexpected system behaviour. The utility logs errors and warnings and notifies Admin Users accordingly. In greater detail:

  • Can be configured to notify admin users by email regarding errors, warnings and/or updates.
  • Identifies batch processes which are not scheduled and raises warnings.
  • Identifies batch processes which stopped executing or cannot be scheduled to be executed because of an error, e.g. the application server's scheduler is 'Not Effective' and logs an error

Health monitoring utility fields

This table contains an explanation of the sections of the Health Monitoring Utility page, a description of the usage of its fields and additional information

 Mandatory   Configurable

Main Information

Status: Determines the status of the Monitoring Utility, which can be one of the following:

  • Running
  • Idle
  • Stopped

Last Execution Date / Time: The last date on which the Utility was executed.

Last Execution Duration in Seconds: The duration of the last execution in seconds.

Latest Errors

A list of the errors identified in the latest execution of the Utility.

Module: Determines the module related with the batch process.

Batch Process: Determines the name of the batch process.

Error Code: Determines the code of the identifier error.

Error Description: Determines the description of the identifier error.

Latest Warnings

A list of the warnings identified by the latest execution of the utility.

Module: Determines the module related with the batch process.

Batch Process: Determines the name of the batch process.

Warning Description: Determines the description of the identified warning.

Email Notifications

 Settings

From Email Address: Defines the email address that will be used in the sender of the email notification. 

Subject: Determines what will be written in the subject of the email notification. 

Notify on Errors: Determines whether notifications should be sent each time an error is identified.

Notify on Warnings: Determines whether notifications should be sent each time a warning is identified.

 Recipients

The users that will be notified either for warnings or errors

Notes

 Back to top


Platform Business Examples

Setting up CRM.COM for the new French call centre

Scenario

Company ZX is opening her doors to french public. A new call centre is being set up to handle customers

  • All system should be available in french however English language should still be supported if some call agents would rather to work with the system in english.
  • The default country for all (users and contacts) should be France.
  • Currency used is Euros (€)
  • The time in the system should be set to Central European time zone.
  • The postal code provided for addresses is specific and the system should be configured to ensure that addresses entered to the system follow the correct format.
  • A sales tax (VAT) of 20% is applicable as a Standard Rate, 10% as Reduced Rate and 2,1% as Super Reduced Rate.
    • All cable channels will be applied a Reduced rate of 10%, while the Standards rate of 20% will be applied to any purchases from their hardware stores, such as antennas, USBs, modems, decoders will have the standards
    • Due to this variation of taxes they would like the rates configured in the system for the products they sell, excluding taxes
    • Note that hospitals will not be charged any taxes
  • Written instructions on setting up new subscriptions will be provided to subscribers upon requests

Solution

  • All system should be available in French however English language should still be supported if some call agents would rather to work with the system in English.
  1. Navigate to Glossary
  2. Download the CRM.COM terms xliff template
    1. Translate terms using a CAT tool
    2. Add the translated terms using Add New Language
  3. Navigate to General Settings and at language settings set the following:
    1. French as the default system language.
      All terms will be shown in english
    2. Select French and English as the supported languages
  • The default country for all (users and contacts) should be France.
  1. Navigate to Countries and if not yet available, create France as a country
  2. Provide the following: Two characters code, Three Character Code, Three Digits Numeric Code, Alternative Code, Dialling Code.
  3. Navigate to General Settings and set the default country to France

  • The time in the system should be set to Central European time zone.
  1. Navigate to General Settings and set the Time Zone to Central European


  • Currency used is Euros (€)
  1. General Settings and set the Default Currency to Euros
    Note that if you would like to make more currencies available then you will need to configure them in the Currencies module, where the conversion rate against the Euro (which is set as the default currency) must be provided. To use these additional currencies, you will need to select them during the creation of a new account.

  • The postal code provided for addresses is specific and the system should be configured to ensure that addresses entered to the system follow the correct format.
  1. Navigate to Formatting Settings
  2. Under Contact Information Formatting Settings > Addresses
    1. Select country "France"
    2. Formatting: Advanced
    3. Regular Expression: ^(F-)?((2[A|B])|[0-9]{2})[0-9]{3}$"

  • A sales tax (VAT) of 20% is applicable as a Standard Rate, 10% as Reduced Rate and 2,1% as Super Reduced Rate
    • All cable channels will be applied a Reduced rate of 10%, while the Standards rate of 20% will be applied to any purchases from their hardware stores, such as antennas, USBs, modems, decoders will have the standards
    • Due to this variation of taxes they would like the rates configured in the system for the products they sell, excluding taxes

  1. Navigate to Tax Definitions
    1. Set the Rate Tax model as Tax Exclusive
      This will dictate that price catalog rates are not including any tax
    2. Create 3 Tax Codes
      1. Standard VAT
      2. Reduced VAT
      3. Super Reduced VAT
    3. For all 3 codes set 'Hospitals' account classification in the exceptions to ensure that no tax will be charged for them
      Note that you will already need to have the 'Hospitals' classification configured and ensure that it will be set on all hospital subscribers.
  2. Navigate to VAT Rates
    1. Create a VAT Rate by specifying the following information:
      • Name: Standard
      • Alternative Code: SR
      • Tax Code: Standard VAT
      • Period Rates:
        • 20% from 01/01/2017 onward
      • Applied on Products
        • Select Product Type: Hardware
          Note that you will already need to have the 'Hardware' product type configured which will be used for all hardware equipment
    2. Create a VAT Rate by specifying the following information:
      • Name: Reduced
      • Alternative Code: RR
      • Tax Code: Reduced VAT
      • Period Rates:
        • 10% from 01/01/2017 onward
      • Applied on Products
        • Select Product Type: Services
          Note that you will already need to have the 'Services' product type configured which will be used for all channels available through cable
    3. Create a VAT Rate by specifying the following information:
      • Name: Super Reduced
      • Alternative Code: SRDR
      • Tax Code: Super Reduced VAT
      • Period Rates:
        • 2.1% from 01/01/2017 onward

  • Written instructions on setting up new subscriptions will be provided to subscribers upon requests
  1. Navigate to Attachment classifications and create a new classification 'Subscriptions'
  2. Navigate to Attachment library and upload the PDF file with the written instructions for installation
    1. Set the classification to Subscriptions
      Users will then be able to access the Attachments Library, search by classification, and download the attachment.The attachment can then be added to the attachments of the record (if section is available), which can then be sent directly to the subscribers through email by creating Communications.

 

 

Back to top

Glossary

CRM.COM Term
Description
CommunicationsLog interaction between customers and agents. Communications can support multiple Communication media such as Email, SMS, telephony, letters and others.
ProductsThey can be physical goods or services; services represent any intangible commodity which is provided to customers, such as telephony, TV channels, installations, start up fees, while physical goods represent any tangible commodity, such as modems, decoders, antennas or magazines. 
Scheduler EngineScheduler engine is used to execute jobs that are configured in the system to handle batch processes.

 

 



  • No labels