Implementing the User Groupware in your application

1. On the "Project" tab, in the "Project" group, click "User Groupware".
2. In the description window of the current project configuration, in the "User Groupware: Disabled" area, click "Change".
3. In the window that appears, enable the User Groupware. You can configure the User Groupware for your application or site in the different tabs of this window. This configuration is presented in the following paragraphs.
4. Validate. The User Groupware is integrated into your project.
5. An administrator account will be created during the first execution of application or site under the "supervisor" name. Then, the corresponding password can be specified.

• Type of groupware,
• Start mode
• User account.

Type of groupware

• Standard User Groupware: The User Groupware will be associated only to your application or website, and the rights will be defined from the application or website.
  If this option is selected, two specific tabs are displayed:
  • the "Data files" tab, which allows you to specify the type of database and authentication used.
  • the "OAuth" tab, which allows you to specify the connection services available to users.
• User Groupware with authentication server: This option allows you to integrate a User Groupware and manage rights via a server.
  If this option is selected, two specific tabs are displayed:
  • the "Server" tab, which allows you to specify the characteristics of the authentication server, the user accounts and the URLs of the administration sites.
  • the "Email" tab, which allows you to customize the messages to be sent to users (registration validation or password reset emails).

• If you are using a PCSCloud platform, the required elements are installed by default on your platform.
  Reminder: PCSCloud is a paid, turnkey solution. For more details, see PCSCloud.
• If you are not using a PCSCloud platform, you will need to install the following elements:
  • an HFSQL server,
  • the reserved server, including the modules of the User Groupware for mobile applications.
  For more details, see Installing BaaS solutions.

Start mode

• The "Automatic start" option indicates that the User Groupware is started at the same time as the application or site.
  The login window or page of the User Groupware is displayed before any other window/page of the application. The project initialization code is run when the login window/page is opened and validated.
• The "Manual start (programmatically)" option allows you to define when the User Groupware should be started.
  The login window or page will only be opened if gpwOpen (or gpwLogin) is used. This option is used to run the project initialization code before opening the login window/page. This option is useful for a multilingual application. A window or a page can be displayed to prompt the user to choose the application language.
• The "Manual start via a control template" option is used to integrate the User Groupware login page in the site. This allows you to work with the automatic User Groupware (and to benefit from its updates) while being able to customize the login page.
  If this option is selected, the WDGPU_WB_CNX internal component is added to your project. This component includes the "TPLC_GPU_Connection" control template that manages the connection. To add this control template, simply drag and drop it onto the desired pages (or templates).
  Once it has been added, you can customize it:
  • by overloading the controls and/or the processes for small changes,
  • by directly modifying the control template for more important changes.

Groupware customization

• No customization:
  WINDEV and WEBDEV take care of everything. All you have to do is start the application or the site to configure the user access.
  The windows of the User Groupware can automatically use the skin template of the application. Simply check “Apply project skin template to non-customized windows at runtime”.
  To get the same appearance for all the windows of the application, it is recommended to always check this option if you use the User Groupware in non-custom mode.
  Note: This option is compatible with the integrated User Groupware ("Manual start via a control template" option).
• Customize login UI:
  The login/register window or page is automatically integrated into your application.
  • The internal component named WDGPU is included in your project. This component contains the login window and the associated procedure. You can customize the connection to the User Groupware.
  • The WDGPU_WB internal component is added to the project. This component contains all the pages, page templates, control templates and procedures necessary for user authentication. This allows you to fully customize all the login pages used by the User Groupware.
• Full customization (expert mode) - Standard User Groupware only:
  The programming of the User Groupware is automatically included in your application.
  • The internal component named WDGPU is included in your project. This component contains an analysis as well as all the windows, queries, classes and procedures required to manage the User Groupware. This allows you to customize all the windows used by the User Groupware.
  • The WDGPU_WB internal component is added to the project. This component contains an analysis as well as all the pages, queries, classes and procedures required to manage the User Groupware. This allows you to customize all the pages used by the User Groupware.

Security

• Allow opening windows and reports by default: This option allows all users to open windows and reports by default. In this case, simply specify which elements will not be accessible when configuring the rights.
• Allow editing reports and queries in Reports and Queries: If this option is checked, the application will use Reports and Queries for all the reports and queries.
  Note: This option is equivalent to "Enable 'Reports and Queries'", in the "Advanced" tab of the project description.

Automatic login in test mode

Data file language

Data file password

• The new password is taken into account only if it is changed before the User Groupware data files are created.
• This password is used to reindex or open data files with WDMAP.

Type of database ("Automatic start" mode only)

• in HFSQL Classic format (by default). The data file directory must be specified.
• in HFSQL Client/Server format. The characteristics of the connection to the HFSQL server must be specified as well as the directory of the different categories of files.

Type of authentication

• Authentication entirely managed by the User Groupware.
• Authentication from an LDAP directory or Active Directory.
  This option avoids duplicating usernames and passwords by using the users from the LDAP directory. In this case, the connection characteristics must be specified (see below).
• Use of Windows authentication.
  This option requires you to create the users in the User Groupware database. Only the supervisor (supervisor password) is created by default. During the first execution, you must:
  • log in as supervisor.
  • create users that exist in Windows.
    Note: There is no need to specify a password for these users. Their Windows password will be verified for their authentication.

• Server address
• Server port number.
• Version of the contacted LDAP server.
• Database

• The User Groupware works with Active Directory. It does not work with openLDAP.
• When the server port corresponds to port 636, the connection is automatically made in "Negociate" mode.

Options

• Login window only (no management of rights): This option is only available for LDAP and Windows authentication.
  In this case, no groupware file will be created. If the application is started in automatic mode, the user will need to log in. If the user is registered in the LDAP directory or in Windows, the application will start; otherwise, it will close. A supervisor cannot configure the rights on windows or pages. If this option is not checked, authentication will take into account user rights. Only users listed in the LDAP directory will be able to log in. Rights can be configured on windows or pages.
• Single sign-on (SSO): This option allows users to sign in once (to the first application run). Other applications using the User Groupware will not require an additional login process. If Windows authentication is used with this option, users will log in automatically. In this case, to configure the Groupware, the Windows session must have been started a supervisor account.

• In "GPU application server (web service and administration site)", specify the server to use. In the case of a new server, select the type of server:
  • PCSCloud platform. In this case, specify the characteristics of your PCSCloud platform.
    Reminder: This option allows you to use a web server, a dedicated server and an HFSQL Client/Server engine already installed and configured.
  • Network or Internet server with the protocol used. Enter the server name, user and password. This information was provided to you during the setup of the server reserved for the User Groupware/Private Store.
  • Specify the type of user accounts managed:
    • Accounts shared between applications: This option allows you to deploy the application with other applications that will be accessible to the same users. This option is recommended for deployments in different companies.
    • Application-specific accounts: This option stores the application with its user database.
      This option is recommended for deploying applications on a store.
  • The administration site URLs are automatically filled in with the information previously specified.
    Note: The specified URLs will only work once the changes in the User Groupware settings window have been confirmed. Upon validation, the modules installed with the reserved application server are automatically configured.

• Registration validation: If necessary, customize the messages sent to newly registered users.
• Forgot password: If necessary, customize the messages sent to users who forget their password.