Versions Compared

Version Old Version 35 New Version Current
Changes made by

Fiona Sargeant (Unlicensed)

Zoe Baldwin

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Insert excerpt
_Banners
_Banners
nameadministration
nopaneltrue
To edit a user account, you must belong to a user group that in turn includes a role with privilege Administer Users, User Groups and Roles

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

Overview

Each user who needs to log into PhixFlow needs to must have a user account set up. User accounts that only exist in PhixFlow are known as local users. You can integrate PhixFlow with other user management systems. 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
 icon window, available at the bottom right of a PhixFlow window; see User Details.

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

Table of Contents
indent12px
stylenone

Info

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. For information about how users, user groups, roles and privileges work together, see:

the
List_standard_settings_standard_settingsnopaneltrue
Insert excerpt
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
_user_repo
_user_repo
nopaneltrue
 and select 
Insert excerpt
_

add

new
_

add

new
nopaneltrue
. PhixFlow opens a property tab where you can enter the details for the new user.

Basic Settings

InfoSome users need to run analysis on models that include database export. When the datasource has the option Use User credentials on export ticked, PhixFlow automatically uses the Login Name and Password to log into the database.

Insert excerpt
_property_toolbar
_property_toolbar
nopaneltrue

Insert excerpt
_property_tabs
_property_tabs
namebasic-h
nopaneltrue

Basic Settings

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

Note

The list of locales available in PhixFlow is a standard list. The presence of a specific locale does not indicate that translations are available for the locale.

The locale sets the default date style. It can also change the language of an application if it has a translation table; see Translating an Application Interface.

Insert excerpt
_system_config
_system_config
nopaneltrue
Domain

Enter the domain

that

with which the user logs in

with

. For PhixFlow user accounts that are not integrated with other user management systems, enter local.

For users configured via active directory, enter an active directory domain

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
configured via active directory
,
this is
the organisation name is supplied by
active directory
the authentication provider.
Password

Available for local users only. Enter

a password for the user

the user's password

by updating this field

.

Users can change their password

here if they have the privilege Administer Users, User Groups and Roles. Alternatively, they can change their password from the  Insert excerpt_user_usernopaneltrue menu → 

:

  • in their 
    Insert excerpt
    _user_details
    _user_details
    nopaneltrue
 →
tab.Confirm PasswordAvailable for local users only. Re-enter the password to confirm it.
  • here, if they have the privilege Administer Users, User Groups and Roles. 
Password Policy

Required. Available for local users only

. PhixFlow

. 

Keep the default password policy, or select an alternative. PhixFlow checks that the password meets the requirements configured in

the password

the password policy.

By default, PhixFlow shows the

 The default  password policy is configured for the

whole system; see Default DashboardSelect a dashboard that PhixFlow will display when the user logs in.Default ApplicationSelect an application that PhixFlow will load when the user logs in. Users can override the default by specifying an alternative application in the URL that they use to access PhixFlow.Email Address

Enter an email address for the user.

For users configured via active directory, enter an active directory email. 

PhixFlow instance in System Configuration.

If you want this user's password to use different rules that have been defined in a policy, select the policy from the drop-down list.

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

configured via active directory, enter an active directory phone number

, the phone number is supplied by the authentication provider.

Enabled

Available for local and mixed users only.

Insert excerpt
_check_box_

ticked

tick
_check_box_

ticked

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

 for user accounts that you set up

 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

. User accounts with Enabled unticked do not permit the user to log into PhixFlow.

, tick this box.

Account Locked

Available for local users only.

Insert excerpt
_check_box_

ticked

tick
_check_box_

ticked

tick
nopaneltrue

 the account is unlocked and the user can log in. Insert excerpt_check_box_untick_check_box_unticknopaneltrueSend Alerts by SMS

PhixFlow models or applications may be configured to send SMS messages to users.

 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.

Password Policy.

Insert excerpt
_check_box_

ticked

untick
_check_box_

ticked

untick
nopaneltrue

 to allow PhixFlow to send SMS alerts to this user's Phone Number.

 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_

untick

tick
_check_box_

untick

tick
nopaneltrue

 to prevent PhixFlow from sending SMS alerts to this user.Send Alerts by EmailPhixFlow models or applications may be configured to send emails to users

 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_

ticked

untick
_check_box_

ticked

untick
nopaneltrue

 to allow PhixFlow to send emails to this user's Phone Number.

 the user may perform a password reset.

Open in Design Mode

Insert excerpt
_check_box_

untick

tick
_check_box_

untick

tick
nopaneltrue
 to

prevent PhixFlow from sending emails to this user.Open in Design ModeIf ticked, the user's default mode is the Design Mode. Otherwise the default mode is App Mode

open PhixFlow in

Insert excerpt
_design_mode
_design_mode
nopaneltrue
 for this user.

Insert excerpt
_check_box_

ticked

untick
_check_box_

ticked

untick
nopaneltrue
 to open PhixFlow in the default 
Insert excerpt
_

design

app_mode
_

design

app_mode
nopaneltrue

 for this user.

.

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_

untick

tick
_check_box_

untick

tick
nopaneltrue
 to open

PhixFlow in the default 

the Help tab on the right of the 

Insert excerpt
_

app

design_mode
_

app

design_mode
nopaneltrue

.Last Activity TimePhixFlow display the most recent time that the user performed an action in PhixFlow.

User Groups

This section has a toolbar with standard buttons and 

 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
_

user

check_box_

group

untick
_

user

check_box_

group

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 to the role
  1. . This automatically adds the user to the 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

.

 

Security Questions

Config Export Settings

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.Current Reset Attempts

PhixFlow shows the number of failed password-reset attempts.

Tip

You can save the user properties without specifying any of the security questions and answers. However, once you have added a question and answer for one, you must complete them all before saving the user properties.

Export Password

This section relates to export zips that you use to move applications, packages and stream data between

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

data in configuration export zip

files. PhixFlow saves the files in the download area for a

configured

limited time period

. You can set the:
  • download area in System Configuration →System Directories → File Download Location
    • how long files are available in System Configuration →General Settings → File Download Expiry. By default files are available for 24 hours.

    ; see Configuring the Download Area.

    Use the following fields to set a default password for

    configuration export password for the user. 
    Note

    If you set a default password, you must tell the user what it is.

    When the user starts a process that generates a file, PhixFlow prompts them for a password. The default password that you set here is autofilled in the prompt, but is displayed as a line of dots.

    The user must provide the password used to create the zip file when they: 

    exported configurations.

    FieldDescription
    Export Password Policy

    By default, PhixFlow applies the Password Policy set in System Configuration

    → For export zip files that PhixFlow generates:

     → Advanced → Export Password Policy. Optionally, select a different password policy to apply different rules about the export password for this user.

    Export Password Not Set
    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_

    ticked

    tick
    _check_box_

    ticked

    tick
    nopaneltrue
     indicates you have

    not

    set a password for the user

    . In this case

    , even if the

    export zip is not encrypted

    password field is left empty.

    Insert excerpt
    _check_box_untick
    _check_box_untick
    nopaneltrue
     indicates you have not set a password for the user.

    The password policy may allow users to open encrypted files without having a password. In this case, untick this option, but leave the Export Password field blank.

    Export PasswordThis field is available when Export Password Not Set is not

     

    Default Export Password

    Available when Set Default Export Password is ticked.

    Enter a password with at least 6 characters.

    Click 

     

    Insert excerpt
    _check_password
    _

    view

    check_password

    _view

    nopaneltrue

     to switch between displaying the password as text or dots

    .

    The user to open encrypted files exported to the download area.

    When the user

    generates

    downloads an

    export,

    exported configuration, the zip file is encrypted and this password is

    supplied by default

    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