Installation Guide – Office 365

TermSet™ Installation Guide – Office 365

Introduction Welcome to the installation guide for TermSet™ in an Office 365 environment. This guide will step you through the entire process, from preparing your Office 365 environment, through installing and activating the TermSet app, to post-installation tasks. IMPORTANT: Do no use this guide to install TermSet in a SharePoint on-premise environment. Alternative guides for various environment are available from http://www.termset.com

Contents INTRODUCTION....................................................................................................................................................................... 2 PREPARING YOUR OFFICE 365 ENVIRONMENT............................................................................................................................... 3 App Catalog Site ..................................................................................................................................................................... 3 Term Store Administrator Accounts ....................................................................................................................................... 4 INSTALLING TERMSET .............................................................................................................................................................. 5 Registering the App ................................................................................................................................................................ 6 Installing the App ................................................................................................................................................................... 6 Deploying the App .................................................................................................................................................................. 7 ACTIVATING TERMSET ............................................................................................................................................................. 8 POST-INSTALLATION TASKS ....................................................................................................................................................... 8 Setting Storage Options.......................................................................................................................................................... 8 Optional: Setting the Default Content Access Account .......................................................................................................... 8 Optional: Setting the Default Taxonomy Account .................................................................................................................. 9 TROUBLESHOOTING AND SUPPORT.............................................................................................................................................. 9

Document Insights Limited™ | Registered in England and Wales 9147037 15 Warwick Road, Stratford-Upon-Avon, Warwickshire, CV37 6YW, United Kingdom

TermSet™ Installation Guide – Office 365

Preparing your Office 365 Environment In this section, you will step through some processes to ensure your Office 365 environment is configured to enable Apps to be deployed. You will also ensure that the Office 365 Managed Metadata service is configured correctly, and that you have identified accounts to be used in specific scenarios.

App Catalog Site TermSet for Office 365 is an App that is installed in Office 365 sites. Before you can add TermSet to a site you need to register it and then add it to your App Catalog, which is a special type of Office 365 site. Follow the steps below to determine whether you have an App Catalog: Procedure: To verify or create an App Catalog site 1.

Log into Office 365 as an administrator.

2.

Click the App Launcher as shown, and then click the Admin tile:

3.

Near the bottom of the left panel, in the Admin section, click SharePoint, as shown:

4.

In the left panel, click apps.

5.

In the main section of the page, click App Catalog.

6.

If you are taken to a SharePoint site, then you already have a valid App Catalog and you can continue with step #11. Otherwise, continue with step #7.

Document Insights Limited™ | Registered in England and Wales 9147037 15 Warwick Road, Stratford-Upon-Avon, Warwickshire, CV37 6YW, United Kingdom

TermSet™ Installation Guide – Office 365

7.

If you do not have an existing App Catalog site, you will see something similar to the below:

Ensure the Create a new app catalog site option is selected, and then click OK. 8.

On the Create App Catalog Site Collection page, provide appropriate information for each field, and then click OK. The site collection creation process starts, and you are returned to the list of site collections. The creation process can take a few minutes, so you will need to wait until that has completed.

9.

When the App Catalog site collection has been created, click it in the site collection list. The site collection properties dialog appears.

10. In the dialog, click the hyperlink to go to the App Catalog site collection. 11. Make a note of the URL of your App Catalog site – you will need to know this later.

Term Store Administrator Accounts By default, Office 365 does not assign any accounts as Term Store Administrators. However, you need to assign a Term Store Administrator before the product can function as expected. IMPORTANT: You need to make a decision about whether to use an existing administrator's account (such as your own) for use by TermSet, or whether to set up and use a new account specifically for use by TermSet. There is no single correct answer – it depends on factors such as whether you want to provision an account just for this use, issues such as password expiry policies, and so on. In general, though, we recommend creating a new dedicated account and ensuring it can log in to Office 365.

Procedure: To assign a Term Store Administrator 1.

Log into Office 365 as an administrator.

Document Insights Limited™ | Registered in England and Wales 9147037 15 Warwick Road, Stratford-Upon-Avon, Warwickshire, CV37 6YW, United Kingdom

TermSet™ Installation Guide – Office 365

2.

Click the App Launcher as shown, and then click the Admin tile:

3.

Near the bottom of the left panel, in the Admin section, click SharePoint, as shown:

4.

In the left panel, click term store.

5.

In the central panel, locate the Term Store Administrators box, as shown:

6.

Enter at least one account that you want to be used by TermSet when it creates groups, term sets, and terms in the term store.

7.

Near the bottom of the page, click Save.

Installing TermSet In this section, you will register and install the TermSet app. You will then deploy the app to the site collections where you want to use it. Document Insights Limited™ | Registered in England and Wales 9147037 15 Warwick Road, Stratford-Upon-Avon, Warwickshire, CV37 6YW, United Kingdom

TermSet™ Installation Guide – Office 365

Registering the App Procedure: To register the TermSet app 1.

Log into Office 365 as an administrator.

2.

Navigate to the App Catalog site that you previously created (or made a note of) in the previous section.

3.

Navigate to the following page: /_layouts/15/AppRegNew.aspx For example, if your App Catalog site is https://acme.sharepoint.com/sites/AppCatalog then you should navigate to: https://acme.sharepoint.com/sites/AppCatalog/_layouts/15/AppRegNew.aspx The page should resemble the following:

4.

In the Client Id box, enter 22324c7d-0236-4a70-b052-3a746f86a8c1

5.

In the Client Secret box, enter 9Fx74BixklZF/i3pGVVdBlcqN1qqCjVwwfvG0MdmYMI=

6.

In the Title box, enter TermSet

7.

In the App Domain box, enter termsetoffice365.azurewebsites.net

8.

In the Redirect URI box, enter https://termsetoffice365.azurewebsites.net

9.

Click Create.

10. When you are informed that the app identifier has been successfully created, click OK. 11. Leave the browser running – you will use it in the next procedure.

Installing the App You will have received the TermSet installation package from Document Insights or a partner. Typically, the package will be zipped, so you first need to unzip it. The unzipped files include a file called TermSet.app. In the following procedure, you will upload TermSet.app. Procedure: To install the TermSet app 1.

In the left navigation, click Apps for SharePoint.

2.

Click Upload. The Add a document dialog appears.

3.

Browse to and select the TermSet.app file. Then click OK.

At this stage, the app is uploaded and is now available for use in your site collections. You will deploy it in the next section.

Document Insights Limited™ | Registered in England and Wales 9147037 15 Warwick Road, Stratford-Upon-Avon, Warwickshire, CV37 6YW, United Kingdom

TermSet™ Installation Guide – Office 365

Deploying the App You can choose to deploy the app with either the 'push' or the 'pull' approach. The following procedures step you through each approach.

The Pull Approach In the 'pull' approach, you add the app in the site collection where you want to use it. Procedure: To pull the TermSet app into a site collection 1.

Browse to a site collection where you want to add the TermSet app.

2.

In the left navigation, click Site Contents.

3.

Click the add an app tile.

4.

In the Apps you can add section, click the TermSet tile.

5.

In the Do you trust TermSet? dialog, click Trust It. The app is added, as shown:

The Push Approach In the 'push' approach, you add the app to the App Catalog site collection, and you can then deploy it to multiple site collections in one operation. Procedure: To push the TermSet app from the App Catalog to multiple site collections 1.

Browse to the App Catalog site.

2.

In the left navigation, click Site Contents.

3.

Click the add an app tile.

4.

In the Apps you can add section, click the TermSet tile.

5.

In the Do you trust TermSet? dialog, click Trust It. The app is added.

6.

Point the mouse to the TermSet app, and the ellipsis is shown, as follows:

7.

Click the ellipsis, and then click Deployment. Document Insights Limited™ | Registered in England and Wales 9147037 15 Warwick Road, Stratford-Upon-Avon, Warwickshire, CV37 6YW, United Kingdom

TermSet™ Installation Guide – Office 365

8.

Enter the URL of the first site collection to which you want to deploy the app into the top text box. Then click Add. The site collection is added to the list box

9.

Repeat step #8 for all the site collections to which you want to deploy the app.

10. Near the bottom of the page, click OK. 11. In the Do you trust TermSet? dialog, click Trust It. When you browse to each of those site collections, the app will already have been added and trusted.

Activating TermSet Before you can use the TermSet app, you must activate it in each site collection. When you obtained the app, Document Insights Limited or a partner should have given you a set of activation details that are unique to your organization. You will need those details to complete the activation process. Procedure: To activate TermSet in a site collection 1.

Browse to a site collection where TermSet has been installed.

2.

Browse to the site contents.

3.

Click the TermSet tile.

4.

The TermSet app will be launched, and you will be prompted to activate it. Click Yes.

5.

Enter the activation details that you have been provided with, and then click Apply.

Post-Installation Tasks Setting Storage Options After you have activated the first instance of TermSet in your first site collection, you will need to select the storage options for where your configuration data is stored. Procedure: To set storage options 1.

After you have activated TermSet (as in the previous procedure), in the left navigation click Settings.

2.

Click Storage Settings.

3.

Choose one of the options. a.

If you choose the Secure Private Azure Storage option, you will need the Account Name and the Account Key that is associated with your Azure storage account.

4.

Click Save.

5.

Wait for about one minute, and then in the dialog click OK.

6.

In the next dialog, click OK.

Congratulations! You are now ready to use TermSet. You do not need to set the storage for each site collection, but you can change the settings at any time from any site collection in the future.

Optional: Setting the Default Content Access Account To extract and analyze useful information in your documents (and to apply metadata if you choose), TermSet needs for you to specify an account that has access to the files and their columns in SharePoint. You can specify an account when prompted, or for convenience you can specify a default account in the Settings section, and then use that when needed. Procedure: To set a default content access account 1.

In TermSet, in the left navigation click Settings. Document Insights Limited™ | Registered in England and Wales 9147037 15 Warwick Road, Stratford-Upon-Avon, Warwickshire, CV37 6YW, United Kingdom

TermSet™ Installation Guide – Office 365

2.

Click Accounts.

3.

In the Default Content Access Account section, type the login name (usually an email address in an Office 365 environment) in the Account Name text box.

4.

In the Default Content Access Account section, type the password for the account in the Account Password text box.

5.

In the Default Content Access Account section, click Apply. IMPORTANT: The account details are NOT validated at this point, so please ensure you enter the details carefully. Also, do NOT attempt to set both the default content access account and the default taxonomy account in one operation – they each have their own [Apply] buttons.

Optional: Setting the Default Taxonomy Account To perform specific actions in your taxonomy (such as creating terms as part of a mapping), TermSet needs for you to specify an account that has access to the term store. You can specify an account when prompted, or for convenience you can specify a default account in the Settings section, and then use that when needed. NOTE: The account you set in the procedure below must be configured as a Term Store Administrator. Please refer to the 'Term Store Administrator Accounts' section in this installation guide. Procedure: To set a default taxonomy account 1.

In TermSet, in the left navigation click Settings.

2.

Click Accounts.

3.

In the Default Taxonomy Mapping Account section, type the login name (usually an email address in an Office 365 environment) in the Account Name text box.

4.

In the Default Taxonomy Mapping Account section, type the password for the account in the Account Password text box.

5.

In the Default Taxonomy Mapping Account section, click Apply. NOTE: The account details are NOT validated at this point, so please ensure you enter the details carefully. Also, do NOT attempt to set both the default content access account and the default taxonomy account in one operation – they each have their own [Apply] buttons.

Troubleshooting and Support For help with the installation procedures, please contact [email protected] To provide feedback about this installation guide, please contact [email protected]

Document Insights Limited™ | Registered in England and Wales 9147037 15 Warwick Road, Stratford-Upon-Avon, Warwickshire, CV37 6YW, United Kingdom