4.4.
Report editor workspace
Report editor workspace gathers windows:
1. Reports;
2. Report editor window (dynamic window).
3. Report attributes.
4.4.1. Reports window
4.4.2. Report editor window
4.4.3. Report attributes window
4.4.3.1. Report attributes
4.4.3.2. Label attributes
4.4.3.3. Table attributes
4.4.1. Reports window
Reports window contains a list of project reports. The list of reports looks like a
qualifier. You can edit its hierarchy, make groups, etc.
The window has commands:
Create new element is a command to create a new row in the list of reports.
Set an icon is command to open a dialog, where you can select an icon to set the icon
for the selected rows.
Order by name is command to sort reports by their names.
Delete selected element(s) is command to delete selected reports.
Open report is a command to open report editor window with selected report.
Expand all is a command that expands all nodes in a reports tree.
Collapse all is a command that collapses all nodes in a reports tree.
4.4.2. Report editor window
Report editor window contains a consequent set of objects to form a report in a web
browser or in model navigator. To form a report, you should use two objects: Label and
Table. With syn-tony of these objects and queries (see below) you can setup a look of ready
to use reports.
Warning! All changes, that were made in a report will not be inserted in a history of
user's actions and you will not be able to undo an action with a report.
Report editor window has commands:
Label is a command to add a new Label object to the report.
Table is a command to add a new Table object to the report.
Move up is a command to move a selected objects up.
Move down is a command to move a selected objects down.
Delete is a command to delete a selected objects.
Compile report form is a command to compile the report to an inner structure of
data. The structure serves for a ready to use report in a web browser or in a model
navigator. Thus, to use last changes in a report, you should to compile it first.
Import report from XML file is a command to open a report from a XML file.
Export report to XML file is a command to save a report to a XML file.
With “Import report from XML file” and “Export report to XML file” commands,
you can transfer reports between different projects.
To select an object in a report editor window, you should click the object. To select a
few objects, you should click on each objected with pressed Ctrl key on the keyboard. To
select a report as an object click on report's free space.
4.4.3. Report attributes window
Report attributes window contains a table with attributes and their values of selected
objects or object's parts in the report editor window. Beside a report also has attributes. To
see a report's attributes you should click report's free of objects space.
4.4.3.1. Report attributes
4.4.3.2. Label attributes
4.4.3.3. Table attributes
4.4.3.1. Report attributes
Base qualifier is an attribute to set a qualifier. The qualifier will be used to build a
report. If you build a report for a model, you should select the model for this attribute. This
attribute cannot be empty.
Language of keywords is an attribute to set a language of keywords. This attribute
cannot be empty.
Model is an attribute to set a model, which is used to build a report. Keywords use
this model (see below).
4.4.3.2. Label attributes
Text is an attribute to set a text, which will be showed in a report. Text can contain a
keywords, which will be used to show different data from a project, like attributes of
elements. A query and a keyword has to be written in squared brackets, like
“[QUERY.KEYWORD]”. A query in the Text attribute has the same form as a query in a
Table attribute (see below). A keyword is written after a query with a dot. Thus, a keyword
specifies a text which should be inserted in the attribute.
List of available keywords:
Name is a name of current element.
QualifierName is a name of current element's qualifier (this should be written as
one word “QualifierName”, any space is not available between “Qualifier” and
“Name” parts of this word).
Code is a code of current element.
CodeIDEF0 is a code of current element, according to the IDEF0 notations [1].
SerialNumber is a serial number of a row in a table. This keyword can be used
only in tables. Beside a query before this keyword, must be exactly as the Query
attribute of the table (see below).
“A name of an attribute”. You can use as a keyword any name of any attribute, to
insert the attribute into the text. A name of an attribute has priority by comparison
with others keywords. That's mean, if you use an attribute with name “Code”, for
example, then keyword “Code” will be replaced with the attribute “Code”, but not
with code of current element.
Queries with keywords can be used in any part of a text. If you need to use symbols
“[“ and “]” in the Text attribute, then, you should replace them with symbols “\[“ and “\]”.
Analogically, you should use “\<”, “\>”, “\\” instead of “<”, “>”, “\” symbols.
If a query and a keyword forms for a Table object (see below), that the query have to
be started like a query for the table object.
In hard need, for additional formatting you can use HTML tags in a text. HTML tag
should be written between symbols “<” and “>”. For example, text “This <b>is</b> simple
<i>text</i>” will be formatted as “This is simple text”. Only formating HTML tags can be
used, you can meet information about HTML tags in additional documentation.
Font is an attribute to set a font of the label.
Size is an attribute to set a size of the label.
Font type is an attribute to set a formatting of the label.
Text align is an attribute to set text align in the label.
Connect with next table. If you set this attribute to “Yes”, then the label will be
shown only if a table below has at least one row. If there is no table below, value of this
attribute is not important.
Print for. With this attribute you can filter labels. If this attribute is empty, then the
label will be present for all elements.
4.4.3.3. Table attributes
Column count is an attribute to set a column count in the table. If this attribute is
empty, then the table contains one column.
Query is an attribute to set a query for getting data from a project. A query sets a way
of data getting from a project. The query is a set of keywords, divided by dot “.”. First
keyword in the query is always a name of base qualifier for the report (see chapter 4.4.3.1.
Report attributes). You should perceive every keyword in a query as a qualifier of some
type (qualifier of activities, qualifier of streams or any other qualifier created by an user).
Depending on this qualifier type, you can use different next keywords. Every keyword also
results a qualifier of some type.
Table 1: Keyword, that can be used after activity boxes
Keyword Definition Qualifier type
Inputs Keyword returns a set of inputs. Streams
InputsControls Keyword returns a set of inputs and controls. Streams
InputsMechanisms Keyword returns a set of inputs and mechanisms. Streams
InputsControlsMechanisms Keyword returns a set of inputs and and controls Streams
mechanisms.
Outputs Keyword returns a set of outputs. Streams
Controls Keyword returns a set of controls. Streams
Mechanisms Keyword returns a set of mechanisms. Streams
Owners Keyword returns a set of owners. Qualifier of
owner
Table 2: Keywords, that can be used after streams
Keyword Definition Qualifier type
Inputs Keyword returns a set of activities, for which Activities
the stream is an input. Every activity shouldn't
have a decomposition diagram.
InputsControls Keyword returns a set of activities, for which Activities
the stream is an input or a control. Every
activity shouldn't have a decomposition
diagram.
InputsMechanisms Keyword returns a set of activities, for which Activities
the stream is an input or a mechanism. Every
activity shouldn't have a decomposition
diagram.
InputsControlsMechanisms Keyword returns a set of activities, for which Activities
the stream is an input or a control or a
mechanism. Every activity shouldn't have a
decomposition diagram.
Outputs Keyword returns a set of activities, for which Activities
the stream is an output. Every activity
shouldn't have a decomposition diagram.
Controls Keyword returns a set of activities, for which Activities
the stream is a control. Every activity shouldn't
have a decomposition diagram.
Mechanisms Keyword returns a set of activities, for which Activities
the stream is a mechanism. Every activity
shouldn't have a decomposition diagram.
Qualifiers Keyword returns a set elements, which are Qualifier created
linked to the stream. by an user.
“Name of a qualifier” Keyword returns a set elements, which are A qualifier created
linked to the stream, and which are belong to a by an user, with
qualifier with the set name. the same name.
Table 3: Keywords, that can be used after a user qualifier
Keyword Definition Qualifier type
Inputs Keyword returns a set of activities, for which stream Activities
is an input, and the element is linked the stream.
Every activity shouldn't have a decomposition
diagram.
InputsControls Keyword returns a set of activities, for which stream Activities
is an input or a control , and the element is linked the
stream. Every activity shouldn't have a
decomposition diagram.
InputsMechanisms Keyword returns a set of activities, for which stream Activities
is an input or mechanism, and the element is linked
the stream. Every activity shouldn't have a
decomposition diagram.
InputsControlsMechanisms Keyword returns a set of activities, for which stream Activities
is an input or a control or a mechanism, and the
element is linked the stream. Every activity shouldn't
have a decomposition diagram.
Outputs Keyword returns a set of activities, for which stream Activities
is an output, and the element is linked the stream.
Every activity shouldn't have a decomposition
diagram.
Controls Keyword returns a set of activities, for which stream Activities
is a control, and the element is linked the stream.
Every activity shouldn't have a decomposition
diagram.
Mechanisms Keyword returns a set of activities, for which stream Activities
is a mechanism, and the element is linked the stream.
Every activity shouldn't have a decomposition
diagram.
Owners Keyword returns a set of activities, for with the Activities
element is an owner.
“Projection name” Keyword returns a set of elements linked with Qualifier, that is
projection to the element. linked to a
current qualifier
with a
projection.
Attribute name of “Qualifier Keyword returns a a set of elements linked with
element” attribute. qualifier element attribute to the element.
Border is an attribute to set border weight. If this attribute is empty, the table will not
have a border.
Print for. With this attribute you can filter tables. If this attribute is empty, then the
table will be present for all elements.
Table's elements “Title element” and “Body element” have attributes just like a Label
element (see chapter 4.4.3.2. Label attributes).
