BuildMaster Documentation

Reports - Capture Report from File

  • Last Modified: 2020-11-06

This is generated from the built-in components of BuildMaster 6.2.21, 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.

Capture Report from File

Captures a plain text or HTML file as a build report.

Script usage:

Capture-FileReport(
	Path: <text>,
	[Html: <true/false>],
	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 file (default)
text
Path
This argument is required.
HTML format
true/false
Html
Report name
text
Name
This argument is required.

Example:

# create a report from the files in the working directory
Capture-FileReport(
    Name: Diff Tool Output,
    Index: index.html
);

Is this documentation incorrect or incomplete? Help us by contributing!

This documentation is licensed under CC-BY-SA-4.0 and stored in GitHub.

Generated from commit 845f3ab3 on master