From 321523d45410afd71888ab878ffde32c1c6992d2 Mon Sep 17 00:00:00 2001 From: Luis Valdez <11777711+luigivaldez@users.noreply.github.com> Date: Fri, 11 Oct 2019 13:59:02 -0400 Subject: [PATCH 1/6] PLAT-41201: Update docs re: SAML/ADFS --- README.md | 42 +++++++++++++++++++++++++----------------- 1 file changed, 25 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index e57768e..b22d980 100644 --- a/README.md +++ b/README.md @@ -17,39 +17,47 @@ * [Contributing](#contributing) ## Overview -The Attivio **Search UI** is an application built on top of Attivio’s Search UI Toolkit, or **SUIT**. The SUIT library is available in a [separate repository](https://github.com/attivio/suit) and via NPM (see below for details). +The Attivio **Search UI** is an application built on top of Attivio’s Search UI Toolkit, or **SUIT**. The SUIT library is available in a [separate repository](https://github.com/attivio/suit) and via NPM (see “What is SUIT?” below for more details). -The Attivio Search UI allows you to search across and view the data in the index of your Attivio, Elasticsearch or Solr installation. You can customize it to suit your needs and can also use it as the basis for creating your own, brand-new search application. +The Attivio Search UI allows you to search across and view the data in the index of your Attivio, Elasticsearch, or Solr installation. You can customize it to suit your needs and can also use it as the basis for creating your own brand-new search application. ## Project Organization -The Attivio Search UI is a web application written in JavaScript and based on the React project. It runs in the user’s browser. This component is in the [**frontend**](https://github.com/attivio/searchui/tree/master/frontend) directory of this repository and consists of application-level code for searching the index, including the definitions of the pages in the application and the logic of how they're connected. +The Attivio Search UI is a web application written in JavaScript and based on the React project. It runs entirely in the user’s browser. The code for the web application is in the [**frontend**](https://github.com/attivio/searchui/tree/master/frontend) directory of the repository and consists of application-level code for searching the index, including the definitions of the pages in the application and the logic of how they’re connected. The application-level code is relatively minimal, dictating how the components (defined in the SUIT library mentioned above) are laid out and condfigured. -The project also contains two additional components that allow you to host the web application, either on one or more Attivio node servers ([**module**](https://github.com/attivio/searchui/tree/master/module)) or from a servlet container such as Apache Tomcat ([**servlet**](https://github.com/attivio/searchui/tree/master/servlet)). The availability of certain functionality will vary depending on how you host and configure the Search UI application and which search engine you use, as described below. +The repository also contains two additional components that allow hosting of the web application, either on one or more Attivio node servers as a module ([**module**](https://github.com/attivio/searchui/tree/master/module)) or in a servlet container such as Apache Tomcat ([**servlet**](https://github.com/attivio/searchui/tree/master/servlet)). The functionality of the Search UI application varies slightly depending on how it is hostyed and configured, as described below. ## What is SUIT? -The SUIT library consists of various React components used by Search UI to render the UI and to interact with the index and other features. It also includes some API and utility classes, mainly used by the components directly but which the application-level code can also access. See the [GitHub repository](https://github.com/attivio/suit) for the SUIT library for documentation on using its components and other functionality. +The UI elements that make up the Search UI application are defined in the SUIT library. These include more basic components such as pop-up menus and text fields as well as more complex components such as one that renders an entire document from the index or one that knows how to take the search criteria provided by the user and perform a search with them. In addition to UI components, SUIT contains a number of API and utility classes which facilitate the interactions between the UI and the back-end server. See the [GitHub repository](https://github.com/attivio/suit) for the SUIT library for detailed documentation on its components and other functionality. + +## Installation and Deployment of Search UI +As was alluded to when describing the project’s organization, there are two options when deploying Search UI. It can be run “embedded,” hosted by the Attivio node server or servers or it can be run “stand-alone,” hosted by a servlet container: -## Installation and Deployment -Search UI has two deployment options. If you're interested in simply downloading a pre-built application, configuring your preferences and deploying it, choose one of the following options: * **[Embedded](https://answers.attivio.com/display/extranet55/Search+UI+Download)** - *deploy as a module making it available from the Attivio Admin UI* -Deploying Search UI within the Attivio Admin UI is recommended for exploration of your data. It is not recommended that this method of deployment be used to serve Search UI to a large number of users in a production environment. Attivio recommends a Stand-alone deployment for production environments where Search UI is serving as the primary user interface. +As a module in the Attivio project is the most straightforward way to deploy Search UI. When you do this, a link in the Attivio Administration UI will be created in the “Query” section along the left side that will take the user to the Search UI application. (The actual URL for Search UI will be the server’s name and port followed by `/searchui`, for example, `http://localhost:17000/searchui`.) + * **[Stand-alone](DeploymentTomcat.md)** - *deploy to an external web server such as Tomcat* -Stand-alone deployments are recommended when Search UI (or a customized version of it) is used as the primary user interface in your production environment. Deploying Search UI within the Attivio Admin UI could lead to resource contention since each Attivio node has other responsibilities, such as ingesting content or responding to queries. Stand-alone deployments can be done on the same host as Attivio nodes provided there are sufficient resources, though in many situations, dedicated hosts are recommended. +Stand-alone deployments are recommended when Search UI is used as the primary user interface in your production environment as this approach allows you to manage and scale the Search UI application separately from the Attivio nodes. If you require integration with a SAML-based identity provider (IdP) for single-sign-on authentication, you will need to perform a stand-alone deployment. (Of course, if you are using the Search UI application with a non-Attivio back end, then you have no chioice but to use the stand-alone method for deploying it since there will be no Attivio nodes.) + +Stand-alone deployments can be done on the same host as Attivio nodes provided there are sufficient resources, though in many situations, dedicated Search UI hosts are recommended to decouple the two. -Stand-alone deployments are recommended when Search UI (or a customized version of it) is used as the primary user interface in your production environment. Deploying Search UI within the Attivio Admin UI could lead to resource contention since each Attivio node has other responsibilities, such as ingesting content or responding to queries. Stand-alone deployments can be done on the same host as Attivio nodes provided there are sufficient resources, though in many situations, dedicated hosts are recommended. +See the instructions at the link above for details on how to configure Apache Tomcat to host the Search UI application. (Although they are written specifically for Tomcat, they are generally useful for deploying to other servlet containers such as Jetty, GlassFish, JBoss, WebSphere, etc…) -For instructions on building the application for one of the above deployment options, or if, instead, you wish to customize and build your own application for either deployment option, see the [Developer's Guide](DevelopersGuide.md) for instructions on setting up your development environment and building. +For instructions on building the application for one of the above deployment options, or if, instead, you wish to customize and build your own application for either deployment option, see the [Developer’s Guide](DevelopersGuide.md) for instructions on setting up your development environment and building. * **[SSO for REST](ConfiguringRESTSSO.md)** - *use SSO to access the Attivio REST APIs* -This last option is useful in case you don't want to run the Search UI application and instead have a custom SSO-enabled web application which needs to be able to call the Attivio REST APIs directly from the user's browser (as opposed to accessing them from a server), so you don't expose the credentials of the Attivio server in your JavaScript code. This configuration can enable this functionality. +This last option is useful in case you don’t want to run the Search UI application and instead have a custom SSO-enabled web application which needs to be able to call the Attivio REST APIs directly from the user’s browser (as opposed to accessing them from a server), so you don’t expose the credentials of the Attivio server in your JavaScript code. This configuration can enable this functionality. ## How Can I Customize the Search UI? -To build your own search application using the SUIT library, with any or all of the features Search UI provides, see the [Developer's Guide](DevelopersGuide.md). +Depending on what you want to do with the Search UI, you can customize it in a few different ways. Many aspects of the application can be changed by editing the configuration (in `[configuration.properties.js](https://github.com/attivio/searchui/tree/master/frontend/configuration.properties.js)`). There are details of what you can change in the configuration in the [FAQ document](FAQ.md), as well as configuration file itself. + +If you are deploying the application as an Attivio module, you can place your updated configuration file in your project’s `resources` directory. If you are deploying to a servlet container, the `application.properties` file should point to your custom configuration file. + +To build your own search application using the SUIT library, with any or all of the features Search UI provides, see the [Developer’s Guide](DevelopersGuide.md). --- @@ -66,7 +74,7 @@ Depending on the security option, users will either be presented with Attivio lo Attivio Login Form Okta Login Form ## Cognitive Search -After logging in, if required, Search UI opens to its "Landing Page." The landing page provides a clean UI to start your search investigation. +After logging in, if required, Search UI opens to its landing page. The landing page provides a clean UI to start your search investigation. Landing Page @@ -86,9 +94,9 @@ Following are some features of the results page: | Feature | Description | | ------- | ----------- | | Logged-in user (Attivio Administrator in our case)
Username | The name of the logged-in user appears in the upper right corner, if available. Otherwise, the username is displayed with an option to log out. | -| Simple or Advanced Query Language
Query Language | Select between Attivio's [Simple Query Language](https://answers.attivio.com/display/extranet55/Simple+Query+Language) or the [Advanced Query Language](https://answers.attivio.com/display/extranet55/Advanced+Query+Language). | +| Simple or Advanced Query Language
Query Language | Select between Attivio’s [Simple Query Language](https://answers.attivio.com/display/extranet55/Simple+Query+Language) or the [Advanced Query Language](https://answers.attivio.com/display/extranet55/Advanced+Query+Language). | | Search Box
Search Box| Enter the text of your query. For the [Simple Query Language](https://answers.attivio.com/display/extranet55/Simple+Query+Language), enter a keyword or a field:keyword pair. The string \*:\* retrieves all documents in all tables. You can paste in more complex queries written in the [Advanced Query Language](https://answers.attivio.com/display/extranet55/Advanced+Query+Language), such as those demonstrated in the [Quick Start Tutorial](https://answers.attivio.com/display/extranet55/Quick+Start+Tutorial). | -| Facet Filters
Facets | The left column of the display is devoted to facet controls. Each one summarizes opportunities to "drill down" on the set of current results to narrow the search. | +| Facet Filters
Facets | The left column of the display is devoted to facet controls. Each one summarizes opportunities to “drill down” on the set of current results to narrow the search. | | Applied Facets
Applied Facet | Under the header, the facet filters that have been applied to the search are displayed. Each item can be individually removed to widen the result set as needed. | | Sort Control
Sort By | The sort control reorders the result items. You can sort by relevancy and select which [relevancy model](https://answers.attivio.com/display/extranet55/Machine+Learning+Relevancy) to use, or by any sortable field in the schema. See [Sorting Results](https://answers.attivio.com/display/extranet55/Sorting+Results) for more information. | | Relevancy Model
Relevancy | If you choose Relevancy in the Sort Control, you can choose the Relevancy Model to use. See [Machine Learning Relevancy](https://answers.attivio.com/display/extranettrunk/Machine+Learning+Relevancy) for more information. | @@ -106,7 +114,7 @@ The 360° View page allows you to take a closer look at a single document and In the 360° View you can see the document text, extracted entities and the Knowledge Graph. The Knowledge Graph shows how this document is linked to other documents by matching the entities extracted. -If we look at "Italy" we can see it relates to two News documents based on mentions of the extracted locations of Italy and Germany. +If we look at “Italy,” we can see it relates to two News documents based on mentions of the extracted locations of Italy and Germany. Knowledge Graph From 9bf2de56c2e4698dd958fe4be7cad68d24e72c09 Mon Sep 17 00:00:00 2001 From: Luis Valdez <11777711+luigivaldez@users.noreply.github.com> Date: Fri, 11 Oct 2019 14:20:16 -0400 Subject: [PATCH 2/6] More edits --- README.md | 21 ++++++++++++--------- 1 file changed, 12 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index b22d980..050b0f0 100644 --- a/README.md +++ b/README.md @@ -19,25 +19,28 @@ ## Overview The Attivio **Search UI** is an application built on top of Attivio’s Search UI Toolkit, or **SUIT**. The SUIT library is available in a [separate repository](https://github.com/attivio/suit) and via NPM (see “What is SUIT?” below for more details). -The Attivio Search UI allows you to search across and view the data in the index of your Attivio, Elasticsearch, or Solr installation. You can customize it to suit your needs and can also use it as the basis for creating your own brand-new search application. +The Attivio Search UI allows you to search across and view the data in the index of your Attivio, Elasticsearch, or Solr installation. You can use it as-is, you can customize it to meet your needs, or you can use it as the starting point when creating your own search-centered application. + +## Using Search UI +If you are interested in how to use the Search UI application as an end-user, see [Using the Search UI](UsingSearchUI.md). The remainder of the current README file deals with deploying and customizing the Search UI application. ## Project Organization -The Attivio Search UI is a web application written in JavaScript and based on the React project. It runs entirely in the user’s browser. The code for the web application is in the [**frontend**](https://github.com/attivio/searchui/tree/master/frontend) directory of the repository and consists of application-level code for searching the index, including the definitions of the pages in the application and the logic of how they’re connected. The application-level code is relatively minimal, dictating how the components (defined in the SUIT library mentioned above) are laid out and condfigured. +The Attivio Search UI is a web application written in JavaScript and based on the [React](https://reactjs.org) project. It runs entirely in the user’s browser. The code for the web application is in the [**frontend**](https://github.com/attivio/searchui/tree/master/frontend) directory of the repository and consists of application-level code for searching the index including the definition of the pages in the application and the logic of how they’re connected. The application-level code is relatively minimal, merely dictating how the components (defined in the SUIT library mentioned above) are laid out and condfigured; the bulk of the code that implements the application is in the SUIT library itself. -The repository also contains two additional components that allow hosting of the web application, either on one or more Attivio node servers as a module ([**module**](https://github.com/attivio/searchui/tree/master/module)) or in a servlet container such as Apache Tomcat ([**servlet**](https://github.com/attivio/searchui/tree/master/servlet)). The functionality of the Search UI application varies slightly depending on how it is hostyed and configured, as described below. +The repository also contains two additional components that allow hosting of the Search UI web application, either on one or more Attivio node servers as a module ([**module**](https://github.com/attivio/searchui/tree/master/module)) or in a servlet container such as Apache Tomcat ([**servlet**](https://github.com/attivio/searchui/tree/master/servlet)). The functionality of the Search UI application varies slightly depending on how it is hosted and configured, as described below. -## What is SUIT? +## What is the SUIT Library? -The UI elements that make up the Search UI application are defined in the SUIT library. These include more basic components such as pop-up menus and text fields as well as more complex components such as one that renders an entire document from the index or one that knows how to take the search criteria provided by the user and perform a search with them. In addition to UI components, SUIT contains a number of API and utility classes which facilitate the interactions between the UI and the back-end server. See the [GitHub repository](https://github.com/attivio/suit) for the SUIT library for detailed documentation on its components and other functionality. +The individual UI elements that make up the Search UI application are defined in the SUIT library. These include more basic components such as pop-up menus and text fields as well as more complex components such as one that renders an entire document from the index or one that knows how to take the search criteria provided by the user and perform a search of the index. In addition to UI components, SUIT contains a number of API and utility classes which facilitate the interactions between the UI and the back-end server. See the [GitHub repository](https://github.com/attivio/suit) for the SUIT library for detailed documentation on its components and other functionality. ## Installation and Deployment of Search UI -As was alluded to when describing the project’s organization, there are two options when deploying Search UI. It can be run “embedded,” hosted by the Attivio node server or servers or it can be run “stand-alone,” hosted by a servlet container: +As was alluded to in discussing the organization of the Search UI repository, there are two options when deploying Search UI. It can be run “embedded,” hosted by the Attivio node server or it can be run “stand-alone,” hosted by a servlet container: -* **[Embedded](https://answers.attivio.com/display/extranet55/Search+UI+Download)** - *deploy as a module making it available from the Attivio Admin UI* +### **[Embedded](https://answers.attivio.com/display/extranet55/Search+UI+Download)** -As a module in the Attivio project is the most straightforward way to deploy Search UI. When you do this, a link in the Attivio Administration UI will be created in the “Query” section along the left side that will take the user to the Search UI application. (The actual URL for Search UI will be the server’s name and port followed by `/searchui`, for example, `http://localhost:17000/searchui`.) +As a module in the Attivio project is the most straightforward way to deploy Search UI. When you do this, a link in the Attivio Administration UI will be created under the “Query” heading. This will open a new tab and take the user to the Search UI application. (The actual URL for Search UI will be the server’s name and port followed by `/searchui`, for example, `http://localhost:17000/searchui`.) -* **[Stand-alone](DeploymentTomcat.md)** - *deploy to an external web server such as Tomcat* +**[Stand-alone](DeploymentTomcat.md)** Stand-alone deployments are recommended when Search UI is used as the primary user interface in your production environment as this approach allows you to manage and scale the Search UI application separately from the Attivio nodes. If you require integration with a SAML-based identity provider (IdP) for single-sign-on authentication, you will need to perform a stand-alone deployment. (Of course, if you are using the Search UI application with a non-Attivio back end, then you have no chioice but to use the stand-alone method for deploying it since there will be no Attivio nodes.) From e3794b62faf68723d16958b11cb29b30eda9772e Mon Sep 17 00:00:00 2001 From: Luis Valdez <11777711+luigivaldez@users.noreply.github.com> Date: Fri, 11 Oct 2019 14:29:49 -0400 Subject: [PATCH 3/6] Update README.md --- README.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 050b0f0..d4c3dea 100644 --- a/README.md +++ b/README.md @@ -36,23 +36,25 @@ The individual UI elements that make up the Search UI application are defined in ## Installation and Deployment of Search UI As was alluded to in discussing the organization of the Search UI repository, there are two options when deploying Search UI. It can be run “embedded,” hosted by the Attivio node server or it can be run “stand-alone,” hosted by a servlet container: -### **[Embedded](https://answers.attivio.com/display/extranet55/Search+UI+Download)** +### Embedded As a module in the Attivio project is the most straightforward way to deploy Search UI. When you do this, a link in the Attivio Administration UI will be created under the “Query” heading. This will open a new tab and take the user to the Search UI application. (The actual URL for Search UI will be the server’s name and port followed by `/searchui`, for example, `http://localhost:17000/searchui`.) -**[Stand-alone](DeploymentTomcat.md)** +The Search UI module is included with the Attivio Platform installer. You can also obtain the latest build of the module on the [Attivio Answers](https://answers.attivio.com/display/extranet55/Search+UI+Download) website. + +### Stand-alone(DeploymentTomcat.md)** Stand-alone deployments are recommended when Search UI is used as the primary user interface in your production environment as this approach allows you to manage and scale the Search UI application separately from the Attivio nodes. If you require integration with a SAML-based identity provider (IdP) for single-sign-on authentication, you will need to perform a stand-alone deployment. (Of course, if you are using the Search UI application with a non-Attivio back end, then you have no chioice but to use the stand-alone method for deploying it since there will be no Attivio nodes.) Stand-alone deployments can be done on the same host as Attivio nodes provided there are sufficient resources, though in many situations, dedicated Search UI hosts are recommended to decouple the two. -See the instructions at the link above for details on how to configure Apache Tomcat to host the Search UI application. (Although they are written specifically for Tomcat, they are generally useful for deploying to other servlet containers such as Jetty, GlassFish, JBoss, WebSphere, etc…) +See the [stand-alone deployment documentation](DeploymentTomcat.md) for details on how to configure Apache Tomcat to host the Search UI application. (Although they are written specifically for Tomcat, they are generally useful for deploying to other servlet containers such as Jetty, GlassFish, JBoss, WebSphere, etc…) For instructions on building the application for one of the above deployment options, or if, instead, you wish to customize and build your own application for either deployment option, see the [Developer’s Guide](DevelopersGuide.md) for instructions on setting up your development environment and building. -* **[SSO for REST](ConfiguringRESTSSO.md)** - *use SSO to access the Attivio REST APIs* +#### Using SSO for the Attivio REST APIs -This last option is useful in case you don’t want to run the Search UI application and instead have a custom SSO-enabled web application which needs to be able to call the Attivio REST APIs directly from the user’s browser (as opposed to accessing them from a server), so you don’t expose the credentials of the Attivio server in your JavaScript code. This configuration can enable this functionality. +If you are writing your own front-end search application that needs access to the Attivio REST APIs but you don't want to use Search UI and SUIT, you can leverage the Search UI servlet used when deploying to Tomcat in order to provide SAML-based access to these APIs. This prevents you from having to expose the credentials of the Attivio server in your JavaScript code. To learn more about how you can do this, see [Configuring REST SSO](ConfiguringRESTSSO.md). ## How Can I Customize the Search UI? From b70b8cb1437223ef66daa454f89f2e45aba53f5e Mon Sep 17 00:00:00 2001 From: Luis Valdez <11777711+luigivaldez@users.noreply.github.com> Date: Fri, 11 Oct 2019 14:34:09 -0400 Subject: [PATCH 4/6] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index d4c3dea..4d569c6 100644 --- a/README.md +++ b/README.md @@ -42,7 +42,7 @@ As a module in the Attivio project is the most straightforward way to deploy Sea The Search UI module is included with the Attivio Platform installer. You can also obtain the latest build of the module on the [Attivio Answers](https://answers.attivio.com/display/extranet55/Search+UI+Download) website. -### Stand-alone(DeploymentTomcat.md)** +### Stand-alone Stand-alone deployments are recommended when Search UI is used as the primary user interface in your production environment as this approach allows you to manage and scale the Search UI application separately from the Attivio nodes. If you require integration with a SAML-based identity provider (IdP) for single-sign-on authentication, you will need to perform a stand-alone deployment. (Of course, if you are using the Search UI application with a non-Attivio back end, then you have no chioice but to use the stand-alone method for deploying it since there will be no Attivio nodes.) From 29574871721d7f9ecf4d883921d11b37e3183a7b Mon Sep 17 00:00:00 2001 From: Luis Valdez <11777711+luigivaldez@users.noreply.github.com> Date: Fri, 11 Oct 2019 17:59:37 -0400 Subject: [PATCH 5/6] PLAT-41201: Remove How to Use section --- README.md | 62 +++---------------------------------------------------- 1 file changed, 3 insertions(+), 59 deletions(-) diff --git a/README.md b/README.md index 4d569c6..0202136 100644 --- a/README.md +++ b/README.md @@ -44,21 +44,19 @@ The Search UI module is included with the Attivio Platform installer. You can al ### Stand-alone -Stand-alone deployments are recommended when Search UI is used as the primary user interface in your production environment as this approach allows you to manage and scale the Search UI application separately from the Attivio nodes. If you require integration with a SAML-based identity provider (IdP) for single-sign-on authentication, you will need to perform a stand-alone deployment. (Of course, if you are using the Search UI application with a non-Attivio back end, then you have no chioice but to use the stand-alone method for deploying it since there will be no Attivio nodes.) +Stand-alone deployments are recommended when Search UI is used as the primary user interface in your production environment as this approach allows you to manage and scale the Search UI application separately from the Attivio nodes. If you require integration with a SAML-based identity provider (IdP) for single-sign-on authentication, you will need to perform a stand-alone deployment. (Of course, if you are using the Search UI application with a non-Attivio back end, then you must use the stand-alone method for deploying it since there will be no Attivio nodes.) Stand-alone deployments can be done on the same host as Attivio nodes provided there are sufficient resources, though in many situations, dedicated Search UI hosts are recommended to decouple the two. See the [stand-alone deployment documentation](DeploymentTomcat.md) for details on how to configure Apache Tomcat to host the Search UI application. (Although they are written specifically for Tomcat, they are generally useful for deploying to other servlet containers such as Jetty, GlassFish, JBoss, WebSphere, etc…) -For instructions on building the application for one of the above deployment options, or if, instead, you wish to customize and build your own application for either deployment option, see the [Developer’s Guide](DevelopersGuide.md) for instructions on setting up your development environment and building. - -#### Using SSO for the Attivio REST APIs +### Using SSO for the Attivio REST APIs If you are writing your own front-end search application that needs access to the Attivio REST APIs but you don't want to use Search UI and SUIT, you can leverage the Search UI servlet used when deploying to Tomcat in order to provide SAML-based access to these APIs. This prevents you from having to expose the credentials of the Attivio server in your JavaScript code. To learn more about how you can do this, see [Configuring REST SSO](ConfiguringRESTSSO.md). ## How Can I Customize the Search UI? -Depending on what you want to do with the Search UI, you can customize it in a few different ways. Many aspects of the application can be changed by editing the configuration (in `[configuration.properties.js](https://github.com/attivio/searchui/tree/master/frontend/configuration.properties.js)`). There are details of what you can change in the configuration in the [FAQ document](FAQ.md), as well as configuration file itself. +Depending on what you want to do with the Search UI, you can customize it in a few different ways. Many aspects of the application can be changed by editing the configuration (in [`configuration.properties.js`](https://github.com/attivio/searchui/tree/master/frontend/configuration.properties.js)). There are examples of what you can change and how to do so in the [FAQ document](FAQ.md), as well as in the comments in the configuration file itself. If you are deploying the application as an Attivio module, you can place your updated configuration file in your project’s `resources` directory. If you are deploying to a servlet container, the `application.properties` file should point to your custom configuration file. @@ -78,60 +76,6 @@ Depending on the security option, users will either be presented with Attivio lo Attivio Login Form Okta Login Form -## Cognitive Search -After logging in, if required, Search UI opens to its landing page. The landing page provides a clean UI to start your search investigation. - -Landing Page - -**On this page you can:** -* [Ask a question](#question) -* Click on [Insights](#insights) to better understand your data - - -## Ask a Question - -Whether you want to ask a free-form question or use our [Advanced Query Language (AQL)](https://answers.attivio.com/display/extranet55/Advanced+Query+Language) in this page you can get to the information you need. Hit **ENTER** or click **Go** to see the results. - -Results - -Following are some features of the results page: - -| Feature | Description | -| ------- | ----------- | -| Logged-in user (Attivio Administrator in our case)
Username | The name of the logged-in user appears in the upper right corner, if available. Otherwise, the username is displayed with an option to log out. | -| Simple or Advanced Query Language
Query Language | Select between Attivio’s [Simple Query Language](https://answers.attivio.com/display/extranet55/Simple+Query+Language) or the [Advanced Query Language](https://answers.attivio.com/display/extranet55/Advanced+Query+Language). | -| Search Box
Search Box| Enter the text of your query. For the [Simple Query Language](https://answers.attivio.com/display/extranet55/Simple+Query+Language), enter a keyword or a field:keyword pair. The string \*:\* retrieves all documents in all tables. You can paste in more complex queries written in the [Advanced Query Language](https://answers.attivio.com/display/extranet55/Advanced+Query+Language), such as those demonstrated in the [Quick Start Tutorial](https://answers.attivio.com/display/extranet55/Quick+Start+Tutorial). | -| Facet Filters
Facets | The left column of the display is devoted to facet controls. Each one summarizes opportunities to “drill down” on the set of current results to narrow the search. | -| Applied Facets
Applied Facet | Under the header, the facet filters that have been applied to the search are displayed. Each item can be individually removed to widen the result set as needed. | -| Sort Control
Sort By | The sort control reorders the result items. You can sort by relevancy and select which [relevancy model](https://answers.attivio.com/display/extranet55/Machine+Learning+Relevancy) to use, or by any sortable field in the schema. See [Sorting Results](https://answers.attivio.com/display/extranet55/Sorting+Results) for more information. | -| Relevancy Model
Relevancy | If you choose Relevancy in the Sort Control, you can choose the Relevancy Model to use. See [Machine Learning Relevancy](https://answers.attivio.com/display/extranettrunk/Machine+Learning+Relevancy) for more information. | -| Paging Controls
Pagination | The paging controls let you page through the search results conveniently. | -| Matching Documents | The right column of this page is devoted to the display of matching documents. | -| User Rating
Rating | A user can provide a rating for a document that can be used as a signal when using Machine Learning to create a relevancy model. See [Machine Learning Relevancy](https://answers.attivio.com/display/extranet55/Machine+Learning+Relevancy) for more information. | -| Show 360° View | You can choose to see a 360° view of a document to better understand the document and how it relates to other documents using our Knowledge Graph. | - ---- - -## 360° View -Italy 360 View - -The 360° View page allows you to take a closer look at a single document and understand how it relates to other documents in the index. - -In the 360° View you can see the document text, extracted entities and the Knowledge Graph. The Knowledge Graph shows how this document is linked to other documents by matching the entities extracted. - -If we look at “Italy,” we can see it relates to two News documents based on mentions of the extracted locations of Italy and Germany. - -Knowledge Graph - ---- - -## Insights -The Insights page provides a dashboard that allows you to quickly understand your data without knowing what data was ingested. - -Using our [Text Analytics](https://answers.attivio.com/display/extranet55/Attivio+Text+Analytics) capabilities and [facets](https://answers.attivio.com/display/extranet55/Facets) we build knowledge on top of your data so that you can better understand your data. - -Insights - --- ## How Do I Configure Search UI? From 3ee8776a439aaf80546f03715600bf43c6881d8e Mon Sep 17 00:00:00 2001 From: Luis Valdez <11777711+luigivaldez@users.noreply.github.com> Date: Fri, 11 Oct 2019 18:07:46 -0400 Subject: [PATCH 6/6] PLAT-41201: Separating out the usage guide --- UsingSearchUI.md | 60 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 60 insertions(+) create mode 100644 UsingSearchUI.md diff --git a/UsingSearchUI.md b/UsingSearchUI.md new file mode 100644 index 0000000..ac763fe --- /dev/null +++ b/UsingSearchUI.md @@ -0,0 +1,60 @@ +# Using the Search UI Application + +To get to the Search UI application use the appropriate URL in your web browser. + +## The Search UI URL + +If the Search UI is being hosted by an Attivio node server, you can access it by going to the Admininstration UI on that node and clicking the “Search UI” link in the left-hand navigation links, under “Query.” You can also access it directly using the name and port of the server followed by `/searhcui` (e.g., `http://my.attivio.node:17000/searchui`). + +If the Search UI is being hosted by a servlet container such as Tomcat, you can access it using the name and port of the server followed by `/searhcui` (e.g., `http://my.tomcat.instance:8080/searchui`). + +## Logging into the Search UI + +Depending on how the Search UI is hosted and configured, you will likely need to log in. Once you do so, you will be taken to Search UI’s landing page. + +Landing Page + +### On this page you can +* [Ask a question](#question) +* Click on [Insights](#insights) to better understand your data + + +## Ask a Question + +Whether you want to ask a free-form question or use our [Advanced Query Language (AQL)](https://answers.attivio.com/display/extranet55/Advanced+Query+Language) in this page you can get to the information you need. Hit **ENTER** or click **Go** to see the results. + +Results + +Following are some features of the results page: + +| Feature | Description | +| ------- | ----------- | +| Logged-in user (Attivio Administrator in our case)
Username | The name of the logged-in user appears in the upper right corner, if available. Otherwise, the username is displayed with an option to log out. | +| Simple or Advanced Query Language
Query Language | Select between Attivio’s [Simple Query Language](https://answers.attivio.com/display/extranet55/Simple+Query+Language) or the [Advanced Query Language](https://answers.attivio.com/display/extranet55/Advanced+Query+Language). | +| Search Box
Search Box| Enter the text of your query. For the [Simple Query Language](https://answers.attivio.com/display/extranet55/Simple+Query+Language), enter a keyword or a field:keyword pair. The string \*:\* retrieves all documents in all tables. You can paste in more complex queries written in the [Advanced Query Language](https://answers.attivio.com/display/extranet55/Advanced+Query+Language), such as those demonstrated in the [Quick Start Tutorial](https://answers.attivio.com/display/extranet55/Quick+Start+Tutorial). | +| Facet Filters
Facets | The left column of the display is devoted to facet controls. Each one summarizes opportunities to “drill down” on the set of current results to narrow the search. | +| Applied Facets
Applied Facet | Under the header, the facet filters that have been applied to the search are displayed. Each item can be individually removed to widen the result set as needed. | +| Sort Control
Sort By | The sort control reorders the result items. You can sort by relevancy and select which [relevancy model](https://answers.attivio.com/display/extranet55/Machine+Learning+Relevancy) to use, or by any sortable field in the schema. See [Sorting Results](https://answers.attivio.com/display/extranet55/Sorting+Results) for more information. | +| Relevancy Model
Relevancy | If you choose Relevancy in the Sort Control, you can choose the Relevancy Model to use. See [Machine Learning Relevancy](https://answers.attivio.com/display/extranettrunk/Machine+Learning+Relevancy) for more information. | +| Paging Controls
Pagination | The paging controls let you page through the search results conveniently. | +| Matching Documents | The right column of this page is devoted to the display of matching documents. | +| User Rating
Rating | A user can provide a rating for a document that can be used as a signal when using Machine Learning to create a relevancy model. See [Machine Learning Relevancy](https://answers.attivio.com/display/extranet55/Machine+Learning+Relevancy) for more information. | +| Show 360° View | You can choose to see a 360° view of a document to better understand the document and how it relates to other documents using our Knowledge Graph. | + +## 360° View +Italy 360 View + +The 360° View page allows you to take a closer look at a single document and understand how it relates to other documents in the index. + +In the 360° View you can see the document text, extracted entities and the Knowledge Graph. The Knowledge Graph shows how this document is linked to other documents by matching the entities extracted. + +If we look at “Italy,” we can see it relates to two News documents based on mentions of the extracted locations of Italy and Germany. + +Knowledge Graph + +## Insights +The Insights page provides a dashboard that allows you to quickly understand your data without knowing what data was ingested. + +Using our [Text Analytics](https://answers.attivio.com/display/extranet55/Attivio+Text+Analytics) capabilities and [facets](https://answers.attivio.com/display/extranet55/Facets) we build knowledge on top of your data so that you can better understand your data. + +Insights