Skip to main content

GenerateAndStoreReportNodeConfiguration

Namespace: Meshmakers.Octo.MeshAdapter.Nodes.Transform

Configuration for node GenerateReport that generates a report and stores it to the file system

public record GenerateAndStoreReportNodeConfiguration : TargetPathNodeConfiguration, INodeConfiguration, IEquatable<NodeConfiguration>, ITargetPathNodeConfiguration, IEquatable<TargetPathNodeConfiguration>, IEquatable<GenerateAndStoreReportNodeConfiguration>

Inheritance Object → NodeConfiguration → TargetPathNodeConfiguration → GenerateAndStoreReportNodeConfiguration
Implements INodeConfiguration, IEquatable<NodeConfiguration>, ITargetPathNodeConfiguration, IEquatable<TargetPathNodeConfiguration>, IEquatable<GenerateAndStoreReportNodeConfiguration>

Properties​

FileSystemFolderUri​

The uri of the folder in the file system where the report should be stored, e.g., /demo under the root folder of Reports.

public string FileSystemFolderUri { get; set; }

Property Value​

String

ReportDefinitionUri​

The uri of the report definition, e.g. /demo/report.trdp under the root folder of Report definitions.

public string ReportDefinitionUri { get; set; }

Property Value​

String

ReportFileNamePrefix​

The prefix of the report file name, e.g. 'report-'. To the prefix the date and time are added in format yyyyMMdd-HHmmssFFF

public string ReportFileNamePrefix { get; set; }

Property Value​

String

RelatedRtIdPath​

The (optional) runtime id of an entity that is set related to the report comes with GenerateAndStoreReportNodeConfiguration.RelatedRtId or GenerateAndStoreReportNodeConfiguration.RelatedRtIdPath.

public string RelatedRtIdPath { get; set; }

Property Value​

String

RelatedRtId​

The (optional) runtime id of an entity that is set related to the report comes with GenerateAndStoreReportNodeConfiguration.RelatedCkTypeId or GenerateAndStoreReportNodeConfiguration.RelatedCkTypeIdPath.

public Nullable<OctoObjectId> RelatedRtId { get; set; }

Property Value​

Nullable<OctoObjectId>

RelatedCkTypeId​

Optional CkTypeId of related CkTypeId, comes with GenerateAndStoreReportNodeConfiguration.RelatedRtId or GenerateAndStoreReportNodeConfiguration.RelatedRtIdPath.

public CkId<CkTypeId> RelatedCkTypeId { get; set; }

Property Value​

CkId<CkTypeId>

RelatedCkTypeIdPath​

Optional path to the CkTypeId of the related CkTypeId, comes with GenerateAndStoreReportNodeConfiguration.RelatedRtId or GenerateAndStoreReportNodeConfiguration.RelatedRtIdPath.

public string RelatedCkTypeIdPath { get; set; }

Property Value​

String

ReportParameters​

Path parameters to be replaced in the URL

public List<HttpPathParameter> ReportParameters { get; set; }

Property Value​

List<HttpPathParameter>

TargetPath​

public string TargetPath { get; set; }

Property Value​

String

TargetValueWriteMode​

public TargetValueWriteModes TargetValueWriteMode { get; set; }

Property Value​

TargetValueWriteModes

TargetValueKind​

public ValueKinds TargetValueKind { get; set; }

Property Value​

ValueKinds

DocumentMode​

public DocumentModes DocumentMode { get; set; }

Property Value​

DocumentModes

Description​

public string Description { get; set; }

Property Value​

String

Constructors​

GenerateAndStoreReportNodeConfiguration()​

public GenerateAndStoreReportNodeConfiguration()