using HTML reports fast and efficient

(1)

Model result documentation

using HTML reports fast and efficient

Martin Lemburg

Tecnomatix Plant Simulation Worldwide User Conference June 22nd, 2016

www.siemens.com/plm/PlantSimulation

Unrestricted © Siemens AG 2016 Tecnomatix Plant Simulation Worldwide User Conference - June

Model result documentation using HTML reports fast and efficient

About the HTML Report 3

•

Creating a HTML Report 4

•

Syntax Elements 5

•

Object Representations 15

•

Toolbar Usage 31

•

Enhanced Usage 35

(2)

Unrestricted © Siemens AG 2016 Tecnomatix Plant Simulation Worldwide User Conference - June 22nd 2016

Page 3 Siemens PLM Software

Model result documentation using HTML reports fast and efficient

About the HTML report

• The HTML report is build from a plain text

• The plain text contains syntactical elements similar to the MarkDown syntax

• The syntactical elements allow to structure the report, to format text

• Objects, their attributes, images, etc. are accessed by the syntactical elements

• Formulas can be inserted as well as

• The HTML report can use other HTML report objects in a modular way

• Pure HTML can be used in the plain text

• The HTML report is monolithic and can be saved into one HTML file to be shared

Model result documentation using HTML reports fast and efficient

Creating a HTML report

1. The edit area to enter the plain text "configuring"

the HTML report in its structure, formatting and content

2. The toolbar to help creating a HTML report 1. Undo

2. Bold and Italics formatting 3. Insert bullets or numbered lists 4. Increase or decrease the indention 5. Insert special, functional characters

6. Insert object, attribute references, images or add images

3. Button displaying the generated HTML report in a new window

4. "Apply" button, which refreshes an already

(3)

Syntax Elements – Table of Contents

•

Headings 6

•

Bulleted and numbered Lists 7

•

Text Format 8

•

Text Indention and Orientation 9

•

Object, Attributes, Formulas 10

•

Images 12

•

Miscellaneous 13

Model result documentation using HTML reports fast and efficient

Syntax elements – headings

• Headings in 6 levels indicated by leading hash marks:

# heading 1

## heading 2

### heading 3

#### heading 4

##### heading 5

###### heading 6

• Shortcuts in the "editor" are <Ctrl+1>, <Ctrl+2>,

…, <Ctrl+6> to insert or to change the heading level indicating hash marks and <Ctrl+0> to reset the heading level

• Headings 1 to 2 are listed in the table of contents by default

• Headings 1 to 4 can be listed in the table of

(4)

Model result documentation using HTML reports fast and efficient

Syntax elements – bulleted and numbered lists

• Bulleted list items are indicated by a leading asterisk ‘*’ :

* item 1

* item 2

* sub list item 1

* sub list item 2

* item 3

• Numbered list items are indicated by a number with a point:

1. item 2. item

1. sub list item 1. sub list item 3. item

• List items might be indented by multiple of 4 blanks or tabulators to create nested lists

• List types can be mixed without problems

Model result documentation using HTML reports fast and efficient

Syntax elements – text format

• Text can be formatted to be bold:

**important** part of a solution

• Text can have italic style:

a *seldom* variant of the solution

• Both styles can be combined:

a *seldom*, but ***important*** variant of the solution

(5)

Syntax elements – text indention and orientation

• Text can be indented over paragraphs using one or multiple ‘>’:

> indented once

>> indented twice

• To Center a line the prefix ‘><‘ is used (Ctrl-e)

>< centered text

Model result documentation using HTML reports fast and efficient

Syntax elements – objects, attributes and formulas (1)

• To insert an object or attribute:

[.Models.Frame.EventController]

[.Models.Frame]

[.Models.Frame.EventController.Date]

• Objects without a type specific handling and allowed parameters return their path

• Methods are executed and the results integrated into the source code before converting to HTML

• To insert formlas without result object "evaluation":

[=(Drain.statNumIn / Source.statNumOut) * 100]

[=Drain.Location]

• To insert formlas with result object "evaluation" resulting in tables, images, etc.:

[>Drain.Location]

(6)

Model result documentation using HTML reports fast and efficient

Syntax elements – inserting objects, attributes and formulas (2)

• Formula examples:

Drain Input to Source Output: [=(Drain.statNumIn / Source.statNumOut) * 100, 02]%

[=Drain.typeStatisticsCumulated, "Cumulated Type Statistics"]

Drain Location: [=Drain.Location]

Drain Location: [>Drain.Location, 10, *]

• Parameters to formulas depend on the result of the formula

• Numeric results can be formatted using the count of digits after the decimal point

• The count of digits after the decimal point with a leading zero appends zeros to ensure the numbers length

• For object results, the parameters depend on the object type

Model result documentation using HTML reports fast and efficient

Syntax elements – images

• To insert the current or a named image:

[=EventController.CurrIcon]: [!EventController]

[!EventController, "default"]

• Adding a caption to an image:

[!EventController, "default", "normal size"]

• Absolute sizing a named image in Millimeters by adding the width andi height:

[!EventController, "default", 12, 6]

[!EventController, "default", "stretched", 12, 6]

[!EventController, "default", 6, *] –- resize respecting aspect ratio

[!EventController, "default", *, 6] –- resize respecting aspect ratio

• Relative sizing a named image in Millimeters by adding the percentage:

[!EventController, "default", 200%]

[!EventController, "default", *] – as big as needed, but never larger

(7)

Syntax elements – miscellaneous (1)

• Horizontal line by inserting three hyphens without text after the last hyphen:

---

--- a comment, not a horizontal line

• Inserting a comment into the HTML report source code by prepending two hyphens:

[>self.Location] -- insertion of a screenshot of the frame containing this report

• Inserting HTML source code, HTML elements and properties:

<a href="http://intranet.mycompany.com/qm-standards.html"

target="blank">QM Standards</a>

Model result documentation using HTML reports fast and efficient

Syntax elements – miscellaneous (2)

• Special characters:

\*#[]-.<>

• To add a “soft” hyphen used for hypenation in the report use the key combination Ctrl+Minus

• Protecting characters with special meaning by escaping them with a backslash:

\#[Source.statNumOut] parts

\* is a asterisk and \\ is a backslash 1\. Is not a numbered list item

• To protect text from being interpreted as markup and not as HTML wrap it into "<<"

and ">>":

This is the per mille sign <<‰>>. It is wrapped into doubled angle brackets, because its introducing ampersand is a specail HTML character, which would be changed to "&"

(8)

Model result documentation using HTML reports fast and efficient

Object Representations – Table of Contents

•

Frames 16

•

3D Views 17

•

Charts 18

•

TableFile and other List Objects 19

•

Drain 21

•

Broker 22

•

Statistics Tables 23

•

Variables 25

•

Methods 26

•

HtmlReports 27

•

FileLinks 28

•

Displays, Comments 29

•

Checkboxes, Dropdown Lists 30

Model result documentation using HTML reports fast and efficient

Object Representations – Frames

• Frames will represent themselves as screenshots of their contents, thus as image:

[.Models.Frame]

[>self.Location] -- the path as attribute used as object

• To get the path of a frame into the report use a formula:

[=.Models.Frme] -- the path of the object returned by the formula [self.Location] -- the path taken from the attribute

• The parameters to be applied to an image can be applied to frames, too:

[.Models.Frame, "caption", 150%]

[.Models.Frame, 150%]

(9)

Object Representations – 3D views

• To insert a 3D view the formula and the SimTalk access is used:

[>Object._3d]

[>Object._3d, 120, 90]

[>Object._3d, "3D view"]

[>Object._3d, "3D view", 120, 90]

• The enhanced syntax allows to set a camera position:

[>Object._3d, 120, 90, CamPosX, CamPosY, CamPosZ]

[>Object._3d, 120, 90, CamPosX, CamPosY, CamPosZ, CampRotX, CamRotZ]

[>Object._3d, "3D view", CamPosX, CamPosY, CamPosZ, CampRotX, CamRotZ]

[>Object._3d, "3D view", 120, 90, CamPosX, CamPosY, CamPosZ, CampRotX, CamRotZ]

Model result documentation using HTML reports fast and efficient

Object Representations – Charts

• A chart will be represented by a scalable image of the current state:

[Chart]

• Parameters for a chart objects are …

• Caption – a string enclosed in double quotes

• Width and height in Millimeters

• Example:

[Chart, "Simulation finished"]

[Chart, 120, 90]

[Chart, "Simulation finished – 100mm x 75mm", 100, 75]

(10)

Model result documentation using HTML reports fast and efficient

Object Representations – TableFile and other List Objects (1)

• A TableFile object is represented as HTML table:

[TableFile]

• Allowed parameters … are …

• Caption – a string enclosed in double quotes

• Column indexes based on 1, where the row index is addressed with 0

• Column ranges with – the last column may be an asterisk and column names:

1..3, ..3, 3..*, #Speed, #AveTime, #MUCount

• The AttributeExplorer has the same parameters, than a TableFile

• Tables from the SQLite Interface are special in accepting a SQL query instead:

[MySqlDb, "SELECT * FROM MUTrace"]

Model result documentation using HTML reports fast and efficient

Object Representations – TableFile and other List Objects (2)

• Example: a table without row or column index:

[TableFile]

[TableFile, "captio"]

[TableFile, "1-3", 1..3]

[TableFile, "1-*", 1..*]

• Example: a table with row and column index with column ranges:

[TableFile]

[TableFile, "1-3", 1..3]

[TableFile, "0-3", ..3]

• Example: a table with row and column index with column indexes and names:

[TableFile, "0,2,4", 0, 2, 4]

[TableFile, "0,#A,#C", 0, #A, #C]

(11)

Object Representations – Drain

• The Drain is represented by a statistics table presenting the "Type Statistics" …

… or any other statistics table, since the drain is an object with statistics

• The Drain accepts the same parameters, than the TableFile to allow presentation of specific columns:

[Drain, "MU throughput/h", #Name, #Throughput per Hour]

Model result documentation using HTML reports fast and efficient

Object Representations – Broker

• The Broker behaves similar to the Drain and is represented by a statistics table presenting the

"Broker Service Statistics" …

… or any other statistics table, since the drain is an object with statistics

• The Broker accepts the same parameters, than the TableFile to allow presentation of specific columns:

[Broker, "Service Counts", #Dwelling Time: Count, #Mediation Time: Count]

(12)

Model result documentation using HTML reports fast and efficient

Object Representations – Statistics Tables (1)

• All objects collecting statistical data represent this data in statistics tables of the following types:

%BlockedTime, %Broker, %BrokerDwellTime, %BrokerMediationTime, %DrainAllTypes,

%DrainCumulated, %DrainTypesPortions, %DrainTypesTimes, %EmptyTime, %Energy,

%Exporter, %ExporterTimePortions, %FailedTime, %ImporterMUWaitingTime,

%ImporterSetupWaitingTime, %ImporterWaiting, %ImporterWaitingTime,

%MUClassStatistics, %MUClassTimePortions, %MUMatflowProperties,

%MUTimePortions, %MatflowProperties, %MovingTime, %MuEmptyTime, %PausedTime,

%PowerUpDownTime, %RotationTime, %SetupTime, %States, %StoppedTime,

%TransBatteryTime, %TransFailedTime, %TransPausedTime, %TransReadyTime,

%TransTraveledDistance, %TransUsageTime, %WaitingTime,

%WorkerTraveledDistance, %WorkingTime

• Some of the types above are only available for Mus, Brokers, Workers, etc. with a related prefix like "Trans", "Broker", "Worker", etc.

• If the type is given, the statistical object excepts optionally only a caption.

Example:

[Broker, %BrokerDwellTime]

[Broker, "Dwelling Time Statistics", %BrokerDwellTime]

Model result documentation using HTML reports fast and efficient

Object Representations – Statistics Tables (2)

Default types for statistical objects, if no explicit type gets specified:

Entity %MUTimePortions

Container %MUMatFlowProperties Transporter %TransUsageTimes Worker %WorkerTraveledDistance Turnplate,

Turntable,

PickAndPlace %RotationTime Converter %MoveingTime

Drain %DrainCumulated

Exporter %Exporter

Broker %BrokerMediationTime All others %State

(13)

Object Representations – Variables

• Variable objects are added the same like the other objects, but they represent their content

• Any numerical or string content is returned as string with the eventually associated unit or currency

• The precision of a number – the count of digits after the period – and zero padding can be set up

• If a Variable holds a table or list object, this gets displayed using the same parameterization

• If a Variable holds a reference to an object, than the path to the object is returned until a object-evaluating formula is used to return the object contents using the same parameterization

• Examples:

[IntegerVariable]

[RealVariable, 04]

[TimeVariable, 2]

Model result documentation using HTML reports fast and efficient

Object Representations – Methods

• Methods can be use to integrate their results into a HTML report

• Any return value of a method will be converted into a string to be inserted into the HTML report

• Markup can not be used within the Method result, but enclosing the result into "<<"

and ">>" allows to use HTML inside the returned results of the Method

• Example:

• Method:

param name:string -> string

return to_str("<<Hello ", name, "<strong>Hello World</strong>>>")

• Usage:

[Method(“John Doe")]

(14)

Model result documentation using HTML reports fast and efficient

Object Representations – HtmlReports

• To modularize a HTML report, another HTML report can be inserted:

[SubFrame.HtmlReport]

• The parameters for inserting a HTML report are:

• The object the report refers to using the anonymous identifier "@":

[SubFrame.HtmlReport, SingleProc]

• The default level for the headings inside the inserted HTML report by specifying hash marks:

[SubFrame.HtmlReport, #]

[SubFrame.HtmlReport, ##]

[SubFrame.HtmlReport, SingleProc, #]

• To insert HTML reports for all objects of a certain “class” in the current Frame including sub-Frames:

[HtmlReportForSingleProc, .MaterialFlow.SingleProc*]

Model result documentation using HTML reports fast and efficient

Object Representations – FileLink

• If a FileLink references a bitmap or SVG file (ScalableVectorGraphic), than the FileLink object can be used to add this referenced image to the report:

[FileLink]

• The parameters for inserting the referenced image to the HTML report are the same, than those for referencing object images:

[FileLink, 120, 90]

[FileLink, "caption"]

[FileLink, "caption", 120, 90]

[FileLink, 150%]

[FileLink, "caption", 150%]

[FileLink, *]

[FileLink, "caption", *]

The data of the image (bitmap or SVG) will be included into the HTML data

(15)

Object Representations – Display, Comment

• Display object

• A Display object inserts its content into the generated HTML as long its display type is “Text"It is possible to use the Display objects font and color attributes:

[Display, true]

• Comment object

• The Comment object will add the comment text to the HTML report as quiet distinguishable part of the report to draw attention:

[Comment]

Model result documentation using HTML reports fast and efficient

Object Representations –Checkboxes, Dropdown Lists

• Checkbox object

• The Checkbox object adds its current icon for the (un)checked state to the generated HTML.

By default the label of the Checkbox object is displayed to the left of the icon

• To display the label of the Checkbox object to right of the icon:

[Checkbox, true]

• Dropdown List

• A Dropdown List object inserts its current selected object into the generated HTML

(16)

Model result documentation using HTML reports fast and efficient

Toolbar Usage – Table of Contents

•

List of Functions 32

•

Insert an Object 33

•

Insert an Image 34

Model result documentation using HTML reports fast and efficient

Toolbar Usage – List of Functions

• The toolbar has the following functions:

• Undo – undoes the last operation (Ctrl+z)

• Inserts the markup for bold text or around selected text (Ctrl+b)

• Inserts the markup for italics or around select text (Ctrl+i)

• Inserts a bullet list item markup (Ctrl+Shift+Hyphen)

• Inserts a numbered list item markup

• Increases (Ctrl+m) or decreases (Ctrl+M) the indention

• Inserts a protected blank (non-breakable space -  ) (Ctrl+Shift+Blank)

• Inserts a page break for print control (Ctrl+Shift+Return)

• Inserts a reference to an object or attribute (Ctrl+k)

• Inserts an image from an object

• Adds a new image from the file system to the HTML report object and inserts it

(17)

Toolbar Usage – Insert an Object

• To inserts a reference to an object or attribute the following steps are needed:

• Selecting an object or attribute by the known object and/or attribute selection dialog

• Depending on the object type one of the following object parameter dialogs pops up:

Model result documentation using HTML reports fast and efficient

Toolbar Usage – Insert an image of an objector attribute reference

• To inserts an image of an object the following steps are needed:

• Selecting an object or attribute by the known object and/or attribute selection dialog

• Selecting an image from the image overview:

• Specifying the image parameters:

(18)

Model result documentation using HTML reports fast and efficient

Enhanced usage – Table of Contents

•

SimTalk Attributes and Methods 36

•

a complex Example 39

Model result documentation using HTML reports fast and efficient

Enhanced usage – SimTalk Attributes and Methods (1)

• The HTML report object has the following SimTalk attributes and methods:

• HTML report generation

• TocLevels

Returns or configures the attribute value representing the number of levels of headings in the table of contents.

Valid values:

• 1 – only headings of the level 1 (#) are listed in the table of contents

• 2 – the first and second heading levels (#, ##) are listed

• 3 – the first, second and third heading levels are (#, ##, ###) listed

• 4 – the first four heading levels (#, ##, ###, ####) are listed in the table of contents

(19)

Enhanced usage – SimTalk Attributes and Methods (2)

• Dynamic HTML report content creation

• append

Appends a text, interpreted as markup, to the report.

The text to be appended can contain any markup syntax and HTML elements.

Thus the text to be appended is not necessarily the text visible after translating into HTML.

• appendLine

Appends only a line, interpreted as markup, to the report.

• appendPlain

Appends a text, only parsed for special characters to be quoted, to the report.

Thus the text appended to the report should be identical to the visible text after translating into HTML.

Model result documentation using HTML reports fast and efficient

Enhanced usage – SimTalk Attributes and Methods (3)

• save

If the report is displayed in its MDI window, than the shown report gets saved to the given file. Otherwise a new report will be generated and saved to the given file.

In opposite to the displayed HTML report , the saved HTML report won’t have object links.

• show, close

Shows the report in its MDI window or closes the currently opened MDI window of the HTML report.

(20)

Model result documentation using HTML reports fast and efficient

Enhanced usage – a complex Example (1)

• The available demonstration Model ReportDemo.spp is a good example for a complex and modularized HTML report:

• The model contains a scenario with several sub-Frames containing HtmlReport objects

• The main HTML report includes its sub-HtmlReport contents this way:

• Each sub-Frame with a sub-HtmlReport object named its HTML report

“ReportObject”

• The HTML report named “ReportObject” is automatically used, when one of the folliwng markup is used – which is identical to the inclusion of HTMLReport objects:

[SubFrame]

[SubFrame, objectPath]

[SubFrame, #]

[SubFrame, objectPath, #]

• Accessing a Frame with a ReportObject won’t show its screenshot, but will integrate its HTML report

Model result documentation using HTML reports fast and efficient

Enhanced usage – a complex Example (2)

• The available demonstration Model ReportDemo.spp is a good example for a complex and modularized HTML report:

• The model shows a way to address multiple objects of the same class:

[.Folder.Folder.….ClassObject*]

• This enhanced syntax allows to collect the HTML report representation of all objects derived from the given class object:

[.MaterialFlow.SingleProc*]

[.ReportHelpers.TODO*]

[.UserInterface.Comment*]

[.MaterialFlow.Frame*, "caption", 120, 80]

• All objects in the Frame the HTML report belongs to and in all sub-Frames derived from the given class object are iterated and included in the HTML report

• This enhance syntax allows to provide the parameters for the collected objects, like for images

(21)

Martin Lemburg Software Developer

Tecnomatix Plant Simulation Nonnendammallee 101 D-13629 Berlin

Phone: +49 30 46 777 522 Fax: +49 30 46 777 511

E-mail:

[email protected]

www.siemens.com/plm/PlantSimulation