Cp card macro | ||
---|---|---|
|
This page is for application designers who want to create new application project.
Live Search | ||||||||
---|---|---|---|---|---|---|---|---|
|
Panel | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
|
Iframe | ||||||
---|---|---|---|---|---|---|
|
Are we calling it application properties or settings? Properties. In this case you are using a pop-up window to set specific properties, but it would be good to keep this consistent. Also, the devs have used lots of different terms in the GUI where clicking an option opens its properties (e.g. Show stream configuration or Show dashboard details). The options should be simplified and made consistent: "Properties" or "Open properties"
We need to add this to the terminology document and also let me know so I can update the flow. We call it settings later on. It was already in.
Overview
There are several things that happen when you create an application.
- PhixFlow creates all the folders in the repository that your project will need.
- The template that you select is added to your application's Packages folder.
The template includes the palettes that will give your application a consistent design. - The template sets default properties for your application:
- formats for dates and numbers
- the palette and components to use for forms, data fields and cards
- the styles for data grids
- the default action - todo-fiona link
- user groups and access permissions - todo-fiona check this is happening
You can change all the properties later; see Application properties.
See also
Creating a New Application
To create a new application:
either in the repository → Applications section, clickInsert excerpt | ||||||||
---|---|---|---|---|---|---|---|---|
|
Overview
Applications contain everything necessary for it to function, from its data and access permissions, to links with associated packages. Each application has a unique URL and associated styling.
Open an Application
To open an existing application
- Double-click on the application's name from the application list that opens with PhixFlow.
- If the application list is not displayed, in the top left of the PhixFlow, click
Every application has a URL which allows you to access it directly.
- To obtain the URL for the application, the most reliable method is to open the application and copy the value from the address bar:
Expand | ||
---|---|---|
| ||
The URL is made up of:
Server address: Application Name: Menu Name:
|
Creating a New Application
- Click
Add New from the PhixFlow Landing Screen.Insert excerpt _addIcon _addIcon nopanel true - If this is not open, click the
Insert excerpt _app_menu _app_menu nopanel true
- If this is not open, click the
Click the last card, which is the New Application card:
- .
2. PhixFlow opens the Create Application
wizard.
3. Set the following properties for your application:
Name: enter a name.
Version (Optional): enter a
version number
if applicable.
Description (Optional): we recommend entering a useful description of the application
, potentially the data owner and app creators.
Template:
Application Icon: This is the image PhixFlow displays in the card on the application menu. If you do not select an icon, PhixFlow uses a default image.
Either use the drop-down to select an icon that has already been loaded into PhixFlow
Template Packages define the styling, default settings and templates used to create your application. We recommend selecting a PhixFlow template, such as Serene Grey, as this comes complete with everything you need to start creating your application.
Application Icon (Optional): select an image to be used as the icon for your application on the selection screen.
Tip Icons for the application menu should be:
- up to 100 pixels high
- between 100 to 150 pixels wide
4. Click Create Application.
todo-fiona: check with dev - you have to click load to get the app creation process to complete
Menu
When you create a new application in the repository, PhixFlow automatically creates a menu item for it. You can find the menu in the repository → Menus branch → application_name
_Menu
. When you add the first option to the menu, it is automatically displayed on the right of the menu bar at the top of the PhixFlow window; see Menu.
Applications are listed as cards on the application menu.
- that have been configured to appear on menu
- and that you have permission to use.
The repository → Applications branch displays the applications that you have permission to use.
To redisplay the application menu, in the top left of the PhixFlow window click:
- either the Application menu
- or the , if it appears.
Each application card also has a pop-up menu; see Application for details.
PhixFlow's Welcome Window
Changing Application Settings
When you create your application project, you are setting up some defaults for the whole application. We now also take them from a template package. To change or set additional options for your application:
- either go the the application Home window and use the link in the top right of the window
- or open the repository and click on the application name.
PhixFlow opens the Application properties.
Your application may also be using defaults set in System Configuration. For example, you can optionally specify the formats for dates and times in your application using the settings:
- Date
- Date/Time
- Number
If you do not specify formats, PhixFlow uses the formats specified in the system configuration.
We need to outline the hierarchy of this logic i.e. system properties are overridden by templates etc.
hidden | true |
---|
Features not yet implemented
You create a new application project from the PhixFlow Welcome window.
To open the- that have been configured to appear on menu
- and that you have permission to use.
Templates Packages
Template Packages contain predefined options to specify a palette and other default properties; these include styling, default settings and templates used to create the content of your application. A Template package is selected when an application is created. See Understanding Template Packages.
Insert excerpt _packages _packages nopanel true
_packages | |
_packages | |
nopanel | true |
In PhixFlow you can share the same resources, such as data connectors and styles, with multiple applications by adding them to a package and then adding the package to different applications. A package can contain anything in an application.
To associate a package to an application:
- Open the Application's
Insert excerpt _property_settings _property_settings nopanel true - Click the Home button from the header menu and then click the properties button.
- Scroll down to the
section in the properties.Insert excerpt _packages _packages nopanel true - Click the
button to open the available packages list.Insert excerpt _packages _packages nopanel true - Tip: If the available packages list opens over the top of the application properties, drag the tab header to the left so that both open tabs can be seen next to each other.
- Drag the required package into the packages area for your application and
your changes.Insert excerpt _save _save nopanel true
Application Properties
To access the application properties, click the
Insert excerpt | ||||||
---|---|---|---|---|---|---|
|
The default properties used by your application are based on the template package you selected when you created it. You can see the default properties or set them in the Application Properties. These include:
- Grid Styling for headers, fonts and row sizes applied to grids by default.
- Set in the
.Insert excerpt _property_tabs _property_tabs name style nopanel true
- Set in the
- Default Components, such as the Form Fields template used when creating input forms.
- Set in the
.Insert excerpt _property_tabs _property_tabs name style nopanel true
- Set in the
- Formats for numbers and dates, including the number of decimal places.
- Set in the
.Insert excerpt _property_tabs _property_tabs nopanel true
- Set in the
- The Application Icon used in the application list to identify your application.
- Set in the
.Insert excerpt _property_tabs _property_tabs nopanel true
- Set in the
If a default style or number/date format is not set in the application properties, PhixFlow uses defaults set in System Configuration. If the latter is not set, PhixFlow will prompt you to set them.
For more detail on this topic see Editing Application Properties.
Startup Actions
Startup actions are Actionflows which run when your application initially opens. They can be used to open the default navigation menu and a specific screen, such as a landing page. See Designing Screens and Startup Actions.
Server Properties
The instance of PhixFlow can be labelled and a colour set. This is useful when you have multiple environments such as Development, UAT and Production.
- Server Properties
- From the header menu, click
→ System → Configuration.Insert excerpt _administration _administration nopanel true - Click on the
.Insert excerpt _property_tabs _property_tabs nopanel true
- From the header menu, click
- Set the Label
- Set a value in PhixFlow Instance. This will appear in the banner at the top of PhixFlow. For Example, Testing.
- Banner Colour
- Choose a colour by clicking the coloured box next to this field. You can pick a specific using the colour picker and set this as the banner colour.
Security
There are two elements of security:
- Controlling who can access an application.
Controlling their privileges within an application.
To find out more on this topic see, 21. Security and Access.
What's Next?
The PhixFlow Fundamentals course provides a practical guide to using PhixFlow, including setting up the application properties.
Already started PhixFlow Fundamentals?
Return to Application Fundamentals
Further Reading
Child pages (Children Display) |
---|