Documenting the Behavior of Custom Actions
InstallShield 2016
Project • This information applies to the following project types:
Windows Logo Guideline • The intended behavior of each custom action must be documented for the Windows logo program. This is especially helpful if system administrators deploy your product to enterprise environments; they sometimes need to know what the custom actions do. If you validate your installation package but you have not specified a value for the Help File Path setting, InstallShield generates validation error ISICE10. For more information, see ISICE10.
To document the behavior of a custom action in your project:
|
1.
|
Create a file that describes the intended behavior of the custom action. The file should be a text-based file such as a .txt, .htm, or .rtf file. Note that each custom action should have its own document. |
|
2.
|
In the View List under Behavior and Logic, click Custom Actions and Sequences (in Basic MSI, InstallScript MSI, MSI Database, and Transform projects) or Custom Actions (in DIM, Merge Module, and MSM Database projects). |
|
3.
|
In the Custom Actions explorer, click the action that you are documenting. |
|
4.
|
For the Help File Path setting, click the ellipsis button (...) to browse to the file that describes the behavior of the custom action. |
Tip • You can specify whether InstallShield should stream the contents of each of the custom action help files into the .msi file at build time. For more information, see the description of the Include Custom Action Help setting for a product configuration in the Releases view.
See Also
ISCustomActionReference Table
Validating Projects
Guidelines for Creating Custom Actions that Meet Requirements of the Windows Logo Program
Open topic with navigation