Roles and connections

After selecting Edit folder from the folder's context menu, use the Roles and connections tab to change details of connections.

Roles and connections

This provides a lookup of connections used by the folder, assigning each to a role.

The config role is used to configure the functionality of the folder. In Relay, the config role is set to the Relay module connection. This is set automatically, and you should not need to change it.

Some advanced features or custom features may require you to set roles and connections manually. It is possible to associate a role with the folder by entering the role and selecting the Folder role option.

Roles and connections are copied down the folder hierarchy. A folder can have more than one connection with the same role, and this can happen inadvertantly by copying a role from a parent folder. To prevent this happening, set the role and select ** Do not copy connection from parent group **. This is particulary required when a Relay-like custom module is used alongside Relay. In this case, there needs to be two config entries, one with the do not copy option, and one to connect to the custom module. The do not copy entry must come first.

Address book

Connection folders have an additional field for entering an address book.

The address book is entered as a two-column table, with name and path.

You can use this to direct tasks to different individuals or groups at the partner organisation. For example, if you wanted to send work to a quality management group, you could set up a name of Quality management. You can leave the path blank to use a suitable default, or set a suitable path value yourself.

When you want to assign work to that group, it will appear as a prefix, such as "Quality management@ACME Limited".

At the partner end, work sent to different address book entries is put in different folders within the connection folder at their end of the connection. It is up to the partner to set up permissions to ensure that the correct individuals or groups receive the correct incoming tasks, and you should work with the partner to define a structure that makes sense.

You can use a path with slashes to create multiple levels of folder at the partner end.

Use Enter to create a new row on the table, and right click in the table to see more option.

If you set any address book entries, you won't be able to send to the top-level connection folder. If you want to do this, include a row with a name of * and a path of /.

Remember to Save or Apply your changes.