Set Service Exchange user roles and organizations

In order for Service Exchange to run correctly, you need to set SX user roles and organizations to allow viewing of SX management and testing UIs.

SX has both management pages and a Testing UI. The management pages include the Content Management UI, the Testing UI includes for example the order wizard.

The two UIs have a similar configuration but the Testing UI is shipped separately as a part of the SDK package. See the SX SDK package documentation for details on how to install it.

These UIs are only accessible by users having certain roles. The roles recognized by SX are described in the following table.

Users are associated with roles in the users.json configuration file, located at [%SX_HOME%]/WEB-INF/config/users.json.

To assign or change SX user roles, refer to the following example configurations.

A simple example configuration:

{
    "Provider": {
        "sxCatalogTransportUser": {
            "roles": [
                "CONSUMPTION"
            ]        
        },
        "admin": {
            "roles": [
                "ADMINISTRATOR"
            ]
        }
    }
}

The file structure reflects the organization structure. In this example the Provider is at the top level, with two users with their roles underneath. A user name can also be * which means all users within the organization will have the same roles. When multiple entries match a user all their roles are merged together.

A more complex example:

	{

            "CONSUMER": {
	       "admin" : {
           	  "roles": [
                    "ADMINISTRATOR"
                  ]
              },
              "*": {
                   "roles": [
                      "UI"
            	   ]
        	}
	  },
   	     "Provider": {
                "sxCatalogTransportUser": {
            	    "roles": [
                       "CONSUMPTION"
            	   ]        
        	}
    	     }
	}

In this example all the users of the CONSUMER organization have access to the testing UI for creating orders, and the admin user also has access to the administration section.