| HTML |
|---|
<style>
.text-span-6 {
background-image: linear-gradient(99deg, rgba(170, 163, 239, .5), rgba(125, 203, 207, .5));
border-radius: 50px;
padding-left: 15px;
padding-right: 15px;
}
#title-text {
display: none;
}
.panelgradient {
background-image: linear-gradient(180deg, #d5def0, whitesmoke);
border-radius: 8px;
flex-direction: column;
justify-content: center;
align-items: center;
padding: 4rem;
display: flex;
position: relative;
}
</style>
<div class ="panelgradient">
<h1 style="text-align: center;">Security <br> (Users and Roles)</h1>
</div> |
Introduction to the Security Module
The Security Module ensures
Security module introduction
The Security module plays a crucial role in ensuringthe safety and integrity of your projects
by managing.
Some of the key features include:
- Managing user access, roles, and permissions.
- Controls who can access, view, and modify
- solution components.
- Controls who can manage runtime user interactions with displays and actions.
This module also supports integration with external user authentication systems, such as Active Directory (AD) and LDAP, to streamline user management across your organization, and implements the technical requirements for for critical infrastructures and regulated process automation, including FDA 21 CFR Part 11.In this chapter, we will explore the key concepts and terminologies related to the Security Module, its configuration process, and the application of security measures in your projects. By the end of this chapter, you will have a solid understanding of how to effectively manage users, roles, and permissions, and ensure a secure environment for your FactoryStudio projects.
On this page:
| Table of Contents | ||||||
|---|---|---|---|---|---|---|
|
Key Concepts and Terms
The Security Module defines the Users allowed to use or modify solution, and their Roles, Permission, and Security Policies. The definition of users can be created locally using the platform tools or executed in connection with external definitions such as Active Directory, LDAP servers, or external SQL databases.
Purpose and Key ConceptsUsers
Anyone accessing the projectsolution, either on the engineering or runtime mode, is a User.
| Note | ||
|---|---|---|
| ||
| If the User did not execute any Log On or Identification procedure, it will be recognized as the pre-defined Guest User, which is equivalent to an anonymous access. |
Permissions
The Permissions concept ensures that users access only the necessary functionalities and data for their job, reducing the risk of security breaches and unauthorized activities. The group-based Permissions allow configuring which functions users can access while editing or during the project runtime.
Policies
The Policies enable the management of the requirements on User Identification and Session control. For instance, you can setup a Policy for minimum of 8 letters passwords (Identification Policy) and an automated LogOff after 8 hours of usage (Session Policy). Then, you setup which Users will be required to follow that Policy.
RuntimeUsers
in engineering (Designer Tool) or in runtime mode (Displays).
Permissions
Permissions are set levels of access for each user that determine what they can or cannot do within the solution.
Policies
Policies manage requirements on User Identification and Session Control.
RuntimeUsers
These users are created and retrieved It is a very common Project requirement to dynamic add and remove Users. Instead of modifying the Project every time, the platform allows the concept of Runtime Users which are dynamically created and retried from an external encrypted SQL database , but other Identification server can be integrated.
The combination of the Runtime Users and the ones defined at the SecurityUsers table are called Project Users.
| Note |
|---|
The main difference between the two is that engineering users can access the software's engineering mode, allowing them to design and configure the project. In contrast, runtime users only can use the application, they cannot change the project configuration or design since they don't have access to the engineering mode. |
Understanding the Security module
Features highlights
Content
User roles management
Content
External Users Definitions
Content
Project configurations protections
Content
Runtime protections
Content
or other identification servers.
Understanding the Security Module
What the Security Module Enables
User roles management
Managing user roles involves assigning a role to each user that defines their level of access to various components of the solution. Each role has its permissions, which can be customized to meet the security requirements of your organization.
Managing External Users (Runtime Users)
External Users in this context refers to users who are not part of the organization but need access to specific components of the project. This can include contractors, clients, or third-party vendors. These users are typically managed via RuntimeUsers or integration with Active Directory and LDAP.
Securing Solution Configuration
The platform provides several tools to secure the solution configuration itself. By assigning Permissions and Policies, administrators can control which users have access to specific modules, editors and documents. This ensures that only authorized users can make changes on each part the solution configuration.
Securing Runtime Execution
Securing runtime involves managing user sessions in client displays by setting password requirements, session restrictions, and e-signature settings. The platform allows administrators to monitor client connections and manage active sessions.
Users, Permissions and Policies Summary
For a summary of the Security Configuration, go to Security Overview, which presents the basic configuration steps and properties for Users, Permission and Policies.
The next section presents the configuration of those elements in further details.
Configuring the Security Module
Configuration Workflow
Each User is assigned to a set of Permissions and a to a Session Policy.
Security Configuration Interfaces | |
|---|---|
Action | Where |
Edit Users | Security → Users |
Define security Permissions | Security → Permissions |
Define security Policies | Security → Policies |
Manage RuntimeUsers | Security → RuntimeUsers |
RuntimeUsers
Runtime Users are either defined in an external database or created dynamically using the CreateUser method. They can log in and use remote operation displays similarly to users specified in the solution configuration.
→ Read more about RuntimeUsers.
AD/LDAP Integrations
Windows AD Integration
The platform can automatically execute user credentials validation and user connection identification using native Windows Active Directory integration, available for users connecting from Windows operating systems.
Configuring the Security module
Configuration Workflow
Users, Permissions and Policies
Creating, editing and managing users
The Named Users with authorization to access the Project are defined in the SecurityUsers table on Security → Users.
Pre-defined users
The following user names are configured by default:
Pre-built Users
Administrator
You can not delete the Guest user, neither add a password to it. The Guest user must be available as the default user when you log off as another user. You may want to change the Guest user permissions, so that Guest users do not have access to any resource.
Do not create other Users with those names nor change the row ID of those users, as they are built-in platform objects.
The Administrator is the only user who can delete or block users and the only user who can define passwords for Database DB interfaces.
Guest User is used for anonymous login and does not have password assigned to it.
RemovingUsersYou have three ways to disable users:
Blocking: Use to block the user’s access. You may want to use this for users who are no longer in your company.
Flagging as deleted: Use to block the user’s access and flag the user as deleted, without deleting the user. You may want to use this for users who are no longer in your company.
Deleting: Removes the user completely from the system.
The method used varies according to the Security requirements on managing users for your application.
Defining Permissions
The project Permissions are defined in the SecurityUsers table on Security → Permissions.
Pre-defined Security groups
The platform comes with a few predefined Permission groups that you can use, or you can create your own.
Security groups
Using Policies and e-sign
Defining Policies
The project Permissions are defined in the SecurityUsers table on Security → Policies.
Pre-defined Policies
The platform comes with a few predefined policies that you can use, or you can create your own.
Policies
Connecting Users with Permission Groups
At the Security → Users table, the column Permissions can be updated to include all Permission Groups authorized to each user. Select multiple rows, right-click to edit the combined rows, when applying same settings to more than one user.
RuntimeUsers
Content
AD/LDAP Integrations
Windows AD Integration
Instead of validating the Users again, the credentials in the Project configuration and the identification of the User connection can be automatically executed using our native Windows Active Directory integration. This functionality in only available for the Users connecting from Windows operating systems.
For more information, see → Read more about Windows AD / LDAP Server.
AD/LDAP Server Integration
When the integration with Windows AD integration is not available, it is still possible for an unavailable, automated identification can still be achieved using the a business server to define an -defined LDAP server to be used by the project.
For → Read more information, about Windows AD / LDAP Server.
Working with the Security
moduleModule
Customizing Login Procedures
Modify the login page, fine-tune user validation, and incorporate custom logic into the client startup ScriptTask process for a tailored login experience.
Further User management can also be execute on Scripts.
→ Read more on Scripts, Handling Security
Applying Security to Displays
Regulate user access and interactions within displays, either by protecting the entire display, or specific commands or elements within each display.
Display Edit or Run Security
The configuration table Displays → List, has the columns EditSecurity and RunSecurity that allow to define the PermissionGroups allowed to configure, or open in runtime, each displays.
Security within the Display
When drawing the solution User Interface, there is a Dynamic Property specifically to apply security to any Input the operator may do at the display.
→ Read more on Drawing User Interfaces / Dynamics and UI Elements, the Security Dynamic configuration.
Security Runtime Attributes
The Securitynamespace contains all runtime information regarding the security system.
Runtime Execution
Content
Monitoring Clients Connections
Content
Customizing Login Procedures
Content
Managing Users on Displays and Scripts
Content
Security module Attributes
The namespace Security has all the runtime information regarding the security system.
For general information on namespace and object concepts, go to the section Objects and Attributes.
The Clientobject has information about the current user logged at that client station
.
Examples | |
|---|---|
Client.Username | The property is the name of current logged user. |
Client.CurrentUser | |
References the data structure with all the information of the currently logged-in user. |
See Namespaces Reference for the complete list of properties and available methods.
Troubleshooting and best practices
By exploring the following sections, you will gain a deeper understanding of the Security module's capabilities and learn how to leverage its full potential to improve your industrial processes, increase efficiency, and drive sustainable growth.
Common issues and solutions
You'll be able to familiarize yourself with common problems that may arise when using the Security module and learn effective troubleshooting techniques to resolve these problems quickly and efficiently.
Diagnostics information about the Security module execution is located in the Security troubleshooting page.
Best practices and recommendations
Benefit from the knowledge of experts and experienced users by following our curated list of best practices and recommendations. These guidelines will help you ensure the successful implementation of the Security module and maximize its impact on your industrial operations.
Please take a look at Security's best practices and recommendations.
In this section...
| Page Tree | ||||
|---|---|---|---|---|
|
CONTEÚDO PARA USAR COMO BASE PARA A NOVA ORGANIZAÇÃO
NEW ORGANIZATION
About the Security Module
Key Concepts and Terminology
* Users
* Permissions
* Policies
* Runtime Users
How the Security Module Works
Features Highlights
Protecting Access to Project Configuration
Allowing Role Security for Operators Interfaces
Integrates with Active Directly, LDAP or other systems
FDA 21 CFR 11 Compliance
Configuring the Security Module
* Configuration Workflow
* Creating and Managing Users
** Pre-defined Users
** Runtime Users
* Defining Permissions and Policies
* Applying Security on Project Configuration
* Applying Security on Displays and User Interface
Working with the Report Module
* Runtime Execution
* Customizing Login Procedures
* Integration with Other Modules
Managing Users with Scripts
* Advanced Features and Options
Troubleshooting and Best Practices
* Common Issues and Solutions
* Best Practices and Recommendations
* Security Module Runtime Attributes
This page provides information about the Security module. Here you can learn about user authentication and access control features, including managing user accounts and assigning specific permissions to different users based on their responsibilities and job functions. Check how to ensure the protection and privacy of your system, prevent unauthorized access and data breaches, and maintain the highest security levels in your project. Consider this page an essential resource to help you extract the full potential of the Security module.
| Anchor | ||||
|---|---|---|---|---|
|
Best Practices and Recommendations:
- Regularly update your user list and their associated permissions to maintain security.
- Conduct periodic audits of user accounts and permissions, making necessary updates and removing inactive users.
- Enforce strong password policies to enhance security.
- Require complex passwords that include uppercase and lowercase letters, numbers, and special characters. Encourage regular password changes.
- Keep your system up-to-date with patches and updates.
- Regular updates often include security enhancements and fixes. Ensure your system is up-to-date to benefit from these improvements.
Troubleshooting and Common Issues:
- User Cannot Log In: Ensure the user is entering correct login credentials. Check if the user's account is active and not blocked or flagged as deleted. If the problem persists, contact your system administrator.
- Permission Denied Error: Check the user's assigned Permissions. Ensure they have the necessary access rights to perform the desired action. Update their Permissions or assign them to a different user group if necessary.
In this section:
| Page Tree | ||||
|---|---|---|---|---|
|
User Settings
The Named Users with authorization to access the Project are defined in the SecurityUsers table on Security → Users.
| Tip | ||
|---|---|---|
| ||
|
Pre-defined Users
The following user names are configured by default:
Pre-built Users
Administrator
| Warning |
|---|
You can not delete the Guest user, neither add a password to it. The Guest user must be available as the default user when you log off as another user. You may want to change the Guest user permissions, so that Guest users do not have access to any resource. |
| Warning |
|---|
| Do not create other Users with those names nor change the row ID of those users, as they are built-in platform objects. |
| Note |
|---|
| The Administrator is the only user who can delete or block users and the only user who can define passwords for Database DB interfaces. |
| Info |
|---|
Guest User is used for anonymous login and does not have password assigned to it. |
Permissions Settings
The project permissions are defined in the SecurityUsers table on Security → Permissions.
| Tip | ||
|---|---|---|
| ||
|
Pre-defined Security groups
The platform comes with a few predefined Permission groups that you can use, or you can create your own.
Security groups
Connecting Users with Permission Groups
At the Security → Users table, the column Permissions can be updated to include all Permission Groups authorized to each user. Select multiple rows, right-click to edit the combined rows, when applying same settings to more than one user.
Disabling Windows Applications Switch
When Task Switch is disabled, the following actions/keys will be inhibited for that User:
- Access to the Start button and the Task Toolbar
- Windows Logo button
- Ctrl + Alt + Del
- Ctrl + ESC
- Alt + Tab
- Alt + F4
- Windows Logo + L
| Info | ||
|---|---|---|
| ||
This configuration applies to RichClients and SmartClients. The file DisableTaskSwitchProtection.bat must be run from the installation directory in order to install the keyboard driver necessary to implement this feature. |
Policies Settings
You can configure settings that you can apply to users.
The platform comes with a few predefined policies that you can use, or you can create your own.
| Tip | ||
|---|---|---|
| ||
|
Applying Policies to Users
The policies you create are available to be used on SecurityUsers tables, at the column Policy