User Guide

Introduction

A simple way to check and automatically update your document.

Verifier for Office, Word
Multiple Office App Awards Winner

Remove links to contents and placeholders within your document, making it safe to share with others. Content and placeholders must be created using either the Designer & Wizard Apps or the Content Chooser App.

In the future the Verifier will highlight outdated elements in your document and allow you to easily update or reject the proposed changes. It will also check all of the text in your document against your companies dictionary helping you avoid misspelling your industries and organizations specific terms.

Launching

Top

In Word

Verifier Ribbon

Once the 'Verifier' Add-In has been deployed and assigned to you, it will automatically appear in the 'Home' tab of your Word application ribbon. To launch the Add-In just click on the 'Verify' button.

Please note:

The 'Verifier' Add-In is currently available in Word for Windows, Word for the Web, Word for Mac, and Word for iOS.

Please note:

If the 'Verifier' Add-In does not appear, make sure that you have signed-in to Word with your Microsoft 365 Work or School account. If that is the case and the Add-In is still not appearing, then please contact your internal IT department.

Signing In

Top

To get started with this Add-In/App you need to connect it with your existing Microsoft 365 Work or School account or with your Personal Microsoft Account. Follow these steps:

Verifier Welcome Page
  • Click on the 'Connect' (1) button.

  • Sign-in using your Microsoft 365 Work or School account or your Personal Microsoft Account.

    Please note:

    The actual sign in experience is provided by Microsoft. officeatwork does not offer any user accounts. Users must use their existing accounts to sign in to the Add-In.

  • Optionally, you might be asked to consent to the Add-In accessing your data. This step might have been taken care of by your internal IT department in advance. In that case you will not be asked.

  • Done.

Accounts

This Add-In accepts Microsoft 365 Work or School accounts. It also accepts Personal Microsoft Accounts including GitHub accounts.

Consenting

The first time you connect the App, you might be asked to consent to the permissions the App requires. Please go through those permissions carefully and grant consent as the App requires these permissions to function. If you do not grant consent the App will not work for you.

Please note:

Your IT administrator could go ahead and pre-consent on behalf of all users. That way you and your fellow users would not have to consent each individually. Your IT administrators can learn more about pre-consenting in the IT Operations Guide further below.

Add-In MenuS

Top

You can find the Add-In menus at the bottom of the Add-In. It currently consists of the 'officeatwork' logo (on the left) and (on the right) the 'Settings' menu, the 'Help' menu, and the 'User' menu. Clicking on the officeatwork logo will take you to the officeatwork website.

Please note:

Dependent on the officeatwork Add-In/App and it's configuration for your Microsoft 365 tenant, items available in the Add-In Menus may vary.

Settings

Settings menu
  • About: This will take you to the about pane that lists various information about this Add-In/App.

  • Rate: This will take you to the review page on Microsoft AppSource.

  • Document: This will take you to the document settings page of this Add-In/App.

Help

Help menu
  • Getting Started: Link to a page that will help you get started with this Add-In or App.

  • Documentation: Link to the documentation of the Add-In or App.

  • Help Center: Link to the officeatwork Help Center.

  • Yammer Community: Link to the officeatwork Yammer community.

  • Send us your Feedback: Link to an online feedback form you can use to reach out to officeatwork.

  • Roadmap: Link to the roadmap page of the Add-In or App.

Additionally to the above listed help offerings you might also want to consider these (free and paid) options:

  • Learn more links: Throughout the Add-In/App you will find 'Learn more' links that will take you to the documentation pages covering the topic you are currently viewing. This is the fastest way to pull up the relevant documentation.

  • Premium Support: Customers with a Premium Support Subscription can use additional support offerings and channels made available via the premium support subscription.

  • Your internal resources: You will most likely have internal resources covering the Business aspects or IT aspects of this Add-In or App. Please also consider reaching out to them when appropriate. Thank you.

User Menu

User menu
  • Signed-in User: You can see the photo, name and email address of the currently signed-in user at the top of the User menu.

  • Sign out: This option will allow you to sign out of this Add-In/App.

Scanning

Top

When launching the 'Verifier' it will automatically begin to scan your document for elements to check. In case if finds no elements it will present the 'no-elements-found' screen offering a 'Scan' button to re-scan your document.

Scan
  • Click on Scan.

  • Document is being scanned. If elements that can be verified are found it will present a 'Document' panel. If no elements are found it will return to the 'no-elements-found' screen.

  • Done.

Issues

Top

When the Verifier Add-In launches, it automatically starts verifying your document. If all goes well you will see a 'All UP-to-date' message in the Issues pane (1). If updates are found you will see the available updates listed (2) in the Ipane.

All UP-to-date

Whenever the document verification process found no issues, it will present a 'All UP-do-date' and a green tic in the issues pane (1).

Issues

Verify

In case you made changes to your document you can re-verify your document any time using the Verify feature on the issues panel.

  • Click the 'Verify' button to start the verification process for your document.

  • Observe the verification process and the outcome.

  • Done.

Updates

Each issue found will be listed in the issues list (2).

Updates

Update All

Clicking the 'Update All' button will resolve all issues found and update outdated linked items in your document.

  • Click the 'Update All' button.

  • All out-of-date linked items in your document will be updated.

  • Done.

Update

Selecting the 'Update' option on a specific item will resolve the issues found for that item only.

  • Click the 'Update' button in the item menu (3).

  • The out-of-date linked item in your document will be updated.

  • Done.

Highlight

Selecting the 'Highlight' option on a specific item will highlight the out-of-date linked item in your document.

  • Click the 'Highlight' button in the item menu (3).

  • The out-of-date linked item in your document will be highlighted.

  • Done.

Document

Top

The 'Document' panel lets you know how many placeholders on your document exist that are potentially linked to data.

Document

Unlink all

Clicking the «Unlink all» button will remove all links to placeholders and contents in your document. Please be aware that the unlinking process can not be undone.

  • Click the 'Unlink all' button.

  • The metadata of all linked elements is removed. The content of your document remains untouched. The Add-In will re-scan the document and end up on the 'no-elements-found' screen.

  • Done.

Scan

Clicking the 'Scan' button will re-scan the document for placeholders and contents and list any found items.

  • Click the 'Scan' button.

  • The document is being re-scanned for linked elements. If elements are found it will display the 'Documents' panel. If no elements are found it will display the 'no-elements-found' screen.

  • Done.

Elements

By clicking on the 'Elements' header you can toggle (show/hide) the list of elements in your document.

  • Click on the 'Elements' heading.

  • The list of elements is being toggled (shown or hidden).

  • Done.

Embedding Add-In

Top

Open Add-in together with a document

You might want this Add-In to open alongside with your document automatically. This can be achieved by actively embedding the Add-In into your currently open document.

To do this follow the steps below:

Document
  • Open the Add-In 'Settings' menu.

  • Click on the 'Document' option.

  • On the 'Document' pane choose your Embedding option (1).

  • Click 'Save' to save your changes.

Embedding options

Never

Choose this option if you do not want the Add-In to open together with your document (default setting).

Once

Choose this option if you want the Add-In to only open the next time you open your document, after that it shall not open automatically anymore. 

Always

Choose this option if you want to have the Add-In open together with your document all the time. Note that the Add-In will also open if you close your document with the Add-In closed and then re-open the document.

Business Operations Guide

Introduction

Top

This Business Operations Guide is aimed at users that are responsible for the successful implementation and running of the officeatwork Apps and Add-Ins in their organization. This guide also includes a Roadmap section where you can learn more about existing and upcoming features.

Apps & Add-Ins

Top

The following Apps and Add-Ins are included in the Verifer.

Supported Applications

The 'Verifier' runs within the following Microsoft 365 applications on Windows, Mac, iPad and Office Online:

Word
Word
Word
Edge
Word
Chrome
Word
Safari
Word
Firefox

Please note:

The 'Verifier' Apps might offer different features depending on the different Microsoft 365 applications on the various platforms.

Supported Storage Services

The  'Verifier' supports the following Microsoft 365 storage locations:

Word
SharePoint Online
Word
Teams
Word
OneDrive
Word
Microsoft Graph

Please note: SharePoint, Teams, and OneDrive can be deactivated on a tenant by tenant basis using the officeatwork Admin Center.

Supported User Accounts

The  'Verifier' supports the following user accounts:

Word
Office 365 Account
Word
Microsoft Personal Account

Variations

The  Apps and Add-Ins will offer different features based on the account you are using or if you are a subscription user or not. If you are evaluating the app without a subscription you will not be able to configure all the options a paying user with a business subscription would be able to. If you sign in using a personal Microsoft account you will also not be able to configure any settings. Additionally, features available only to Microsoft 365 Users like SharePoint Online will also be missing.

Personal

FREE

when using a personal Microsoft account.

Storage Locations

OneDrive

Microsoft Graph

Teams

SharePoint

Tenant Settings

Feature Settings

Custom feature settings like disabling OneDrive or removing the Yammer and Feedback form link.

Sample Libraries deactivated

Advertisement Free

New users will receive no e-mails from officeatwork.

Business

Trial

when using an Office 365 or Microsoft 365 account for evaluation purposes.

Supported Libraries

OneDrive for Business

Microsoft Graph

Teams

SharePoint

Tenant Settings

Feature Settings

Custom feature settings like disabling OneDrive or removing the Yammer and Feedback form link.

Sample Libraries deactivated

Advertisement Free

New users will receive no e-mails from officeatwork.

Business

Subscription

when using a paid subscription with a Office 365 or Microsoft 365 account.

Supported Libraries

OneDrive for Business

Microsoft Graph

Teams

SharePoint

Tenant Settings

Feature Settings

Custom feature settings like disabling OneDrive or removing the Yammer and Feedback form link.

Sample Libraries deactivated

Advertisement Free

New users will receive no e-mails from officeatwork.

Analytics

Top

officeatwork provides analytics support that will allow you to get insights into the usage of your assets and data used within the officeatwork Apps and Add-Ins. To capture this information you need to set up a data capturing stream that will allow the officeatwork Apps and Add-Ins to send your usage data into a storage location you own.

The attributes per event we provide are as follows:

  • action (Sample: 'Launched', 'Folder Loaded', 'Template Chosen', 'Document Creation Requested', etc.)

  • addInName (Sample: 'Template Chooser, 'Content Chooser', etc.)

  • assetExtension (Sample: 'docx', 'jpg', 'svg', 'html', 'xlsx', etc.)

  • assetId (Sample: '715IQYDHBZCGRAG5NOCVFIQUSBB7ITQ5LN' etc.)

  • assetName (Sample: 'Letter', 'Project Budget Sheet', 'Memorandum', etc.)

  • assetUrl (Sample: 'https://tenant.sharepoint.com/sites/AllCompany/Documents/General/Contents/Legal/TrademarkStatement.docx'

  • hostApplication (Sample: 'Excel', 'Word', 'SharePoint', 'Browser', etc.)

  • hostPlatform (Sample: 'Windows', 'iOS', 'Mac', 'Web', etc.)

  • hostVersion (Sample: '16.35.218.0', '2.27.709.0', '16.01', etc.)

  • sourceName (Sample: 'Corporate Templates', 'Sales Contents', etc.)

  • sourceType (Sample: 'OneDrive', 'Teams', 'SharePoint', 'Pixabay', etc.)

  • timestamp (Sample: 2018-10-11T12:27:22.205Z)

  • userDisplayName (Sample: 'Joe Miller', etc.)

  • userEmail (Sample: 'joe.miller@sample.com')

  • userId (Sample: '43d7d85d-e05e-4adf-bd1f-691b0a53bb64', etc.)

Power BI

To gain insights into your officeatwork apps and Add-In usage via Power BI you need to follow these three basic steps:

  • Set up a Streaming Data Set in Power BI

  • Register your Streaming Data Set API URL for each of your officeatwork Add-Ins and Apps using the officeatwork Admin Center

  • Create Reports in Power BI

Setting up your Power BI Streaming Data Set in Power BI

Please check out the Power BI documentation to learn how to set up a streaming data set. The steps below will provide some important additional details you will need to take into account when creating your Streaming Data Set:

  • On any of your Power BI workspaces click the '+' button (top right corner) in Power BI to create a new streaming dataset!

  • For the source of your dataset choose API.

  • For Dataset name provide any name you wish. Sample: 'officeatwork-usage'.

  • Create a field for ALL attributes we offer (Sample: 'action', 'addInName', etc.). Make sure to choose 'DateTime' for the timestamp attribute and 'Text' for all others in the format dropdown.

  • Make sure to switch on 'Historic data analysis'.

  • Once created you can get the API info for your new streaming data set and copy the value from the 'Push URL' starting with 'https://api.powerbi.com/... '. You will need this in the second step!

Register your Streaming Data Set API URL for your officeatwork Apps and Add-Ins

Please make sure that before you start this step that you have the 'Push URL' form the previous step in your clipboard.

  • Launch the officeatwork Admin Center

  • Select the app on the left you want to configure (for example the 'Template Chooser').

  • Click the 'Manage' button on the 'Analytics' panel.

  • Paste the 'Push URL' into the 'Power BI streaming dataset API endpoint URL'.

  • Click 'Save' at the bottom of the pane.

  • Done.

Create Reports in Power BI

You can now go ahead and create as many reports in Power BI as you wish. Please be aware that you need to use one of the officeatwork Apps or Add-Ins after connecting your Power BI streaming dataset for your reports to showy any officeatwork usage data!

Roadmap

Top

Planned

Released March 2020

Released June 2019

IT Operations Guide

Deployment

Top

Office Add-ins

Historically you might be used to deploy Office Add-Ins using MSI packages. This is not an option for our modern officeatwork cloud SaaS Office Add-Ins anymore as they are not built with the older (COM) platform dependent technology.

Please note:

We do not offer any MSI packages for our modern web-based Office Add-Ins.

Centralized Deployment

The by far best way of deploying Add-ins for Microsoft 365 is using the new 'Centralized Deployment' feature inside the Microsoft 365 admin center. This feature will allow you to deploy Add-Ins to your users on all devices and platforms. There are no local installations necessary for this to work.

You can reach 'Centralized Deployment' by going to: Microsoft 365 admin center > Settings > Add-ins > + Deploy Add-In

Please note:

You might want to check if your tenant is ready for 'Centralized Deployment'. Here is a link to the Microsoft support document called 'Determine if Centralized Deployment of add-ins works for your organization' that will explain the requirements in detail. Microsoft also offers an Add-In (Word & Excel) that will perform automated checks to see if your infrastructure is ready for Centralized Deployment. It's called 'Compatibility Checker for Centralized Deployment'.

Please note:

You must be an Office 365 admin to be able to sign in to the Office 365 Admin portal. You will also need to use the ‘I want to add an Add-In from the Office Store‘ option as this will keep your add-ins up-to-date automatically!

Additional Resources

Sharepoint add-in catalog (for older Office versions)

Modern Web Office Add-ins can also be deployed for older Office versions like Office 2013. For that you can use the SharePoint Add-In catalog deployment method. Please note that some features like showing icons in the ribbon in Office will not be available via this deployment path. This deployment method will though work for the officeatwork 365 Template Chooser and Content Chooser Add-Ins. Please expect limited functionality due to missing API's in older Office versions like Office 2013. Check out our compatibility section below to learn more about any missing features for your Office version.

Additional Resources

Office Store

You can find our Add-Ins within the Office Store experience provided within the Office applications. Just use the 'Get it now' button to acquire and deploy the Add-In for the signed-in user only.

Appsource

You can find our Add-Ins for Office on AppSource. Just use the 'Get it now' button in AppSource to acquire and deploy the Add-In. If you are signed-in as a Microsoft 365 administrator the 'Get it now' button should take you to the centralized deployment experience.

Please note:

If you can manage your AppSource purchases in the Microsoft 365 Admin Center. Here is a link to the Manage subscriptions in Admin Center documentation.

Compatibility

Top

Check out the minimal Office versions required for running the officeatwork Web Add-In on your devices. Also see what specific features of the individual Add-Ins are supported from what version onward.

Minimal Office Version

Minimal Office version required to run the officeatwork App.

Windows

Office 2013 (MSI)

not available

Office 2016 (MSI)

not available

Office 2019 (MSI)

all versions

Office 365 (C2R)

1612 (7668.1000)

Office Online

Office 365

March 2017

Mac OS

Office 365

15.32

iPad

Office 365

2.22

General Add-IN Features

Ribbon Icon

Access App via one or multiple icon in the Office ribbon.

Windows

Office 2013 (MSI)

not available

Office 2016 (MSI)

not available

Office 2019 (MSI)

all versions

Office 365 (C2R)

1603 (6769.0000)

Office Online

Office 365

January 2016

Mac OS

Office 365

15.33.0 (1704.0900)

iPad

Office 365

not applicable

Centralized Deployment

Deploying Word, Excel and PowerPoint Apps in Office.

Windows

Office 2013 (MSI)

not available

Office 2016 (MSI)

not available

Office 2019 (MSI)

all versions

Office 365 (C2R)

1704 (8067.2115)

Office Online

Office 365

January 2016

Mac OS

Office 365

15.34.0 (1705.1500)

iPad

Office 365

not applicable

Automatically open a task pane

Automatically load an App and open a task pane when opening a specific Word, Excel or PowerPoint document.

Windows

Office 2013 (MSI)

not available

Office 2016 (MSI)

not available

Office 2019 (MSI)

all versions

Office 365 (C2R)

16.0 (8121.1000)

Office Online

Office 365

January 2016

Mac OS

Office 365

15.34.0 (1705.1500)

iPad

Office 365

not applicable

MFA (Multi-Factor authentication)

Top

All the officeatwork Add-Ins require Microsoft accounts to sign-in to the Add-Ins. If you have activated MFA (Multi-Factor Authentication) for our Microsoft Work or School account in Microsoft 365, it will automatically also apply for the officeatwork Add-Ins. You as an Admin do not have to configure any dedicated settings for the officeatwork Add-ins as they automatically 'inherit' your sign-in policy you defined for your organization.

Pre-Consenting

Top

Administrators of a Microsoft 365 tenant can pre-consent access to required scopes by clicking the 'Pre-Consent' buttons listed in the Data Scopes section below. Once done, users of your tenant will not have to individually grant access to the various scopes required by the officeatwork Add-In/App.

Data Scopes

Following our security principles our Apps and Add-Ins do not have their own independent data access definitions. What the Apps and Add-Ins can access is always governed by the data provider.

Microsoft 365

Here are some principles that apply to all the access our Apps and Add-Ins have in Microsoft 365:

  • Data access is always scoped to the signed-in user.

  • officeatwork employees do not get access to your data.

  • Your data is protected by the Microsoft 365 security framework including multi-factor authentication.

  • The actual App or Add-In sign in screens are provided and hosted by Microsoft. You can see that as the officeatwork sign in process displays the identical sign in screens and flow as if you were to sign in to Microsoft 365.

  • Users can only access data within the Apps that they can access based on their existing access rights in Microsoft 365.

  • This also means that a user can not access data of another user via the officeatwork Apps.

Sign-In
Pre-Consent

For the sign-in process the Add-In requires the following scopes:

  • openid user permission to enable users to sign in to the add-in with their organizational and/or Microsoft Account.

  • openid profile user permission to show the signed-in user in the Add-In. This is helpful to assure/confirm the user what account was used to sign-in to the Add-In.

  • openid offline_access user permission to enable automatic sign in via refresh-tokens, as without users would have to manually Sign-In every single time they launch the Add-In. This scope is only required for Non-SSO enabled host applications.

  • User.Read user permission to be able to read the user's basic properties.

  • openid email user permission to activate the evaluation subscription in the Add-In. (this scope will be retired soon)

  • User.ReadWrite user permission to be able to save the user's settings. (this scope will be retired soon)

OneDrive
Pre-Consent

For verifying the content of linked contents stored in OneDrive the Add-In requires the following scopes:

  • Files.Read user permission to be able to read the signed-in user's files.

For verifying the content of linked contents stored in OneDrive the Add-In requires the following scopes:

  • Files.Read.All user permission to be able to read all the files the signed-in user has access to.

SharePoint
Pre-Consent

For verifying the content of linked contents and placeholders stored in SharePoint the Add-In requires the following scopes:

  • Sites.Read.All admin permission to enable reading data from SharePoint Online.

All scopes
Pre-Consent

For verifying the content of linked contents stored in OneDrive the Add-In requires the following scopes:

  • openid user permission to enable users to sign in to the add-in with their organizational and/or Microsoft Account.

  • openid profile user permission to show the signed-in user in the Add-In. This is helpful to assure/confirm the user what account was used to sign-in to the Add-In.

  • openid offline_access user permission to enable automatic sign in via refresh-tokens, as without users would have to manually Sign-In every single time they launch the Add-In. This scope is only required for Non-SSO enabled host applications.

  • User.Read user permission to be able to read the user's basic properties.

  • openid email user permission to activate the evaluation subscription in the Add-In. (this scope will be retired soon)

  • User.ReadWrite user permission to be able to save the user's settings. (this scope will be retired soon)

  • Files.Read user permission to be able to read the signed-in user's files.

  • Files.Read.All user permission to be able to read all the files the signed-in user has access to.

  • Sites.Read.All admin permission to enable reading data from SharePoint Online.

Security

Top

You can find more information about the security of the officeatwork Add-Ins and apps on the Microsoft 365 App Certification Program pages. Navigate to the appropriate officeatwork Add-In/App using the left navigation of the site. There you will be able to learn more on how your data and privacy are adequately secured and protected.

We have built all our Apps with a solid and enterprise prove security architecture. We have chosen an architecture that follows these simple principles.

  • We believe that it is not acceptable that customer data ever gets transferred to any of our officeatwork servers and that we in general limit the data we do have to transfer to our servers to the bare minimum possible.

  • We do not introduce a new permissions or security schema but always use existing permission and security schemas in place offered by the data providers like Office 365, allowing our Add-Ins to only access data the user using the Add-In has already been approved for.

  • All data transfer is encrypted.

  • Any minimal data we store is encrypted.

Data flow

One of the biggest security concern is how the data the Add-In processes flows and if the user's privacy and the companies IP is protected.

The following describes the main usage scenarios and how the data flows between the different actors like the user, the Add-Ins and other connected services.

Loading Add-In

When the Add-In gets loaded it uses encrypted communications via a high availability Azure CDN service. Loading the Add-In requires no User nor Customer Data.

Add-In loading data flow

Sign-In to Add-In

To sign in to the officeatwork Add-Ins you can use either your Microsoft personal or organizational account. The flow starts with the user signing in using Microsoft's sign in flow. After a successful identification by Microsoft a User Access Token is collected by a trusted officeatwork server side Azure function that then hands the Access Token to the Add-In combined with tenant settings data stored in an officeatwork controlled globally available Azure cosmos DB. This flow takes place without any connection to the customer's data.

Sign in data flow

Using Add-In

While the user is interacting with the Add-Ins data might be required. The access to that data is enabled via the User Access Token allowing the Add-In to read and write data in the name of the User directly without having to bypass any officeatwork server services.

Add-In usage data flow

SLA (Service Level agreement)

Top

All officeatwork SaaS Add-Ins/Apps are hosted across multiple data centers across multiple continents and regions on the Microsoft Azure platform. Please find below the services used with the links to the according Microsoft Service Level Agreement: