Versions Compared

Version Old Version 14 New Version Current
Changes made by

Fiona Sargeant

Zoe Baldwin

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Insert excerpt
_Banners
_Banners
nameadministration
nopaneltrue

This page is for PhixFlow administrators who need to set up user accounts in PhixFlow and for users who want to update their account, for example with a new password. It describes the user settings.  Insert excerpt_admin_user_topic_admin_user_topicnopaneltrue

Overview

There are several ways to set up user accounts for PhixFlow.

Local only

Active Directory

Single sign-on 

PhixFlow user - either a "local" user, that is, only defined in PhixFlow, and independent of any other part of your infrastructure; or an "AD" user - that is, a user created automatically in PhixFlow if you have set up integration with Microsoft Active Directory, and a user have logged into PhixFlow by this means.

Info

To edit a user account that is not your own, you must belong to a user group that in turn includes a role with privilege Administer Users, User Groups and Roles

Use the user settings tab to add . The user group inherits privileges from the roles listed in the settings tab; see User Group Roles and Privileges.

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 TypeAuthenticationAuthorisation
local userUser logs in with a username and password maintained in PhixFlow.Access is controlled by user groups assigned to the user in PhixFlow.
mixed userUser 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 userUser 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 

Insert excerpt
_user_details
_user_details
nopaneltrue
 window, available from the header bar
Insert excerpt
_user_options
_user_options
nopaneltrue
; 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. If you need to restrict user access to sub-sets of modelling objects, display components etc. you can add the objects to this settings tab.. For information about how users, user groups, roles and privileges work together, see:

Info

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 

Insert excerpt
_user_repo
_user_repo
nopaneltrue
  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

Insert excerpt
_standarduser_settingsrepo
_standarduser_settingsrepo
nopaneltrue

Panel
borderColor#7da054
titleColorwhite
titleBGColor#7da054
borderStylesolid
titleSections on this page

Table of Contents
indent12px
stylenone

Adding or Changing a User Account

 and select 
Insert excerpt
_new
_new
nopaneltrue
. PhixFlow opens a property tab where you can enter the details for the new user.

Insert excerpt
_property_toolbar
_property_toolbar
nopaneltrue

Insert excerpt
_property_tabs
_property_tabs
namebasic-h
nopaneltrue

Basic Settings

FieldDescription
Login Name
The login name that

Required. Enter a name with which the user will log into PhixFlow

with

. Whatever capitalisation you use, PhixFlow treats the name as all lowercase.

If

this user is going to run tasks that include database exports, if the Datasource has the option Use User credentials on export ticked, this username will be used to log onto the database to perform the export

creating a mixed user the login name must match the name used for the external login provider.

First Name
First Name
Required. Enter the first name of the user. For external users, the first name is supplied by the authentication provider.
Last Name
Last Name Language of the user. Select a language

Enter the last name of the user. For external users, the last name is supplied by the authentication provider.

Language
Locale

Required. Select the user's country from the drop-down list.

Insert excerpt
_system_config
_system_config
nopaneltrue
Domain
The

Enter the domain

that

with which the user logs in. For PhixFlow user accounts that are not integrated with

. This can be local, for users that exist independently in PhixFlow, or one of the configured active directory domains, if an integration with active directory has been set up. See Configure Active Directory Integration for details.OrganisationThe users Organisation. For local users this is free format text. For AD users this is the Organisation supplied by AD.Password

This is only visible for local users. You can set the user's password by updating this field.

If this user is going to run tasks that include database exports, if the Datasource has the option Use User credentials on export ticked, this password will be used to log onto the database to perform the export.

Confirm PasswordThis is only visible for local users. Confirmation of the Password entered above.Password Policy

This is only visible for local users. The Password Policy that the user's password will be checked against. The built in Password Policy is selected by default. The default system password policy can be changed in the System Configuration editor.

Administrators can select another option from the drop-down list. See the Password Policy Details form.

Default DashboardDefault dashboard of the user. Select a value from the drop-down list.Default ApplicationThe default application is the application that will be loaded when the user logs in if they haven't specified an application in the URL.Email AddressEmail Address of the user. For AD users this is the email address supplied by AD.Phone NumberPhone number of the user. For AD users this is the phone number supplied by AD.EnabledThis is only visible for local users. Disabled users can still receive

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 TypeRead-only. PhixFlow displays LOCAL, MIXED or EXTERNAL, depending on the configuration of the properties.
OrganisationEnter 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 
    Insert excerpt
    _user_details
    _user_details
    nopaneltrue
    ; 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:

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.

Insert excerpt
_check_box_tick
_check_box_tick
nopaneltrue
 to allow the user to log into PhixFlow. 

You can only enable a user if the Password has been set.

Insert excerpt
_check_box_untick
_check_box_untick
nopaneltrue
 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,

but they cannot log in to PhixFlow

tick this box.

Account Locked
This is only visible

Available for local users

. If ticked, the user's account is locked due to

only.

Insert excerpt
_check_box_tick
_check_box_tick
nopaneltrue
 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.

Send Alerts by SMSIf ticked, the user can receive SMS alerts, if configured n a PhixFlow process, to the phone number defined in their user details.Send Alerts by EmailIf ticked, the user can receive email alerts, if configured in a PhixFlow process, to the email address defined in their user details.Open in Design ModeIf ticked, the user's default mode is the Design Mode. Otherwise the default mode is App Mode.Last Activity TimeThe last time the user performed an action in PhixFlow.

User Groups

This section has a toolbar with standard buttons and  Insert excerpt_user_group_user_groupnopaneltrue.

Insert excerpt
_check_box_untick
_check_box_untick
nopaneltrue
 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.

 

Insert excerpt
_check_box_tick
_check_box_tick
nopaneltrue
 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.

Insert excerpt
_check_box_untick
_check_box_untick
nopaneltrue
 the user may perform a password reset.

Open in Design Mode

Insert excerpt
_check_box_tick
_check_box_tick
nopaneltrue
 to open PhixFlow in
Insert excerpt
_design_mode
_design_mode
nopaneltrue
 for this user.

Insert excerpt
_check_box_untick
_check_box_untick
nopaneltrue
 to open PhixFlow in the default 
Insert excerpt
_app_mode
_app_mode
nopaneltrue
.

Show the Help Tab on Startup

The Help tab provides a link to the PhixFlow Help and Training and Training Courses. 

Insert excerpt
_check_box_tick
_check_box_tick
nopaneltrue
 to open the Help tab on the right of the 
Insert excerpt
_design_mode
_design_mode
nopaneltrue
 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.

Insert excerpt
_check_box_untick
_check_box_untick
nopaneltrue
 to prevent the Help tab being opened at login.

Last Activity TimeRead-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:

  1. Click
    Insert excerpt
    _user_group
    _user_group
    nopaneltrue
     to list all the user groups in the repository.
  2. Drag user groups into this list
to add them
  1. . This automatically adds the user to the
role
  1. user group. 

To remove a user from a user group

from the role

, use the toolbar button 

Insert excerpt
_delete
_delete
nopaneltrue

 in the toolbar

.

For

Active Directory

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

for details

.

 Current Reset AttemptsPhixFlow shows the number of failed password-reset attempts.

Security Questions

This section is only available for local users. Enter up to 3 questions and answers. If a user needs to reset their password, PhixFlow asks one of the questions to verify the user's identity; see Password Reset.

FieldDescriptionQuestion 1The user's first security question.Answer 1The answer to the first security question.Question 2The user's second security question.Answer 2The answer to the second security question.Question 3The user's third security question.Answer 3The answer to the third security question.Last requested reset timePhixFlow shows the (read-only) date/time of the last password reset link.

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.

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

Excerpt
nameExportPasswordPolicy


Note

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.

Insert excerpt
_check_box_tick
_check_box_tick
nopaneltrue
 indicates you have set a password for the user, even if the password field is left empty.

Insert excerpt
_check_box_untick
_check_box_untick
nopaneltrue
 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. 

Insert excerpt
_check_password
_check_password
nopaneltrue
.

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.

Note

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.


Insert excerpt
_more_options
_more_options
nopaneltrue

FieldDescription
CloseCloses the user tab.
Generate API KeyGenerates an API Key to be used in API Authentication, see API Authentication and Secret Keys.
Send Password ResetSends a password reset email to the user.
BackGoes back.
ForwardGoes forward.
Find in RepositoryFinds the user in the Repository.
Hide AllCollapses all sections on the user tab.
Permanently DeleteDeletes the user.


Insert excerpt
_audit
_audit
nopaneltrue

Live Search
spaceKey@self
additionalnone
placeholderSearch all help pages
typepage

Panel
borderColor#00374F
titleColorwhite
titleBGColor#00374F
borderStylesolid
titleSections on this page

Table of Contents
maxLevel3
indent12px
stylenone