Coveo Platform 7.0. Administration Roles

Transcription

1 Coveo Platform 7.0 Administration Roles

2 Coveo Platform 7.0 Administration Roles Notice The content in this document represents the current view of Coveo as of the date of publication. Because Coveo continually responds to changing market conditions, information in this document is subject to change without notice. For the latest documentation, visit our website at Coveo Solutions Inc., 2013 Coveo is a trademark of Coveo Solutions Inc. This document is protected by intellectual property laws and is subject to all restrictions specified in the Coveo Customer Agreement. Document part number: PM EN Publication date: 5/14/2018 4www.coveo.com ii

3 Table of Contents 1. About Administration Roles Administration Role Feature Comparison Administration Role Short Descriptions 5 2. Assigning Users to Administration Roles 8

4 1. About Administration Roles In an organization using the Coveo Platform, one or more persons may need to access the Coveo Web tools (Administration Tool, Interface Editor) to configure and manage various aspects of the Coveo solution. The Coveo Platform includes administration roles that allow to securely manage who has access to which features from the Coveo Web tools (see "Assigning Users to Administration Roles" on page 8). Notes: When a member of an administration role has partial access to the Coveo Administration Tool, the features to which access is restricted (tabs, menus, parameters...) are visible but disabled, appearing shaded. When you add a local Windows administrator account while CES is running, CES does not automatically become aware of the existence of the new account. Depending on your CES version, allow access to this new user: o CES (April 2014) You can manually refresh the CES security cache. o CES (March 2014) You must restart the CES service. Important: A user having administrator permissions on the Coveo server automatically gets the equivalent of the Administrator (Limited Access) role. The administration roles apply to web connections to the Coveo Administration Tool and Interface Editor. 1.1 Administration Role Feature Comparison The following tables respectively provide a comparative list of operation and configuration available to each administration role. Administration roles Operation Relevance "Search Interface Designer" on page 7 Usage Change license Enable read-only Control remote mirrors Delete index content Delete old logs

5 Administration roles Operation Relevance "Search Interface Designer" on page 7 Usage Access Usage Analytics module Display top queries View query logs View system logs View index logs Rebuild sources Refresh/increment sources Pause/resume sources Refresh/remove documents Refresh converter scripts Test converters Commit current transactions Clean GroupBy cache Refresh security cache Browse index Browse index without checking permissions Modifications through Web services

6 Administration roles Configuration Relevance "Search Interface Designer" on page 7 Usage /transaction update frequency performance cache memory performance mode Log Mail alert Mirrors Slices Remote indexes Administration roles Super user tokens Search pages to keep hot Crawlers/top queries count Crawlers/crawling paused Crawlers/live history size Collections/add Collections/remove Sources/add Sources/remove

7 Administration roles Configuration Relevance "Search Interface Designer" on page 7 Usage Source/schedule Source/filters Source/fields Source/XML definition Source/document type Source/Crawler source parameters Source/language Source/scripts Converter scripts Converters Language hint Schedules Security providers Document types Field aliases Fields XML document definitions SharePoint references User identities Top Results Ranking

8 Administration roles Configuration Relevance "Search Interface Designer" on page 7 Usage Result clustering Collaborative ranking Thesaurus Search interfaces Search hubs Search data 1.2 Administration Role Short Descriptions Administration role name format is [Role]([Permissions Collections]). When you add a role in the Configuration > Security > Roles > Assign administration roles page, you make a selection in the Roles and Permissions or Collections lists. Example: When you want to give a user the Administrator (Full Access) role, you first select Administrator, and then select Full Access under in the Permissions box that appears.

9 Administrator (Full Access) Members of this role have the same access as the Administrators (Limited Access) role but also full read access to document details for all indexed documents, like for the s (Full Access) role. This role is typically assigned to IT persons who need to review details from all indexes documents to be able to troubleshoot Coveo Platform issues. Important: Members of the Administrators (Full Access) role can see potentially sensitive information such as document titles, document summaries, metadata values. This role provides Super User-like access but index browser queries made with this role are logged so that they become traceable. Assign this role with care. Administrator (Limited Access) Members of this role have access to all Coveo Web tool features, including read access to index browser document details but only for documents that they normally have access, like for the s (Limited Access) role. For other documents, inaccessible to the member, document details are hidden, protecting potentially sensitive information. A number of features are exclusive to this role, including assigning other users to administration roles (see "Assigning Users to Administration Roles" on page 8). This role is typically assigned to IT persons in charge of the Coveo solution. Relevance Analyst Members of this role have access to Top Results (for all collections and sources), ranking, clustering, and thesaurus configuration to control how the index content is returned for end-user queries. This role is typically assigned to persons in charge of ensuring search users can easily find documents they are looking for. Usage Analyst Members of this role have access to query logs/history and the Usage Analytics module to analyze how the Coveo solution is used. This role is typically assigned to persons in charge of evaluating the adoption of the Coveo solution, such as the project manager or the solution owner. Important: Usage gain full access to the Usage Analytics module interface where potentially sensitive information can be exposed as all queries by all users can be viewed. Assign this role with care. Administrator (Full Access) Members of this role have access to all index operation and configuration for all collections and sources, but do not have access to the index browser. They can change configuration affecting many or all collections and sources. This role is typically assigned to IT persons in charge of the Coveo solution. Administrator (Limited Access) Members of this role have access to basic index operation and configuration for selected collections and sources. Users member of this role cannot change configuration affecting more than one collection or sources. This role can be assigned to persons in charge of specific indexed repositories to give them access to basic index operation and configuration for the corresponding collections and sources. (Full Access) Members of this role have access to the index browser with read access to document details for all indexed

10 documents. Access to this information is useful when required to see what documents and metadata are available in the index while attempting to troubleshoot unexpected behavior of the Coveo Platform. This role is typically assigned to IT persons or information managers who need to review details from all indexed documents to be able to troubleshoot Coveo Platform issues. Important: Members of the (Full Access) role can see potentially sensitive information such as document titles, document summaries, metadata values. This role provides Super User-like access but index browser queries made with this role are logged so that they become traceable. Assign this role with care. (Limited Access) Members of this role have read access to index browser document details but only for documents this user has normally access to. For other documents, inaccessible to the current user, document details are hidden, protecting potentially sensitive information. This role is typically assigned to IT persons or information managers in charge of troubleshooting Coveo Platform issues. Search Interface Designer Members of this role have access to the Interface Editor where out-of-the-box search hubs and search interfaces can be customized, as well as new ones created and configured. This role is typically assigned to IT persons in charge of the search interfaces for the Coveo Platform.

11 2. Assigning Users to Administration Roles If you can connect to the Coveo server or if you are a member of the Administrators, you can assign users or groups to at least one of the available administration roles (see "About Administration Roles" on page 1). These users or groups can then securely access the Administration Tool and Interface Editor features specifically associated with their administration role membership. To assign users to administration roles 1. On the Coveo server, access the Administration Tool. 2. Select Configuration > Security. 3. In the navigation panel that appears on the left, click Roles. 4. In the panel on the right, click Add to assign an administration role. Note: You can also click an existing name to modify its administration roles, or click the delete icon ( to the name to completely delete the assigned administration role. ) next 5. In the Assign Administration Roles page:

12 a. Using the Security Provider, Type, and Name parameters, specify the user or group that you want to assign to an administration role. Note: For Active Directory security providers, enter the Name in the domain\user or domain\group form. b. In the Roles panel, select the role to which you want to assign the user or group (see "About Administration Roles" on page 1). When you select Administrator, in the Permissions box that appears on the right, under, select Full Access or Limited Access. Note: CES (October 2014) When you select Administrator, in the Roles Types box that appears, select Full Access or Limited Access. When you select Partial Permissions, you can select one or more of the following roles: o o o Relevancy Usage When you select Administrators, in the Collections box that appears on the right, you can also select Full Control or limited control for All Collections or for a Subset of collections. When you select collections containing more than one source, in the Sources box that appears, you can

13 also select limited control for All Sources or for a Subset of the sources from the selected collections. When you select, in the Permissions box that appears, under, select Full Access or Limited Access. Note: CES (October 2014) When you select, in the Roles Types box that appears, select Full Access or Limited Access. Search Interface Designer c. Click Save when creating a new set, or Apply changes when modifying an existing set.