Engagement Center UI Configuration

Overview

The Engagement Center UI Configuration service is a mashup service that is used for handling configuration for the Engagement Center UI.

Using this service, you can handle:

  1. Tiles configuration
  2. The logo and the background image of the Engagement Center home page. The size of uploaded image is limited within 1 MB and only JPG, PNG, and JPEG formats are accepted.
  3. The UI layout of the engagement context in the Engagement Center (action area views, business document types, header area views, and work area views)
  4. Required scopes that enable the Agent Home to acquire an access token
  5. Modules configuration


API Reference

/{tenant}/objectViewExtension

The object view extension can be utilized to extend views of business document types.

/{tenant}/objectViewExtension

get

Get object view configurations of extended business document type views.

Required scope: hybris.cecenteruiconfig_view

put

Update object view extensions.

Required scope: hybris.cecenteruiconfig_manage

post

Create new object view extensions.

Required scope: hybris.cecenteruiconfig_manage

delete

Delete a object view extension.

Required scope: hybris.cecenteruiconfig_manage

/{tenant}/tilesConfig

Engagement Center tiles configuration.

/{tenant}/tilesConfig

get

Get configuration information of all tiles that the current user is authorized to see.

Different scopes may be required depending on which tiles need to be retrieved:

  • hybris.cecenteruiconfig_view Provide read-only access to Engagement Center UI configuration
  • hybris.cecenteruiconfig_customer_engage Provide access to the Engagement Context tile
  • hybris.cecenteruiconfig_ticket_backoffice Provide access to the Service Tickets tile
  • hybris.cecenteruiconfig_cctr_analytics_contact Provide access to the Interactions tile
  • hybris.cecenteruiconfig_cctr_analytics_queue Provide access to the Queues tile
  • hybris.cecenteruiconfig_cctr_analytics_agent Provide access to the Agents tile
put

Update tiles configuration.

Required scope: hybris.cecenteruiconfig_manage

post

Create default configuration for SAP pre-delivered tiles.

Required scope: hybris.cecenteruiconfig_manage

delete

Delete the configuration for the tiles.

Required scope: hybris.cecenteruiconfig_manage

/{tenant}/tilesConfig/{id}

delete tile configuration by id

delete

Delete the configuration for the tile by ID.

Required scope: hybris.cecenteruiconfig_manage

/{tenant}/tilesConfig/default

Default tile configuration

get

Get information about default configuration for all tiles that the current user is authorized to see.

Different scopes may be required depending on which tiles need to be retrieved:

  • hybris.cecenteruiconfig_view Provide read-only access to Engagement Center UI configuration
  • hybris.cecenteruiconfig_customer_engage Provide access to the Engagement Context tile
  • hybris.cecenteruiconfig_ticket_backoffice Provide access to the Service Tickets tile
  • hybris.cecenteruiconfig_cctr_analytics_contact Provide access to the Interactions tile
  • hybris.cecenteruiconfig_cctr_analytics_queue Provide access to the Queues tile
  • hybris.cecenteruiconfig_cctr_analytics_agent Provide access to the Agents tile

Logo image

/{tenant}/backgroundImage

Background image

/{tenant}/backgroundImage

get

Get background image that are currently configured in this service. The background image will be returned as a link to the the Media service.

Required scope: hybris.cecenteruiconfig_view

post

Upload a picture as background image and create a key-value pair in the Configuration service. Detailed information is returned by the Media service to store picture information.

Required scope: hybris.cecenteruiconfig_manage

put

Update background image and replace the picture information stored in the Configuration service. At the meantime, delete the old image information in the Media service.

Required scope: hybris.cecenteruiconfig_manage

delete

Delete the key-value pair that stores image information in the Configuration service and delete image information in the Media service.

Required scope: hybris.cecenteruiconfig_manage

/{tenant}/businessDocumentTypes

Business Document Types

/{tenant}/businessDocumentTypes

get

Get current business document types configuration data.

Required scope: hybris.cecenteruiconfig_view

put

Update business document types.

Required scope: hybris.cecenteruiconfig_manage

post

Post business document types.

Required scope: hybris.cecenteruiconfig_manage

delete

Delete business document types.

Required scope: hybris.cecenteruiconfig_manage

/{tenant}/businessDocumentTypes/default

Default business document types

get

Get default business document types configuration data.

Required scope: hybris.cecenteruiconfig_view

/{tenant}/workAreaViews

Work area views

/{tenant}/workAreaViews

get

Get work area views.

Required scope: hybris.cecenteruiconfig_view

put

Update work area views.

Required scope: hybris.cecenteruiconfig_manage

post

Post work area views.

Required scope: hybris.cecenteruiconfig_manage

delete

Delete work area views.

Required scope: hybris.cecenteruiconfig_manage

/{tenant}/workAreaViews/default

Default work area views

get

Get default work area views.

Required scope: hybris.cecenteruiconfig_view

/{tenant}/headerAreaViews

Header area views

/{tenant}/headerAreaViews

get

Get header area views.

Required scope: hybris.cecenteruiconfig_view

post

Create header area views.

Required scope: hybris.cecenteruiconfig_manage

put

Update header area views.

Required scope: hybris.cecenteruiconfig_manage

delete

Delete header area views.

Required scope: hybris.cecenteruiconfig_manage

/{tenant}/headerAreaViews/default

Default header area views

get

Get default header area views.

Required scope: hybris.cecenteruiconfig_view

/{tenant}/actionAreaViews

Action area views

/{tenant}/actionAreaViews

get

Get action area views.

Required scope: hybris.cecenteruiconfig_view

post

Create action area views.

Required scope: hybris.cecenteruiconfig_manage

put

Update action area views.

Required scope: hybris.cecenteruiconfig_manage

delete

Delete action area views.

Required scope: hybris.cecenteruiconfig_manage

/{tenant}/actionAreaViews/default

Default action area views

get

Get default action area views.

Required scope: hybris.cecenteruiconfig_view

/{tenant}/requiredScopes

Required scopes

/{tenant}/requiredScopes

get

Get all the required scopes that are configured in this service. Engagement Center will use these scopes to acquire tokens from the OAuth2 service.

Required scope: hybris.cecenteruiconfig_view

post

Load all the required scopes that are pre-delivered by SAP as the default configuration.

Required scope: hybris.cecenteruiconfig_manage

put

Update existing required scopes.

Required scope: hybris.cecenteruiconfig_manage

delete

Delete the list of required scopes from the configuration. After deletion, Engagement Center will not be able to acquire a token with proper authorization to perform certain actions.

Required scope: hybris.cecenteruiconfig_manage

/{tenant}/requiredScopes/default

Default required scopes

get

Get the default required scopes. Engagement Center will use these scopes to acquire tokens from the OAuth2 service.

Required scope: hybris.cecenteruiconfig_view

/{tenant}/moduleDefinitions

Module definitions

/{tenant}/moduleDefinitions

get

Get module definitions.

Required scope: hybris.cecenteruiconfig_view

post

Create module definitions.

Required scope: hybris.cecenteruiconfig_manage

put

Update module definitions.

Required scope: hybris.cecenteruiconfig_manage

delete

Delete module definitions.

Required scope: hybris.cecenteruiconfig_manage

/{tenant}/moduleDefinitions/default

Default module definitions

get

Get default module definitions.

Required scope: hybris.cecenteruiconfig_view

/{tenant}/businessContextConfig

Business context related configurations

/{tenant}/businessContextConfig

get

Retrieve all the business context-related configurations, which are required to render the Engagement Context in the Engagement Center. These configurations include:

  1. Business Document Types (/{tenant}/businessDocumentTypes)
  2. Header Area Views (/{tenant}/headerAreaViews)
  3. Work Area Views (/{tenant}/workAreaViews)
  4. Action Area Views (/{tenant}/actionAreaViews)
  5. Module Definitions (/{tenant}/moduleDefinitions)
  6. SAP GUI for HTML URLs (/{tenant}/sapguihtml)
  7. Side Panel Views (/{tenant}/sidePanelConfig)
  8. I18N Values (/{tenant}/i18n)
  9. Configuration Parameters (/{tenant}/configParameters)
  10. Account Searches (/{tenant}/accountSearches)

If the service does not find any data on one of the listed configurations, then the properties of the respective configuration are not included in the response.

Required scope: hybris.cecenteruiconfig_view

/{tenant}/sapguihtml

SAP GUI for HTML URLs

/{tenant}/sapguihtml

get

Get list of all URLs for SAP GUI for HTML.

Required scope: hybris.cecenteruiconfig_view

put

Update the list of all URLs for SAP GUI for HTML.

Required scope: hybris.cecenteruiconfig_manage

post

Post a list of all URLs for SAP GUI for HTML.

Required scope: hybris.cecenteruiconfig_manage

delete

Delete the list of all URLs for SAP GUI for HTML.

Required scope: hybris.cecenteruiconfig_manage