The purpose of this article is to provide instructions on how to provide integration demo videos. The article will review the tools used, goals of the integration demos, recording steps, and best practices.
Ideally, every sync in a project should have a demo video recorded before it's released
to UAT or production. These videos are used by the marketing team to brag about their
favorite developers (though they'll try to say it's for bringing in new clients).
- Clarity Connect (V3 & V4)
- Recording Software(s)
- OBS Studio is a wonderful software for recording and can be made to capture per window,
per-monitor, etc.
- Kdenlive is great for snipping out parts of the demo you don't want to send along even
to marketing or removing snippets of audio yourself if needed.
- Microsoft Teams, in a pinch, can suffice, although it gives lower quality.
The goal of these demo recordings is twofold:
- Developers assigned to the project will demonstrate the workflows within the FSD and show working implementations
- The Marketing team is able to provide a voice-over on the recording and generate marketing material
- Pull up the user interface of the two separate systems (sandboxes) and the UI of Connect (C3 & C4)
- Record via Teams (or preferred recording system) and talk through the process being completed.
- Note: you DO need to provide a voice-over but your voice will NOT be used in the marketing video
- Utilize the exact workflows provided in the FSD and show the process of creation and updating
- Example: Account Creation
- Within System A (eCommerce): Create a new account (via UI) and go through the account registration process
- You can use Ron Halversen name for testing
- Within System B (ERP): Show that the account you created does not already exist
- Within Clarity Connect: Trigger the job sync related to Account Creation and show the sync visualizer running with a progress bar
- Within System B: Show the account you created
- Recording Completed
- ALWAYS show a video of the system(s) before and after changes are made.
- It is important to display them before so the demo is showing what will change.
- ALWAYS test the integration following the explicit steps in the client's IIW/FSD.
- Some steps being missed will cause issues for the client during their User Acceptance Testing. Catching these ahead of the client helps prevent client satisfaction issues.
- ONLY the marketing team will ever hear your beautiful voice and they'll dub
over you later with their own voices, so don't worry too much about noises on the mic.
- DO, however, try to explain workflows as you go. The marketing team can leverage that
in their final scripts.
- IN GENERAL, over-showing is better than under-showing.
- Let the marketing team edit extraneous information.
When done, post the video into the following options:
Tag the following team personnel
- Clint Thompson – Integration Program Manager
- Ron Halverson – VP of Sales
- Jeremy Howell – Executive Account Manager
- Reily Halverson – Account Manager
- Your Project Manager
Videos too large to be added to Microsoft Teams can be added into the following Transfer Big Files account to allow Ron Halverson to review and update the videos. Please ping Ron Halverson and Clint Thompson once completed.
URL: https://www.transferbigfiles.com
Name: transferbigfiles.com
Folder: Clarity