Versions Compared

Old Version 62

changes.mady.by.user Fiona Sargeant (Unlicensed)

Saved on

compared with

New Version Current

changes.mady.by.user 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. It describes the user settings.  Insert excerpt_admin_user_topic_admin_user_topicnopaneltrue

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 and security questions (version 10.0 and earlier) in the User Details window.

Types of PhixFlow User

There are three types of userusers, 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.
PanelborderColor#7da054titleColorwhitetitleBGColor#7da054

Table of Contents
indent12px
stylenone

borderStylesolidtitleSections on this page
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
Active Directory
AD/ AAD via SAML
Access is controlled by user groups assigned to the user in PhixFlow
.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
Active Directory/SAML
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
TipIf you use an external login system (Active Directory/SAML), you must create accounts with the same username in PhixFlow
.
However, you do not need to set any password.

For more information, see:

Integration

Users can view and change their own user account details from the 

Insert excerpt
_user_details
_user_details
nopaneltrue
 window, available from the

task bar at the bottom of the PhixFlow window

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
Info

To edit a user account, you must belong to a user group that has

a role

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.

User Properties

Insert excerpt
_

standard

property_

settings

toolbar
_

standard

property_

settings

toolbar
nopaneltrue

Info

Some 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 logs into the database using the user's:

  • the Basic Settings → Login Name
    • and Basic Settings → Password.

    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

    lower-caseSystem configuration

    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.

    Insert excerpt
    System configuration
    _system_config
    _system_config
    nopaneltrue
    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 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.

    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. PhixFlow uses this address to send notification emails. These are configured in the Send by Email sections of:

    These link to User Notification Rules.

    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_

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

    or security questions

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

    Insert excerpt
    _check_box_

    ticked

    tick
    _check_box_

    ticked

    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.

    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_

    ticked

    tick
    _check_box_

    ticked

    tick
    nopaneltrue
     indicates

    there have been too many failed attempts to answer the security questions and

    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_

    ticked

    tick
    _check_box_

    ticked

    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 pages and Training Courses. 

    Insert excerpt
    _check_box_

    ticked

    tick
    _check_box_

    ticked

    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

    This section has a toolbar with standard buttons and 

    Insert excerpt
    _user_group
    _user_group
    nopaneltrue
    .

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

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

    Insert excerpt
    _delete
    _delete
    nopaneltrue
    .

    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 Active Directory Integration via LDAP for details. 

    Security Questions

    This section is only applicable to PhixFlow version 10.0 and earlier.

    This section is only available for local users. Enter 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 Changing or Resetting Your Password

    Reset

    .

    FieldDescription
    Question 1

    To configure security questions and answers:

    • Either enter the security question-answer pairs for the user
    • Or leave these fields blank and ask the user to set their own via their User Details. These property fields will be automatically updated.

    Answers are encrypted. They are displayed in these fields as dots.

    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.


    Answer 1
    Question 2
    Answer 2
    Question 3
    Answer 3
    Last requested reset time

    PhixFlow displays the date/time of the last password reset.

    If you change the account configuration so that a local user is converted to a mixed or external user, PhixFlow automatically clears the security questions and answers, as they are no longer required.

    Tip

    You can save the user properties with

    none

    no or incomplete security questions and answers.

    PhixFlow recommends that users set all three security questions and answers in the User Details window.

    Config Export

    Password

    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.

    Export Password Not Set

    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

    . 

    , 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

    , even if the password field is left empty.

    . 

    Default Export Password
    This field is available when 

    Available when Set Default Export Password

    Not Set is not

     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
    _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