System - Networks

From Cyclos4 Wiki
Jump to: navigation, search

Related sub-modules

Not applicable.

Description

Networks are the highest level categorization in Cyclos. A quick explanation can be found at the Concepts network section.

Business rules

Global administrators

  • The management of networks (e.g. creating, removing) is done by users that belong to the build-in 'global administrators' group.
  • When a network is created (by a global or multi network administrator, or via de API) there will be one build in group called 'network administrators', these network administrators have some fixed permissions (see Users_-_Groups).
  • Global administrators can switch to a network. When switched to a network the global or multi network administrator will have the same permissions as the 'network administrators' group.


Multi network administrators

  • Administrators belonging to group created at global level are part of a 'Multi network admin' group. Be aware that these multi network groups are listed in the same list as the build-in 'Global administrators' group. Multi network admins can be given permissions to manage specific networks. The can also be given permissions to create new Networks, in which case they can manage automatically.
  • Multi network administrators can switch among the networks they manage from the network list or the network switcher at the status menu.


Network scope

  • All users in the system that are not part of a global or multi network admin group will operate automatically from within a network 'scope', the network will appear (and respond) as a single system (interoperability will be available through 'global' entities, as explained further on).
  • The 'network administrators' can create new administrator groups in there network. Together with these groups the 'network administrators' manage the network.


Local and global entities

  • Most entities are local, what means they can only be managed, and even only viewed at local (network) level. Examples of local entities are products, agreements, record types, message categories, advertisement categories etc.
  • Example of global entities are Groups, languages, configurations, channels, phone schemes, system images and account related entities (in order to have a quick overview of all global entities you can just enter as a global admin).
  • Apart from the management of local network entities, a local (network) administrator can see and 'use' all global entities, but cannot edit or remove them. The global entities are simply 'available' for local use. For example, profile fields can be defined globally. The network admin will just select the profile fields he/she wants to use in the local product. And add custom profile fields if needed.
  • Groups and configurations defined at the global level are special cases. They are global but not visible at network level.
  • In some cases the global admin as network admin have access the same feature (e.g error logs). But the global admin will see all errors in the system, and the network admin only errors that were generated within their network scope


Note: The concept of local and global entities might seem complex. But for the network admin it is quite straightforward. For the network admin there will be just some entities that he/she cannot modify. They will behave simply as 'build-in' entities. That can either be used or not.


Access

  • A global administrator can create and manage networks via the menu (System Management - Networks). From the Network details page the global admin can change the Network properties, for example the name and access URL.
  • In order for a global admin to manage the network itself (e.g. creating and managing groups, accounts, products, user etc) the global admin needs to enter the network via the a single select 'switcher' at the right top menu (between logged user and logout options). Selecting 'Global administration' will bring the admin back to the global administration mode. (the switcher option is just an 'extra' to avoid global admins having to create local admins for each network they want to manage)
  • A network administrator will never see any options concerning other networks. A network admin won't even need to have knowledge of the existence of other networks.


Interoperability (Cyclos4.1 or later)
In network details there will be an option ‘accessible networks’. This should show a two level select option, networks and the groups within the networks. (similar to the groupset/group multi select). This way a global admin can allow groups from specific networks to do operations (e.g. payments) among them. Of course the admin will first need to create a global currency, account etc. The network admin will need to add the account and inter transaction type to a local product.


Note: Global accounts will work slightly different than local accounts. For example, transaction fees on global accounts cannot be applied for specific users and groups (as in local accounts), but only to networks.

Notifications

When a new network is created an notification will be sent. The idea is that in the future system admins can be assigned specific networks to manage, and also have the permission to create new networks, which they obviously can manage. Those system admins will be probably 'Cyclos service providers' that won't have 'full' system admin permissions such as creating new channels and password types. When a new network is created a full system admin might want to be informed when a new network has been created.

Page: Network List

Security

Roles:

  • Global admin

View permission:

Other permissions:

Page sections

Permissions

Search page (filters)

Fields Type Rules
Name Text Allows the admin to search for a network with a specific name.
Managed by Single selection with global admin groups Allows the admin to show the networks assigned to a specific global admin group
  • Default value "all".
New Button Navigates to the network details page to add a new network, for the selected type.
  • Displayed on the left (first item).


Search result (list *)

* Automatically shows all networks, sorted by default at creation date.
* Above the list at the lieft is a sort button (similar to users search) with the option to sort by creation date or alphabetically.
* Disabled networks are shown striped trough in the search result list.

Fields Type Rules
Name Text The network name.
Default Icon Show which network is the default network. There can be only one default network. This network will not fall in the global mode when the main URL is accessed. For example communities.cyclos.org will fall in the network 'communities' because it is defined as default. If this would not be the case it would fall in the global URL (communities.cyclos.org/global).
Remove Icon Removes this Network. Only possbile the Network has neven been used (has no data)


Page: Network details

Security

Roles:

  • Global admin

View permission:

Other permissions:

Page sections

Details page

Fields Type Rules
Name Text Here you can specify the name of the network.
  • Maximal 50 characters.
  • Required.
Internal name Text Here you can specify the internal name of the network. This is necessary for the webservices
  • The internal name can only be defined at global level (not by a network admin). A network can allways be accessed by the global URL and intername as path. Even if the root URL in the default configuration of the network has been modified.
  • Maximal 50 characters.
  • Required.
Enabled Boolean Allows the administrator to disable/enable the group.
  • Checked by default as enabled;
  • If disabled, not any related entity/information about network is available in Cyclos
Default Boolean Allows the administrator to set the network as default network. See the network matching rules on #Business_rules.
  • When a network is set to default, the previously default network (if any) will have the default flag removed.
  • Only visible for global admins (multi-network admins cannot change, only view this value)
Parent configuration Single select Defines the configuration which will be parent of the network's default configuration.
  • As options, should show all global configurations.
  • Required and editable on insert. Read-only on edit.
Managed by groups Links Shows a link for each of the groups which manage this network
Switch to this network Action button Allows to switch to the network. Visible after the network is saved and enabled.
Save Action button Saves the network