Configuration file

The configuration file offers the possibility to organize, sort and customize the report.

The following options are supported in the Reporting Server.

Key

Description

Sample

Level

 

 

 

 

General

 

 

 

Store Type

Specifies which store mode to use. Currently only "Ram" is supported.

"StoreType": "Ram"

1

Header

Provides the possibility to display three headers arranged one below the other. If the second and / or third header is not to be used, an empty string can be specified.

"Header": [
"Header 1",
"Header 2",
"Header 3",
]

1

Footer

The footer of a PDF page is divided into three areas. All three areas can be individualized with a free text. To display the date and time of creation, the placeholder "{date} {time}" must be specified. To display the page number, the placeholder "{page} of {total-pages}" must be specified. If a range is to be left blank, an empty string can be specified.

"Footer": [
"Footer Left",
"Footer Center",
"Footer Right",
]

1

Logo

The logo is displayed on the top right of the first page. The logo can be specified as a relative path to the folder Reporting-Server\Configuration\ConfigFiles. Alternatively, the logo can be specified as a Base64String with the preceding encoding.

"Logo": ".//<Bildname.png>"
oder
"Logo": "data:image/<Encoding>;base64, <Base64String>"

1

StyleSheet

Offers the possibility to customize the design of a report. To use a user-specific StyleSheet, its name must be specified (see Style Sheet).

"StyleSheet": "StyleBeckhoff.css"

1

SignatureSettingsFile

Provides the possibility to sign a report (see Signing).

"SignatureSettingsFile": "BeckhoffSignatures.json",

 

Email text

This text will be included in every email unless a specific text is specified.

"EmailText": "Custom of E-Mails send to all recipients with no or empty E-Mail-Text. Special. Ones"

1

Required Keys

Is a collection from Data Key. If the data objects of these data keys are not available in the Reporting Server, the report will not be generated.

"RequiredKeys": ["Data101"]

1

Trigger On Required Key Received

Is another way to trigger the generation of a report. If true is selected for the option and all data objects with the required Data Keys are present, the report will be generated. This eliminates the need for a trigger message from a Reporting Client.

"TriggerOnRequiredKeyReceived": false

1

 

 

 

 

Static Default Data

 

 

 

Default Data

This object can be used to define data objects to be presented in each report.

"DefaultData": {}

1

 

 

 

 

Text Fields

This element is an array and can have multiple text field objects with the following elements.

"TextFields": []

2

Key

Used as a heading for the text field.

"Key": "My Text Field"

3

Comment

Serves as a comment for the data object. The comment is not displayed in the report.

"Comment": "My Comment"

3

Sort Priority

Specifies the position of the data object in the report.

"SortPriority": 42

3

Value

Contains an individual value and must be specified as STRING.

"Value": "253-5553-9421"

3

 

 

 

 

Tables

This element is an array and can have multiple table objects with the following elements.

"Tables": []

2

Key

Used as a heading for the table.

"Key": "My Table"

3

Comment

Serves as a comment for the data object. The comment is not displayed in the report.

"Comment": "My Comment"

3

Sort Priority

Specifies the position of the data object in the report.

"SortPriority": 42

3

Value

This element is an object and contains the following elements.

"Value": {}

3

Header

This element is an array and receives the column titles of the table. The number of column titles must be equal to the columns of the table.

"Header": ["Table Header 1", "Table Header 2"]

4

DataTypes

This element is an array and receives the data types of the table column. The following data types are possible: BOOL, BYTE, SBYTE, CHAR, DECIMAL, DOUBLE, FLOAT, INT, UINT, LONG, ULONG, SHORT, USHORT, STRING. The number of data types must be equal to the columns of the table.

"DataTypes": ["string", "double"]

4

Values

This element is a 2D array and receives the value of the table. An array in the array represents a table column. The table column must match the specified data type. The number of arrays must be equal to the columns of the table. The arrays should be the same size.

"Values": [[],[]]

4

 

 

 

 

Images

This element is an array and can have multiple image objects with the following elements.

"Images": []

2

Key

Used as a caption for the image.

"Key": "My Image"

3

Comment

Serves as a comment for the data object. The comment is not displayed in the report.

"Comment": "My Comment"

3

Sort Priority

Specifies the position of the data object in the report.

"SortPriority": 42

3

Value

Contains the Base64String with PNG encoding.

"Value": "<Base64String PNG-Encoding>"

3

 

 

 

 

Value Pairs

This element is an array and can have multiple key-value pair objects with the following elements.

"ValuePairs": []

2

Key

Used as a heading for the collection from key-value pairs.

"Key": "My Value Pair"

3

Comment

Serves as a comment for the data object. The comment is not displayed in the report.

"Comment": "My Comment"

3

Sort Priority

Specifies the position of the data object in the report.

"SortPriority": 42

3

Value Pair Collection

Serves as a collection of key-value pairs. This element is an array and can have multiple objects with the following elements.

"ValuePair_Collection": []

3

Key

Contains an individual value and is displayed presented on the left side.

"Key": "Serial number"

4

Data Type

Describes the data type of the "Value" element.

"DataType": "string"

4

Value

Contains an individual value and is presented on the right side. The value must be specified as STRING.

"Value": "253-5553-9421"

4

 

 

 

 

Data Configurations

 

 

 

Data Configurations

Data Configurations can be used to sort and individualize the data that is sent dynamically from the Reporting Clients. This element is an array and can have multiple objects with the following elements.

"DataConfigurations": []

1

Key

Corresponds to the Data Key of the data object. This ensures that this data configuration is applied to a unique data object. (Required)

"Key": "DataTable101"

2

Title

Provides the option of a better name as a heading. (optional)

"Title": "Rotations and vibrations"

2

SortPriority

Specifies the position of the data object in the report. (Required)

"SortPriority": 42

2

IsRequired

Indicates whether this data object is required for generating the report. (see: TriggerOnRequiredKey)

"IsRequired": false

2

StoreMode

Provides the option to store individual data objects in a specific way and display them accordingly. Currently, four different store modes are supported:

  • Blocking: the first data object is saved and all subsequent data objects with the same data key are discarded.
  • Overwriting: the newly received data object replaces the last data object with the same data key.
  • Appending: the newly received data object is saved. The previously received data objects are also held and presented in the report. In the case of a table, the data is merged.
  • Appending_Series: this store mode corresponds to the store mode "Appending". However, the data objects are numbered and presented in individual tables.
"StoreMode": "Overwriting"

2

RoundTo

Provides the option to round floating-point numbers to a specified decimal place.

"SortPriority": 4

2

TimestampFormat

Provides the option to convert Timestamp to a specified format. By default, the following formatting is selected: "yyyy-MM-dd HH:mm:ss.ffff"
(See also: Custom date and time format strings)

"TimestampFormat": "HH:mm:ss.ffff"

2

IsAsc

Provides the option to specify the sort order of a data table. If the value is true, the first data set is presented in the first line.

"IsAsc": true

2

StyleClass

Provides the option to use a custom CSS style class. The CSS style class must be defined in the CSS file and the CSS file must be referenced under the StyleSheet option.

"StyleClass": "CustomClass"

2

 

 

 

 

Publish Locations

 

 

 

Publish Locations

 

"PublishLocations": []

1

Email Publish Location

Used to forward the report as an e-mail. This element is an array and can have multiple objects with the following elements.

"EmailPublishLocations": []

2

Type

Specifies the type of distribution.

"Type": "File"

3

Format

Offers the option to send only a selection of formats by email.

"Format": ["PDF", "HTML", "JSON"]

3

Address

Provides the ability to send the report to multiple email addresses.

"Address": [ "m.mustermann@tester.com "]

3

Use Bcc

Provides the option to set the email addresses in BCC.

"UseBcc": false

3

Text

Provides the option to specify a specific email text. This text replaces the default email text.

"Text": "Hello, \n insert email text here.\n Your Reporting Service.

3

File Publish Location

Used to copy the report to a specified location. This element is an array and can have multiple objects with the following elements.

"FilePublishLocations": []

2

Type

Specifies the type of distribution.

"Type": "File"

3

Format

Offers the option, to send only a selection of formats by email.

"Format": ["PDF", "HTML", "JSON"]

3

Path

Provides the possibility to specify a destination path for the report. The destination path must not require administrator rights.

"Path": "C:\\tmp\\CpyFolder"

3