Channels

Channels

This wiki page explains the Channels configuration, which can be found in the 'Channels' tab in any configuration. Be aware that there is also a 'Manage channels' page (in menu: System - System configuration - Channel) which contains a list with the built-in channels and the option to create custom channels. Manage channels are explained in the Manage Channels wiki page.
tab shows a list for each available channel (those which were not disabled in parent configurations).

A product is usually assigned to all channels, but it is possible to restrict a product to certain channels (product setting: Product applied to channels).
In the same way a transfer type can be restricted to use specific channels (Transfer type setting: Applicability - Channels)

Permissions

As channels are part of a configuration (it is a 'tab' in the configuration details) the permissions that apply to configurations are the same for channels. There permissions for configurations and channels are defined in an admin group or product under the configuration section - field 'system configuration'.
There are three options, none, view and manage.

When manage is selected the admin group can manage all configurations in the network (this is the fixed option for the network administrator group).
When manage is selected the admin group can manage all configurations in the network.
When view is selected the admin group can view all configurations in the network but manage only the selected (with the option 'Manage specific configurations')
When none is select the admins of the admin group cannot view or manage any configuration. This is a typical setting for operational admin groups.

Channels list

This list contains the built-in channels and possible custom channels.

Column	Type	Rules
Channel name	Text	The channel name
Enabled	Yes / No	Defines whether the channel is enabled for users in this configuration (or inherited configurations). If a configuration disables a channel, that channel will not be accessible by any child configurations.

Main

Fields	Type	Rules
Edit / Customize	Image button (Icon)	Defines whether the channel will be customized in this configuration (when checked) or inherit definitions from the parent configuration (when unchecked).
Enabled	Checkbox	Defines whether the channel is enabled for users in this configuration (or inherited configurations).
Channel access
User access	Single selection	On the channel configuration it is possible to control the user access, which may be: Enabled by default: Users always can the channel and can disable it (in personal settings) Enforced enabled: Users can access the channel but not disable it
User identification methods	Multi selection	The identification methods that are allowed to access the current (selected) channel
Default user identification method	Single selection	The default identification method for accessing the current channel (will be shown pre-selected at the login page).
Identity providers	Multi selection	Identity providers allowed to login to Cyclos (e.g. Facebook or Google) For more information on identify providers see the wiki page.
Registration with identity providers	Single selection	Allow registering (in Cyclos) with external identity providers (e.g. Facebook or Google) For more information on identify providers see the wiki page.
Access password	Single selection	Password type used to access cyclos via current channel Contains all password types (see Access - Password types)
Login confirmation method	Single selection	The method used for login confirmation
Login confirmation password	Single selection	The password type used for login confirmation
Confirmation method	Single selection	Extra password can be required for sensitive operations (e.g. performing payments). Contains all password types (see Access - Password types)
Confirmation password	Single selection	Extra password can be required for sensitive operations (e.g. performing payments). Contains all password types (see Access - Password types)
Request confirmation once per session	Single selection	If an operation (e.g. payment) did require a confirmation password and the password was entered successfully the user will not be asked again to provide a confirmation password within the same session. Only available when confirmation password is enabled
Skip confirmation for trusted sessions	Single selection	If the user session (login) was confirmed by a trusted device (typically mobile with Cyclos mobile app), than the confirmation password will be skipped. Only available when confirmation password is enabled
Session timeout	Time interval	Defines how long sessions lasts before they are invalidated. The user will be logged out when the session expires.
IP address whitelist	Multi line text	Allows specifying a list with IP addresses from which the channel can be accessed. When the check box is not checked no IP restrictions are enabled. Global administrators can also allow specific IP address on a system wide level (System - Users - Management - IP addresses)
Perform payments
User identification methods for performing payments	Multi selection	Contains the identification methods (see Access - Principal types) (except for access clients) that will be used to identify payment receivers in the payment form.
Show QR-code scanning	Checkbox	QR code icon will be shown in the payment form. It will open the camera for QR code scanning (to identify the payment receiver)
User autocomplete on perform payments	Checkbox	Defines whether the User autocomplete will show up on the payment form.
Contacts on perform payments	Checkbox	Defines whether the Contact selection will show up on the payment form.
Default on make payments	Radio button	Defines what is the default when making a payment. Options: Autocomplete - the default is the User autocomplete. Can only be selected if "User autocomplete on perform payments" is checked. Contacts - the default is the Contacts selection. Can only be selected if "Contacts on perform payments" is checked. Identification method - The default is an specific identification method.
Default identification method for performing payments	Single selection	Defines which is the default identification method Only visible when "Default on make payments" is set to "Identification method" and when one or more options are selected in "User identification methods for performing payments".
Receive payments (POS)
User identification methods for receiving payments	Multi selection	Contains the identification methods (see Access - Principal types) (except for access clients) that will be used to identify payers in the receive payment form.
Show QR-code scanning	Checkbox	QR code icon will be shown in the payment form. It will open the camera for QR code scanning (to identify the payment receiver)
User autocomplete on receive payments	Checkbox	Defines whether the User autocomplete will show up on the receive payment form.
Contacts on receive payments	Checkbox	Defines whether the Contact selection will show up on the receive payment form.
Default on receive payments	Radio button	Defines what is the default when receiving a payment. Options: Autocomplete - the default is the User autocomplete. Can only be selected if "User autocomplete on receive payments" is checked. Contacts - the default is the Contacts selection. Can only be selected if "Contacts on receive payments" is checked. Identification method - The default is an specific identification method.
Default identification method for receiving payments	Single selection	Defines which is the default identification method, and is only visible, when "Default on receive payments" is set to "Identification method". Shows up only if the option "Identification method" is set in "Default on make payments" and one more more options are selected in "User identification methods for receiving payments".

Web services

Fields	Type	Rules
Edit / Customize	Image button (Icon)	This field is the same as in the main channel. For explanation select link (Fields column at the left)
Enabled	Checkbox	Idem
Show QR code for User identification methods	Checkbox	Allows generating a QR (via the API) to identifier the receiver or payer.
Channel access
User access	Single selection	Idem
User identification methods	Multi selection	Idem
Default user identification method	Single selection	Idem
Identity providers	Multi selection	Idem
Registration with identity providers	Single selection	Idem
Access password	Single selection	Idem
Login confirmation method	Single selection	Idem
Login confirmation password	Single selection	Idem
Confirmation method	Single selection	Idem
Session timeout	Time interval	Idem
IP address whitelist	Multi line text	Idem
Perform payments
User identification methods for performing payments	Multi selection	Idem
Show QR-code scanning	Checkbox	Idem
User autocomplete on perform payments	Checkbox	Idem
Contacts on perform payments	Checkbox	Idem
Default on make payments	Radio button	Idem
Default identification method for performing payments	Single selection	Idem
Receive payments (POS)
User identification methods for receiving payments	Multi selection	Idem
Show QR-code scanning	Checkbox	Idem
User autocomplete on receive payments	Checkbox	Idem
Contacts on receive payments	Checkbox	Idem
Default on receive payments	Radio button	Idem
Default identification method for receiving payments	Single selection	Idem

OAuth2 / OpenID Connect

Fields	Type	Rules
Edit / Customize	Image button (Icon)	This field is the same as in the main channel. For explanation select link (Fields column at the left)
Enabled	Checkbox	Idem
Channel access
User access	Single selection	Idem
User identification methods	Multi selection	Idem
Access password	Single selection	Idem
Perform payments
User identification methods for performing payments	Multi selection	Idem
Show QR-code scanning	Checkbox	Idem

SMS

Fields	Type	Rules
Edit / Customize	Image button (Icon)	This field is the same as in the main channel. For explanation select link (Fields column at the left)
Enabled	Checkbox	Idem
Channel access
User access	Single selection	Idem
Access password	Single selection	Idem
IP address whitelist	Multi line text	Idem
Perform payments
User identification methods for performing payments	Multi selection	Idem
Show QR-code scanning	Checkbox	Idem
Default identification method for performing payments	Single selection	Idem
Inbound SMS
Inbound SMS URL	Text	The (Cyclos) URL that will be invoked by an SMS Gateway provider in order to deliver an 'inbound' SMS to Cyclos. No editable.
Mobile number source	Text	The name of the GET or POST field that specifies the caller ID of a message. The value needs to be in curly brackets. For example, the value "{phone}" means that the Inbound SMS URL has a variable "phone" that contains the phone number (caller ID). This variable will differ per gateway provider (and needs to be informed by the provider) Required when the channel is enabled
SMS message source	Text	The name of the GET or POST field that specifies the text of the SMS The value needs to be in curly brackets. For example, the value "{message}" means that the Inbound SMS URL has a variable "message" that contains the message text. This variable will differ per gateway provider (and needs to be informed by the provider)
User identification in operations	Single selection	This option determins how the destination user is identified in the payment operation. Possible values are Mobile phone number, or Login name
HTTP username	Text	SMS gateway providers usually allow specifying a HTTP user name and Password in the delivery URL for enhanced security. If used, the HTTP username and password in the URL must be the same as specified here.
HTTP password	Text	See above
Script	Single selection	Custom script. Optional Only shows scripts of type "Inbound SMS handling".
Script parameters	Text area	Parameters passed to the script, with the same format as Java Properties

SMS Operations

List

Name	Type	Rules
Add operation	Single select button	Gives the option to create a custom SMS operation or an Info text
Name	Text	Operation name
Aliases	Text	This are the aliases (words) separated by comas that will invoke the corresponding operation.
Type	Text	The type indicates the operation type. There are three operation types: Built-in - Operations that come with the system. Text - Operation that returns a text corresponding to the alias sent to the system. Custom - Custom operation
Enabled	Yes / No	Operations can be disabled or enabled (in the operation details) page. This field will show if the operation is enabled or not. Yes - Operation is active and will be invoked when message with alias is received. No - The system will ignore messages with aliases specified in the operation.

Account information

Name	Type	Rules
Enabled	Boolean	If selected the operation is activated.
Aliases	Text	The aliases are one or more words (separated by comma's) that will invoke the operation. The alias(es) are sent to the system in the message text. For example: If no password is used (option below) and the aliases is 'ai', 'accountinfo' a SMS message with either 'ia' or 'accountinfo' will return the account information of the user.
Use password	Check box	When checked the user has to put a password (or PIN) in the message in order for the operation to work. Example of operation SMS message: 'ai 1234' Example message explanation: 'ai' is the alias, and '1234' is password (required in this example). For more information about passwords see ( Access password)
Account type	Single selection	This selection shows a list with available account types (related via this congiruation - user group - product - account types). The SMS operation will return information about the selected account type.

Payment

Name	Type	Rules
Enabled	Boolean	If selected the operation is activated.
Aliases	Text	The aliases are one or more words (separated by comma's) that will invoke the operation. The alias(es) are sent to the system as message text.
Use password	Check box	When checked the user has to put a password (or PIN) in the message in order for the operation to work.
Payment type	Single selection	Specifies what payment will be used for SMS payments. The selection list will show all transfer types that have the channel SMS selected. The payment operation format is: alias(es) password (if enabled) destination user (login name or phone nr, depending on channel configuration) amount. Example: pay 1234 some_user 12,34 Example explanation: 'pay' is the payment alias, '1234' is the payer's password, 'some_user' is the destination user and '12,34' is the payment amount (decimal separation in amount can be either comma or dot).

Info text

Name	Type	Rules
Name	Text	Operation name
Enabled	Boolean	If selected the operation is activated.
Aliases	Text	The aliases are one or more words (separated by comma's) that will invoke the operation. The alias(es) will be sent by users to the system as message text.
Text	Text	Respond text The info text operation format is simply: 'alias' Example: 'promotion' Example explanation: 'promotion' is the alias defined. It would return a SMS message with some promotion text (defined in the 'text' field).

User registration

Name	Type	Rules
Name	Text	Operation name
Enabled	Boolean	If selected the operation is activated.
Aliases	Text	The aliases are one or more words (separated by comma's) that will invoke the operation. The alias(es) will be sent by users to the system as message text.
Group	Single select	Here you can chose the group the users will belong to. The drop down select will show all user groups that have the configuration selected. Operation format: 'alias password loginname username' Example registration message: 'reg 1234 user1 User one' Where: reg: alias 1234: password (can be used for login at web interface, if password type is defined as generated no password input is required). user1: the login name of the user User one: the real (full) name of the user 'promotion' is the alias defined. It would return a SMS message with some promotion text (defined in the 'text' field).

Custom SMS Operation

Name	Type	Rules
Name	Text	Operation name
Enabled	Boolean	If selected the operation is activated.
Aliases	Text	The aliases are one or more words (separated by comma's) that will invoke the operation. The alias(es) are sent to the system in the message text.
Java class	Text	This is the package or class that implements the custom command. The class needs extend the class: org.cyclos.impl.utils.sms.BaseSmsoperation. For operations that don't require the common methods defined in the Base operation class it is possible to implement just the interface: org.cyclos.impl.utils.sms.SmsOperation

Pay at POS

Fields	Type	Rules
Edit / Customize	Image button (Icon)	This field is the same as in the main channel. For explanation select link (Fields column at the left)
Enabled	Checkbox	Idem
Channel access
User access	Single selection	Idem
Confirmation method	Single selection	Idem
Confirmation password	Single selection	Idem

Mobile app

Fields	Type	Rules
Edit / Customize	Image button (Icon)	This field is the same as in the main channel. For explanation select link (Fields column at the left)
Enabled	Checkbox	Idem
Show QR code for User identification methods	Checkbox	Idem
Channel access
User access	Single selection	Idem
User identification methods	Multi selection	Idem
Default user identification method	Single selection	Idem
Identity providers	Multi selection	Idem
Registration with identity providers	Single selection	Idem
Access password	Single selection	Idem
Confirmation password	Single selection	Idem
Request confirmation once per session	Select box	Idem
Skip confirmation for trusted sessions	Single selection	Idem
Users need to login before confirming operations with trusted devices	Select box	If this option is selected the user will need to login with his credentials after scanning the QR code
Only allow login of trusted devices	Select box	If a user login (the mobile) without having made the device trusted he will be prompted to make the device trusted (by email confirmation). The user can only login once the device as been made trusted.
Suggest to make the device trusted on login	Select box	This is the number of times the user will be suggested to make the device trusted (confirmed by email one time password). A trusted device offers extra security. A trusted device can be give more permissions (e.g. skip payment confirmation password) and it can be used to confirm operations done at the web channel (e.g. login and payment)
Session timeout	Time interval	Idem
Enable device PIN	Select box	A device PIN can be used instead of a password. As it is stored securely in the device. It is considered more secure than a password, and can therefore be more simple (numbers only). Therefore it is good policy to enable device PIN. It can work together with the fingerprint login
PIN length	Integer	The length of the PIN (numbers only)
Maximum PIN tries	Integer	The is the number of maximum tries until PIN is disabled. If this happens the user will need to login with another identification method (e.g. password or fingerprint) and create a new PIN. A dialogue box with instructions how to do this is shown when the max failed PIN attempts is reached.
Suggest to activate PIN on login	Single Select (0-9)	This is the number of times the user will be suggested to enter and activate a device PIN.
PIN expires after	Time interval	When the PIN expires the user will be asked to type in a new PIN.
IP address whitelist	Multi line text	Idem
Perform payments
User identification methods for performing payments	Multi selection	Idem
Show QR-code scanning	Checkbox	Idem
User autocomplete on perform payments	Checkbox	Idem
Contacts on perform payments	Checkbox	Idem
Default on make payments	Radio button	Idem
Default identification method for performing payments	Single selection	Idem
Receive payments (POS)
User identification methods for receiving payments	Multi selection	Idem
Show QR-code scanning	Checkbox	Idem
User autocomplete on receive payments	Checkbox	Idem
Contacts on receive payments	Checkbox	Idem
Default on receive payments	Radio button	Idem
Default identification method for receiving payments	Single selection	Idem

Ticket

Fields	Type	Rules
Edit / Customize	Image button (Icon)	This field is the same as in the main channel. For explanation select link (Fields column at the left)
Enabled	Checkbox	Idem
Channel access
User access	Single selection	Idem
Login on payment confirmation page	Single selection	By default it tickets can be paid via the web interface without the need to login to the main web interface, but the simplified ticket page that can be found at the /pay URL path. It is possible to confirm ticket payment by login and QR code scanning. With this setting it is possible only allow QR code scanning by mobile, which is considered more secure (as mobile devices can be enabled as 'trusted device').
User identification methods	Multi selection	Idem
Default user identification method	Single selection	Idem
Access password	Single selection	Idem
Confirmation method	Single selection	Idem
Confirmation password	Single selection	Idem
Request confirmation once per session	Checkbox	Idem
Skip confirmation for trusted sessions	Checkbox	Idem
Session timeout	Time interval	Idem
IP address whitelist	Multi line text	Idem

Easy invoice

Fields	Type	Rules
Edit / Customize	Image button (Icon)	This field is the same as in the main channel. For explanation select link (Fields column at the left)
Enabled	Checkbox	Idem
Channel access
User access	Single selection	Idem
Login on payment confirmation page	Single selection	Idem
Easy invoice payer identification methods	Multi selection	Allowed identification methods for the payer of the easy invoice (as variable in URL)
Easy invoice receiver identification methods	Multi selection	Allowed identification methods for the receiver of the easy invoice (as variable in URL)
Access password	Single selection	Idem
Confirmation method	Single selection	Idem
Confirmation password	Single selection	Idem
Request confirmation once per session	Checkbox	Idem
Skip confirmation for trusted sessions	Checkbox	Idem
Session timeout	Time interval	Idem
IP address whitelist	Multi line text	Idem

Custom channel

Fields	Type	Rules
Edit / Customize	Image button (Icon)	This field is the same as in the main channel. For explanation select link (Fields column at the left)
Enabled	Checkbox	Idem
Show QR code for User identification methods	Checkbox	Idem
Channel access
User access	Single selection	Idem
User identification methods	Multi selection	Idem
Default user identification method	Single selection	Idem
Identity providers	Multi selection	Idem
Registration with identity providers	Single selection	Idem
Access password	Single selection	Idem
Login confirmation method	Single selection	Idem
Login confirmation password	Single selection	Idem
Confirmation method	Single selection	Idem
Confirmation password	Single selection	Idem
Request confirmation once per session	Select box	Idem
Session timeout	Time interval	Idem
Enable device PIN	Time interval	Idem
PIN length	Integer	Idem
Maximum PIN tries	Integer	Idem
PIN expires after	Time interval	Idem
IP address whitelist	Multi line text	Idem
Perform payments
User identification methods for performing payments	Multi selection	Idem
Show QR-code scanning	Checkbox	Idem
User autocomplete on perform payments	Checkbox	Idem
Contacts on perform payments	Checkbox	Idem
Default on make payments	Radio button	Idem
Default identification method for performing payments	Single selection	Idem
Receive payments (POS)
User identification methods for receiving payments	Multi selection	Idem
Show QR-code scanning	Checkbox	Idem
User autocomplete on receive payments	Checkbox	Idem
Contacts on receive payments	Checkbox	Idem
Default on receive payments	Radio button	Idem
Default identification method for receiving payments	Single selection	Idem