System - Configurations

From Cyclos Wiki
Jump to navigation Jump to search

Description

The configuration determines how Cyclos looks like, feels and behaves for groups of logged users or for guests. Some examples of options that can be set in a configuration are the language, the address, the address layout, the number format, the mail server and much more.

Also most content management items are bound to a theme. E.g. per configuration you can edit the banners that are visible. These content management items are however edited through the content menu:

Business rules

Configurations are defined in an hierarchical fashion. There is one, hard-coded configuration, which is the system default. This system default configuration is always the root of any configuration tree. When creating a new configuration an existing 'parent' configuration need to be chosen, this can be the system default configuration or any other configuration the admin has the permission to manage. This means that all configurations descend directly or indirectly from the (hard-coded) system default configuration. An admin can chose to inherit the options from the respective 'parent' configuration or customize them (by selecting the edit icon). It is also possible to 'lock' options (by selecting the lock icon), when options are locked lower level configurations cannot change them anymore. Configurations which have child configurations cannot be deleted. Besides that, configurations may be set for specific guests (matching an URL parameter) and/or to specific users (through group and / or group set).

On runtime, always the most specific configuration is used for guests:

  • Specific guest (matching URL parameter), if any
  • System default

For logged users, the group determines the configuration that will be applied. A group has a configuration property; a configuration does not have a group property. A group can only have one configuration and must have a configuration - it may not be null. Groupsets also have a configuration. The groupset's configuration only determines what the default configuration will be in the form for creating a new group. However, the admin may just choose another configuration for this new group. The default configuration when creating a new groupset is always system default. As stated above, a user group can only have one configuration. However, a configuration is always part of a hierarchical configuration tree. A new configuration always needs to extend a higher level one. This means that all configurations in the system are part of a hierarcal configuration tree. The built-in 'global default' configuration is the top of the hierciarchy

Configuration applicabilitly

When viewing Cyclos as guest (not logged in) the configuration that will be applied is determined by the URL (domain or path) the user accesses. The URL/path is defined in the config.
When a user logs in to Cyclos the configuration will be applied that is bound to the group the user. Be aware, it does not take in account the access URL/path defined in the configuration of the user group. A user can login in to a URL/path defined in configuration at a higher level. But the only difference is that he logs in at another URL. What he sees (layout, pages etc) is from the configuration that is bound to his user group.
Example, system with the following two configurations:

  • Config1: bound to group1, URL: www.mybank.com
  • Config2: bound to group2, extends config1, path: www.mybank.com/city
  • A user from group2 can access both domains, www.mybank.com/city and www.mybank.com. And will get the same result once logged in.
  • A user from group1 can access only by URL www.mybank.com
Restrictions
  • It is also possible to set in a configuration 'access only by URL/path'. This means that users can only login at the path (not at higher defined URL/paths).

The advantage of this is that you can restrict specific access (e.g. global admins or Web services access) to a path, wich can be a hard to find path like www.domain.com/sdlf893knd9234rd.

  • The 'access only by URL/path' restrictions, as well as the white lists restriction are applied when a session is established.
  • If a global admin has session he can switch to lower level configurations without the restrictions being applied.

Therefore, when implementing IP and URL restrictions it is important that the higher global admin groups have similar or more restrictive permissions.

Rules for fields
  • By default the value of the higher configuration is shown for each field, an edit icon is shown in the right column next to the field to customize the field.
    • When a field is not customized (thus inherited) an edit icon is shown.
    • When a field is not edited (customized) no lock icon is shown.
    • When the field is customized an revert to inherited value icon is shown.
    • When a field is customized, and not locked, a green unlocked icon is shown.
    • When a field is customized and locked, a yellow locked icon is shown.
    • When a field is locked in a higher configuration a grey lock icon is shown.
  • In the case of the inheritance from a higher configuration of the selected options in a multi-selection field there are only two options:
    • When the field is customized and locked at a higher configuration level all children have to follow the definitions in the parent.
    • When the field is customized and not locked, each following configuration can select among the available options until on one level the field is locked.

Permissions


Pages

Search (filters)

Fields Type Rules
Filter by groups Multiple selection Allows filtering by groups
Name Text Allows filtering by configuration name
URL Text Allows filtering by URL (defined in the configuration)
  • Only visible in Advanced searches mode
New Multi action button When creating a new configuration an existing 'parent' configuration needs to be chosen, this can be the system default configuration or any other configuration the admin has the permission to manage. At clicking the selected option, an empty details page for creating a new configuration opens based on the chosen 'parent' configuration.
Advanced Action button Switch to advanced mode
  • Only visible on Single searches mode
Single Action button Switch to simple mode
  • Only visible on Advanced searches mode


Search result (list)

* Automatically shows all configurations, shown hierarchical and sorted alphabetically by name.

Fields Type Rules
Name Text (read only) Shows the name of the configuration and an arrow icon before the name indicating the location in the configuration hierarchy.
URL Text (read only) The URL of the configuration.
Preview Icon Displays the selected configurations settings in view only mode. It shows the 'active' configuration, meaning it combines all applied settings (also those inherited from higher level configurations)
Remove Icon Allows the admin to remove the configuration.
  • Only visible if the admin has the System configuration - Manage permission.
  • A configuration can only be removed if it is not used and / or if it doesn't have children.


Details page

Fields Type Rules
Parent Text (read only) Indicates which is the direct parent configuration of which the new configuration descends from. All configurations are extended directly from another configuration being or the main configuration which is part of the default database (system default), or any other lower level configuration.
  • Not visible for system default.
  • Definition realized in the upper level, when fixed, cannot be changed in a descending configuration.
Name Text The name of the configuration.
  • Required.
  • Must be unique.
  • Max length of 100 characters.
Description Text Here you can put an explanatory text for the configuration.
Main URL Text The root URL.
  • Needs to be a valid URL. Either URL of the main web application including the internal name of the network (e.g. commmunities.cyclos.org/network1) or an 'own' domain resolving to the IP address of the main webapplication domain (e.g. http://www.mydomain.org pointing to communities.cyclos.org)
  • There shouldn't exist 2 configurations with the same combination of root URL.
  • Only editable by Global admins
URL path Text
  • The path from the root URL to distinguish this configuration from others in the same network. For example, if the global default configuration's root path is http://www.server.org, and the network's internal name is 'England', having a path of 'London' will match requests to http://www.server.org/england/london.
  • Cannot contain May only contain letters, digits, dots, minus or plus characters
  • Maximal 50 characters.
  • The following reserved words that cannot be used as path name: cyclos, js, images, content, web-rpc, java-rpc
  • There is no 'path' option in the default network configuration nor Global default configuration.
Used by groups Links Shows the groups currently using this configuration, with links to the details page
  • User that are not logged in (guests) that access with the Root URL or the Path (see above) will get the current configuration
  • Logged users can only access the configurations in which their group is listed.
  • There is no 'Used by groups' option in Global default configuration.
User data
Privacy-controlled profile fields Multi selection The selected fields will be included in the privacy control lists (see: System configuration - User configuration - Privacy control lists)
Require e-mail Boolean Determines whether the e-mail is required or not for users with this configuration.
Unique e-mail Boolean Determines whether the e-mail needs to be unique.
  • Only appears in top level configurations (global, network default)

Note Making the e-mail not unique effectively disables e-mail as an identification method for access or performing / receiving payments in this configuration and its affected children. Please, proceed with caution

Validate e-mail on Multi selection Determines when the e-mail must be validated by the user
  • only visible when Require e-mail is selected
  • Available options:
    • Public registration
    • Registrations by administrators
    • Registrations by brokers
    • Registration by member
    • Operator registration by member
    • Email modification by user himself
    • Email modification by administrator
    • Email modification by broker
    • Imported users
Default email privacy setting Single selection When a user registers or changes his profile he can determine whether to hide or show his email for others. Here the admin can select the default value for this setting. In general for businesses this value will be visible and for consumers it will be hidden. Options:
  • Private (Hidden for other users)
  • Visible to other users
Require profile image Boolean When selected the user must upload a profile image upon registration.
Default image for newly registered users Image When users are registering without uploading a profile image a system wide default image is shown. With this setting it is possible to have customized default profile images per configuration/group.
Generated login name Boolean Determines whether new users with this configuration will have their usernames automatically generated (when checked) or will need to provide the username manually (when unchecked). When the username is automatically generated, the length will be the maximum set in the field "Generated login name length". The username will be an integer, when the maximum number of digits is reached another digit will be added.
Generated login name length Integer The length of generated usernames.
  • Visible only when checkbox of Generated login name is checked.
Regular expression for login name Text Defines the regular mask used to validate manually entered usernames.
  • Visible only when checkbox of generated login name is not checked (username manually entered).
  • It uses the standard Java regular expressions http://docs.oracle.com/javase/7/docs/api/java/util/regex/Pattern.html
  • If the webservices are used please do not allow the use of the colon ":", because this is used to separate the user name and password. So don't add "\p" or "\:".
Username length Integer range Determines the minimum and maximum number of characters for usernames.
  • Visible only when checkbox of Generated login name is not checked.
Individual documents directory Single selection Content manager configuration, in cyclos properties


Localization
Default language Single selection Indicates the default language for the application and data translations.
  • Shows all languages available in the system. New languages can be created in the content management - application translation (see Languages).
  • Required when system default.
Additional languages Multi selection Indicates the additional languages, besides the default, users can choose.
  • Shows all languages available in the system. New languages can be created in the content management - application translation (see Languages).
  • When no additional languages are allowed, the user will be forced to use the default language
Country Single selection Defines the country which will be used as default for address and phones.
  • Required when system default.
  • Values: List with all countries
Number format Single selection Indicates the way how numbers will be formatted.
  • Required when system default.

Possible values:

  • Comma as decimal separator;
  • Period as decimal separator.
Distance unit Single selection Defines the scale unit used in the calculations of address distances in user / advertisement search.
  • Required when system default.
  • Possible values:
    • Kilometer
    • Mile
Date format Single selection Indicates the way how dates will be formatted.
  • Required when system default.
  • Possible values:
    • day/month/year
    • day-month-year
    • day.month.year
    • month/day/year
    • month-day-year
    • month.day.year
    • year/month/day
    • year-month-day
    • year.month.day
Time format Single selection Indicates the way how the time (hours / minutes) will be formatted.
  • Required when system default.
  • Possible values:
    • 24 hours
    • 12 hours
List separator Single selection Indicates which separator to use in CSV exports.
  • Required when system default.
    • Comma
    • Colon
    • Semicolon
    • Pipe
Time zone Single selection Indicates the time zone used to display / parse dates.
  • Required when system default.
  • Possible listed values are all obtained from the java library system.
Addresses
Enabled address fields Multi selection Allows to determine the address fields listed in the profile of the groups with this configuration.
  • Available options:
    • Address line 1
    • Address line 2
    • Street
    • Number
    • Complement
    • Neighborhood
    • PO Box
    • Zip Code
    • City
    • Region or State
    • Country
Required address fields Multi selection Allows to determine the required address fields listed in the profile of the groups with this configuration. Only the address fields selected in the Enabled address fields plus Country will be shown in the option list.
Default city Text Allows to define a default city that will show up in the address of each user who inherits the configuration.
Default region or state Text Allows to define a default region or state that will show up in the address of each user who inherits the configuration.
Require address Boolean If checked, when registering a user with this configuration at least one address is required.
Default address privacy setting Single selection When a user registers or changes his profile he can determine whether to hide or show his address for others. Here the admin can select the default value for this setting. In general for businesses this value will be visible and for consumers it will be hidden. Options:
  • Hidden for other users
  • Visible to other users
Phones
Always show international phone number Boolean If checked the phone number from users having this configuration will always be shown in international notation.
Unique mobile phone Boolean If checked, the phone number must be unique.
  • Enabled by default (set to yes)
  • Only visible on main configuration

Note Making the mobile phone not unique effectively disables the SMS channel and mobile phone as an identification method for access or performing / receiving payments in this configuration and its affected children. Please, proceed with caution.

Require mobile phone Boolean If checked, at least one mobile phone number from users having this configuration has to be informed at registration.
Require landline phone Boolean If checked, at least one landline phone number from users having this configuration has to be informed at registration.
Enable landline extension Boolean If checked, an extension can be entered for landline phone numbers:
  • When enabled, minimal size 1 digit, maximal length 6 digits.
Default phone privacy setting Single selection When a user registers or changes his profile he can determine whether to hide or show his phone number for others. Here the admin can select the default value for this setting. In general for businesses this value will be visible and for consumers it will be hidden. Options:
  • Hidden for other users
  • Visble to other users
Display
Application name Text The simple name of the current Cyclos instance, or the project it belongs to.
  • Required when system default.
Application description Text A small description for the application. Is the value of the description meta tag (SEO) of the index page
Administration name Text An identifier to be shown to regular members instead of the name of a specific administrator, since regular members should never know the specific administrator.
  • Required when system default.
Results on autocomplete fields Integer The number of results on fields that use autocomplete (for example, the quick user selection field in the payment window).
  • Required when system default.
Maximum results on requests / PDF / CSV Integer The maximum number of returned results. Even if more than that is requested, it will be limited by this setting. Mainly used to limit the export results in a report (CSV, PDF).
Skip total count on searches Boolean This setting will not show the total count in searches (shown under the search result list). This will improve the search performance for large databases. The 'total count' indicator is not considered relevant information for end-users, and therefore an admin might consider to skip it when it improves the search performance.
User format for managers Custom widget Indicates how users will be displayed for managers. Has a separator and fields that can be added to the format.
  • Required when system default.
  • Maximum of 5 items

Note: The changes on User format for managers will not be reflected on users until the user profile is saved or a reindex bulk action is executed

User format for others Custom widget Indicates how users will be displayed to other users (non managers).
  • Required when system default.
  • Maximum of 5 items

Note: The changes on User format for others will not be reflected on users until the user profile is saved or a re-index bulk action is executed

Name label for users Text It is possible to define a custom 'Name' label. For example, for a specific user group you might want to show 'Business name' instead of Name. This can be done with this setting.
User search in menu Single selection With this setting the user search can be hidden in the menu, and it is also possible to limit the search for specific groups.

Note This setting will overwrite the visibility settings in the product.

Groups allowed in user search Multi selection Only shown when above setting (user search in menu) is set to 'specific groups'.
Maximum left banners Integer When set, indicates the maximum amount of banner sections on the left of the main window (below the menu and notification windows). When there are more banners than the defined maximum, the banners will rotate (change per period).

Note: This setting applies only to the classic interface

Maximum right banners Integer When set, indicates the maximum amount of banner sections on the right of the main window. When there are more banners than the defined maximum, the banners will rotate (change per period).

Note: This setting applies only to the classic interface

Seconds before rotating banners Integer When set, indicates the time interval the banners rotate, if exceeding the maximum amount of banners.
Use left spaces for guest pages Boolean If selected, the left column of the main window will display the guest page definitions instead of banners.
Default result sort order for users Single Selection

Available options:

  • Relevance
  • Creation date
  • Alphabetically ascending
  • Alphabetically descending
  • Distance
Default result type for users Single selection Defines which is the default type of results of a user search.

Available Options

  • Tiled boxes
  • List with thumbnails
  • Regular list. Without thumbnails
  • Map
Advertisement initial search Single selection New front-end only
  • Available options
    • Show categories
    • Show advertisements
Default result sort order for advertisements Single selection
  • Available options
    • Relevance
    • Last published
    • Price highest
    • Price lowest
    • Distance
Default result type for advertisements Single selection Defines which is the default type of results of an advertisement search.

Available options

  • Tiled boxes
  • List with thumbnails
  • Regular list. Without thumbnails
  • Map
Advertisement categories Single selection

Available options:

  • Text bullets list
  • List with pictures
Advertisement sub categories results Integer Will show subcategories (inf configured)
  • Only visible when select List with pictures on Advertisement categories

note For classic front-end only

Default account history period Single selection
  • Available options:
    • Today
    • Current week
    • Last month
    • Last 3 months
    • Last 12 months
    • Current month
    • Current year
    • All time
Profile field in account history print title Single selection This field will be shown in the title of the account history PDF file.

Available options: Any Profile custom fields in network plus Use default user formatting

Profile fields in account history print Multi selection

Available options: Any Profile custom fields in network

Account status indicators Multi selection This are the optional fields that will show up above the account in the account history (if selected in this setting).
  • Available options
    • Balance
    • Reserved amount
    • Available balance
    • Negative balance limit
    • Positive balance limit
    • Negative since
    • Virtual rated balance
    • Balance reach maturity in
    • Age of balance
    • Balance at begin of period
    • Balance at end of period
    • Total received
    • Total paid
    • Net income
Menu type for users Single selection Indicates which menu type(s) is (are) shown for logged users who have this configuration.
  • Required when system default.
  • Available options:
    • Top and left menu (automatic);
    • Top menu only.

Note: Classic front-end only

Menu for voucher buying Single selection

Available options:

    • Banking
    • Marketplace
Redirect login to URL Text In case Cyclos is accessed from within another site (e.g. word press) the URL of that front-end needs to be set here.
URL to redirect after logout Text Same as above. If you want to redirect the user to an external site after logout.
Notify users when logging-in on new devices Boolean The user will get an notification (in Cyclos and by email) when there is a login from a new device.
Link generation script Single selection Link generation is also needed when you users login from a different site. It make sure that links that are sent in emails will point to the correct URL.

The link generation needs a script. An example can be found at the reference guide

  • Available options: Any 'Link generation' scripts that are defined
Link generation script parameters Text area Possible script parameters for link generation script
  • Only visible if Link generation script has a value
IP geolocation script Single selection IP geolocation is used to show the location of an IP (e.g. in: User - Management - IP addresses - details)
  • Example can be seen at the reference guide
  • Available options: Any Ip geolocation scripts defined
IP geolocation script parameters Text area The geolocation will need a script (see above)
  • Only visible if IP geolocation script has a value
Cache geolocation results for Time interval This is the time the IP location will be cached. This can diminish the costs of the geolocation services.
New frontend
Public API URL Text The front-end uses (just like the mobile app) the Restful API. It is possible to change the default (public) URL in this setting.
Front-end to use Radio button

Available options:

  • Classic
  • New

Note: Network administrators will always have to possibility to switch from the new to the classic front-end

Allow switching between front-ends Boolean The option in the new front-end can be find under the 'Personal - Settings' menu. It is also possible to create a dashboard item (shortcut).
Application title Text The title that will show up at the top left (next to the system logo)
Application title on mobile Text The title that will show up in the top bar of the mobile application.
Application menu title on mobile Text Title will show up in the top bar.

Note: The launch icon and title can be customized at mobile code level. Instructions are provided in the read-me file in the mobile download.

Mobile landing page Radio button Usually the landing page is the home page. To make the login process quicker the login page can be displayed directly with this setting.

Available options:

  • Login
  • Home
Split the top bar and the menu bar Boolean The top bar can be split in two bars, one with the quick access items (e.g. logout, shopping cart) and one with the menu items. Having two menus can be useful when there are many menu menu items (as there is more space).
Accounts in the dashboard Single selection If users can have more than one accounts they can be presented in different ways in the dashboard.

Available options:

  • Do not display accounts
  • Show one account per card
  • Show up to 4 merged accounts per card
Show latest users in dashboard Boolean This window will show the latest users that registered.
Show latest advertisements in dashboard Boolean This window will show the latest advertisements that have been published.
Mobile application
Map preference Single selection
  • Required when system default.
  • Available options:
    • Show local map directly (search near me)
    • Show default map directly
    • Show filters first
Default zoom level Single selection
  • Available options: integer values from 0 to 18
  • Required when system default.
Show QR scan option at login page Boolean This will show a QR code icon at the top of the login page. The QR scan will initiate any action that is allowed (e.g. confirm payment or redeem voucher). If login in required for the operation the login credentials are requested in order to confirm the operation.
Enable Bluetooth printing Boolean This will add an option in the mobile settings menu to add an blue-tooth receipt printer.

See also Wiki page mobile printer

Url in the Apple store Text The URL pointing to the apple store where the mobile app is published.
URL in the Google Play store Text The URL pointing to the Google play store where the mobile app is published.
Firebase JSON private key Text area If Firebase is configured (to enable in app messaging) the private key needs to be provided here.

Note: The Cyclos mobile reference guide has detailed information about the Firebase configuration.

Maps & directory
Use Google maps Boolean Google maps can be used for locating users, advertisements and vouchers.
Google maps server API Text
Google maps browser API Text
Maximum users / advertisements on map Integer The maximum result that can be shown on map per request.
  • Required when system default.
  • It is used for:
    • User search
    • Advertisement search
Default map location (lat,lng) Text
Default zoom level on web Single selection
  • Required when system default.
  • Available options: Integer values from 0 to 18
Default filter for map directory Single selection
  • Allowed options
    • User profile Keywords
    • All profile multiple and single selection fields (does not include dynamic section custom fields)
Account number (only visible in global or network default configurations)
Enable account number Boolean When checked, indicates that account number settings will be defined for this configuration.
Mask Text The mask used for input and formatting of account numbers.

This masks can restrict which characters will be generated, the size and the format, using the following constructors.

  • #, 0 or 9 - A number.
  • a or A - A letter.
  • ? or _ - Any character.
  • l or L - A lowercase letter.
  • u or U - An uppercase letter.
  • c or C - A capitalized letter. (only the first letter will be capitalized. Ex: using ccc on the mask will result in something like Abc)
  • \\, \#, \0, ... - Those literal characters. Remember that, when you write a string, '\\' means a single backslask. To use a backslash on the mask, you need 4 on the string.

An account number example would be: UUU-########

It will generate account numbers like: ABC-12345678

  • Only visible if 'Enable account number' is true
Script to generate numbers Single selection Custom script used to generate account numbers
  • Only visible if Enable account number is true
  • Possible options: any scripts of type 'Account number generation'
Script parameters Text area Parameters passed to the custom script
  • Only visible if Enable account number is true
  • Only visible if there is an account number generation script
Custom session handling (only visible in global or network default configurations)
Enable custom session management Boolean The cyclos session mechanism can be customized. We advice only to do it with solid knowledge of the session mechanism, and only if it is really needed
Session handling script Single selection
  • Only visible if Enable custom session management is true
  • Possible options: any scripts of type 'Session handling'
  • Required
Script parameters Text area
  • Only visible if Enable custom session management is true
  • Only visible if Session handling script has a value
E-mails
Host Text The URL or IP address of the SMTP server.
  • Required for global default configurations.
Port Number The SMTP port.
  • Required for global default configurations.
User Text The SMTP user. Not used when empty.
Password Password The SMTP password. Not used when empty.
Security protocol Radio Available options:
  • Unencrypted (Default)
  • STARTTLS
  • SSL/TLS
Max. mailing recipients (against spam) Integer
From address on sent e-mails Text The address used for sent e-mails. Always visible when the user receives the email.
  • Required for global default configurations.
Display name on sent e-mails Text The displayed name which can be seen in sent e-mails. Always visible when the user receives the email.
  • Required for global default configurations.
Outbound SMS messages
Enable outbound SMS messages Boolean When checked, indicates that SMS gateway settings as a whole will be enabled for this configuration. The SMS gateway server settings can be set separatly for any child configuration if it is not locked in the father configuration. If it is locked in the father configuration, the settings will be inherited to any child configuration.
Gateway URL Text Full URL of Gateway
  • Supported variables (built-in) are {number} (the international number), {national_number} national number, {country_code}, {message}
  • Only required if does not have a 'SMS sending script' defined
  • Only visible when 'Enable outbound SMS messages' is true.
HTTP username Text The username (given by gateway provider)
  • Only visible when 'Enable outbound SMS messages' is true.
HTTP password Password The password (given by gateway provider)
  • Only visible when 'Enable outbound SMS messages' is true.
HTTP headers Text area
  • Only visible when 'Enable outbound SMS messages' is true.
HTTP request type Radio POST or GET (depending on the method used by the gateway provider)
  • Only visible when 'Enable outbound SMS messages' is true.
HTTP request POST body Text area
  • Only visible when 'Enable outbound SMS messages' is true.
  • Only visible when 'HTTP request type' is POST.
Send ASCI characters only Boolean Only allow ASCI characters. ASCI characters with accents will be converted to normal ASCI characters.
  • Only visible when 'Enable outbound SMS messages' is true.
Character encoding Text This option allows to customize which encoding to use for both request parameters encoding and body.
  • Only visible when 'Enable outbound SMS messages' is true.
  • Only visible when 'Send ASCI characters only' is false.
  • Required
SMS sender script Single selection Custom script used to send SMS messages
  • Only visible when 'Enable outbound SMS messages' is true.
  • Possible options: any scripts of type 'Outbound SMS sending'.
  • Only visible when 'Send ASCI characters only' is false.
Script parameters Textarea Parameters passed to the custom script
  • Only visible when 'Enable outbound SMS messages' is true.
  • Only visible if there is a 'SMS sender script' selected
Maximum global messages per month Integer The the total maximum of SMS for all the users that use this configuration.
  • Only visible when 'Enable outbound SMS messages' is true.
Maximum global messages per unregistered phone Integer The the total maximum of SMS for all the users that use this configuration.
  • Only visible when 'Enable outbound SMS messages' is true.
Restrictions
Allow access Single selection
  • Required when system default.
  • Possible options:
    • From this URL or URLs of parents configurations
    • From this URL only
    • From any URL

Note: There are various use cases for these options. For example, it is good practice to create a specific configuration for administrators, and set a difficult to guess URL path in the configuration with the Allow access option set to: 'From this URL only'.

Maximum upload size File size The maximum size accepted for uploads.
  • Required when system default.
Maximum full image dimensions Integer (range) The maximum dimensions (resolution) for uploaded images. Images larger than these will be resized.
  • Required when system default.
Maximum medium thumbnail dimensions Integer (range) The maximum dimensions for medium thumbnails.(for example detail page advertisement or profile)
  • Required when system default
  • Classic front-end only
Maximum small thumbnail dimensions Integer (range) The maximum dimensions for small thumbnails.(for example results list tiled view)

Examples: User and ads results

  • Required when system default
  • Classic front-end only
Maximum tiny thumbnail dimensions Integer (range) The maximum dimensions for tiny thumbnails.(for example results list bullet view)
  • Required when system default
  • Classic front-end only
Maximum PNG images size File size The maximum size accepted for PNG images. PNG images larger than this size will be converted to JPEG.
  • Required when system default.
JPEG images quality Integer
  • Required when system default.
  • Maximum allowed value: 100
Maximum temporary images for authenticated users Integer I some page images can be uploaded (e.g. advertisement or profile) but they are only saved to the database when user clicks on the button 'Save'. Before the advertisement (or any entity that has an image upload and a save button) has been saved the images will remain in cache. In this setting the maximum of images in cache can be defined.
  • Required when system default.
Maximum temporary images for public registration (per IP address) Integer Same as above, but for non logged users.
  • Required when system default.
Allow multiple system reports at once Boolean The report feature (Report - Reports - System Reports) can be quite heavy for a system with much data. This can have an impact on the performance, and therefore the number of options that can be select at once can be limited.
Maximum user identification attempts (login) per hour Integer
Maximum user identification attempts (receive payments) Integer
After failing login names, block remote IP for Time interval
Maximum blocked users per day by IP address Integer
  • Only visible at global or network default configurations.
After maximum blocked users reached, block remote IP for Time interval
  • Only visible at global or network default configurations.
Alerts
Given very bad references Integer When set, an user alert is generated when a member gives the defined amount of very bad references.


Received very bad references Integer When set, an user alert is generated when a member receives the defined amount of very bad references.
Notifications
Notification script Single selection It is possible to customize the notifications send to users. An example can be found in the Cyclos reference guide.
  • Possible options: any scripts of type 'Notification'.
Notification script parameters Text area
  • Only visible when 'Notification script' has a script selected
CAPTCHA
Provider Radio buttons
  • Required
  • Available options: Internal or reCAPTCHA V2
Text length Integer
  • Only visible when 'Provider' is 'Internal'
  • Required
Text color Color picker
  • Only visible when 'Provider' is 'Internal'
  • Required
Effect Radio button
  • Only visible when 'Provider' is 'Internal'
  • Required
  • Possible options:
    • Shadow
    • Fish-eye
    • Water
reCAPTCHA site key Text
  • Only visible when 'Provider' is 'reCAPTCHA V2'
  • Required
reCAPTCHA secret key Password
  • Only visible when 'Provider' is 'reCAPTCHA V2'
  • Required
Use captcha on registration Boolean
Use captcha on forgot password Boolean
Data visible to guests
Include in sitemap (used by web search engines) Boolean If you want the URL to be available to search engines (SEO) this option needs to be selected.
Search users on groups Multi selection When the user search is available for guests the groups that can be search in can be defined with this setting.
User directory (map) on groups Multi selection When the user search is available for guests the users of groups that can be shown on the map can be defined with this setting.
View profile on groups Multi selection Allows defining groups / group sets visible to guest users.
  • List of all possible groups and group sets.

The profiles of users belonging to these groups can be shown for guests.

User profile fields Multi selection The profile fields of users belonging to these groups can be shown for guests.
  • List of all possible user fields in the network.
Possible groups for public registration Multi selection Defines which groups can be used on public registration for guest users.
  • List of all possible groups.
Registration wizard for large screens Single selections Here you can select to show a wizard (with steps) instead of a single page registration form. This setting will be applied for registrations done from large screens sizes
Registration wizard for medium screens Single selection Here you can select to show a wizard (with steps) instead of a single page registration form. This setting will be applied for registrations done from medium screen sizes.
Registration wizard for small screens Single selection Here you can select to show a wizard (with steps) instead of a single page registration form. This setting will be applied for registrations done from small screen sizes.
Forgotten passwords retrieval Single selection
  • Possible Options:
    • Disabled
    • Enabled
    • Enabled with security question
Require security question on registration Boolean
  • Currently the user can chose from 3 security questions, which are fixed.
    • What was the name of your first pet?
    • What was the first name of your maternal grandmother?
    • What was the name of your elementary / primary school?
  • Only visible if 'Forgotten passwords retrieval' is 'Enabled with security question'
Forgotten passwords medium Radio buttons
  • Only visible if 'Forgotten passwords retrieval' is 'Enabled' or 'Enabled with security question'
  • Possible Options:
    • Send by mail
    • Send by SMS
    • Both
Menu type for guests Single selection
  • Possible options
    • Top and left menu (automatic)
    • Top menu only

Note: Classic front-end only

Visible advertisement groups Multi selection The advertisement search results will be limited to advertisements of the selected groups (in this setting).

Note: Show simple/webshop ads must be enabled (see settings further below)

Visible ad fields Multi selection Define what custom advertisement fields can be seen by guests.
  • Possible options: Any 'Custom advertisement field'
Show simple ads Boolean If selected simple ads (non web-shop) will show up in the guests page (non logged users).
  • Only visible if has at least a 'Visible advertisement groups' selected
Show web-shop ads Boolean If selected web-shop ads will show up in the guests page (non logged users).
  • Only visible if has at least a 'Visible advertisement groups' selected
Hide advertisements owner to guests Boolean Don't show advertisement owner to guests (login is required to see all advertisement details)
Hide advertisements price to guests Boolean Don't show advertisement price to guests (login is required to see all advertisement details)
Custom users search menu label Text Allows a customized label used for the user search in the menu for guests.
  • Only visible if has at least a 'Search users on groups' selected
Custom advertisement search menu label Text Allows a customized label used for the advertisement search in the menu for guests.
  • Only visible if has at least a 'Visible advertisement groups' selected
Dynamic OpenID Connect / OAuth 2 clients
Dynamic OIDC clients Boolean Select to overwrite higher level configuration setting
Enable dynamic OIDC clients Boolean Enable dynamic (user generated) OIDC clients


Allow non HTTPS connections Select box


Permissions (scopes) Multi select Types of allowed operations
Allowed account types Multi select
Allowed payment types Multi select
Allowed ticket types Multi select
Single payment per consent
Access token expiration
Logging (Only visible for Global or Network default configurations)
Tasks logging Radio button Tasks logging will log all scheduled tasks (recurring and background tasks).

Please be aware that both recurring and background and tasks have tabs with an execution log and a history log. This is the recommend place to retrieve information about the tasks. The task logging should only be used in case for in-depth analyses and trouble shouting. Much care should taken with the verbose logging setting, as it will generated a large amount of data.

  • Possible options:
    • Off
    • Regular (recommended)
    • Verbose
  • Only available in global mode
  • The logging settings in at hosting level (in the cyclos.properties file) will define where and how is logged (e.g. in file, database or terminal, and what directories in case of file logging). The settings in the Cyclos configuration define 'what' is logged.
  • The reason that some logging settings are done in the configuration is that you can fine tune the setting per network. For example, a network with test data would not need logging, so you can disable the logs and save data traffic and storage.
Enable services logging Boolean All operations in Cyclos a part from a service. Enabling service logging will log those operations, for example a 'Search User' operation.
Log parameters on services Boolean This will log also the parameter of the service. For example, continuing the above example (Search User), it will also log the search variables/filters that were used in the search.
  • Only visible if 'Enable services logging' is true
Log results on services Boolean This will log also the result of the service. For example, continuing the above example (Search User) it will also log the search result.
  • Only visible if 'Enable services logging' is true
Log services for guests Boolean This will log also the services for guests (non logged users)
  • Only visible if 'Enable services logging' is true
Log writes only in services Boolean This will skip the read only services requests, and will result in much smaller log sizes.
Maximum error log entries Integer Defines the maximum of error log entries in Reports - Alerts & Logs - Error logs.

The number of maximum logs that will be returned. Older logs will be removed. Zero means unlimited.

  • Only visible for Global default configurations
  • Required

Channels (Tab)

The channels are described in a dedicated wiki page.

Retrieved from "https://wiki.cyclos.org/index.php?title=System_-_Configurations&oldid=22860"