Plan for Deploying In-Application Support
Once you decide to deploy content for in-application support, some of the fundamental questions that need to be addressed are:
- What deployment mechanism is most appropriate for your application, Help Integration with a target application or SmartHelp-based deployment?
- Who needs to be involved, what needs to be done, and when does it have to happen?
Understanding the answers to these questions will give you the information you need to implement help integration and context-sensitive help successfully.
These are the tasks which need to be completed to successfully deploy in-application support.
Content Author
- Create content in the Developer - While ExactMatch information for target applications and SmartMatch information for browser-based non-target applications will be automatically captured, it is recommended that you validate that context is being captured.
- Publish the content
- Give the published content to the web server administrator
Web Server Administrator
- Deploy the published content to a web server
- Provide the URL for the content to the application administrator
Application Administrator
- Perform the configuration steps detailed in the in-application support guide for each application
- Receive the content URL from the web server administrator
- Perform help integration steps for URL configuration, if applicable
Test User
- Verify the published content appears from the application using the Help Menu Integration option or the SmartHelp button, as deployed
- If you are deploying context-sensitive help, the test user should coordinate with the content developer to note which parts of the application were used to create content and then verify that the content launches with an appropriate list of relevant topics.
For most target applications, application configuration can occur after and independently of content creation. There are two exceptions:
- Oracle E-Business Suite: It requires library files to be installed on the application server (applcore forms server) before recording content. See Implement Context-Sensistive Help Integration in the Oracle E-Business Suite section later in this manual for more information on installing library files for Oracle E-Business Suite.
- PeopleSoft Enterprise: It is recommended that PeopleBooks is installed and configured before starting to record content.
If you want to deploy context-sensitive help, always check that context is being captured while recording. See Context Recognition in the Recorder in the Record and Edit Topic Content chapter of the Content Development manual for more information on capturing context while recording.