Difference between revisions of "SOP-MES0039 MESWeb Central"

From 42Q
Jump to navigation Jump to search
Line 1: Line 1:
<small>[[42Q Cloud-Based MES/MOMS|42Q Home]] &gt;[[Administration]] &gt; MESWeb Central</small><br>[[Image:42Q Logo.jpg]]<br>
 
  
<br>
+
<small>[[42Q_Cloud-Based_MES/MOMS|42Q Home]] >[[Administration|Administration]] > MESWeb Central</small><br/> [[File:42Q Logo.jpg|RTENOTITLE]]
<center>'''MESWeb'''</center> <center>'''''MESWeb Central'''''</center>  
 
''<center>'''Version MES15 Portal 1.0''' </center> <center>'''Work Instruction'''</center>''
 
  
<br>  
+
&nbsp;
 +
 
 +
&nbsp;
 +
 
 +
&nbsp;
 +
<center>'''MESWeb'''</center> <center>'''''MESWeb Central'''''</center> <center>'''''Version MES15 Portal 1.0'''''</center> <center>'''''Work Instruction'''''</center>
 +
&nbsp;
 
<center>This Work Instruction is 42Q's corporate standard.</center> <center>This document is under revision control. The latest revision is located on Intranet.</center> <center>Once printed it is an uncontrolled copy. All alterations to this work instruction require approval.</center> <center>Contact the IT Global Education and Training Department to submit suggested alterations and or updates.</center>  
 
<center>This Work Instruction is 42Q's corporate standard.</center> <center>This document is under revision control. The latest revision is located on Intranet.</center> <center>Once printed it is an uncontrolled copy. All alterations to this work instruction require approval.</center> <center>Contact the IT Global Education and Training Department to submit suggested alterations and or updates.</center>  
''This edition applies to MES15 Portal 1.0 Application and all subsequent releases and modifications until otherwise indicated in new revisions.''  
+
''This edition applies to MES15 Portal 1.0 Application and all subsequent releases and modifications until otherwise indicated in new revisions.''
 +
 
 +
== Introduction ==
 +
<div style="color:#000000;margin-left:0.2701in;margin-right:0in;">MESWeb is a powerful business intelligence application designed from the ground up to simplify reporting from manufacturing execution systems, and empower end users with a streamlined and full-featured web interface. The application includes an ad hoc report design tool that allows users to easily build their own reports and modify existing ones with little to no training. Also, create rich, customized reports from heterogeneous data sources.</div>
 +
 
 +
 
 +
<div style="margin-left:0.2701in;margin-right:0in;"><span style="color:#000000;">Decentralized custom reports, redundant data, lack of </span>pop up<span style="color:#000000;">al security controls, and convoluted development requirements are problems faced by all 42Q s, and MESWeb has been designed to resolve these issues while maximizing usability and performance.</span></div>
 +
 
 +
 
 +
<div style="margin-left:0.2701in;margin-right:0in;">The purpose of this application is to manage the permissions for every report in our MES Web application. It provides 42Q’s with an easy mechanism for managing users, roles, applications, services and the relations among them.</div>
 +
 
 +
 
 +
<div style="margin-left:0.25in;margin-right:0in;"></div>
 +
 
 +
<div style="margin-left:0.25in;margin-right:0in;"></div># <div style="margin-left:0.5in;margin-right:0in;">'''Administration'''</div>
 +
 
 +
 
 +
There are 2 types of roles in MESWeb, the first type grants certain permissions to user in the Central module and those are:* <div style="margin-left:0.5in;margin-right:0in;">'''Administrator''': user with this role has full permissions to all locations in Central module.</div>
 +
* <div style="margin-left:0.5in;margin-right:0in;">'''Security Manager''': can grant access all kind of permissions except “Administrator” to other users and himself, including roles and reports.</div>
 +
* <div style="margin-left:0.5in;margin-right:0in;">'''Report Manager''': this role has all permission in the Report Module but just for the specific Location assigned. (Create, edit, copy, publish reports)</div>
 +
* <div style="margin-left:0.5in;margin-right:0in;">'''Data Source Manager''': this role has all permission in the Data source module but just for the specific Location assigned. (Create, edit, delete data sources)</div>
 +
 
 +
 
 +
The following roles will only take effect on the report execution:* <div style="margin-left:0.5in;margin-right:0in;">'''All MESR Customers''': this role allows the user to see all customers of a specific location.</div>
 +
* <div style="margin-left:0.5in;margin-right:0in;">'''All data sources''': this role allow user to see all data sources of a specific location.</div>
 +
* <div style="margin-left:0.5in;margin-right:0in;">'''All Reports''': this role allows the user to see and execute all reports available in a specific location.</div>
 +
 
 +
 
 +
<div style="color:#000000;"></div>
 +
 
 +
<div style="color:#000000;">This section will cover how to navigate and execute all location, data source and custom reports activities. With this portlet, the user can add, edit or delete locations, servers, data sources, and data source types. The user can also access report group maintenance to perform searches, create, edit or delete report groups and add s to report groups. Report maintenance also allows the user to create, edit, or delete reports. The user can also publish/unpublished reports. </div>
 +
 
 +
 
 +
# <div style="margin-left:0.5in;margin-right:0in;">To access MESWeb, navigate to '''Administration > MESWeb Central'''.</div>
 +
# <div style="margin-left:0.5in;margin-right:0in;">Select the Administration icon located on the MESWeb Central Main page.</div>
 +
 
 +
 
 +
 
 +
'''Figure 1: MESWeb Central Administration'''
 +
 
 +
[[Image:image47.jpg.png|top]]
 +
 
 +
 
 +
# <div style="color:#0000ff;margin-left:0.5in;margin-right:0in;">Upon selecting the Administration icon, four additional icons become available: Locations, Data Sources, Reports, and Report Groups.</div>
 +
 
 +
 
 +
 
 +
<div style="color:#0000ff;"></div>
 +
 
 +
'''Figure 2: Administration Functions'''
 +
 
 +
[[Image:image122.jpg.png|top]]
 +
 
 +
# <div style="color:#0000ff;margin-left:0.5in;margin-right:0in;">Once an icon is selected, it is placed in a tab at the top of the Administration Page. The user can navigate between icons by placing them in tabs that can be easily accessed. </div>
 +
 
 +
 
 +
'''Figure 3: Functions in Tabs'''
 +
 
 +
[[Image:image143.jpg.png|top]]
 +
 
 +
 
 +
#
 +
## <div style="margin-left:1in;margin-right:0in;">'''''Locations'''''</div>
  
== Introduction  ==
 
  
MESWeb is a powerful business intelligence application designed from the ground up to simplify reporting from manufacturing execution systems, and empower end users with a streamlined and full-featured web interface. The application includes an ad hoc report design tool that allows users to easily build their own reports and modify existing ones with little to no training. Also, create rich, customized reports from heterogeneous data sources.
 
  
Decentralized custom reports, redundant data, lack of formal security controls, and convoluted development requirements are problems faced by any large manufacturer, and MESWeb has been designed to resolve these issues while maximizing usability and performance.  
+
'''Definition''': Location is a specific site or plant.
  
The purpose of this application is to manage the permissions for every report in our MES Web application. It provides the user with an easy mechanism for managing users, roles, applications, services and the relations among them.  
+
This function allows Administrators to add, edit, or delete locations. Also located in this module is the ability to add, edit, or delete location.
  
== Administration  ==
 
  
The Administration module was developed for employees with the following roles:  
+
#
 +
##
 +
### <div style="margin-left:1.5in;margin-right:0in;">'''''Filter Locations'''''</div>
  
*'''Administrator''': the Administrator user has full access for all locations;
 
*'''Security Manager''': the Security Manager user has full access for the locations that he is assigned;
 
*'''All MESR Customers''': in the Execution module, this user is able to see all customers of a specific location;
 
*'''All Data Sources''': in the Execution module, this user is able to see all data sources of a specific location;
 
*'''All Reports''': this user is able to execute all reports of a specific location;
 
*'''Report Manager''': this role has all permission in the Report Module but just for a specific Location;
 
*'''Data Source Manager''': this role has all permission in the Data Source Module but just for a specific Location;
 
  
This section will cover how to navigate and execute all location, data source and custom reports activities. With this portlet, the user can add, edit or delete locations, servers, data sources, and data source types. The user can also access report group maintenance to perform searches, create, edit or delete report groups and add s to report groups. Report maintenance also allows the user to create, edit, or delete reports. The user can also publish/unpublished reports.  
+
The filtering option located in the Locations tab allows the Administrator to search for specific locations based on their name and/or domain. The list displays empty and the user need to search to load the data in the page.
  
1. To access MESWeb, navigate to '''Administration <nowiki>></nowiki> MESWeb Central'''.
 
  
2. Select the Administration icon located on the MESWeb Central Main screen.  
+
# <div style="margin-left:0.5in;margin-right:0in;">To filter the list, enter the location name and/or select the domain from the drop down box provided. </div>
 +
# <div style="margin-left:0.5in;margin-right:0in;">Select '''Search '''to filter the name list.</div>
 +
# <div style="margin-left:0.5in;margin-right:0in;">Select '''Clear '''to clear entries.</div>
  
'''Figure 1: MESWeb Central Administration'''
 
  
[[Image:SOP-5-I-MES00-C-MESWeb-Central-Administration.jpg]]<br>
+
'''Figure 4: Filter Locations'''
  
3. Upon selecting the Administration icon, four additional icons become available: Locations, Data Sources, Reports, and Report Groups.  
+
[[Image:image123.jpg.png|top]]
  
'''Figure 2: Administration Functions'''
 
  
[[Image:02 MESWeb Admin.png|02 MESWeb Admin.png]]<br>  
+
#
 +
##
 +
### <div style="margin-left:1.5in;margin-right:0in;">'''''Add Location'''''</div>
  
1. Once an icon is selected, it is placed in a tab at the top of the Administration Page. The user can navigate between icons by placing them in tabs that can be easily accessed.
 
  
'''Figure 3: Functions in Tabs'''
+
This function allows the Administrator to add a location based on the name, server, domain, time zone, and culture of the location.
  
[[Image:03 MESWeb Admin.png]]<br>
 
  
=== Locations ===
+
# <div style="margin-left:0.5in;margin-right:0in;">To add a location, select '''Add '''located above the name list in the Locations tab.</div>
 +
# <div style="margin-left:0.5in;margin-right:0in;">Enter the location '''Name''', '''Server''',''' Domain''',''' Time Zone''', and''' Culture'''. All fields are mandatory.</div>
 +
# <div style="margin-left:0.5in;margin-right:0in;">Select '''Save '''to confirm or '''Cancel '''to exit.</div>
  
'''Definition''': Location is a specific .
 
  
This function allows Administrators to add, edit, or delete locations. Also located in this module is the ability to add, edit, or delete server names.
+
'''Figure 5: Add Location'''
  
==== Filter Locations  ====
+
[[Image:image84.jpg.png|top]]
  
The filtering option located in the Locations tab allows the Administrator to search for specific locations based on their name and/or domain.
 
  
1. To filter the name list, enter the name and/or select the domain from the drop down box provided.  
+
# <div style="margin-left:0.5in;margin-right:0in;">After all information has been entered and saved, the new location will be placed in the name list on the main screen of the Locations tab.</div>
 +
# <div style="margin-left:0.5in;margin-right:0in;">After creating the location, a report group (Default Reports) is created (for this created location) and all predefined reports are assigned to this report group.</div>
  
2. Select '''Search '''to filter the name list.
 
  
3. Select '''Clear '''to clear entries.
+
#
 +
##
 +
### <div style="margin-left:1.5in;margin-right:0in;">'''''Edit Location'''''</div>
  
'''Figure 4: Filter Locations'''
 
  
[[Image:04 MESWeb Admin.png|04 MESWeb Admin.png]]<br>
+
This function allows the Administrator to edit any location’s name, server, domain, time zone, and/or culture.
  
==== Add Location  ====
 
  
This function allows the Administrator to add a location based on the name, server, domain, time zone, and culture of the location.  
+
# <div style="margin-left:0.5in;margin-right:0in;">To edit a location, select the desired location from the name list and then select '''Edit'''.</div>
 +
# <div style="margin-left:0.5in;margin-right:0in;">The Location Detail pop up displays. All fields are available to edit. After changing the desired information, select '''Save '''to confirm.</div>
 +
# <div style="margin-left:0.5in;margin-right:0in;">Select '''Cancel '''to exit.</div>
  
1. To add a location, select '''Add '''located above the name list in the Locations tab.
 
  
2. Enter the location '''Name''', '''Server''','''Domain''','''Time Zone''', and'''Culture'''. All fields are mandatory.  
+
<div style="margin-left:0.5in;margin-right:0in;"></div>
  
3. Select '''Save '''to confirm or '''Cancel '''to exit.
+
'''Figure 6: Edit Location'''
  
'''Figure 5: Add Location'''
+
[[Image:image168.jpg.png|top]]
  
[[Image:05 MESWeb Admin.png|05 MESWeb Admin.png]]<br> 4. After all information has been entered and saved, the new location will be placed in the name list on the main screen of the Locations tab.
 
  
5. After creating the location, a report group (Default Reports) is created (for this created location) and all predefined reports are assigned to this report group.  
+
# <div style="margin-left:0.5in;margin-right:0in;">The changes to the location will appear in the name list on the main screen of the Locations tab.</div>
  
==== Edit Location  ====
 
  
This function allows the Administrator to edit any location<nowiki></nowiki>s name, server, domain, time zone, and/or culture.
+
#
 +
##
 +
### <div style="margin-left:1.5in;margin-right:0in;">'''''Delete Location'''''</div>
  
1. To edit a location, select the desired location from the name list and then select '''Edit'''.
 
  
2. The Location Detail form displays. All fields are available to edit. After changing the desired information, select '''Save '''to confirm.  
+
This function allows the Administrator to delete a location from the Location Name list.
  
3. Select '''Cancel '''to exit.
 
  
'''Figure 6: Edit Location'''  
+
# <div style="margin-left:0.5in;margin-right:0in;">To delete a location from the location name list, select the desired location and then select '''Delete'''. </div>
 +
# <div style="margin-left:0.5in;margin-right:0in;">A confirmation prompt will display. Select '''Yes '''to confirm deletion or '''No '''to cancel.</div>
  
[[Image:06 MESWeb Admin.png|06 MESWeb Admin.png]]<br> 4. The changes to the location will appear in the name list on the main screen of the Locations tab.
 
  
==== Delete Location ====
+
'''Figure 7: Delete Location'''
  
This function allows the Administrator to delete a location from the name list.  
+
[[Image:image50.jpg.png|top]]
  
1. To delete a location from the name list, select the desired location and then select '''Delete'''.
 
  
2. A confirmation prompt will display. Select '''Yes '''to confirm deletion or '''No '''to cancel.  
+
# <div style="margin-left:0.5in;margin-right:0in;">The location will be removed from the name list on the main screen of the Locations tab.</div>
  
'''Figure 7: Delete Location'''
 
  
[[Image:07 MESWeb Admin.png|07 MESWeb Admin.png]]<br>
+
<u>'''NOTE</u>:''' It is not allowed to delete a location if data sources, report groups, reports or user permissions are created for this location.
  
3. The location will be removed from the name list on the main screen of the Locations tab.
 
  
'''Note:''' It is not allowed to delete a location if data sources, report groups, reports or user permissions are created for this location.
+
#
 +
##
 +
### <div style="margin-left:1.5in;margin-right:0in;">'''''Server'''''</div>
  
==== Server  ====
 
  
'''Definition''': Servers where the MESWeb Execution application is installed.
 
  
The Server function located in the Locations tab allows the administrator user to add, edit or delete the servers that will be available for all locations.  
+
'''Definition''': Server is where the MESWeb Execution application is installed.  
  
1. To access the server function, select the '''Server '''icon located on the right of the main screen under the Locations tab.
 
  
'''Figure 8: Server'''
+
The Server function located in the Locations tab allows the administrator user to add, edit or delete the servers that will be available for all locations.
  
[[Image:08 MESWeb Admin.png|08 MESWeb Admin.png]]<br> A server list displays containing all previously created servers listed numerically and alphabetically. From this screen, the Administrator can add, edit or delete a server.
 
  
'''Figure 9: Server List'''  
+
# <div style="margin-left:0.5in;margin-right:0in;">To access the server function, select the '''Server '''icon located on the right of the main screen under the Locations tab.</div>
  
[[Image:09 MESWeb Admin.png|09 MESWeb Admin.png]]<br>
 
  
1. To add a server name, select '''Add '''located above the server name list.
+
'''Figure 8: Server'''
  
2. The Server Detail form displays. Enter a name for the server and select '''Save'''.  
+
[[Image:image144.jpg.png|top]]
  
3. Select '''Cancel '''to exit.
 
  
4. Once the server name has been entered and saved, the created server will appear in the server list.  
+
A server list displays containing all previously created servers listed numerically and alphabetically. From this screen, the Administrator can add, edit or delete a server.
  
'''Figure 10: Add Server Name'''
 
  
[[Image:10 MESWeb Admin.png|10 MESWeb Admin.png]]<br>
+
'''Figure 9: Server List'''
  
===== Edit Server Name  =====
+
[[Image:image179.jpg.png|top]]
  
1. To edit a server name, select the desired server name from the server list.
 
  
2. Select '''Edit '''located above the server name list.
+
#
 +
##
 +
###
 +
#### <div style="margin-left:2in;margin-right:0in;">'''Add Server Name'''</div>
  
3. The Server Detail form displays. After editing the server name, select '''Save '''to confirm.  
+
# <div style="margin-left:0.5in;margin-right:0in;">To add a server, select '''Add '''located above the server name list.</div>
 +
# <div style="margin-left:0.5in;margin-right:0in;">The Server Detail pop up displays. Enter a name for the server and select '''Save'''.</div>
 +
# <div style="margin-left:0.5in;margin-right:0in;">Select '''Cancel '''to exit.</div>
 +
# <div style="margin-left:0.5in;margin-right:0in;">Once the server name has been entered and saved, the created server will appear in the server list. </div>
  
4. Select '''Cancel '''to exit.
 
  
'''Figure 11: Edit Server'''
 
  
[[Image:11 MESWeb Admin.png|11 MESWeb Admin.png]]<br>
+
'''Figure 10: Add a Server Name'''
  
===== Delete Server Name  =====
+
[[Image:image101.jpg.png|top]]
  
1. To delete a server name, select the server name from the server list.
 
  
2. Select '''Delete '''located above the server name list.
+
#
 +
##
 +
###
 +
#### <div style="margin-left:2in;margin-right:0in;">'''Edit Server Name'''</div>
  
3. A confirmation prompt will display. Select '''Yes '''to confirm or '''No '''to exit.
 
  
'''Figure 12: Delete Server Name'''
 
  
[[Image:12 MESWeb Admin.png|12 MESWeb Admin.png]]<br> '''Note:''' If the server has any location assigned, it not will be allowed delete the server.  
+
# <div style="margin-left:0.5in;margin-right:0in;">To edit a server name, select the desired server name from the server list.</div>
 +
# <div style="margin-left:0.5in;margin-right:0in;">Select '''Edit '''located above the server name list.</div>
 +
# <div style="margin-left:0.5in;margin-right:0in;">The Server Detail pop up displays. After editing the server name, select '''Save '''to confirm.</div>
 +
# <div style="margin-left:0.5in;margin-right:0in;">Select '''Cancel '''to exit.</div>
  
=== Data Sources  ===
 
  
'''Definition:''' a given name to a database for a specific location. The reports will query data inside this database.
 
  
This function allows Administrators to add, edit, or delete data sources. Also located in this module is the ability to add, edit, or data source types.
+
'''Figure 11: Edit Server'''
  
==== Filter Data Sources  ====
+
[[Image:image71.jpg.png|top]]
  
The filtering option located in the Data Sources tab allows the Administrator to search for specific data sources based on their location and/or name.
 
  
1. To filter the Data Source list, select the locations from the drop down box provided and/or enter the data source name.
+
#
 +
##
 +
###
 +
#### <div style="margin-left:2in;margin-right:0in;">'''Delete Server Name'''</div>
  
2. Select '''Search '''to filter the Data Source list.  
+
# <div style="margin-left:0.5in;margin-right:0in;">To delete a server name, select the server name from the server list.</div>
 +
# <div style="margin-left:0.5in;margin-right:0in;">Select '''Delete '''located above the server name list.</div>
 +
# <div style="margin-left:0.5in;margin-right:0in;">A confirmation message displays. Select '''Yes '''to confirm or '''No '''to exit.</div>
  
3. Select '''Clear '''to clear entries.
 
  
'''Figure 13: Filter Data Sources'''
 
  
[[Image:13 MESWeb Admin.png|13 MESWeb Admin.png]]<br>  
+
'''Figure 12: Delete Server Name'''
 +
 
 +
[[Image:image138.jpg.png|top]]
 +
 
 +
 
 +
<u>'''NOTE</u>:''' If the server has any location assigned, it not will be allowed delete the server.
 +
 
 +
 
 +
#
 +
## <div style="margin-left:1in;margin-right:0in;">'''''Data Sources'''''</div>
 +
 
 +
 
 +
'''Definition:''' a given name to a database for a specific location. The reports will query data inside this database.
 +
 
 +
 
 +
This function allows Administrators to add, edit, or delete data sources. Also located in this module is the ability to add, edit, or data source types.
 +
 
 +
 
 +
 
 +
'''Figure 13: Data Source List'''
 +
 
 +
[[Image:image162.jpg.png|top]]
 +
 
 +
 
 +
#
 +
##
 +
### <div style="margin-left:1.5in;margin-right:0in;">'''''Filter Data Sources'''''</div>
 +
 
 +
 
 +
 
 +
The filtering option located in the Data Sources tab allows the Administrator to search for specific data sources based on their location and/or name.
 +
 
 +
 
 +
# <div style="margin-left:0.5in;margin-right:0in;">To filter the Data Source list, select the locations from the drop down box provided and/or enter the data source name.</div>
 +
# <div style="margin-left:0.5in;margin-right:0in;">Select '''Search '''to filter the Data Source list.</div>
 +
# <div style="margin-left:0.5in;margin-right:0in;">Select '''Clear '''to clear entries.</div>
 +
 
 +
 
 +
 
 +
'''Figure 14: Filter Data Sources'''
 +
 
 +
[[Image:image174.jpg.png|top]]
 +
 
 +
 
 +
#
 +
##
 +
### <div style="margin-left:1.5in;margin-right:0in;">'''''Add Data Sources'''''</div>
 +
 
  
==== Add Data Sources  ====
 
  
 
This function allows the Administrator to add a data source based on the name, description, location, database type, and connection parameters associated to the database type.  
 
This function allows the Administrator to add a data source based on the name, description, location, database type, and connection parameters associated to the database type.  
  
1. To add a data source, select '''Add '''located above the Data Source list in the Data Sources tab. The details form displays.
 
  
2. Enter the data source '''Name''', '''Description''','''Location''',and the'''Database Type '''into the details form. All fields except the description field are mandatory.  
+
# <div style="margin-left:0.5in;margin-right:0in;">To add a data source, select '''Add '''located above the Data Source list in the Data Sources tab. The details pop up displays.</div>
 +
# <div style="margin-left:0.5in;margin-right:0in;">Enter the data source '''Name''', '''Description''',''' Location''',''' '''and the''' Database Type '''into the details pop up. All fields except the description field are mandatory.</div>
 +
 
 +
 
  
3. Depending on the database type, a subsequent Connection Parameters form will display below the details form. The information required in this form is dependent upon the Database Type selected. Enter the required information in to the Connection Parameters form.
+
'''Figure 15: Add Data Source'''
  
4. Select '''Save ''' to confirm or '''Cancel '''to exit
+
[[Image:image121.jpg.png|top]]
  
'''Figure 14: Add Data Source'''
 
  
[[Image:14 MESWeb Admin Add Data Source.png|14 MESWeb Admin Add Data Source.png]]<br>  
+
# <div style="margin-left:0.5in;margin-right:0in;">Depending on the database type ('''Database Type''' field), a subsequent '''Connection Parameters''' pop up displays below the details pop up. The information required in this pop up is dependent upon the Database Type selected. Enter the required information in to the Connection Parameters pop up.</div>
  
'''Types''': This is the schemas that the created data source has. Select the schemas dragging the items from one list to another. Select '''Save''' to confirm or '''Cancel''' to exit.
 
  
'''Figure 15: Data Source -Types'''  
+
'''Figure 16: Select Database Type'''
  
[[Image:15 MESWeb Admin Data Source Types.png]]<br>
+
[[Image:image65.jpg.png|top]]
  
==== Edit Data Sources  ====
 
  
This function allows the Administrator to edit the name, description and connection string of any data source.
+
'''Figure 17: Conection Parameter'''
  
1. To edit a data source, select the desired data source from the Data Source list located on the main page of the Data Sources tab.  
+
[[Image:image75.jpg.png|top]]
  
2. Select '''Edit '''located above the name list.
 
  
3. The Data Source Details form displays. The name and description are available for editing. The Connection Parameters section is not available to edit, but the connection string below the connection parameters form can be edited.  
+
Add a DataSource in Central is easy. The user just needs to follow the steps.# <div style="margin-left:0.5in;margin-right:0in;">'''Log in Portal''' -> '''Go to Administration''' -> '''Select MesWeb Central''' ->''' Select Data Sources''' -> '''Click Add button.'''</div>
 +
# <div style="margin-left:0.5in;margin-right:0in;">Fill out '''Name''', '''Description''', '''Location''' and '''Database Type'''.</div>
 +
# <div style="margin-left:0.5in;margin-right:0in;">The Database Types available are: '''MySQL''', '''Oracle''', '''Pervasive''',''' Postgres SQL''',''' SQL Server, '''according with the Database Type Selected. The screen will show the fields that the user needs to fill out to create the datasource connection. </div>
 +
# <div style="margin-left:0.5in;margin-right:0in;">Fill out Connection Parameters. The user has two options to fill out those fields: </div>
  
4. After changing desired information, select '''Save '''to confirm or '''Cancel '''to exit.  
+
* <div style="margin-left:0.5in;margin-right:0in;">The user can fill out the fields :'''Server''', '''Port''', '''Database''', '''User''' and '''Password.'''</div>
 +
* <div style="margin-left:0.5in;margin-right:0in;">The user can fill out just the '''Connection String''' field. If the Connection String is valid, the fields '''Server''', '''Port''', '''Database''', '''User''' and '''Password''' will fill out automatically. Example of the Connection String: jdbc:postgresql://p88meswebl1.sanmina.com:5432/bem?user=user&password=pass</div>
  
'''Figure 16: Edit Data Source'''
 
  
[[Image:16 MESWeb Admin Edit.png|16 MESWeb Admin Edit.png]]<br>
 
  
Note that editing the Data Source, the Connection Parameters field will be displayed according to the chosen during the data source addition.  
+
The Connection String should have the following format.
  
==== Delete Data Sources  ====
 
  
This function allows the Administrator to delete any data source.  
+
{| style="border-spacing:0;width:6.5in;"
 +
|- style="border:1pt solid #000001;padding:0.0694in;"
 +
|| SQL Server
 +
|| jdbc:sqlserver://%Server%:%Port%;databaseName=%Database%;user=%User%;password=%Password%;encrypt=false
 +
|- style="border:1pt solid #000001;padding:0.0694in;"
 +
|| Oracle
 +
|| jdbc:oracle:thin:%User%/%Password%@%Server%:%Port%:%Database%
 +
|- style="border:1pt solid #000001;padding:0.0694in;"
 +
|| MySQL
 +
|| jdbc:mysql://%Server%:%Port%/%Database%?user=%User%&password=%Password%
 +
|- style="border:1pt solid #000001;padding:0.0694in;"
 +
|| Pervasive
 +
|| jdbc:pervasive://%Server%:%Port%/%Database%?user=%User%&password=%Password%
 +
|- style="border:1pt solid #000001;padding:0.0694in;"
 +
|| Postgres SQL
 +
|| jdbc:postgresql://%Server%:%Port%/%Database%?user=%User%&password=%Password%
 +
|-
 +
|}
 +
# <div style="margin-left:0.5in;margin-right:0in;">Select''' DataSource Type'''(s).</div>
 +
# <div style="margin-left:0.5in;margin-right:0in;">Click in Save button. If the parameters of the connection are correct, the Data Source will save, if not and error will show the error description.</div>
  
1. To delete a data source, select the desired data source from the name list located on the main page of the Data Sources tab.
 
  
2. Select '''Delete '''located above the name list.
 
  
3. A confirmation prompt will display. Select '''Yes '''to confirm or '''No '''to cancel.  
+
'''Types''': This is the schemas that the created data source has. Select the schemas dragging the items from one list to another.  
  
'''Figure 17: Delete Data Source'''
 
  
[[Image:17 MESWeb Admin Delete.png|17 MESWeb Admin Delete.png]]<br>
+
'''8Figure 18: Data Source -Types'''
  
==== Data Source Type  ====
+
[[Image:image180.png.png|top]]
  
The Data Source Type function located in the Data Sources tab allows the administrator user to add, edit or delete the data source types.
 
  
1. To access the data source type function, select the '''Data Source Type '''icon located on the right of the main screen under the Data Sources tab.
+
# <div style="margin-left:0.5in;margin-right:0in;">Select '''Save '''to confirm or '''Cancel '''to exit</div>
  
'''Note''': if a data source type is deleted reports associated to it may not work correctly.
 
  
'''Figure 18: Data Source Type'''
 
  
[[Image:18 MESWeb Admin Data Source Type.png|18 MESWeb Admin Data Source Type.png]]<br>  
+
#
 +
##
 +
### <div style="margin-left:1.5in;margin-right:0in;">'''''Edit Data Sources'''''</div>
  
A data source type list displays containing all previously created data sources listed alphabetically. From this screen, the Administrator user can add, edit or delete a data source type.
 
  
'''Figure 19: Data Source Type List'''
 
  
[[Image:19 MESWeb AdminData Source Type List.png]]<br>
+
This function allows the Administrator to edit the name, description and connection string of any data source.
  
===== Add Data Source Type  =====
 
  
1. To add a data source type, select '''Add''' located above the data source type list.  
+
# <div style="margin-left:0.5in;margin-right:0in;">To edit a data source, select the desired data source from the Data Source list located on the main page of the Data Sources tab.</div>
 +
# <div style="margin-left:0.5in;margin-right:0in;">Select '''Edit '''located above the name list. </div>
 +
# <div style="margin-left:0.5in;margin-right:0in;">The Data Source Details pop up displays. The name and description are available for editing. The Connection Parameters section is not available to edit, but the connection string below the connection parameters pop up can be edited. </div>
 +
# <div style="margin-left:0.5in;margin-right:0in;">After changing desired information, select '''Save '''to confirm or '''Cancel '''to exit. </div>
  
2. Enter a data source type and description, both mandatory fields.
 
  
3. Select '''Save '''to create Data Source Type.
+
'''Figure 19: Edit Data Source'''
  
4. Select '''Cancel '''to exit.  
+
[[Image:image163.jpg.png|top]]
  
'''Figure 20: Add Data Source Type'''
 
  
[[Image:20 MESWeb Admin Add Data Source.png]]<br>
+
<u>'''NOTE'''</u>: editing the Data Source, the Connection Parameters field will be displayed according to the''' Database Type''' chosen during the data source addition.  
  
===== Edit Data Source Type  =====
 
  
1. To edit a data source type, select the desired data source type from the list.
+
#
 +
##
 +
### <div style="margin-left:1.5in;margin-right:0in;">'''''Delete Data Sources'''''</div>
  
2. Select '''Edit''' located above the Data Source Type list.
 
  
3. Both the name and description fields are available to edit. After desired changes have been made, select '''Save '''to continue.
 
  
4. Select '''Cancel '''to exit.  
+
This function allows the Administrator to delete any data source.
  
'''Figure 21: Edit Data Source Type'''
 
  
[[Image:21 MESWeb Admin Edit Data Source Type.png]]<br>  
+
# <div style="margin-left:0.5in;margin-right:0in;">To delete a data source, select the desired data source from the name list located on the main page of the Data Sources tab.</div>
 +
# <div style="margin-left:0.5in;margin-right:0in;">Select '''Delete '''located above the name list.</div>
 +
# <div style="margin-left:0.5in;margin-right:0in;">A confirmation prompt will display. Select '''Yes '''to confirm or '''No '''to cancel.</div>
  
===== Delete Data Source Type  =====
 
  
1. To delete a data source type, select the desired data source type from the list.  
+
<div style="margin-left:0.25in;margin-right:0in;"></div>
  
2. Select '''Delete '''located above the Data Source Type list.
 
  
3. A confirmation prompt will display. Select '''Yes '''to confirm or '''No '''to exit.
+
'''Figure 20: Delete Data Source'''
  
'''Figure 22: Delete Data Source Type'''
+
[[Image:image61.jpg.png|top]]
  
[[Image:22 MESWeb Admin Delete Data Source Type.png]]<br> Note: It is not allowed delete a data source type if:
 
  
*If assigned to a data source;  
+
#
*If there is any report already created for this data source type;
+
##
 +
### <div style="margin-left:1.5in;margin-right:0in;">'''''Data Source Type'''''</div>
 +
 
 +
 
 +
 
 +
The Data Source Type function located in the Data Sources tab allows the administrator user to add, edit or delete the data source types.
 +
 
 +
 
 +
# <div style="margin-left:0.5in;margin-right:0in;">To access the data source type function, select the '''Data Source Type '''icon located on the right of the main page under the Data Sources tab.</div>
 +
 
 +
 
 +
 
 +
'''Note''': if a data source type is deleted reports associated to it may not work correctly.
 +
 
 +
 
 +
 
 +
'''Figure 21: Data Source Type'''
 +
 
 +
[[Image:image129.jpg.png|top]]
 +
 
 +
 
 +
A data source type list displays containing all previously created data sources listed alphabetically. From this screen, the Administrator user can add, edit or delete a data source type.
 +
 
 +
 
 +
#
 +
##
 +
###
 +
#### <div style="margin-left:2in;margin-right:0in;">'''Add Data Source Type'''</div>
 +
 
 +
 
 +
# <div style="margin-left:0.5in;margin-right:0in;">To add a data source type, select '''Add''' located above the data source type list.</div>
 +
# <div style="margin-left:0.5in;margin-right:0in;">Enter a data source type and description, both mandatory fields.</div>
 +
# <div style="margin-left:0.5in;margin-right:0in;">Select '''Save '''to create Data Source Type.</div>
 +
# <div style="margin-left:0.5in;margin-right:0in;">Select '''Cancel '''to exit. </div>
 +
 
 +
 
 +
 
 +
 
 +
'''Figure 22: Add Data Source Type'''
 +
 
 +
[[Image:image183.jpg.png|top]]
 +
 
 +
 
 +
#
 +
##
 +
###
 +
#### <div style="margin-left:2in;margin-right:0in;">'''Edit Data Source Type'''</div>
 +
 
 +
 
 +
# <div style="margin-left:0.5in;margin-right:0in;">To edit a data source type, select the desired data source type from the list.</div>
 +
# <div style="margin-left:0.5in;margin-right:0in;">Select '''Edit''' located above the Data Source Type list.</div>
 +
# <div style="margin-left:0.5in;margin-right:0in;">Both the name and description fields are available to edit. After desired changes have been made, select '''Save '''to continue.</div>
 +
# <div style="margin-left:0.5in;margin-right:0in;">Select '''Cancel '''to exit.</div>
 +
 
 +
 
 +
'''Figure 23: Edit Data Source Type'''
 +
 
 +
[[Image:image80.jpg.png|top]]
 +
 
 +
 
 +
#
 +
##
 +
###
 +
#### <div style="margin-left:2in;margin-right:0in;">'''Delete Data Source Type'''</div>
 +
 
 +
 
 +
# <div style="margin-left:0.5in;margin-right:0in;">To delete a data source type, select the desired data source type from the list.</div>
 +
# <div style="margin-left:0.5in;margin-right:0in;">Select '''Delete '''located above the Data Source Type list.</div>
 +
# <div style="margin-left:0.5in;margin-right:0in;">A confirmation prompt will display. Select '''Yes '''to confirm or '''No '''to exit.</div>
 +
 
 +
 
 +
'''Figure 24: Delete Data Source Type'''
 +
 
 +
[[Image:image94.jpg.png|top]]
 +
 
 +
 
 +
<u>'''NOTE'''</u>: It is not allowed delete a data source type if:# <div style="margin-left:0.5in;margin-right:0in;">If assigned to a data source;</div>
 +
# <div style="margin-left:0.5in;margin-right:0in;">If there is any report already created for this data source type;</div>
 +
 
 +
 
 +
 
 +
<div style="margin-left:0.5in;margin-right:0in;"></div>
 +
 
 +
<div style="margin-left:0.5in;margin-right:0in;"></div>#
 +
## <div style="margin-left:1in;margin-right:0in;">'''''Reports'''''</div>
 +
 
  
=== Reports  ===
 
  
 
The Reports Module was developed for employees with Security Manager (specific Location) and Administrator (all locations) roles. This section will cover how to navigate and execute all reports activities. The Reports module allows the user to edit copy or publish reports.  
 
The Reports Module was developed for employees with Security Manager (specific Location) and Administrator (all locations) roles. This section will cover how to navigate and execute all reports activities. The Reports module allows the user to edit copy or publish reports.  
  
==== Filter Reports  ====
 
  
The filtering option located in the Reports tab allows the Administrator or Security Manager users to search for specific reports based on the owner location, report group, name, owner user, data source type, and/or status.
+
#
 +
##
 +
### <div style="margin-left:1.5626in;margin-right:0in;">'''''Filter Reports'''''</div>
 +
 
  
1. To filter the report list, select an owner Location, Report Group, Data Source Type, and/or Status from the drop down boxes provided, or enter the Name and/or Owner User.
 
  
2. Select '''Search '''to filter the list or '''Clear '''to clear all fields.  
+
The filtering option located in the Reports tab allows the Administrator or Security Manager users to search for specific reports based on the owner location, report group, name, owner user, data source type, and/or status.
  
3. The results will display in the report list.
 
  
'''Figure 23: Filter Reports'''  
+
# <div style="margin-left:0.5in;margin-right:0in;">To filter the report list, select an owner Location, Report Group, Data Source Type, and/or Status from the drop down boxes provided, or enter the Name and/or Owner User.</div>
 +
# <div style="margin-left:0.5in;margin-right:0in;">Select '''Search '''to filter the list or '''Clear '''to clear all fields. </div>
 +
# <div style="margin-left:0.5in;margin-right:0in;">The results will display in the report list.</div>
  
[[Image:23 MESWeb Admin Filter Reports.png|23 MESWeb Admin Filter Reports.png]]<br>
 
  
Note: just the Publish functionality is available for the Reports module; the other functionalities are in WIP (work in progress) status.
 
  
==== Add Reports ====
+
'''Figure 25: Filter Reports'''
  
This feature allows users to add reports that will be executed in the Execution Module.  
+
[[Image:image105.jpg.png|top]]
  
'''Figure 24: Add Reports'''
 
  
[[Image:24 MESWeb Admin Add Reports.png|24 MESWeb Admin Add Reports.png]]<br> To add a report the user must enter all mandatory fields, configure the SQL command clicking on the "<nowiki>+</nowiki>" icon or '''Configuration''' and select '''Save to '''commit. For further information about these fields, see the respective modules (Location, Group (Report Group), and Data Source Type) in the Portal.  
+
'''Note''': just the Publish functionality is available for the''' Reports''' module; the other functionalities are in '''WIP '''(work in progress) status.
  
'''Note''': Checking '''Private''' just the report owner will have permissions (open, edit, etc) for this report.
 
  
The default format will be the pre select format for the Execution Module, but it could be changed during the execution.  
+
#
 +
##
 +
### <div style="margin-left:1.5in;margin-right:0in;">'''''Add Reports'''''</div>
  
===== SQL Code  =====
 
  
'''Figure 25: Report Maintenance: SQL Code Configuration'''
 
  
[[Image:25 MESWeb Admin SQLCode Add Report.png|25 MESWeb Admin SQLCode Add Report.png]]<br>
+
This feature allows users to add reports that will be executed in the Execution Module.
  
This feature allows the user to add a query and check if the query is valid by clicking on Check Code SQL. To add a parameter it is necessary to use the syntax: <nowiki><</nowiki>%shop_order%<nowiki>></nowiki> .
+
'''Figure 26: Add Reports'''
  
===== Parameters  =====
+
[[Image:image172.jpg.png|top]]
  
At this point, the user will choose the parameters Types and Orders. For example, if the parameter will be a check box, a list box, text box, etc
+
'''Figure 27: Add Reports Basic '''
  
The Report Maintenance page is displayed. Select Parameters tab to add a parameter.  
+
[[Image:image12.jpg.png|top]]
  
'''Figure 26: Parameters'''
 
  
[[Image:26 MESWeb Admin SQLCode Add Report.png|26 MESWeb Admin SQLCode Add Report.png]]<br>
+
To add a report the user must enter all mandatory fields and go to the other configuration tabs too enter the necessary data to the report. Select '''Save to '''commit. For further information about these fields, see the respective modules (Location, Group (Report Group), and Data Source Type) in the Portal.
  
1. The first thing to be done is create a new parameter step.&nbsp; Parameter steps give us the ability to establish parent-child relationships between parameters.&nbsp;
 
  
2. Select "'''New Step'''"
+
'''Note''': Checking '''Private''' just the report owner will have permissions (open, edit, etc) for this report.
  
3. With a new step in place we can begin adding our parameters.
 
  
4. Select '''"New Parameters"''' to configure the parameters;
+
The default format will be the pre select format for the Execution Module, but it could be changed during the execution.
  
'''Figure 27: New Parameter'''
 
  
[[Image:27 MESWeb Admin.png|27 MESWeb Admin.png]]<br>  
+
#
 +
##
 +
###
 +
#### <div style="margin-left:2in;margin-right:0in;">'''SQL Code'''</div>
  
There are three fields that are required of every parameter you setup:
 
  
1. '''Name''' is straight forward - what you type here is what will be used as the parameters caption.&nbsp; For example, "Customers" in the WIP Distribution report.
 
  
2. '''Instruction'''  
+
'''Figure 28: Report Maintenance: SQL Code Configuration'''
  
You will provide any important information for the end user regarding this parameter.&nbsp; In most cases this will be a very basic sentence such as "Indicate whether you want to see units that are in wip or not" that are already intuitive by just looking at the parameter.&nbsp; However, you might come across situations as you develop your reports where you create a parameter whose relationship to the report is not so obvious and this field will give you a great way to explain it to the user.&nbsp; The text you enter in this field will be displayed in this list.  
+
[[Image:image72.jpg.png|top]]
  
3. '''Parameter Type'''
 
  
'''The Parameter Type '''Field will allow the user to choose the Type of parameter that will determine how this parameter is displayed. The available parameter types are listed below:  
+
This feature allows the user to add a query and check if the query is valid by clicking on Check Code SQL. To add a parameter it is necessary to use the syntax: <%shop_order%> .
  
*'''Drop Down List'''
 
  
Choosing this parameter type, the user will create a "list" according with the SQL code entered in the command line.
+
#
 +
##
 +
###
 +
#### <div style="margin-left:2in;margin-right:0in;">'''Parameters'''</div>
  
The Value field represents the value that will be replaced in the SQL Code.
 
  
'''Figure 28: Drop Down List Parameter'''
+
At this point, the user will choose the parameters Types and Orders. For example, if the parameter will be a check box, a list box, text box, etc
  
[[Image:28 MESWeb Admin.png|28 MESWeb Admin.png]]<br>
 
  
The user must enter the mandatory fields ('''Name''', '''Instructions''', '''Command''', '''Data Type''', '''Value Field, Display Field''' and '''the Parameter SQL''').  
+
The Report Maintenance page is displayed. Select Parameters tab to add a parameter.
  
'''Parameter SQL''':&nbsp; this is where the developer selects the text in their report SQL that will be replaced by the values in the parameter they are currently creating. So if in their report sql they had "<nowiki><</nowiki>%Customers%<nowiki>></nowiki>" they would see an option in this field that would say "Customers". That<nowiki>’</nowiki>s where the application would insert the customers the users select when they execute the report.
+
'''Figure 29: Parameters'''
  
'''Data Type''': this indicates what kind of data will be inserted. It is the value type (integer, string, date, and double);  
+
[[Image:image177.jpg.png|top]]# <div style="margin-left:0.5in;margin-right:0in;">The first thing to be done is create a new parameter step.&nbsp; Parameter steps give us the ability to establish parent-child relationships between parameters.&nbsp; </div>
 +
# <div style="margin-left:0.5in;margin-right:0in;">Select "'''New Step'''"</div>
 +
# <div style="margin-left:0.5in;margin-right:0in;">With a new step in place we can begin adding our parameters. </div>
 +
# <div style="margin-left:0.5in;margin-right:0in;">Select '''“New Parameters”''' to configure the parameters; </div>
  
'''Command''': this is used to enter the SQL query that will fill the list with the data;
 
  
'''Value Field''': this field is the column name. This value will be substituted in the SQL Code;
 
  
'''Display Field''': this column name that will be displayed to the user;
+
'''Figure 30: New Parameter'''
  
'''Required''': this field defines if the field is mandatory or not;
+
[[Image:image64.jpg.png|top]]
  
'''Note''': The '''Option Item''' will be displayed if the '''required''' field is not checked and it will be used to remove or replace code lines in the SQL Code in the Execution Module. This action is the same for all parameters types.  
+
There are three fields that are required of every parameter you setup:# <div style="margin-left:0.25in;margin-right:0in;">'''Name''' is straight forward - what you type here is what will be used as the parameters caption.&nbsp; For example, "Customers" in the WIP Distribution report.</div>
  
Check the '''All Option''' check box if you want to add the
 
  
'''Figure 29: Option Item'''  
+
# <div style="margin-left:0.25in;margin-right:0in;">'''Instruction'''</div>
  
[[Image:29 MESWeb Admin.png|29 MESWeb Admin.png]]<br> Select '''Add '''to open the maintenance screen.
 
  
'''Figure 30: Optional Item Maintenance'''
+
The user will provide any important information for the end user regarding this parameter.&nbsp; In most cases this will be a very basic sentence such as "Indicate whether you want to see units that are in wip or not" that are already intuitive by just looking at the parameter.&nbsp; However, you might come across situations as you develop your reports where you create a parameter whose relationship to the report is not so obvious and this field will give you a great way to explain it to the user.&nbsp; The text enterered in this field will be displayed in this list.
  
[[Image:30 MESWeb Admin.png]]<br> For example, the user can remove the <nowiki><</nowiki>%location%<nowiki>></nowiki> command and replace it for any value he wants.
 
  
Select '''Save '''to commit.
+
# <div style="margin-left:0.25in;margin-right:0in;">'''Parameter Type'''</div>
  
During the report execution, if no value is entered for this command, it will be replaced or removed automatically.
 
  
Also, the user can '''Edit''' or '''Delete''' items by clicking on Edit / Delete buttons. Select '''Save''' to commit.
 
  
*'''Customer Drop down List'''
+
'''The Parameter Type '''Field will allow the user to choose the Type of parameter that will determine how this parameter is displayed. The available parameter types are listed below:# <div style="margin-left:0.5in;margin-right:0in;">'''Drop Down List'''</div>
  
This option is almost the same of the Drop down List; the difference is that for this case, the fields '''Command''', <br>'''Data Type''', '''Value Field''' and '''Display Field''' are already configured, so it will bring a customer list.
 
  
'''Figure 31: Customer Drop Down List'''
+
Choosing this parameter type, the user will create a “list” according with the SQL code entered in the command line.
  
[[Image:31 MESWeb Admin.png|31 MESWeb Admin.png]]<br> It is the same for '''Location Drop down List''','''Product Drop down List '''and'''Project Drop down List '''options. The user must enter the mandatory fields ('''Name''', '''Instructions''' and the '''Parameter''' SQL).  
+
The Value field represents the value that will be replaced in the SQL Code.
  
'''Note''': The '''Option Item''' will be displayed if the '''Required''' field is not checked and it will be used to remove or replace code lines in the SQL Code in the Execution Module. This action is the same for all parameters types.
 
  
Check the '''All Option''' check box if you want to add an option to choose "'''All'''"items in the list.
+
'''Figure 31: Drop Down List Parameter'''
  
These options are available when the '''Data Source Type''' selected is '''MESR'''.  
+
<div style="margin-left:0in;margin-right:0in;">[[Image:image176.jpg.png|top]]</div>
  
----
 
  
*'''List Box'''
+
The user must enter the mandatory fields ('''Name''', '''Instructions''', '''Command''', '''Data Type''', '''Value Field, Display Field''' and '''the Parameter SQL''').
  
Choosing this parameter type, the user will create a "'''Multiple Choose List'''" according with the SQL code entered in the command line.
 
  
'''Figure 32: List Box'''  
+
'''Parameter SQL''':&nbsp; this is where the developer selects the text in their report SQL that will be replaced by the values in the parameter they are currently creating. So if in their report sql they had "<%Customers%>" they would see an option in this field that would say "Customers". That's where the application would insert the customers the users select when they execute the report.
  
[[Image:32 MESWeb Admin.png|32 MESWeb Admin.png]]<br>
+
'''Data Type''': this indicates what kind of data will be inserted. It is the value type (integer, string, date, and double);
  
The user must enter the mandatory fields ('''Name''', '''Instructions''', '''Command''', '''Data Type''', '''Value Field''', '''Display Field''' and the '''Parameter SQL''') already described and:
+
'''Command''': this is used to enter the SQL query that will fill the list with the data;
  
'''Rows''': this allows developers to configure how many rows the user can see in the boxes at a time. When<nowiki>’</nowiki>s there<nowiki>’</nowiki>s going to be several hundred choices for the user it might help for them to select a higher number making it easier to search through all of them;  
+
'''Value Field''': this field is the column name. This value will be substituted in the SQL Code;
  
'''Select Maximum''': this puts a limit on how many items the user can select in the parameter. If there are maybe 10,000 options for the user to choose you wouldn<nowiki>’</nowiki>t want to allow them to select that many;  
+
'''Display Field''': this column name that will be displayed to the user;
  
'''Max Exceeded Msg''': message that will be displayed if the user tries to select more data that was set in the '''Select Maximum''' field.  
+
'''Required''': this field defines if the field is mandatory or not;
 +
 
 +
'''Note''': The '''Optional Item''' section will be displayed if the '''Required''' field is not checked and it will be used to remove or replace code lines in the SQL Code in the Execution Module. This action is the same for all parameters types.
 +
 
 +
Check the '''All Option''' check box if you want to add an option to choose “'''All'''“items in the list.
 +
 
 +
 
 +
'''Figure 32: Optional Item'''
 +
 
 +
<div style="margin-left:0in;margin-right:0in;">[[Image:image68.jpg.png|top]]</div>
 +
 
 +
 
 +
<div style="margin-left:0in;margin-right:0in;">Select '''Add '''to open the maintenance screen.</div>
 +
 
 +
 
 +
'''Figure 33: Optional Item Maintenance'''
 +
 
 +
<div style="margin-left:0in;margin-right:0in;">[[Image:image173.png.png|top]]</div>
 +
 
 +
 
 +
<div style="margin-left:0in;margin-right:0in;">For example, the user can remove the <%location%> command and replace it for any value he wants.</div>
 +
 
 +
<div style="margin-left:0in;margin-right:0in;">Select '''Save '''to commit.</div>
 +
 
 +
<div style="margin-left:0in;margin-right:0in;">During the report execution, if no value is entered for this command, it will be replaced or removed automatically.</div>
 +
 
 +
<div style="margin-left:0in;margin-right:0in;">Also, the user can '''Edit''' or '''Delete''' items by clicking on '''Edit''' / '''Delete '''buttons. Select '''Save''' to commit.</div>
 +
 
 +
 
 +
'''Figure 34: Parents'''
 +
 
 +
[[Image:image117.jpg.png|top]]
 +
 
 +
 
 +
Add '''Parent Parameter''' is a functionality that helps to share parameters between steps.# <div style="margin-left:0.5in;margin-right:0in;">Create a new Step;</div>
 +
# <div style="margin-left:0.5in;margin-right:0in;">Create '''New Parameter''', fill out '''Parameter Name''', '''Parameter Type''', etc;</div>
 +
# <div style="margin-left:0.5in;margin-right:0in;">Click '''Add Parents '''in order to be able to use a parameter from other step. In this case we have available the '''Data Source '''parameter because is the parameter in step 1;</div>
 +
# <div style="margin-left:0.5in;margin-right:0in;">Now the useer can use the parent parameter to write a query in Command field.</div>
 +
 
 +
 
 +
The parents are the paramters created in the previous steps and they could be used in the command query.
 +
 
 +
 
 +
For example:
 +
 
 +
<div style="margin-left:0in;margin-right:0in;">select ***** where *** = <%param_2%>where the tag <%param_2%> which is releated to the selected parent parameter (choosen as parent).</div>
 +
 
 +
 
 +
'''Figure 35: Add Parents'''
 +
 
 +
[[Image:image60.jpg.png|top]]
 +
 
 +
 
 +
# <div style="margin-left:0.5in;margin-right:0in;">'''List Box'''</div>
 +
 
 +
 
 +
 
 +
<div style="margin-left:0in;margin-right:0in;">Choosing this parameter type, the user will create a “'''Multiple Choose List'''” according with the SQL code entered in the command line.</div>
 +
 
 +
 
 +
'''Figure 36: List Box'''
 +
 
 +
<div style="margin-left:0in;margin-right:0in;">[[Image:image181.jpg.png|top]]</div>
 +
 
 +
 
 +
The user must enter the mandatory fields ('''Name''', '''Instructions''', '''Command''', '''Data Type''', '''Value Field''', '''Display Field''' and the '''Parameter SQL''') already described and:
 +
 
 +
 
 +
'''Rows''': this allows developers to configure how many rows the user can see in the boxes at a time. When's there's going to be several hundred choices for the user it might help for them to select a higher number making it easier to search through all of them;
  
It is the same for options. The user must enter the mandatory fields ('''Name''', '''Instructions''' and the '''Parameter''' SQL).
+
'''Select Maximum''': this puts a limit on how many items the user can select in the parameter. If there are maybe 10,000 options for the user to choose you wouldn't want to allow them to select that many;
  
----
+
'''Max Exceeded Msg''': message that will be displayed if the user tries to select more data that was set in the '''Select Maximum''' field.
  
*'''Customer List Box'''
 
  
This option is the same as '''List Box''';
+
It is the same for options. The user must enter the mandatory fields ('''Name''', '''Instructions''' and the '''Parameter''' SQL).
  
'''Figure 33: Customer List Box'''
 
  
[[Image:33 MESWeb Admin.png|33 MESWeb Admin.png]]<br>  
+
# <div style="margin-left:0.5in;margin-right:0in;">'''Data Range'''</div>
  
The fields '''Rows''', '''Select Maximum''', '''Max Exceeded Msg,''' '''Command''', '''Data Type''', '''Value Field''' and '''Display Field''' are already configured. The user will just enter the data for Instructions and Parameter SQL fields.
 
  
The result for this option is a customer
 
  
For Customer Order List Box, Department List Box, Location List Box, Product List Box, Route List Box, Shift List Box, Shop Order List Box and Process List Box options have the same configuration.
+
<div style="margin-left:1in;margin-right:0in;"></div>
  
'''Note''': These options are available when the '''Data Source Type''' selected is '''MESR'''.  
+
<div style="margin-left:0in;margin-right:0in;">This option is used to set a range of date.</div>
  
----
+
'''Figure 37: Data Range'''
  
*'''Data Range'''
+
[[Image:image132.jpg.png|top]]
  
This option is used to set a range of date.
 
  
'''Figure 34: Data Range'''  
+
The user must enter the mandatory fields ('''Name''' and '''Instructions)''' already described;
  
[[Image:34 MESWeb Admin.png|34 MESWeb Admin.png]]<br> The user must enter the mandatory fields ('''Name''' and '''Instructions)''' already described;
 
  
'''Start SQL''': it is the parameter name that will be substituted for the initial date range;  
+
'''Start SQL''': it is the parameter name that will be substituted for the initial date range;
  
 
'''End SQL''': it is the parameter name that will be substituted for the final date range;  
 
'''End SQL''': it is the parameter name that will be substituted for the final date range;  
Line 490: Line 730:
 
'''Max Day Range''': it is maximum quantity of days in the initial and final date range;  
 
'''Max Day Range''': it is maximum quantity of days in the initial and final date range;  
  
'''Display Time''': Choosing this check box, the field to choose the time is displayed;  
+
'''Display Time''': Choosing this check box, the field to choose the time is displayed;
 +
 
 +
 
 +
# <div style="margin-left:0.5in;margin-right:0in;">'''Date Time'''</div>
 +
 
 +
 
 +
 
 +
<div style="margin-left:0in;margin-right:0in;">This parameter type will allow the user to choose date and time.</div>
 +
 
 +
'''Figure 37: Date Time'''
 +
 
 +
[[Image:image67.jpg.png|top]]
 +
 
 +
 
 +
The user must enter the mandatory fields ('''Name, Parameter SQL''' and '''Instructions)''' already described;
 +
 
 +
 
 +
# <div style="margin-left:0.5in;margin-right:0in;">'''Check Box'''</div>
 +
 
 +
 
 +
 
 +
<div style="margin-left:0in;margin-right:0in;"></div>
 +
 
 +
<div style="margin-left:0in;margin-right:0in;">This will allow the users to choose values ('''Yes''' or '''No''', '''On '''or '''Off''' or '''True''' or '''False''').</div>
 +
 
 +
 
 +
'''Figure 38: Check Box'''
 +
 
 +
[[Image:image118.jpg.png|top]]
 +
 
 +
 
 +
The user must enter the mandatory fields ('''Name, Parameter SQL''' and '''Instructions)''' already described;
 +
 
 +
 
 +
# <div style="margin-left:0.5in;margin-right:0in;">'''Text Box'''</div>
 +
 
 +
 
 +
 
 +
<div style="margin-left:0in;margin-right:0in;"></div>
 +
 
 +
<div style="margin-left:0in;margin-right:0in;">This allows the user to set any text entry.</div>
  
----
+
'''Figure 39: Text Box'''
  
*'''Date Time'''
+
[[Image:image93.jpg.png|top]]
  
This parameter type will allow the user to choose date and time.
 
  
'''Figure 35: Date Time'''
 
  
[[Image:35 MESWeb Admin.png|35 MESWeb Admin.png]]<br>
+
The user must enter the mandatory fields ('''Name, Parameter SQL''' and '''Instructions)''' already described;
  
The user must enter the mandatory fields ('''Name, Parameter SQL''' and '''Instructions)''' already described;
+
'''Default Value''': this is the initial value that will be displayed in the Execution Module.
  
----
+
'''Validation''': it will allow the user to add a validation for this field (Text Box).
  
*'''Check Box'''
 
  
This will allow the users to choose values ('''Yes''' or '''No''', '''On '''or '''Off''' or '''True''' or '''False''').
+
'''Figure 40: Validation Field'''
  
'''Figure 36: Check Box'''
+
[[Image:image161.jpg.png|top]]
  
[[Image:36 MESWeb Admin.png|36 MESWeb Admin.png]]<br> The user must enter the mandatory fields ('''Name, Parameter SQL''' and '''Instructions)''' already described;
 
  
----
+
There are four validation types:
  
*'''Text Box'''
 
  
This allows the user to set any text entry.  
+
# <div style="margin-left:0.5in;margin-right:0in;">'''Data Type Validation'''</div>
  
'''Figure 37: Text Box'''
 
  
[[Image:37 MESWeb Admin.png|37 MESWeb Admin.png]]<br>
 
  
The user must enter the mandatory fields ('''Name, Parameter SQL''' and '''Instructions)''' already described;
+
'''Figure 41: Validation: Data Type'''
  
'''Default Value''': this is the initial value that will be displayed in the Execution Module.  
+
[[Image:image79.jpg.png|top]]
  
'''Validation''': it will allow the user to add a validation for this field (Text Box).
 
  
'''Figure 38: Validation Field'''
+
If the user enters a different value chosen in the Data Type, the field will be invalid and an error message that was configured in the “Error Msg” field is displayed.
  
[[Image:38 MESWeb Admin.png]]<br> There are four validation types:
 
  
*'''Data Type Validation'''
+
# <div style="margin-left:0.5in;margin-right:0in;">'''Expression Validation'''</div>
  
'''Figure 39: Validation: Data Type'''
 
  
[[Image:39 MESWeb Admin.png|39 MESWeb Admin.png]]<br> If the user enters a different value chosen in the Data Type, the field will be invalid and an error message that was configured in the "Error Msg" field is displayed.
 
  
*'''Expression Validation'''
 
  
'''Figure 40: Validation: Expression'''  
+
'''Figure 42: Validation: Expression'''
  
[[Image:40 MESWeb Admin.png|40 MESWeb Admin.png]]<br>
+
[[Image:image62.jpg.png|top]]
  
Choosing the "'''Expression'''" as validation, the user is able to add an expression (e.g. <font size="1">/<nowiki>^[</nowiki>a-zA-Z0-9<nowiki>][</nowiki>a-zA-Z0-9\._-<nowiki>]+</nowiki>@(<nowiki>[</nowiki>a-zA-Z0-9\._-<nowiki>]+</nowiki>\.)<nowiki>[</nowiki>a-zA-Z-0-9<nowiki>]{</nowiki>2<nowiki>}</nowiki>/)).</font>
 
  
If the user enters a different value that is not accepted for the expression, the field will be invalid and an error message that was configured in the "Error Msg" field is displayed.  
+
Choosing the “'''Expression'''” as validation, the user is able to add an expression (e.g. <span style="color:#000000;">/^[a-zA-Z0-9][a-zA-Z0-9\._-]+@([a-zA-Z0-9\._-]+\.)[a-zA-Z-0-9]{2}/)). </span>
  
*'''Range Validation'''
+
If the user enters a different value that is not accepted for the expression, the field will be invalid and an error message that was configured in the “Error Msg” field is displayed.# <div style="margin-left:0.5in;margin-right:0in;">'''Range Validation'''</div>
  
'''Figure 41: Validation: Range'''
 
  
[[Image:41 MESWeb Admin.png|41 MESWeb Admin.png]]<br> Choosing the "'''Range'''" as validation, the user is able to set a value interval with maximum and minimum values that is configured in the '''Min. Value''' and '''Max. Value''' fields.
 
  
If the user enters a different interval that is not accepted for the expression, the field will be invalid and an error message that was configured in the "'''Error Msg'''" field is displayed.
+
'''Figure 43: Validation: Range'''
  
*'''Value Validation'''
+
[[Image:image6.jpg.png|top]]
  
'''Figure 42: Validation: Value'''
 
  
[[Image:42 MESWeb Admin.png|42 MESWeb Admin.png]]<br> Choosing the "'''Value'''" as validation, the user is able to set a validation for Operator (combo box) that defines which comparison will be done as displayed in the figure 43.  
+
Choosing the '''Range'''as validation, the user is able to set a value interval with maximum and minimum values that is configured in the '''Min. Value''' and '''Max. Value''' fields.  
  
'''Figure 43: Operator Field'''  
+
If the user enters a different interval that is not accepted for the expression, the field will be invalid and an error message that was configured in the “'''Error Msg'''” field is displayed.
  
[[Image:43 MESWeb Admin.png|43 MESWeb Admin.png]]<br>
 
  
'''Compare to''' field will receive the value to be compared with the value entered by the user.
+
# <div style="margin-left:0.5in;margin-right:0in;">'''Value Validation'''</div>
  
If the user enters a different value that is not accepted for the comparison, the field will be invalid and an error message that was configured in the "Error Msg" field is displayed.
 
  
----
 
  
*'''Multi-Line Text Box'''
+
'''Figure 44: Validation: Value'''
  
It is like the '''Text Box''', the difference is that the user can enter with Multiple Data. Each data must be in different lines.  
+
[[Image:image184.jpg.png|top]]
  
'''Figure 44: Multi-Line Text Box'''
 
  
[[Image:44 MESWeb Admin.png|44 MESWeb Admin.png]]<br>
+
Choosing the “'''Value'''” as validation, the user is able to set a validation for Operator (combo box) that defines which comparison will be done as displayed in the figure 43.
 +
 
 +
 
 +
'''Figure 45: Operator Field'''
 +
 
 +
[[Image:image127.jpg.png|top]]
 +
 
 +
 
 +
'''Compare to''' field will receive the value to be compared with the value entered by the user.
 +
 
 +
If the user enters a different value that is not accepted for the comparison, the field will be invalid and an error message that was configured in the “Error Msg” field is displayed.
 +
 
 +
 
 +
# <div style="margin-left:0.5in;margin-right:0in;">'''Multi-Line Text Box'''</div>
 +
 
 +
 
 +
It is like the '''Text Box''', the difference is that the user can enter with Multiple Data. Each data must be in different lines.
 +
 
 +
'''Figure 46: Multi-Line Text Box'''
 +
 
 +
[[Image:image57.jpg.png|top]]
 +
 
  
 
'''Input Limit''' will define the quantity of data can be entered.  
 
'''Input Limit''' will define the quantity of data can be entered.  
Line 586: Line 867:
 
Checking the '''Is Case Sensitive''' will allow to distinguish Lowercase and Uppercase.  
 
Checking the '''Is Case Sensitive''' will allow to distinguish Lowercase and Uppercase.  
  
----
 
  
*'''Radio Button List'''
+
# <div style="margin-left:0.5in;margin-right:0in;">'''Radio Button List'''</div>
 +
 
 +
 
  
 
Choosing the '''Radio Button''' parameter type, all result of the SQL Code configured in the '''Command''' field will be a radio button.  
 
Choosing the '''Radio Button''' parameter type, all result of the SQL Code configured in the '''Command''' field will be a radio button.  
  
'''Figure 45: Radio Button List'''  
+
'''Figure 47: Radio Button List'''
 +
 
 +
<div style="margin-left:0in;margin-right:0in;">[[Image:image104.jpg.png|top]]</div>
 +
 
 +
 
 +
<div style="margin-left:0in;margin-right:0in;">'''Note''': The user will be able to select just one Radio Button.</div>
  
[[Image:45 MESWeb Admin.png|45 MESWeb Admin.png]]<br> '''Note''': The user will be able to select just one Radio Button.
 
  
Select '''Save Parameters''' to commit.  
+
Select '''Save Parameters''' to commit.
  
'''Note''': If there is just one parameter created for a step and the user remove this parameter, the step will be automatically removed.  
+
'''Note''': If there is just one parameter created for a step and the user remove this parameter, the step will be automatically removed.
  
===== Drill Down  =====
 
  
Drill Down is a link to another report. It is used to see detailed data in a separated report.
+
#
 +
##
 +
###
 +
#### <div style="margin-left:2in;margin-right:0in;">'''Drill Down'''</div>
  
'''Figure 46: Drill Down'''
 
  
'''[[Image:46 MESWeb Admin.png|46 MESWeb Admin.png]]'''
 
  
==== Add Drill Down ====
+
Drill Down is a link to another report. It is used to see detailed data in a separated report.
  
To add a DD report, select the Drill Down tab and click on '''Add''' button;
+
'''Figure 48: Drill Down'''
  
'''Figure 47: Add Drill Down Report'''  
+
[[Image:image166.jpg.png|top]]
 +
 
 +
 
 +
#
 +
##
 +
###
 +
####
 +
##### <div style="margin-left:2.5in;margin-right:0in;">'''Add Drill Down '''</div>
 +
 
 +
 
 +
 
 +
To add a''' DD''' report, select the Drill Down tab and click on '''Add''' button;
 +
 
 +
 
 +
'''Figure 49: Add Drill Down Report'''
 +
 
 +
[[Image:image11.jpg.png|top]]
 +
 
 +
 
 +
* <div style="margin-left:0.5in;margin-right:0in;">'''Current Report Column'''</div>
  
[[Image:47 MESWeb Admin.png|47 MESWeb Admin.png]]<br>
 
  
*'''Current Report Column'''
 
  
 
It is possible to create one drill down report per column. All available parent report columns are displayed in the combo box list.  
 
It is possible to create one drill down report per column. All available parent report columns are displayed in the combo box list.  
  
*'''Child Report'''
 
  
It will display just reports that have the same data source type and were published in the same location of the parent report.  
+
* <div style="margin-left:0.5in;margin-right:0in;">'''Child Report'''</div>
 +
 
 +
 
 +
 
 +
It will display just reports that have the same data source type and were published in the same location of the parent report.
  
 
When the user selects a '''Child Report''', all their parameters will be displayed in the list to be set the values that the parameters will receive when the report is executed. For each parameter, there are three values types that could be set as follow:  
 
When the user selects a '''Child Report''', all their parameters will be displayed in the list to be set the values that the parameters will receive when the report is executed. For each parameter, there are three values types that could be set as follow:  
  
No index entries found.  
+
<div style="color:#000000;">No index entries found.</div>
 +
 
 +
 
 +
'''Figure 50: Static Value'''
 +
 
 +
[[Image:image119.jpg.png|top]]
 +
 
 +
'''Static''': will set a fixed value to the DD report parameter;
 +
 
 +
 
 +
'''Figure 51: Field Value'''
 +
 
 +
[[Image:image128.jpg.png|top]]
 +
 
 +
 
 +
<span style="color:#000000;">'''Field'''</span><span style="color:#000000;">: it will be the link value of the parent report that will be displayed in parameter field in the DD report;</span>
 +
 
 +
<div style="color:#000000;">All parent report columns will be displayed. </div>
 +
 
 +
 
 +
'''Figure 52: Parent Parameter'''
 +
 
 +
[[Image:image133.jpg.png|top]]
 +
 
 +
 
 +
'''Parent parameter''': the value of a parameter in the report already chosen as the main will be displayed in the parameter field of the DD report;
  
'''Figure 48: Static Value'''
+
<div style="color:#000000;">All parent report parameters will be displayed. </div>
  
[[Image:48 MESWeb Admin.png]]<br> '''Static''': will set a fixed value to the DD report parameter;
 
  
'''Figure 49: Field Value'''  
+
To finish, click on '''Save''' button or '''Close''' to cancel de action.
  
[[Image:49 MESWeb Admin.png]]<br> '''Field''': it will be the link value of the parent report that will be displayed in parameter field in the DD report;
 
  
All parent report columns will be displayed.  
+
#
 +
##
 +
###
 +
####
 +
##### <div style="margin-left:2.5in;margin-right:0in;">'''Remove'' Drill Down '''''</div>
  
'''Figure 50: Parent Parameter'''
 
  
[[Image:50 MESWeb Admin.png]]<br> '''Parent parameter''': the value of a parameter in the report already chosen as the main will be displayed in the parameter field of the DD report;
 
  
All parent report parameters will be displayed.
+
'''Figure 53: Remove Drill Down'''
  
To finish, click on '''Save''' button or '''Cancel''' to cancel de action.  
+
[[Image:image106.jpg.png|top]]
  
==== Remove Drill Down  ====
 
  
'''Figure 51: Remove Drill Down'''  
+
To remove a drill down, select the report and click on '''Remove''' button. Click on '''Yes '''to confirm or''' Cancel''' to cancel the action.#
 +
##
 +
###
 +
#### <div style="margin-left:2in;margin-right:0in;">'''Testing '''</div>
  
[[Image:51 MESWeb Admin.png|51 MESWeb Admin.png]]<br> To remove a drill down, select the report and click on '''Remove''' button. Click on '''Yes '''to confirm or'''Cancel''' to cancel the action.
 
  
===== Testing  =====
 
  
 
It is useful test the reports before publishing, to do this, after create a report, select '''Testing''' tab.  
 
It is useful test the reports before publishing, to do this, after create a report, select '''Testing''' tab.  
  
'''Figure 52: Testing Reports'''  
+
'''Figure 54: Testing Reports'''
  
[[Image:52 MESWeb Admin.png|52 MESWeb Admin.png]]<br> Note that for each step, there are instructions displayed according to what were defined in the '''Instruction''' field.
+
[[Image:image165.jpg.png|top]]
  
'''Step1'''  
+
 
 +
Note that for each step, there are instructions displayed according to what were defined in the '''Instruction''' field.
 +
 
 +
 
 +
'''Step1'''
  
 
This step will be the Data Source according to the Location and Data Source Type already configured.  
 
This step will be the Data Source according to the Location and Data Source Type already configured.  
  
'''Figure 53: Step1'''  
+
'''Figure 55: Step1'''
 +
 
 +
[[Image:image82.jpg.png|top]]
 +
 
 +
<u>'''NOTE'''</u>: If there is just a single option of data source, it will be automatically displayed. Select '''Next Step''' to continue.
 +
 
 +
'''Step2'''
 +
 
 +
This is the first step created in the '''Parameter''' tab. The parameters that will be displayed in step2 are the ones defined according to the Parameter Type chosen.
 +
 
 +
 
 +
'''Figure 56: Step 2'''
 +
 
 +
[[Image:image70.jpg.png|top]]
 +
 
 +
 
 +
 
 +
'''Output'''
 +
 
 +
 
 +
Note: If there is no other step created, the '''Output''' is displayed. Select '''Go''' to see the result.
 +
 
 +
 
 +
'''Figure 57: Report Result'''
 +
 
 +
[[Image:image98.png.png|top]]
 +
 
 +
 
 +
<u>'''NOTE'''</u>: To execute a drill down report, click on the displayed link.#
 +
##
 +
###
 +
#### <div style="margin-left:2in;margin-right:0in;">'''Summary'''</div>
 +
 
 +
 
 +
 
 +
Go to Summary tab to publish the report.
 +
 
 +
'''Figure 58: Summary'''
 +
 
 +
[[Image:image167.jpg.png|top]]
 +
 
 +
 
 +
Here the user will see the information about the report, the SQL Code and the parameters. This page can’t be edited, it just bring the report summary.
 +
 
 +
 
 +
1. '''Would you like to publish this report'''? Select '''Yes, I want to'''.
 +
 
 +
2. The message should be displayed: '''Thank You'''
 +
 
 +
Your report is now published and ready to be executed in the production environment.
 +
 
 +
 
 +
#
 +
##
 +
### <div style="margin-left:1.5in;margin-right:0in;">'''''Edit Reports'''''</div>
 +
 
 +
 
 +
 
 +
The Edit Report page is the same for Add Reports. See bellow the exceptions:# <div style="margin-left:0.5in;margin-right:0in;">If the report was already published, the '''Owner Location''' can’t be updated;</div>
 +
# <div style="margin-left:0.5in;margin-right:0in;">If the report was already published, '''Summary '''page message is: “Would you like to update this report?” Clicking on ‘Yes, I want to” a new version of this report is created. </div>
 +
 
 +
 
 +
 
 +
<div style="margin-left:0.5in;margin-right:0in;"></div>
 +
 
 +
<div style="margin-left:0in;margin-right:0in;">'''Note''': The user is able to edit several reports at the same time.</div>
  
[[Image:53 MESWeb Admin.png]]<br>
 
  
'''Note''': If there is just a single option of data source, it will be automatically displayed. Select '''Next Step''' to continue.
+
#
 +
##
 +
### <div style="margin-left:1.5in;margin-right:0in;">'''''Copy Report'''''</div>
  
'''Step2'''
 
  
This is the first step created in the '''Parameter''' tab. The parameters that will be displayed in step2 are the ones defined according to the Parameter Type chosen.
 
  
'''Figure 54: Step 2'''  
+
To copy a report, select the report and select '''Copy''' button.
  
[[Image:54 MESWeb Admin.png]]<br>
+
The '''Copy Report''' page is displayed.
  
'''Output'''  
+
'''Figure 59: Copy Report'''
  
Note: If there is no other step created, the '''Output''' is displayed. Select '''Go''' to see the result.  
+
[[Image:image164.jpg.png|top]]
  
'''Figure 55: Report Result'''
 
  
[[Image:55 MESWeb Admin.png|55 MESWeb Admin.png]]<br>
+
Enter the Mandatory fields and select '''Save''' to commit. The Edit page is displayed to make any update if necessary.
  
'''Note''': To execute a drill down report, click on the displayed link.
 
  
===== Summary  =====
+
<u>'''NOTE'''</u>: Only Locations with the data source of the same type as this report are available to copy.
  
Go to Summary tab to publish the report.
 
  
'''Figure 56: Summary'''
 
  
[[Image:56 MESWeb Admin.png|56 MESWeb Admin.png]]<br>
 
  
Here the user will see the information about the report, the SQL Code and the parameters. This page can<nowiki></nowiki>t be edited, it just bring the report summary.
+
#
 +
##
 +
### <div style="margin-left:1.5in;margin-right:0in;">'''''Publish Reports'''''</div>
  
1. '''Would you like to publish this report'''? Select '''Yes, I want to'''.
 
  
2. The message should be displayed: '''Thank You'''
 
  
Your report is now published and ready to be executed in the production environment.  
+
To publish a report, select the report from the list and select '''Publish'''.
  
==== Edit Reports  ====
+
Note that Security Manager users are able to publish for locations that have assigned.
  
The Edit Report page is the same for Add Reports. See bellow the exceptions:
 
  
1. If the report was already published, the '''Owner Location''' can<nowiki>’</nowiki>t be updated;
+
In this functionality, if the report was created and published from the Add or Edit for the chosen location, it will be available for publish for other s. Otherwise, the Publish button will not available.
  
2. If the report was already published, '''Summary '''page message is: "Would you like to update this report?" Clicking on <nowiki>’</nowiki>Yes, I want to" a new version of this report is created.
 
  
'''Note''': The user is able to edit several reports at the same time.
+
'''Figure 60: Publishing Reports'''
  
==== Copy Report  ====
+
[[Image:image92.png.png|top]]
  
To copy a report, select the report and select '''Copy''' button.
 
  
The '''Copy Report''' page is displayed.  
+
The Administrator user is able to:# <div style="margin-left:0.5in;margin-right:0in;">Update the report status that will define if the report will be displayed in the Execution module. Just the Active status will be displayed.</div>
 +
# <div style="margin-left:0.5in;margin-right:0in;">Choose the location and the report group to publish the report.</div>
  
'''Figure 57: Copy Report'''
 
  
[[Image:57 MESWeb Admin.png|57 MESWeb Admin.png]]<br>
 
  
Enter the Mandatory fields and select '''Save''' to commit. The Edit page is displayed to make any update if necessary.
+
<u>'''NOTE'''</u>: Clicking on '''Test this Report''' will execute this report and an execution screen is displayed;
  
'''Note''': Only Locations with the data source of the same type as this report are available to copy.  
+
To remove the location, select the location and select '''Delete'''. The report is no more publish for the selected location.
  
==== Publish Reports  ====
 
  
To publish a report, select the report from the list and select '''Publish'''.  
+
<u>'''NOTE</u>:''' It is not allowed to delete the location that the report was created.
  
Note that Security Manager users are able to publish for locations that have assigned.
 
  
In this functionality, if the report was created and published from the Add or Edit for the chosen location, it will be available for publish for other s. Otherwise, the Publish button will not available.
+
'''Figure 61: Test the Report: Execute'''
  
'''Figure 58: Publishing Reports'''
+
[[Image:image99.png.png|top]]
  
[[Image:58 MESWeb Admin.png|58 MESWeb Admin.png]]<br>
 
  
The Administrator user is able to:
+
For further information about this page, see '''Testing''' tab.
  
*Update the report status that will define if the report will be displayed in the Execution module. Just the Active status will be displayed.
+
Select '''Save''' to commit.
*Choose the location and the report group to publish the report.
 
  
'''Note''': Clicking on '''Test this Report''' will execute this report and an execution screen is displayed;
 
  
To remove the location, select the location and select '''Delete'''. The report is no more publish for the selected location.
+
#
 +
##
 +
### <div style="margin-left:1.5in;margin-right:0in;">'''''History Reports'''''</div>
  
'''Note''': It is not allowed to delete the location that the report was created.
 
  
'''Figure 59: Test the Report: Execute'''
 
  
[[Image:59 MESWeb Admin.png]]<br>
+
'''Figure 62: History Report'''
  
For further information about this page, see '''Testing''' tab.  
+
[[Image:image100.png.png|top]]
  
Select '''Save''' to commit.
 
  
==== History Reports  ====
+
This page displays all created report versions.
  
'''Figure 60: History Report'''
+
The version displayed in blue is the current version.
  
[[Image:60 MESWeb Admin.png]]<br> This page displays all created report versions.
 
  
The version displayed in blue is the current version.  
+
The user is able to rollback the version if there are old versions in the list selecting the version and clicking on RollBack button. The Edit page will be displayed and any update can be done. See Edit topic for further information.
  
The user is able to rollback the version if there are old versions in the list selecting the version and clicking on RollBack button. The Edit page will be displayed and any update can be done. See Edit topic for further information.
 
  
Selecting any version and clicking on Execute button, the Execute page is displayed. . See Test the Report topic for further information.  
+
Selecting any version and clicking on Execute button, the Execute page is displayed. . See Test the Report topic for further information.
 +
 
 +
 
 +
#
 +
##
 +
### <div style="margin-left:1.5in;margin-right:0in;">'''''Predefined'''''</div>
  
<br>
 
  
==== Predefined  ====
 
  
 
The predefined reports code cannot be changed. This kind of reports is considered complex and their code are maintained for the MESWeb development team.  
 
The predefined reports code cannot be changed. This kind of reports is considered complex and their code are maintained for the MESWeb development team.  
  
In the MESWeb Central Predefined functionality, the users are able to map or manage the reports (add and/or edit).
 
  
'''Figure 61: Mapping Predefined Reports'''  
+
In the MESWeb Central Predefined functionality, the users are able to map or manage the reports (add and/or edit).
 +
 
 +
 
 +
'''Figure 63: Mapping Predefined Reports'''
  
[[Image:61 MESWeb Admin.png|61 MESWeb Admin.png]]<br> Administrator and Security Manager users are able to execute this functionality. Due to the chosen location, the users select the reports that the location will have access. These reports will be displayed in the Default Reports list of the chosen location.
+
[[Image:image95.jpg.png|top]]
  
===== Predefined Maintenance =====
+
Administrator and Security Manager users are able to execute this functionality. Due to the chosen location, the users select the reports that the location will have access. These reports will be displayed in the Default Reports list of the chosen location.
 +
 
 +
 
 +
#
 +
##
 +
###
 +
#### <div style="margin-left:2in;margin-right:0in;">'''Predefined Maintenance'''</div>
 +
 
 +
 
 +
 
 +
Administrators '''and''' Security Manager users are able to execute this functionality and it give access to chosen reports to other s.
 +
 
 +
 
 +
# <div style="margin-left:0.5in;margin-right:0in;">'''''Edit Predefined Reports (Maintanance)'''''</div>
  
Administrators and Security Manager users are able to execute this functionality and it give access to chosen reports to other s.
 
  
====== Add Predefined Reports  ======
 
  
 
Just Administrator users are able to add Predefined Reports.  
 
Just Administrator users are able to add Predefined Reports.  
  
'''Figure 62: Add Predefined Reports'''  
+
'''Figure 64: Edit Predefined Reports'''
 +
 
 +
[[Image:image109.jpg.png|top]]
 +
 
 +
 
 +
#
 +
## <div style="margin-left:1.5in;margin-right:0in;">'''''Report Groups'''''</div>
 +
 
 +
 
 +
With this sub module the Administrator and Security Manager users can access report group maintenance to perform searches, create, edit or delete report groups and add reports to groups.
 +
 
 +
 
 +
#
 +
##
 +
### <div style="margin-left:2in;margin-right:0in;">'''''Filter Report Groups'''''</div>
  
[[Image:62 MESWeb Admin.png|62 MESWeb Admin.png]]<br>
 
  
====== Edit Predefined Reports ======
+
The filtering option located in the Report Groups tab allows the Administrator user to search for specific report groups based on the location, name, and/or description.
 +
 
 +
 
 +
# <div style="margin-left:0.5in;margin-right:0in;">To filter the report group list, select a Location from the drop down box provided, and/or enter the Name and/or Description.</div>
 +
# <div style="margin-left:0.5in;margin-right:0in;">Select '''Search '''to filter the list or '''Clear '''to clear all fields. </div>
 +
# <div style="margin-left:0.5in;margin-right:0in;">The results will display in the report group list.</div>
 +
 
 +
 
 +
 
 +
'''Figure 65: Filter Report Groups'''
 +
 
 +
[[Image:image107.jpg.png|top]]
 +
 
 +
 
 +
#
 +
##
 +
### <div style="margin-left:2in;margin-right:0in;">'''''Add Report Groups'''''</div>
 +
 
 +
 
 +
 
 +
This function allows the Administrator to add a report group based on the report group name, description, and location.
 +
 
 +
 
 +
# <div style="margin-left:0.5in;margin-right:0in;">To add a report group, select '''Add '''located above Report Group list.</div>
 +
# <div style="margin-left:0.5in;margin-right:0in;">The Report Group Detail pop up displays.</div>
 +
 
 +
 
 +
'''Figure 66: Add Report Group'''
 +
 
 +
[[Image:image69.jpg.png|top]]
 +
 
 +
 
 +
# <div style="margin-left:0.5in;margin-right:0in;">Enter the Report Group Name and Description and select a Location from the drop down box provided. All fields are mandatory. </div>
 +
# <div style="margin-left:0.5in;margin-right:0in;">Select '''Save''' to confirm addition.</div>
 +
# <div style="margin-left:0.5in;margin-right:0in;">Select '''Cancel '''to exit.</div>
 +
# <div style="margin-left:0.5in;margin-right:0in;">The new report group will appear alphabetically in the report group list.</div>
 +
 
 +
 
 +
 
 +
#
 +
##
 +
### <div style="margin-left:2in;margin-right:0in;">'''''Edit Report Groups'''''</div>
 +
 
 +
 
 +
This function allows the Administrator and Security Manager users to edit a report group’s name, description, and/or location.
 +
 
 +
 
 +
# <div style="margin-left:0.5in;margin-right:0in;">To edit a report group, select the desired report group from the list.</div>
 +
# <div style="margin-left:0.5in;margin-right:0in;">Select '''Edit '''located above the report group list.</div>
 +
# <div style="margin-left:0.5in;margin-right:0in;">The Report Group Detail pop up displays.</div>
 +
 
 +
 
 +
 
 +
'''Figure 67: Edit Report Group'''
 +
 
 +
[[Image:image170.jpg.png|top]]
 +
 
 +
 
 +
<u>'''NOTE'''</u>: Location is a read only field.
 +
 
 +
 
 +
# <div style="margin-left:0.5in;margin-right:0in;">After completing changes, select '''Save '''to confirm.</div>
 +
# <div style="margin-left:0.5in;margin-right:0in;">Select '''Cancel '''to exit without saving.</div>
 +
 
 +
 
 +
#
 +
##
 +
### <div style="margin-left:2in;margin-right:0in;">'''''Delete Report Groups'''''</div>
 +
 
 +
 
 +
 
 +
This function allows the Administrator to delete a report group from the report group list.
 +
 
 +
 
 +
# <div style="margin-left:0.5in;margin-right:0in;">To delete a report group, select the desires report group from the list.</div>
 +
# <div style="margin-left:0.5in;margin-right:0in;">Select '''Delete''' located above the report group list.</div>
 +
# <div style="margin-left:0.5in;margin-right:0in;">A confirmation prompt will display. Select '''Yes '''to confirm or '''No '''to exit.</div>
 +
# <div style="margin-left:0.5in;margin-right:0in;">The report group will be removed from the report group list.</div>
 +
 
 +
 
 +
 
 +
'''Figure 68: Delete Report Group'''
 +
 
 +
[[Image:image124.jpg.png|top]]
 +
 
 +
 
 +
<u>'''NOTE'''</u>: It is not allowed to delete a report group if:# <div style="margin-left:0.5in;margin-right:0in;">A report were created or published to the report group.</div>
 +
# <div style="margin-left:0.5in;margin-right:0in;">Any user has permission for this report group.</div>
 +
 
 +
 
 +
 
 +
<div style="margin-left:0.5in;margin-right:0in;"></div>#
 +
##
 +
### <div style="margin-left:2in;margin-right:0in;">'''''Add Report to Group'''''</div>
 +
 
 +
 
 +
 
 +
This function allows the Administrator to add a report to a report group by searching for its location and data source type.
 +
 
 +
 
 +
# <div style="margin-left:0.5in;margin-right:0in;">To add a report to a report group, select the desired report group from the list.</div>
 +
# <div style="margin-left:0.5in;margin-right:0in;">Select '''Add Report to Group''' located above the report group list.</div>
 +
 
 +
 
 +
'''Figure 69: Add Report to Group'''
 +
 
 +
[[Image:image125.jpg.png|top]]
 +
 
 +
 
 +
# <div style="margin-left:0.5in;margin-right:0in;">The Report to Group pop up displays. Search for the specific report by selecting the location and data source type of the report from the drop down boxes provided.</div>
 +
# <div style="margin-left:0.5in;margin-right:0in;">Select the search icon located to the right of the drop down boxes.</div>
 +
# <div style="margin-left:0.5in;margin-right:0in;">The report will display in the left '''Available '''column. To move the report to the '''Selected '''column, double-click or drag and drop the report. </div>
 +
# <div style="margin-left:0.5in;margin-right:0in;">Select '''Save '''to add the report to the report group.</div>
 +
# <div style="margin-left:0.5in;margin-right:0in;">Select '''Cancel '''to exit.</div>
 +
 
 +
 
 +
# <div style="margin-left:0.5in;margin-right:0in;">'''Access Control '''</div>
 +
 
 +
 
 +
<div style="margin-left:0.25in;margin-right:0in;">The Access Control module was developed for employees with Administrator and Security Manager roles. This section will cover how to navigate and execute functions in Access Control. With the Access Control module, the Administrator is able to search, add, delete or edit users or user groups (will be developed). </div>
 +
 
 +
 
 +
# <div style="margin-left:0.5in;margin-right:0in;">To access MESWeb, navigate to '''Administration > MESWeb Central'''.</div>
 +
# <div style="margin-left:0.5in;margin-right:0in;">Select the Access Control icon located on the MESWeb Central Main page.</div>
 +
 
 +
 
 +
 
 +
'''Figure 70: MESWeb Central Access Control'''
 +
 
 +
[[Image:image131.jpg.png|top]]
 +
 
 +
 
 +
# <div style="margin-left:0.5in;margin-right:0in;">Upon selecting the Access Control icon, two additional icons become available: Users and User Groups.</div>
 +
 
 +
 
 +
 
 +
<div style="margin-left:0in;margin-right:0in;"></div>
 +
 
 +
'''Figure 71: Access Control Functions'''
 +
 
 +
[[Image:image169.jpg.png|top]]
 +
 
 +
 
 +
# <div style="margin-left:0.5in;margin-right:0in;">Once either icon is selected, it is placed in a tab at the top of the Access Control page. The user can navigate between both icons by placing them in tabs that can be easily accessed. </div>
 +
 
 +
 
 +
 
 +
<div style="color:#0000ff;"></div>
 +
 
 +
'''Figure 72: User Icon in Tab'''
 +
 
 +
[[Image:image103.jpg.png|top]]
 +
 
 +
 
 +
<div style="color:#0000ff;"></div>#
 +
## <div style="margin-left:1in;margin-right:0in;">'''''Users'''''</div>
 +
 
 +
 
 +
 
 +
The Users icon under the Access Control screen in MESWeb Central allows Administrators to manage user permissions and edit user information. With this portlet, administrators can assign Administrator permissions to specific users for assigned locations and edit the user’s information.
 +
 
 +
 
 +
#
 +
##
 +
### <div style="margin-left:1.5in;margin-right:0in;">'''''Filter Users'''''</div>
 +
 
 +
 
 +
 
 +
The filtering option located in the '''Users''' tab allows the Administrator to search for specific employees by User Name, Full Name, and/or Email.
 +
 
 +
 
 +
# <div style="margin-left:0.8in;margin-right:0in;">To filter the User List, enter the desired User Name, Full Name, and/or Email address into the provided fields. </div>
 +
# <div style="margin-left:0.8in;margin-right:0in;">Select '''Search''' to filter users.</div>
 +
# <div style="margin-left:0.8in;margin-right:0in;">Select '''Clear '''to clear all fields.</div>
 +
 
 +
 
 +
 
 +
 
 +
 
 +
'''Figure 73: Filter User List'''
 +
 
 +
[[Image:image24.jpg.png|top]]
 +
 
 +
 
 +
#
 +
##
 +
### <div style="margin-left:1.5in;margin-right:0in;">'''''Manage Permissions'''''</div>
 +
 
 +
 
 +
 
 +
This function allows Administrators to assign Administrator permissions to users for specific locations.
 +
 
 +
 
 +
# <div style="margin-left:0.8in;margin-right:0in;">To assign Administrator permissions to a user, select a user from the list by placing a check in the box to the left of the User Name. </div>
 +
# <div style="margin-left:0.8in;margin-right:0in;">Select '''Manage Permissions'''.</div>
 +
# <div style="margin-left:0.8in;margin-right:0in;">The User Permissions pop up displays.</div>
 +
 
 +
 
 +
'''Figure 74: User Permissions'''
 +
 
 +
[[Image:image48.jpg.png|top]]
 +
 
 +
 
 +
# <div style="margin-left:0.8126in;margin-right:0in;">With this pop up, the administrator can assign Administrator permissions to a user by checking the box to the right of the Administrator option.</div>
 +
# <div style="margin-left:0.8126in;margin-right:0in;">Upon selecting a location, two panels display allowing the Administrator to assign Roles, Report Groups, Reports, Mesr Customers, Data Source, and Group Permissions to the user.</div>
 +
 
 +
 
 +
'''Figure 75: Assign Privileges (User Permissions)'''
 +
 
 +
[[Image:image58.jpg.png|top]]
 +
 
 +
 
 +
# <div style="margin-left:0.5in;margin-right:0in;">To move an '''Available''' Role/Report Group/Report/Mesr Customer/Data Sources to the '''Selected '''column, double-click or drag and drop the selection.</div>
 +
 
 +
 
 +
 
 +
<div style="margin-left:0.5in;margin-right:0in;"></div>
 +
 
 +
<u>'''NOTE'''</u>: Under the '''Mesr Customers''' tab, the Administrator must first select a Data Source from the drop down box before moving customers to the selected column.
 +
 
 +
 
 +
# <div style="margin-left:0.5in;margin-right:0in;">After moving all applicable selections in each tab, select '''Save '''to assign permissions to the user.</div>
 +
# <div style="margin-left:0.5in;margin-right:0in;">Select '''Cancel '''to exit.</div>
 +
# <div style="margin-left:0.5in;margin-right:0in;">The user will appear in the user list with the '''Administrator''' box selected.</div>
 +
 
 +
 
 +
#
 +
##
 +
### <div style="margin-left:1.5in;margin-right:0in;">'''''Edit Users'''''</div>
 +
 
 +
 
 +
 
 +
This function allows Administrators to edit the following user information:* <div style="margin-left:0.5in;margin-right:0in;">Full Name</div>
 +
* <div style="margin-left:0.5in;margin-right:0in;">Email</div>
 +
* <div style="margin-left:0.5in;margin-right:0in;">Language (under development)</div>
 +
* <div style="margin-left:0.5in;margin-right:0in;">If Active</div>
 +
* <div style="margin-left:0.5in;margin-right:0in;">If Expires</div>
 +
* <div style="margin-left:0.5in;margin-right:0in;">Expiration Date</div>
 +
* <div style="margin-left:0.5in;margin-right:0in;">If Customer</div>
 +
* <div style="margin-left:0.5in;margin-right:0in;">Hide Main Navigation</div>
 +
* <div style="margin-left:0.5in;margin-right:0in;">Show Icons</div>
 +
 
 +
 
 +
# <div style="margin-left:0.5in;margin-right:0in;">To edit users, select the desired user from the user name list and then select '''Edit.'''</div>
 +
 
 +
 
 +
'''Figure 76: Edit Users'''
 +
 
 +
[[Image:image74.jpg.png|top]]
 +
 
 +
 
 +
# <div style="margin-left:0.5in;margin-right:0in;">The User Search Detail pop up displays. All fields are available to edit except for the user name. Make desired changes and then select '''Save'''.</div>
 +
# <div style="margin-left:0.5in;margin-right:0in;">Select '''Cancel '''to exit.</div>
 +
 
 +
 
 +
'''Figure 77: User Search Detail'''
 +
 
 +
[[Image:image78.jpg.png|top]]
 +
 
 +
 
 +
#
 +
##
 +
### <div style="margin-left:1.5in;margin-right:0in;">'''''Import Users'''''</div>
 +
 
 +
 
 +
 
 +
This function allows Administrators to import several uses at the same time using the available Template.
 +
 
 +
Select the Import buttom and the Import Users dialog displays.
 +
 
 +
 
 +
'''Figure 78: Import Users'''
 +
 
 +
[[Image:image51.jpg.png|top]]
 +
 
 +
 
 +
Search the file and select it. It is possible to skip existing users or update them by selecting the radion buttons.
 +
 
 +
 
 +
Selecting the''' Get Template''' buttom, the user gets a template that can be filled and imported with new users.
 +
 
 +
 
 +
'''Figure 79: Import Users Template'''
 +
 
 +
[[Image:image83.jpg.png|top]]
 +
 
 +
 
 +
#
 +
## <div style="margin-left:1in;margin-right:0in;">'''''User Groups'''''</div>
 +
 
 +
 
 +
<div style="margin-left:0in;margin-right:0in;"></div>
 +
 
 +
The User Groups icon under the Access Control screen in MESWeb Central allows Administrators to manage user Groups by add, edit, delete, manage users and manage permissions.
 +
 
 +
 
 +
To access the User Groups, select the''' User Groups '''icon in the left panel. The User Groups tab is displayed.
 +
 
 +
 
 +
'''Figure 80: User Groups Main Page'''
 +
 
 +
[[Image:image140.jpg.png|top]]
 +
 
 +
 
 +
#
 +
##
 +
### <div style="margin-left:1.5in;margin-right:0in;">'''''Filter User Groups'''''</div>
  
Just Administrator users are able to add Predefined Reports.
 
  
'''Figure 63: Edit Predefined Reports'''
 
  
[[Image:63 MESWeb Admin.png|63 MESWeb Admin.png]]<br>
+
The filtering option located in the '''User Groups''' tab allows the Administrator to search for specific groups by User Groups Name or Location.
  
=== Report Groups  ===
 
  
With this module the Administrator and Security Manager users can access report group maintenance to perform searches, create, edit or delete report groups and add reports to groups.  
+
# <div style="margin-left:0.8in;margin-right:0in;">To filter the User Group List, enter the desired Name, and/or Location into the provided fields. </div>
 +
# <div style="margin-left:0.8in;margin-right:0in;">Select '''Search''' to filter users.</div>
 +
# <div style="margin-left:0.8in;margin-right:0in;">Select '''Clear '''to clear all fields.</div>
  
==== Filter Report Groups  ====
 
  
The filtering option located in the Report Groups tab allows the Administrator user to search for specific report groups based on the location, name, and/or description.
 
  
1. To filter the report group list, select a Location from the drop down box provided, and/or enter the Name and/or description.
+
'''Figure 81: Filter User List'''
  
2. Select '''Search '''to filter the list or '''Clear '''to clear all fields.  
+
[[Image:image76.jpg.png|top]]
  
3. The results will display in the report group list.
 
  
'''Figure 64: Filter Report Groups'''  
+
#
 +
##
 +
### <div style="margin-left:1.5in;margin-right:0in;">'''''Add User Groups'''''</div>
  
[[Image:64 MESWeb Admin.png|64 MESWeb Admin.png]]<br>
 
  
==== Add Report Groups  ====
+
This function allows the Administrator to add a user group based on the user group name, description, and location.
  
This function allows the Administrator to add a report group based on the group name, description, and location.
 
  
1. To add a report group, select '''Add '''located above Report Group list.  
+
# <div style="margin-left:0.5in;margin-right:0in;">To add a user group, select '''Add '''located above User Group list.</div>
 +
# <div style="margin-left:0.5in;margin-right:0in;">The User Group Detail pop up displays.</div>
  
2. The Report Group Detail from displays.
 
  
'''Figure 65: Add Report Group'''
 
  
[[Image:65 MESWeb Admin.png|65 MESWeb Admin.png]]<br> 3. Enter the Group Name and Description and select a Location from the drop down box provided. All fields are mandatory. (This screen must be re-captured)
+
'''Figure 82: Add User Group'''
  
4. Select '''Save''' to confirm addition.  
+
[[Image:image49.jpg.png|top]]
  
5. Select '''Cancel '''to exit.
 
  
6. The new report group will appear alphabetically in the report group list.  
+
# <div style="margin-left:0.5in;margin-right:0in;">Enter the Name and Description and select a Location from the drop down box provided. All fields are mandatory.</div>
 +
# <div style="margin-left:0.5in;margin-right:0in;">Select '''Save''' to confirm addition.</div>
 +
# <div style="margin-left:0.5in;margin-right:0in;">Select '''Cancel '''to exit.</div>
 +
# <div style="margin-left:0.5in;margin-right:0in;">The new user group will appear alphabetically in the report group list.</div>
  
==== Edit Report Groups  ====
 
  
This function allows the Administrator and Security Manager users to edit a report group<nowiki>’</nowiki>s name, description, and/or location.
 
  
1. To edit a report group, select the desired report group from the list.
+
#
 +
##
 +
### <div style="margin-left:1.5in;margin-right:0in;">'''''Edit User Groups'''''</div>
  
2. Select '''Edit '''located above the report group list.
 
  
3. The Report Group Detail form displays.
 
  
'''Figure 66: Edit Report Group'''
+
This function allows the Administrator and Security Manager users to edit a user group’s name and/or description.
  
[[Image:66 MESWeb Admin.png|66 MESWeb Admin.png]]<br>
 
  
<u>NOTE</u>: Location is a read only field.  
+
# <div style="margin-left:0.5in;margin-right:0in;">To edit a user group, select the desired user group from the list.</div>
 +
# <div style="margin-left:0.5in;margin-right:0in;">Select '''Edit '''located above the User Group list.</div>
 +
# <div style="margin-left:0.5in;margin-right:0in;">The User Group Detail pop up displays.</div>
  
4. After completing changes, select '''Save '''to confirm.
 
  
5. Select '''Cancel '''to exit without saving.
 
  
==== Delete Report Groups  ====
+
'''Figure 83: Edit User Group'''
  
This function allows the Administrator to delete a report group from the report group list.  
+
[[Image:image171.jpg.png|top]]
  
1. To delete a report group, select the desires report group from the list.
 
  
2. Select '''Delete''' located above the report group list.  
+
<u>'''NOTE'''</u>: Location is a read only field.
  
3. A confirmation prompt will display. Select '''Yes '''to confirm or '''No '''to exit.
 
  
4. The report group will be removed from the report group list.  
+
# <div style="margin-left:0.5in;margin-right:0in;">After completing changes, select '''Save '''to confirm.</div>
 +
# <div style="margin-left:0.5in;margin-right:0in;">Select '''Cancel '''to exit without saving.</div>
  
'''Figure 67: Delete Report Group'''
 
  
[[Image:67 MESWeb Admin.png|67 MESWeb Admin.png]]<br> Note: It is not allowed to delete a report group if:
+
#
 +
##
 +
### <div style="margin-left:1.5in;margin-right:0in;">'''''Delete User Groups'''''</div>
  
*A report were created or published to the report group.
 
*Any user has permission for this report group.
 
  
==== Add Report to Group  ====
 
  
This function allows the Administrator to add a report to a report group by searching for its location and data source.  
+
This function allows the Administrator to delete a user group from the user group list.
  
1. To add a report to a report group, select the desired report group from the list.
 
  
2. Select '''Add Report to Group''' located above the report group list.  
+
# <div style="margin-left:0.5in;margin-right:0in;">To delete a user group, select the desired user group from the list.</div>
 +
# <div style="margin-left:0.5in;margin-right:0in;">Select '''Delete''' located above the user group list.</div>
 +
# <div style="margin-left:0.5in;margin-right:0in;">A confirmation prompt will display. Select '''Yes '''to confirm or '''No '''to exit.</div>
 +
# <div style="margin-left:0.5in;margin-right:0in;">The user group will be removed from the user group list.</div>
  
'''Figure 68: Add Report to Group'''
 
  
[[Image:68 MESWeb Admin.png|68 MESWeb Admin.png]]<br> 3. The Report to Group form displays. Search for the specific report by selecting the location and data source type of the report from the drop down boxes provided.
 
  
4. Select the search icon located to the right of the drop down boxes.
+
'''Figure 84: Delete Report Group'''
  
5. The report will display in the left '''Available '''column. To move the report to the '''Selected '''column, double-click or drag and drop the report.  
+
[[Image:image97.jpg.png|top]]
  
6. Select '''Save '''to add the report to the report group.
 
  
7. Select '''Cancel '''to exit.  
+
<u>'''NOTE'''</u>: It is not allowed to delete a user group if:# <div style="margin-left:0.5in;margin-right:0in;">the user group has users assigned;</div>
  
'''Figure 69: Report to Group Form'''
 
  
[[Image:69 MESWeb Admin.png|69 MESWeb Admin.png]]<br>  
+
<div style="color:#ff0000;"></div>
  
== Access Control  ==
+
It is possible select more than a user group at the same time to make a massive delete.
  
The Access Control module was developed for employees with Administrator and Security Manager roles. This section will cover how to navigate and execute functions in Access Control. With the Access Control module, the Administrator is able to search, add, delete or edit users or user groups (will be developed).
 
  
1. To access MESWeb, navigate to '''Administration <nowiki>></nowiki> MESWeb Central'''.
+
#
 +
##
 +
### <div style="margin-left:1.5in;margin-right:0in;">'''''Mapping User'''''</div>
  
2. Select the Access Control icon located on the MESWeb Central Main screen.
 
  
'''Figure 70: MESWeb Central Access Control'''
 
  
[[Image:SOP-5-I-MES00-C-MESWeb-Central-Access-Control.jpg]]<br>
+
This functionality map user to a selected group.
  
<br> 3. Upon selecting the Access Control icon, two additional icons become available: Users and User Groups.  
+
To map users, follow the stepes bellow:# <div style="margin-left:0.5in;margin-right:0in;">Select a group name in the list and select Mapping User;</div>
 +
# <div style="margin-left:0.5in;margin-right:0in;">The '''Mapping User''' pop up displays;</div>
 +
# <div style="margin-left:0.5in;margin-right:0in;">In the rigth side of the page, the filter will display the users registered in the system. Just move the user to the left side and it will be part of the group.</div>
 +
# <div style="margin-left:0.5in;margin-right:0in;">To remove users from the group, move the user to the right side.</div>
  
'''Figure 71: Access Control Functions'''
 
  
[[Image:SOP-5-I-MES00-C-MESWeb-Access-Control-Functions.jpg]]<br>
 
  
<br> 4. Once either icon is selected, it is placed in a tab at the top of the Access Control Page. The user can navigate between both icons by placing them in tabs that can be easily accessed.
+
'''Figure 85: Mapping User '''
  
'''Figure 72: User Icon in Tab'''<br>
+
[[Image:image142.jpg.png|top]]
  
[[Image:72 MESWeb Admin.png|72 MESWeb Admin.png]]<br>
 
  
=== Users ===
+
#
 +
##
 +
###
 +
#### <div style="margin-left:2in;margin-right:0in;">'''Import Users to Group'''</div>
  
The Users icon under the Access Control screen in MESWeb Central allows Administrators to manage user permissions and edit user information. With this portlet, administrators can assign Administrator permissions to specific users for assigned locations and edit the user<nowiki>’</nowiki>s information.
 
  
==== Filter Users  ====
 
  
The filtering option located in the '''Users''' tab allows the Administrator to search for specific employees by User Name, Full Name, and/or Email.  
+
This function allows Administrators to import several uses at the same time using the available Template.
  
1. To filter the User List, enter the desired User Name, Full Name, and/or Email address into the provided fields.  
+
Select the Import buttom and the Import Users pop up displays.
  
2. Select '''Search''' to filter users.
 
  
3. Select '''Clear '''to clear all fields.
+
'''Figure 86: Import Users to Group'''
  
'''Figure 73: Filter User List'''
+
[[Image:image85.jpg.png|top]]
  
[[Image:73 MESWeb Admin.png|73 MESWeb Admin.png]]<br>
 
  
==== Add Users  ====
+
Search the file and select it. It is possible to skip not found users or update them by selecting the available radion buttons.
  
NOTE: Information for the new user must already exist in the system.
 
  
1. '''Filter''' the User list by entering the User Name, Full Name, and/or Email address into the provided fields.  
+
Selecting the''' Get Template''' buttom, the user gets a template that can be filled and imported with new users.
  
2. Select the user you wish to add by checking the box to the left of the User Name.
 
  
3. Select '''Add'''.
+
'''Figure 87: Import Users Template'''
  
NOTE: The '''Add''' icon will only display when a user who is not "Active" is selected.
+
[[Image:image59.jpg.png|top]]#
 +
##
 +
### <div style="margin-left:1.5in;margin-right:0in;">'''''Manage Permissions'''''</div>
  
'''Figure 73: Add User'''
 
  
[[Image:AddUser.png]]<br> <br> The User Search Detail window displays.
 
  
'''Figure 74: User Search Detail'''
+
This function allows Administrators to assign permissions for groups.
  
[[Image:AddUser2.PNG]]<br> <br> 4. Select the radio button to the right of "Active" to Activate the user.
 
  
5. Select '''Save'''.  
+
# <div style="margin-left:0.8in;margin-right:0in;">To assign user group permissions, select a Name from the list by placing a check in the box to the left of the Name. </div>
 +
# <div style="margin-left:0.8in;margin-right:0in;">Select '''Manage Permissions'''.</div>
 +
# <div style="margin-left:0.8in;margin-right:0in;">The User Group Permissions pop up displays.</div>
  
'''Figure 75: Activate the User'''
 
  
[[Image:AddUser3.png]]<br>
 
  
The user is now "Active", which adds him/her to the system. <br>
+
'''Figure 88: Manage PermissionsUser Group Permissions'''
  
==== Manage Permissions  ====
+
[[Image:image77.jpg.png|top]]
  
This function allows Administrators to assign Administrator permissions to users for specific locations.
 
  
1. To assign Administrator permissions to a user, select a user from the list by placing a check in the box to the left of the User Name.
+
'''Figure 89: Assign Privileges'''
  
2. Select '''Manage Permissions'''.  
+
[[Image:image178.jpg.png|top]]
  
'''Figure 74: Manage Permissions'''
 
  
[[Image:74 MESWeb Admin.png|74 MESWeb Admin.png]]<br>  
+
# <div style="margin-left:0.5in;margin-right:0in;">To move an '''Available''' Role/Report Group/Report/Mesr Customer/Data Sources to the '''Selected '''column, double-click or drag and drop the selection.</div>
  
3. The User Permissions form displays.
 
  
'''Figure 75: User Permissions Form'''
 
  
[[Image:75 MESWeb Admin.png]]<br> 4. With this form, the administrator can assign Administrator permissions to a user by checking the box to the right of the Administrator option.
+
<div style="margin-left:0.5in;margin-right:0in;"></div>
  
6. Upon selecting a location, two panels display allowing the Administrator to assign Roles, Report Groups, Reports, and Mesr Customers to the user.  
+
<u>'''NOTE'''</u>: Under the '''Mesr Customers''' tab, the Administrator must first select a Data Source from the drop down box before moving customers to the selected column.
  
'''Figure 76: Assign Privileges'''
 
  
[[Image:76 MESWeb Admin.png]]<br>  
+
# <div style="margin-left:0.5in;margin-right:0in;">After moving all applicable selections in each tab, select '''Save '''to assign permissions to the user.</div>
 +
# <div style="margin-left:0.5in;margin-right:0in;">Select '''Cancel '''to exit.</div>
 +
# <div style="margin-left:0.5in;margin-right:0in;">The user will appear in the user list with the '''Administrator''' box selected.</div>
  
7. To move an '''Available''' Role/Report Group/Report/Mesr Customer to the '''Selected '''column, double-click or drag and drop the selection.
 
  
<u>'''NOTE'''</u>: Under the '''Mesr Customers''' tab, the Administrator must first select a Data Source from the drop down box before moving customers to the selected column.
 
  
8. After moving all applicable selections in each tab, select '''Save '''to assign permissions to the user.
+
<div style="margin-left:1in;margin-right:0in;"></div># <div style="margin-left:0.5in;margin-right:0in;">'''Appendix A'''</div>
  
9. Select '''Cancel '''to exit.
 
  
10. The user will appear in the user list with the '''Administrator''' box selected.
 
  
==== Edit Users  ====
+
<div style="margin-left:0.25in;margin-right:0in;">'''''Access Control'''''</div>
  
This function allows Administrators to edit the following user information:
+
<div style="margin-left:0.25in;margin-right:0in;">It is a module that will set the permissions for users and external customers of 42Q</div>
  
*Full Name
 
*Email
 
*Language (under development)
 
*If Active
 
*If Expires
 
*Expiration Date
 
*If Customer
 
*Hide Main Navigation
 
*Show Icons
 
  
1. To edit users, select the desired user from the user name list and then select '''Edit.'''  
+
<div style="margin-left:0.25in;margin-right:0in;">'''''administrator'''''</div>
  
'''Figure 77: Edit Users'''
+
<div style="margin-left:0.25in;margin-right:0in;">the System Administration has full access to MESWeb - all s, all reports, all customers.</div>
  
[[Image:77 MESWeb Admin.png|77 MESWeb Admin.png]]<br>
 
  
2. The User Search Detail form displays. All fields are available to edit except for the user name. Make desired changes and then select '''Save'''.
+
<div style="margin-left:0.25in;margin-right:0in;">'''''customer user'''''</div>
  
3. Select '''Cancel '''to exit.
+
<div style="margin-left:0.2756in;margin-right:0in;">user for external customers to access the application </div>
  
'''Figure 78: User Search Detail'''
 
  
[[Image:78 MESWeb Admin.png]]<br>  
+
<div style="margin-left:0.25in;margin-right:0in;">'''''find username'''''</div>
  
----
+
<div style="margin-left:0.25in;margin-right:0in;">for the "find" when we look up the username we use a web service at the Helpdesk, so it's finding something that's separate from MESWeb</div>
  
== Appendix A  ==
 
  
'''''Access Control'''''  
+
<div style="margin-left:0.25in;margin-right:0in;">'''''MES Web'''''</div>
  
It is a module that will set the permissions for users and external customers of 42Q.  
+
<div style="margin-left:0.25in;margin-right:0in;">application that provides reporting capabilities through a web-based interface.</div>
  
'''''Administrator'''''
 
  
The System Administrator has full access to MESWeb - all s, all reports, all customers.  
+
<div style="margin-left:0.25in;margin-right:0in;">'''''parameters '''''</div>
  
'''''Customer User'''''
+
<div style="margin-left:0.25in;margin-right:0in;">definitions for data, reports, or configurations.</div>
  
User for external customers to access the application.
 
  
'''''Find Username'''''  
+
<div style="margin-left:0.25in;margin-right:0in;">'''''roles '''''</div>
  
For the "find" when we look up the username we use a web service at the Helpdesk, so it<nowiki></nowiki>s finding something that<nowiki>’</nowiki>s separate from MESWeb.
+
<div style="margin-left:0.25in;margin-right:0in;">''user profile inside MESWeb''</div>
  
'''''MES Web'''''
 
  
Application that provides reporting capabilities through a web-based interface.  
+
<div style="margin-left:0.25in;margin-right:0in;">'''''SiteMinder'''''</div>
  
'''''Parameters'''''
+
<div style="margin-left:0.25in;margin-right:0in;">''Universal login of 42Q''</div>
  
Definitions for data, reports, or configurations.
 
  
'''''Roles'''''  
+
<div style="margin-left:0.25in;margin-right:0in;">'''''user'''''</div>
  
''User profile inside MESWeb.''
+
<div style="margin-left:0.25in;margin-right:0in;">the User role is able to execute only those reports specifically granted access to him/her, and may not create new reports or modify existing reports. Administrators may restrict users' access to only that data belonging to specific customers.</div>
  
'''''SiteMinder'''''
 
  
''Universal login of 42Q''  
+
<div style="margin-left:0.25in;margin-right:0in;">'''''username'''''</div>
  
'''''User'''''
+
<div style="margin-left:0.25in;margin-right:0in;">the username is the siteminder username (or a partial string)</div>
  
the User role is able to execute only those reports specifically granted access to him/her, and may not create new reports or modify existing reports. Administrators may restrict users<nowiki>’</nowiki> access to only that data belonging to specific customers.
 
  
'''''Username'''''  
+
# <div style="margin-left:0.5in;margin-right:0in;">'''Revision Log'''</div>
  
The username is the siteminder username (or a partial string)
 
  
----
 
  
== Revision Log  ==
 
  
{| width="91%" cellspacing="0" cellpadding="4" border="2"
+
{| style="border-spacing:0;width:6.5139in;"
 +
|-
 +
| style="background-color:#00a8a8;border-top:0.5pt solid #000001;border-bottom:0.5pt solid #000001;border-left:0.5pt solid #000001;border-right:none;padding-top:0in;padding-bottom:0in;padding-left:0.075in;padding-right:0.075in;color:#ffffff;" | Date
 +
| style="background-color:#00a8a8;border-top:0.5pt solid #000001;border-bottom:0.5pt solid #000001;border-left:0.5pt solid #000001;border-right:none;padding-top:0in;padding-bottom:0in;padding-left:0.075in;padding-right:0.075in;color:#ffffff;" | Author
 +
| style="background-color:#00a8a8;border-top:0.5pt solid #000001;border-bottom:0.5pt solid #000001;border-left:0.5pt solid #000001;border-right:none;padding-top:0in;padding-bottom:0in;padding-left:0.075in;padding-right:0.075in;color:#ffffff;" | Title
 +
| style="background-color:#00a8a8;border-top:0.5pt solid #000001;border-bottom:0.5pt solid #000001;border-left:0.5pt solid #000001;border-right:none;padding-top:0in;padding-bottom:0in;padding-left:0.075in;padding-right:0.075in;color:#ffffff;" | Version
 +
| style="background-color:#00a8a8;border:0.5pt solid #000001;padding-top:0in;padding-bottom:0in;padding-left:0.075in;padding-right:0.075in;color:#ffffff;" | Change Reference
 +
|-
 +
| style="border-top:0.5pt solid #000001;border-bottom:0.5pt solid #000001;border-left:0.5pt solid #000001;border-right:none;padding-top:0in;padding-bottom:0in;padding-left:0.075in;padding-right:0.075in;" | 04/08/14
 +
| style="border-top:0.5pt solid #000001;border-bottom:0.5pt solid #000001;border-left:0.5pt solid #000001;border-right:none;padding-top:0in;padding-bottom:0in;padding-left:0.075in;padding-right:0.075in;" | Elaine Fonaro
 +
| style="border-top:0.5pt solid #000001;border-bottom:0.5pt solid #000001;border-left:0.5pt solid #000001;border-right:none;padding-top:0in;padding-bottom:0in;padding-left:0.075in;padding-right:0.075in;" | Technical Writer
 +
| style="border-top:0.5pt solid #000001;border-bottom:0.5pt solid #000001;border-left:0.5pt solid #000001;border-right:none;padding-top:0in;padding-bottom:0in;padding-left:0.075in;padding-right:0.075in;" | v 1.0
 +
| style="border:0.5pt solid #000001;padding-top:0in;padding-bottom:0in;padding-left:0.075in;padding-right:0.075in;" | This is the first revision of MESWeb - Access Control Work Instruction
 
|-
 
|-
| '''Revision'''
+
| style="border-top:0.5pt solid #000001;border-bottom:0.5pt solid #000001;border-left:0.5pt solid #000001;border-right:none;padding-top:0in;padding-bottom:0in;padding-left:0.075in;padding-right:0.075in;" | 04/08/14
| '''Date'''
+
| style="border-top:0.5pt solid #000001;border-bottom:0.5pt solid #000001;border-left:0.5pt solid #000001;border-right:none;padding-top:0in;padding-bottom:0in;padding-left:0.075in;padding-right:0.075in;" | Ashley Martin
| '''Editor'''
+
| style="border-top:0.5pt solid #000001;border-bottom:0.5pt solid #000001;border-left:0.5pt solid #000001;border-right:none;padding-top:0in;padding-bottom:0in;padding-left:0.075in;padding-right:0.075in;" | Technical Writer
| '''Comment'''
+
| style="border-top:0.5pt solid #000001;border-bottom:0.5pt solid #000001;border-left:0.5pt solid #000001;border-right:none;padding-top:0in;padding-bottom:0in;padding-left:0.075in;padding-right:0.075in;" | v 1.0
 +
| style="border:0.5pt solid #000001;padding-top:0in;padding-bottom:0in;padding-left:0.075in;padding-right:0.075in;" | General Review
 
|-
 
|-
| v 1.0  
+
| style="border-top:0.5pt solid #000001;border-bottom:0.5pt solid #000001;border-left:0.5pt solid #000001;border-right:none;padding-top:0in;padding-bottom:0in;padding-left:0.075in;padding-right:0.075in;" | 07/21/14
| 08/04/14  
+
| style="border-top:0.5pt solid #000001;border-bottom:0.5pt solid #000001;border-left:0.5pt solid #000001;border-right:none;padding-top:0in;padding-bottom:0in;padding-left:0.075in;padding-right:0.075in;" | Elaine Fonaro
| Elaine Fonaro  
+
| style="border-top:0.5pt solid #000001;border-bottom:0.5pt solid #000001;border-left:0.5pt solid #000001;border-right:none;padding-top:0in;padding-bottom:0in;padding-left:0.075in;padding-right:0.075in;" | Technical Writer
| This is the first revision of Access Control: User<nowiki>’</nowiki>s Guide
+
| style="border-top:0.5pt solid #000001;border-bottom:0.5pt solid #000001;border-left:0.5pt solid #000001;border-right:none;padding-top:0in;padding-bottom:0in;padding-left:0.075in;padding-right:0.075in;" | v 1.0
 +
| style="border:0.5pt solid #000001;padding-top:0in;padding-bottom:0in;padding-left:0.075in;padding-right:0.075in;" | Add the Report Module and general review
 
|-
 
|-
| v 1.0  
+
| style="border-top:0.5pt solid #000001;border-bottom:0.5pt solid #000001;border-left:0.5pt solid #000001;border-right:none;padding-top:0in;padding-bottom:0in;padding-left:0.075in;padding-right:0.075in;" | 10/29/14
| 08/04/14  
+
| style="border-top:0.5pt solid #000001;border-bottom:0.5pt solid #000001;border-left:0.5pt solid #000001;border-right:none;padding-top:0in;padding-bottom:0in;padding-left:0.075in;padding-right:0.075in;" | Claudia Urenda
| Ashley Martin
+
 
| General Review
+
Elaine Fonaro
 +
| style="border-top:0.5pt solid #000001;border-bottom:0.5pt solid #000001;border-left:0.5pt solid #000001;border-right:none;padding-top:0in;padding-bottom:0in;padding-left:0.075in;padding-right:0.075in;" | Business Analyst
 +
 
 +
Technical Writer
 +
| style="border-top:0.5pt solid #000001;border-bottom:0.5pt solid #000001;border-left:0.5pt solid #000001;border-right:none;padding-top:0in;padding-bottom:0in;padding-left:0.075in;padding-right:0.075in;" | v1.0
 +
| style="border:0.5pt solid #000001;padding-top:0in;padding-bottom:0in;padding-left:0.075in;padding-right:0.075in;" | Final Review
 
|-
 
|-
| V 1.0  
+
| style="border-top:0.5pt solid #000001;border-bottom:0.5pt solid #000001;border-left:0.5pt solid #000001;border-right:none;padding-top:0in;padding-bottom:0in;padding-left:0.075in;padding-right:0.075in;" | 04/28/16
| 21/7/14
+
| style="border-top:0.5pt solid #000001;border-bottom:0.5pt solid #000001;border-left:0.5pt solid #000001;border-right:none;padding-top:0in;padding-bottom:0in;padding-left:0.075in;padding-right:0.075in;" | Elaine Fonaro
| Elaine Fonaro  
+
| style="border-top:0.5pt solid #000001;border-bottom:0.5pt solid #000001;border-left:0.5pt solid #000001;border-right:none;padding-top:0in;padding-bottom:0in;padding-left:0.075in;padding-right:0.075in;" | Technical Writer
| Add the Report Module and general review
+
| style="border-top:0.5pt solid #000001;border-bottom:0.5pt solid #000001;border-left:0.5pt solid #000001;border-right:none;padding-top:0in;padding-bottom:0in;padding-left:0.075in;padding-right:0.075in;" | v 1.0
 +
| style="border:0.5pt solid #000001;padding-top:0in;padding-bottom:0in;padding-left:0.075in;padding-right:0.075in;" | Converted to 42Q
 
|-
 
|-
| V1.0  
+
| style="border-top:0.5pt solid #000001;border-bottom:0.5pt solid #000001;border-left:0.5pt solid #000001;border-right:none;padding-top:0in;padding-bottom:0in;padding-left:0.075in;padding-right:0.075in;" | 08/05/16
| 29/10/14
+
| style="border-top:0.5pt solid #000001;border-bottom:0.5pt solid #000001;border-left:0.5pt solid #000001;border-right:none;padding-top:0in;padding-bottom:0in;padding-left:0.075in;padding-right:0.075in;" | Elaine Fonaro
| Elaine Fonaro and<br>Claudia Urenda
+
| style="border-top:0.5pt solid #000001;border-bottom:0.5pt solid #000001;border-left:0.5pt solid #000001;border-right:none;padding-top:0in;padding-bottom:0in;padding-left:0.075in;padding-right:0.075in;" | Technical Writer
| Final Review
+
| style="border-top:0.5pt solid #000001;border-bottom:0.5pt solid #000001;border-left:0.5pt solid #000001;border-right:none;padding-top:0in;padding-bottom:0in;padding-left:0.075in;padding-right:0.075in;" | v 1.0
 +
| style="border:0.5pt solid #000001;padding-top:0in;padding-bottom:0in;padding-left:0.075in;padding-right:0.075in;" | Converted to Google Doc
 +
|-
 +
| style="border-top:0.5pt solid #000001;border-bottom:0.5pt solid #000001;border-left:0.5pt solid #000001;border-right:none;padding-top:0in;padding-bottom:0in;padding-left:0.075in;padding-right:0.075in;" | 03/22/18
 +
| style="border-top:0.5pt solid #000001;border-bottom:0.5pt solid #000001;border-left:0.5pt solid #000001;border-right:none;padding-top:0in;padding-bottom:0in;padding-left:0.075in;padding-right:0.075in;" | Elaine Fonaro
 +
| style="border-top:0.5pt solid #000001;border-bottom:0.5pt solid #000001;border-left:0.5pt solid #000001;border-right:none;padding-top:0in;padding-bottom:0in;padding-left:0.075in;padding-right:0.075in;" | Technical Writer
 +
| style="border-top:0.5pt solid #000001;border-bottom:0.5pt solid #000001;border-left:0.5pt solid #000001;border-right:none;padding-top:0in;padding-bottom:0in;padding-left:0.075in;padding-right:0.075in;" | v 1.0
 +
| style="border:0.5pt solid #000001;padding-top:0in;padding-bottom:0in;padding-left:0.075in;padding-right:0.075in;" | Applyed new Template for format.
 +
|-
 +
| style="border-top:0.5pt solid #000001;border-bottom:0.5pt solid #000001;border-left:0.5pt solid #000001;border-right:none;padding-top:0in;padding-bottom:0in;padding-left:0.075in;padding-right:0.075in;" | 05/25/18
 +
| style="border-top:0.5pt solid #000001;border-bottom:0.5pt solid #000001;border-left:0.5pt solid #000001;border-right:none;padding-top:0in;padding-bottom:0in;padding-left:0.075in;padding-right:0.075in;" | Elaine Fonaro
 +
| style="border-top:0.5pt solid #000001;border-bottom:0.5pt solid #000001;border-left:0.5pt solid #000001;border-right:none;padding-top:0in;padding-bottom:0in;padding-left:0.075in;padding-right:0.075in;" | Technical Writer
 +
| style="border-top:0.5pt solid #000001;border-bottom:0.5pt solid #000001;border-left:0.5pt solid #000001;border-right:none;padding-top:0in;padding-bottom:0in;padding-left:0.075in;padding-right:0.075in;" | v 1.0
 +
| style="border:0.5pt solid #000001;padding-top:0in;padding-bottom:0in;padding-left:0.075in;padding-right:0.075in;" | Reviewed and Update all images according new user interface
 +
 
 +
Added the User Group new topic
 
|-
 
|-
| V1.0
 
| 16/01/15
 
| Elaine Fonaro
 
| Rules Updated
 
 
|}
 
|}

Revision as of 19:04, 28 May 2018

42Q Home >Administration > MESWeb Central
RTENOTITLE

 

 

 

MESWeb
MESWeb Central
Version MES15 Portal 1.0
Work Instruction

 

This Work Instruction is 42Q's corporate standard.
This document is under revision control. The latest revision is located on Intranet.
Once printed it is an uncontrolled copy. All alterations to this work instruction require approval.
Contact the IT Global Education and Training Department to submit suggested alterations and or updates.

This edition applies to MES15 Portal 1.0 Application and all subsequent releases and modifications until otherwise indicated in new revisions.

Introduction

MESWeb is a powerful business intelligence application designed from the ground up to simplify reporting from manufacturing execution systems, and empower end users with a streamlined and full-featured web interface. The application includes an ad hoc report design tool that allows users to easily build their own reports and modify existing ones with little to no training. Also, create rich, customized reports from heterogeneous data sources.


Decentralized custom reports, redundant data, lack of pop upal security controls, and convoluted development requirements are problems faced by all 42Q s, and MESWeb has been designed to resolve these issues while maximizing usability and performance.


The purpose of this application is to manage the permissions for every report in our MES Web application. It provides 42Q’s with an easy mechanism for managing users, roles, applications, services and the relations among them.


#

Administration


There are 2 types of roles in MESWeb, the first type grants certain permissions to user in the Central module and those are:*

Administrator: user with this role has full permissions to all locations in Central module.
  • Security Manager: can grant access all kind of permissions except “Administrator” to other users and himself, including roles and reports.
  • Report Manager: this role has all permission in the Report Module but just for the specific Location assigned. (Create, edit, copy, publish reports)
  • Data Source Manager: this role has all permission in the Data source module but just for the specific Location assigned. (Create, edit, delete data sources)


The following roles will only take effect on the report execution:*

All MESR Customers: this role allows the user to see all customers of a specific location.
  • All data sources: this role allow user to see all data sources of a specific location.
  • All Reports: this role allows the user to see and execute all reports available in a specific location.


This section will cover how to navigate and execute all location, data source and custom reports activities. With this portlet, the user can add, edit or delete locations, servers, data sources, and data source types. The user can also access report group maintenance to perform searches, create, edit or delete report groups and add s to report groups. Report maintenance also allows the user to create, edit, or delete reports. The user can also publish/unpublished reports.


  1. To access MESWeb, navigate to Administration > MESWeb Central.
  2. Select the Administration icon located on the MESWeb Central Main page.


Figure 1: MESWeb Central Administration

File:Image47.jpg.png


  1. Upon selecting the Administration icon, four additional icons become available: Locations, Data Sources, Reports, and Report Groups.


Figure 2: Administration Functions

File:Image122.jpg.png

  1. Once an icon is selected, it is placed in a tab at the top of the Administration Page. The user can navigate between icons by placing them in tabs that can be easily accessed.


Figure 3: Functions in Tabs

File:Image143.jpg.png


    1. Locations


Definition: Location is a specific site or plant.

This function allows Administrators to add, edit, or delete locations. Also located in this module is the ability to add, edit, or delete location.


      1. Filter Locations


The filtering option located in the Locations tab allows the Administrator to search for specific locations based on their name and/or domain. The list displays empty and the user need to search to load the data in the page.


  1. To filter the list, enter the location name and/or select the domain from the drop down box provided.
  2. Select Search to filter the name list.
  3. Select Clear to clear entries.


Figure 4: Filter Locations

File:Image123.jpg.png


      1. Add Location


This function allows the Administrator to add a location based on the name, server, domain, time zone, and culture of the location.


  1. To add a location, select Add located above the name list in the Locations tab.
  2. Enter the location Name, Server, Domain, Time Zone, and Culture. All fields are mandatory.
  3. Select Save to confirm or Cancel to exit.


Figure 5: Add Location

File:Image84.jpg.png


  1. After all information has been entered and saved, the new location will be placed in the name list on the main screen of the Locations tab.
  2. After creating the location, a report group (Default Reports) is created (for this created location) and all predefined reports are assigned to this report group.


      1. Edit Location


This function allows the Administrator to edit any location’s name, server, domain, time zone, and/or culture.


  1. To edit a location, select the desired location from the name list and then select Edit.
  2. The Location Detail pop up displays. All fields are available to edit. After changing the desired information, select Save to confirm.
  3. Select Cancel to exit.


Figure 6: Edit Location

File:Image168.jpg.png


  1. The changes to the location will appear in the name list on the main screen of the Locations tab.


      1. Delete Location


This function allows the Administrator to delete a location from the Location Name list.


  1. To delete a location from the location name list, select the desired location and then select Delete.
  2. A confirmation prompt will display. Select Yes to confirm deletion or No to cancel.


Figure 7: Delete Location

File:Image50.jpg.png


  1. The location will be removed from the name list on the main screen of the Locations tab.


NOTE: It is not allowed to delete a location if data sources, report groups, reports or user permissions are created for this location.


      1. Server


Definition: Server is where the MESWeb Execution application is installed.


The Server function located in the Locations tab allows the administrator user to add, edit or delete the servers that will be available for all locations.


  1. To access the server function, select the Server icon located on the right of the main screen under the Locations tab.


Figure 8: Server

File:Image144.jpg.png


A server list displays containing all previously created servers listed numerically and alphabetically. From this screen, the Administrator can add, edit or delete a server.


Figure 9: Server List

File:Image179.jpg.png


        1. Add Server Name
  1. To add a server, select Add located above the server name list.
  2. The Server Detail pop up displays. Enter a name for the server and select Save.
  3. Select Cancel to exit.
  4. Once the server name has been entered and saved, the created server will appear in the server list.


Figure 10: Add a Server Name

File:Image101.jpg.png


        1. Edit Server Name


  1. To edit a server name, select the desired server name from the server list.
  2. Select Edit located above the server name list.
  3. The Server Detail pop up displays. After editing the server name, select Save to confirm.
  4. Select Cancel to exit.


Figure 11: Edit Server

File:Image71.jpg.png


        1. Delete Server Name
  1. To delete a server name, select the server name from the server list.
  2. Select Delete located above the server name list.
  3. A confirmation message displays. Select Yes to confirm or No to exit.


Figure 12: Delete Server Name

File:Image138.jpg.png


NOTE: If the server has any location assigned, it not will be allowed delete the server.


    1. Data Sources


Definition: a given name to a database for a specific location. The reports will query data inside this database.


This function allows Administrators to add, edit, or delete data sources. Also located in this module is the ability to add, edit, or data source types.


Figure 13: Data Source List

File:Image162.jpg.png


      1. Filter Data Sources


The filtering option located in the Data Sources tab allows the Administrator to search for specific data sources based on their location and/or name.


  1. To filter the Data Source list, select the locations from the drop down box provided and/or enter the data source name.
  2. Select Search to filter the Data Source list.
  3. Select Clear to clear entries.


Figure 14: Filter Data Sources

File:Image174.jpg.png


      1. Add Data Sources


This function allows the Administrator to add a data source based on the name, description, location, database type, and connection parameters associated to the database type.


  1. To add a data source, select Add located above the Data Source list in the Data Sources tab. The details pop up displays.
  2. Enter the data source Name, Description, Location, and the Database Type into the details pop up. All fields except the description field are mandatory.


Figure 15: Add Data Source

File:Image121.jpg.png


  1. Depending on the database type (Database Type field), a subsequent Connection Parameters pop up displays below the details pop up. The information required in this pop up is dependent upon the Database Type selected. Enter the required information in to the Connection Parameters pop up.


Figure 16: Select Database Type

File:Image65.jpg.png


Figure 17: Conection Parameter

File:Image75.jpg.png


Add a DataSource in Central is easy. The user just needs to follow the steps.#

Log in Portal -> Go to Administration -> Select MesWeb Central -> Select Data Sources -> Click Add button.
  1. Fill out Name, Description, Location and Database Type.
  2. The Database Types available are: MySQL, Oracle, Pervasive, Postgres SQL, SQL Server, according with the Database Type Selected. The screen will show the fields that the user needs to fill out to create the datasource connection.
  3. Fill out Connection Parameters. The user has two options to fill out those fields:
  • The user can fill out the fields :Server, Port, Database, User and Password.
  • The user can fill out just the Connection String field. If the Connection String is valid, the fields Server, Port, Database, User and Password will fill out automatically. Example of the Connection String: jdbc:postgresql://p88meswebl1.sanmina.com:5432/bem?user=user&password=pass


The Connection String should have the following format.


SQL Server jdbc:sqlserver://%Server%:%Port%;databaseName=%Database%;user=%User%;password=%Password%;encrypt=false
Oracle jdbc:oracle:thin:%User%/%Password%@%Server%:%Port%:%Database%
MySQL jdbc:mysql://%Server%:%Port%/%Database%?user=%User%&password=%Password%
Pervasive jdbc:pervasive://%Server%:%Port%/%Database%?user=%User%&password=%Password%
Postgres SQL jdbc:postgresql://%Server%:%Port%/%Database%?user=%User%&password=%Password%
  1. Select DataSource Type(s).
  2. Click in Save button. If the parameters of the connection are correct, the Data Source will save, if not and error will show the error description.


Types: This is the schemas that the created data source has. Select the schemas dragging the items from one list to another.


8Figure 18: Data Source -Types

File:Image180.png.png


  1. Select Save to confirm or Cancel to exit


      1. Edit Data Sources


This function allows the Administrator to edit the name, description and connection string of any data source.


  1. To edit a data source, select the desired data source from the Data Source list located on the main page of the Data Sources tab.
  2. Select Edit located above the name list.
  3. The Data Source Details pop up displays. The name and description are available for editing. The Connection Parameters section is not available to edit, but the connection string below the connection parameters pop up can be edited.
  4. After changing desired information, select Save to confirm or Cancel to exit.


Figure 19: Edit Data Source

File:Image163.jpg.png


NOTE: editing the Data Source, the Connection Parameters field will be displayed according to the Database Type chosen during the data source addition.


      1. Delete Data Sources


This function allows the Administrator to delete any data source.


  1. To delete a data source, select the desired data source from the name list located on the main page of the Data Sources tab.
  2. Select Delete located above the name list.
  3. A confirmation prompt will display. Select Yes to confirm or No to cancel.



Figure 20: Delete Data Source

File:Image61.jpg.png


      1. Data Source Type


The Data Source Type function located in the Data Sources tab allows the administrator user to add, edit or delete the data source types.


  1. To access the data source type function, select the Data Source Type icon located on the right of the main page under the Data Sources tab.


Note: if a data source type is deleted reports associated to it may not work correctly.


Figure 21: Data Source Type

File:Image129.jpg.png


A data source type list displays containing all previously created data sources listed alphabetically. From this screen, the Administrator user can add, edit or delete a data source type.


        1. Add Data Source Type


  1. To add a data source type, select Add located above the data source type list.
  2. Enter a data source type and description, both mandatory fields.
  3. Select Save to create Data Source Type.
  4. Select Cancel to exit.



Figure 22: Add Data Source Type

File:Image183.jpg.png


        1. Edit Data Source Type


  1. To edit a data source type, select the desired data source type from the list.
  2. Select Edit located above the Data Source Type list.
  3. Both the name and description fields are available to edit. After desired changes have been made, select Save to continue.
  4. Select Cancel to exit.


Figure 23: Edit Data Source Type

File:Image80.jpg.png


        1. Delete Data Source Type


  1. To delete a data source type, select the desired data source type from the list.
  2. Select Delete located above the Data Source Type list.
  3. A confirmation prompt will display. Select Yes to confirm or No to exit.


Figure 24: Delete Data Source Type

File:Image94.jpg.png


NOTE: It is not allowed delete a data source type if:#

If assigned to a data source;
  1. If there is any report already created for this data source type;


#

    1. Reports


The Reports Module was developed for employees with Security Manager (specific Location) and Administrator (all locations) roles. This section will cover how to navigate and execute all reports activities. The Reports module allows the user to edit copy or publish reports.


      1. Filter Reports


The filtering option located in the Reports tab allows the Administrator or Security Manager users to search for specific reports based on the owner location, report group, name, owner user, data source type, and/or status.


  1. To filter the report list, select an owner Location, Report Group, Data Source Type, and/or Status from the drop down boxes provided, or enter the Name and/or Owner User.
  2. Select Search to filter the list or Clear to clear all fields.
  3. The results will display in the report list.


Figure 25: Filter Reports

File:Image105.jpg.png


Note: just the Publish functionality is available for the Reports module; the other functionalities are in WIP (work in progress) status.


      1. Add Reports


This feature allows users to add reports that will be executed in the Execution Module.

Figure 26: Add Reports

File:Image172.jpg.png

Figure 27: Add Reports Basic

File:Image12.jpg.png


To add a report the user must enter all mandatory fields and go to the other configuration tabs too enter the necessary data to the report. Select Save to commit. For further information about these fields, see the respective modules (Location, Group (Report Group), and Data Source Type) in the Portal.


Note: Checking Private just the report owner will have permissions (open, edit, etc) for this report.


The default format will be the pre select format for the Execution Module, but it could be changed during the execution.


        1. SQL Code


Figure 28: Report Maintenance: SQL Code Configuration

File:Image72.jpg.png


This feature allows the user to add a query and check if the query is valid by clicking on Check Code SQL. To add a parameter it is necessary to use the syntax: <%shop_order%> .


        1. Parameters


At this point, the user will choose the parameters Types and Orders. For example, if the parameter will be a check box, a list box, text box, etc


The Report Maintenance page is displayed. Select Parameters tab to add a parameter.

Figure 29: Parameters

File:Image177.jpg.png#

The first thing to be done is create a new parameter step.  Parameter steps give us the ability to establish parent-child relationships between parameters. 
  1. Select "New Step"
  2. With a new step in place we can begin adding our parameters.
  3. Select “New Parameters” to configure the parameters;


Figure 30: New Parameter

File:Image64.jpg.png

There are three fields that are required of every parameter you setup:#

Name is straight forward - what you type here is what will be used as the parameters caption.  For example, "Customers" in the WIP Distribution report.


  1. Instruction


The user will provide any important information for the end user regarding this parameter.  In most cases this will be a very basic sentence such as "Indicate whether you want to see units that are in wip or not" that are already intuitive by just looking at the parameter.  However, you might come across situations as you develop your reports where you create a parameter whose relationship to the report is not so obvious and this field will give you a great way to explain it to the user.  The text enterered in this field will be displayed in this list.


  1. Parameter Type


The Parameter Type Field will allow the user to choose the Type of parameter that will determine how this parameter is displayed. The available parameter types are listed below:#

Drop Down List


Choosing this parameter type, the user will create a “list” according with the SQL code entered in the command line.

The Value field represents the value that will be replaced in the SQL Code.


Figure 31: Drop Down List Parameter

File:Image176.jpg.png


The user must enter the mandatory fields (Name, Instructions, Command, Data Type, Value Field, Display Field and the Parameter SQL).


Parameter SQL:  this is where the developer selects the text in their report SQL that will be replaced by the values in the parameter they are currently creating. So if in their report sql they had "<%Customers%>" they would see an option in this field that would say "Customers". That's where the application would insert the customers the users select when they execute the report.

Data Type: this indicates what kind of data will be inserted. It is the value type (integer, string, date, and double);

Command: this is used to enter the SQL query that will fill the list with the data;

Value Field: this field is the column name. This value will be substituted in the SQL Code;

Display Field: this column name that will be displayed to the user;

Required: this field defines if the field is mandatory or not;

Note: The Optional Item section will be displayed if the Required field is not checked and it will be used to remove or replace code lines in the SQL Code in the Execution Module. This action is the same for all parameters types.

Check the All Option check box if you want to add an option to choose “All“items in the list.


Figure 32: Optional Item

File:Image68.jpg.png


Select Add to open the maintenance screen.


Figure 33: Optional Item Maintenance

File:Image173.png.png


For example, the user can remove the <%location%> command and replace it for any value he wants.
Select Save to commit.
During the report execution, if no value is entered for this command, it will be replaced or removed automatically.
Also, the user can Edit or Delete items by clicking on Edit / Delete buttons. Select Save to commit.


Figure 34: Parents

File:Image117.jpg.png


Add Parent Parameter is a functionality that helps to share parameters between steps.#

Create a new Step;
  1. Create New Parameter, fill out Parameter Name, Parameter Type, etc;
  2. Click Add Parents in order to be able to use a parameter from other step. In this case we have available the Data Source parameter because is the parameter in step 1;
  3. Now the useer can use the parent parameter to write a query in Command field.


The parents are the paramters created in the previous steps and they could be used in the command query.


For example:

select ***** where *** = <%param_2%>where the tag <%param_2%> which is releated to the selected parent parameter (choosen as parent).


Figure 35: Add Parents

File:Image60.jpg.png


  1. List Box


Choosing this parameter type, the user will create a “Multiple Choose List” according with the SQL code entered in the command line.


Figure 36: List Box

File:Image181.jpg.png


The user must enter the mandatory fields (Name, Instructions, Command, Data Type, Value Field, Display Field and the Parameter SQL) already described and:


Rows: this allows developers to configure how many rows the user can see in the boxes at a time. When's there's going to be several hundred choices for the user it might help for them to select a higher number making it easier to search through all of them;

Select Maximum: this puts a limit on how many items the user can select in the parameter. If there are maybe 10,000 options for the user to choose you wouldn't want to allow them to select that many;

Max Exceeded Msg: message that will be displayed if the user tries to select more data that was set in the Select Maximum field.


It is the same for options. The user must enter the mandatory fields (Name, Instructions and the Parameter SQL).


  1. Data Range


This option is used to set a range of date.

Figure 37: Data Range

File:Image132.jpg.png


The user must enter the mandatory fields (Name and Instructions) already described;


Start SQL: it is the parameter name that will be substituted for the initial date range;

End SQL: it is the parameter name that will be substituted for the final date range;

Max Day Range: it is maximum quantity of days in the initial and final date range;

Display Time: Choosing this check box, the field to choose the time is displayed;


  1. Date Time


This parameter type will allow the user to choose date and time.

Figure 37: Date Time

File:Image67.jpg.png


The user must enter the mandatory fields (Name, Parameter SQL and Instructions) already described;


  1. Check Box


This will allow the users to choose values (Yes or No, On or Off or True or False).


Figure 38: Check Box

File:Image118.jpg.png


The user must enter the mandatory fields (Name, Parameter SQL and Instructions) already described;


  1. Text Box


This allows the user to set any text entry.

Figure 39: Text Box

File:Image93.jpg.png


The user must enter the mandatory fields (Name, Parameter SQL and Instructions) already described;

Default Value: this is the initial value that will be displayed in the Execution Module.

Validation: it will allow the user to add a validation for this field (Text Box).


Figure 40: Validation Field

File:Image161.jpg.png


There are four validation types:


  1. Data Type Validation


Figure 41: Validation: Data Type

File:Image79.jpg.png


If the user enters a different value chosen in the Data Type, the field will be invalid and an error message that was configured in the “Error Msg” field is displayed.


  1. Expression Validation



Figure 42: Validation: Expression

File:Image62.jpg.png


Choosing the “Expression” as validation, the user is able to add an expression (e.g. /^[a-zA-Z0-9][a-zA-Z0-9\._-]+@([a-zA-Z0-9\._-]+\.)[a-zA-Z-0-9]{2}/)).

If the user enters a different value that is not accepted for the expression, the field will be invalid and an error message that was configured in the “Error Msg” field is displayed.#

Range Validation


Figure 43: Validation: Range

File:Image6.jpg.png


Choosing the “Range” as validation, the user is able to set a value interval with maximum and minimum values that is configured in the Min. Value and Max. Value fields.

If the user enters a different interval that is not accepted for the expression, the field will be invalid and an error message that was configured in the “Error Msg” field is displayed.


  1. Value Validation


Figure 44: Validation: Value

File:Image184.jpg.png


Choosing the “Value” as validation, the user is able to set a validation for Operator (combo box) that defines which comparison will be done as displayed in the figure 43.


Figure 45: Operator Field

File:Image127.jpg.png


Compare to field will receive the value to be compared with the value entered by the user.

If the user enters a different value that is not accepted for the comparison, the field will be invalid and an error message that was configured in the “Error Msg” field is displayed.


  1. Multi-Line Text Box


It is like the Text Box, the difference is that the user can enter with Multiple Data. Each data must be in different lines.

Figure 46: Multi-Line Text Box

File:Image57.jpg.png


Input Limit will define the quantity of data can be entered.

Checking the Is Case Sensitive will allow to distinguish Lowercase and Uppercase.


  1. Radio Button List


Choosing the Radio Button parameter type, all result of the SQL Code configured in the Command field will be a radio button.

Figure 47: Radio Button List

File:Image104.jpg.png


Note: The user will be able to select just one Radio Button.


Select Save Parameters to commit.

Note: If there is just one parameter created for a step and the user remove this parameter, the step will be automatically removed.


        1. Drill Down


Drill Down is a link to another report. It is used to see detailed data in a separated report.

Figure 48: Drill Down

File:Image166.jpg.png


          1. Add Drill Down


To add a DD report, select the Drill Down tab and click on Add button;


Figure 49: Add Drill Down Report

File:Image11.jpg.png


  • Current Report Column


It is possible to create one drill down report per column. All available parent report columns are displayed in the combo box list.


  • Child Report


It will display just reports that have the same data source type and were published in the same location of the parent report.

When the user selects a Child Report, all their parameters will be displayed in the list to be set the values that the parameters will receive when the report is executed. For each parameter, there are three values types that could be set as follow:

No index entries found.


Figure 50: Static Value

File:Image119.jpg.png

Static: will set a fixed value to the DD report parameter;


Figure 51: Field Value

File:Image128.jpg.png


Field: it will be the link value of the parent report that will be displayed in parameter field in the DD report;

All parent report columns will be displayed.


Figure 52: Parent Parameter

File:Image133.jpg.png


Parent parameter: the value of a parameter in the report already chosen as the main will be displayed in the parameter field of the DD report;

All parent report parameters will be displayed.


To finish, click on Save button or Close to cancel de action.


          1. Remove Drill Down


Figure 53: Remove Drill Down

File:Image106.jpg.png


To remove a drill down, select the report and click on Remove button. Click on Yes to confirm or Cancel to cancel the action.#

        1. Testing


It is useful test the reports before publishing, to do this, after create a report, select Testing tab.

Figure 54: Testing Reports

File:Image165.jpg.png


Note that for each step, there are instructions displayed according to what were defined in the Instruction field.


Step1

This step will be the Data Source according to the Location and Data Source Type already configured.

Figure 55: Step1

File:Image82.jpg.png

NOTE: If there is just a single option of data source, it will be automatically displayed. Select Next Step to continue.

Step2

This is the first step created in the Parameter tab. The parameters that will be displayed in step2 are the ones defined according to the Parameter Type chosen.


Figure 56: Step 2

File:Image70.jpg.png


Output


Note: If there is no other step created, the Output is displayed. Select Go to see the result.


Figure 57: Report Result

File:Image98.png.png


NOTE: To execute a drill down report, click on the displayed link.#

        1. Summary


Go to Summary tab to publish the report.

Figure 58: Summary

File:Image167.jpg.png


Here the user will see the information about the report, the SQL Code and the parameters. This page can’t be edited, it just bring the report summary.


1. Would you like to publish this report? Select Yes, I want to.

2. The message should be displayed: Thank You

Your report is now published and ready to be executed in the production environment.


      1. Edit Reports


The Edit Report page is the same for Add Reports. See bellow the exceptions:#

If the report was already published, the Owner Location can’t be updated;
  1. If the report was already published, Summary page message is: “Would you like to update this report?” Clicking on ‘Yes, I want to” a new version of this report is created.


Note: The user is able to edit several reports at the same time.


      1. Copy Report


To copy a report, select the report and select Copy button.

The Copy Report page is displayed.

Figure 59: Copy Report

File:Image164.jpg.png


Enter the Mandatory fields and select Save to commit. The Edit page is displayed to make any update if necessary.


NOTE: Only Locations with the data source of the same type as this report are available to copy.



      1. Publish Reports


To publish a report, select the report from the list and select Publish.

Note that Security Manager users are able to publish for locations that have assigned.


In this functionality, if the report was created and published from the Add or Edit for the chosen location, it will be available for publish for other s. Otherwise, the Publish button will not available.


Figure 60: Publishing Reports

File:Image92.png.png


The Administrator user is able to:#

Update the report status that will define if the report will be displayed in the Execution module. Just the Active status will be displayed.
  1. Choose the location and the report group to publish the report.


NOTE: Clicking on Test this Report will execute this report and an execution screen is displayed;

To remove the location, select the location and select Delete. The report is no more publish for the selected location.


NOTE: It is not allowed to delete the location that the report was created.


Figure 61: Test the Report: Execute

File:Image99.png.png


For further information about this page, see Testing tab.

Select Save to commit.


      1. History Reports


Figure 62: History Report

File:Image100.png.png


This page displays all created report versions.

The version displayed in blue is the current version.


The user is able to rollback the version if there are old versions in the list selecting the version and clicking on RollBack button. The Edit page will be displayed and any update can be done. See Edit topic for further information.


Selecting any version and clicking on Execute button, the Execute page is displayed. . See Test the Report topic for further information.


      1. Predefined


The predefined reports code cannot be changed. This kind of reports is considered complex and their code are maintained for the MESWeb development team.


In the MESWeb Central Predefined functionality, the users are able to map or manage the reports (add and/or edit).


Figure 63: Mapping Predefined Reports

File:Image95.jpg.png

Administrator and Security Manager users are able to execute this functionality. Due to the chosen location, the users select the reports that the location will have access. These reports will be displayed in the Default Reports list of the chosen location.


        1. Predefined Maintenance


Administrators and Security Manager users are able to execute this functionality and it give access to chosen reports to other s.


  1. Edit Predefined Reports (Maintanance)


Just Administrator users are able to add Predefined Reports.

Figure 64: Edit Predefined Reports

File:Image109.jpg.png


    1. Report Groups


With this sub module the Administrator and Security Manager users can access report group maintenance to perform searches, create, edit or delete report groups and add reports to groups.


      1. Filter Report Groups


The filtering option located in the Report Groups tab allows the Administrator user to search for specific report groups based on the location, name, and/or description.


  1. To filter the report group list, select a Location from the drop down box provided, and/or enter the Name and/or Description.
  2. Select Search to filter the list or Clear to clear all fields.
  3. The results will display in the report group list.


Figure 65: Filter Report Groups

File:Image107.jpg.png


      1. Add Report Groups


This function allows the Administrator to add a report group based on the report group name, description, and location.


  1. To add a report group, select Add located above Report Group list.
  2. The Report Group Detail pop up displays.


Figure 66: Add Report Group

File:Image69.jpg.png


  1. Enter the Report Group Name and Description and select a Location from the drop down box provided. All fields are mandatory.
  2. Select Save to confirm addition.
  3. Select Cancel to exit.
  4. The new report group will appear alphabetically in the report group list.


      1. Edit Report Groups


This function allows the Administrator and Security Manager users to edit a report group’s name, description, and/or location.


  1. To edit a report group, select the desired report group from the list.
  2. Select Edit located above the report group list.
  3. The Report Group Detail pop up displays.


Figure 67: Edit Report Group

File:Image170.jpg.png


NOTE: Location is a read only field.


  1. After completing changes, select Save to confirm.
  2. Select Cancel to exit without saving.


      1. Delete Report Groups


This function allows the Administrator to delete a report group from the report group list.


  1. To delete a report group, select the desires report group from the list.
  2. Select Delete located above the report group list.
  3. A confirmation prompt will display. Select Yes to confirm or No to exit.
  4. The report group will be removed from the report group list.


Figure 68: Delete Report Group

File:Image124.jpg.png


NOTE: It is not allowed to delete a report group if:#

A report were created or published to the report group.
  1. Any user has permission for this report group.


#

      1. Add Report to Group


This function allows the Administrator to add a report to a report group by searching for its location and data source type.


  1. To add a report to a report group, select the desired report group from the list.
  2. Select Add Report to Group located above the report group list.


Figure 69: Add Report to Group

File:Image125.jpg.png


  1. The Report to Group pop up displays. Search for the specific report by selecting the location and data source type of the report from the drop down boxes provided.
  2. Select the search icon located to the right of the drop down boxes.
  3. The report will display in the left Available column. To move the report to the Selected column, double-click or drag and drop the report.
  4. Select Save to add the report to the report group.
  5. Select Cancel to exit.


  1. Access Control


The Access Control module was developed for employees with Administrator and Security Manager roles. This section will cover how to navigate and execute functions in Access Control. With the Access Control module, the Administrator is able to search, add, delete or edit users or user groups (will be developed).


  1. To access MESWeb, navigate to Administration > MESWeb Central.
  2. Select the Access Control icon located on the MESWeb Central Main page.


Figure 70: MESWeb Central Access Control

File:Image131.jpg.png


  1. Upon selecting the Access Control icon, two additional icons become available: Users and User Groups.


Figure 71: Access Control Functions

File:Image169.jpg.png


  1. Once either icon is selected, it is placed in a tab at the top of the Access Control page. The user can navigate between both icons by placing them in tabs that can be easily accessed.


Figure 72: User Icon in Tab

File:Image103.jpg.png


#

    1. Users


The Users icon under the Access Control screen in MESWeb Central allows Administrators to manage user permissions and edit user information. With this portlet, administrators can assign Administrator permissions to specific users for assigned locations and edit the user’s information.


      1. Filter Users


The filtering option located in the Users tab allows the Administrator to search for specific employees by User Name, Full Name, and/or Email.


  1. To filter the User List, enter the desired User Name, Full Name, and/or Email address into the provided fields.
  2. Select Search to filter users.
  3. Select Clear to clear all fields.



Figure 73: Filter User List

File:Image24.jpg.png


      1. Manage Permissions


This function allows Administrators to assign Administrator permissions to users for specific locations.


  1. To assign Administrator permissions to a user, select a user from the list by placing a check in the box to the left of the User Name.
  2. Select Manage Permissions.
  3. The User Permissions pop up displays.


Figure 74: User Permissions

File:Image48.jpg.png


  1. With this pop up, the administrator can assign Administrator permissions to a user by checking the box to the right of the Administrator option.
  2. Upon selecting a location, two panels display allowing the Administrator to assign Roles, Report Groups, Reports, Mesr Customers, Data Source, and Group Permissions to the user.


Figure 75: Assign Privileges (User Permissions)

File:Image58.jpg.png


  1. To move an Available Role/Report Group/Report/Mesr Customer/Data Sources to the Selected column, double-click or drag and drop the selection.


NOTE: Under the Mesr Customers tab, the Administrator must first select a Data Source from the drop down box before moving customers to the selected column.


  1. After moving all applicable selections in each tab, select Save to assign permissions to the user.
  2. Select Cancel to exit.
  3. The user will appear in the user list with the Administrator box selected.


      1. Edit Users


This function allows Administrators to edit the following user information:*

Full Name
  • Email
  • Language (under development)
  • If Active
  • If Expires
  • Expiration Date
  • If Customer
  • Hide Main Navigation
  • Show Icons


  1. To edit users, select the desired user from the user name list and then select Edit.


Figure 76: Edit Users

File:Image74.jpg.png


  1. The User Search Detail pop up displays. All fields are available to edit except for the user name. Make desired changes and then select Save.
  2. Select Cancel to exit.


Figure 77: User Search Detail

File:Image78.jpg.png


      1. Import Users


This function allows Administrators to import several uses at the same time using the available Template.

Select the Import buttom and the Import Users dialog displays.


Figure 78: Import Users

File:Image51.jpg.png


Search the file and select it. It is possible to skip existing users or update them by selecting the radion buttons.


Selecting the Get Template buttom, the user gets a template that can be filled and imported with new users.


Figure 79: Import Users Template

File:Image83.jpg.png


    1. User Groups


The User Groups icon under the Access Control screen in MESWeb Central allows Administrators to manage user Groups by add, edit, delete, manage users and manage permissions.


To access the User Groups, select the User Groups icon in the left panel. The User Groups tab is displayed.


Figure 80: User Groups Main Page

File:Image140.jpg.png


      1. Filter User Groups


The filtering option located in the User Groups tab allows the Administrator to search for specific groups by User Groups Name or Location.


  1. To filter the User Group List, enter the desired Name, and/or Location into the provided fields.
  2. Select Search to filter users.
  3. Select Clear to clear all fields.


Figure 81: Filter User List

File:Image76.jpg.png


      1. Add User Groups


This function allows the Administrator to add a user group based on the user group name, description, and location.


  1. To add a user group, select Add located above User Group list.
  2. The User Group Detail pop up displays.


Figure 82: Add User Group

File:Image49.jpg.png


  1. Enter the Name and Description and select a Location from the drop down box provided. All fields are mandatory.
  2. Select Save to confirm addition.
  3. Select Cancel to exit.
  4. The new user group will appear alphabetically in the report group list.


      1. Edit User Groups


This function allows the Administrator and Security Manager users to edit a user group’s name and/or description.


  1. To edit a user group, select the desired user group from the list.
  2. Select Edit located above the User Group list.
  3. The User Group Detail pop up displays.


Figure 83: Edit User Group

File:Image171.jpg.png


NOTE: Location is a read only field.


  1. After completing changes, select Save to confirm.
  2. Select Cancel to exit without saving.


      1. Delete User Groups


This function allows the Administrator to delete a user group from the user group list.


  1. To delete a user group, select the desired user group from the list.
  2. Select Delete located above the user group list.
  3. A confirmation prompt will display. Select Yes to confirm or No to exit.
  4. The user group will be removed from the user group list.


Figure 84: Delete Report Group

File:Image97.jpg.png


NOTE: It is not allowed to delete a user group if:#

the user group has users assigned;


It is possible select more than a user group at the same time to make a massive delete.


      1. Mapping User


This functionality map user to a selected group.

To map users, follow the stepes bellow:#

Select a group name in the list and select Mapping User;
  1. The Mapping User pop up displays;
  2. In the rigth side of the page, the filter will display the users registered in the system. Just move the user to the left side and it will be part of the group.
  3. To remove users from the group, move the user to the right side.


Figure 85: Mapping User

File:Image142.jpg.png


        1. Import Users to Group


This function allows Administrators to import several uses at the same time using the available Template.

Select the Import buttom and the Import Users pop up displays.


Figure 86: Import Users to Group

File:Image85.jpg.png


Search the file and select it. It is possible to skip not found users or update them by selecting the available radion buttons.


Selecting the Get Template buttom, the user gets a template that can be filled and imported with new users.


Figure 87: Import Users Template

File:Image59.jpg.png#

      1. Manage Permissions


This function allows Administrators to assign permissions for groups.


  1. To assign user group permissions, select a Name from the list by placing a check in the box to the left of the Name.
  2. Select Manage Permissions.
  3. The User Group Permissions pop up displays.


Figure 88: Manage PermissionsUser Group Permissions

File:Image77.jpg.png


Figure 89: Assign Privileges

File:Image178.jpg.png


  1. To move an Available Role/Report Group/Report/Mesr Customer/Data Sources to the Selected column, double-click or drag and drop the selection.


NOTE: Under the Mesr Customers tab, the Administrator must first select a Data Source from the drop down box before moving customers to the selected column.


  1. After moving all applicable selections in each tab, select Save to assign permissions to the user.
  2. Select Cancel to exit.
  3. The user will appear in the user list with the Administrator box selected.


#

Appendix A


Access Control
It is a module that will set the permissions for users and external customers of 42Q


administrator
the System Administration has full access to MESWeb - all s, all reports, all customers.


customer user
user for external customers to access the application


find username
for the "find" when we look up the username we use a web service at the Helpdesk, so it's finding something that's separate from MESWeb


MES Web
application that provides reporting capabilities through a web-based interface.


parameters
definitions for data, reports, or configurations.


roles
user profile inside MESWeb


SiteMinder
Universal login of 42Q


user
the User role is able to execute only those reports specifically granted access to him/her, and may not create new reports or modify existing reports. Administrators may restrict users' access to only that data belonging to specific customers.


username
the username is the siteminder username (or a partial string)


  1. Revision Log



Date Author Title Version Change Reference
04/08/14 Elaine Fonaro Technical Writer v 1.0 This is the first revision of MESWeb - Access Control Work Instruction
04/08/14 Ashley Martin Technical Writer v 1.0 General Review
07/21/14 Elaine Fonaro Technical Writer v 1.0 Add the Report Module and general review
10/29/14 Claudia Urenda

Elaine Fonaro

Business Analyst

Technical Writer

v1.0 Final Review
04/28/16 Elaine Fonaro Technical Writer v 1.0 Converted to 42Q
08/05/16 Elaine Fonaro Technical Writer v 1.0 Converted to Google Doc
03/22/18 Elaine Fonaro Technical Writer v 1.0 Applyed new Template for format.
05/25/18 Elaine Fonaro Technical Writer v 1.0 Reviewed and Update all images according new user interface

Added the User Group new topic