Integration Server 10.15 | Built-In Services Reference Guide | Packages Folder | Summary of Elements in this Folder | pub.packages:updateHomePage
 
pub.packages:updateHomePage
WmPublic. Updates the home page of a custom package. This service does not apply to the system packages.
The package home page is at Integration Server_directory \instances\instance_name\packages\<package Name>\pub\index.html
Input Parameters
packageName
String Name of the package for which you want to update the home page. Package names are case sensitive.
replaceHTML
Boolean Flag that specifies whether to overwrite the existing index.html file. Set to:
*true to replace index.html with a predefined home page template for custom package documentation and all the required resources.
*false to modify only the resources and not the index.html file.
Note:
If any of the input parameters contain leading or trailing spaces, Integration Server considers the input parameter as an invalid input and throws an error.
Output Parameters
success
Boolean Flag that specifies whether the home page is updated successfully.
message
String Conditional. Message from Integration Server that specifies whether the home page is updated successfully. The message changes based on the replaceHTML value.
Usage Notes
After creating a custom package, you must run the pub.packages:updateHomePage service with replaceHTML set to true to see the updated package documentation. When the replaceHTML value is true, the service overrides the existing content in the index.html file. If the replaceHTML value is false, the index.html file retains the existing content.
To see the subsequent changes to the package, run the service again from Integration Server Administrator by regenerating the home page. This invokes the pub.packages:updateHomePage service with replaceHTML as false. If you need to update the changes in the index.html file, run the service with replaceHTML set to true.
You can access the package home page even when Integration Server Administrator session expires. For more information on viewing package information and generating package documentation, see the webMethods Integration Server Administrator’s Guide and webMethods Service Development Help.