Easy Taxonomy Web Service allows you to integrate the Easy Taxonomy™ solution with external systems; Once deployed, the web service allows external systems to obtain a Json formatted file that includes the latest released versions of the taxonomy trees by calling the web service URL.
The Following Steps explain in details how to deploy and use the Web Service:
To learn more about how to call the Web Service once it is deployed, please refer to the article How to Invoke the Web Service.
Deploy the Web Service Function in Azure Portal
Download the Deployment Package
The Deployment package contains the code to be installed in the Azure Function, download the Zip file in the Attachments section below.
Create the Function App in Azure
Follow the steps in this article to create your first function in Azure Portal.
Deploy the Function App in azure
1. Download and install the Azure CLI (Azure Command-Line Interface)
2. Open the PowerShell and run the command-line to login
3. Run the command-line to deploy function app
Complete Function App Configuration
1. Sign in to the Azure portal with your Azure account.
2. Open the Function app
3. Click on Configuration option in left menu
4. Create the Following Application Settings
- SiteUrl: The SharePoint site where Easy Taxonomy™ is installed
- ConfigListName: The name of the list containing Easy Taxonomy™ configuration, usually "Taxonomy Configuration".
- ClientID: The client ID retrieved during the App registration, refer to the section Register Application and Grant Permissions below.
- ClientSecret: The client secret retrieved during the App registration, refer to the section Register Application and Grant Permissions below.
Get the Function App URL
1. Sign in to the Azure portal with your Azure account.
2. Navigate to the Function Overview Page
3. Click on the TaxonomyReport Function
4. In the top menu select Get Function URL
5. Copy the displayed URL
6. To test the URL, pass it into the web browser address bar and hit enter, the system will display the Json formatted file containing the latest published version of the taxonomy(ies).
Register Application and Grant Permissions
For the Web Service to work, the function has to be registered in the SharePoint tenant. follow the steps below to register the app and retrieve the Client Id and Client Secret Parameters.
Create App Identifier
1. Navigate to the SharePoint site where Easy Taxonomy™ is installed, and then call the appregnew.aspx page (e.g. https://contoso.sharepoint.com/sites/EasyTaxonomy/_layouts/15/appregnew.aspx).
2. In the displayed page click on the Generate button to generate a Client Id and a Client Secret and enter the remaining information like shown in the screen-shot below.
Important Store the retrieved information (Client Id and Client Secret) since you'll need it in the next step. |
Grant Permissions to the App
Once the App Identifier is created, next step is to grant permissions to the app. Since we're granting tenant scoped permissions this granting can only be done via the appinv.aspx page on the tenant administration site.
1. Navigate to the SharePoint site where Easy Taxonomy™ is installed, and then call the appinv.aspx page (e.g. https://contoso.sharepoint.com/sites/EasyTaxonomy/_layouts/15/appinv.aspx ).
2. Once the page is loaded paste your Client Id in the App Id field and click the lookup button
3. Copy and paste the XML below into the field "Permissions required by the app".
4. When you click Create you'll be presented with a permission consent dialog. Click "Trust It" to grant permissions to the App.
Attachments
Was this article helpful?
That’s Great!
Thank you for your feedback
Sorry! We couldn't be helpful
Thank you for your feedback
Feedback sent
We appreciate your effort and will try to fix the article