Versions Compared

Key

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

Introduction

PhixFlow provides a number of standard template formats, components and styles for use when building new applications.

Each time you import the formats or other templates the system will create new copies of the imported objects, which you can then modify and/or customise.

Once you have used the template formats / components, regardless of whether you have customised them or not, you should consider them to be part of the application(s) that  you have configured, and if you have more than  one PhixFlow instance you should use Export / Import to move the template formats / components package along with your application(s) from instance to instance.

Should I Import the Formats files or the Templates File?

You should import the formats and template files into your new PhixFlow instance if

  • this is your first or only PhixFlow instance, or
  • you expressly want to create new copies of the formats or components

Don't worry if you are unsure about this - you can return to this step at  any time.

How to Import the Formats or Templates file

This assumes that you have completed the installation to the point where you can login as an Administrator.

To import the templates file:

  1. Copy the templates file from the installation package (normally on the Tomcat server) to somewhere directly visible to the client browser
    1. The templates file is called $release/install/templates/phixflow_templates.xml
    2. Copy this file to somewhere local e.g. (on Windows) Downloads
  2. Login as an Administrator
  3. Configure the System Configuration Temporary Directory
  4. Click on Administration Menu / Import Configuration
    1. Choose the local copy of phixflow_templates
    2. Click Open
    3. Click OK
  5. Check that the Package PhixFlow Templates has been created

...

Insert excerpt
_Banners
_Banners
namescreen
nopaneltrue

Overview

You can add your own components to the palettes provided by Phixflow. Alternatively, you can keep your custom components on your own palettes; see Changing or Creating a Palette.

If you have a specific component that you want to reuse on multiple screens:

  1. Convert it to a template component, described below.
  2. Add it to a new or existing palette.

Making a Template

  1. On a screen canvas, add components from a palette and change their properties to create the layout and design you want.
  2. Set all the style options you require. We recommend that you use shared styles when designing a layout that you want to add to a palette.
  3. Right-click the outermost component for the layout and select 
    Insert excerpt
    _repository_find
    _repository_find
    nopaneltrue
    .
  4. In the repository, right-click the component name.
  5. From the popup menu, select Copy as a Template.
  6. PhixFlow opens a new property pane. This is a copy of the original component, with the Advanced → Template property ticked. It is saved in the Template section of the repository. 
  7. Edit the name to reflect that this component is now a template.

Adding a Template Component to a Palette

  1. In the repository, find a palette and open its properties.
  2. Drag the palette properties tab into the workspace.
    PhixFlow creates a second panel so that the palette properties are displayed next to the repository.
  3. Expand the repository → Templates section.
  4. Drag template components into:
    • Either the palette properties → Components section
    • Or the palette properties → Palette Groups → open group properties → Components section.

The template now appears in the palette as a reusable component that you can drag onto the screen canvas.

Managing Palettes and Template Components

To successfully move a palette to a different PhixFlow instance, you must include all its templates and styles in the export. Consider adding your styles, templates and associated palette to a package, to ensure they are all included; see Package for how to add items to a package.

To export your application, click the Administration menu → 

Insert excerpt
_export
_export
nopaneltrue
 → 
Insert excerpt
_export_config
_export_config
nopaneltrue
; see Export Configuration and Import Configuration.