Difference between revisions of "Easy Tagging for SharePoint online/Manual/Authorize at Azure AD"

From DIQA-Homepage
(Created page with "{{Seite |Titel=Easy Tagging App for Sharepoint online |Kategorie=Product |Image=EasyTaggingBannern.png |Verlauf= |Pfad=Main Page > Products > Easy_Tagging_for_SharePoint...")
 
 
(31 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{Seite
+
{{ManualPage
|Titel=Easy Tagging App for Sharepoint online
+
|Titel=User Manual: Authorize at Azure Active Directory
|Kategorie=Product
+
|RelatedProduct=Easy_Tagging_for_SharePoint_online
|Image=EasyTaggingBannern.png
 
 
|Verlauf=
 
|Verlauf=
|Pfad=[[Main Page]] > Products > [[Easy_Tagging_for_SharePoint_online|Easy Tagging for SharePoint online]]
+
|Pfad=[[Main Page]] > Products > [[Easy_Tagging_for_SharePoint_online|Easy Tagging for SharePoint online]] > User Manual > [[Easy_Tagging_for_SharePoint_online/Manual/Authorize_at_Azure_AD|Authorize at Azure Active Directory]]
 
|Keywords=SharePoint, o365, office 365, auto tagging
 
|Keywords=SharePoint, o365, office 365, auto tagging
 
|SEO-Description=The Easy Tagging App for SharePoint online greatly reduces the time to provide large numbers of documents with consistent tags.
 
|SEO-Description=The Easy Tagging App for SharePoint online greatly reduces the time to provide large numbers of documents with consistent tags.
 
|en_link=
 
|en_link=
 
}}
 
}}
 +
 
<div class="row">
 
<div class="row">
 
<div class="col-xs-12 col-md-8 col-lg-9 col-xl-10">
 
<div class="col-xs-12 col-md-8 col-lg-9 col-xl-10">
 
<p>
 
<p>
Finding documents in Sharepoint online/Office 365 can be tedious. If you want to restrict your search to certain document types (like: reports, inquiries, CVs, sales orders, invoices) you either end up with too many irrelevant search hits or relevant documents don't show up because they don't include the search term. If you rely on Sharepoint's fulltext search capabilities only, then your users will be frustrated and spend too much time to find the right documents.
+
Before you are able to use the "MailDispatcher"-feature of the EasyTagging App, you have to authorize the EasyTagging App in your Azure Active Directory.
 
</p>
 
</p>
 
<p>
 
<p>
You can provide your users with a better search experience if you use search refiners. Users can further refine their search result by clicking on the refiner values, e.g. to retrieve "sales orders" or "invoices", only. Before you are able to create meaningful search refiners, you have to arrange for a couple of pre-requisites which include tagging documents with tags. This guide shows you how to automatically tag documents with their type (e.g. invoice, sales order, cv, inquiry) and how to provide search refiners that contain these document types.
+
Please follow this sequence of steps. If you require assistance then we are happy to help!
 
</p>
 
</p>
<div class="row">
 
<!-- --><div class="col-lg-6">
 
== Frustrating search experience without meaningful refiners: ==
 
<html>
 
<div class="center"><div class="floatnone"><a href="/mediawiki_en/images/a/a2/Fulltextsearch3.JPG" class="image"><img alt="Tagcloud" src="/mediawiki_en/images/a/a2/Fulltextsearch3.JPG" width="100%" height="100%" style="vertical-align: middle" srcset="/mediawiki_en/images/a/a2/Fulltextsearch3.JPG 1x" data-file-width="" data-file-height=""></a></div></div>
 
</html>
 
<br>
 
''Entering the search term "order" returns a lot of irrelevant documents (e.g. a CV) and even misses some sales order documents.''
 
<!-- --></div>
 
<!-- --><div class="col-lg-6">
 
== Better: filter documents by type, language, etc: ==
 
<html>
 
<div class="center"><div class="floatnone"><a href="/mediawiki_en/images/9/9f/Capture-refinement3.JPG" class="image"><img alt="Tagcloud" src="/mediawiki_en/images/9/9f/Capture-refinement3.JPG" width="100%" height="100%" style="vertical-align: middle" srcset="/mediawiki_en/images/9/9f/Capture-refinement3.JPG 1x" data-file-width="" data-file-height=""></a></div></div>
 
</html>
 
<br>
 
''If you provide search refiners, then the users will be able to precicely filter for all "sales order" documents, for instance.''
 
<!-- --></div>
 
</div> <!-- row -->
 
 
<p>
 
The following steps assume that you have Sharepoint Online/Office 365 and a library that contains at least dozens of documents or scanned documents (pdf or image formats). If you are familiar with certain configuration aspects of Sharepoint then you will need 30 minutes to go them through in your tenant. If you require assistance then we are happy to help!</p>
 
 
 
== Watch the steps in the video: ==
 
<div>
 
<p>
 
{{#widget:YouTube
 
|id=hMaEIa2DMNs
 
}}
 
</p>
 
</div>
 
 
<div id="accordionwrapper" width="100%" style="">
 
<div class="spinner" style="display: block;">
 
  <div class="bounce1"></div>
 
  <div class="bounce2"></div>
 
  <div class="bounce3"></div>
 
</div>
 
<div id="accordion" width="100%" style="display: none;">
 
  <h2>Step 1: Prepare your library</h2>
 
<div>
 
<p>
 
 
<div class="row funktionen-row">
 
<div class="row funktionen-row">
 
<!-- --><div class="col-md-6 col-md-border funktionen" style="text-align: justify; ">
 
<!-- --><div class="col-md-6 col-md-border funktionen" style="text-align: justify; ">
=== 1. Create a termset with your document types ===
+
=== Open your Azure Active Directory ===
# Open the termstore manager (from the site settings)
+
Open your organisation's Azure Active Directory and select the "App registrations" action.
# Create a new termset, named "document types"  
 
# Create a term for each document type that you keep in your document library, e.g. inquiry, invoice, sales order, resume
 
 
<!-- --></div>
 
<!-- --></div>
<!-- --><div class="col-md-6 col-md-border funktionen imageExpand" style="text-align: justify; >[[File:Create_termset.png|center|middle]]</div>
+
<!-- --><div class="col-md-6 col-md-border funktionen imageExpand" style="text-align: justify; >[[File:App_registrations.PNG|x300px|center|middle]]</div>
 
</div>
 
</div>
 
<div class="row funktionen-row">
 
<div class="row funktionen-row">
 
<!-- --><div class="col-md-6 col-md-border funktionen" style="text-align: justify; ">
 
<!-- --><div class="col-md-6 col-md-border funktionen" style="text-align: justify; ">
=== 2. Create a column for your document library that contins the document types ===
+
=== Register an application ===
# Open the document library
+
#Click on the "Register an application" link and enter this information:
# Open the library advanced settings
+
:* Name: EasyTagging (or any other name of your choice)
# Click on "create column"
+
:* Supported account types: option 1: "Accounts in this organizational directory only"
# Enter the name of the new library column, e.g. "document type"
+
#Click on "Register" to submit the form.
# Select "managed metadata" as type
+
# Copy the value of the Application client id into a text editor, you will need that information later
# In the term set settings: select the termset "document type" (from the step above)
 
# Click on "Save" to close the form  
 
 
<!-- --></div>
 
<!-- --></div>
<!-- --><div class="col-md-6 col-md-border funktionen imageExpand" style="text-align: justify; >[[File:Create_column.png|center|middle]]</div>
+
<!-- --><div class="col-md-6 col-md-border funktionen imageExpand" style="text-align: justify; >[[File:App_registration_2.PNG|x300px|center|middle]]</div>
 
</div>
 
</div>
 
<div class="row funktionen-row">
 
<div class="row funktionen-row">
 
<!-- --><div class="col-md-6 col-md-border funktionen" style="text-align: justify; ">
 
<!-- --><div class="col-md-6 col-md-border funktionen" style="text-align: justify; ">
=== 3. Manually tag a couple of documents as examples (not all!) ===
+
=== Create a client secret ===
# Open the library settings and add the new column "Document types" to the default view of the library
+
# Click on the newly created application
# Open the "Quick Edit" view of the library.
+
# Select "Certificates & secrets"
# Populate the field "Document types" with meaningful values for a couple of documents per document type. It is not necessary to provide each document with a tag, but the more examples you provide, the better the results will be. You should achieve a coverage of 20% of all documents per document type (and at least 10 examples per document type).
+
# Click on the "New client secret"-action and fill in this information:
<big>You have now prepared everything required to teach the "Easy Tagging App" about your way to tag. You can now carry on and install the Easy Tagging App and train the "Learn Tags"-predictor.</big>
+
:* short description
 +
:* expiration
 +
# Click on "Add" to submit the form
 +
* Copy the value of the client secret into a text editor, you will need that information later
 
<!-- --></div>
 
<!-- --></div>
<!-- --><div class="col-md-6 col-md-border funktionen imageExpand" style="text-align: justify; >[[File:Tagexample.png|center|middle]]</div>
+
<!-- --><div class="col-md-6 col-md-border funktionen imageExpand" style="text-align: justify; >[[File:Client_secret1.PNG|x300px|center|middle]]</div>
 
</div>
 
</div>
</p>
 
</div>
 
  <h2>Step 2: Automatically tag all your documents</h2>
 
<div>
 
<p>
 
 
<div class="row funktionen-row">
 
<div class="row funktionen-row">
 
<!-- --><div class="col-md-6 col-md-border funktionen" style="text-align: justify; ">
 
<!-- --><div class="col-md-6 col-md-border funktionen" style="text-align: justify; ">
=== 1. Install the Easy Tagging App from the App Source (free evaluation!) ===
+
=== Grant permissions ===
# Open the site settings and click on "Add an App"
+
# Click on "API permissions"
# Click on "Sharepoint Store"
+
# Click on "Add a permission"
# In the Sharepoint Store: enter "diqa" as search term
+
# Select the "Microsoft Graph" API
# Click on the "Easy Tagging" card to initiate the installation.
+
# Select "Application permissions" as type of permission
<br><br>
+
# Tick the checkboxes for the "Mail.ReadBasic.All", "Mail.Read" and "Mail.Send" permissions
:Direct link to the Microsoft App Store:
+
# Click on "Add permissions" to submit the form
<html><a href="https://appsource.microsoft.com/en-us/product/office/WA200000136?tab=Overview" target="_self" title="Go to Microsoft AppSource"> &#9654;&nbsp;Got to Microsoft AppSource</a></html>
 
 
 
 
<!-- --></div>
 
<!-- --></div>
<!-- --><div class="col-md-6 col-md-border funktionen imageExpand" style="text-align: justify; >[[File:Appstore.png|center|middle]]</div>
+
<!-- --><div class="col-md-6 col-md-border funktionen imageExpand" style="text-align: justify; >[[File:Permissions_new.PNG|x300px|center|middle]]</div>
 
</div>
 
</div>
 
<div class="row funktionen-row">
 
<div class="row funktionen-row">
 
<!-- --><div class="col-md-6 col-md-border funktionen" style="text-align: justify; ">
 
<!-- --><div class="col-md-6 col-md-border funktionen" style="text-align: justify; ">
=== 2. Launch the app and grant it the requested permissions ===
+
=== Grant admin consent ===
# Open the site contents again where you should find the newly installed Easy Tagging App
+
# In the "Configured permissions" blade: click on "Grant admin consent"
# Click on the App and grant it the requested permissions.
 
# The configuration page of the app opens in a new tab.
 
 
<!-- --></div>
 
<!-- --></div>
<!-- --><div class="col-md-6 col-md-border funktionen imageExpand" style="text-align: justify; >[[File:Launch_the_app_modern.png|center|middle]]</div>
+
<!-- --><div class="col-md-6 col-md-border funktionen imageExpand" style="text-align: justify; >[[File:Adminconsent_new.PNG|x300px|center|middle]]</div>
 
</div>
 
</div>
 
<div class="row funktionen-row">
 
<div class="row funktionen-row">
 
<!-- --><div class="col-md-6 col-md-border funktionen" style="text-align: justify; ">
 
<!-- --><div class="col-md-6 col-md-border funktionen" style="text-align: justify; ">
=== 3. Connect the Easy Tagging App with the IDAS service (1/2) ===
+
=== Enter the Application ID and Secret into the Easy Tagging App ===
# In the configuration page of the Easy Tagging App: click on the "Predictors & Taggers" tab
+
# Open the EasyTagging App from within your Sharepoint site
# Click on the link "Click here to connect to IDAS"
+
# Click on "create new mail dispatcher" which opens a dialog
<!-- --></div>
+
# In the dialog click on "Click to enter authorization credentials" which opens another dialog
<!-- --><div class="col-md-6 col-md-border funktionen imageExpand" style="text-align: justify; >[[File:Apptab.png|center|middle]]</div>
+
# In the dialog "Enter or edit authorization credentials" enter this information:
</div>
+
:* client application id from the steps above
 +
:* client secret from the steps above
 +
# click on "Store changes and close dialog"
 +
# Enter the rest of the information to configure the mail dispatcher
 +
# Test the mail dispatcher
 +
If the mail dispatcher fails (you will see the error message in the dispatcher log) then you should review your application permissions.
 +
Drop us an email if you have problems: [email protected]
  
<div class="row funktionen-row">
 
<!-- --><div class="col-md-6 col-md-border funktionen" style="text-align: justify; ">
 
=== 4. Connect the Easy Tagging App with the IDAS service (2/2) ===
 
# In the connection dialog: select the "IDAS Evaluation Service" tab
 
# Click on "I accept the terms of use" tick box
 
# If the service status says "IDAS evaluation service is available", then click on the "connect" button. If the status says something different: click on "refresh status".
 
# The dialog closes and you can setup a predictor.
 
 
<!-- --></div>
 
<!-- --></div>
<!-- --><div class="col-md-6 col-md-border funktionen imageExpand" style="text-align: justify; >[[File:Connect2.png|center|middle]]</div>
+
<!-- --><div class="col-md-6 col-md-border funktionen imageExpand" style="text-align: justify; >[[File:Easytagging.PNG|x300px|center|middle]]</div>
 
</div>
 
</div>
<div class="row funktionen-row">
 
<!-- --><div class="col-md-6 col-md-border funktionen" style="text-align: justify; ">
 
=== 5. Launch the "Learning Wizard" in your library ===
 
# After you have created a connection to the IDAS Evaluation service you can launch the "Learning Wizard" which will guide you through the process to learn from your examples and to tag your documents.
 
# Return to your library and open the "Library Settings" ribbon.
 
# Click on the "Learning Wizard" icon which launches the wizard in a dialog.
 
# Go through the three steps:
 
## Click on "Click to start the wizard"
 
## Step 1: select the language that is used in most of the documents of the library. If you documents in other languages: just select english.
 
## Step 1: in the field "Learn to predict tags from this managed metadata column": select the "document types" column that you created in the earlier steps
 
## Step 2: your library is analysed for sufficient examples. If you don't have enough examples: please add further examples before you continue with the wizard.
 
## Step 3: select the column which will receive the document type tags: just keep the selection.
 
## Step 3: click on the link "Start Learning and Tagging".
 
# The learning and tagging processes are running in the background.
 
# You can inspect the progress in the library ribbon "Predictors + Taggers"
 
<!-- --></div>
 
<!-- --><div class="col-md-6 col-md-border funktionen imageExpand" style="text-align: justify; >[[File:Start_learning_wizard.JPG|center|middle]]</div>
 
</div>
 
<div class="row funktionen-row">
 
<!-- --><div class="col-md-6 col-md-border funktionen" style="text-align: justify; ">
 
=== 6. Important: re-index your document library ===
 
# Opent the settings of your library
 
# Click on "re-index document library"
 
# Click on "Ok" to close the form
 
<big>Now all your documents in the library have been provided with tags, and the search index is being updated in the background. You can now carry on and setup the search page that uses these tags.</big>
 
<!-- --></div>
 
<!-- --><div class="col-md-6 col-md-border funktionen imageExpand" style="text-align: justify; >[[File:Library_settings.JPG|center|middle]]</div>
 
</div>
 
</p>
 
</div>
 
  <h2>Step 3: Create a search center that includes the search refiners</h2>
 
<div>
 
<p>
 
<div class="row funktionen-row">
 
<!-- --><div class="col-md-6 col-md-border funktionen" style="text-align: justify; ">
 
=== 1. Create an Enterprise Search Center ===
 
# Open the contents of your Sharepoint site and click on "subsites".
 
# Create a new sub site by clicking on the "New" action link.
 
# A form opens where you specify the new sub site.
 
# In the template field: select "Enterprise/Basic Search Center".
 
# Click on "Create" to create the new seach center.
 
<!-- --></div>
 
<!-- --><div class="col-md-6 col-md-border funktionen imageExpand" style="text-align: justify; >[[File:Create_search_center.JPG|center|middle]]</div>
 
</div>
 
<div class="row funktionen-row">
 
<!-- --><div class="col-md-6 col-md-border funktionen" style="text-align: justify; ">
 
=== 2. Adjust the search schema: map the crawled property to a refinable managed property ===
 
# Open the Sharepoint admin center for your tenant.
 
# Click on the "Search" section
 
# In the Search section: click on "Search schema"
 
# In the "Search schema" settings: activate the tab "Crawled properties"
 
# Search for all crawled properties that start with the string "ows_"
 
# Select the crawled property that relates to your "document type"-managed property, e.g. "ows_Document_x0020_type"
 
# Create a mapping to the managed property "RefinableString01" (or 00, or any other number).
 
# Save the settings.
 
<!-- --></div>
 
<!-- --><div class="col-md-6 col-md-border funktionen imageExpand" style="text-align: justify; >[[File:Searchschema.JPG|center|middle]]</div>
 
</div>
 
<div class="row funktionen-row">
 
<!-- --><div class="col-md-6 col-md-border funktionen" style="text-align: justify; ">
 
=== 3. Add the new refiner to the search page ===
 
# Open the search center
 
# Open the search results page (named "results.aspx")
 
# Click on "Edit page"
 
# In the page edit view: open the property settings of the Refinement webpart
 
# Click on the button "Choose refiners"
 
# In the "refinement configuration" dialog: add the refinable managed propery
 
(from the search schema step), like: RefinableString00 (or 01 etc).
 
# You should see sample values that contain you document types.
 
# Click on "Ok" to add RefinableString00 to the refiner
 
# Save the modified properties of the webpart by clicking on "OK"
 
# Store the modified page.
 
<!-- --></div>
 
<!-- --><div class="col-md-6 col-md-border funktionen imageExpand" style="text-align: justify; >[[File:Search_refiner.JPG|center|middle]]</div>
 
</div>
 
<div class="row funktionen-row">
 
<!-- --><div class="col-md-6 col-md-border funktionen" style="text-align: justify; ">
 
=== 4. verify the search results ===
 
# Open the search center
 
# Enter "*" as search string and submit the query
 
# Inspect the refiner values: they should include your document types
 
# Click on a refiner value, like "invoice", in order to restrict your search results to contain only invoices and bills.
 
 
<big>If the new refiner does not contain values then you have to wait until the Sharepoint online search engine has completed re-indexing your library. If still no values show up then you have to go back to your library settings and click on "re-index library".</big>
 
<!-- --></div>
 
<!-- --><div class="col-md-6 col-md-border funktionen imageExpand" style="text-align: justify; >[[File:Searchresults.JPG|center|middle]]</div>
 
</div>
 
</p></div></div>
 
==What's next?==
 
* Add refiners for the document language like: english, french, german, spanisch
 
** The Easy Tagging App has a built-in predictor that detects the language that is used in documents. You can simply use that predictor in a tagger to tag all your documents with the language. Similar to the steps in section 3 you would simply create another refiner that allows users to restrict their search results to certain languages.
 
* Add refiners for important words:
 
** The Easy Tagging App is able to identify important words from documents and store them in the termstore as a new termset. If you let the tagger tag your documents with them, then your users can use them to filter their search results.
 
 
 
==Questions?==
 
==Questions?==
 
{{Emailformular
 
{{Emailformular
Line 237: Line 90:
 
|Placeholder=
 
|Placeholder=
 
}}
 
}}
</div></div>
+
</div>
 
<div class="hideSM col-md-4 col-lg-3 col-xl-2">
 
<div class="hideSM col-md-4 col-lg-3 col-xl-2">
 
{{Linkbox
 
{{Linkbox
 
|color=#a0b844  
 
|color=#a0b844  
|align=left
+
|heading=related products
|heading=Links
 
 
|links=
 
|links=
{{ButtonOpenTab|solid=solid|expandsection=Evaluate for free|text=Evaluate for free}}<br>
+
* [[Easy_Tagging_for_SharePoint_online|Easy Tagging App]]
{{ButtonOpenTab|solid=solid|expandsection=Get your commercial license|text=Get your commercial license}}<br>
 
{{ButtonOpenTab|solid=solid|expandsection=Features + installation|text=All features}}<br>
 
{{ButtonOpenTab|solid=solid|expandsection=News about the product|text=News about the product}}
 
 
}}
 
}}
{{Linkbox
 
|color=#a0b844
 
|heading=Video
 
|align=center
 
|links=
 
{{#widget:YouTube
 
|width=100%
 
|height=100%
 
|id=8_ss16-t2B0}}
 
{{ButtonOpenTab|fontsize=small|expandsection=Watch the video|text=Watch the video}}}}
 
{{Ansprechpartner|hansch}}
 
 
 
</div>
 
</div>
 
</div>
 
</div>

Latest revision as of 10:04, 8 April 2021

Main Page > Products > Easy Tagging App for Sharepoint online > User Manual > Authorize at Azure Active Directory
Manual

User Manual: Authorize at Azure Active Directory

Before you are able to use the "MailDispatcher"-feature of the EasyTagging App, you have to authorize the EasyTagging App in your Azure Active Directory.

Please follow this sequence of steps. If you require assistance then we are happy to help!

Open your Azure Active Directory

Open your organisation's Azure Active Directory and select the "App registrations" action.

App registrations.PNG

Register an application

  1. Click on the "Register an application" link and enter this information:
  • Name: EasyTagging (or any other name of your choice)
  • Supported account types: option 1: "Accounts in this organizational directory only"
  1. Click on "Register" to submit the form.
  2. Copy the value of the Application client id into a text editor, you will need that information later
App registration 2.PNG

Create a client secret

  1. Click on the newly created application
  2. Select "Certificates & secrets"
  3. Click on the "New client secret"-action and fill in this information:
  • short description
  • expiration
  1. Click on "Add" to submit the form
  • Copy the value of the client secret into a text editor, you will need that information later
Client secret1.PNG

Grant permissions

  1. Click on "API permissions"
  2. Click on "Add a permission"
  3. Select the "Microsoft Graph" API
  4. Select "Application permissions" as type of permission
  5. Tick the checkboxes for the "Mail.ReadBasic.All", "Mail.Read" and "Mail.Send" permissions
  6. Click on "Add permissions" to submit the form
Permissions new.PNG

Grant admin consent

  1. In the "Configured permissions" blade: click on "Grant admin consent"
Adminconsent new.PNG

Enter the Application ID and Secret into the Easy Tagging App

  1. Open the EasyTagging App from within your Sharepoint site
  2. Click on "create new mail dispatcher" which opens a dialog
  3. In the dialog click on "Click to enter authorization credentials" which opens another dialog
  4. In the dialog "Enter or edit authorization credentials" enter this information:
  • client application id from the steps above
  • client secret from the steps above
  1. click on "Store changes and close dialog"
  2. Enter the rest of the information to configure the mail dispatcher
  3. Test the mail dispatcher

If the mail dispatcher fails (you will see the error message in the dispatcher log) then you should review your application permissions. Drop us an email if you have problems: [email protected]

Easytagging.PNG

Questions?

EU Dataprotection Terms

* These fields are required.

related products