Shipping your Office Online integration¶
Once you believe you are ready to ship your integration, you should contact Microsoft and ask to begin the ‘go live’ process. This process will prepare you to ship your Office Online integration.
The ‘go live’ process consists of three phases:
Validation - Microsoft will validate your WOPI implementation as well as your UI integration. Depending on what issues are uncovered during validation, this may take some time. You should estimate a two-week turnaround time assuming there are no major issues uncovered. However, we recommend allowing at least a month unless your integration is very simple.
You can avoid delays in validation by ensuring that your implementation is consistent with this documentation and that the WOPI Validation application tests are passing before beginning the ‘go live’ process.
Production Smoke Test - Microsoft will enable you to use the production Office Online environment for smoke-testing. This should be basic testing performed by the host since the production environment is slightly different than the test environment, and different issues may be uncovered. This can be as long or as short as the host deems necessary. Typically a week is enough time, though it can be much shorter.
Sign off and roll out - Once Microsoft has signed off on your integration, you can begin to roll out to your users. Depending on your traffic estimates, Microsoft may request that you roll out over a period of several days to ensure you do not overload Office Online or your WOPI servers.
To manage this process, Microsoft will create a dedicated Trello board to track issues and provide a common communication channel between your team and Microsoft. You can learn more about how to use this Trello board in the Using Trello to manage the ‘go live’ process section.
Before starting the ‘go live’ process, you should read the below sections for an overview of the types of questions and issues that you may need to address during the process.
Preparing for the ‘go live’ process¶
As part of the validation process, Microsoft will test your WOPI implementation using the WOPI Validation application. All of the tests in the following categories must be passing:
- HostFrameIntegration (ValidLanguagePlaceholderValues may be skipped if the host is not using the UI_LLCC or DC_LLCC placeholder values)
- PutRelativeFile or PutRelativeFileUnsupported
- RenameFileIfCreateChildFileIsNotSupported or RenameFileIfCreateChildFileIsSupported (applicable only if the host supports RenameFile)
- ProofKeys (applicable only for hosts implementing proof key validation)
In addition to checking the WOPI validation results, Microsoft will do some manual validation of scenarios that cannot currently be tested using the WOPI validator. You should follow the steps in the testing guide and fully test these scenarios prior to starting the ‘go live’ process.
In order to enable your WOPI host to use Office Online’s production environment, Microsoft will perform some manual validation of your WOPI implementation and Office Online integration. This requires that you provide Microsoft test accounts that they can use to test your integration.
The provided test accounts must be able to test your Office Online integration. In addition, you must provide a way for Microsoft to access the WOPI Validation application using these test accounts.
Once test accounts are provided, Microsoft will provide you with a rough time line to complete testing. Usually testing can be completed within two weeks. However, this time line is subject to demand; if other partners are already being tested it may take additional time for Microsoft to begin testing your implementation. In addition, if implementation issues are uncovered during testing the process may take longer.
Business user flow test accounts¶
If you are using the business user flow, you will need test accounts from Microsoft in order to effectively test the flow in the Test environment. See the Testing the business user flow section for more information.
WOPI implementation questionnaire¶
There are some aspects of your WOPI implementation that are particularly critical to the success of your integration. In order to verify these parts of your implementation, Microsoft will ask you to answer some questions regarding your specific WOPI implementation. These questions are included below.
This list of questions is subject to change. Microsoft will provide you with a specific list of questions as part of the ‘go live’ process that may differ from the list below.
- Confirm that your File IDs meet the criteria listed in the documentation. Office Online expects file IDs to be unique and consistent over time, as well as when accessed by different users or via different UI paths (e.g. a given file might be available in two different parts of your UI, such as in a typical folder and also in search results. If the document is meant to be the same, then the file IDs should match. Otherwise users will see unexpected behavior when they access the same file via different UI paths).
- Confirm you’re providing a user ID using the UserId field and that the ID is unique and consistent over time as described here.
- Confirm that the value in the OwnerId field represents the user who owns the document and is unique and consistent over time as described here.
- Are you sending the SHA256 value in CheckFileInfo?
- Are you using the business user flow?
- What WOPI host capabilities properties are you passing in CheckFileInfo?
- WOPI access tokens are currently provided in both the Authorization header and on the WOPI URL in the
access_tokenparameter. Which of these are you using?
- Do you use IPv6 in your datacenters?
Production settings check¶
Prior to enabling your integration in the production environment, Microsoft will ask you to verify your current Microsoft-configured settings, including your entries in the WOPI domain allow list and Redirect domain allow list.
Changes to production settings require time to make.
Any changes to Microsoft-configured settings will take 2-3 weeks to fully roll out to the production environment. This includes changes to the WOPI domain allow list.
The test environment, on the other hand, is generally updated with new settings within 24-48 hours.
Service management contacts¶
Office Online is a worldwide cloud service, and is thus monitored at all times. As part of the ‘go live’ process, Microsoft will provide you with information regarding how to escalate service quality issues with Office Online’s on-call engineers.
In order to use the production environment, you must also provide a contact for Microsoft’s on-call engineers to reach if Office Online detects an issue that we suspect is due to a problem on the host side. For example, Office Online’s monitoring systems might detect error rates for sessions spiking, and the on-call engineer would contact the host to see if it’s a known issue on the host side. Ideally this emergency contact can be reached 24x7, either by phone or email.
Rollout schedule and traffic estimates¶
Typically Microsoft asks partners to roll out over a period of time - between a few days to two weeks - depending on the anticipated traffic. For smaller hosts this is not always necessary. If you’re already planning on doing this, you should communicate the schedule to Microsoft (i.e. 10% day 1, 50% day 2, etc.). If you’re not, you must coordinate with Microsoft to ensure this is appropriate given your traffic estimates.
In order to best plan the rollout, you should be prepared to provide Microsoft with updated traffic estimates. Ideally these will be broken down by view/edit, file type, and geography, but provide whatever you can.
Once you and Microsoft have agreed on a rollout plan and Microsoft has signed off on your WOPI implementation, your WOPI host will be enabled in the production environment. You should plan to do some basic testing against the production environment prior to rollout to ensure there are no unique issues using that environment. Once you have completed that testing, you can roll your integration out to users according the agreed-upon rollout schedule.