Capture HTML Report from Directory

This is generated from the built in components of BuildMaster 7.0.0, and may be different than what you have installed (especially if you have extensions); go to [User Icon] -> Documentation within your BuildMaster instance to see exactly what operations are available.

Captures all HTML files from a directory into a browsable build report.

Script usage:

Capture-HtmlDirectoryReport( [FromDirectory: <text>], Index: <text>, [Preview: <text>], Name: <text> );

This operation may be prefixed with Reports::, although this is a built-in namespace and isn't really necessary.

Arguments:

Name	Format	Script Usage	Usage Notes
From directory	text	FromDirectory
☆ HTML index page	text	Index	The HTML index page is the first page that is viewed when the report is opened and should contain links to other pages captured in the report. This argument is required.
Preview page	text	Preview	The preview page is displayed on the build overview page.
☆ Report name	text	Name	This argument is required.

Name

Format

Script Usage

Usage Notes

From directory

text

FromDirectory

☆ HTML index page

text

Index

The HTML index page is the first page that is viewed when the report is opened and should contain links to other pages captured in the report. This argument is required.

Preview page

text

Preview

The preview page is displayed on the build overview page.

☆ Report name

text

Name

This argument is required.

Note: At a minimum, the specified index file is required. The preview HTML file is optional, but may be desirable to provide a quick summary of the report contents. Links to other pages in the report should be relative from the root directory captured.

Example:

# create a report from the files in the working directory Capture-HtmlDirectoryReport( Name: Files In Working Directory, Index: index.html, Preview: preview.html );

Capture HTML Report from Directory