This page is for PhixFlow administrators who need to set up user accounts in PhixFlow. It describes the user settings.

Overview

Each user who needs to log into PhixFlow must have a user account set up. In addition, user accounts are added to user groups to control their access to features, items and data in PhixFlow.

Administrators use the user properties to configure the user accounts. Users can manage their own password in the User Details window.

Types of PhixFlow User

There are three types of users, depending on whether you manage the user authentication and authorisation:

entirely in PhixFlow - local user
partly with an external login system - mixed user
entirely with an external login system - external user.

User Type	Authentication	Authorisation
local user	User logs in with a username and password maintained in PhixFlow.	Access is controlled by user groups assigned to the user in PhixFlow.
mixed user	User logs in using integration with AD/ AAD via SAML.	Authentication is provided by AD/ AAD; authorisation is provided by PhixFlow. In this case, you must create accounts with the same username in PhixFlow. However, you do not need to set any password.
external user	User logs in with integration with AD/ AAD via SAML or integration with AD via LDAP.	Access is controlled by external user groups mapped to PhixFlow user groups on login.

For more information, see:

Users can view and change their own user account details from the User Details window, available from the header bar User Options; see User Details.

You can add individual users to user groups. Members of a user group have the privileges of their roles. The privileges provide members of a user group with access to PhixFlow features, modelling objects, display components, actions and applications. For information about how users, user groups, roles and privileges work together, see:

To edit a user account, you must belong to a user group that has a role with the privilege Administer Users, User Groups and Roles. See Roles.

Adding or Changing a User Account

To create or change a user account, in the repository scroll down to the Users section.

To change an existing user account, double-click on the name to open its property tab.

To add a new user account, right-click Users and select Create New. PhixFlow opens a property tab where you can enter the details for the new user.

Property Pane Toolbar

For information about the toolbar options, see the Common Properties page, Toolbars and Controls section.

Properties Tab

Basic Settings

Field	Description
Login Name	Required. Enter a name with which the user will log into PhixFlow. Whatever capitalisation you use, PhixFlow treats the name as all lowercase. If creating a mixed user the login name must match the name used for the external login provider.
First Name	Required. Enter the first name of the user. For external users, the first name is supplied by the authentication provider.
Last Name	Enter the last name of the user. For external users, the last name is supplied by the authentication provider.
Locale	Required. Select the user's country from the drop-down list. Configuration
Domain	Enter the domain with which the user logs in. For PhixFlow user accounts that are not integrated with other user management systems, enter `local`. The drop-down list displays all external login domains for authentication only. These are configured in phixflow-login.xml. The domain set here also affects the user list in the repository as follows: PhixFlow lists users grouped by domain. Changing the domain here also changes where the user is listed in the repository. Dragging a user to a different domain in the repository also changes the domain set in this property.
User Type	Read-only. PhixFlow displays LOCAL, MIXED or EXTERNAL, depending on the configuration of the properties.
Organisation	Enter your organisation name. For external users, the organisation name is supplied by the authentication provider.
Password	Available for local users only. Enter the user's password. Users can change their password: in their User Details; see User Details here, if they have the privilege Administer Users, User Groups and Roles.
Password Policy	Required. Available for local users only. Keep the default password policy, or select an alternative. PhixFlow checks that the password meets the requirements configured in the password policy. The default password policy is configured for the PhixFlow instance in System Configuration.
Email Address	Enter an email address for the user. PhixFlow uses this address to send notification emails. These are configured in the Send by Email sections of: Task Plans File Exporter These link to User Notification Rule. For external users, the email address is supplied by the authentication provider.
Phone Number	Enter a phone number of the user. For external users, the phone number is supplied by the authentication provider.
Enabled	Available for local and mixed users only. Tick to allow the user to log into PhixFlow. You can only enable a user if the Password has been set. Untick to disable a user account, so that the user cannot log into PhixFlow. When you disable a user account, PhixFlow does not check the account details, such as password. If a user account is only needed to receive emails sent by PhixFlow task plans or file exporters, tick this box.
Account Locked	Available for local users only. Tick indicates there have been too many login failures and PhixFlow has locked the account to prevent unauthorised access. Untick the check box to unlock the account. The permitted number of login failures is configured in the Password Policy. Untick the account is unlocked and the user can log in.
Password Reset Locked	Available for local users with a password policy that permits password reset. Tick indicates PhixFlow has disabled password reset for this user. Untick the check box to allow password reset. The permitted number of reset attempts is configured in the Password Policy. Untick the user may perform a password reset.
Open in Design Mode	Tick to open PhixFlow in Design Mode for this user. Untick to open PhixFlow in the default Application Mode.
Show the Help Tab on Startup	The Help tab provides a link to the PhixFlow Help and Training and Training Courses. Tick to open the Help tab on the right of the Design Mode view when the user logs in. The user can: either click X on the Help tab to close it during their session or untick this box via their User Details, to prevent the Help tab from being displayed. Untick to prevent the Help tab being opened at login.
Last Activity Time	Read-only. PhixFlow displays the most recent time that the user was active in PhixFlow.

User Groups

The grid contains a list of user groups to which this user belongs. To add a user group to the list:

Click User Groups to list all the user groups in the repository.
Drag user groups into this list. This automatically adds the user to the user group.

To remove a user from a user group, use the toolbar button Delete.

For external users, the list of user groups shown for the user is read-only. The user groups are the PhixFlow equivalents that map to the Active Directory user groups; see Configure AAD Integration via SAML and Configure Active Directory Integration.

Config Export Settings

This section relates to exported configurations. These are applications, packages or selected objects saved as zip files. You can move exported configurations between PhixFlow instances.

To ensure data security, PhixFlow can encrypt the files. PhixFlow saves the files in the download area for a limited time period; see Configuring the Download Area.

Use the following fields to set a default password for exported configurations.

Field	Description
Export Password Policy	By default, PhixFlow applies the Password Policy set in System Configuration → Advanced → Export Password Policy. Optionally, select a different password policy to apply different rules about the export password for this user. Users require an Export Password Policy to be able to download exports. For external users, this is set by the External User Template when the user is created. If this is not set, the user will not have an Export Password Policy and will not be able to download exports.
Set Default Export Password	For user accounts with an empty Export Password, use this tick box to distinguish between passwords set as blank, or passwords not yet set. Tick indicates you have set a password for the user, even if the password field is left empty. Untick indicates you have not set a password for the user.
Default Export Password	Available when Set Default Export Password is ticked. Enter a password with at least 6 characters. Click Show/Hide Password to switch between displaying the password as text or dots.. When the user downloads an exported configuration, the zip file is encrypted and this password is associated with it. The user can enter a different password. If you set a default password, you must tell the user what it is. The user must supply the same password when they import the configuration to another PhixFlow instance; see Using the Download Area.

More Options

Field	Description
Close	Closes the user tab.
Generate API Key	Generates an API Key to be used in API Authentication, see API Authentication and Secret Keys.
Send Password Reset	Sends a password reset email to the user.
Back	Goes back.
Forward	Goes forward.
Find in Repository	Finds the user in the Repository.
Hide All	Collapses all sections on the user tab.
Permanently Delete	Deletes the user.

Audit Tab

Audit Summary

See the Common Properties page, Audit Summary section.

Sections on this page

Browser not supported