Difference between revisions of "SOP-MES0039 MESWeb Central"

From 42Q
Jump to navigation Jump to search
Line 916: Line 916:
 
 
 
 
  
−
==== '''<span style="font-size:small;">​​​​​​​​​​​​​Summary</span>''' ====
+
 
 +
==== <span style="font-size:small;">​​​​​​Summary</span> ====
  
 
==== &nbsp; ====
 
==== &nbsp; ====

Revision as of 13:51, 4 June 2018

42Q Home >Administration > MESWeb Central
RTENOTITLE      

MESWeb
MESWeb Central
Version MES15 Portal 1.0
Work Instruction

 

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

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

 

Contents

Introduction

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

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

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

 


Administration

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

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

 

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

  • All MESR Customers: this role allows the user to see all customers of a specific location.
  • All data sources: this role allow user to see all data sources of a specific location.
  • All Reports: this role allows the user to see and execute all reports available in a specific location.
 
This section will cover how to navigate and execute all location, data source and custom reports activities. With this portlet, the user can add, edit or delete locations, servers, data sources, and data source types. The user can also access report group maintenance to perform searches, create, edit or delete report groups and add s to report groups. Report maintenance also allows the user to create, edit, or delete reports. The user can also publish/unpublished reports.

To access MESWeb,

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

 

Figure 1: MESWeb Central Administration

Image1.jpg

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

 

Figure 2: Administration Functions

Image2.jpg

  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

Image3.jpg

 

Locations

Definition: Location is a specific site or plant.

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

 

Filter Locations

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

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

 

Figure 4: Filter Locations

Image123.jpg.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, and Culture. All fields are mandatory.
  3. Select Save to confirm or Cancel to exit.

 

Figure 5: Add Location

Image84.jpg.png

 

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

 

 

Edit Location

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

 

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

 

Figure 6: Edit Location

Image168.jpg.png

 

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

 

Edit Location

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

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

 

Figure 7: Delete Location

Image50.jpg.png

 

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

 

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

 

Server

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

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

 

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

 

Figure 8: Server

Image144.jpg.png

A server list displays containing all previously created servers listed numerically and alphabetically.

From this screen, the Administrator can add, edit or delete a server.

 

Figure 9: Server List

Image179.jpg.png

 

Add ServerName

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

 

 

Figure 10: Add a Server Name

Image101.jpg.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 pop up displays. After editing the server name, select Save to confirm.
  4. Select Cancel to exit.

 

 

Figure 11: Edit Server

RTENOTITLE

 

Delete Server Name

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

 

Figure 12: Delete Server Name

Image138.jpg.png

NOTE: If the server has any location assigned, it not will be allowed to 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.

 

Figure 13: Data Source List

Image162.jpg.png

 

Filter Data Sources

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

 

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

 

 

Figure 14: Filter Data Sources

RTENOTITLE

 

Add Data Sources

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

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

 

Figure 15: Add Data Source

Image121.jpg.png

 

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

 

Figure 16: Select Database Type

Image65.jpg.png

Figure 17: Conection Parameter

Image75.jpg.png

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

 

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

The Connection String should have the following format.

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

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

 

Figure 18: Data Source -Types

Image180.png.png

 

  1. Select Save to confirm or Cancel to exit

 

Edit Data Sources

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

 

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

 

Figure 19: Edit Data Source

Image163.jpg.png

NOTE: editing the Data Source, the Connection Parameters field will be displayed according to theDatabase Type 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 20: Delete Data Source

Image61.jpg.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 page under the Data Sources tab.

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

 

Figure 21: Data Source Type

Image129.jpg.png

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

 

​​​​​​​​​​​​​​Add Data Source Type

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

 

Figure 22: Add Data Source Type

Image183.jpg.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 23: Edit Data Source Type

Image80.jpg.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 24: Delete Data Source Type

Image94.jpg.png

 

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

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

 

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

Image105.jpg.png

Note: just the Publish functionality is available for theReports 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 26: Add Reports

Image172.jpg.png

 

Figure 27: Add Reports Basic

Image12.jpg.png

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

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

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

 

​​​​​​​​​​​​​​SQL Code

Figure 28: Report Maintenance: SQL Code Configuration

Image72.jpg.png

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

 

​​​​​​​​​​​​​​Parameters

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

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

Figure 29: Parameters

Image177.jpg.png#

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

 

Figure 30: New Parameter

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

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

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

  • Parameter Type

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

  • Drop Down List

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

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

 

Figure 31: Drop Down List Parameter

Image176.jpg.png

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

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

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

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

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

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

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

 

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

 

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

Figure 32: Optional Item

Image68.jpg.png

Select Add to open the maintenance screen.

Figure 33: Optional Item Maintenance

Image173.png.png

For example, the user can remove the <%location%> command and replace it for any value he wants.

Select Save to commit.
During the report execution, if no value is entered for this command, it will be replaced or removed automatically.
Also, the user can Edit or Delete items by clicking on Edit / Delete buttons. Select Save to commit.

Figure 34: Parents

Image117.jpg.png

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

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

 

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

For example:

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

Figure 35: Add Parents

Image60.jpg.png

 

  1. List Box

 

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

Figure 36: List Box

Image181.jpg.png

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

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

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

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

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

 

  1. Data Range

 

 
This option is used to set a range of date.

Figure 37: Data Range

Image132.jpg.png

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

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

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

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

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

 

  1. Date Time

 

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

Figure 37: Date Time

Image67.jpg.png

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

 

  1. Check Box

 

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

Figure 38: Check Box

Image118.jpg.png

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

 

  1. Text Box

 

 
This allows the user to set any text entry.

Figure 39: Text Box

Image93.jpg.png

 

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

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

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

Figure 40: Validation Field

Image161.jpg.png

There are four validation types:

 

  1. Data Type Validation

 

Figure 41: Validation: Data Type

Image79.jpg.png

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

 

  1. Expression Validation

Figure 42: Validation: Expression

Image62.jpg.png

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

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

  1. Range Validation

 

Figure 43: Validation: Range

Image6.jpg.png

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

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

 

  1. Value Validation

 

Figure 44: Validation: Value

Image184.jpg.png

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

Figure 45: Operator Field

Image127.jpg.png

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

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

 

  1. Multi-Line Text Box

 

 

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

Figure 46: Multi-Line Text Box

Image57.jpg.png

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

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

 

  1. Radio Button List

 

 

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

Figure 47: Radio Button List

Image104.jpg.png

 

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

Select Save Parameters to commit.

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

 


Drill Down

 

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

Figure 48: Drill Down

Image166.jpg.png

 

Add Drill Down

 

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

Figure 49: Add Drill Down Report

Image11.jpg.png

 

  • Current Report Column

 

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

 

  • Child Report

 

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

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

No index entries found.

Figure 50: Static Value

Image119.jpg.png

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

Figure 51: Field Value

Image128.jpg.png

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

All parent report columns will be displayed.

Figure 52: Parent Parameter

Image133.jpg.png

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

All parent report parameters will be displayed.

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

 

Remove Drill Down

 

Figure 53: Remove Drill Down

Image106.jpg.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 54: Testing Reports

Image165.jpg.png

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

 

Step1

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

Figure 55: Step1

Image82.jpg.png

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

 

Step2

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

Figure 56: Step 2

Image70.jpg.png

 

Output

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

Figure 57: Report Result

Image98.png.png

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

 


​​​​​​Summary

 

Go to Summary tab to publish the report.

Figure 58: Summary

Image167.jpg.png

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

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

2. The message should be displayed: Thank You

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

 

​​​​​​​​​​​​​​Edit Reports

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

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

 

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

 

​​​​​​​​​​​​​​Copy Report

 

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

The Copy Report page is displayed.

Figure 59: Copy Report

Image164.jpg.png

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

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

 

​​​​​​​​​​​​​​Publish Reports

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

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

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

Figure 60: Publishing Reports

Image92.png.png

 

The Administrator user is able to:#

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

 

 

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

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

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

Figure 61: Test the Report: Execute

Image99.png.png

For further information about this page, see Testing tab.

Select Save to commit.

 

​​​​​​​​​​​​​​History Reports

 

Figure 62: History Report

Image100.png.png

This page displays all created report versions.

The version displayed in blue is the current version.

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

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

 

​​​​​​​​​​​​​​Predefined

 

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

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

Figure 63: Mapping Predefined Reports

Image95.jpg.png

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

 

​​​​​​​​​​​​​​Predefined Maintenance

 

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

 

Edit Predefined Reports (Maintanance)

 

Just Administrator users are able to add Predefined Reports.

Figure 64: Edit Predefined Reports

Image109.jpg.png

 

Report Groups

 

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

 

​​​​​​​​​​​​​​Filter Report Groups

 

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

 

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

 

 

Figure 65: Filter Report Groups

Image107.jpg.png

 

​​​​​​​​​​​​​​Add Report Groups

 

 

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

 

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

 

 

Figure 66: Add Report Group

Image69.jpg.png

 

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

 

​​​​​​​​​​​​​​Edit Report Groups

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

 

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

 

Figure 67: Edit Report Group

Image170.jpg.png

NOTE: Location is a read only field.

 

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

 

 

​​​​​​​​​​​​​​Delete Report Groups

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

 

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

 

Figure 68: Delete Report Group

Image124.jpg.png

 

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

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

 

​​​​​​​​​​​​​​Add Report to Group

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

 

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

 

 

Figure 69: Add Report to Group

Image125.jpg.png

 

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

 

Access Control

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

 

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

 

Figure 70: MESWeb Central Access Control

Image131.jpg.png

 

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

 

 

Figure 71: Access Control Functions

Image169.jpg.png

 

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

 

 

Figure 72: User Icon in Tab

Image103.jpg.png

 

 
  1.  
Users

 

 

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

 

    1. Filter Users

 

 

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

 

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

 

 

Figure 73: Filter User List

Image24.jpg.png

 

    1. Manage Permissions

 

 

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

 

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

 

Figure 74: User Permissions

Image48.jpg.png

 

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

 

 

Figure 75: Assign Privileges (User Permissions)

Image58.jpg.png

 

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

 

 

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

 

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

 

 

    1. Edit Users

 

 

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

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

 

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

 

Figure 76: Edit Users

Image74.jpg.png

 

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

 

Figure 77: User Search Detail

Image78.jpg.png

 

 

    1. Import Users

 

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

Select the Import buttom and the Import Users dialog displays.

Figure 78: Import Users

Image51.jpg.png

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

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

 

 

 

 

Figure 79: Import Users Template

Image83.jpg.png

 

  1. User Groups

 

 

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

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

Figure 80: User Groups Main Page

Image140.jpg.png

 

    1. Filter User Groups

 

 

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

 

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

 

Figure 81: Filter User List

Image76.jpg.png

 

    1. Add User Groups

 

 

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

 

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

 

 

Figure 82: Add User Group

Image49.jpg.png

 

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

 

 

    1. Edit User Groups

 

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

 

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

 

Figure 83: Edit User Group

Image171.jpg.png

NOTE: Location is a read only field.

 

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

 

 

    1. Delete User Groups

 

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

 

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

 

Figure 84: Delete Report Group

Image97.jpg.png

 

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

the user group has users assigned;

 

 

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

 

    1. Mapping User

 

This functionality map users to a selected group.

To map users, follow the stepes bellow:#

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

 

 

Figure 85: Mapping User

Image142.jpg.png

 

      1. Import Users to Group

 

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

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

Figure 86: Import Users to Group

Image85.jpg.png

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

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

 

Figure 87: Import Users Template

Image59.jpg.png#

    1. Manage Permissions

 

This function allows Administrators to assign permissions for groups.

 

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

 

Figure 88: Manage PermissionsUser Group Permissions

Image77.jpg.png

Figure 89: Assign Privileges

Image178.jpg.png

 

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

 

 

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

 

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

 

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

 

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

 

customer user
user for external customers to access the application

 

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

 

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

 

parameters
definitions for data, reports, or configurations.

 

roles
user profile inside MESWeb

 

SiteMinder
Universal login of 42Q

 

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

 

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

 

Revision Log

 

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

Elaine Fonaro

Business Analyst

Technical Writer

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

Added the User Groupnew topic

Retrieved from "https://42qrpt1.42-q.com/mes_wiki/index.php?title=SOP-MES0039_MESWeb_Central&oldid=26605"