Difference between revisions of "SOP-MES0039 MESWeb Central"

From 42Q
Jump to navigation Jump to search
Line 9: Line 9:
 
''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==
+
== 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.
+
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 all Sanmina s, and MESWeb has been designed to resolve these issues while maximizing usability and performance.
+
Decentralized custom reports, redundant data, lack of formal security controls, and convoluted development requirements are problems faced by all Sanmina 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 Sanmina-SCI s with an easy mechanism for managing users, roles, applications, services and the relations among them.
+
The purpose of this application is to manage the permissions for every report in our MES Web application. It provides Sanmina-SCI s with an easy mechanism for managing users, roles, applications, services and the relations among them.  
  
==Administration==
+
== Administration ==
  
The Administration module was developed for employees with the following roles:
+
The Administration module was developed for employees with the following roles:  
  
* '''Administrator''': the Administrator user has full access for all locations;
+
*'''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;
+
*'''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 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 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;
+
*'''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;
+
*'''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;
+
*'''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.
+
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 <nowiki>></nowiki> MESWeb Central'''.
+
1. To access MESWeb, navigate to '''Administration <nowiki>></nowiki> MESWeb Central'''.  
  
2. Select the Administration icon located on the MESWeb Central Main screen.
+
2. Select the Administration icon located on the MESWeb Central Main screen.  
  
'''Figure 1: MESWeb Central Administration'''
+
'''Figure 1: MESWeb Central Administration'''  
  
 +
[[Image:01_MESWeb_Admin.png|700px]]<br>
  
 +
3. Upon selecting the Administration icon, four additional icons become available: Locations, Data Sources, Reports, and Report Groups.
  
3. Upon selecting the Administration icon, four additional icons become available: Locations, Data Sources, Reports, and Report Groups.
+
'''Figure 2: Administration Functions'''
  
'''Figure 2: Administration Functions'''
+
[[Image:02_MESWeb_Admin.png|700px]]<br>
  
 +
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'''
  
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.
+
<br>
  
'''Figure 3: Functions in Tabs'''
+
=== Locations ===
  
 +
'''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.
  
===Locations===
+
==== Filter Locations ====
'''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.
+
The filtering option located in the Locations tab allows the Administrator to search for specific locations based on their name and/or domain.  
  
====Filter Locations====
+
1. To filter the name list, enter the name and/or select the domain from the drop down box provided.
  
The filtering option located in the Locations tab allows the Administrator to search for specific locations based on their name and/or domain.
+
2. Select '''Search '''to filter the name list.  
  
1. To filter the name list, enter the name and/or select the domain from the drop down box provided.
+
3. Select '''Clear '''to clear entries.  
  
2. Select '''Search '''to filter the name list.
+
'''Figure 4: Filter Locations'''  
  
3. Select '''Clear '''to clear entries.
+
[[Image:04_MESWeb_Admin.png|700px]]<br>
  
'''Figure 4: Filter Locations'''
+
==== 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.
  
====Add Location====
+
2. Enter the location '''Name''', '''Server''','''Domain''','''Time Zone''', and'''Culture'''. All fields are mandatory.
  
This function allows the Administrator to add a location based on the name, server, domain, time zone, and culture of the location.
+
3. Select '''Save '''to confirm or '''Cancel '''to exit.  
  
1. To add a location, select '''Add '''located above the name list in the Locations tab.
+
'''Figure 5: Add Location'''  
  
2. Enter the location '''Name''', '''Server''',''' Domain''',''' Time Zone''', and''' Culture'''. All fields are mandatory.
+
[[Image:05_MESWeb_Admin.png|700px]]<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.  
  
3. Select '''Save '''to confirm or '''Cancel '''to exit.
+
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.  
  
'''Figure 5: Add Location'''
+
==== Edit Location ====
  
 +
This function allows the Administrator to edit any location<nowiki>’</nowiki>s name, server, domain, time zone, and/or culture.
  
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.
+
1. To edit a location, select the desired location from the name list and then select '''Edit'''.  
  
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.
+
2. The Location Detail form displays. All fields are available to edit. After changing the desired information, select '''Save '''to confirm.  
  
====Edit Location====
+
3. Select '''Cancel '''to exit.
  
This function allows the Administrator to edit any location<nowiki>’</nowiki>s name, server, domain, time zone, and/or culture.
+
'''Figure 6: Edit Location'''
  
1. To edit a location, select the desired location from the name list and then select '''Edit'''.
+
[[Image:06_MESWeb_Admin.png|700px]]<br> 4. The changes to the location will appear in the name list on the main screen of the Locations tab.  
  
2. The Location Detail form displays. All fields are available to edit. After changing the desired information, select '''Save '''to confirm.
+
==== Delete Location ====
  
3. Select '''Cancel '''to exit.
+
This function allows the Administrator to delete a location from the name list.  
  
'''Figure 6: Edit Location'''
+
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.
  
4. The changes to the location will appear in the name list on the main screen of the Locations tab.
+
'''Figure 7: Delete Location'''
  
====Delete Location====
+
[[Image:07_MESWeb_Admin.png|700px]]<br>
  
This function allows the Administrator to delete a location from the name list.
+
3. The location will be removed from the name list on the main screen of the Locations tab.  
  
1. To delete a location from the name list, select the desired location and then select '''Delete'''.
+
'''Note:''' It is not allowed to delete a location if data sources, report groups, reports or user permissions are created for this location.  
  
2. A confirmation prompt will display. Select '''Yes '''to confirm deletion or '''No '''to cancel.
+
==== Server ====
  
'''Figure 7: Delete Location'''
+
'''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.
  
 +
1. To access the server function, select the '''Server '''icon located on the right of the main screen under the Locations tab.
  
3. The location will be removed from the name list on the main screen of the Locations tab.
+
'''Figure 8: Server'''
  
'''Note:''' It is not allowed to delete a location if data sources, report groups, reports or user permissions are created for this location.
+
[[Image:08_MESWeb_Admin.png|700px]]<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.  
  
====Server====
+
'''Figure 9: Server List'''  
'''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.
+
[[Image:09_MESWeb_Admin.png|700px]]<br>
  
1. To access the server function, select the '''Server '''icon located on the right of the main screen under the Locations tab.
+
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'''.
  
 +
3. Select '''Cancel '''to exit.
  
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.
+
4. Once the server name has been entered and saved, the created server will appear in the server list.  
  
'''Figure 9: Server List'''
+
'''Figure 10: Add Server Name'''  
  
 +
[[Image:10_MESWeb_Admin.png|700px]]<br>
  
 +
===== Edit Server Name =====
  
1. To add a server name, select '''Add '''located above the server name list.
+
1. To edit a server name, select the desired server name from the server list.  
  
2. The Server Detail form displays. Enter a name for the server and select '''Save'''.
+
2. Select '''Edit '''located above the server name list.  
  
3. Select '''Cancel '''to exit.
+
3. The Server Detail form displays. After editing the server name, select '''Save '''to confirm.  
  
4. Once the server name has been entered and saved, the created server will appear in the server list.
+
4. Select '''Cancel '''to exit.  
  
'''Figure 10: Add Server Name'''
+
'''Figure 11: Edit Server'''  
  
 +
[[Image:11_MESWeb_Admin.png|700px]]<br>
  
=====Edit Server Name=====
+
===== Delete Server Name =====
  
1. To edit a server name, select the desired server name from the server list.
+
1. To delete a server name, select the server name from the server list.  
  
2. Select '''Edit '''located above the server name list.
+
2. Select '''Delete '''located above the server name list.  
  
3. The Server Detail form displays. After editing the server name, select '''Save '''to confirm.
+
3. A confirmation prompt will display. Select '''Yes '''to confirm or '''No '''to exit.  
  
4. Select '''Cancel '''to exit.
+
'''Figure 12: Delete Server Name'''  
  
'''Figure 11: Edit Server'''
+
[[Image:12_MESWeb_Admin.png|700px]]<br> '''Note:''' If the server has any location assigned, it not will be allowed delete the server.
  
 +
=== Data Sources ===
  
=====Delete Server Name=====
+
'''Definition:''' a given name to a database for a specific location. The reports will query data inside this database.  
1. To delete a server name, select the server name from the server list.
 
  
2. Select '''Delete '''located above the server name list.
+
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.  
  
3. A confirmation prompt will display. Select '''Yes '''to confirm or '''No '''to exit.
+
==== Filter Data Sources ====
  
'''Figure 12: Delete Server Name'''
+
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.
  
'''Note:''' If the server has any location assigned, it not will be allowed delete the server.
+
2. Select '''Search '''to filter the Data Source list.  
  
===Data Sources===
+
3. Select '''Clear '''to clear entries.
  
'''Definition:''' a given name to a database for a specific location. The reports will query data inside this database.
+
'''Figure 13: Filter Data Sources'''  
  
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.
+
[[Image:13_MESWeb_Admin.png|700px]]<br>
  
====Filter Data Sources====
+
==== Add 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.
+
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 filter the Data Source list, select the locations from the drop down box provided and/or enter the data source name.
+
1. To add a data source, select '''Add '''located above the Data Source list in the Data Sources tab. The details form displays.  
  
2. Select '''Search '''to filter the Data Source list.
+
2. Enter the data source '''Name''', '''Description''','''Location''',and the'''Database Type '''into the details form. All fields except the description field are mandatory.  
  
3. Select '''Clear '''to clear entries.
+
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 13: Filter Data Sources'''
+
4. Select '''Save ''' to confirm or '''Cancel '''to exit
  
 +
'''Figure 14: Add Data Source'''
  
 +
[[Image:14_MESWeb_Admin_Add_Data_Source.png|700px]]<br>
  
====Add Data Sources====
+
'''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.
  
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.
+
'''Figure 15: Data Source -Types'''
  
1. To add a data source, select '''Add '''located above the Data Source list in the Data Sources tab. The details form displays.
+
[[Image:15_MESWeb_Admin_Data_Source_Types.png]]<br>
  
2. Enter the data source '''Name''', '''Description''',''' Location''',''' '''and the''' Database Type '''into the details form. All fields except the description field are mandatory.
+
==== Edit Data Sources ====
  
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.
+
This function allows the Administrator to edit the name, description and connection string of any data source.  
  
4. Select '''Save ''' to confirm or '''Cancel '''to exit
+
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.  
  
'''Figure 14: Add Data Source'''
+
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.
  
 +
4. After changing desired information, select '''Save '''to confirm or '''Cancel '''to exit.
  
'''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 16: Edit Data Source'''  
  
'''Figure 15: Data Source -Types'''
+
[[Image:16_MESWeb_Admin_Edit.png|700px]]<br>
  
 +
Note that editing the Data Source, the Connection Parameters field will be displayed according to the chosen during the data source addition.
  
 +
==== Delete Data Sources ====
  
====Edit Data Sources====
+
This function allows the Administrator to delete any data source.
  
This function allows the Administrator to edit the name, description and connection string of 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.  
  
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 '''Delete '''located above the name list.  
  
2. Select '''Edit '''located above the name list.
+
3. A confirmation prompt will display. Select '''Yes '''to confirm or '''No '''to cancel.  
  
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.
+
'''Figure 17: Delete Data Source'''
  
4. After changing desired information, select '''Save '''to confirm or '''Cancel '''to exit.
+
[[Image:17_MESWeb_Admin_Delete.png|700px]]<br>
  
'''Figure 16: Edit Data Source'''
+
==== 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 screen under the Data Sources tab.
  
Note that editing the Data Source, the Connection Parameters field will be displayed according to the chosen during the data source addition.
+
'''Note''': if a data source type is deleted reports associated to it may not work correctly.  
  
====Delete Data Sources====
+
'''Figure 18: Data Source Type'''
  
This function allows the Administrator to delete any data source.
+
[[Image:18_MESWeb_Admin_Data_Source_Type.png|700px]]<br>
  
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.
+
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.  
  
2. Select '''Delete '''located above the name list.
+
'''Figure 19: Data Source Type List'''  
  
3. A confirmation prompt will display. Select '''Yes '''to confirm or '''No '''to cancel.
+
[[Image:19_MESWeb_AdminData_Source_Type_List.png]]<br>
  
'''Figure 17: Delete Data Source'''
+
===== 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.
  
====Data Source Type====
+
3. Select '''Save '''to create 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.
+
4. Select '''Cancel '''to exit.  
  
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.
+
'''Figure 20: Add Data Source Type'''  
  
'''Note''': if a data source type is deleted reports associated to it may not work correctly.
+
[[Image:20_MESWeb_Admin_Add_Data_Source.png]]<br>
  
'''Figure 18: Data Source Type'''
+
===== 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.
  
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.
+
3. Both the name and description fields are available to edit. After desired changes have been made, select '''Save '''to continue.  
  
'''Figure 19: Data Source Type List'''
+
4. Select '''Cancel '''to exit.
  
 +
'''Figure 21: Edit Data Source Type'''
  
 +
[[Image:21_MESWeb_Admin_Edit_Data_Source_Type.png]]<br>
  
=====Add Data Source Type=====
+
===== Delete Data Source Type =====
  
1. To add a data source type, select '''Add''' located above the data source type list.
+
1. To delete a data source type, select the desired data source type from the list.  
  
2. Enter a data source type and description, both mandatory fields.
+
2. Select '''Delete '''located above the Data Source Type list.  
  
3. Select '''Save '''to create Data Source Type.
+
3. A confirmation prompt will display. Select '''Yes '''to confirm or '''No '''to exit.  
  
4. Select '''Cancel '''to exit.
+
'''Figure 22: Delete Data Source Type'''  
  
'''Figure 20: Add Data Source Type'''
+
[[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;
  
 +
=== Reports ===
  
=====Edit Data Source Type=====
+
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. To edit a data source type, select the desired data source type from the list.
+
==== Filter Reports ====
  
2. Select '''Edit''' located above the Data Source Type list.
+
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. Both the name and description fields are available to edit. After desired changes have been made, select '''Save '''to continue.
+
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.  
  
4. Select '''Cancel '''to exit.
+
2. Select '''Search '''to filter the list or '''Clear '''to clear all fields.  
  
'''Figure 21: Edit Data Source Type'''
+
3. The results will display in the report list.
  
 +
'''Figure 23: Filter Reports'''
  
 +
[[Image:23_MESWeb_Admin_Filter_Reports.png|700px]]<br>
  
=====Delete Data Source Type=====
+
Note: just the Publish functionality is available for the Reports module; the other functionalities are in WIP (work in progress) status.
  
1. To delete a data source type, select the desired data source type from the list.
+
==== Add Reports ====
  
2. Select '''Delete '''located above the Data Source Type list.
+
This feature allows users to add reports that will be executed in the Execution Module.  
  
3. A confirmation prompt will display. Select '''Yes '''to confirm or '''No '''to exit.
+
'''Figure 24: Add Reports'''  
  
'''Figure 22: Delete Data Source Type'''
+
[[Image:24_MESWeb_Admin_Add_Reports.png|700px]]<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''': Checking '''Private''' just the report owner will have permissions (open, edit, etc) for this report.
  
Note: It is not allowed delete a data source type if:
+
The default format will be the pre select format for the Execution Module, but it could be changed during the execution.
  
* If assigned to a data source;
+
===== SQL Code =====
* If  there is any report already created for this data source type;
 
  
===Reports===
+
'''Figure 25: Report Maintenance: SQL Code Configuration'''
  
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.
+
[[Image:25_MESWeb_Admin_SQLCode_Add_Report.png|700px]]<br>
  
====Filter Reports====
+
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> .
  
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.
+
===== Parameters =====
  
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.
+
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
  
2. Select '''Search '''to filter the list or '''Clear '''to clear all fields.
+
The Report Maintenance page is displayed. Select Parameters tab to add a parameter.  
  
3. The results will display in the report list.
+
'''Figure 26: Parameters'''
  
'''Figure 23: Filter Reports'''
+
[[Image:26_MESWeb_Admin_SQLCode_Add_Report.png|700px]]<br>
  
 +
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: just the Publish functionality is available for the Reports module; the other functionalities are in WIP (work in progress) status.
+
3. With a new step in place we can begin adding our parameters.  
  
====Add Reports====
+
4. Select '''"New Parameters"''' to configure the parameters;
  
This feature allows users to add reports that will be executed in the Execution Module.
+
'''Figure 27: New Parameter'''
  
'''Figure 24: Add Reports'''
+
[[Image:27_MESWeb_Admin.png|700px]]<br>
  
 +
There are three fields that are required of every parameter you setup:
  
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.
+
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.  
  
'''Note''': Checking '''Private''' just the report owner will have permissions (open, edit, etc) for this report.
+
2. '''Instruction'''  
  
The default format will be the pre select format for the Execution Module, but it could be changed during the execution.
+
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.  
  
=====SQL Code=====
+
3. '''Parameter Type'''  
'''Figure 25: Report Maintenance: SQL Code Configuration'''
 
  
 +
'''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'''
  
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> .
+
Choosing this parameter type, the user will create a "list" according with the SQL code entered in the command line.  
  
=====Parameters=====
+
The Value field represents the value that will be replaced in the SQL Code.  
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 28: Drop Down List Parameter'''
  
'''Figure 26: Parameters'''
+
[[Image:28_MESWeb_Admin.png|700px]]<br>
  
 +
The user must enter the mandatory fields ('''Name''', '''Instructions''', '''Command''', '''Data Type''', '''Value Field, Display Field''' and '''the Parameter SQL''').
  
 +
'''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.
  
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;                                    
+
'''Data Type''': this indicates what kind of data will be inserted. It is the value type (integer, string, date, and double);  
  
2. Select "'''New Step'''"
+
'''Command''': this is used to enter the SQL query that will fill the list with the data;
  
3. With a new step in place we can begin adding our parameters.
+
'''Value Field''': this field is the column name. This value will be substituted in the SQL Code;
  
4. Select '''"New Parameters"''' to configure the parameters;
+
'''Display Field''': this column name that will be displayed to the user;  
  
'''Figure 27: New Parameter'''
+
'''Required''': this field defines if the field is mandatory or not;
  
 +
'''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 the
  
There are three fields that are required of every parameter you setup:
+
'''Figure 29: Option Item'''
  
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.
+
[[Image:29_MESWeb_Admin.png|700px]]<br> Select '''Add '''to open the maintenance screen.  
  
2. '''Instruction'''
+
'''Figure 30: Optional Item Maintenance'''  
  
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: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.  
  
3. '''Parameter Type'''
+
Select '''Save '''to commit.
  
'''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:
+
During the report execution, if no value is entered for this command, it will be replaced or removed automatically.  
  
* '''Drop Down List'''
+
Also, the user can '''Edit''' or '''Delete''' items by clicking on Edit / Delete buttons. Select '''Save''' to commit.  
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.
+
*'''Customer Drop down List'''
  
'''Figure 28: Drop Down List Parameter'''
+
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'''
  
 +
[[Image:31_MESWeb_Admin.png|700px]]<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 user must enter the mandatory fields ('''Name''', '''Instructions''', '''Command''', '''Data Type''', '''Value Field, Display Field''' and '''the Parameter SQL''').
+
'''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.  
  
'''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.
+
Check the '''All Option''' check box if you want to add an option to choose "'''All'''"items in the list.  
  
'''Data Type''': this indicates what kind of data will be inserted. It is the value type (integer, string, date, and double);
+
These options are available when the '''Data Source Type''' selected is '''MESR'''.  
 
 
'''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 '''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 the
 
 
 
'''Figure 29: Option Item'''
 
 
 
 
 
Select '''Add '''to open the maintenance screen.
 
 
 
'''Figure 30: Optional Item Maintenance'''
 
 
 
 
 
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.
 
 
 
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'''
 
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'''
 
 
 
 
 
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).
 
 
 
'''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.
 
 
 
These options are available when the '''Data Source Type''' selected is '''MESR'''.
 
  
 
----
 
----
  
* '''List Box'''
+
*'''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 32: 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 32: List Box'''
  
 +
[[Image:32_MESWeb_Admin.png|700px]]<br>
  
The user must enter the mandatory fields ('''Name''', '''Instructions''', '''Command''', '''Data Type''', '''Value Field''', '''Display Field''' and the '''Parameter SQL''') already described and:
+
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<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;
+
'''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;  
  
'''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;
+
'''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;  
  
'''Max Exceeded Msg''': message that will be displayed if the user tries to select more data that was set in the '''Select Maximum''' field.
+
'''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).
+
It is the same for options. The user must enter the mandatory fields ('''Name''', '''Instructions''' and the '''Parameter''' SQL).  
  
 
----
 
----
  
* '''Customer List Box'''
+
*'''Customer List Box'''
 
 
This option is the same as '''List Box''';
 
  
'''Figure 33: Customer List Box'''
+
This option is the same as '''List Box''';
  
 +
'''Figure 33: Customer List Box'''
  
 +
[[Image:33_MESWeb_Admin.png|700px]]<br>
  
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 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
+
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.
+
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.  
  
'''Note''': These options are available when the '''Data Source Type''' selected is '''MESR'''.
+
'''Note''': These options are available when the '''Data Source Type''' selected is '''MESR'''.  
  
 
----
 
----
  
* '''Data Range'''
+
*'''Data Range'''
 
 
This option is used to set a range of date.
 
  
'''Figure 34: Data Range'''
+
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|700px]]<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;  
  
'''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;  
  
 
----
 
----
  
* '''Date Time'''
+
*'''Date Time'''
This parameter type will allow the user to choose date and time.
 
  
'''Figure 35: Date Time'''
+
This parameter type will allow the user to choose date and time.
  
 +
'''Figure 35: Date Time'''
  
 +
[[Image:35_MESWeb_Admin.png|700px]]<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;  
  
 
----
 
----
  
* '''Check Box'''
+
*'''Check Box'''
  
This will allow the users to choose values ('''Yes''' or '''No''', '''On '''or '''Off''' or '''True''' or '''False''').
+
This will allow the users to choose values ('''Yes''' or '''No''', '''On '''or '''Off''' or '''True''' or '''False''').  
  
'''Figure 36: Check Box'''
+
'''Figure 36: Check Box'''  
  
 
+
[[Image:36_MESWeb_Admin.png|700px]]<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;
 
  
 
----
 
----
  
* '''Text Box'''
+
*'''Text Box'''
  
This allows the user to set any text entry.
+
This allows the user to set any text entry.  
  
'''Figure 37: Text Box'''
+
'''Figure 37: Text Box'''  
  
 +
[[Image:37_MESWeb_Admin.png|700px]]<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.
  
'''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).  
  
'''Validation''': it will allow the user to add a validation for this field (Text Box).
+
'''Figure 38: Validation Field'''  
  
'''Figure 38: Validation Field'''
+
[[Image:38_MESWeb_Admin.png]]<br> There are four validation types:  
  
 +
*'''Data Type Validation'''
  
There are four validation types:
+
'''Figure 39: Validation: Data Type'''
  
* '''Data Type Validation'''
+
[[Image:39_MESWeb_Admin.png|700px]]<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.
'''Figure 39: Validation: Data Type'''
 
  
 +
*'''Expression Validation'''
  
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.
+
'''Figure 40: Validation: Expression'''
  
* '''Expression Validation'''
+
[[Image:40_MESWeb_Admin.png|700px]]<br>
'''Figure 40: Validation: Expression'''
 
  
 +
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. <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>
+
*'''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.
+
'''Figure 41: Validation: Range'''
  
* '''Range Validation'''
+
[[Image:41_MESWeb_Admin.png|700px]]<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.
  
'''Figure 41: Validation: Range'''
+
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.
  
 +
*'''Value Validation'''
  
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 42: Validation: Value'''  
  
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:42_MESWeb_Admin.png|700px]]<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.  
  
* '''Value Validation'''
+
'''Figure 43: Operator Field'''  
  
'''Figure 42: Validation: Value'''
+
[[Image:43_MESWeb_Admin.png|700px]]<br>
  
 +
'''Compare to''' field will receive the value to be compared with the value entered by the user.
  
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.
+
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.  
 
 
'''Figure 43: Operator Field'''
 
 
 
 
 
 
 
'''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.
 
  
 
----
 
----
  
* '''Multi-Line Text Box'''
+
*'''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 44: 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 44: Multi-Line Text Box'''
  
 +
[[Image:44_MESWeb_Admin.png|700px]]<br>
  
'''Input Limit''' will define the quantity of data can be entered.
+
'''Input Limit''' will define the quantity of data can be entered.  
  
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'''
+
*'''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 45: Radio Button List'''
 
 
 
 
 
'''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.
 
 
 
=====Drill Down=====
 
Drill Down is a link to another report. It is used to see detailed data in a separated report.
 
 
 
'''Figure 46: Drill Down'''
 
  
====Add Drill Down====
+
Choosing the '''Radio Button''' parameter type, all result of the SQL Code configured in the '''Command''' field will be a radio button.
To add a DD report, select the Drill Down tab and click on '''Add''' button;
 
  
'''Figure 47: Add Drill Down Report'''
+
'''Figure 45: Radio Button List'''  
  
 +
[[Image:45_MESWeb_Admin.png|700px]]<br> '''Note''': The user will be able to select just one Radio Button.
  
 +
Select '''Save Parameters''' to commit.
  
* '''Current Report Column'''
+
'''Note''': If there is just one parameter created for a step and the user remove this parameter, the step will be automatically removed.  
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'''
+
===== Drill Down =====
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:
+
Drill Down is a link to another report. It is used to see detailed data in a separated report.  
  
No index entries found.
+
'''Figure 46: Drill Down'''
  
'''Figure 48: Static Value'''
+
'''[[Image:46_MESWeb_Admin.png|700px]]'''
  
 +
==== Add Drill Down ====
  
'''Static''': will set a fixed value to the DD report parameter;
+
To add a DD report, select the Drill Down tab and click on '''Add''' button;  
  
'''Figure 49: Field Value'''
+
'''Figure 47: Add Drill Down Report'''  
  
 +
[[Image:47_MESWeb_Admin.png|700px]]<br>
  
'''Field''': it will be the link value of the parent report that will be displayed in parameter field in the DD report;
+
*'''Current Report Column'''
  
All parent report columns will be displayed.
+
It is possible to create one drill down report per column. All available parent report columns are displayed in the combo box list.  
  
'''Figure 50: Parent Parameter'''
+
*'''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.
  
'''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;
+
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:
  
All parent report parameters will be displayed.
+
No index entries found.  
  
To finish, click on '''Save''' button or '''Cancel''' to cancel de action.
+
'''Figure 48: Static Value'''  
  
====Remove Drill Down====
+
[[Image:48_MESWeb_Admin.png]]<br> '''Static''': will set a fixed value to the DD report parameter;
'''Figure 51: Remove Drill Down'''
 
  
 +
'''Figure 49: Field Value'''
  
To remove a drill down, select the report and click on '''Remove''' button. Click on '''Yes '''to confirm or''' Cancel''' to cancel the 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;
  
=====Testing=====
+
All parent report columns will be displayed.
  
It is useful test the reports before publishing, to do this, after create a report, select '''Testing''' tab.
+
'''Figure 50: Parent Parameter'''  
  
'''Figure 52: Testing Reports'''
+
[[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.
  
Note that for each step, there are instructions displayed according to what were defined in the '''Instruction''' field.
+
To finish, click on '''Save''' button or '''Cancel''' to cancel de action.  
  
'''Step1'''
+
==== Remove Drill Down ====
  
This step will be the Data Source according to the Location and Data Source Type already configured.
+
'''Figure 51: Remove Drill Down'''
  
'''Figure 53: Step1'''
+
[[Image:51_MESWeb_Admin.png|700px]]<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.
  
'''Note''': If there is just a single option of data source, it will be automatically displayed. Select '''Next Step''' to continue.
+
'''Figure 52: Testing Reports'''  
  
'''Step2'''
+
[[Image:52_MESWeb_Admin.png|700px]]<br> Note that for each step, there are instructions displayed according to what were defined in the '''Instruction''' field.
  
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.
+
'''Step1'''  
  
'''Figure 54: Step 2'''
+
This step will be the Data Source according to the Location and Data Source Type already configured.
  
 +
'''Figure 53: Step1'''
  
 +
[[Image:53_MESWeb_Admin.png]]<br>
  
'''Output'''
+
'''Note''': If there is just a single option of data source, it will be automatically displayed. Select '''Next Step''' to continue.
  
Note: If there is no other step created, the '''Output''' is displayed. Select '''Go''' to see the result.
+
'''Step2'''  
  
'''Figure 55: Report Result'''
+
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'''
  
 +
[[Image:54_MESWeb_Admin.png]]<br>
  
'''Note''': To execute a drill down report, click on the displayed link.
+
'''Output'''  
  
=====Summary=====
+
Note: If there is no other step created, the '''Output''' is displayed. Select '''Go''' to see the result.  
Go to Summary tab to publish the report.
 
  
'''Figure 56: Summary'''
+
'''Figure 55: Report Result'''  
  
 +
[[Image:55_MESWeb_Admin.png|700px]]<br>
  
 +
'''Note''': To execute a drill down report, click on the displayed link.
  
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.
+
===== Summary =====
  
1. '''Would you like to publish this report'''?  Select '''Yes, I want to'''.
+
Go to Summary tab to publish the report.  
  
2. The message should be displayed:  '''Thank You'''
+
'''Figure 56: Summary'''  
  
Your report is now published and ready to be executed in the production environment.
+
[[Image:56_MESWeb_Admin.png|700px]]<br>
  
====Edit Reports====
+
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.  
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;
+
1. '''Would you like to publish this report'''? Select '''Yes, I want to'''.
  
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.
+
2. The message should be displayed: '''Thank You'''  
  
'''Note''': The user is able to edit several reports at the same time.
+
Your report is now published and ready to be executed in the production environment.  
  
====Copy Report====
+
==== Edit Reports ====
To copy a report, select the report and select '''Copy''' button.
 
  
The '''Copy Report''' page is displayed.
+
The Edit Report page is the same for Add Reports. See bellow the exceptions:
  
'''Figure 57: Copy Report'''
+
1. If the report was already published, the '''Owner Location''' can<nowiki>’</nowiki>t be updated;
  
 +
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.
  
Enter the Mandatory fields and select '''Save''' to commit. The Edit page is displayed to make any update if necessary.
+
==== Copy Report ====
  
'''Note''': Only Locations with the data source of the same type as this report are available to copy.
+
To copy a report, select the report and select '''Copy''' button.  
  
====Publish Reports====
+
The '''Copy Report''' page is displayed.  
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.
+
'''Figure 57: Copy Report'''
  
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.
+
[[Image:57_MESWeb_Admin.png|700px]]<br>
  
'''Figure 58: Publishing Reports'''
+
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.
  
 +
==== Publish Reports ====
  
The Administrator user is able to:
+
To publish a report, select the report from the list and select '''Publish'''.
  
* Update the report status that will define if the report will be displayed in the Execution module. Just the Active status will be displayed.
+
Note that Security Manager users are able to publish for locations that have assigned.  
* 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;
+
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.
  
To remove the location, select the location and select '''Delete'''. The report is no more publish for the selected location.
+
'''Figure 58: Publishing Reports'''  
  
'''Note''': It is not allowed to delete the location that the report was created.
+
[[Image:58_MESWeb_Admin.png|700px]]<br>
  
'''Figure 59: Test the Report: Execute'''
+
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.
 +
*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;
  
For further information about this page, see '''Testing''' tab.
+
To remove the location, select the location and select '''Delete'''. The report is no more publish for the selected location.  
  
Select '''Save''' to commit.
+
'''Note''': It is not allowed to delete the location that the report was created.  
  
====History Reports====
+
'''Figure 59: Test the Report: Execute'''  
'''Figure 60: History Report'''
 
  
 +
[[Image:59_MESWeb_Admin.png]]<br>
  
This page displays all created report versions.
+
For further information about this page, see '''Testing''' tab.  
  
The version displayed in blue is the current version.
+
Select '''Save''' to commit.  
  
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.
+
==== History Reports ====
  
Selecting any version and clicking on Execute button, the Execute page is displayed. . See Test the Report topic for further information.
+
'''Figure 60: History Report'''
  
<br>
+
[[Image:60_MESWeb_Admin.png]]<br> This page displays all created report versions.  
====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).
+
The version displayed in blue is the current version.  
  
'''Figure 61: Mapping Predefined Reports'''
+
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.
  
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.
+
<br>
  
=====Predefined Maintenance=====
+
==== Predefined ====
Administrators and Security Manager users are able to execute this functionality and it give access to chosen reports to other s.
 
  
======Add Predefined Reports======
+
The predefined reports code cannot be changed. This kind of reports is considered complex and their code are maintained for the MESWeb development team.  
Just Administrator users are able to add Predefined Reports.
 
  
'''Figure 62: Add Predefined Reports'''
+
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'''
  
 +
[[Image:61_MESWeb_Admin.png|700px]]<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.
  
======Edit Predefined Reports======
+
===== Predefined Maintenance =====
Just Administrator users are able to add Predefined Reports.
 
  
'''Figure 63: Edit Predefined Reports'''
+
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.
  
===Report Groups===
+
'''Figure 62: Add Predefined Reports'''
  
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.
+
[[Image:62_MESWeb_Admin.png|700px]]<br>
  
====Filter Report Groups====
+
====== 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.
+
Just Administrator users are able to add Predefined Reports.  
  
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 63: Edit Predefined Reports'''
  
2. Select '''Search '''to filter the list or '''Clear '''to clear all fields.
+
[[Image:63_MESWeb_Admin.png|700px]]<br>
  
3. The results will display in the report group list.
+
=== Report Groups ===
  
'''Figure 64: Filter 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.
  
 +
==== 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.
  
====Add Report Groups====
+
1. To filter the report group list, select a Location from the drop down box provided, and/or enter the Name and/or description.
  
This function allows the Administrator to add a report group based on the group name, description, and location.
+
2. Select '''Search '''to filter the list or '''Clear '''to clear all fields.  
  
1. To add a report group, select '''Add '''located above Report Group list.
+
3. The results will display in the report group list.  
  
2. The Report Group Detail from displays.
+
'''Figure 64: Filter Report Groups'''
  
'''Figure 65: Add Report Group'''
+
[[Image:64_MESWeb_Admin.png|700px]]<br>
  
 +
==== Add Report Groups ====
  
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)
+
This function allows the Administrator to add a report group based on the group name, description, and location.  
  
4. Select '''Save''' to confirm addition.
+
1. To add a report group, select '''Add '''located above Report Group list.  
  
5. Select '''Cancel '''to exit.
+
2. The Report Group Detail from displays.  
  
6. The new report group will appear alphabetically in the report group list.
+
'''Figure 65: Add Report Group'''
  
====Edit Report Groups====
+
[[Image:65_MESWeb_Admin.png|700px]]<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)
  
This function allows the Administrator and Security Manager users to edit a report group<nowiki>’</nowiki>s name, description, and/or location.
+
4. Select '''Save''' to confirm addition.  
  
1. To edit a report group, select the desired report group from the list.
+
5. Select '''Cancel '''to exit.  
  
2. Select '''Edit '''located above the report group list.
+
6. The new report group will appear alphabetically in the report group list.  
  
3. The Report Group Detail form displays.
+
==== Edit Report Groups ====
  
'''Figure 66: Edit Report Group'''
+
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.
  
 +
2. Select '''Edit '''located above the report group list.
  
<u>NOTE</u>: Location is a read only field.
+
3. The Report Group Detail form displays.  
  
4. After completing changes, select '''Save '''to confirm.
+
'''Figure 66: Edit Report Group'''  
  
5. Select '''Cancel '''to exit without saving.
+
[[Image:66_MESWeb_Admin.png|700px]]<br>
  
====Delete Report Groups====
+
<u>NOTE</u>: Location is a read only field.
  
This function allows the Administrator to delete a report group from the report group list.
+
4. After completing changes, select '''Save '''to confirm.  
  
1. To delete a report group, select the desires report group from the list.
+
5. Select '''Cancel '''to exit without saving.  
  
2. Select '''Delete''' located above the report group list.
+
==== Delete Report Groups ====
  
3. A confirmation prompt will display. Select '''Yes '''to confirm or '''No '''to exit.
+
This function allows the Administrator to delete a report group from the report group list.  
  
4. The report group will be removed from the report group list.
+
1. To delete a report group, select the desires report group from the list.  
  
'''Figure 67: Delete Report Group'''
+
2. Select '''Delete''' located above the report group list.
  
 +
3. A confirmation prompt will display. Select '''Yes '''to confirm or '''No '''to exit.
  
Note: It is not allowed to delete a report group if:
+
4. The report group will be removed from the report group list.
  
* A report were created or published to the report group.
+
'''Figure 67: Delete Report Group'''
* Any user has permission for this report group.
 
  
====Add Report to Group====
+
[[Image:67_MESWeb_Admin.png|700px]]<br> Note: It is not allowed to delete a report group if:
  
This function allows the Administrator to add a report to a report group by searching for its location and data source.
+
*A report were created or published to the report group.
 +
*Any user has permission for this report group.
  
1. To add a report to a report group, select the desired report group from the list.
+
==== Add Report to Group ====
  
2. Select '''Add Report to Group''' located above the report group list.
+
This function allows the Administrator to add a report to a report group by searching for its location and data source.  
  
'''Figure 68: Add Report to Group'''
+
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.
  
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.
+
'''Figure 68: Add Report to Group'''
  
4. Select the search icon located to the right of the drop down boxes.
+
[[Image:68_MESWeb_Admin.png|700px]]<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.  
  
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.
+
4. Select the search icon located to the right of the drop down boxes.  
  
6. Select '''Save '''to add the report to the 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.  
  
7. Select '''Cancel '''to exit.
+
6. Select '''Save '''to add the report to the report group.  
  
'''Figure 69: Report to Group Form'''
+
7. Select '''Cancel '''to exit.
  
 +
'''Figure 69: Report to Group Form'''
  
==Access Control==
+
[[Image:69_MESWeb_Admin.png|700px]]<br>
  
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).
+
== Access Control ==
  
1. To access MESWeb, navigate to '''Administration <nowiki>></nowiki> MESWeb Central'''.
+
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).  
  
2. Select the Access Control icon located on the MESWeb Central Main screen.
+
1. To access MESWeb, navigate to '''Administration <nowiki>></nowiki> MESWeb Central'''.  
  
'''Figure 70: MESWeb Central Access Control'''
+
2. Select the Access Control icon located on the MESWeb Central Main screen.
  
 +
'''Figure 70: MESWeb Central Access Control'''
  
 +
[[Image:70_MESWeb_Admin.png|700px]]<br>
  
 +
<br> 3. Upon selecting the Access Control icon, two additional icons become available: Users and User Groups.
  
3. Upon selecting the Access Control icon, two additional icons become available: Users and User Groups.
+
'''Figure 71: Access Control Functions'''
  
'''Figure 71: Access Control Functions'''
+
[[Image:71_MESWeb_Admin.png|700px]]<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 72: User Icon in Tab'''<br>
  
 +
[[Image:72_MESWeb_Admin.png|700px]]<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.
+
=== Users ===
  
'''Figure 72: User Icon in Tab'''
+
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.
  
 +
1. To filter the User List, enter the desired User Name, Full Name, and/or Email address into the provided fields.
  
===Users===
+
2. Select '''Search''' to filter 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<nowiki>’</nowiki>s information.
+
3. Select '''Clear '''to clear all fields.  
  
====Filter Users====
+
'''Figure 73: Filter User List'''
  
The filtering option located in the '''Users''' tab allows the Administrator to search for specific employees by User Name, Full Name, and/or Email.
+
[[Image:73_MESWeb_Admin.png|700px]]<br>
  
1. To filter the User List, enter the desired User Name, Full Name, and/or Email address into the provided fields.
+
==== Manage Permissions ====
  
2. Select '''Search''' to filter users.
+
This function allows Administrators to assign Administrator permissions to users for specific locations.  
  
3. Select '''Clear '''to clear all fields.
+
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 73: Filter User List'''
+
2. Select '''Manage Permissions'''.
  
 +
'''Figure 74: Manage Permissions'''
  
 +
[[Image:74_MESWeb_Admin.png|700px]]<br>
  
====Manage Permissions====
+
3. The User Permissions form displays.
  
This function allows Administrators to assign Administrator permissions to users for specific locations.
+
'''Figure 75: User Permissions Form'''
  
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.
+
[[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.  
  
2. Select '''Manage Permissions'''.
+
6. Upon selecting a location, two panels display allowing the Administrator to assign Roles, Report Groups, Reports, and Mesr Customers to the user.  
  
'''Figure 74: Manage Permissions'''
+
'''Figure 76: Assign Privileges'''  
  
 +
[[Image:76_MESWeb_Admin.png]]<br>
  
 +
7. To move an '''Available''' Role/Report Group/Report/Mesr Customer to the '''Selected '''column, double-click or drag and drop the selection.
  
3. The User Permissions form displays.
+
<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 75: User Permissions Form'''
+
8. After moving all applicable selections in each tab, select '''Save '''to assign permissions to the user.
  
 +
9. Select '''Cancel '''to exit.
  
4. With this form, the administrator can assign Administrator permissions to a user by checking the box to the right of the Administrator option.
+
10. The user will appear in the user list with the '''Administrator''' box selected.  
  
6. Upon selecting a location, two panels display allowing the Administrator to assign Roles, Report Groups, Reports, and Mesr Customers to the user.
+
==== Edit Users ====
  
'''Figure 76: Assign Privileges'''
+
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.'''
  
7. To move an '''Available''' Role/Report Group/Report/Mesr Customer to the '''Selected '''column, double-click or drag and drop the selection.
+
'''Figure 77: Edit Users'''  
  
<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.
+
[[Image:77_MESWeb_Admin.png|700px]]<br>  
  
8. After moving all applicable selections in each tab, select '''Save '''to assign permissions to the user.
+
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'''.  
  
9. Select '''Cancel '''to exit.
+
3. Select '''Cancel '''to exit.  
 
 
10. The user will appear in the user list with the '''Administrator''' box selected.
 
 
 
====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 77: Edit Users'''
 
 
 
 
 
 
 
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'''.
 
 
 
3. Select '''Cancel '''to exit.
 
 
 
'''Figure 78: User Search Detail'''
 
  
 +
'''Figure 78: User Search Detail'''
  
 +
[[Image:78_MESWeb_Admin.png]]<br>
  
 
----
 
----
  
==Appendix A==
+
== Appendix A ==
  
'''''Access Control'''''
+
'''''Access Control'''''  
  
It is a module that will set the permissions for users and external customers of Sanmina
+
It is a module that will set the permissions for users and external customers of Sanmina  
  
'''''administrator'''''
+
'''''administrator'''''  
  
the System Administration has full access to MESWeb - all s, all reports, all customers.
+
the System Administration has full access to MESWeb - all s, all reports, all customers.  
  
'''''customer user'''''
+
'''''customer user'''''  
  
user for external customers to access the application
+
user for external customers to access the application  
  
'''''find username'''''
+
'''''find username'''''  
  
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
+
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  
  
'''''MES Web'''''
+
'''''MES Web'''''  
  
application that provides reporting capabilities through a web-based interface.
+
application that provides reporting capabilities through a web-based interface.  
  
'''''parameters'''''
+
'''''parameters'''''  
  
definitions for data, reports, or configurations.
+
definitions for data, reports, or configurations.  
  
'''''roles'''''
+
'''''roles'''''  
  
''user profile inside MESWeb''
+
''user profile inside MESWeb''  
  
'''''SiteMinder'''''
+
'''''SiteMinder'''''  
  
''Universal login of Sanmina''
+
''Universal login of Sanmina''  
  
'''''user'''''
+
'''''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<nowiki>’</nowiki> access to only that data belonging to specific customers.
+
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'''''
+
'''''username'''''  
  
the username is the siteminder username (or a partial string)
+
the username is the siteminder username (or a partial string)  
  
 
----
 
----
  
==Revision Log==
+
== Revision Log ==
 
 
{|border="2" cellspacing="0" cellpadding="4" width="91%"
 
|'''Revision'''
 
|'''Date'''
 
|'''Editor'''
 
|'''Comment'''
 
  
 +
{| cellspacing="0" cellpadding="4" border="2" width="91%"
 +
|-
 +
| '''Revision'''
 +
| '''Date'''
 +
| '''Editor'''
 +
| '''Comment'''
 
|-
 
|-
|v 1.0  
+
| v 1.0  
|April/08/2014
+
| April/08/2014  
|Elaine Fonaro  
+
| Elaine Fonaro  
|This is the first revision of Access Control: User<nowiki>’</nowiki>s Guide
+
| This is the first revision of Access Control: User<nowiki>’</nowiki>s Guide
 
 
 
|-
 
|-
|v 1.0  
+
| v 1.0  
|April/08/2014
+
| April/08/2014  
|Ashley Martin  
+
| Ashley Martin  
|General Review  
+
| General Review
 
 
 
|-
 
|-
|V 1.0
+
| V 1.0  
|July/21/2014
+
| July/21/2014  
|Elaine Fonaro
+
| Elaine Fonaro  
|Add the Report Module and general review
+
| Add the Report Module and general review
 
 
 
|-
 
|-
|V1.0
+
| V1.0  
|Oct/29/2014
+
| Oct/29/2014  
|Elaine Fonaro and<br>Claudia Urenda
+
| Elaine Fonaro and<br>Claudia Urenda  
|Final Review
+
| Final Review
 
 
 
|}
 
|}
  
[[category:uncategorized]]
+
[[Category:Uncategorized]]

Revision as of 16:45, 1 December 2014

Cirrus > Reporting > MESWeb Central
Sanmina logo.png


MESWeb
MESWeb Central
Version MES15 Portal 1.0
Work Instruction


This Work Instruction is Sanmina's corporate standard.
This document is under revision control. The latest revision is located on SanminaNet.
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 formal security controls, and convoluted development requirements are problems faced by all Sanmina 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 Sanmina-SCI s with an easy mechanism for managing users, roles, applications, services and the relations among them.

Administration

The Administration module was developed for employees with the following roles:

  • 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.

1. To access MESWeb, navigate to Administration > MESWeb Central.

2. Select the Administration icon located on the MESWeb Central Main screen.

Figure 1: MESWeb Central Administration

01 MESWeb Admin.png

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

Figure 2: Administration Functions

02 MESWeb Admin.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


Locations

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.

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.

1. To filter the name list, enter the 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

04 MESWeb Admin.png

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, andCulture. All fields are mandatory.

3. Select Save to confirm or Cancel to exit.

Figure 5: Add Location

05 MESWeb Admin.png
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.

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 form 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

06 MESWeb Admin.png
4. The changes to the location will appear in the name list on the main screen of the Locations tab.

Delete Location

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

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.

Figure 7: Delete Location

07 MESWeb Admin.png

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.

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.

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

08 MESWeb Admin.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

09 MESWeb Admin.png

1. To add a server name, select Add located above the server name list.

2. The Server Detail form 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 Server Name

10 MESWeb Admin.png

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 form displays. After editing the server name, select Save to confirm.

4. Select Cancel to exit.

Figure 11: Edit Server

11 MESWeb Admin.png

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 prompt will display. Select Yes to confirm or No to exit.

Figure 12: Delete Server Name

12 MESWeb Admin.png
Note: If the server has any location assigned, it not will be allowed delete the server.

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.

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 13: Filter Data Sources

13 MESWeb Admin.png

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 form displays.

2. Enter the data source Name, Description,Location,and theDatabase Type into the details form. All fields except the description field are mandatory.

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.

4. Select Save to confirm or Cancel to exit

Figure 14: Add Data Source

14 MESWeb Admin Add Data Source.png

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

15 MESWeb Admin Data Source Types.png

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 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.

4. After changing desired information, select Save to confirm or Cancel to exit.

Figure 16: Edit Data Source

16 MESWeb Admin Edit.png

Note that editing the Data Source, the Connection Parameters field will be displayed according to the chosen during the data source addition.

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 17: Delete Data Source

17 MESWeb Admin Delete.png

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 screen under the Data Sources tab.

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

Figure 18: Data Source Type

18 MESWeb Admin Data Source Type.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.

Figure 19: Data Source Type List

19 MESWeb AdminData Source Type List.png

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 20: Add Data Source Type

20 MESWeb Admin Add Data Source.png

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 21: Edit Data Source Type

21 MESWeb Admin Edit Data Source Type.png

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 22: Delete Data Source Type

22 MESWeb Admin Delete Data Source Type.png
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;

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.

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 23: Filter Reports

23 MESWeb Admin Filter Reports.png

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

Add Reports

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

Figure 24: Add Reports

24 MESWeb Admin Add Reports.png
To add a report the user must enter all mandatory fields, configure the SQL command clicking on the "+" 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: 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.

SQL Code

Figure 25: Report Maintenance: SQL Code Configuration

25 MESWeb Admin SQLCode Add Report.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%> .

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 26: Parameters

26 MESWeb Admin SQLCode Add Report.png

1. 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. 

2. Select "New Step"

3. With a new step in place we can begin adding our parameters.

4. Select "New Parameters" to configure the parameters;

Figure 27: New Parameter

27 MESWeb Admin.png

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.  For example, "Customers" in the WIP Distribution report.

2. Instruction

You 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 you enter in this field will be displayed in this list.

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:

  • 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 28: Drop Down List Parameter

28 MESWeb Admin.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 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 the

Figure 29: Option Item

29 MESWeb Admin.png
Select Add to open the maintenance screen.

Figure 30: Optional Item Maintenance

30 MESWeb Admin.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.

  • Customer Drop down List

This option is almost the same of the Drop down List; the difference is that for this case, the fields Command,
Data Type, Value Field and Display Field are already configured, so it will bring a customer list.

Figure 31: Customer Drop Down List

31 MESWeb Admin.png
It is the same for Location Drop down List,Product Drop down List andProject Drop down List options. The user must enter the mandatory fields (Name, Instructions and the Parameter SQL).

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.

These options are available when the Data Source Type selected is MESR.


  • 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 32: List Box

32 MESWeb Admin.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).


  • Customer List Box

This option is the same as List Box;

Figure 33: Customer List Box

33 MESWeb Admin.png

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.

Note: These options are available when the Data Source Type selected is MESR.


  • Data Range

This option is used to set a range of date.

Figure 34: Data Range

34 MESWeb Admin.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;


  • Date Time

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

Figure 35: Date Time

35 MESWeb Admin.png

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


  • Check Box

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

Figure 36: Check Box

36 MESWeb Admin.png
The user must enter the mandatory fields (Name, Parameter SQL and Instructions) already described;


  • Text Box

This allows the user to set any text entry.

Figure 37: Text Box

37 MESWeb Admin.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 38: Validation Field

38 MESWeb Admin.png
There are four validation types:

  • Data Type Validation

Figure 39: Validation: Data Type

39 MESWeb Admin.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.

  • Expression Validation

Figure 40: Validation: Expression

40 MESWeb Admin.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 41: Validation: Range

41 MESWeb Admin.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.

  • Value Validation

Figure 42: Validation: Value

42 MESWeb Admin.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 43: Operator Field

43 MESWeb Admin.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.


  • 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 44: Multi-Line Text Box

44 MESWeb Admin.png

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

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


  • 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 45: Radio Button List

45 MESWeb Admin.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.

Drill Down

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

Figure 46: Drill Down

46 MESWeb Admin.png

Add Drill Down

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

Figure 47: Add Drill Down Report

47 MESWeb Admin.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 48: Static Value

48 MESWeb Admin.png
Static: will set a fixed value to the DD report parameter;

Figure 49: Field Value

49 MESWeb Admin.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 50: Parent Parameter

50 MESWeb Admin.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 Cancel to cancel de action.

Remove Drill Down

Figure 51: Remove Drill Down

51 MESWeb Admin.png
To remove a drill down, select the report and click on Remove button. Click on Yes to confirm orCancel to cancel the action.

Testing

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

Figure 52: Testing Reports

52 MESWeb Admin.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 53: Step1

53 MESWeb Admin.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 54: Step 2

54 MESWeb Admin.png

Output

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

Figure 55: Report Result

55 MESWeb Admin.png

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

Summary

Go to Summary tab to publish the report.

Figure 56: Summary

56 MESWeb Admin.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.

Edit Reports

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’t be updated;

2. 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.

Copy Report

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

The Copy Report page is displayed.

Figure 57: Copy Report

57 MESWeb Admin.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.

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 58: Publishing Reports

58 MESWeb Admin.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.
  • 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 59: Test the Report: Execute

59 MESWeb Admin.png

For further information about this page, see Testing tab.

Select Save to commit.

History Reports

Figure 60: History Report

60 MESWeb Admin.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.


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 61: Mapping Predefined Reports

61 MESWeb Admin.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.

Predefined Maintenance

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.

Figure 62: Add Predefined Reports

62 MESWeb Admin.png

Edit Predefined Reports

Just Administrator users are able to add Predefined Reports.

Figure 63: Edit Predefined Reports

63 MESWeb Admin.png

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.

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 64: Filter Report Groups

64 MESWeb Admin.png

Add Report Groups

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.

2. The Report Group Detail from displays.

Figure 65: Add Report Group

65 MESWeb Admin.png
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)

4. Select Save to confirm addition.

5. Select Cancel to exit.

6. The new report group will appear alphabetically in the report group list.

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 form displays.

Figure 66: Edit Report Group

66 MESWeb Admin.png

NOTE: Location is a read only field.

4. After completing changes, select Save to confirm.

5. Select Cancel to exit without saving.

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 67: Delete Report Group

67 MESWeb Admin.png
Note: It is not allowed to delete a report group if:

  • 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.

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 68: Add Report to Group

68 MESWeb Admin.png
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.

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.

6. Select Save to add the report to the report group.

7. Select Cancel to exit.

Figure 69: Report to Group Form

69 MESWeb Admin.png

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 screen.

Figure 70: MESWeb Central Access Control

70 MESWeb Admin.png


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

Figure 71: Access Control Functions

71 MESWeb Admin.png


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 72: User Icon in Tab

72 MESWeb Admin.png

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.

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

73 MESWeb Admin.png

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.

Figure 74: Manage Permissions

74 MESWeb Admin.png

3. The User Permissions form displays.

Figure 75: User Permissions Form

75 MESWeb Admin.png
4. With this form, the administrator can assign Administrator permissions to a user by checking the box to the right of the Administrator option.

6. Upon selecting a location, two panels display allowing the Administrator to assign Roles, Report Groups, Reports, and Mesr Customers to the user.

Figure 76: Assign Privileges

76 MESWeb Admin.png

7. To move an Available Role/Report Group/Report/Mesr Customer 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.

8. After moving all applicable selections in each tab, select Save to assign permissions to the user.

9. Select Cancel to exit.

10. The user will appear in the user list with the Administrator box selected.

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 77: Edit Users

77 MESWeb Admin.png

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.

3. Select Cancel to exit.

Figure 78: User Search Detail

78 MESWeb Admin.png


Appendix A

Access Control

It is a module that will set the permissions for users and external customers of Sanmina

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 Sanmina

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)


Revision Log

Revision Date Editor Comment
v 1.0 April/08/2014 Elaine Fonaro This is the first revision of Access Control: User’s Guide
v 1.0 April/08/2014 Ashley Martin General Review
V 1.0 July/21/2014 Elaine Fonaro Add the Report Module and general review
V1.0 Oct/29/2014 Elaine Fonaro and
Claudia Urenda
Final Review