itm wiki - Contributi utente [it]

Resources and Groups

2019-08-05T09:40:53Z

Luca.pandolfo: /* Group Definition */

itmSUITE® manage resources and Groups as way to profile the user to the System.

''[[Glossary | Resource]]'' is linked to a ''[[Glossary | User]]'' and can belongs to a different Groups.
''[[Glossary | Group]]'' is used to profile the resources and assign to them different roles in the system.

The main point treated in the guide are:
# Resource Management process
# Group Management process

== Resource Management process ==

The following table report the process the ''resource'' is involved

{| class="wikitable"
! Resource Management!! Description
|-
| Resource Definition || See below
|-
| Add Resource to Group || See below
|-
| Add Resource to Project / Service|| ''[[ Project configuration steps - Resources |Resource on Project]]''
|-
| Enable a Resource on Service Catalogue Request (SRCS)|| ''[[ Creating Service Catalog Management (SRCS)|SRCS Management]]''
|-
| Timesheet declaration || ''[[ Timesheet Management |Timesheet Management]]''
|-
| Synchronization User & Resource with Active Directory || ''[[ Domain authentication and SSO| User and Resource Synchronization]]''

|}

=== Resource Definition ===

Manage the ''Resource'' is the entry point of Human management at the system.
''Resource'' can be associate to a ''User’, so he/she has a login or can be a standalone resource.

Resource management is done by a Manager ''[[Glossary | Role]]'', using the Resources/ Resources 
This session enables the Manager / Administrator to: Add, Copy and filter

To perform the copy of the ''Resource'' is necessary to select an existing ''Resource''.

The Resource form presents nine tabs:

# General
# Address
# Document
# Configuration Items
# Project / Service
# Service Request
# Groups
# Privileges
# Cost Items

here below the list of fields present into the General tab:

{| class="wikitable"
! Field !! Description
|-
| "Creation User" || Contains the ''full name'' of resource that has created the record. Non editable.
|-
| "Creation Date" || Contains the ''Date time'' of record registration. Non editable.
|-
| "Edit User" || Contains the ''full name'' of the last resource that has saved the record. Non editable.
|-
| "Edit Date" || Contains the ''last Date time'' of record modification. Non editable.
|-
| "Status" || This field identify the ''supplier' status, available values are:
{| class="wikitable"
! Status!! Description
|-
| Inactive || Initial status of Resource enable the ''Manager'' to set all the properties
|-
| Active || Status to set if the Resource to get it operational
|-
| Cancelled || Status to set if the Resource is no more operational
|}
|-
| "Code" || Company internal number of the resource. Non editable.
|-
| "Name" || Name of the Resource.
|-
| "Surname" || Surname of the Resource.
|-
| "Birthday" || Date of Birth of the Resource.
|-
| "Birth Place" || Place of Birth of the Resource.
|-
| "Type" || This is an attribute of the ''Resource''. The master data for this field are present in ''/General/Resources/Resource Type''.
|-
| "External code" || This is an attribute of the ''Resource''. Usually is used as external key toward other Company software. E.g.: SAP Employee Number.
|-
| "Country" || This is an attribute of the ''Resource''. The master data for this field are present in ''/General/Company/Countries''.
|-
| "Supplier" || This is an attribute of the ''Resource''. The master data for this field are present in ''/General/Supplier Management/Suppliers''.
|-
| "Sale Role" || This information determines the define the Default profile that will be used by the billing process. The master data for this field are present in ''/General/Resources/Sale Roles''.
|-
| "Purchase Role" || This information determines the define the Default profile that will be used to charge costs. The master data for this field are present in General/ Resources/Purchase Roles
|-
| "Is customer Resource" || This is an attribute of the ''Resource''. This flag declare that a resource is linked to a ''Client''
|-
| "Customer" || This is an attribute link the ''Resource'' to the client he/she belongs to.
|-
| "Organization Unit" || This is an attribute link the ''Resource'' to the Organization Unit (OU) of Client he/she belongs too.
|-
| "Login" || This is an attribute link the ''Resource''. Login is a link towards the User Management information.
|-
| "Can declare holiday" || If flagged enable the resource to manage his Holiday. Holiday is managed directly in ''/Personal/Resource calendar''.
|-
| "Pers.View Right" || If flagged enable the resource to manage ''[[Views_management#Personal_Data_views|Personal views]]''
|-
| "Client Type" || This is an attribute of the ''Resource''. The master data for this field are present in ''/General/Company/Client Types''.
|-
| "VIP Type" || This is an attribute of the ''Resource''. The master data for this field are present in ''/General/Resources/VIP Types''.
|-
| "Can declare illness" || If flagged enable the resource to manage his Illness. Illness is managed directly in ''/Personal/Resource calendar''.
|-
| "Can switch Accessible Mode" || This is an attribute of the ''Resource''. If flagged enable the resource to access the system in Accessible Mode.
|-
| "Can open ticket by resource selection" || This is an attribute of the ''Resource''. If flagged enable the ''resource'' to call "Add Request by Resource". This is a special way to call ''[[ Glossary | SRCS]]'' session. The value available are:
{| class="wikitable"
! Field!! Description
|-
| No (Default) || ''[[ Glossary | SRCS]]'' special form is not active for this ''Resource''
|-
| Simple || ''Resource'' can open "Add Request by Resource” but the edit resource information option isn't available
|-
| Full Options || ''Resource'' can open "Add Request by Resource" and the edit resource information option is available
|}
|-
| "Resource search Capability" || This is an attribute depends of "Can open ticket by resource selection". The value available are:
{| class="wikitable"
! Field!! Description
|-
| "All Resources" || Default value, the "Add Request by Resource" function shown all the active Resources
|-
| "Only Resources of OU he/she belongs to" || If flagged enable the ''resource'' to select in the "Add Request by Resource" function only the resources present in the same Resource OU.
|-
| "Only Resources of OUs where Resource is OU Manager" || If flagged enable the ''resource'' to select in the "Add Request by Resource" function only the resources present all the OUs where he/she is the OU Manager.
|}
|-
| "Can Edit Own Resource Data" || If flagged enable the ''resource'' to update the ''/Personal/Profile'' information.
|-
| "CMS Access" || If flagged enable the ''resource'' login to itmSUITE® CMS Module
|-
| "User Mapping mode" || itmSUITE® CMS is core module that can be called from itmSUITE® PM or itmSUITE® SM or via specific portal. When called from PM/SM we should specify how the connect resource can be seen in CMS.
The available options are:
{| class="wikitable"
! Access Option!! Description
|-
| System || The current resource will be granted with system right on itmSUITE® CMS, so he/she will have the Administrator privileges. (see [[ASM - Asset and Service Management]])
|-
| CMS local || The current resource should have a login on itmSUITE® CMS. PM /SM login should match with the CMS login. (see [[ASM - Asset and Service Management]])
|-
| Suite || The current resource login will be used on CMS. The right on CMS will be inherit via Groups Privileges. (see [[ASM - Asset and Service Management]])
|}

|}

For each ''resource'' is possible to set different Address. For example, "Headquarters", "Order" addresses. The session enables the user to Add, Delete or Print the list of address.

The list of fields is shown in the table below:

{| class="wikitable"
! Address tab fields!! Description
|-
| "Address" || Used to set Street information
|-
| "City" || Used to indicate the supplier's city
|-
| "Postal code" || Used to indicate the supplier's postal code
|-
| "District" || Used to indicate the supplier's province
|-
| "Region" || Used to indicate the supplier's region
|-
| "Phone" || Used to indicate the supplier's phone number. This should be specific by supplier address type, "Headquarters", "Order"
|-
| "Mobile" || Used to indicate the supplier's Mobile phone number.
|-
| "Fax" || Used to indicate the supplier's fax number.
|-
| "Email" || Used to indicate the supplier's Email information.
|-
| "Type" || This is an attribute of the ''supplier''. The master data for this field are present in ''/General/Company/Address Types''.
|-
| "Notes" || Used to indicate general notes.
|-
| "Country" || This is an attribute of the ''supplier''. The master data for this field are present in ''/General/Company/Countries''.
|-
| "Use for Ticket Info" || if flagged this address will be used to populate the ''Ticket User Info Tab''. information
|-
| "Default" || if flagged this address will be proposed as default address.
|}

For each ''resource'' is possible to add different Documents. The session enables the user to Add, Delete or Print the list of documents.

The list of fields is shown in the table below:
{| class="wikitable"
! Field !! Description
|-
| "Creation User" || Contains the ''full name'' of resource that has created the record. Non editable.
|-
| "Creation Date" || Contains the ''Date time'' of record registration. Non editable.
|-
| "Edit User" || Contains the ''full name'' of the last resource that has saved the record. Non editable.
|-
| "Edit Date" || Contains the ''last Date time'' of record modification. Non editable.
|-
| "Name" || Document name. Populated automatically with the file name, can be change by the user.
|-
| "Topic" || Identify the area of the document. The Topic follow the document taxonomy
|-
| "Type" || Identify the type of document. The Type follow the document taxonomy.
|-
| "Format" || Document can be store in the itmSUITE® Database, default option, or linked to an external source.
|-
| "Visibility" || This Option enable the user to set the Document visibility.
{| class="wikitable"
! Field !! Description
|-
| "Private" || Only the people that can manage the ''resource'' can manage the document.
|-
| "Public" || in this case the system enable to select the "All Users" flag.
|}
|-
| "Description" ||Additional document description
|-
| "Upload Document" ||document full path or link.
|}

For each ''resource'' is possible to Manage Configuration Item. The session enables the user to Add and Associate, Assign to Requester a configuration item. The possibility to see or manage the configuration is granted via the ''Privileges'' tab, see below.
Anyway if ''[[Glossary | Configuration Item]]’’ are associated to the ''resource'' some property is show to the user. For further detail refer to [[ASM - Asset and Service Management]]

For each ''resource'' is possible to see the list of ''[[Glossary |Project]]'' / ''[[Glossary | Service]]'' he/she is involved. The ''Project/Service'' tab show also if the resource is "On Budget" on a specific project/service.

For each ''resource'' is possible to see the list of ''[[Glossary |SRCS]]'' he/she has been enabled.

For each ''resource'' is possible to manage the assignment of resource to specific ''group''.
The session enables the user to Add, Delete or Print the list of groups. Note:
# Adding a resource to groups means add he/she as a Group Member
# Deleting resource from a group means delete he/she as a Group Member

For each ''resource'' is possible to manage Privileges. There are two possible levels of granularity: visibility or editability and can be assigned at the following entity:
# Resources
# Price lists

Resource privileges is managed by ''resource type'' and Entity. The list of available entity is:
<Resource Type>

{| class="wikitable"
! Entity!! Description
|-
| Tab General view || Resource can view General Tab of Resource session
|-
| Tab General update || Resource can update General Tab of Resource session
|-
| Tab Address view || Resource can view Address Tab of Resource session
|-
| Tab Address update|| Resource can update Address Tab of Resource session
|-
| Tab Document view|| Resource can view Document Tab of Resource session
|-
| Tab Document update|| Resource can update Document Tab of Resource session
|-
| Tab Configuration Item view|| Resource can view Configuration item Tab of Resource session
|-
| Tab Configuration Item update|| Resource can update Configuration item Tab of Resource session
|-
| Tab Project/Service view|| Resource can view Project/Service Tab of Resource session
|-
| Tab Project/Service update|| Resource can update Project/Service Tab of Resource session
|-
| Tab Service Request view|| Resource can view Service Request Tab of Resource session
|-
| Tab Service Request update|| Resource can update Service Request Tab of Resource session
|-
| Tab Group view|| Resource can view Group Tab of Resource session
|-
| Tab Group update|| Resource can update Group Tab of Resource session
|-
| Tab Privileges view|| Resource can view Privileges Tab of Resource session
|-
| Tab Privileges update|| Resource can update Privileges Tab of Resource session
|-
| Tab Cost Items view|| Resource can view Cost Items Tab of Resource session
|-
| Tab Cost Items update|| Resource can update Cost Items Tab of Resource session
|}

''[[Glossary |Price list]]'' privileges are managed for entity. The list of available entity is:
{| class="wikitable"
! Entity!! Description
|-
| Price lists view || Resource can view Price List definition
|-
| Price lists update ||Resource can update Price List definition
|-
| View Price items for projects/services ||Resource can view Price Items Project / Service definition
|-
| Update Price items for projects/services||Resource can update Price Items Project / Service definition
|-
| View Cost items for resources||Resource can view Cost Items definition
|-
| Update Cost items for resources||Resource can update Cost Items definition
|}

For each ''resource'' is possible to manage Cost Items. Resource can manage Cost Item only if enabled in tab ''Privileges''. Cost Item is the instance of a Price Item actualized with the Start Date. E.g a Price Item can be the license of a product. The Cost track and expense the assignment of the license to a resource. The session enables the user to Add, Delete a Cost Item. When a Cost Item is assigned to a resource is important to recorded the quantity and the "Start Date" (Assignment Start Date). To track all figure assigned to a resource is better to set the "End Date" (Assignment End Date) instead of deleting the relationship between ''Resource'' and ''Cost Item''.

=== Add Resource to Project / Service ===
Resource in a key point of Project and Service management. Without resource is not possible to develop the activities, records costs and benefit. For further detail about this subject refer to
''[[Project configuration steps - Resources]]''

=== Enable a Resource on Service Catalogue Request (SRCS) ===

itmSUITE® enable the ''Manager'' to create a catalogue of request and to distribute it to a ''resource'' , groups as well to all the resources that belongs to an Organization unit. For further detail about this subject refer to ''[[Workflow Engine Configuration]]''

=== Timesheet declaration ===
Timesheet declare can be perform by all the resource except the user with Role "Requester". For further detail about this subject refer to ''[[Workflow Engine Configuration]]'' or ''[[Timesheet Management]]''

=== Synchronization User & Resource with Active Directory ===
Resource can be created manually or imported from Active Directory. For further detail about this subject refer to ''[[Domain authentication and SSO]]''

== Group Management process ==
The following table report the process the Group is involved

{| class="wikitable"
! Group Management !! Description
|-
| Group Definition || See Above
|-
| Add Resource to Group || See above on Resource Chapter
|-
| Add Group as Profile in a Workflow || ''[[ Workflow Engine Configuration|Workfow mangement]]''
|-
| Add Group to Workflow || ''[[ Workflow Engine Configuration|Workfow mangement]]''
|-
| Enable a Group on Service Catalogue Request (SRCS) || ''[[ vvv |SRCS Management]]''
|-
| Profile a Timesheet declaration || ''[[ Timesheet Management| Timesheet Management]]''
|}

=== Group Definition ===

Manage the ''Group'' is the entry point to manage group of resources for:
# Manage profile role on workflow
# Create a visibility or assigned ownership or activity in workflow
# Profile the Timesheet declaration.

Group management is done by a Manager ''[[Glossary | Role]]'', using the General/Ticket/Groups . This session enables the Manager / Administrator to: Add, Delete and Print the list of Group.

The Group form presents four tabs:
# General
# Member
# Privileges
# Domain Info

Groups deletion is a logical cancellation.

To define a Group is we can insert:
The list of fields is shown in the table below:
{| class="wikitable"
! Field !! Description
|-
| Name || Group Name
|-
| Description || Group description
|-
| Default || Attribute of group. Usually the manager configures the group using the ''[[Glossary | MDMM]]'' function.
|-
| Status || This field can be Active / Cancelled. Only "Active" group are seen in Workflow Management. changeableness
|-
| Menu Access || If flagged this Group will be accessible as menu link
|-
| Group can't be deleted || If flagged this Group can't be accidentally cancelled
|}

General tab enabled to define a group of groups. itmSUITE® enable this selecting the Add Group button.

For each ''Group'' is possible to define the ''Members''. Manager can specify directly the list of resource that will be part of it. itmSUITE® presents an EJS grid with the possibility to Add , Filter and Delete the member ''resource'' of a group. Deletion in this case perform a physical relationship cancellation between ''resource'' and ''group''.

For each ''group'' is possible to manage Privileges. There are two categories of privileges:
# General Privileges
# ASM Privileges

General Privileges can be set for the following entity:
# Resources, with the same detail present in ''Resource / Privileges''
# Price lists, with the same detail present in ''Resource / Privileges''
# Timesheet

Timesheet privileges can be granted on the following entity
{| class="wikitable"
! Entity!! Description
|-
| Group View || Resource Member of group can view all the timesheet that refer to itself
|-
| Group Approval || Resource Member of group can Approved the timesheet that refer to itself
|}

[[Glossary| ASM]] Privileges, show the [[Glossary | Configuration Item]] Structure present into the itmSUITE® CMS Module. For each folder/sub folder the ''Administrator'' can assign the following privileges:

{| class="wikitable"
! Privilege !! Description
|-
| Read || Resource Member of group can view the ''configuration item'' present into the folder and read the information.
|-
| Update || Resource Member of group can view the ''configuration item'' present into the folder and update the information.
|-
| Read Own || Resource Member of group can view the ''configuration item'' present into the folder and read the information only of he/she is the ''Creator'' of the ''configuration item''.
|-
| Update Own || Resource Member of group can view the ''configuration item'' present into the folder and update the information only of he/she is the ''Creator'' of the ''configuration item''.

|}
It is possible also grant the group to:
{| class="wikitable"
! Privilege !! Description
|-
| Exploration model grant || Resource Member of group can run the Exploration Model function
|-
| Meta Data grant || Resource Member of group can manage the Metadata function
|}

=== Add Resource to Group ===
Refer to ''Member'' Tab management above.

=== Add Group as Profile in a Workflow ===
The Workflow management has been enriched with the possibility to profile ''Group'' as [[Glossary |Role]] in a Workflow.
With this feature Resource present on a Group can be granted to:
* Access a ticket
* Manage a ticket
For further detail see [[Workflow Engine Configuration |Workflow Management]] in a Workflow.

=== Add Group to Workflow ===
Group is a a key component in ''Workflow Management''.
Mainly the Group can act as Profile,say static [[Glossary |role]], or assume dynamic [[Glossary |role]], so per ''ticket''.

For further detail see [[Workflow Engine Configuration |Workflow Management]] in a Workflow.

=== Enable a Group on Service Catalogue Request (SRCS) ===
[[Glossary |SRCS]] is the service catalogue request. itmSUITE® can grant the visibility of a single request to:
#Requester(s)
#Group(s)
#Organization Unit(s)

For further detail see [[Creating Service Catalog Management (SRCS)|SRCS Management]] in a Workflow.

=== Profile a Timesheet declaration ===
This feature enable the resource to specify the Group he/she was working during the ''Timesheet'' registration. This feature is a simple way to categorized ''Timesheet'' based on the Business Role assumed by the Resource.

For further detail see ''[[ Timesheet Management |Timesheet Management]]''

== How to ==
Set on Resource:

{| class="wikitable"
! Resource Configuration!! Link!! Description
|-
| VIP Type || General/ Resources/VIP Type || This function defines the data source to set the VIP type in Resource master data
|-
| Purchase Roles || General/ Resources/Purchase Roles || This function defines the data source used to set the default value for purchase role in the Resource master data.
|-
| Sale Roles || General/ Resources/Sale Roles || This function defines the data source used to set the default value for sale role in the Resource master data.

|}

Resources and Groups

2019-08-05T09:35:48Z

Luca.pandolfo: /* Resource Definition */

itmSUITE® manage resources and Groups as way to profile the user to the System.

''[[Glossary | Resource]]'' is linked to a ''[[Glossary | User]]'' and can belongs to a different Groups.
''[[Glossary | Group]]'' is used to profile the resources and assign to them different roles in the system.

The main point treated in the guide are:
# Resource Management process
# Group Management process

== Resource Management process ==

The following table report the process the ''resource'' is involved

{| class="wikitable"
! Resource Management!! Description
|-
| Resource Definition || See below
|-
| Add Resource to Group || See below
|-
| Add Resource to Project / Service|| ''[[ Project configuration steps - Resources |Resource on Project]]''
|-
| Enable a Resource on Service Catalogue Request (SRCS)|| ''[[ Creating Service Catalog Management (SRCS)|SRCS Management]]''
|-
| Timesheet declaration || ''[[ Timesheet Management |Timesheet Management]]''
|-
| Synchronization User & Resource with Active Directory || ''[[ Domain authentication and SSO| User and Resource Synchronization]]''

|}

=== Resource Definition ===

Manage the ''Resource'' is the entry point of Human management at the system.
''Resource'' can be associate to a ''User’, so he/she has a login or can be a standalone resource.

Resource management is done by a Manager ''[[Glossary | Role]]'', using the Resources/ Resources 
This session enables the Manager / Administrator to: Add, Copy and filter

To perform the copy of the ''Resource'' is necessary to select an existing ''Resource''.

The Resource form presents nine tabs:

# General
# Address
# Document
# Configuration Items
# Project / Service
# Service Request
# Groups
# Privileges
# Cost Items

here below the list of fields present into the General tab:

{| class="wikitable"
! Field !! Description
|-
| "Creation User" || Contains the ''full name'' of resource that has created the record. Non editable.
|-
| "Creation Date" || Contains the ''Date time'' of record registration. Non editable.
|-
| "Edit User" || Contains the ''full name'' of the last resource that has saved the record. Non editable.
|-
| "Edit Date" || Contains the ''last Date time'' of record modification. Non editable.
|-
| "Status" || This field identify the ''supplier' status, available values are:
{| class="wikitable"
! Status!! Description
|-
| Inactive || Initial status of Resource enable the ''Manager'' to set all the properties
|-
| Active || Status to set if the Resource to get it operational
|-
| Cancelled || Status to set if the Resource is no more operational
|}
|-
| "Code" || Company internal number of the resource. Non editable.
|-
| "Name" || Name of the Resource.
|-
| "Surname" || Surname of the Resource.
|-
| "Birthday" || Date of Birth of the Resource.
|-
| "Birth Place" || Place of Birth of the Resource.
|-
| "Type" || This is an attribute of the ''Resource''. The master data for this field are present in ''/General/Resources/Resource Type''.
|-
| "External code" || This is an attribute of the ''Resource''. Usually is used as external key toward other Company software. E.g.: SAP Employee Number.
|-
| "Country" || This is an attribute of the ''Resource''. The master data for this field are present in ''/General/Company/Countries''.
|-
| "Supplier" || This is an attribute of the ''Resource''. The master data for this field are present in ''/General/Supplier Management/Suppliers''.
|-
| "Sale Role" || This information determines the define the Default profile that will be used by the billing process. The master data for this field are present in ''/General/Resources/Sale Roles''.
|-
| "Purchase Role" || This information determines the define the Default profile that will be used to charge costs. The master data for this field are present in General/ Resources/Purchase Roles
|-
| "Is customer Resource" || This is an attribute of the ''Resource''. This flag declare that a resource is linked to a ''Client''
|-
| "Customer" || This is an attribute link the ''Resource'' to the client he/she belongs to.
|-
| "Organization Unit" || This is an attribute link the ''Resource'' to the Organization Unit (OU) of Client he/she belongs too.
|-
| "Login" || This is an attribute link the ''Resource''. Login is a link towards the User Management information.
|-
| "Can declare holiday" || If flagged enable the resource to manage his Holiday. Holiday is managed directly in ''/Personal/Resource calendar''.
|-
| "Pers.View Right" || If flagged enable the resource to manage ''[[Views_management#Personal_Data_views|Personal views]]''
|-
| "Client Type" || This is an attribute of the ''Resource''. The master data for this field are present in ''/General/Company/Client Types''.
|-
| "VIP Type" || This is an attribute of the ''Resource''. The master data for this field are present in ''/General/Resources/VIP Types''.
|-
| "Can declare illness" || If flagged enable the resource to manage his Illness. Illness is managed directly in ''/Personal/Resource calendar''.
|-
| "Can switch Accessible Mode" || This is an attribute of the ''Resource''. If flagged enable the resource to access the system in Accessible Mode.
|-
| "Can open ticket by resource selection" || This is an attribute of the ''Resource''. If flagged enable the ''resource'' to call "Add Request by Resource". This is a special way to call ''[[ Glossary | SRCS]]'' session. The value available are:
{| class="wikitable"
! Field!! Description
|-
| No (Default) || ''[[ Glossary | SRCS]]'' special form is not active for this ''Resource''
|-
| Simple || ''Resource'' can open "Add Request by Resource” but the edit resource information option isn't available
|-
| Full Options || ''Resource'' can open "Add Request by Resource" and the edit resource information option is available
|}
|-
| "Resource search Capability" || This is an attribute depends of "Can open ticket by resource selection". The value available are:
{| class="wikitable"
! Field!! Description
|-
| "All Resources" || Default value, the "Add Request by Resource" function shown all the active Resources
|-
| "Only Resources of OU he/she belongs to" || If flagged enable the ''resource'' to select in the "Add Request by Resource" function only the resources present in the same Resource OU.
|-
| "Only Resources of OUs where Resource is OU Manager" || If flagged enable the ''resource'' to select in the "Add Request by Resource" function only the resources present all the OUs where he/she is the OU Manager.
|}
|-
| "Can Edit Own Resource Data" || If flagged enable the ''resource'' to update the ''/Personal/Profile'' information.
|-
| "CMS Access" || If flagged enable the ''resource'' login to itmSUITE® CMS Module
|-
| "User Mapping mode" || itmSUITE® CMS is core module that can be called from itmSUITE® PM or itmSUITE® SM or via specific portal. When called from PM/SM we should specify how the connect resource can be seen in CMS.
The available options are:
{| class="wikitable"
! Access Option!! Description
|-
| System || The current resource will be granted with system right on itmSUITE® CMS, so he/she will have the Administrator privileges. (see [[ASM - Asset and Service Management]])
|-
| CMS local || The current resource should have a login on itmSUITE® CMS. PM /SM login should match with the CMS login. (see [[ASM - Asset and Service Management]])
|-
| Suite || The current resource login will be used on CMS. The right on CMS will be inherit via Groups Privileges. (see [[ASM - Asset and Service Management]])
|}

|}

For each ''resource'' is possible to set different Address. For example, "Headquarters", "Order" addresses. The session enables the user to Add, Delete or Print the list of address.

The list of fields is shown in the table below:

{| class="wikitable"
! Address tab fields!! Description
|-
| "Address" || Used to set Street information
|-
| "City" || Used to indicate the supplier's city
|-
| "Postal code" || Used to indicate the supplier's postal code
|-
| "District" || Used to indicate the supplier's province
|-
| "Region" || Used to indicate the supplier's region
|-
| "Phone" || Used to indicate the supplier's phone number. This should be specific by supplier address type, "Headquarters", "Order"
|-
| "Mobile" || Used to indicate the supplier's Mobile phone number.
|-
| "Fax" || Used to indicate the supplier's fax number.
|-
| "Email" || Used to indicate the supplier's Email information.
|-
| "Type" || This is an attribute of the ''supplier''. The master data for this field are present in ''/General/Company/Address Types''.
|-
| "Notes" || Used to indicate general notes.
|-
| "Country" || This is an attribute of the ''supplier''. The master data for this field are present in ''/General/Company/Countries''.
|-
| "Use for Ticket Info" || if flagged this address will be used to populate the ''Ticket User Info Tab''. information
|-
| "Default" || if flagged this address will be proposed as default address.
|}

For each ''resource'' is possible to add different Documents. The session enables the user to Add, Delete or Print the list of documents.

The list of fields is shown in the table below:
{| class="wikitable"
! Field !! Description
|-
| "Creation User" || Contains the ''full name'' of resource that has created the record. Non editable.
|-
| "Creation Date" || Contains the ''Date time'' of record registration. Non editable.
|-
| "Edit User" || Contains the ''full name'' of the last resource that has saved the record. Non editable.
|-
| "Edit Date" || Contains the ''last Date time'' of record modification. Non editable.
|-
| "Name" || Document name. Populated automatically with the file name, can be change by the user.
|-
| "Topic" || Identify the area of the document. The Topic follow the document taxonomy
|-
| "Type" || Identify the type of document. The Type follow the document taxonomy.
|-
| "Format" || Document can be store in the itmSUITE® Database, default option, or linked to an external source.
|-
| "Visibility" || This Option enable the user to set the Document visibility.
{| class="wikitable"
! Field !! Description
|-
| "Private" || Only the people that can manage the ''resource'' can manage the document.
|-
| "Public" || in this case the system enable to select the "All Users" flag.
|}
|-
| "Description" ||Additional document description
|-
| "Upload Document" ||document full path or link.
|}

For each ''resource'' is possible to Manage Configuration Item. The session enables the user to Add and Associate, Assign to Requester a configuration item. The possibility to see or manage the configuration is granted via the ''Privileges'' tab, see below.
Anyway if ''[[Glossary | Configuration Item]]’’ are associated to the ''resource'' some property is show to the user. For further detail refer to [[ASM - Asset and Service Management]]

For each ''resource'' is possible to see the list of ''[[Glossary |Project]]'' / ''[[Glossary | Service]]'' he/she is involved. The ''Project/Service'' tab show also if the resource is "On Budget" on a specific project/service.

For each ''resource'' is possible to see the list of ''[[Glossary |SRCS]]'' he/she has been enabled.

For each ''resource'' is possible to manage the assignment of resource to specific ''group''.
The session enables the user to Add, Delete or Print the list of groups. Note:
# Adding a resource to groups means add he/she as a Group Member
# Deleting resource from a group means delete he/she as a Group Member

For each ''resource'' is possible to manage Privileges. There are two possible levels of granularity: visibility or editability and can be assigned at the following entity:
# Resources
# Price lists

Resource privileges is managed by ''resource type'' and Entity. The list of available entity is:
<Resource Type>

{| class="wikitable"
! Entity!! Description
|-
| Tab General view || Resource can view General Tab of Resource session
|-
| Tab General update || Resource can update General Tab of Resource session
|-
| Tab Address view || Resource can view Address Tab of Resource session
|-
| Tab Address update|| Resource can update Address Tab of Resource session
|-
| Tab Document view|| Resource can view Document Tab of Resource session
|-
| Tab Document update|| Resource can update Document Tab of Resource session
|-
| Tab Configuration Item view|| Resource can view Configuration item Tab of Resource session
|-
| Tab Configuration Item update|| Resource can update Configuration item Tab of Resource session
|-
| Tab Project/Service view|| Resource can view Project/Service Tab of Resource session
|-
| Tab Project/Service update|| Resource can update Project/Service Tab of Resource session
|-
| Tab Service Request view|| Resource can view Service Request Tab of Resource session
|-
| Tab Service Request update|| Resource can update Service Request Tab of Resource session
|-
| Tab Group view|| Resource can view Group Tab of Resource session
|-
| Tab Group update|| Resource can update Group Tab of Resource session
|-
| Tab Privileges view|| Resource can view Privileges Tab of Resource session
|-
| Tab Privileges update|| Resource can update Privileges Tab of Resource session
|-
| Tab Cost Items view|| Resource can view Cost Items Tab of Resource session
|-
| Tab Cost Items update|| Resource can update Cost Items Tab of Resource session
|}

''[[Glossary |Price list]]'' privileges are managed for entity. The list of available entity is:
{| class="wikitable"
! Entity!! Description
|-
| Price lists view || Resource can view Price List definition
|-
| Price lists update ||Resource can update Price List definition
|-
| View Price items for projects/services ||Resource can view Price Items Project / Service definition
|-
| Update Price items for projects/services||Resource can update Price Items Project / Service definition
|-
| View Cost items for resources||Resource can view Cost Items definition
|-
| Update Cost items for resources||Resource can update Cost Items definition
|}

For each ''resource'' is possible to manage Cost Items. Resource can manage Cost Item only if enabled in tab ''Privileges''. Cost Item is the instance of a Price Item actualized with the Start Date. E.g a Price Item can be the license of a product. The Cost track and expense the assignment of the license to a resource. The session enables the user to Add, Delete a Cost Item. When a Cost Item is assigned to a resource is important to recorded the quantity and the "Start Date" (Assignment Start Date). To track all figure assigned to a resource is better to set the "End Date" (Assignment End Date) instead of deleting the relationship between ''Resource'' and ''Cost Item''.

=== Add Resource to Project / Service ===
Resource in a key point of Project and Service management. Without resource is not possible to develop the activities, records costs and benefit. For further detail about this subject refer to
''[[Project configuration steps - Resources]]''

=== Enable a Resource on Service Catalogue Request (SRCS) ===

itmSUITE® enable the ''Manager'' to create a catalogue of request and to distribute it to a ''resource'' , groups as well to all the resources that belongs to an Organization unit. For further detail about this subject refer to ''[[Workflow Engine Configuration]]''

=== Timesheet declaration ===
Timesheet declare can be perform by all the resource except the user with Role "Requester". For further detail about this subject refer to ''[[Workflow Engine Configuration]]'' or ''[[Timesheet Management]]''

=== Synchronization User & Resource with Active Directory ===
Resource can be created manually or imported from Active Directory. For further detail about this subject refer to ''[[Domain authentication and SSO]]''

== Group Management process ==
The following table report the process the Group is involved

{| class="wikitable"
! Group Management !! Description
|-
| Group Definition || See Above
|-
| Add Resource to Group || See above on Resource Chapter
|-
| Add Group as Profile in a Workflow || ''[[ Workflow Engine Configuration|Workfow mangement]]''
|-
| Add Group to Workflow || ''[[ Workflow Engine Configuration|Workfow mangement]]''
|-
| Enable a Group on Service Catalogue Request (SRCS) || ''[[ vvv |SRCS Management]]''
|-
| Profile a Timesheet declaration || ''[[ Timesheet Management| Timesheet Management]]''
|}

=== Group Definition ===

Manage the ''Group'' is the entry point to manage group of resources for:
# Manage profile role on workflow
# Create a visibility or assigned ownership or activity in workflow
# Profile the Timesheet declaration.

Group management is done by a Manager ''[[Glossary | Role]]'', using the General/Ticket/Groups . This session enables the Manager / Administrator to: Add, Delete and Print the list of Group.

The Group form presents four tabs:
# General
# Member
# Privileges
# Domain Info

Groups deletion is a logical cancellation.

To define a Group is we can insert:
The list of fields is shown in the table below:
{| class="wikitable"
! Field !! Description
|-
| Name || Group Name
|-
| Description || Group description
|-
| Default || Attribute of group. Usually the manager configures the group using the ''[[Glossary | MDMM]]'' function.
|-
| Status || This field can be Active / Cancelled. Only "Active" group are seen in Workflow Management. changeableness
|-
| Menu Access || If flagged this Group will be accessible as menu link
|-
| Group can't be deleted || If flagged this Group can't be accidentally cancelled
|}

General tab enabled to define a group of groups. itmSUITE® enable this selecting the Add Group button.

For each ''Group'' is possible to define the ''Members''. Manager can specify directly the list of resource that will be part of it. itmSUITE® presents an EJS grid with the possibility to Add , Filter and Delete the member ''resource'' of a group. Deletion in this case perform a physical relationship cancellation between ''resource'' and ''group''.

For each ''group'' is possible to manage Privileges. There are two categories of privileges:
# General Privileges
# ASM Privileges

General Privileges can be set for the following entity:
# Resources, with the same detail present in ''Resource / Privileges''
# Price lists, with the same detail present in ''Resource / Privileges''
# Timesheet

Timesheet privileges can be granted on the following entity
{| class="wikitable"
! Entity!! Description
|-
| Group View || Resource Member of group can view all the timesheet that refer to itself
|-
| Group Approval || Resource Member of group can Approved the timesheet that refer to itself
|}

[[Glossary| ASM]] Privileges, show the [[Glossary | Configuration Item]] Structure present into the itmSUITE® CMS Module. For each folder/sub folder the ''Administrator'' can assign the following privileges:

{| class="wikitable"
! Privilege !! Description
|-
| Read || Resource Member of group can view the ''configuration item'' present into the folder and read the information.
|-
| Update || Resource Member of group can view the ''configuration item'' present into the folder and update the information.
|-
| Read Own || Resource Member of group can view the ''configuration item'' present into the folder and read the information only of he/she is the ''Creator'' of the ''configuration item''.
|-
| Update Own || Resource Member of group can view the ''configuration item'' present into the folder and update the information only of he/she is the ''Creator'' of the ''configuration item''.

|}
It is possible also grant the group to:
{| class="wikitable"
! Privilege !! Description
|-
| Exploration model grant || Resource Member of group can run the Exploration Model function
|-
| Meta Data grant || Resource Member of group can manage the Metadata function
|}

=== Add Resource to Group ===
Refer to ''Member'' Tab management above.

=== Add Group as Profile in a Workflow ===
The Workflow management has been enriched with the possibility to profile ''Group'' as [[Glossary |Role]] in a Workflow.
With this feature Resource present on a Group can be granted to:
* Access a ticket
* Manage a ticket
For further detail see [[Workflow Engine Configuration |Workflow Management]] in a Workflow.

=== Add Group to Workflow ===
Group is a a key component in ''Workflow Management''.
Mainly the Group can act as Profile,say static [[Glossary |role]], or assume dynamic [[Glossary |role]], so per ''ticket''.

For further detail see [[Workflow Engine Configuration |Workflow Management]] in a Workflow.

=== Enable a Group on Service Catalogue Request (SRCS) ===
[[Glossary |SRCS]] is the service catalogue request. itmSUITE® can grant the visibility of a single request to:
#Requester(s)
#Group(s)
#Organization Unit(s)

For further detail see [[Creating Service Catalog Management (SRCS)|SRCS Management]] in a Workflow.

=== Profile a Timesheet declaration ===
This feature enable the resource to specify the Group he/she was working during the ''Timesheet'' registration. This feature is a simple way to categorized ''Timesheet'' based on the Business Role assumed by the Resource.

For further detail see ''[[ Timesheet Management |Timesheet Management]]''

== How to ==
Set on Resource:

{| class="wikitable"
! Resource Configuration!! Link!! Description
|-
| VIP Type || General/ Resources/VIP Type || This function defines the data source to set the VIP type in Resource master data
|-
| Purchase Roles || General/ Resources/Purchase Roles || This function defines the data source used to set the default value for purchase role in the Resource master data.
|-
| Sale Roles || General/ Resources/Sale Roles || This function defines the data source used to set the default value for sale role in the Resource master data.

|}

REP - Reporting

2018-06-18T15:18:14Z

Luca.pandolfo: /* Add report on itmSUITE® menu */

REP is an optional itmSUITE® module that defines functionality to manage and excute reports created by Eclipse BIRT Designer tool. 
It allows to load one or more report templates (BIRT.rptdesign file) and to create and to execute report instances through the BIRT Viewer integrated on itmSUITE®.

=== BIRT Architecture ===
[http://www.eclipse.org/birt/ BIRT] (Business Intelligence Reporting Tool) is an open source tool installed as Eclipse IDE plug-in for report developing. It has origin from collaboration between Actuate (along with IBM) and Eclipse.org open source community. 
BIRT is a Java based tool that allows to extract data from many data source types for report generation in several output format (pdf, xlsx, docx, etc.).

[[File:Birt_Architecture.png|centre|thumb|500x500px|Birt Architecture]]

BIRT architecture includes two main components:
# Report Designer: a UI component to create report template (.rptdesign file)
# Report Engine: runtime component for report rendering

The Design Engine generates a .rptdesign file (in XML format) structured according to configurations applied by user (by BIRT Designer) and the Report Engine, through BIRT Viewer, parse and renders it as report in HTML,or other, format.

=== BIRT Report on itmSUITE® ===
In itmSUITE®, the steps required to upload and execute BIRT report previously created through the BIRT Designer are following:
#Data source configuration
#Load report template (.rptdesign file)
#Create a report instance
#Add report on menu and execute it

==== Data Source Configuration ====
In itmSUITE®, BIRT report data can be extracted only from data sources connected to database.
Data Source settings are accessible on the '''''General > Company > Report Engine > Data Source''''' menu.

[[File:dataSource.png|centre|frame|Data Source list - more data source items can be created]]

Data source creation steps:
# Click on '''Add New''' button
# Fill following fields (* mandatory):
{| class="wikitable"
! Field Name !! Description !! Example Value
|-
| Name* || Logic data source item name || "Sample DB"
|-
| Description || Data source item description || "Sample data source"
|-
| Company* || Company to which data source item is assigned || "Sample Company"
|-
| Status* || Configurable Active/Inactive statuses || "Active"
|-
| Type* || Driver type used to connect to data source || "JDBC"
|-
| Data Driver* || Driver used to connect to data source || "MSSQL"
|-
| DB Server* || URL (or IP) of data source server || "192.168.10.5"
|-
| Port* || Connection data source port || "1433"
|-
| DB Name* || Database name to which data source item refers || "PMSM_SAMPLE_DB"
|-
| Username* || Username used to connect to database || -
|-
| Password* || Password used to connect to database || -
|-
|}
<ol>
<li value=3>Click on '''Check And Save''' button to check database connection and to save data source settings</li>
</ol>

==== Load report template ====
Report template (.rptdesign) file defines the report structure in a well-formed XML document.
In itmSUITE®, a report template can be associated to more report instances. Report template configuration is accessible on the '''''General > Company > Report Engine > Report template''''' menu.

[[File:reportTemplateList.png|centre|frame]]

The report template creation requires following steps:
# Click on '''Add New''' button
# Fill following fields on ''General'' tab:
{| class="wikitable"
! Field Name !! Description !! Example Value
|-
| Name* || Logic report template name || "Sample Report Template"
|-
| Description || Report template description || "A report tamplate as sample"
|-
| Status* || Configurable Active/Inactive statuses || "Active"
|-
| BIRT Report Template* || Load .rptdesign file || "Sample_Report_Template"
|-
|}
<ol>
<li value=3>Fill the following fields on ''Data source'' tab:</li>
</ol>
{| class="wikitable"
! Field Name !! Description !! Example Value
|-
| Data source* || Data source imported from .rptdesign file || "PMSM_DB_TEST"
|-
| Mapped on || itmSUITE® data source item to which report template can refers for data extraction. If it is empty, data source defined in .rptdesign file is used || "PMSM DB Test"
|-
| Type* || Connection type to data source (always JDBC) || "JDBC"
|-
|}

<ol>
<li value=4>Click on '''Save''' button to save report template settings</li>
</ol>

==== Create Report Instance ====
Report instance defines a BIRT report that can refer to only a report template and can be launched directly from itmSUITE® menu.
A report instance is configurable on the '''''General > Company > Report Engine > Report Management''''' menu

[[File:reportManagementList.png|centre|frame]]

The report instance creation requires following steps:
# Click on '''Add New''' button
# Fill following fields on ''General'' tab:
{| class="wikitable"
! Field Name !! Description !! Example Value
|-
| Name* || Report name || "Sample Report"
|-
| Description || Report description || "A sample report"
|-
| Status* || Configurable Active/Inactive statuses. If Inactive report cannot be shown on itmSUITE® menu || "Active"
|-
| Template* || Report template name to which report instance refers || "Sample_Report_Template"
|-
|}
<ol>
<li ''value=3>Check that all report parameters are visible on ''Parameters'' tab:</li>
</ol>

[[File:reportParameter.png|centre|frame]]

<ol>
<li value=4>On ''Filter Designer'' tab, it is possible to customize a report launcher box (at default it contains the same parameters defined on report template):</li>
*Hide/show report parameters
*Add/delete parameters sections
*Edit each report parameter item (read-only,label editing, mandatory, etc.)
*Add (as drag&drop ) Output field to extract report in several format (html, word, excel, pdf, ppt)
*Add (as drag&drop) Open Report in New Window check box to visualize report ouput on a new tab

[[File:reportDesigner.png|centre|frame]]

It is possible to see a report launcher preview by clicking on '''Preview''' button
<li>On ''Assignments'' tab, set report visibility grants on itmSUITE® menu

[[File:reportAssignment.png|centre|frame]]

by following filter fields:

{| class="wikitable"
! Filter Name !! Description
|-
| Role || it limits visibility to users that belong to following roles: ''superadmin'', ''administrator'', ''manager'', ''pm'', ''resource'', ''requester''. It works also as prefilter for Resource filter
|-
| Resource || it limits visibility to selected ''resources''
|-
| Group || it limits visibility to members of selected ''groups''
|-
| Organization unit || it limits visibility to ''resources'' that belong to selected ''organization units''
|-
|}
</li>
<li>
On Filter tab, it is possible to manage personal filters selectable by user directly from report

[[File:reportFilter.png|centre|frame]]
</li>
</ol>

==== Add report on itmSUITE® menu ====
After report instance has been created on '''''Report Management''''', it needs to add a report entry in itmSUITE® menu.

[[File:reportMenu.png|centre|frame]]

Report menu entry is configurable on the '''''General > Company > Main Navigation Menu''''', under the ''Not Used/Reporting'' section. 
'''Important:''' ''administrator'' re-login is required in order user can drag and drop new report entry from ''Not Used/Reporting'' section to any ''Main Navigation Menu'' section. 
Finally report can be run in new itmSUITE® menu entry by users that have visibility grants.

REP - Reporting

2018-06-18T15:01:24Z

Luca.pandolfo: /* Create Report Instance */

REP is an optional itmSUITE® module that defines functionality to manage and excute reports created by Eclipse BIRT Designer tool. 
It allows to load one or more report templates (BIRT.rptdesign file) and to create and to execute report instances through the BIRT Viewer integrated on itmSUITE®.

=== BIRT Architecture ===
[http://www.eclipse.org/birt/ BIRT] (Business Intelligence Reporting Tool) is an open source tool installed as Eclipse IDE plug-in for report developing. It has origin from collaboration between Actuate (along with IBM) and Eclipse.org open source community. 
BIRT is a Java based tool that allows to extract data from many data source types for report generation in several output format (pdf, xlsx, docx, etc.).

[[File:Birt_Architecture.png|centre|thumb|500x500px|Birt Architecture]]

BIRT architecture includes two main components:
# Report Designer: a UI component to create report template (.rptdesign file)
# Report Engine: runtime component for report rendering

The Design Engine generates a .rptdesign file (in XML format) structured according to configurations applied by user (by BIRT Designer) and the Report Engine, through BIRT Viewer, parse and renders it as report in HTML,or other, format.

=== BIRT Report on itmSUITE® ===
In itmSUITE®, the steps required to upload and execute BIRT report previously created through the BIRT Designer are following:
#Data source configuration
#Load report template (.rptdesign file)
#Create a report instance
#Add report on menu and execute it

==== Data Source Configuration ====
In itmSUITE®, BIRT report data can be extracted only from data sources connected to database.
Data Source settings are accessible on the '''''General > Company > Report Engine > Data Source''''' menu.

[[File:dataSource.png|centre|frame|Data Source list - more data source items can be created]]

Data source creation steps:
# Click on '''Add New''' button
# Fill following fields (* mandatory):
{| class="wikitable"
! Field Name !! Description !! Example Value
|-
| Name* || Logic data source item name || "Sample DB"
|-
| Description || Data source item description || "Sample data source"
|-
| Company* || Company to which data source item is assigned || "Sample Company"
|-
| Status* || Configurable Active/Inactive statuses || "Active"
|-
| Type* || Driver type used to connect to data source || "JDBC"
|-
| Data Driver* || Driver used to connect to data source || "MSSQL"
|-
| DB Server* || URL (or IP) of data source server || "192.168.10.5"
|-
| Port* || Connection data source port || "1433"
|-
| DB Name* || Database name to which data source item refers || "PMSM_SAMPLE_DB"
|-
| Username* || Username used to connect to database || -
|-
| Password* || Password used to connect to database || -
|-
|}
<ol>
<li value=3>Click on '''Check And Save''' button to check database connection and to save data source settings</li>
</ol>

==== Load report template ====
Report template (.rptdesign) file defines the report structure in a well-formed XML document.
In itmSUITE®, a report template can be associated to more report instances. Report template configuration is accessible on the '''''General > Company > Report Engine > Report template''''' menu.

[[File:reportTemplateList.png|centre|frame]]

The report template creation requires following steps:
# Click on '''Add New''' button
# Fill following fields on ''General'' tab:
{| class="wikitable"
! Field Name !! Description !! Example Value
|-
| Name* || Logic report template name || "Sample Report Template"
|-
| Description || Report template description || "A report tamplate as sample"
|-
| Status* || Configurable Active/Inactive statuses || "Active"
|-
| BIRT Report Template* || Load .rptdesign file || "Sample_Report_Template"
|-
|}
<ol>
<li value=3>Fill the following fields on ''Data source'' tab:</li>
</ol>
{| class="wikitable"
! Field Name !! Description !! Example Value
|-
| Data source* || Data source imported from .rptdesign file || "PMSM_DB_TEST"
|-
| Mapped on || itmSUITE® data source item to which report template can refers for data extraction. If it is empty, data source defined in .rptdesign file is used || "PMSM DB Test"
|-
| Type* || Connection type to data source (always JDBC) || "JDBC"
|-
|}

<ol>
<li value=4>Click on '''Save''' button to save report template settings</li>
</ol>

==== Create Report Instance ====
Report instance defines a BIRT report that can refer to only a report template and can be launched directly from itmSUITE® menu.
A report instance is configurable on the '''''General > Company > Report Engine > Report Management''''' menu

[[File:reportManagementList.png|centre|frame]]

The report instance creation requires following steps:
# Click on '''Add New''' button
# Fill following fields on ''General'' tab:
{| class="wikitable"
! Field Name !! Description !! Example Value
|-
| Name* || Report name || "Sample Report"
|-
| Description || Report description || "A sample report"
|-
| Status* || Configurable Active/Inactive statuses. If Inactive report cannot be shown on itmSUITE® menu || "Active"
|-
| Template* || Report template name to which report instance refers || "Sample_Report_Template"
|-
|}
<ol>
<li ''value=3>Check that all report parameters are visible on ''Parameters'' tab:</li>
</ol>

[[File:reportParameter.png|centre|frame]]

<ol>
<li value=4>On ''Filter Designer'' tab, it is possible to customize a report launcher box (at default it contains the same parameters defined on report template):</li>
*Hide/show report parameters
*Add/delete parameters sections
*Edit each report parameter item (read-only,label editing, mandatory, etc.)
*Add (as drag&drop ) Output field to extract report in several format (html, word, excel, pdf, ppt)
*Add (as drag&drop) Open Report in New Window check box to visualize report ouput on a new tab

[[File:reportDesigner.png|centre|frame]]

It is possible to see a report launcher preview by clicking on '''Preview''' button
<li>On ''Assignments'' tab, set report visibility grants on itmSUITE® menu

[[File:reportAssignment.png|centre|frame]]

by following filter fields:

{| class="wikitable"
! Filter Name !! Description
|-
| Role || it limits visibility to users that belong to following roles: ''superadmin'', ''administrator'', ''manager'', ''pm'', ''resource'', ''requester''. It works also as prefilter for Resource filter
|-
| Resource || it limits visibility to selected ''resources''
|-
| Group || it limits visibility to members of selected ''groups''
|-
| Organization unit || it limits visibility to ''resources'' that belong to selected ''organization units''
|-
|}
</li>
<li>
On Filter tab, it is possible to manage personal filters selectable by user directly from report

[[File:reportFilter.png|centre|frame]]
</li>
</ol>

==== Add report on itmSUITE® menu ====
After report instance has been created on '''''Report Management''''', it needs to add a report entry in itmSUITE® menu.

[[File:reportMenu.png|centre|frame]]

Report menu entry is configurable on the '''''General > Company > Main Navigation Menu''''' in ''Not Used/Reporting'' section. 
'''Important:''' it needs to repeat ''administrator'' login in order that report entry can be dragged and dropped from ''Not Used/Reporting'' section to ''Main Navigation Menu section''

Finally report can be run by assigned users from itmSUITE® menu entry configured by ''administrator''.

REP - Reporting

2018-06-18T14:57:14Z

Luca.pandolfo:

REP is an optional itmSUITE® module that defines functionality to manage and excute reports created by Eclipse BIRT Designer tool. 
It allows to load one or more report templates (BIRT.rptdesign file) and to create and to execute report instances through the BIRT Viewer integrated on itmSUITE®.

=== BIRT Architecture ===
[http://www.eclipse.org/birt/ BIRT] (Business Intelligence Reporting Tool) is an open source tool installed as Eclipse IDE plug-in for report developing. It has origin from collaboration between Actuate (along with IBM) and Eclipse.org open source community. 
BIRT is a Java based tool that allows to extract data from many data source types for report generation in several output format (pdf, xlsx, docx, etc.).

[[File:Birt_Architecture.png|centre|thumb|500x500px|Birt Architecture]]

BIRT architecture includes two main components:
# Report Designer: a UI component to create report template (.rptdesign file)
# Report Engine: runtime component for report rendering

The Design Engine generates a .rptdesign file (in XML format) structured according to configurations applied by user (by BIRT Designer) and the Report Engine, through BIRT Viewer, parse and renders it as report in HTML,or other, format.

=== BIRT Report on itmSUITE® ===
In itmSUITE®, the steps required to upload and execute BIRT report previously created through the BIRT Designer are following:
#Data source configuration
#Load report template (.rptdesign file)
#Create a report instance
#Add report on menu and execute it

==== Data Source Configuration ====
In itmSUITE®, BIRT report data can be extracted only from data sources connected to database.
Data Source settings are accessible on the '''''General > Company > Report Engine > Data Source''''' menu.

[[File:dataSource.png|centre|frame|Data Source list - more data source items can be created]]

Data source creation steps:
# Click on '''Add New''' button
# Fill following fields (* mandatory):
{| class="wikitable"
! Field Name !! Description !! Example Value
|-
| Name* || Logic data source item name || "Sample DB"
|-
| Description || Data source item description || "Sample data source"
|-
| Company* || Company to which data source item is assigned || "Sample Company"
|-
| Status* || Configurable Active/Inactive statuses || "Active"
|-
| Type* || Driver type used to connect to data source || "JDBC"
|-
| Data Driver* || Driver used to connect to data source || "MSSQL"
|-
| DB Server* || URL (or IP) of data source server || "192.168.10.5"
|-
| Port* || Connection data source port || "1433"
|-
| DB Name* || Database name to which data source item refers || "PMSM_SAMPLE_DB"
|-
| Username* || Username used to connect to database || -
|-
| Password* || Password used to connect to database || -
|-
|}
<ol>
<li value=3>Click on '''Check And Save''' button to check database connection and to save data source settings</li>
</ol>

==== Load report template ====
Report template (.rptdesign) file defines the report structure in a well-formed XML document.
In itmSUITE®, a report template can be associated to more report instances. Report template configuration is accessible on the '''''General > Company > Report Engine > Report template''''' menu.

[[File:reportTemplateList.png|centre|frame]]

The report template creation requires following steps:
# Click on '''Add New''' button
# Fill following fields on ''General'' tab:
{| class="wikitable"
! Field Name !! Description !! Example Value
|-
| Name* || Logic report template name || "Sample Report Template"
|-
| Description || Report template description || "A report tamplate as sample"
|-
| Status* || Configurable Active/Inactive statuses || "Active"
|-
| BIRT Report Template* || Load .rptdesign file || "Sample_Report_Template"
|-
|}
<ol>
<li value=3>Fill the following fields on ''Data source'' tab:</li>
</ol>
{| class="wikitable"
! Field Name !! Description !! Example Value
|-
| Data source* || Data source imported from .rptdesign file || "PMSM_DB_TEST"
|-
| Mapped on || itmSUITE® data source item to which report template can refers for data extraction. If it is empty, data source defined in .rptdesign file is used || "PMSM DB Test"
|-
| Type* || Connection type to data source (always JDBC) || "JDBC"
|-
|}

<ol>
<li value=4>Click on '''Save''' button to save report template settings</li>
</ol>

==== Create Report Instance ====
Report instance defines a BIRT report that can refer to only a report template and can be launched directly from itmSUITE® menu.
A report instance is configurable on the '''''General > Company > Report Engine > Report Management''''' menu

[[File:reportManagementList.png|centre|frame]]

The report instance creation requires following steps:
# Click on '''Add New''' button
# Fill following fields on ''General'' tab:
{| class="wikitable"
! Field Name !! Description !! Example Value
|-
| Name* || Report name || "Sample Report"
|-
| Description || Report description || "A sample report"
|-
| Status* || Configurable Active/Inactive statuses. If Inactive report cannot be shown on itmSUITE® menu || "Active"
|-
| Template* || Report template name to which report instance refers || "Sample_Report_Template"
|-
|}
<ol>
<li ''value=3>Check that all report parameters are visible on ''Parameters'' tab:</li>
</ol>

[[File:reportParameter.png|centre|frame]]

<ol>
<li value=4>On ''Filter Designer'' tab, it is possible to customize a report launcher box (at default it contains the same parameters defined on report template):</li>
*Hide/show report parameters
*Add/delete parameters sections
*Edit each report parameter item (read-only,label editing, mandatory, etc.)
*Add (as drag&drop ) Output field to extract report in several format (html, word, excel, pdf, ppt)
*Add (as drag&drop) Open Report in New Window check box to visualize report ouput on a new tab

[[File:reportDesigner.png|centre|frame]]

It is possible to see a report launcher preview by clicking on '''Preview''' button
<li>On ''Assignments'' tab, set report visibility grants on itmSUITE® menu

[[File:reportAssignment.png|centre|frame]]

by following filter fields:

{| class="wikitable"
! Filter Name !! Description
|-
| Role || it limits visibility to users that belong to following roles: ''superadmin'', ''administrator'', ''manager'', ''pm'', ''resource'', ''requester''. It works also as prefilter for Resource filter
|-
| Resource || it limits visibility to selected ''resources''
|-
| Group || it limits visibility to members of selected ''groups''
|-
| Organization unit || it limits visibility to resources that belong to selected ''organization units''
|-
|}
</li>
<li>
On Filter tab, it is possible to manage personal filters selectable by user directly from report

[[File:reportFilter.png|centre|frame]]
</li>
</ol>

==== Add report on itmSUITE® menu ====
After report instance has been created on '''''Report Management''''', it needs to add a report entry in itmSUITE® menu.

[[File:reportMenu.png|centre|frame]]

Report menu entry is configurable on the '''''General > Company > Main Navigation Menu''''' in ''Not Used/Reporting'' section. 
'''Important:''' it needs to repeat ''administrator'' login in order that report entry can be dragged and dropped from ''Not Used/Reporting'' section to ''Main Navigation Menu section''

Finally report can be run by assigned users from itmSUITE® menu entry configured by ''administrator''.

REP - Reporting

2018-06-18T14:54:31Z

Luca.pandolfo:

REP is an optional itmSUITE® module that defines functionality to manage and excute reports created by Eclipse BIRT Designer tool. 
It allows to load one or more report templates (BIRT.rptdesign file) and to create and to execute report instances through the BIRT Viewer integrated on itmSUITE®.

=== BIRT Architecture ===
[http://www.eclipse.org/birt/ BIRT] (Business Intelligence Reporting Tool) is an open source tool installed as Eclipse IDE plug-in for report developing. It has origin from collaboration between Actuate (along with IBM) and Eclipse.org open source community. 
BIRT is a Java based tool that allows to extract data from many data source types for report generation in several output format (pdf, xlsx, docx, etc.).

[[File:Birt_Architecture.png|centre|thumb|500x500px|Birt Architecture]]

BIRT architecture includes two main components:
# Report Designer: a UI component to create report template (.rptdesign file)
# Report Engine: runtime component for report rendering

The Design Engine generates a .rptdesign file (in XML format) structured according to configurations applied by user (by BIRT Designer) and the Report Engine, through BIRT Viewer, parse and renders it as report in HTML,or other, format.

=== BIRT Report on itmSUITE® ===
In itmSUITE®, the steps required to upload and execute BIRT report previously created through the BIRT Designer are following:
#Data source configuration
#Load report template (.rptdesign file)
#Create a report instance
#Add report on menu and execute it

==== Data Source Configuration ====
In itmSUITE®, BIRT report data can be extracted only from data sources connected to database.
Data Source settings are accessible on the '''''General > Company > Report Engine > Data Source''''' menu.

[[File:dataSource.png|centre|frame|Data Source list - more data source items can be created]]

Data source creation steps:
# Click on '''Add New''' button
# Fill following fields (* mandatory):
{| class="wikitable"
! Field Name !! Description !! Example Value
|-
| Name* || Logic data source item name || "Sample DB"
|-
| Description || Data source item description || "Sample data source"
|-
| Company* || Company to which data source item is assigned || "Sample Company"
|-
| Status* || Configurable Active/Inactive statuses || "Active"
|-
| Type* || Driver type used to connect to data source || "JDBC"
|-
| Data Driver* || Driver used to connect to data source || "MSSQL"
|-
| DB Server* || URL (or IP) of data source server || "192.168.10.5"
|-
| Port* || Connection data source port || "1433"
|-
| DB Name* || Database name to which data source item refers || "PMSM_SAMPLE_DB"
|-
| Username* || Username used to connect to database || -
|-
| Password* || Password used to connect to database || -
|-
|}
<ol>
<li value=3>Click on '''Check And Save''' button to check database connection and to save data source settings</li>
</ol>

==== Load report template ====
Report template (.rptdesign) file defines the report structure in a well-formed XML document.
In itmSUITE®, a report template can be associated to more report instances. Report template configuration is accessible on the '''''General > Company > Report Engine > Report template''''' menu.

[[File:reportTemplateList.png|centre|frame]]

The report template creation requires following steps:
# Click on '''Add New''' button
# Fill following fields on ''General'' tab:
{| class="wikitable"
! Field Name !! Description !! Example Value
|-
| Name* || Logic report template name || "Sample Report Template"
|-
| Description || Report template description || "A report tamplate as sample"
|-
| Status* || Configurable Active/Inactive statuses || "Active"
|-
| BIRT Report Template* || Load .rptdesign file || "Sample_Report_Template"
|-
|}
<ol>
<li value=3>Fill the following fields on ''Data source'' tab:</li>
</ol>
{| class="wikitable"
! Field Name !! Description !! Example Value
|-
| Data source* || Data source imported from .rptdesign file || "PMSM_DB_TEST"
|-
| Mapped on || itmSUITE® data source item to which report template can refers for data extraction. If it is empty, data source defined in .rptdesign file is used || "PMSM DB Test"
|-
| Type* || Connection type to data source (always JDBC) || "JDBC"
|-
|}

<ol>
<li value=4>Click on '''Save''' button to save report template settings</li>
</ol>

==== Create Report Instance ====
Report instance defines a BIRT report that can refer to only a report template and can be launched directly from itmSUITE® menu.
A report instance is configurable on the '''''General > Company > Report Engine > Report Management''''' menu

[[File:reportManagementList.png|centre|frame]]

The report instance creation requires following steps:
# Click on '''Add New''' button
# Fill following fields on ''General'' tab:
{| class="wikitable"
! Field Name !! Description !! Example Value
|-
| Name* || Report name || "Sample Report"
|-
| Description || Report description || "A sample report"
|-
| Status* || Configurable Active/Inactive statuses. If Inactive report cannot be shown on itmSUITE® menu || "Active"
|-
| Template* || Report template name to which report instance refers || "Sample_Report_Template"
|-
|}
<ol>
<li ''value=3>Check that all report parameters are visible on ''Parameters'' tab:</li>
</ol>

[[File:reportParameter.png|centre|frame]]

<ol>
<li value=4>On ''Filter Designer'' tab, it is possible to customize a report launcher box (at default it contains the same parameters defined on report template):</li>
*Hide/show report parameters
*Add/delete parameters sections
*Edit each report parameter item (read-only,label editing, mandatory, etc.)
*Add (as drag&drop ) Output field to extract report in several format (html, word, excel, pdf, ppt)
*Add (as drag&drop) Open Report in New Window check box to visualize report ouput on a new tab

[[File:reportDesigner.png|centre|frame]]

It is possible to see a report launcher preview by clicking on '''Preview''' button
<li>On ''Assignments'' tab, set report visibility grants on itmSUITE® menu

[[File:reportAssignment.png|centre|frame]]

by following filter fields:

{| class="wikitable"
! Filter Name !! Description
|-
| Role || it limits visibility to users that belong to following roles: ''superadmin'', ''administrator'', ''manager'', ''pm'', ''resource'', ''requester''. It works also as prefilter for Resource filter
|-
| Resource || it limits visibility to selected ''resources''
|-
| Group || it limits visibility to members of selected ''groups''
|-
| Organization unit || it limits visibility to resources that belong to selected ''organization units''
|-
|}
</li>
<li>
On Filter tab, it is possible to manage personal filters selectable by user directly from report

[[File:reportFilter.png|centre|frame]]
</li>
</ol>

==== Load report template ====
Report template (.rptdesign) file defines the report structure in a well-formed XML document.
In itmSUITE®, a report template can be associated to more report instances. Report template configuration is accessible on the '''''General > Company > Report Engine > Report template'''''

[[File:reportTemplateList.png|centre|frame]]

The report template creation requires following steps:
# Click on '''Add New''' button
# Fill following fields on ''General'' tab:
{| class="wikitable"
! Field Name !! Description !! Example Value
|-
| Name* || Logic report template name || "Sample Report Template"
|-
| Description || Report template description || "A report tamplate as sample"
|-
| Status* || Configurable Active/Inactive statuses || "Active"
|-
| BIRT Report Template* || Load .rptdesign file || "Sample_Report_Template"
|-
|}
<ol>
<li value=3>Fill the following fields on ''Data source'' tab:</li>
</ol>
{| class="wikitable"
! Field Name !! Description !! Example Value
|-
| Data source* || Data source imported from .rptdesign file || "PMSM_DB_TEST"
|-
| Mapped on || itmSUITE® data source item to which report template can refers for data extraction. If it is empty, data source defined in .rptdesign file is used || "PMSM DB Test"
|-
| Type* || Connection type to data source (always JDBC) || "JDBC"
|-
|}

<ol>
<li value=4>Click on '''Save''' button to save report template settings</li>
</ol>

==== Add report on itmSUITE® menu ====
After report instance has been created on '''''Report Management''''', it needs to add a report entry in itmSUITE® menu.

[[File:reportMenu.png|centre|frame]]

Report menu entry is configurable on the '''''General > Company > Main Navigation Menu''''' in ''Not Used/Reporting'' section. 
'''Important:''' it needs to repeat ''administrator'' login in order that report entry can be dragged and dropped from ''Not Used/Reporting'' section to ''Main Navigation Menu section''

Finally report can be run by assigned users from itmSUITE® menu entry configured by ''administrator''.

REP - Reporting

2018-06-18T14:51:35Z

Luca.pandolfo: /* Create Report Instance */

REP is an optional itmSUITE® module that defines functionality to manage and excute reports created by Eclipse BIRT Designer tool. 
It allows to load one or more report templates (BIRT.rptdesign file) and to create and to execute report instances through the BIRT Viewer integrated on itmSUITE®.

=== BIRT Architecture ===
[http://www.eclipse.org/birt/ BIRT] (Business Intelligence Reporting Tool) is an open source tool installed as Eclipse IDE plug-in for report developing. It has origin from collaboration between Actuate (along with IBM) and Eclipse.org open source community. 
BIRT is a Java based tool that allows to extract data from many data source types for report generation in several output format (pdf, xlsx, docx, etc.).

[[File:Birt_Architecture.png|centre|thumb|500x500px|Birt Architecture]]

BIRT architecture includes two main components:
# Report Designer: a UI component to create report template (.rptdesign file)
# Report Engine: runtime component for report rendering

The Design Engine generates a .rptdesign file (in XML format) structured according to configurations applied by user (by BIRT Designer) and the Report Engine, through BIRT Viewer, parse and renders it as report in HTML,or other, format.

=== BIRT Report on itmSUITE® ===
In itmSUITE®, the steps required to upload and execute BIRT report previously created through the BIRT Designer are following:
#Data source configuration
#Load report template (.rptdesign file)
#Create a report instance
#Add report on menu and execute it

==== Data Source Configuration ====
In itmSUITE®, BIRT report data can be extracted only from data sources connected to database.
Data Source settings are accessible on the '''''General > Company > Report Engine > Data Source''''' menu.

[[File:dataSource.png|centre|frame|Data Source list - more data source items can be created]]

Data source creation steps:
# Click on '''Add New''' button
# Fill following fields (* mandatory):
{| class="wikitable"
! Field Name !! Description !! Example Value
|-
| Name* || Logic data source item name || "Sample DB"
|-
| Description || Data source item description || "Sample data source"
|-
| Company* || Company to which data source item is assigned || "Sample Company"
|-
| Status* || Configurable Active/Inactive statuses || "Active"
|-
| Type* || Driver type used to connect to data source || "JDBC"
|-
| Data Driver* || Driver used to connect to data source || "MSSQL"
|-
| DB Server* || URL (or IP) of data source server || "192.168.10.5"
|-
| Port* || Connection data source port || "1433"
|-
| DB Name* || Database name to which data source item refers || "PMSM_SAMPLE_DB"
|-
| Username* || Username used to connect to database || -
|-
| Password* || Password used to connect to database || -
|-
|}
<ol>
<li value=3>Click on '''Check And Save''' button to check database connection and to save data source settings</li>
</ol>

==== Load report template ====
Report template (.rptdesign) file defines the report structure in a well-formed XML document.
In itmSUITE®, a report template can be associated to more report instances. Report template configuration is accessible on the '''''General > Company > Report Engine > Report template''''' menu.

[[File:reportTemplateList.png|centre|frame]]

The report template creation requires following steps:
# Click on '''Add New''' button
# Fill following fields on ''General'' tab:
{| class="wikitable"
! Field Name !! Description !! Example Value
|-
| Name* || Logic report template name || "Sample Report Template"
|-
| Description || Report template description || "A report tamplate as sample"
|-
| Status* || Configurable Active/Inactive statuses || "Active"
|-
| BIRT Report Template* || Load .rptdesign file || "Sample_Report_Template"
|-
|}
<ol>
<li value=3>Fill the following fields on ''Data source'' tab:</li>
</ol>
{| class="wikitable"
! Field Name !! Description !! Example Value
|-
| Data source* || Data source imported from .rptdesign file || "PMSM_DB_TEST"
|-
| Mapped on || itmSUITE® data source item to which report template can refers for data extraction. If it is empty, data source defined in .rptdesign file is used || "PMSM DB Test"
|-
| Type* || Connection type to data source (always JDBC) || "JDBC"
|-
|}

<ol>
<li value=4>Click on '''Save''' button to save report template settings</li>
</ol>

==== Create Report Instance ====
Report instance defines a BIRT report that can refer to only a report template and can be launched directly from itmSUITE® menu.
A report instance is configurable on the '''''General > Company > Report Engine > Report Management''''' menu

[[File:reportManagementList.png|centre|frame]]

The report instance creation requires following steps:
# Click on '''Add New''' button
# Fill following fields on ''General'' tab:
{| class="wikitable"
! Field Name !! Description !! Example Value
|-
| Name* || Report name || "Sample Report"
|-
| Description || Report description || "A sample report"
|-
| Status* || Configurable Active/Inactive statuses. If Inactive report cannot be shown on itmSUITE® menu || "Active"
|-
| Template* || Report template name to which report instance refers || "Sample_Report_Template"
|-
|}
<ol>
<li ''value=3>Check that all report parameters are visible on ''Parameters'' tab:</li>
</ol>

[[File:reportParameter.png|centre|frame]]

<ol>
<li value=4>On ''Filter Designer'' tab, it is possible to customize a report launcher box (at default it contains the same parameters defined on report template):</li>
*Hide/show report parameters
*Add/delete parameters sections
*Edit each report parameter item (read-only,label editing, mandatory, etc.)
*Add (as drag&drop ) Output field to extract report in several format (html, word, excel, pdf, ppt)
*Add (as drag&drop) Open Report in New Window check box to visualize report ouput on a new tab

[[File:reportDesigner.png|centre|frame]]

It is possible to see a report launcher preview by clicking on '''Preview''' button
<li>On ''Assignments'' tab, set report visibility grants on itmSUITE® menu

[[File:reportAssignment.png|centre|frame]]

by following filter fields:

{| class="wikitable"
! Filter Name !! Description
|-
| Role || it limits visibility to users that belong to following roles: ''superadmin'', ''administrator'', ''manager'', ''pm'', ''resource'', ''requester''. It works also as prefilter for Resource filter
|-
| Resource || it limits visibility to selected ''resources''
|-
| Group || it limits visibility to members of selected ''groups''
|-
| Organization unit || it limits visibility to resources that belong to selected ''organization units''
|-
|}
</li>
<li>
On Filter tab, it is possible to manage personal filters selectable by user directly from report

[[File:reportFilter.png|centre|frame]]
</li>
</ol>

==== Load report template ====
Report template (.rptdesign) file defines the report structure in a well-formed XML document.
In itmSUITE®, a report template can be associated to more report instances. Report template configuration is accessible on the '''''General > Company > Report Engine > Report template'''''

[[File:reportTemplateList.png|centre|frame]]

The report template creation requires following steps:
# Click on '''Add New''' button
# Fill following fields on ''General'' tab:
{| class="wikitable"
! Field Name !! Description !! Example Value
|-
| Name* || Logic report template name || "Sample Report Template"
|-
| Description || Report template description || "A report tamplate as sample"
|-
| Status* || Configurable Active/Inactive statuses || "Active"
|-
| BIRT Report Template* || Load .rptdesign file || "Sample_Report_Template"
|-
|}
<ol>
<li value=3>Fill the following fields on ''Data source'' tab:</li>
</ol>
{| class="wikitable"
! Field Name !! Description !! Example Value
|-
| Data source* || Data source imported from .rptdesign file || "PMSM_DB_TEST"
|-
| Mapped on || itmSUITE® data source item to which report template can refers for data extraction. If it is empty, data source defined in .rptdesign file is used || "PMSM DB Test"
|-
| Type* || Connection type to data source (always JDBC) || "JDBC"
|-
|}

<ol>
<li value=4>Click on '''Save''' button to save report template settings</li>
</ol>

==== Add report on itmSUITE® menu ====
After report instance has been created on '''''Report Management''''', it needs to add a report entry in itmSUITE® menu.

[[File:reportMenu.png|centre|frame]]

Report menu entry is configurable on the '''''General > Company > Main Navigation Menu''''' in ''Not Used/Reporting'' section. 
'''Important:''' it needs to repeat ''administrator'' login in order that report entry can be dragged and dropped from ''Not Used/Reporting'' section to ''Main Navigation Menu section''

Finally report can be run by assigned users from itmSUITE® menu entry configured by ''administrator''.

REP - Reporting

2018-06-18T14:48:00Z

Luca.pandolfo: /* Load report template */

REP is an optional itmSUITE® module that defines functionality to manage and excute reports created by Eclipse BIRT Designer tool. 
It allows to load one or more report templates (BIRT.rptdesign file) and to create and to execute report instances through the BIRT Viewer integrated on itmSUITE®.

=== BIRT Architecture ===
[http://www.eclipse.org/birt/ BIRT] (Business Intelligence Reporting Tool) is an open source tool installed as Eclipse IDE plug-in for report developing. It has origin from collaboration between Actuate (along with IBM) and Eclipse.org open source community. 
BIRT is a Java based tool that allows to extract data from many data source types for report generation in several output format (pdf, xlsx, docx, etc.).

[[File:Birt_Architecture.png|centre|thumb|500x500px|Birt Architecture]]

BIRT architecture includes two main components:
# Report Designer: a UI component to create report template (.rptdesign file)
# Report Engine: runtime component for report rendering

The Design Engine generates a .rptdesign file (in XML format) structured according to configurations applied by user (by BIRT Designer) and the Report Engine, through BIRT Viewer, parse and renders it as report in HTML,or other, format.

=== BIRT Report on itmSUITE® ===
In itmSUITE®, the steps required to upload and execute BIRT report previously created through the BIRT Designer are following:
#Data source configuration
#Load report template (.rptdesign file)
#Create a report instance
#Add report on menu and execute it

==== Data Source Configuration ====
In itmSUITE®, BIRT report data can be extracted only from data sources connected to database.
Data Source settings are accessible on the '''''General > Company > Report Engine > Data Source''''' menu.

[[File:dataSource.png|centre|frame|Data Source list - more data source items can be created]]

Data source creation steps:
# Click on '''Add New''' button
# Fill following fields (* mandatory):
{| class="wikitable"
! Field Name !! Description !! Example Value
|-
| Name* || Logic data source item name || "Sample DB"
|-
| Description || Data source item description || "Sample data source"
|-
| Company* || Company to which data source item is assigned || "Sample Company"
|-
| Status* || Configurable Active/Inactive statuses || "Active"
|-
| Type* || Driver type used to connect to data source || "JDBC"
|-
| Data Driver* || Driver used to connect to data source || "MSSQL"
|-
| DB Server* || URL (or IP) of data source server || "192.168.10.5"
|-
| Port* || Connection data source port || "1433"
|-
| DB Name* || Database name to which data source item refers || "PMSM_SAMPLE_DB"
|-
| Username* || Username used to connect to database || -
|-
| Password* || Password used to connect to database || -
|-
|}
<ol>
<li value=3>Click on '''Check And Save''' button to check database connection and to save data source settings</li>
</ol>

==== Load report template ====
Report template (.rptdesign) file defines the report structure in a well-formed XML document.
In itmSUITE®, a report template can be associated to more report instances. Report template configuration is accessible on the '''''General > Company > Report Engine > Report template''''' menu.

[[File:reportTemplateList.png|centre|frame]]

The report template creation requires following steps:
# Click on '''Add New''' button
# Fill following fields on ''General'' tab:
{| class="wikitable"
! Field Name !! Description !! Example Value
|-
| Name* || Logic report template name || "Sample Report Template"
|-
| Description || Report template description || "A report tamplate as sample"
|-
| Status* || Configurable Active/Inactive statuses || "Active"
|-
| BIRT Report Template* || Load .rptdesign file || "Sample_Report_Template"
|-
|}
<ol>
<li value=3>Fill the following fields on ''Data source'' tab:</li>
</ol>
{| class="wikitable"
! Field Name !! Description !! Example Value
|-
| Data source* || Data source imported from .rptdesign file || "PMSM_DB_TEST"
|-
| Mapped on || itmSUITE® data source item to which report template can refers for data extraction. If it is empty, data source defined in .rptdesign file is used || "PMSM DB Test"
|-
| Type* || Connection type to data source (always JDBC) || "JDBC"
|-
|}

<ol>
<li value=4>Click on '''Save''' button to save report template settings</li>
</ol>

==== Create Report Instance ====
Report instance defines a BIRT report that can refer to only a report template and can be launched directly from itmSUITE® menu.
A report instance is configurable on the '''''General > Company > Report Engine > Report Management''''' menu

[[File:reportManagementList.png|centre|frame]]

The report instance creation requires following steps:
# Click on '''Add New''' button
# Fill following fields on ''General'' tab:
{| class="wikitable"
! Field Name !! Description !! Example Value
|-
| Name* || Report name || "Sample Report"
|-
| Description || Report description || "A sample report"
|-
| Status* || Configurable Active/Inactive statuses. If Inactive report cannot be shown on itmSUITE® menu || "Active"
|-
| Template* || Report template name to which report instance refers || "Sample_Report_Template"
|-
|}
<ol>
<li ''value=3>Check that all report parameters are visible on ''Parameters'' tab:</li>
</ol>

[[File:reportParameter.png|centre|frame]]

<ol>
<li value=4>On ''Filter Designer'' tab, it is possible to customize a report launcher box (at default it contain''''Italic text''s the same parameters defined on report template):</li>
*Hide/show report parameters
*Add/delete parameters sections
*Edit each report parameter item (read-only,label editing, mandatory, etc.)
*Add Output field to extract report in several format (html, word, excel, pdf, ppt)
*Add Open Report in New Window check box to visualize report ouput on a new tab

[[File:reportDesigner.png|centre|frame]]

It is possible to see a report launcher preview by clicking on '''Preview''' button
<li>On ''Assignments'' tab, set report visibility grants on itmSUITE® menu

[[File:reportAssignment.png|centre|frame]]

by following filter fields:

{| class="wikitable"
! Filter Name !! Description
|-
| Role || it limits visibility to users that belong to following roles: ''superadmin'', ''administrator'', ''manager'', ''pm'', ''resource'', ''requester''. It works also as prefilter for Resource filter
|-
| Resource || it limits visibility to selected ''resources''
|-
| Group || it limits visibility to members of selected ''groups''
|-
| Organization unit || it limits visibility to resources that belong to selected ''organization units''
|-
|}
</li>
<li>
On Filter tab, it is possible to manage personal filters selectable by user directly from report

[[File:reportFilter.png|centre|frame]]
</li>
</ol>

==== Load report template ====
Report template (.rptdesign) file defines the report structure in a well-formed XML document.
In itmSUITE®, a report template can be associated to more report instances. Report template configuration is accessible on the '''''General > Company > Report Engine > Report template'''''

[[File:reportTemplateList.png|centre|frame]]

The report template creation requires following steps:
# Click on '''Add New''' button
# Fill following fields on ''General'' tab:
{| class="wikitable"
! Field Name !! Description !! Example Value
|-
| Name* || Logic report template name || "Sample Report Template"
|-
| Description || Report template description || "A report tamplate as sample"
|-
| Status* || Configurable Active/Inactive statuses || "Active"
|-
| BIRT Report Template* || Load .rptdesign file || "Sample_Report_Template"
|-
|}
<ol>
<li value=3>Fill the following fields on ''Data source'' tab:</li>
</ol>
{| class="wikitable"
! Field Name !! Description !! Example Value
|-
| Data source* || Data source imported from .rptdesign file || "PMSM_DB_TEST"
|-
| Mapped on || itmSUITE® data source item to which report template can refers for data extraction. If it is empty, data source defined in .rptdesign file is used || "PMSM DB Test"
|-
| Type* || Connection type to data source (always JDBC) || "JDBC"
|-
|}

<ol>
<li value=4>Click on '''Save''' button to save report template settings</li>
</ol>

==== Add report on itmSUITE® menu ====
After report instance has been created on '''''Report Management''''', it needs to add a report entry in itmSUITE® menu.

[[File:reportMenu.png|centre|frame]]

Report menu entry is configurable on the '''''General > Company > Main Navigation Menu''''' in ''Not Used/Reporting'' section. 
'''Important:''' it needs to repeat ''administrator'' login in order that report entry can be dragged and dropped from ''Not Used/Reporting'' section to ''Main Navigation Menu section''

Finally report can be run by assigned users from itmSUITE® menu entry configured by ''administrator''.

REP - Reporting

2018-06-18T14:47:44Z

Luca.pandolfo: /* Load report template */

REP is an optional itmSUITE® module that defines functionality to manage and excute reports created by Eclipse BIRT Designer tool. 
It allows to load one or more report templates (BIRT.rptdesign file) and to create and to execute report instances through the BIRT Viewer integrated on itmSUITE®.

=== BIRT Architecture ===
[http://www.eclipse.org/birt/ BIRT] (Business Intelligence Reporting Tool) is an open source tool installed as Eclipse IDE plug-in for report developing. It has origin from collaboration between Actuate (along with IBM) and Eclipse.org open source community. 
BIRT is a Java based tool that allows to extract data from many data source types for report generation in several output format (pdf, xlsx, docx, etc.).

[[File:Birt_Architecture.png|centre|thumb|500x500px|Birt Architecture]]

BIRT architecture includes two main components:
# Report Designer: a UI component to create report template (.rptdesign file)
# Report Engine: runtime component for report rendering

The Design Engine generates a .rptdesign file (in XML format) structured according to configurations applied by user (by BIRT Designer) and the Report Engine, through BIRT Viewer, parse and renders it as report in HTML,or other, format.

=== BIRT Report on itmSUITE® ===
In itmSUITE®, the steps required to upload and execute BIRT report previously created through the BIRT Designer are following:
#Data source configuration
#Load report template (.rptdesign file)
#Create a report instance
#Add report on menu and execute it

==== Data Source Configuration ====
In itmSUITE®, BIRT report data can be extracted only from data sources connected to database.
Data Source settings are accessible on the '''''General > Company > Report Engine > Data Source''''' menu.

[[File:dataSource.png|centre|frame|Data Source list - more data source items can be created]]

Data source creation steps:
# Click on '''Add New''' button
# Fill following fields (* mandatory):
{| class="wikitable"
! Field Name !! Description !! Example Value
|-
| Name* || Logic data source item name || "Sample DB"
|-
| Description || Data source item description || "Sample data source"
|-
| Company* || Company to which data source item is assigned || "Sample Company"
|-
| Status* || Configurable Active/Inactive statuses || "Active"
|-
| Type* || Driver type used to connect to data source || "JDBC"
|-
| Data Driver* || Driver used to connect to data source || "MSSQL"
|-
| DB Server* || URL (or IP) of data source server || "192.168.10.5"
|-
| Port* || Connection data source port || "1433"
|-
| DB Name* || Database name to which data source item refers || "PMSM_SAMPLE_DB"
|-
| Username* || Username used to connect to database || -
|-
| Password* || Password used to connect to database || -
|-
|}
<ol>
<li value=3>Click on '''Check And Save''' button to check database connection and to save data source settings</li>
</ol>

==== Load report template ====
Report template (.rptdesign) file defines the report structure in a well-formed XML document.
In itmSUITE®, a report template can be associated to more report instances. Report template configuration is accessible on the '''''General > Company > Report Engine > Report template''''' menu

[[File:reportTemplateList.png|centre|frame]]

The report template creation requires following steps:
# Click on '''Add New''' button
# Fill following fields on ''General'' tab:
{| class="wikitable"
! Field Name !! Description !! Example Value
|-
| Name* || Logic report template name || "Sample Report Template"
|-
| Description || Report template description || "A report tamplate as sample"
|-
| Status* || Configurable Active/Inactive statuses || "Active"
|-
| BIRT Report Template* || Load .rptdesign file || "Sample_Report_Template"
|-
|}
<ol>
<li value=3>Fill the following fields on ''Data source'' tab:</li>
</ol>
{| class="wikitable"
! Field Name !! Description !! Example Value
|-
| Data source* || Data source imported from .rptdesign file || "PMSM_DB_TEST"
|-
| Mapped on || itmSUITE® data source item to which report template can refers for data extraction. If it is empty, data source defined in .rptdesign file is used || "PMSM DB Test"
|-
| Type* || Connection type to data source (always JDBC) || "JDBC"
|-
|}

<ol>
<li value=4>Click on '''Save''' button to save report template settings</li>
</ol>

==== Create Report Instance ====
Report instance defines a BIRT report that can refer to only a report template and can be launched directly from itmSUITE® menu.
A report instance is configurable on the '''''General > Company > Report Engine > Report Management''''' menu

[[File:reportManagementList.png|centre|frame]]

The report instance creation requires following steps:
# Click on '''Add New''' button
# Fill following fields on ''General'' tab:
{| class="wikitable"
! Field Name !! Description !! Example Value
|-
| Name* || Report name || "Sample Report"
|-
| Description || Report description || "A sample report"
|-
| Status* || Configurable Active/Inactive statuses. If Inactive report cannot be shown on itmSUITE® menu || "Active"
|-
| Template* || Report template name to which report instance refers || "Sample_Report_Template"
|-
|}
<ol>
<li ''value=3>Check that all report parameters are visible on ''Parameters'' tab:</li>
</ol>

[[File:reportParameter.png|centre|frame]]

<ol>
<li value=4>On ''Filter Designer'' tab, it is possible to customize a report launcher box (at default it contain''''Italic text''s the same parameters defined on report template):</li>
*Hide/show report parameters
*Add/delete parameters sections
*Edit each report parameter item (read-only,label editing, mandatory, etc.)
*Add Output field to extract report in several format (html, word, excel, pdf, ppt)
*Add Open Report in New Window check box to visualize report ouput on a new tab

[[File:reportDesigner.png|centre|frame]]

It is possible to see a report launcher preview by clicking on '''Preview''' button
<li>On ''Assignments'' tab, set report visibility grants on itmSUITE® menu

[[File:reportAssignment.png|centre|frame]]

by following filter fields:

{| class="wikitable"
! Filter Name !! Description
|-
| Role || it limits visibility to users that belong to following roles: ''superadmin'', ''administrator'', ''manager'', ''pm'', ''resource'', ''requester''. It works also as prefilter for Resource filter
|-
| Resource || it limits visibility to selected ''resources''
|-
| Group || it limits visibility to members of selected ''groups''
|-
| Organization unit || it limits visibility to resources that belong to selected ''organization units''
|-
|}
</li>
<li>
On Filter tab, it is possible to manage personal filters selectable by user directly from report

[[File:reportFilter.png|centre|frame]]
</li>
</ol>

==== Load report template ====
Report template (.rptdesign) file defines the report structure in a well-formed XML document.
In itmSUITE®, a report template can be associated to more report instances. Report template configuration is accessible on the '''''General > Company > Report Engine > Report template'''''

[[File:reportTemplateList.png|centre|frame]]

The report template creation requires following steps:
# Click on '''Add New''' button
# Fill following fields on ''General'' tab:
{| class="wikitable"
! Field Name !! Description !! Example Value
|-
| Name* || Logic report template name || "Sample Report Template"
|-
| Description || Report template description || "A report tamplate as sample"
|-
| Status* || Configurable Active/Inactive statuses || "Active"
|-
| BIRT Report Template* || Load .rptdesign file || "Sample_Report_Template"
|-
|}
<ol>
<li value=3>Fill the following fields on ''Data source'' tab:</li>
</ol>
{| class="wikitable"
! Field Name !! Description !! Example Value
|-
| Data source* || Data source imported from .rptdesign file || "PMSM_DB_TEST"
|-
| Mapped on || itmSUITE® data source item to which report template can refers for data extraction. If it is empty, data source defined in .rptdesign file is used || "PMSM DB Test"
|-
| Type* || Connection type to data source (always JDBC) || "JDBC"
|-
|}

<ol>
<li value=4>Click on '''Save''' button to save report template settings</li>
</ol>

==== Add report on itmSUITE® menu ====
After report instance has been created on '''''Report Management''''', it needs to add a report entry in itmSUITE® menu.

[[File:reportMenu.png|centre|frame]]

Report menu entry is configurable on the '''''General > Company > Main Navigation Menu''''' in ''Not Used/Reporting'' section. 
'''Important:''' it needs to repeat ''administrator'' login in order that report entry can be dragged and dropped from ''Not Used/Reporting'' section to ''Main Navigation Menu section''

Finally report can be run by assigned users from itmSUITE® menu entry configured by ''administrator''.

REP - Reporting

2018-06-18T14:44:42Z

Luca.pandolfo: /* BIRT Architecture */

REP is an optional itmSUITE® module that defines functionality to manage and excute reports created by Eclipse BIRT Designer tool. 
It allows to load one or more report templates (BIRT.rptdesign file) and to create and to execute report instances through the BIRT Viewer integrated on itmSUITE®.

=== BIRT Architecture ===
[http://www.eclipse.org/birt/ BIRT] (Business Intelligence Reporting Tool) is an open source tool installed as Eclipse IDE plug-in for report developing. It has origin from collaboration between Actuate (along with IBM) and Eclipse.org open source community. 
BIRT is a Java based tool that allows to extract data from many data source types for report generation in several output format (pdf, xlsx, docx, etc.).

[[File:Birt_Architecture.png|centre|thumb|500x500px|Birt Architecture]]

BIRT architecture includes two main components:
# Report Designer: a UI component to create report template (.rptdesign file)
# Report Engine: runtime component for report rendering

The Design Engine generates a .rptdesign file (in XML format) structured according to configurations applied by user (by BIRT Designer) and the Report Engine, through BIRT Viewer, parse and renders it as report in HTML,or other, format.

=== BIRT Report on itmSUITE® ===
In itmSUITE®, the steps required to upload and execute BIRT report previously created through the BIRT Designer are following:
#Data source configuration
#Load report template (.rptdesign file)
#Create a report instance
#Add report on menu and execute it

==== Data Source Configuration ====
In itmSUITE®, BIRT report data can be extracted only from data sources connected to database.
Data Source settings are accessible on the '''''General > Company > Report Engine > Data Source''''' menu.

[[File:dataSource.png|centre|frame|Data Source list - more data source items can be created]]

Data source creation steps:
# Click on '''Add New''' button
# Fill following fields (* mandatory):
{| class="wikitable"
! Field Name !! Description !! Example Value
|-
| Name* || Logic data source item name || "Sample DB"
|-
| Description || Data source item description || "Sample data source"
|-
| Company* || Company to which data source item is assigned || "Sample Company"
|-
| Status* || Configurable Active/Inactive statuses || "Active"
|-
| Type* || Driver type used to connect to data source || "JDBC"
|-
| Data Driver* || Driver used to connect to data source || "MSSQL"
|-
| DB Server* || URL (or IP) of data source server || "192.168.10.5"
|-
| Port* || Connection data source port || "1433"
|-
| DB Name* || Database name to which data source item refers || "PMSM_SAMPLE_DB"
|-
| Username* || Username used to connect to database || -
|-
| Password* || Password used to connect to database || -
|-
|}
<ol>
<li value=3>Click on '''Check And Save''' button to check database connection and to save data source settings</li>
</ol>

==== Load report template ====
Report template (.rptdesign) file defines the report structure in a well-formed XML document.
In itmSUITE®, a report template can be associated to more report instances. Report template configuration is accessible on the '''''General > Company > Report Engine > Report template'''''

[[File:reportTemplateList.png|centre|frame]]

The report template creation requires following steps:
# Click on '''Add New''' button
# Fill following fields on ''General'' tab:
{| class="wikitable"
! Field Name !! Description !! Example Value
|-
| Name* || Logic report template name || "Sample Report Template"
|-
| Description || Report template description || "A report tamplate as sample"
|-
| Status* || Configurable Active/Inactive statuses || "Active"
|-
| BIRT Report Template* || Load .rptdesign file || "Sample_Report_Template"
|-
|}
<ol>
<li value=3>Fill the following fields on ''Data source'' tab:</li>
</ol>
{| class="wikitable"
! Field Name !! Description !! Example Value
|-
| Data source* || Data source imported from .rptdesign file || "PMSM_DB_TEST"
|-
| Mapped on || itmSUITE® data source item to which report template can refers for data extraction. If it is empty, data source defined in .rptdesign file is used || "PMSM DB Test"
|-
| Type* || Connection type to data source (always JDBC) || "JDBC"
|-
|}

<ol>
<li value=4>Click on '''Save''' button to save report template settings</li>
</ol>

==== Create Report Instance ====
Report instance defines a BIRT report that can refer to only a report template and can be launched directly from itmSUITE® menu.
A report instance is configurable on the '''''General > Company > Report Engine > Report Management''''' menu

[[File:reportManagementList.png|centre|frame]]

The report instance creation requires following steps:
# Click on '''Add New''' button
# Fill following fields on ''General'' tab:
{| class="wikitable"
! Field Name !! Description !! Example Value
|-
| Name* || Report name || "Sample Report"
|-
| Description || Report description || "A sample report"
|-
| Status* || Configurable Active/Inactive statuses. If Inactive report cannot be shown on itmSUITE® menu || "Active"
|-
| Template* || Report template name to which report instance refers || "Sample_Report_Template"
|-
|}
<ol>
<li ''value=3>Check that all report parameters are visible on ''Parameters'' tab:</li>
</ol>

[[File:reportParameter.png|centre|frame]]

<ol>
<li value=4>On ''Filter Designer'' tab, it is possible to customize a report launcher box (at default it contain''''Italic text''s the same parameters defined on report template):</li>
*Hide/show report parameters
*Add/delete parameters sections
*Edit each report parameter item (read-only,label editing, mandatory, etc.)
*Add Output field to extract report in several format (html, word, excel, pdf, ppt)
*Add Open Report in New Window check box to visualize report ouput on a new tab

[[File:reportDesigner.png|centre|frame]]

It is possible to see a report launcher preview by clicking on '''Preview''' button
<li>On ''Assignments'' tab, set report visibility grants on itmSUITE® menu

[[File:reportAssignment.png|centre|frame]]

by following filter fields:

{| class="wikitable"
! Filter Name !! Description
|-
| Role || it limits visibility to users that belong to following roles: ''superadmin'', ''administrator'', ''manager'', ''pm'', ''resource'', ''requester''. It works also as prefilter for Resource filter
|-
| Resource || it limits visibility to selected ''resources''
|-
| Group || it limits visibility to members of selected ''groups''
|-
| Organization unit || it limits visibility to resources that belong to selected ''organization units''
|-
|}
</li>
<li>
On Filter tab, it is possible to manage personal filters selectable by user directly from report

[[File:reportFilter.png|centre|frame]]
</li>
</ol>

==== Load report template ====
Report template (.rptdesign) file defines the report structure in a well-formed XML document.
In itmSUITE®, a report template can be associated to more report instances. Report template configuration is accessible on the '''''General > Company > Report Engine > Report template'''''

[[File:reportTemplateList.png|centre|frame]]

The report template creation requires following steps:
# Click on '''Add New''' button
# Fill following fields on ''General'' tab:
{| class="wikitable"
! Field Name !! Description !! Example Value
|-
| Name* || Logic report template name || "Sample Report Template"
|-
| Description || Report template description || "A report tamplate as sample"
|-
| Status* || Configurable Active/Inactive statuses || "Active"
|-
| BIRT Report Template* || Load .rptdesign file || "Sample_Report_Template"
|-
|}
<ol>
<li value=3>Fill the following fields on ''Data source'' tab:</li>
</ol>
{| class="wikitable"
! Field Name !! Description !! Example Value
|-
| Data source* || Data source imported from .rptdesign file || "PMSM_DB_TEST"
|-
| Mapped on || itmSUITE® data source item to which report template can refers for data extraction. If it is empty, data source defined in .rptdesign file is used || "PMSM DB Test"
|-
| Type* || Connection type to data source (always JDBC) || "JDBC"
|-
|}

<ol>
<li value=4>Click on '''Save''' button to save report template settings</li>
</ol>

==== Add report on itmSUITE® menu ====
After report instance has been created on '''''Report Management''''', it needs to add a report entry in itmSUITE® menu.

[[File:reportMenu.png|centre|frame]]

Report menu entry is configurable on the '''''General > Company > Main Navigation Menu''''' in ''Not Used/Reporting'' section. 
'''Important:''' it needs to repeat ''administrator'' login in order that report entry can be dragged and dropped from ''Not Used/Reporting'' section to ''Main Navigation Menu section''

Finally report can be run by assigned users from itmSUITE® menu entry configured by ''administrator''.

REP - Reporting

2018-06-18T14:43:23Z

Luca.pandolfo: /* BIRT Architecture */

REP is an optional itmSUITE® module that defines functionality to manage and excute reports created by Eclipse BIRT Designer tool. 
It allows to load one or more report templates (BIRT.rptdesign file) and to create and to execute report instances through the BIRT Viewer integrated on itmSUITE®.

=== BIRT Architecture ===
[http://www.eclipse.org/birt/ BIRT] (Business Intelligence Reporting Tool) is an open source tool installed as Eclipse IDE plug-in for report developing. It has origin from collaboration between Actuate (along with IBM) and Eclipse.org open source community. 
BIRT is a Java based tool that allows to extract data from many data source types for report generation in several output format (pdf, xlsx, docx, etc.).

[[File:Birt_Architecture.png|centre|thumb|500x500px|Birt Architecture]]

BIRT architecture includes two main components:
# Report Designer: a UI component to create report template (.rptdesign file)
# Report Engine: runtime component for report rendering

The Design Engine generates a .rptdesign file (in XML format) structured according to configurations applied by user (by BIRT Designer) and the Report Engine, through BIRT Viewer, parses it and renders it as report in html (or other formats).

=== BIRT Report on itmSUITE® ===
In itmSUITE®, the steps required to upload and execute BIRT report previously created through the BIRT Designer are following:
#Data source configuration
#Load report template (.rptdesign file)
#Create a report instance
#Add report on menu and execute it

==== Data Source Configuration ====
In itmSUITE®, BIRT report data can be extracted only from data sources connected to database.
Data Source settings are accessible on the '''''General > Company > Report Engine > Data Source''''' menu.

[[File:dataSource.png|centre|frame|Data Source list - more data source items can be created]]

Data source creation steps:
# Click on '''Add New''' button
# Fill following fields (* mandatory):
{| class="wikitable"
! Field Name !! Description !! Example Value
|-
| Name* || Logic data source item name || "Sample DB"
|-
| Description || Data source item description || "Sample data source"
|-
| Company* || Company to which data source item is assigned || "Sample Company"
|-
| Status* || Configurable Active/Inactive statuses || "Active"
|-
| Type* || Driver type used to connect to data source || "JDBC"
|-
| Data Driver* || Driver used to connect to data source || "MSSQL"
|-
| DB Server* || URL (or IP) of data source server || "192.168.10.5"
|-
| Port* || Connection data source port || "1433"
|-
| DB Name* || Database name to which data source item refers || "PMSM_SAMPLE_DB"
|-
| Username* || Username used to connect to database || -
|-
| Password* || Password used to connect to database || -
|-
|}
<ol>
<li value=3>Click on '''Check And Save''' button to check database connection and to save data source settings</li>
</ol>

==== Load report template ====
Report template (.rptdesign) file defines the report structure in a well-formed XML document.
In itmSUITE®, a report template can be associated to more report instances. Report template configuration is accessible on the '''''General > Company > Report Engine > Report template'''''

[[File:reportTemplateList.png|centre|frame]]

The report template creation requires following steps:
# Click on '''Add New''' button
# Fill following fields on ''General'' tab:
{| class="wikitable"
! Field Name !! Description !! Example Value
|-
| Name* || Logic report template name || "Sample Report Template"
|-
| Description || Report template description || "A report tamplate as sample"
|-
| Status* || Configurable Active/Inactive statuses || "Active"
|-
| BIRT Report Template* || Load .rptdesign file || "Sample_Report_Template"
|-
|}
<ol>
<li value=3>Fill the following fields on ''Data source'' tab:</li>
</ol>
{| class="wikitable"
! Field Name !! Description !! Example Value
|-
| Data source* || Data source imported from .rptdesign file || "PMSM_DB_TEST"
|-
| Mapped on || itmSUITE® data source item to which report template can refers for data extraction. If it is empty, data source defined in .rptdesign file is used || "PMSM DB Test"
|-
| Type* || Connection type to data source (always JDBC) || "JDBC"
|-
|}

<ol>
<li value=4>Click on '''Save''' button to save report template settings</li>
</ol>

==== Create Report Instance ====
Report instance defines a BIRT report that can refer to only a report template and can be launched directly from itmSUITE® menu.
A report instance is configurable on the '''''General > Company > Report Engine > Report Management''''' menu

[[File:reportManagementList.png|centre|frame]]

The report instance creation requires following steps:
# Click on '''Add New''' button
# Fill following fields on ''General'' tab:
{| class="wikitable"
! Field Name !! Description !! Example Value
|-
| Name* || Report name || "Sample Report"
|-
| Description || Report description || "A sample report"
|-
| Status* || Configurable Active/Inactive statuses. If Inactive report cannot be shown on itmSUITE® menu || "Active"
|-
| Template* || Report template name to which report instance refers || "Sample_Report_Template"
|-
|}
<ol>
<li ''value=3>Check that all report parameters are visible on ''Parameters'' tab:</li>
</ol>

[[File:reportParameter.png|centre|frame]]

<ol>
<li value=4>On ''Filter Designer'' tab, it is possible to customize a report launcher box (at default it contain''''Italic text''s the same parameters defined on report template):</li>
*Hide/show report parameters
*Add/delete parameters sections
*Edit each report parameter item (read-only,label editing, mandatory, etc.)
*Add Output field to extract report in several format (html, word, excel, pdf, ppt)
*Add Open Report in New Window check box to visualize report ouput on a new tab

[[File:reportDesigner.png|centre|frame]]

It is possible to see a report launcher preview by clicking on '''Preview''' button
<li>On ''Assignments'' tab, set report visibility grants on itmSUITE® menu

[[File:reportAssignment.png|centre|frame]]

by following filter fields:

{| class="wikitable"
! Filter Name !! Description
|-
| Role || it limits visibility to users that belong to following roles: ''superadmin'', ''administrator'', ''manager'', ''pm'', ''resource'', ''requester''. It works also as prefilter for Resource filter
|-
| Resource || it limits visibility to selected ''resources''
|-
| Group || it limits visibility to members of selected ''groups''
|-
| Organization unit || it limits visibility to resources that belong to selected ''organization units''
|-
|}
</li>
<li>
On Filter tab, it is possible to manage personal filters selectable by user directly from report

[[File:reportFilter.png|centre|frame]]
</li>
</ol>

==== Load report template ====
Report template (.rptdesign) file defines the report structure in a well-formed XML document.
In itmSUITE®, a report template can be associated to more report instances. Report template configuration is accessible on the '''''General > Company > Report Engine > Report template'''''

[[File:reportTemplateList.png|centre|frame]]

The report template creation requires following steps:
# Click on '''Add New''' button
# Fill following fields on ''General'' tab:
{| class="wikitable"
! Field Name !! Description !! Example Value
|-
| Name* || Logic report template name || "Sample Report Template"
|-
| Description || Report template description || "A report tamplate as sample"
|-
| Status* || Configurable Active/Inactive statuses || "Active"
|-
| BIRT Report Template* || Load .rptdesign file || "Sample_Report_Template"
|-
|}
<ol>
<li value=3>Fill the following fields on ''Data source'' tab:</li>
</ol>
{| class="wikitable"
! Field Name !! Description !! Example Value
|-
| Data source* || Data source imported from .rptdesign file || "PMSM_DB_TEST"
|-
| Mapped on || itmSUITE® data source item to which report template can refers for data extraction. If it is empty, data source defined in .rptdesign file is used || "PMSM DB Test"
|-
| Type* || Connection type to data source (always JDBC) || "JDBC"
|-
|}

<ol>
<li value=4>Click on '''Save''' button to save report template settings</li>
</ol>

==== Add report on itmSUITE® menu ====
After report instance has been created on '''''Report Management''''', it needs to add a report entry in itmSUITE® menu.

[[File:reportMenu.png|centre|frame]]

Report menu entry is configurable on the '''''General > Company > Main Navigation Menu''''' in ''Not Used/Reporting'' section. 
'''Important:''' it needs to repeat ''administrator'' login in order that report entry can be dragged and dropped from ''Not Used/Reporting'' section to ''Main Navigation Menu section''

Finally report can be run by assigned users from itmSUITE® menu entry configured by ''administrator''.

REP - Reporting

2018-06-18T14:39:59Z

Luca.pandolfo: /* BIRT Architecture */

REP is an optional itmSUITE® module that defines functionality to manage and excute reports created by Eclipse BIRT Designer tool. 
It allows to load one or more report templates (BIRT.rptdesign file) and to create and to execute report instances through the BIRT Viewer integrated on itmSUITE®.

=== BIRT Architecture ===
[http://www.eclipse.org/birt/ BIRT] (Business Intelligence Reporting Tool) is an open source tool installed as Eclipse IDE plug-in for report developing. It has origin from collaboration between Actuate (along with IBM) and Eclipse.org open source community. 
BIRT is a Java based tool that allows to extract data from many data source types for report generation in several output format (pdf, xlsx, docx, etc.).

[[File:Birt_Architecture.png|centre|thumb|500x500px|Birt Architecture]]

BIRT architecture includes two main components:
# Report Designer: a UI component to create report template (.rptdesign file)
# Report Engine: runtime component for report rendering

The Design Engine generates a .rptdesign file(in XML format) structured according to configurations applied by user (by BIRT Designer) and the Report Engine, through BIRT Viewer, parses it and renders it as report in html (or other formats).

=== BIRT Report on itmSUITE® ===
In itmSUITE®, the steps required to upload and execute BIRT report previously created through the BIRT Designer are following:
#Data source configuration
#Load report template (.rptdesign file)
#Create a report instance
#Add report on menu and execute it

==== Data Source Configuration ====
In itmSUITE®, BIRT report data can be extracted only from data sources connected to database.
Data Source settings are accessible on the '''''General > Company > Report Engine > Data Source''''' menu.

[[File:dataSource.png|centre|frame|Data Source list - more data source items can be created]]

Data source creation steps:
# Click on '''Add New''' button
# Fill following fields (* mandatory):
{| class="wikitable"
! Field Name !! Description !! Example Value
|-
| Name* || Logic data source item name || "Sample DB"
|-
| Description || Data source item description || "Sample data source"
|-
| Company* || Company to which data source item is assigned || "Sample Company"
|-
| Status* || Configurable Active/Inactive statuses || "Active"
|-
| Type* || Driver type used to connect to data source || "JDBC"
|-
| Data Driver* || Driver used to connect to data source || "MSSQL"
|-
| DB Server* || URL (or IP) of data source server || "192.168.10.5"
|-
| Port* || Connection data source port || "1433"
|-
| DB Name* || Database name to which data source item refers || "PMSM_SAMPLE_DB"
|-
| Username* || Username used to connect to database || -
|-
| Password* || Password used to connect to database || -
|-
|}
<ol>
<li value=3>Click on '''Check And Save''' button to check database connection and to save data source settings</li>
</ol>

==== Load report template ====
Report template (.rptdesign) file defines the report structure in a well-formed XML document.
In itmSUITE®, a report template can be associated to more report instances. Report template configuration is accessible on the '''''General > Company > Report Engine > Report template'''''

[[File:reportTemplateList.png|centre|frame]]

The report template creation requires following steps:
# Click on '''Add New''' button
# Fill following fields on ''General'' tab:
{| class="wikitable"
! Field Name !! Description !! Example Value
|-
| Name* || Logic report template name || "Sample Report Template"
|-
| Description || Report template description || "A report tamplate as sample"
|-
| Status* || Configurable Active/Inactive statuses || "Active"
|-
| BIRT Report Template* || Load .rptdesign file || "Sample_Report_Template"
|-
|}
<ol>
<li value=3>Fill the following fields on ''Data source'' tab:</li>
</ol>
{| class="wikitable"
! Field Name !! Description !! Example Value
|-
| Data source* || Data source imported from .rptdesign file || "PMSM_DB_TEST"
|-
| Mapped on || itmSUITE® data source item to which report template can refers for data extraction. If it is empty, data source defined in .rptdesign file is used || "PMSM DB Test"
|-
| Type* || Connection type to data source (always JDBC) || "JDBC"
|-
|}

<ol>
<li value=4>Click on '''Save''' button to save report template settings</li>
</ol>

==== Create Report Instance ====
Report instance defines a BIRT report that can refer to only a report template and can be launched directly from itmSUITE® menu.
A report instance is configurable on the '''''General > Company > Report Engine > Report Management''''' menu

[[File:reportManagementList.png|centre|frame]]

The report instance creation requires following steps:
# Click on '''Add New''' button
# Fill following fields on ''General'' tab:
{| class="wikitable"
! Field Name !! Description !! Example Value
|-
| Name* || Report name || "Sample Report"
|-
| Description || Report description || "A sample report"
|-
| Status* || Configurable Active/Inactive statuses. If Inactive report cannot be shown on itmSUITE® menu || "Active"
|-
| Template* || Report template name to which report instance refers || "Sample_Report_Template"
|-
|}
<ol>
<li ''value=3>Check that all report parameters are visible on ''Parameters'' tab:</li>
</ol>

[[File:reportParameter.png|centre|frame]]

<ol>
<li value=4>On ''Filter Designer'' tab, it is possible to customize a report launcher box (at default it contain''''Italic text''s the same parameters defined on report template):</li>
*Hide/show report parameters
*Add/delete parameters sections
*Edit each report parameter item (read-only,label editing, mandatory, etc.)
*Add Output field to extract report in several format (html, word, excel, pdf, ppt)
*Add Open Report in New Window check box to visualize report ouput on a new tab

[[File:reportDesigner.png|centre|frame]]

It is possible to see a report launcher preview by clicking on '''Preview''' button
<li>On ''Assignments'' tab, set report visibility grants on itmSUITE® menu

[[File:reportAssignment.png|centre|frame]]

by following filter fields:

{| class="wikitable"
! Filter Name !! Description
|-
| Role || it limits visibility to users that belong to following roles: ''superadmin'', ''administrator'', ''manager'', ''pm'', ''resource'', ''requester''. It works also as prefilter for Resource filter
|-
| Resource || it limits visibility to selected ''resources''
|-
| Group || it limits visibility to members of selected ''groups''
|-
| Organization unit || it limits visibility to resources that belong to selected ''organization units''
|-
|}
</li>
<li>
On Filter tab, it is possible to manage personal filters selectable by user directly from report

[[File:reportFilter.png|centre|frame]]
</li>
</ol>

==== Load report template ====
Report template (.rptdesign) file defines the report structure in a well-formed XML document.
In itmSUITE®, a report template can be associated to more report instances. Report template configuration is accessible on the '''''General > Company > Report Engine > Report template'''''

[[File:reportTemplateList.png|centre|frame]]

The report template creation requires following steps:
# Click on '''Add New''' button
# Fill following fields on ''General'' tab:
{| class="wikitable"
! Field Name !! Description !! Example Value
|-
| Name* || Logic report template name || "Sample Report Template"
|-
| Description || Report template description || "A report tamplate as sample"
|-
| Status* || Configurable Active/Inactive statuses || "Active"
|-
| BIRT Report Template* || Load .rptdesign file || "Sample_Report_Template"
|-
|}
<ol>
<li value=3>Fill the following fields on ''Data source'' tab:</li>
</ol>
{| class="wikitable"
! Field Name !! Description !! Example Value
|-
| Data source* || Data source imported from .rptdesign file || "PMSM_DB_TEST"
|-
| Mapped on || itmSUITE® data source item to which report template can refers for data extraction. If it is empty, data source defined in .rptdesign file is used || "PMSM DB Test"
|-
| Type* || Connection type to data source (always JDBC) || "JDBC"
|-
|}

<ol>
<li value=4>Click on '''Save''' button to save report template settings</li>
</ol>

==== Add report on itmSUITE® menu ====
After report instance has been created on '''''Report Management''''', it needs to add a report entry in itmSUITE® menu.

[[File:reportMenu.png|centre|frame]]

Report menu entry is configurable on the '''''General > Company > Main Navigation Menu''''' in ''Not Used/Reporting'' section. 
'''Important:''' it needs to repeat ''administrator'' login in order that report entry can be dragged and dropped from ''Not Used/Reporting'' section to ''Main Navigation Menu section''

Finally report can be run by assigned users from itmSUITE® menu entry configured by ''administrator''.

REP - Reporting

2018-06-18T14:38:34Z

Luca.pandolfo: /* BIRT Architecture */

REP is an optional itmSUITE® module that defines functionality to manage and excute reports created by Eclipse BIRT Designer tool. 
It allows to load one or more report templates (BIRT.rptdesign file) and to create and to execute report instances through the BIRT Viewer integrated on itmSUITE®.

=== BIRT Architecture ===
[http://www.eclipse.org/birt/, BIRT] (Business Intelligence Reporting Tool) is an open source tool installed as Eclipse IDE plug-in for report developing. It has origin from collaboration between Actuate (along with IBM) and Eclipse.org open source community. 
BIRT is a Java based tool that allows to extract data from many data source types for report generation in several output format (pdf, xlsx, docx, etc.).

[[File:Birt_Architecture.png|centre|thumb|500x500px|Birt Architecture]]

BIRT architecture includes two main components:
# Report Designer: a UI component to create report template (.rptdesign file)
# Report Engine: runtime component for report rendering

The Design Engine generates a .rptdesign file(in XML format) structured according to configurations applied by user (by BIRT Designer) and the Report Engine, through BIRT Viewer, parses it and renders it as report in html (or other formats).

=== BIRT Report on itmSUITE® ===
In itmSUITE®, the steps required to upload and execute BIRT report previously created through the BIRT Designer are following:
#Data source configuration
#Load report template (.rptdesign file)
#Create a report instance
#Add report on menu and execute it

==== Data Source Configuration ====
In itmSUITE®, BIRT report data can be extracted only from data sources connected to database.
Data Source settings are accessible on the '''''General > Company > Report Engine > Data Source''''' menu.

[[File:dataSource.png|centre|frame|Data Source list - more data source items can be created]]

Data source creation steps:
# Click on '''Add New''' button
# Fill following fields (* mandatory):
{| class="wikitable"
! Field Name !! Description !! Example Value
|-
| Name* || Logic data source item name || "Sample DB"
|-
| Description || Data source item description || "Sample data source"
|-
| Company* || Company to which data source item is assigned || "Sample Company"
|-
| Status* || Configurable Active/Inactive statuses || "Active"
|-
| Type* || Driver type used to connect to data source || "JDBC"
|-
| Data Driver* || Driver used to connect to data source || "MSSQL"
|-
| DB Server* || URL (or IP) of data source server || "192.168.10.5"
|-
| Port* || Connection data source port || "1433"
|-
| DB Name* || Database name to which data source item refers || "PMSM_SAMPLE_DB"
|-
| Username* || Username used to connect to database || -
|-
| Password* || Password used to connect to database || -
|-
|}
<ol>
<li value=3>Click on '''Check And Save''' button to check database connection and to save data source settings</li>
</ol>

==== Load report template ====
Report template (.rptdesign) file defines the report structure in a well-formed XML document.
In itmSUITE®, a report template can be associated to more report instances. Report template configuration is accessible on the '''''General > Company > Report Engine > Report template'''''

[[File:reportTemplateList.png|centre|frame]]

The report template creation requires following steps:
# Click on '''Add New''' button
# Fill following fields on ''General'' tab:
{| class="wikitable"
! Field Name !! Description !! Example Value
|-
| Name* || Logic report template name || "Sample Report Template"
|-
| Description || Report template description || "A report tamplate as sample"
|-
| Status* || Configurable Active/Inactive statuses || "Active"
|-
| BIRT Report Template* || Load .rptdesign file || "Sample_Report_Template"
|-
|}
<ol>
<li value=3>Fill the following fields on ''Data source'' tab:</li>
</ol>
{| class="wikitable"
! Field Name !! Description !! Example Value
|-
| Data source* || Data source imported from .rptdesign file || "PMSM_DB_TEST"
|-
| Mapped on || itmSUITE® data source item to which report template can refers for data extraction. If it is empty, data source defined in .rptdesign file is used || "PMSM DB Test"
|-
| Type* || Connection type to data source (always JDBC) || "JDBC"
|-
|}

<ol>
<li value=4>Click on '''Save''' button to save report template settings</li>
</ol>

==== Create Report Instance ====
Report instance defines a BIRT report that can refer to only a report template and can be launched directly from itmSUITE® menu.
A report instance is configurable on the '''''General > Company > Report Engine > Report Management''''' menu

[[File:reportManagementList.png|centre|frame]]

The report instance creation requires following steps:
# Click on '''Add New''' button
# Fill following fields on ''General'' tab:
{| class="wikitable"
! Field Name !! Description !! Example Value
|-
| Name* || Report name || "Sample Report"
|-
| Description || Report description || "A sample report"
|-
| Status* || Configurable Active/Inactive statuses. If Inactive report cannot be shown on itmSUITE® menu || "Active"
|-
| Template* || Report template name to which report instance refers || "Sample_Report_Template"
|-
|}
<ol>
<li ''value=3>Check that all report parameters are visible on ''Parameters'' tab:</li>
</ol>

[[File:reportParameter.png|centre|frame]]

<ol>
<li value=4>On ''Filter Designer'' tab, it is possible to customize a report launcher box (at default it contain''''Italic text''s the same parameters defined on report template):</li>
*Hide/show report parameters
*Add/delete parameters sections
*Edit each report parameter item (read-only,label editing, mandatory, etc.)
*Add Output field to extract report in several format (html, word, excel, pdf, ppt)
*Add Open Report in New Window check box to visualize report ouput on a new tab

[[File:reportDesigner.png|centre|frame]]

It is possible to see a report launcher preview by clicking on '''Preview''' button
<li>On ''Assignments'' tab, set report visibility grants on itmSUITE® menu

[[File:reportAssignment.png|centre|frame]]

by following filter fields:

{| class="wikitable"
! Filter Name !! Description
|-
| Role || it limits visibility to users that belong to following roles: ''superadmin'', ''administrator'', ''manager'', ''pm'', ''resource'', ''requester''. It works also as prefilter for Resource filter
|-
| Resource || it limits visibility to selected ''resources''
|-
| Group || it limits visibility to members of selected ''groups''
|-
| Organization unit || it limits visibility to resources that belong to selected ''organization units''
|-
|}
</li>
<li>
On Filter tab, it is possible to manage personal filters selectable by user directly from report

[[File:reportFilter.png|centre|frame]]
</li>
</ol>

==== Load report template ====
Report template (.rptdesign) file defines the report structure in a well-formed XML document.
In itmSUITE®, a report template can be associated to more report instances. Report template configuration is accessible on the '''''General > Company > Report Engine > Report template'''''

[[File:reportTemplateList.png|centre|frame]]

The report template creation requires following steps:
# Click on '''Add New''' button
# Fill following fields on ''General'' tab:
{| class="wikitable"
! Field Name !! Description !! Example Value
|-
| Name* || Logic report template name || "Sample Report Template"
|-
| Description || Report template description || "A report tamplate as sample"
|-
| Status* || Configurable Active/Inactive statuses || "Active"
|-
| BIRT Report Template* || Load .rptdesign file || "Sample_Report_Template"
|-
|}
<ol>
<li value=3>Fill the following fields on ''Data source'' tab:</li>
</ol>
{| class="wikitable"
! Field Name !! Description !! Example Value
|-
| Data source* || Data source imported from .rptdesign file || "PMSM_DB_TEST"
|-
| Mapped on || itmSUITE® data source item to which report template can refers for data extraction. If it is empty, data source defined in .rptdesign file is used || "PMSM DB Test"
|-
| Type* || Connection type to data source (always JDBC) || "JDBC"
|-
|}

<ol>
<li value=4>Click on '''Save''' button to save report template settings</li>
</ol>

==== Add report on itmSUITE® menu ====
After report instance has been created on '''''Report Management''''', it needs to add a report entry in itmSUITE® menu.

[[File:reportMenu.png|centre|frame]]

Report menu entry is configurable on the '''''General > Company > Main Navigation Menu''''' in ''Not Used/Reporting'' section. 
'''Important:''' it needs to repeat ''administrator'' login in order that report entry can be dragged and dropped from ''Not Used/Reporting'' section to ''Main Navigation Menu section''

Finally report can be run by assigned users from itmSUITE® menu entry configured by ''administrator''.

REP - Reporting

2018-06-18T14:33:51Z

Luca.pandolfo: /* BIRT Architecture */

REP is an optional itmSUITE® module that defines functionality to manage and excute reports created by Eclipse BIRT Designer tool. 
It allows to load one or more report templates (BIRT.rptdesign file) and to create and to execute report instances through the BIRT Viewer integrated on itmSUITE®.

=== BIRT Architecture ===
[[BIRT]] (Business Intelligence Reporting Tool) is an open source tool installed as Eclipse IDE plug-in for report developing. It has origin from collaboration between Actuate (along with IBM) and Eclipse.org open source community. 
BIRT is a Java based tool that allows to extract data from many data source types for report generation in several output format (pdf, xlsx, docx, etc.).

[[File:Birt_Architecture.png|centre|thumb|500x500px|Birt Architecture]]

BIRT architecture includes two main components:
# Report Designer: a UI component to create report template (.rptdesign file)
# Report Engine: runtime component for report rendering

The Design Engine generates a .rptdesign file(in XML format) structured according to configurations applied by user (by BIRT Designer) and the Report Engine, through BIRT Viewer, parses it and renders it as report in html (or other formats).

=== BIRT Report on itmSUITE® ===
In itmSUITE®, the steps required to upload and execute BIRT report previously created through the BIRT Designer are following:
#Data source configuration
#Load report template (.rptdesign file)
#Create a report instance
#Add report on menu and execute it

==== Data Source Configuration ====
In itmSUITE®, BIRT report data can be extracted only from data sources connected to database.
Data Source settings are accessible on the '''''General > Company > Report Engine > Data Source''''' menu.

[[File:dataSource.png|centre|frame|Data Source list - more data source items can be created]]

Data source creation steps:
# Click on '''Add New''' button
# Fill following fields (* mandatory):
{| class="wikitable"
! Field Name !! Description !! Example Value
|-
| Name* || Logic data source item name || "Sample DB"
|-
| Description || Data source item description || "Sample data source"
|-
| Company* || Company to which data source item is assigned || "Sample Company"
|-
| Status* || Configurable Active/Inactive statuses || "Active"
|-
| Type* || Driver type used to connect to data source || "JDBC"
|-
| Data Driver* || Driver used to connect to data source || "MSSQL"
|-
| DB Server* || URL (or IP) of data source server || "192.168.10.5"
|-
| Port* || Connection data source port || "1433"
|-
| DB Name* || Database name to which data source item refers || "PMSM_SAMPLE_DB"
|-
| Username* || Username used to connect to database || -
|-
| Password* || Password used to connect to database || -
|-
|}
<ol>
<li value=3>Click on '''Check And Save''' button to check database connection and to save data source settings</li>
</ol>

==== Load report template ====
Report template (.rptdesign) file defines the report structure in a well-formed XML document.
In itmSUITE®, a report template can be associated to more report instances. Report template configuration is accessible on the '''''General > Company > Report Engine > Report template'''''

[[File:reportTemplateList.png|centre|frame]]

The report template creation requires following steps:
# Click on '''Add New''' button
# Fill following fields on ''General'' tab:
{| class="wikitable"
! Field Name !! Description !! Example Value
|-
| Name* || Logic report template name || "Sample Report Template"
|-
| Description || Report template description || "A report tamplate as sample"
|-
| Status* || Configurable Active/Inactive statuses || "Active"
|-
| BIRT Report Template* || Load .rptdesign file || "Sample_Report_Template"
|-
|}
<ol>
<li value=3>Fill the following fields on ''Data source'' tab:</li>
</ol>
{| class="wikitable"
! Field Name !! Description !! Example Value
|-
| Data source* || Data source imported from .rptdesign file || "PMSM_DB_TEST"
|-
| Mapped on || itmSUITE® data source item to which report template can refers for data extraction. If it is empty, data source defined in .rptdesign file is used || "PMSM DB Test"
|-
| Type* || Connection type to data source (always JDBC) || "JDBC"
|-
|}

<ol>
<li value=4>Click on '''Save''' button to save report template settings</li>
</ol>

==== Create Report Instance ====
Report instance defines a BIRT report that can refer to only a report template and can be launched directly from itmSUITE® menu.
A report instance is configurable on the '''''General > Company > Report Engine > Report Management''''' menu

[[File:reportManagementList.png|centre|frame]]

The report instance creation requires following steps:
# Click on '''Add New''' button
# Fill following fields on ''General'' tab:
{| class="wikitable"
! Field Name !! Description !! Example Value
|-
| Name* || Report name || "Sample Report"
|-
| Description || Report description || "A sample report"
|-
| Status* || Configurable Active/Inactive statuses. If Inactive report cannot be shown on itmSUITE® menu || "Active"
|-
| Template* || Report template name to which report instance refers || "Sample_Report_Template"
|-
|}
<ol>
<li ''value=3>Check that all report parameters are visible on ''Parameters'' tab:</li>
</ol>

[[File:reportParameter.png|centre|frame]]

<ol>
<li value=4>On ''Filter Designer'' tab, it is possible to customize a report launcher box (at default it contain''''Italic text''s the same parameters defined on report template):</li>
*Hide/show report parameters
*Add/delete parameters sections
*Edit each report parameter item (read-only,label editing, mandatory, etc.)
*Add Output field to extract report in several format (html, word, excel, pdf, ppt)
*Add Open Report in New Window check box to visualize report ouput on a new tab

[[File:reportDesigner.png|centre|frame]]

It is possible to see a report launcher preview by clicking on '''Preview''' button
<li>On ''Assignments'' tab, set report visibility grants on itmSUITE® menu

[[File:reportAssignment.png|centre|frame]]

by following filter fields:

{| class="wikitable"
! Filter Name !! Description
|-
| Role || it limits visibility to users that belong to following roles: ''superadmin'', ''administrator'', ''manager'', ''pm'', ''resource'', ''requester''. It works also as prefilter for Resource filter
|-
| Resource || it limits visibility to selected ''resources''
|-
| Group || it limits visibility to members of selected ''groups''
|-
| Organization unit || it limits visibility to resources that belong to selected ''organization units''
|-
|}
</li>
<li>
On Filter tab, it is possible to manage personal filters selectable by user directly from report

[[File:reportFilter.png|centre|frame]]
</li>
</ol>

==== Load report template ====
Report template (.rptdesign) file defines the report structure in a well-formed XML document.
In itmSUITE®, a report template can be associated to more report instances. Report template configuration is accessible on the '''''General > Company > Report Engine > Report template'''''

[[File:reportTemplateList.png|centre|frame]]

The report template creation requires following steps:
# Click on '''Add New''' button
# Fill following fields on ''General'' tab:
{| class="wikitable"
! Field Name !! Description !! Example Value
|-
| Name* || Logic report template name || "Sample Report Template"
|-
| Description || Report template description || "A report tamplate as sample"
|-
| Status* || Configurable Active/Inactive statuses || "Active"
|-
| BIRT Report Template* || Load .rptdesign file || "Sample_Report_Template"
|-
|}
<ol>
<li value=3>Fill the following fields on ''Data source'' tab:</li>
</ol>
{| class="wikitable"
! Field Name !! Description !! Example Value
|-
| Data source* || Data source imported from .rptdesign file || "PMSM_DB_TEST"
|-
| Mapped on || itmSUITE® data source item to which report template can refers for data extraction. If it is empty, data source defined in .rptdesign file is used || "PMSM DB Test"
|-
| Type* || Connection type to data source (always JDBC) || "JDBC"
|-
|}

<ol>
<li value=4>Click on '''Save''' button to save report template settings</li>
</ol>

==== Add report on itmSUITE® menu ====
After report instance has been created on '''''Report Management''''', it needs to add a report entry in itmSUITE® menu.

[[File:reportMenu.png|centre|frame]]

Report menu entry is configurable on the '''''General > Company > Main Navigation Menu''''' in ''Not Used/Reporting'' section. 
'''Important:''' it needs to repeat ''administrator'' login in order that report entry can be dragged and dropped from ''Not Used/Reporting'' section to ''Main Navigation Menu section''

Finally report can be run by assigned users from itmSUITE® menu entry configured by ''administrator''.

REP - Reporting

2018-06-18T14:09:05Z

Luca.pandolfo: /* Add report on itmSUITE® menu */

REP is an optional itmSUITE® module that defines functionality to manage and excute reports created by Eclipse BIRT Designer tool. 
It allows to load one or more report templates (BIRT.rptdesign file) and to create and to execute report instances through the BIRT Viewer integrated on itmSUITE®.

=== BIRT Architecture ===
BIRT (Business Intelligence Reporting Tool)is an open source tool installed as Eclipse IDE plug-in for report developing. It has origin from collaboration between Actuate (along with IBM) and Eclipse.org open source community. 
BIRT is a Java based tool that allows to extract data from many data source types for report generation in several output format (pdf, xlsx, docx, etc.).

[[File:Birt_Architecture.png|centre|thumb|500x500px|Birt Architecture]]

BIRT architecture includes two main components:
# Report Designer: a UI component to create report template (.rptdesign file)
# Report Engine: runtime component for report rendering

The Design Engine generates a .rptdesign file(in XML format) structured according to configurations applied by user (by BIRT Designer) and the Report Engine, through BIRT Viewer, parses it and renders it as report in html (or other formats).

=== BIRT Report on itmSUITE® ===
In itmSUITE®, the steps required to upload and execute BIRT report previously created through the BIRT Designer are following:
#Data source configuration
#Load report template (.rptdesign file)
#Create a report instance
#Add report on menu and execute it

==== Data Source Configuration ====
In itmSUITE®, BIRT report data can be extracted only from data sources connected to database.
Data Source settings are accessible on the '''''General > Company > Report Engine > Data Source''''' menu.

[[File:dataSource.png|centre|frame|Data Source list - more data source items can be created]]

Data source creation steps:
# Click on '''Add New''' button
# Fill following fields (* mandatory):
{| class="wikitable"
! Field Name !! Description !! Example Value
|-
| Name* || Logic data source item name || "Sample DB"
|-
| Description || Data source item description || "Sample data source"
|-
| Company* || Company to which data source item is assigned || "Sample Company"
|-
| Status* || Configurable Active/Inactive statuses || "Active"
|-
| Type* || Driver type used to connect to data source || "JDBC"
|-
| Data Driver* || Driver used to connect to data source || "MSSQL"
|-
| DB Server* || URL (or IP) of data source server || "192.168.10.5"
|-
| Port* || Connection data source port || "1433"
|-
| DB Name* || Database name to which data source item refers || "PMSM_SAMPLE_DB"
|-
| Username* || Username used to connect to database || -
|-
| Password* || Password used to connect to database || -
|-
|}
<ol>
<li value=3>Click on '''Check And Save''' button to check database connection and to save data source settings</li>
</ol>

==== Load report template ====
Report template (.rptdesign) file defines the report structure in a well-formed XML document.
In itmSUITE®, a report template can be associated to more report instances. Report template configuration is accessible on the '''''General > Company > Report Engine > Report template'''''

[[File:reportTemplateList.png|centre|frame]]

The report template creation requires following steps:
# Click on '''Add New''' button
# Fill following fields on ''General'' tab:
{| class="wikitable"
! Field Name !! Description !! Example Value
|-
| Name* || Logic report template name || "Sample Report Template"
|-
| Description || Report template description || "A report tamplate as sample"
|-
| Status* || Configurable Active/Inactive statuses || "Active"
|-
| BIRT Report Template* || Load .rptdesign file || "Sample_Report_Template"
|-
|}
<ol>
<li value=3>Fill the following fields on ''Data source'' tab:</li>
</ol>
{| class="wikitable"
! Field Name !! Description !! Example Value
|-
| Data source* || Data source imported from .rptdesign file || "PMSM_DB_TEST"
|-
| Mapped on || itmSUITE® data source item to which report template can refers for data extraction. If it is empty, data source defined in .rptdesign file is used || "PMSM DB Test"
|-
| Type* || Connection type to data source (always JDBC) || "JDBC"
|-
|}

<ol>
<li value=4>Click on '''Save''' button to save report template settings</li>
</ol>

==== Create Report Instance ====
Report instance defines a BIRT report that can refer to only a report template and can be launched directly from itmSUITE® menu.
A report instance is configurable on the '''''General > Company > Report Engine > Report Management''''' menu

[[File:reportManagementList.png|centre|frame]]

The report instance creation requires following steps:
# Click on '''Add New''' button
# Fill following fields on ''General'' tab:
{| class="wikitable"
! Field Name !! Description !! Example Value
|-
| Name* || Report name || "Sample Report"
|-
| Description || Report description || "A sample report"
|-
| Status* || Configurable Active/Inactive statuses. If Inactive report cannot be shown on itmSUITE® menu || "Active"
|-
| Template* || Report template name to which report instance refers || "Sample_Report_Template"
|-
|}
<ol>
<li ''value=3>Check that all report parameters are visible on ''Parameters'' tab:</li>
</ol>

[[File:reportParameter.png|centre|frame]]

<ol>
<li value=4>On ''Filter Designer'' tab, it is possible to customize a report launcher box (at default it contain''''Italic text''s the same parameters defined on report template):</li>
*Hide/show report parameters
*Add/delete parameters sections
*Edit each report parameter item (read-only,label editing, mandatory, etc.)
*Add Output field to extract report in several format (html, word, excel, pdf, ppt)
*Add Open Report in New Window check box to visualize report ouput on a new tab

[[File:reportDesigner.png|centre|frame]]

It is possible to see a report launcher preview by clicking on '''Preview''' button
<li>On ''Assignments'' tab, set report visibility grants on itmSUITE® menu

[[File:reportAssignment.png|centre|frame]]

by following filter fields:

{| class="wikitable"
! Filter Name !! Description
|-
| Role || it limits visibility to users that belong to following roles: ''superadmin'', ''administrator'', ''manager'', ''pm'', ''resource'', ''requester''. It works also as prefilter for Resource filter
|-
| Resource || it limits visibility to selected ''resources''
|-
| Group || it limits visibility to members of selected ''groups''
|-
| Organization unit || it limits visibility to resources that belong to selected ''organization units''
|-
|}
</li>
<li>
On Filter tab, it is possible to manage personal filters selectable by user directly from report

[[File:reportFilter.png|centre|frame]]
</li>
</ol>

==== Load report template ====
Report template (.rptdesign) file defines the report structure in a well-formed XML document.
In itmSUITE®, a report template can be associated to more report instances. Report template configuration is accessible on the '''''General > Company > Report Engine > Report template'''''

[[File:reportTemplateList.png|centre|frame]]

The report template creation requires following steps:
# Click on '''Add New''' button
# Fill following fields on ''General'' tab:
{| class="wikitable"
! Field Name !! Description !! Example Value
|-
| Name* || Logic report template name || "Sample Report Template"
|-
| Description || Report template description || "A report tamplate as sample"
|-
| Status* || Configurable Active/Inactive statuses || "Active"
|-
| BIRT Report Template* || Load .rptdesign file || "Sample_Report_Template"
|-
|}
<ol>
<li value=3>Fill the following fields on ''Data source'' tab:</li>
</ol>
{| class="wikitable"
! Field Name !! Description !! Example Value
|-
| Data source* || Data source imported from .rptdesign file || "PMSM_DB_TEST"
|-
| Mapped on || itmSUITE® data source item to which report template can refers for data extraction. If it is empty, data source defined in .rptdesign file is used || "PMSM DB Test"
|-
| Type* || Connection type to data source (always JDBC) || "JDBC"
|-
|}

<ol>
<li value=4>Click on '''Save''' button to save report template settings</li>
</ol>

==== Add report on itmSUITE® menu ====
After report instance has been created on '''''Report Management''''', it needs to add a report entry in itmSUITE® menu.

[[File:reportMenu.png|centre|frame]]

Report menu entry is configurable on the '''''General > Company > Main Navigation Menu''''' in ''Not Used/Reporting'' section. 
'''Important:''' it needs to repeat ''administrator'' login in order that report entry can be dragged and dropped from ''Not Used/Reporting'' section to ''Main Navigation Menu section''

Finally report can be run by assigned users from itmSUITE® menu entry configured by ''administrator''.

REP - Reporting

2018-06-18T13:56:05Z

Luca.pandolfo: /* Add report on itmSUITE® menu */

REP is an optional itmSUITE® module that defines functionality to manage and excute reports created by Eclipse BIRT Designer tool. 
It allows to load one or more report templates (BIRT.rptdesign file) and to create and to execute report instances through the BIRT Viewer integrated on itmSUITE®.

=== BIRT Architecture ===
BIRT (Business Intelligence Reporting Tool)is an open source tool installed as Eclipse IDE plug-in for report developing. It has origin from collaboration between Actuate (along with IBM) and Eclipse.org open source community. 
BIRT is a Java based tool that allows to extract data from many data source types for report generation in several output format (pdf, xlsx, docx, etc.).

[[File:Birt_Architecture.png|centre|thumb|500x500px|Birt Architecture]]

BIRT architecture includes two main components:
# Report Designer: a UI component to create report template (.rptdesign file)
# Report Engine: runtime component for report rendering

The Design Engine generates a .rptdesign file(in XML format) structured according to configurations applied by user (by BIRT Designer) and the Report Engine, through BIRT Viewer, parses it and renders it as report in html (or other formats).

=== BIRT Report on itmSUITE® ===
In itmSUITE®, the steps required to upload and execute BIRT report previously created through the BIRT Designer are following:
#Data source configuration
#Load report template (.rptdesign file)
#Create a report instance
#Add report on menu and execute it

==== Data Source Configuration ====
In itmSUITE®, BIRT report data can be extracted only from data sources connected to database.
Data Source settings are accessible on the '''''General > Company > Report Engine > Data Source''''' menu.

[[File:dataSource.png|centre|frame|Data Source list - more data source items can be created]]

Data source creation steps:
# Click on '''Add New''' button
# Fill following fields (* mandatory):
{| class="wikitable"
! Field Name !! Description !! Example Value
|-
| Name* || Logic data source item name || "Sample DB"
|-
| Description || Data source item description || "Sample data source"
|-
| Company* || Company to which data source item is assigned || "Sample Company"
|-
| Status* || Configurable Active/Inactive statuses || "Active"
|-
| Type* || Driver type used to connect to data source || "JDBC"
|-
| Data Driver* || Driver used to connect to data source || "MSSQL"
|-
| DB Server* || URL (or IP) of data source server || "192.168.10.5"
|-
| Port* || Connection data source port || "1433"
|-
| DB Name* || Database name to which data source item refers || "PMSM_SAMPLE_DB"
|-
| Username* || Username used to connect to database || -
|-
| Password* || Password used to connect to database || -
|-
|}
<ol>
<li value=3>Click on '''Check And Save''' button to check database connection and to save data source settings</li>
</ol>

==== Load report template ====
Report template (.rptdesign) file defines the report structure in a well-formed XML document.
In itmSUITE®, a report template can be associated to more report instances. Report template configuration is accessible on the '''''General > Company > Report Engine > Report template'''''

[[File:reportTemplateList.png|centre|frame]]

The report template creation requires following steps:
# Click on '''Add New''' button
# Fill following fields on ''General'' tab:
{| class="wikitable"
! Field Name !! Description !! Example Value
|-
| Name* || Logic report template name || "Sample Report Template"
|-
| Description || Report template description || "A report tamplate as sample"
|-
| Status* || Configurable Active/Inactive statuses || "Active"
|-
| BIRT Report Template* || Load .rptdesign file || "Sample_Report_Template"
|-
|}
<ol>
<li value=3>Fill the following fields on ''Data source'' tab:</li>
</ol>
{| class="wikitable"
! Field Name !! Description !! Example Value
|-
| Data source* || Data source imported from .rptdesign file || "PMSM_DB_TEST"
|-
| Mapped on || itmSUITE® data source item to which report template can refers for data extraction. If it is empty, data source defined in .rptdesign file is used || "PMSM DB Test"
|-
| Type* || Connection type to data source (always JDBC) || "JDBC"
|-
|}

<ol>
<li value=4>Click on '''Save''' button to save report template settings</li>
</ol>

==== Create Report Instance ====
Report instance defines a BIRT report that can refer to only a report template and can be launched directly from itmSUITE® menu.
A report instance is configurable on the '''''General > Company > Report Engine > Report Management''''' menu

[[File:reportManagementList.png|centre|frame]]

The report instance creation requires following steps:
# Click on '''Add New''' button
# Fill following fields on ''General'' tab:
{| class="wikitable"
! Field Name !! Description !! Example Value
|-
| Name* || Report name || "Sample Report"
|-
| Description || Report description || "A sample report"
|-
| Status* || Configurable Active/Inactive statuses. If Inactive report cannot be shown on itmSUITE® menu || "Active"
|-
| Template* || Report template name to which report instance refers || "Sample_Report_Template"
|-
|}
<ol>
<li ''value=3>Check that all report parameters are visible on ''Parameters'' tab:</li>
</ol>

[[File:reportParameter.png|centre|frame]]

<ol>
<li value=4>On ''Filter Designer'' tab, it is possible to customize a report launcher box (at default it contain''''Italic text''s the same parameters defined on report template):</li>
*Hide/show report parameters
*Add/delete parameters sections
*Edit each report parameter item (read-only,label editing, mandatory, etc.)
*Add Output field to extract report in several format (html, word, excel, pdf, ppt)
*Add Open Report in New Window check box to visualize report ouput on a new tab

[[File:reportDesigner.png|centre|frame]]

It is possible to see a report launcher preview by clicking on '''Preview''' button
<li>On ''Assignments'' tab, set report visibility grants on itmSUITE® menu

[[File:reportAssignment.png|centre|frame]]

by following filter fields:

{| class="wikitable"
! Filter Name !! Description
|-
| Role || it limits visibility to users that belong to following roles: ''superadmin'', ''administrator'', ''manager'', ''pm'', ''resource'', ''requester''. It works also as prefilter for Resource filter
|-
| Resource || it limits visibility to selected ''resources''
|-
| Group || it limits visibility to members of selected ''groups''
|-
| Organization unit || it limits visibility to resources that belong to selected ''organization units''
|-
|}
</li>
<li>
On Filter tab, it is possible to manage personal filters selectable by user directly from report

[[File:reportFilter.png|centre|frame]]
</li>
</ol>

==== Load report template ====
Report template (.rptdesign) file defines the report structure in a well-formed XML document.
In itmSUITE®, a report template can be associated to more report instances. Report template configuration is accessible on the '''''General > Company > Report Engine > Report template'''''

[[File:reportTemplateList.png|centre|frame]]

The report template creation requires following steps:
# Click on '''Add New''' button
# Fill following fields on ''General'' tab:
{| class="wikitable"
! Field Name !! Description !! Example Value
|-
| Name* || Logic report template name || "Sample Report Template"
|-
| Description || Report template description || "A report tamplate as sample"
|-
| Status* || Configurable Active/Inactive statuses || "Active"
|-
| BIRT Report Template* || Load .rptdesign file || "Sample_Report_Template"
|-
|}
<ol>
<li value=3>Fill the following fields on ''Data source'' tab:</li>
</ol>
{| class="wikitable"
! Field Name !! Description !! Example Value
|-
| Data source* || Data source imported from .rptdesign file || "PMSM_DB_TEST"
|-
| Mapped on || itmSUITE® data source item to which report template can refers for data extraction. If it is empty, data source defined in .rptdesign file is used || "PMSM DB Test"
|-
| Type* || Connection type to data source (always JDBC) || "JDBC"
|-
|}

<ol>
<li value=4>Click on '''Save''' button to save report template settings</li>
</ol>

==== Add report on itmSUITE® menu ====
After report instance has been created on '''''Report Management''''', it needs to add a report entry in itmSUITE® menu.

[[File:reportMenu.png|centre|frame]]

Report menu entry is configurable on the '''''General > Company > Main Navigation Menu''''' in ''Not Used/Reporting'' section. 
'''Important:''' it needs to repeat user login in order to report entry can be dragged and dropped from ''Not Used/Reporting'' section to ''Main Navigation Menu section''

REP - Reporting

2018-06-18T13:54:35Z

Luca.pandolfo: /* Add report on itmSUITE® menu */

REP is an optional itmSUITE® module that defines functionality to manage and excute reports created by Eclipse BIRT Designer tool. 
It allows to load one or more report templates (BIRT.rptdesign file) and to create and to execute report instances through the BIRT Viewer integrated on itmSUITE®.

=== BIRT Architecture ===
BIRT (Business Intelligence Reporting Tool)is an open source tool installed as Eclipse IDE plug-in for report developing. It has origin from collaboration between Actuate (along with IBM) and Eclipse.org open source community. 
BIRT is a Java based tool that allows to extract data from many data source types for report generation in several output format (pdf, xlsx, docx, etc.).

[[File:Birt_Architecture.png|centre|thumb|500x500px|Birt Architecture]]

BIRT architecture includes two main components:
# Report Designer: a UI component to create report template (.rptdesign file)
# Report Engine: runtime component for report rendering

The Design Engine generates a .rptdesign file(in XML format) structured according to configurations applied by user (by BIRT Designer) and the Report Engine, through BIRT Viewer, parses it and renders it as report in html (or other formats).

=== BIRT Report on itmSUITE® ===
In itmSUITE®, the steps required to upload and execute BIRT report previously created through the BIRT Designer are following:
#Data source configuration
#Load report template (.rptdesign file)
#Create a report instance
#Add report on menu and execute it

==== Data Source Configuration ====
In itmSUITE®, BIRT report data can be extracted only from data sources connected to database.
Data Source settings are accessible on the '''''General > Company > Report Engine > Data Source''''' menu.

[[File:dataSource.png|centre|frame|Data Source list - more data source items can be created]]

Data source creation steps:
# Click on '''Add New''' button
# Fill following fields (* mandatory):
{| class="wikitable"
! Field Name !! Description !! Example Value
|-
| Name* || Logic data source item name || "Sample DB"
|-
| Description || Data source item description || "Sample data source"
|-
| Company* || Company to which data source item is assigned || "Sample Company"
|-
| Status* || Configurable Active/Inactive statuses || "Active"
|-
| Type* || Driver type used to connect to data source || "JDBC"
|-
| Data Driver* || Driver used to connect to data source || "MSSQL"
|-
| DB Server* || URL (or IP) of data source server || "192.168.10.5"
|-
| Port* || Connection data source port || "1433"
|-
| DB Name* || Database name to which data source item refers || "PMSM_SAMPLE_DB"
|-
| Username* || Username used to connect to database || -
|-
| Password* || Password used to connect to database || -
|-
|}
<ol>
<li value=3>Click on '''Check And Save''' button to check database connection and to save data source settings</li>
</ol>

==== Load report template ====
Report template (.rptdesign) file defines the report structure in a well-formed XML document.
In itmSUITE®, a report template can be associated to more report instances. Report template configuration is accessible on the '''''General > Company > Report Engine > Report template'''''

[[File:reportTemplateList.png|centre|frame]]

The report template creation requires following steps:
# Click on '''Add New''' button
# Fill following fields on ''General'' tab:
{| class="wikitable"
! Field Name !! Description !! Example Value
|-
| Name* || Logic report template name || "Sample Report Template"
|-
| Description || Report template description || "A report tamplate as sample"
|-
| Status* || Configurable Active/Inactive statuses || "Active"
|-
| BIRT Report Template* || Load .rptdesign file || "Sample_Report_Template"
|-
|}
<ol>
<li value=3>Fill the following fields on ''Data source'' tab:</li>
</ol>
{| class="wikitable"
! Field Name !! Description !! Example Value
|-
| Data source* || Data source imported from .rptdesign file || "PMSM_DB_TEST"
|-
| Mapped on || itmSUITE® data source item to which report template can refers for data extraction. If it is empty, data source defined in .rptdesign file is used || "PMSM DB Test"
|-
| Type* || Connection type to data source (always JDBC) || "JDBC"
|-
|}

<ol>
<li value=4>Click on '''Save''' button to save report template settings</li>
</ol>

==== Create Report Instance ====
Report instance defines a BIRT report that can refer to only a report template and can be launched directly from itmSUITE® menu.
A report instance is configurable on the '''''General > Company > Report Engine > Report Management''''' menu

[[File:reportManagementList.png|centre|frame]]

The report instance creation requires following steps:
# Click on '''Add New''' button
# Fill following fields on ''General'' tab:
{| class="wikitable"
! Field Name !! Description !! Example Value
|-
| Name* || Report name || "Sample Report"
|-
| Description || Report description || "A sample report"
|-
| Status* || Configurable Active/Inactive statuses. If Inactive report cannot be shown on itmSUITE® menu || "Active"
|-
| Template* || Report template name to which report instance refers || "Sample_Report_Template"
|-
|}
<ol>
<li ''value=3>Check that all report parameters are visible on ''Parameters'' tab:</li>
</ol>

[[File:reportParameter.png|centre|frame]]

<ol>
<li value=4>On ''Filter Designer'' tab, it is possible to customize a report launcher box (at default it contain''''Italic text''s the same parameters defined on report template):</li>
*Hide/show report parameters
*Add/delete parameters sections
*Edit each report parameter item (read-only,label editing, mandatory, etc.)
*Add Output field to extract report in several format (html, word, excel, pdf, ppt)
*Add Open Report in New Window check box to visualize report ouput on a new tab

[[File:reportDesigner.png|centre|frame]]

It is possible to see a report launcher preview by clicking on '''Preview''' button
<li>On ''Assignments'' tab, set report visibility grants on itmSUITE® menu

[[File:reportAssignment.png|centre|frame]]

by following filter fields:

{| class="wikitable"
! Filter Name !! Description
|-
| Role || it limits visibility to users that belong to following roles: ''superadmin'', ''administrator'', ''manager'', ''pm'', ''resource'', ''requester''. It works also as prefilter for Resource filter
|-
| Resource || it limits visibility to selected ''resources''
|-
| Group || it limits visibility to members of selected ''groups''
|-
| Organization unit || it limits visibility to resources that belong to selected ''organization units''
|-
|}
</li>
<li>
On Filter tab, it is possible to manage personal filters selectable by user directly from report

[[File:reportFilter.png|centre|frame]]
</li>
</ol>

==== Load report template ====
Report template (.rptdesign) file defines the report structure in a well-formed XML document.
In itmSUITE®, a report template can be associated to more report instances. Report template configuration is accessible on the '''''General > Company > Report Engine > Report template'''''

[[File:reportTemplateList.png|centre|frame]]

The report template creation requires following steps:
# Click on '''Add New''' button
# Fill following fields on ''General'' tab:
{| class="wikitable"
! Field Name !! Description !! Example Value
|-
| Name* || Logic report template name || "Sample Report Template"
|-
| Description || Report template description || "A report tamplate as sample"
|-
| Status* || Configurable Active/Inactive statuses || "Active"
|-
| BIRT Report Template* || Load .rptdesign file || "Sample_Report_Template"
|-
|}
<ol>
<li value=3>Fill the following fields on ''Data source'' tab:</li>
</ol>
{| class="wikitable"
! Field Name !! Description !! Example Value
|-
| Data source* || Data source imported from .rptdesign file || "PMSM_DB_TEST"
|-
| Mapped on || itmSUITE® data source item to which report template can refers for data extraction. If it is empty, data source defined in .rptdesign file is used || "PMSM DB Test"
|-
| Type* || Connection type to data source (always JDBC) || "JDBC"
|-
|}

<ol>
<li value=4>Click on '''Save''' button to save report template settings</li>
</ol>

==== Add report on itmSUITE® menu ====
After report instance has been created on '''''Report Management''''', it needs to add a report entry in itmSUITE® menu.

[[File:reportMenu.png|centre|frame]]

Report menu entry is configurable on the '''''General > Company > Main Navigation Menu''''' in ''Not Used/Reporting'' section.
'''Important:''' it needs to rerun user login in order to report entry can be dragged and dropped from ''Not Used/Reporting'' section to ''Main Navigation Menu section''

REP - Reporting

2018-06-18T13:54:14Z

Luca.pandolfo: /* Add report on itmSUITE® menu */

REP is an optional itmSUITE® module that defines functionality to manage and excute reports created by Eclipse BIRT Designer tool. 
It allows to load one or more report templates (BIRT.rptdesign file) and to create and to execute report instances through the BIRT Viewer integrated on itmSUITE®.

=== BIRT Architecture ===
BIRT (Business Intelligence Reporting Tool)is an open source tool installed as Eclipse IDE plug-in for report developing. It has origin from collaboration between Actuate (along with IBM) and Eclipse.org open source community. 
BIRT is a Java based tool that allows to extract data from many data source types for report generation in several output format (pdf, xlsx, docx, etc.).

[[File:Birt_Architecture.png|centre|thumb|500x500px|Birt Architecture]]

BIRT architecture includes two main components:
# Report Designer: a UI component to create report template (.rptdesign file)
# Report Engine: runtime component for report rendering

The Design Engine generates a .rptdesign file(in XML format) structured according to configurations applied by user (by BIRT Designer) and the Report Engine, through BIRT Viewer, parses it and renders it as report in html (or other formats).

=== BIRT Report on itmSUITE® ===
In itmSUITE®, the steps required to upload and execute BIRT report previously created through the BIRT Designer are following:
#Data source configuration
#Load report template (.rptdesign file)
#Create a report instance
#Add report on menu and execute it

==== Data Source Configuration ====
In itmSUITE®, BIRT report data can be extracted only from data sources connected to database.
Data Source settings are accessible on the '''''General > Company > Report Engine > Data Source''''' menu.

[[File:dataSource.png|centre|frame|Data Source list - more data source items can be created]]

Data source creation steps:
# Click on '''Add New''' button
# Fill following fields (* mandatory):
{| class="wikitable"
! Field Name !! Description !! Example Value
|-
| Name* || Logic data source item name || "Sample DB"
|-
| Description || Data source item description || "Sample data source"
|-
| Company* || Company to which data source item is assigned || "Sample Company"
|-
| Status* || Configurable Active/Inactive statuses || "Active"
|-
| Type* || Driver type used to connect to data source || "JDBC"
|-
| Data Driver* || Driver used to connect to data source || "MSSQL"
|-
| DB Server* || URL (or IP) of data source server || "192.168.10.5"
|-
| Port* || Connection data source port || "1433"
|-
| DB Name* || Database name to which data source item refers || "PMSM_SAMPLE_DB"
|-
| Username* || Username used to connect to database || -
|-
| Password* || Password used to connect to database || -
|-
|}
<ol>
<li value=3>Click on '''Check And Save''' button to check database connection and to save data source settings</li>
</ol>

==== Load report template ====
Report template (.rptdesign) file defines the report structure in a well-formed XML document.
In itmSUITE®, a report template can be associated to more report instances. Report template configuration is accessible on the '''''General > Company > Report Engine > Report template'''''

[[File:reportTemplateList.png|centre|frame]]

The report template creation requires following steps:
# Click on '''Add New''' button
# Fill following fields on ''General'' tab:
{| class="wikitable"
! Field Name !! Description !! Example Value
|-
| Name* || Logic report template name || "Sample Report Template"
|-
| Description || Report template description || "A report tamplate as sample"
|-
| Status* || Configurable Active/Inactive statuses || "Active"
|-
| BIRT Report Template* || Load .rptdesign file || "Sample_Report_Template"
|-
|}
<ol>
<li value=3>Fill the following fields on ''Data source'' tab:</li>
</ol>
{| class="wikitable"
! Field Name !! Description !! Example Value
|-
| Data source* || Data source imported from .rptdesign file || "PMSM_DB_TEST"
|-
| Mapped on || itmSUITE® data source item to which report template can refers for data extraction. If it is empty, data source defined in .rptdesign file is used || "PMSM DB Test"
|-
| Type* || Connection type to data source (always JDBC) || "JDBC"
|-
|}

<ol>
<li value=4>Click on '''Save''' button to save report template settings</li>
</ol>

==== Create Report Instance ====
Report instance defines a BIRT report that can refer to only a report template and can be launched directly from itmSUITE® menu.
A report instance is configurable on the '''''General > Company > Report Engine > Report Management''''' menu

[[File:reportManagementList.png|centre|frame]]

The report instance creation requires following steps:
# Click on '''Add New''' button
# Fill following fields on ''General'' tab:
{| class="wikitable"
! Field Name !! Description !! Example Value
|-
| Name* || Report name || "Sample Report"
|-
| Description || Report description || "A sample report"
|-
| Status* || Configurable Active/Inactive statuses. If Inactive report cannot be shown on itmSUITE® menu || "Active"
|-
| Template* || Report template name to which report instance refers || "Sample_Report_Template"
|-
|}
<ol>
<li ''value=3>Check that all report parameters are visible on ''Parameters'' tab:</li>
</ol>

[[File:reportParameter.png|centre|frame]]

<ol>
<li value=4>On ''Filter Designer'' tab, it is possible to customize a report launcher box (at default it contain''''Italic text''s the same parameters defined on report template):</li>
*Hide/show report parameters
*Add/delete parameters sections
*Edit each report parameter item (read-only,label editing, mandatory, etc.)
*Add Output field to extract report in several format (html, word, excel, pdf, ppt)
*Add Open Report in New Window check box to visualize report ouput on a new tab

[[File:reportDesigner.png|centre|frame]]

It is possible to see a report launcher preview by clicking on '''Preview''' button
<li>On ''Assignments'' tab, set report visibility grants on itmSUITE® menu

[[File:reportAssignment.png|centre|frame]]

by following filter fields:

{| class="wikitable"
! Filter Name !! Description
|-
| Role || it limits visibility to users that belong to following roles: ''superadmin'', ''administrator'', ''manager'', ''pm'', ''resource'', ''requester''. It works also as prefilter for Resource filter
|-
| Resource || it limits visibility to selected ''resources''
|-
| Group || it limits visibility to members of selected ''groups''
|-
| Organization unit || it limits visibility to resources that belong to selected ''organization units''
|-
|}
</li>
<li>
On Filter tab, it is possible to manage personal filters selectable by user directly from report

[[File:reportFilter.png|centre|frame]]
</li>
</ol>

==== Load report template ====
Report template (.rptdesign) file defines the report structure in a well-formed XML document.
In itmSUITE®, a report template can be associated to more report instances. Report template configuration is accessible on the '''''General > Company > Report Engine > Report template'''''

[[File:reportTemplateList.png|centre|frame]]

The report template creation requires following steps:
# Click on '''Add New''' button
# Fill following fields on ''General'' tab:
{| class="wikitable"
! Field Name !! Description !! Example Value
|-
| Name* || Logic report template name || "Sample Report Template"
|-
| Description || Report template description || "A report tamplate as sample"
|-
| Status* || Configurable Active/Inactive statuses || "Active"
|-
| BIRT Report Template* || Load .rptdesign file || "Sample_Report_Template"
|-
|}
<ol>
<li value=3>Fill the following fields on ''Data source'' tab:</li>
</ol>
{| class="wikitable"
! Field Name !! Description !! Example Value
|-
| Data source* || Data source imported from .rptdesign file || "PMSM_DB_TEST"
|-
| Mapped on || itmSUITE® data source item to which report template can refers for data extraction. If it is empty, data source defined in .rptdesign file is used || "PMSM DB Test"
|-
| Type* || Connection type to data source (always JDBC) || "JDBC"
|-
|}

<ol>
<li value=4>Click on '''Save''' button to save report template settings</li>
</ol>

==== Add report on itmSUITE® menu ====
After report instance has been created on '''''Report Management''''', it needs to add an report entry in itmSUITE® menu.

[[File:reportMenu.png|centre|frame]]

Report menu entry is configurable on the '''''General > Company > Main Navigation Menu''''' in ''Not Used/Reporting'' section.
'''Important:''' it needs to rerun user login in order to report entry can be dragged and dropped from ''Not Used/Reporting'' section to ''Main Navigation Menu section''

REP - Reporting

2018-06-18T13:53:51Z

Luca.pandolfo: /* Add report on itmSUITE® menu */

REP is an optional itmSUITE® module that defines functionality to manage and excute reports created by Eclipse BIRT Designer tool. 
It allows to load one or more report templates (BIRT.rptdesign file) and to create and to execute report instances through the BIRT Viewer integrated on itmSUITE®.

=== BIRT Architecture ===
BIRT (Business Intelligence Reporting Tool)is an open source tool installed as Eclipse IDE plug-in for report developing. It has origin from collaboration between Actuate (along with IBM) and Eclipse.org open source community. 
BIRT is a Java based tool that allows to extract data from many data source types for report generation in several output format (pdf, xlsx, docx, etc.).

[[File:Birt_Architecture.png|centre|thumb|500x500px|Birt Architecture]]

BIRT architecture includes two main components:
# Report Designer: a UI component to create report template (.rptdesign file)
# Report Engine: runtime component for report rendering

The Design Engine generates a .rptdesign file(in XML format) structured according to configurations applied by user (by BIRT Designer) and the Report Engine, through BIRT Viewer, parses it and renders it as report in html (or other formats).

=== BIRT Report on itmSUITE® ===
In itmSUITE®, the steps required to upload and execute BIRT report previously created through the BIRT Designer are following:
#Data source configuration
#Load report template (.rptdesign file)
#Create a report instance
#Add report on menu and execute it

==== Data Source Configuration ====
In itmSUITE®, BIRT report data can be extracted only from data sources connected to database.
Data Source settings are accessible on the '''''General > Company > Report Engine > Data Source''''' menu.

[[File:dataSource.png|centre|frame|Data Source list - more data source items can be created]]

Data source creation steps:
# Click on '''Add New''' button
# Fill following fields (* mandatory):
{| class="wikitable"
! Field Name !! Description !! Example Value
|-
| Name* || Logic data source item name || "Sample DB"
|-
| Description || Data source item description || "Sample data source"
|-
| Company* || Company to which data source item is assigned || "Sample Company"
|-
| Status* || Configurable Active/Inactive statuses || "Active"
|-
| Type* || Driver type used to connect to data source || "JDBC"
|-
| Data Driver* || Driver used to connect to data source || "MSSQL"
|-
| DB Server* || URL (or IP) of data source server || "192.168.10.5"
|-
| Port* || Connection data source port || "1433"
|-
| DB Name* || Database name to which data source item refers || "PMSM_SAMPLE_DB"
|-
| Username* || Username used to connect to database || -
|-
| Password* || Password used to connect to database || -
|-
|}
<ol>
<li value=3>Click on '''Check And Save''' button to check database connection and to save data source settings</li>
</ol>

==== Load report template ====
Report template (.rptdesign) file defines the report structure in a well-formed XML document.
In itmSUITE®, a report template can be associated to more report instances. Report template configuration is accessible on the '''''General > Company > Report Engine > Report template'''''

[[File:reportTemplateList.png|centre|frame]]

The report template creation requires following steps:
# Click on '''Add New''' button
# Fill following fields on ''General'' tab:
{| class="wikitable"
! Field Name !! Description !! Example Value
|-
| Name* || Logic report template name || "Sample Report Template"
|-
| Description || Report template description || "A report tamplate as sample"
|-
| Status* || Configurable Active/Inactive statuses || "Active"
|-
| BIRT Report Template* || Load .rptdesign file || "Sample_Report_Template"
|-
|}
<ol>
<li value=3>Fill the following fields on ''Data source'' tab:</li>
</ol>
{| class="wikitable"
! Field Name !! Description !! Example Value
|-
| Data source* || Data source imported from .rptdesign file || "PMSM_DB_TEST"
|-
| Mapped on || itmSUITE® data source item to which report template can refers for data extraction. If it is empty, data source defined in .rptdesign file is used || "PMSM DB Test"
|-
| Type* || Connection type to data source (always JDBC) || "JDBC"
|-
|}

<ol>
<li value=4>Click on '''Save''' button to save report template settings</li>
</ol>

==== Create Report Instance ====
Report instance defines a BIRT report that can refer to only a report template and can be launched directly from itmSUITE® menu.
A report instance is configurable on the '''''General > Company > Report Engine > Report Management''''' menu

[[File:reportManagementList.png|centre|frame]]

The report instance creation requires following steps:
# Click on '''Add New''' button
# Fill following fields on ''General'' tab:
{| class="wikitable"
! Field Name !! Description !! Example Value
|-
| Name* || Report name || "Sample Report"
|-
| Description || Report description || "A sample report"
|-
| Status* || Configurable Active/Inactive statuses. If Inactive report cannot be shown on itmSUITE® menu || "Active"
|-
| Template* || Report template name to which report instance refers || "Sample_Report_Template"
|-
|}
<ol>
<li ''value=3>Check that all report parameters are visible on ''Parameters'' tab:</li>
</ol>

[[File:reportParameter.png|centre|frame]]

<ol>
<li value=4>On ''Filter Designer'' tab, it is possible to customize a report launcher box (at default it contain''''Italic text''s the same parameters defined on report template):</li>
*Hide/show report parameters
*Add/delete parameters sections
*Edit each report parameter item (read-only,label editing, mandatory, etc.)
*Add Output field to extract report in several format (html, word, excel, pdf, ppt)
*Add Open Report in New Window check box to visualize report ouput on a new tab

[[File:reportDesigner.png|centre|frame]]

It is possible to see a report launcher preview by clicking on '''Preview''' button
<li>On ''Assignments'' tab, set report visibility grants on itmSUITE® menu

[[File:reportAssignment.png|centre|frame]]

by following filter fields:

{| class="wikitable"
! Filter Name !! Description
|-
| Role || it limits visibility to users that belong to following roles: ''superadmin'', ''administrator'', ''manager'', ''pm'', ''resource'', ''requester''. It works also as prefilter for Resource filter
|-
| Resource || it limits visibility to selected ''resources''
|-
| Group || it limits visibility to members of selected ''groups''
|-
| Organization unit || it limits visibility to resources that belong to selected ''organization units''
|-
|}
</li>
<li>
On Filter tab, it is possible to manage personal filters selectable by user directly from report

[[File:reportFilter.png|centre|frame]]
</li>
</ol>

==== Load report template ====
Report template (.rptdesign) file defines the report structure in a well-formed XML document.
In itmSUITE®, a report template can be associated to more report instances. Report template configuration is accessible on the '''''General > Company > Report Engine > Report template'''''

[[File:reportTemplateList.png|centre|frame]]

The report template creation requires following steps:
# Click on '''Add New''' button
# Fill following fields on ''General'' tab:
{| class="wikitable"
! Field Name !! Description !! Example Value
|-
| Name* || Logic report template name || "Sample Report Template"
|-
| Description || Report template description || "A report tamplate as sample"
|-
| Status* || Configurable Active/Inactive statuses || "Active"
|-
| BIRT Report Template* || Load .rptdesign file || "Sample_Report_Template"
|-
|}
<ol>
<li value=3>Fill the following fields on ''Data source'' tab:</li>
</ol>
{| class="wikitable"
! Field Name !! Description !! Example Value
|-
| Data source* || Data source imported from .rptdesign file || "PMSM_DB_TEST"
|-
| Mapped on || itmSUITE® data source item to which report template can refers for data extraction. If it is empty, data source defined in .rptdesign file is used || "PMSM DB Test"
|-
| Type* || Connection type to data source (always JDBC) || "JDBC"
|-
|}

<ol>
<li value=4>Click on '''Save''' button to save report template settings</li>
</ol>

==== Add report on itmSUITE® menu ====
After report instance has been created on '''''Report Management''''', it needs to add an report entry in itmSUITE® menu.

[[File:reportMenu.png|centre|frame]]

Report menu entry is configurable on the '''''General > Company > Main Navigation Menu''''' in ''Not Used/Reporting'' section. '''Important:''' it needs to rerun user login in order to report entry can be dragged and dropped from ''Not Used/Reporting'' section to ''Main Navigation Menu section''

REP - Reporting

2018-06-18T11:03:43Z

Luca.pandolfo: /* BIRT Report on itmSUITE® */

REP is an optional itmSUITE® module that defines functionality to manage and excute reports created by Eclipse BIRT Designer tool. 
It allows to load one or more report templates (BIRT.rptdesign file) and to create and to execute report instances through the BIRT Viewer integrated on itmSUITE®.

=== BIRT Architecture ===
BIRT (Business Intelligence Reporting Tool)is an open source tool installed as Eclipse IDE plug-in for report developing. It has origin from collaboration between Actuate (along with IBM) and Eclipse.org open source community. 
BIRT is a Java based tool that allows to extract data from many data source types for report generation in several output format (pdf, xlsx, docx, etc.).

[[File:Birt_Architecture.png|centre|thumb|500x500px|Birt Architecture]]

BIRT architecture includes two main components:
# Report Designer: a UI component to create report template (.rptdesign file)
# Report Engine: runtime component for report rendering

The Design Engine generates a .rptdesign file(in XML format) structured according to configurations applied by user (by BIRT Designer) and the Report Engine, through BIRT Viewer, parses it and renders it as report in html (or other formats).

=== BIRT Report on itmSUITE® ===
In itmSUITE®, the steps required to upload and execute BIRT report previously created through the BIRT Designer are following:
#Data source configuration
#Load report template (.rptdesign file)
#Create a report instance
#Add report on menu and execute it

==== Data Source Configuration ====
In itmSUITE®, BIRT report data can be extracted only from data sources connected to database.
Data Source settings are accessible on the '''''General > Company > Report Engine > Data Source''''' menu.

[[File:dataSource.png|centre|frame|Data Source list - more data source items can be created]]

Data source creation steps:
# Click on '''Add New''' button
# Fill following fields (* mandatory):
{| class="wikitable"
! Field Name !! Description !! Example Value
|-
| Name* || Logic data source item name || "Sample DB"
|-
| Description || Data source item description || "Sample data source"
|-
| Company* || Company to which data source item is assigned || "Sample Company"
|-
| Status* || Configurable Active/Inactive statuses || "Active"
|-
| Type* || Driver type used to connect to data source || "JDBC"
|-
| Data Driver* || Driver used to connect to data source || "MSSQL"
|-
| DB Server* || URL (or IP) of data source server || "192.168.10.5"
|-
| Port* || Connection data source port || "1433"
|-
| DB Name* || Database name to which data source item refers || "PMSM_SAMPLE_DB"
|-
| Username* || Username used to connect to database || -
|-
| Password* || Password used to connect to database || -
|-
|}
<ol>
<li value=3>Click on '''Check And Save''' button to check database connection and to save data source settings</li>
</ol>

==== Load report template ====
Report template (.rptdesign) file defines the report structure in a well-formed XML document.
In itmSUITE®, a report template can be associated to more report instances. Report template configuration is accessible on the '''''General > Company > Report Engine > Report template'''''

[[File:reportTemplateList.png|centre|frame]]

The report template creation requires following steps:
# Click on '''Add New''' button
# Fill following fields on ''General'' tab:
{| class="wikitable"
! Field Name !! Description !! Example Value
|-
| Name* || Logic report template name || "Sample Report Template"
|-
| Description || Report template description || "A report tamplate as sample"
|-
| Status* || Configurable Active/Inactive statuses || "Active"
|-
| BIRT Report Template* || Load .rptdesign file || "Sample_Report_Template"
|-
|}
<ol>
<li value=3>Fill the following fields on ''Data source'' tab:</li>
</ol>
{| class="wikitable"
! Field Name !! Description !! Example Value
|-
| Data source* || Data source imported from .rptdesign file || "PMSM_DB_TEST"
|-
| Mapped on || itmSUITE® data source item to which report template can refers for data extraction. If it is empty, data source defined in .rptdesign file is used || "PMSM DB Test"
|-
| Type* || Connection type to data source (always JDBC) || "JDBC"
|-
|}

<ol>
<li value=4>Click on '''Save''' button to save report template settings</li>
</ol>

==== Create Report Instance ====
Report instance defines a BIRT report that can refer to only a report template and can be launched directly from itmSUITE® menu.
A report instance is configurable on the '''''General > Company > Report Engine > Report Management''''' menu

[[File:reportManagementList.png|centre|frame]]

The report instance creation requires following steps:
# Click on '''Add New''' button
# Fill following fields on ''General'' tab:
{| class="wikitable"
! Field Name !! Description !! Example Value
|-
| Name* || Report name || "Sample Report"
|-
| Description || Report description || "A sample report"
|-
| Status* || Configurable Active/Inactive statuses. If Inactive report cannot be shown on itmSUITE® menu || "Active"
|-
| Template* || Report template name to which report instance refers || "Sample_Report_Template"
|-
|}
<ol>
<li ''value=3>Check that all report parameters are visible on ''Parameters'' tab:</li>
</ol>

[[File:reportParameter.png|centre|frame]]

<ol>
<li value=4>On ''Filter Designer'' tab, it is possible to customize a report launcher box (at default it contain''''Italic text''s the same parameters defined on report template):</li>
*Hide/show report parameters
*Add/delete parameters sections
*Edit each report parameter item (read-only,label editing, mandatory, etc.)
*Add Output field to extract report in several format (html, word, excel, pdf, ppt)
*Add Open Report in New Window check box to visualize report ouput on a new tab

[[File:reportDesigner.png|centre|frame]]

It is possible to see a report launcher preview by clicking on '''Preview''' button
<li>On ''Assignments'' tab, set report visibility grants on itmSUITE® menu

[[File:reportAssignment.png|centre|frame]]

by following filter fields:

{| class="wikitable"
! Filter Name !! Description
|-
| Role || it limits visibility to users that belong to following roles: ''superadmin'', ''administrator'', ''manager'', ''pm'', ''resource'', ''requester''. It works also as prefilter for Resource filter
|-
| Resource || it limits visibility to selected ''resources''
|-
| Group || it limits visibility to members of selected ''groups''
|-
| Organization unit || it limits visibility to resources that belong to selected ''organization units''
|-
|}
</li>
<li>
On Filter tab, it is possible to manage personal filters selectable by user directly from report

[[File:reportFilter.png|centre|frame]]
</li>
</ol>

==== Load report template ====
Report template (.rptdesign) file defines the report structure in a well-formed XML document.
In itmSUITE®, a report template can be associated to more report instances. Report template configuration is accessible on the '''''General > Company > Report Engine > Report template'''''

[[File:reportTemplateList.png|centre|frame]]

The report template creation requires following steps:
# Click on '''Add New''' button
# Fill following fields on ''General'' tab:
{| class="wikitable"
! Field Name !! Description !! Example Value
|-
| Name* || Logic report template name || "Sample Report Template"
|-
| Description || Report template description || "A report tamplate as sample"
|-
| Status* || Configurable Active/Inactive statuses || "Active"
|-
| BIRT Report Template* || Load .rptdesign file || "Sample_Report_Template"
|-
|}
<ol>
<li value=3>Fill the following fields on ''Data source'' tab:</li>
</ol>
{| class="wikitable"
! Field Name !! Description !! Example Value
|-
| Data source* || Data source imported from .rptdesign file || "PMSM_DB_TEST"
|-
| Mapped on || itmSUITE® data source item to which report template can refers for data extraction. If it is empty, data source defined in .rptdesign file is used || "PMSM DB Test"
|-
| Type* || Connection type to data source (always JDBC) || "JDBC"
|-
|}

<ol>
<li value=4>Click on '''Save''' button to save report template settings</li>
</ol>

==== Add report on itmSUITE® menu ====
After report instance has been created on '''''Report Management''''' option, it shall be shown as entry in itmSUITE® menu.

[[File:reportMenu.png|centre|frame]]

REP - Reporting

2018-06-18T10:47:14Z

Luca.pandolfo: /* BIRT Report on itmSUITE® */

REP is an optional itmSUITE® module that defines functionality to manage and excute reports created by Eclipse BIRT Designer tool. 
It allows to load one or more report templates (BIRT.rptdesign file) and to create and to execute report instances through the BIRT Viewer integrated on itmSUITE®.

=== BIRT Architecture ===
BIRT (Business Intelligence Reporting Tool)is an open source tool installed as Eclipse IDE plug-in for report developing. It has origin from collaboration between Actuate (along with IBM) and Eclipse.org open source community. 
BIRT is a Java based tool that allows to extract data from many data source types for report generation in several output format (pdf, xlsx, docx, etc.).

[[File:Birt_Architecture.png|centre|thumb|500x500px|Birt Architecture]]

BIRT architecture includes two main components:
# Report Designer: a UI component to create report template (.rptdesign file)
# Report Engine: runtime component for report rendering

The Design Engine generates a .rptdesign file(in XML format) structured according to configurations applied by user (by BIRT Designer) and the Report Engine, through BIRT Viewer, parses it and renders it as report in html (or other formats).

=== BIRT Report on itmSUITE® ===
In itmSUITE®, the steps required to upload and execute BIRT report previously created through the BIRT Designer are following:
#Data source configuration
#Load report template (.rptdesign file)
#Create a report instance
#Add report on menu and execute it

==== Data Source Configuration ====
In itmSUITE®, BIRT report data can be extracted only from data sources connected to database.
Data Source settings are accessible on the '''''General > Company > Report Engine > Data Source''''' menu.

[[File:dataSource.png|centre|frame|Data Source list - more data source items can be created]]

Data source creation steps:
# Click on '''Add New''' button
# Fill following fields (* mandatory):
{| class="wikitable"
! Field Name !! Description !! Example Value
|-
| Name* || Logic data source item name || "Sample DB"
|-
| Description || Data source item description || "Sample data source"
|-
| Company* || Company to which data source item is assigned || "Sample Company"
|-
| Status* || Configurable Active/Inactive statuses || "Active"
|-
| Type* || Driver type used to connect to data source || "JDBC"
|-
| Data Driver* || Driver used to connect to data source || "MSSQL"
|-
| DB Server* || URL (or IP) of data source server || "192.168.10.5"
|-
| Port* || Connection data source port || "1433"
|-
| DB Name* || Database name to which data source item refers || "PMSM_SAMPLE_DB"
|-
| Username* || Username used to connect to database || -
|-
| Password* || Password used to connect to database || -
|-
|}
<ol>
<li value=3>Click on '''Check And Save''' button to check database connection and to save data source settings</li>
</ol>

==== Load report template ====
Report template (.rptdesign) file defines the report structure in a well-formed XML document.
In itmSUITE®, a report template can be associated to more report instances. Report template configuration is accessible on the '''''General > Company > Report Engine > Report template'''''

[[File:reportTemplateList.png|centre|frame]]

The report template creation requires following steps:
# Click on '''Add New''' button
# Fill following fields on ''General'' tab:
{| class="wikitable"
! Field Name !! Description !! Example Value
|-
| Name* || Logic report template name || "Sample Report Template"
|-
| Description || Report template description || "A report tamplate as sample"
|-
| Status* || Configurable Active/Inactive statuses || "Active"
|-
| BIRT Report Template* || Load .rptdesign file || "Sample_Report_Template"
|-
|}
<ol>
<li value=3>Fill the following fields on ''Data source'' tab:</li>
</ol>
{| class="wikitable"
! Field Name !! Description !! Example Value
|-
| Data source* || Data source imported from .rptdesign file || "PMSM_DB_TEST"
|-
| Mapped on || itmSUITE® data source item to which report template can refers for data extraction. If it is empty, data source defined in .rptdesign file is used || "PMSM DB Test"
|-
| Type* || Connection type to data source (always JDBC) || "JDBC"
|-
|}

<ol>
<li value=4>Click on '''Save''' button to save report template settings</li>
</ol>

==== Create Report Instance ====
Report instance defines a BIRT report that can refer to only a report template and can be launched directly from itmSUITE® menu.
A report instance is configurable on the '''''General > Company > Report Engine > Report Management''''' menu

[[File:reportManagementList.png|centre|frame]]

The report instance creation requires following steps:
# Click on '''Add New''' button
# Fill following fields on ''General'' tab:
{| class="wikitable"
! Field Name !! Description !! Example Value
|-
| Name* || Report name || "Sample Report"
|-
| Description || Report description || "A sample report"
|-
| Status* || Configurable Active/Inactive statuses. If Inactive report cannot be shown on itmSUITE® menu || "Active"
|-
| Template* || Report template name to which report instance refers || "Sample_Report_Template"
|-
|}
<ol>
<li ''value=3>Check that all report parameters are visible on ''Parameters'' tab:</li>
</ol>

[[File:reportParameter.png|centre|frame]]

<ol>
<li value=4>On ''Filter Designer'' tab, it is possible to customize a report launcher box (at default it contain''''Italic text''s the same parameters defined on report template):</li>
*Hide/show report parameters
*Add/delete parameters sections
*Edit each report parameter item (read-only,label editing, mandatory, etc.)
*Add Output field to extract report in several format (html, word, excel, pdf, ppt)
*Add Open Report in New Window check box to visualize report ouput on a new tab

[[File:reportDesigner.png|centre|frame]]

It is possible to see a report launcher preview by clicking on '''Preview''' button
<li>On ''Assignments'' tab, set report visibility grants on itmSUITE® menu

[[File:reportAssignment.png|centre|frame]]

by following filter fields:

{| class="wikitable"
! Filter Name !! Description
|-
| Role || it limits visibility to users that belong to following roles: ''superadmin'', ''administrator'', ''manager'', ''pm'', ''resource'', ''requester''. It works also as prefilter for Resource filter
|-
| Resource || it limits visibility to selected ''resources''
|-
| Group || it limits visibility to members of selected ''groups''
|-
| Organization unit || it limits visibility to resources that belong to selected ''organization units''
|-
|}
</li>
<li>
On Filter tab, it is possible to manage personal filters selectable by user directly from report

[[File:reportFilter.png|centre|frame]]
</li>
</ol>

REP - Reporting

2018-06-18T07:54:54Z

Luca.pandolfo: /* BIRT Report on itmSUITE® */

REP - Reporting

2018-06-15T15:52:15Z

Luca.pandolfo: /* BIRT Report on itmSUITE® */

REP - Reporting

2018-06-15T15:51:33Z

Luca.pandolfo: /* BIRT Report on itmSUITE® */

REP - Reporting

2018-06-14T14:07:25Z

Luca.pandolfo: /* Data Source Configuration */

REP - Reporting

2018-06-14T12:16:50Z

Luca.pandolfo: /* BIRT Report on itmSUITE® */

REP - Reporting

2018-06-14T08:46:25Z

Luca.pandolfo: /* Data Source Configuration */

REP - Reporting

2018-06-14T07:51:42Z

Luca.pandolfo: /* Data Source Configuration */

REP - Reporting

2018-06-13T16:07:51Z

Luca.pandolfo: /* Data Source Configuration */

REP - Reporting

2018-06-13T16:06:50Z

Luca.pandolfo: /* BIRT Report on itmSUITE® */

REP - Reporting

2018-06-13T16:06:22Z

Luca.pandolfo:

REP - Reporting

2018-06-13T16:05:58Z

Luca.pandolfo: /* Data Source Configuration */

REP - Reporting

2018-06-13T16:05:10Z

Luca.pandolfo: /* BIRT Architecture */

File:MbScheduler.png

2018-06-13T15:44:34Z

Luca.pandolfo:

File:ReportTaskFormat.png

2018-06-13T15:43:56Z

Luca.pandolfo:

File:ReportTaskList.png

2018-06-13T15:43:26Z

Luca.pandolfo:

File:ReportTaskEmail.png

2018-06-13T15:42:55Z

Luca.pandolfo:

File:ReportTask.png

2018-06-13T15:42:35Z

Luca.pandolfo: Luca.pandolfo uploaded a new version of File:ReportTask.png

File:ReportTask.png

2018-06-13T15:42:22Z

Luca.pandolfo:

File:ReportAction.png

2018-06-13T15:41:19Z

Luca.pandolfo:

File:ReportEventFilter.png

2018-06-13T15:40:56Z

Luca.pandolfo:

File:ReportEventProfile.png

2018-06-13T15:39:49Z

Luca.pandolfo:

File:ReportMenu.png

2018-06-13T15:39:25Z

Luca.pandolfo:

File:ReportFilter.png

2018-06-13T15:39:10Z

Luca.pandolfo:

File:ReportAssignment.png

2018-06-13T15:38:55Z

Luca.pandolfo:

File:ReportDesigner.png

2018-06-13T15:38:30Z

Luca.pandolfo:

File:ReportParameter.png

2018-06-13T15:38:20Z

Luca.pandolfo:

File:ReportManagementList.png

2018-06-13T15:37:56Z

Luca.pandolfo:

File:ReportTemplateList.png

2018-06-13T15:37:36Z

Luca.pandolfo:

File:DataSource.png

2018-06-13T15:37:22Z

Luca.pandolfo: