Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Insert excerpt
_Banners
_Banners
nameadministrationSystemAdmin
nopaneltrue

This page is for PhixFlow administrators. It summarises the configuration and monitoring tasks you need to do, with links to more details.

Table of Contents
maxLevel3
indent12px
excludeLearn More
stylenone

Minimum Set-up After Installation

If you have installed PhixFlow for the first time, you

may want

need to do the minimum set-up so that you can start creating

models and basic

applications.

  1. Login as the startup user.
  2. Add your licence key

to System Configuration → Advanced →  Licence Key
  1. Expand
    titleHow?
    1. Click 
      Insert excerpt
      _administration
      _administration
      nopaneltrue
      → System → Configuration
    2. In the Advanced section enter your Licence Key
    3. Save your changes


  2. Create a user with Administrator privileges.

    Expand
    titleHow?
    • In the Full Repository →  Role, create a new role called “Administrator”.  
    • In the role properties → Privileges section, open the list of privileges and drag them all into the role.
    • In Full Repository →  User Group, create a new group called “Administrators”.
    • In the user group properties → Roles section, open the list of privileges and drag in the “Administrator” role.
    • In Full Repository →  User, create a new user for yourself.
    • In the user properties → User Groups section, open the list of user groups and drag in the “Administrators” user group.


  3. Check your new user account works.
    • Logout
    • Login using your new user account
  4. Once your account works, delete the startup user.
  5. Set up the essential file locations
in System Configuration →  System
  1. in 
    Insert excerpt
    _administration
    _administration
    nopaneltrue
    → System → Configuration
    System Directories:
    • Restricted Directory: this is optional, but is an important security setting. Leaving it empty effectively allows users to scan the server file system with File Collectors. Although it only allows users to see files that Tomcat has permission to access, this can include files which most users should not be able to see. Typically this is set to the root of the file system you set up for PhixFlow data files. E.g. /opt/phixflow/data.

      Note

      When you set a Restricted Directory, all other system directories, except the Database Driver File Directory, must be sub-directories of the restricted directory.

      Example:

      Code Block
      update system_configuration set restricted_dir = '/opt/phixflow/data';
      commit;


    • Temporary File Location: e.g. /opt/phixflow/data/temp – needed for exporting and importing applications and models between PhixFlow instances.

    • File Upload Directory: e.g. /opt/phixflow/data/upload –  needed for uploaded files ( via file collectors)
    • Download Location: required to export data; see Configuring the Download Area.

Full System Configuration

For a full system with multiple users, you need to configure:

We recommend that you:

You can optionally configure:

Monitoring and Maintenance

To monitor and maintain PhixFlow, you need to:

  • Set up scheduled maintenance using task plans that include system and archive tasks; see Using Tasks and Task Plans

    Tip

    Use task plans to schedule tasks that maintain the PhixFlow system. The system task includes processes that clear the data from incomplete recordsets.

    If incomplete recordsets accumulate, this can slow down PhixFlow's performance. Depending on your PhixFlow database, queries that have to exempt many incomplete recordsets can reach system limits. This can prevent PhixFlow and its applications from running. Therefore, we recommend that you add a system task to a task plan that is scheduled to run daily or weekly.


  • Configure a stand-by webapp to shadow the active webapp. The standby webapp will automatically take over in the event that the active server fails. See Configuring for Resilience.
  • Monitor PhixFlow processes, tasks and user activity; see System Monitoring and System Console.
  • Prepare server machines for installing or upgrading to a new version of PhixFlow; see the Installation and Upgrade pages: 

If you have several PhixFlow instances, for example a development instance and production instance, you may also need to move packages, applications, models and tables between PhixFlow instances; see Administration Menu and Moving Items and Data Between Instances.

Other useful information is available in:

PhixFlow Database Considerations

When users or automated process change the data in the PhixFlow client, the data changes are automatically published to the PhixFlow database.

Insert excerpt
_publishing_space
_publishing_space
nopanel

true

Learn More

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

Table of Contents
maxLevel3
indent12px
stylenone

Pages in the Administration Topic

Child pages (Children Display)
alltrue

Pages in the User Administration Topic

children

all

true

pageUser Administration