Skip to content

Commit

Permalink
Refresh of all instructions to match v6 of the Agilebase development …
Browse files Browse the repository at this point in the history
…interface
  • Loading branch information
okohll committed Oct 20, 2022
1 parent 08ac056 commit 4fa60f2
Show file tree
Hide file tree
Showing 105 changed files with 263 additions and 240 deletions.
3 changes: 2 additions & 1 deletion content/docs/adding-help/_index.md
Expand Up @@ -5,7 +5,8 @@ type: docs
weight: 90
description: "How to add inline help to aid users of your applications"
tags:
- Architect
- Citizen Developer level 2
- v6
---
Help for the application you build can be added in at many levels of the user interface
* at the individual field level
Expand Down
3 changes: 2 additions & 1 deletion content/docs/advanced-usage/_index.md
Expand Up @@ -5,7 +5,8 @@ type: docs
weight: 110
description: Resources typically useful in the later stages of development
tags:
- Principal Architect
- Software Architect
- v6
---
Also, new features, news and tips and tricks are posted on https://blog.agilebase.co.uk. Please subscribe on that page to receive any updates.

Expand Down
3 changes: 2 additions & 1 deletion content/docs/advanced-usage/build-patterns.md
Expand Up @@ -5,7 +5,8 @@ type: docs
weight: 130
description: Common patterns, or recipes for accomplishing useful tasks
tags:
- Principal Architect
- Software Architect
- v6
---
Some of these are just useful ideas, some are tips and tricks and some are larger-scale build patterns for more complex tasks commonly undertaken by customers.

Expand Down
3 changes: 2 additions & 1 deletion content/docs/advanced-usage/company-settings.md
Expand Up @@ -5,7 +5,8 @@ type: docs
weight: 120
description: These settings apply to the whole Agilebase account
tags:
- Principal Architect
- Software Architect
- v6
---
To access them:
1. In the administration interface, expand the _Administration_ section at the bottom left
Expand Down
3 changes: 2 additions & 1 deletion content/docs/advanced-usage/performance-optimisation.md
Expand Up @@ -5,7 +5,8 @@ type: docs
weight: 130
description: Working with big data and complex views
tags:
- Principal Architect
- Software Architect
- v6
---
Agilebase automatically takes some measures behind the scenes to maintain high performance as data volumes grow.

Expand Down
3 changes: 2 additions & 1 deletion content/docs/calendar/_index.md
Expand Up @@ -5,7 +5,8 @@ type: docs
weight: 80
description: Using the built in calendar and integrating with third party calendars
tags:
- Certified Architect
- Junior Software Architect
- v6
---
Any view with one or more date/time fields can have its data displayed in calendar form. If there are two date/time fields, the first will be the start time, the second the end time. If there's only one, events will last 1 hour by default, unless the field is a date only, in which case they will be all day.

Expand Down
7 changes: 4 additions & 3 deletions content/docs/charting/_index.md
Expand Up @@ -5,7 +5,8 @@ type: docs
weight: 70
description: Data visualisation options
tags:
- Citizen Developer
- Citizen Developer level 1
- v6
---
In Agilebase there are two mechanisms for charting and visualising data, each suited to a different purpose
1) our [built-in charting](built-in-charting)
Expand All @@ -27,7 +28,7 @@ Creating charts can be used in conjunction with building views, in an agile fash
Developers can also choose to have certain charts emailed to different groups of people on a regular basis. For example, [TODO]

## Exporting to Business Intelligence
We provide our own business intelligence tool, an instance of Apache Superset, which is available at https://superset.agilebase.co.uk for easy setup 'out of the box', however any tool you wish such as Power BI can also be connected.
Any tool you wish such as Power BI or Tableau for example can be connected.

This may be useful when
* You want to report summary KPIs or trends upwards, to higher levels of management, so you need a dashboard
Expand All @@ -38,7 +39,7 @@ This may be useful when
* You are happy with the privacy and data security implications - see below

### Privacy and data security
When connecting a Business Intelligence tool, whether that's the Superset instance we provide, or a third party tool, it's important to realise that data *leaves Agilebase* and therefore is no longer protected by Agilebase's roles and privileges system.
When connecting a Business Intelligence tool, it's important to realise that data *leaves Agilebase* and therefore is no longer protected by Agilebase's roles and privileges system.

You may have data in Agilebase which is only accessible to certain members of staff, however when accessed outside of Agilebase, those rules no longer apply. That doesn't necessarily mean the data is accessible publicly, but it does mean it's controlled by whatever privilege system the third party tool uses, which will be different to Agilebase's.

Expand Down
7 changes: 4 additions & 3 deletions content/docs/charting/built-in-charting.md
Expand Up @@ -5,7 +5,8 @@ type: docs
weight: 80
description: Building and working with charts
tags:
- Citizen Developer
- Citizen Developer level 1
- v6
---
Charting is not strictly an administrator function, as any user can create charts and other data visualisations, such as maps and word clouds.

Expand All @@ -15,7 +16,7 @@ In Agilebase, charts 'belong to' a view. Each view can have a collection of char

## Creating a chart
1. In the tiles interface, open the tile and view to use as a source of chart data
2. Click the charts button to the left of the data rows displayed
2. Click the charts button at the top right of the screen
3. Click the _add/edit chart or map_ button
4. Follow each of the steps (1 - 3) on screen to build the chart
5. In the last step, give a name to the chart and press _save_
Expand All @@ -35,7 +36,7 @@ Charts can be embedded into tables. When the user opens a record, the chart will

So for example if you have a chart of sales per month per customer, which you embed into a customer table, it will show as sales per month, only for the customer on screen.

This is accomplished by using a view with chart(s) as a [cross-referenced panel]({{<relref "/docs/fields/field-types/special-field-types/referenced-data">}}) - see that page for setup information.
This is accomplished by using a view with chart(s) as a [referenced data field]({{<relref "/docs/fields/field-types/special-field-types/referenced-data">}}) - see that page for setup information.

## Embedding charts in tabs
When a tab contains many 'child' records, e.g. an organisation may have a tab which contains financial data for the past 10 years, then charts can display above the rows of data when the tab's opened.
Expand Down
41 changes: 5 additions & 36 deletions content/docs/charting/business-intelligence.md
Expand Up @@ -5,27 +5,24 @@ type: docs
weight: 80
description: Visualising data in third party Business Intelligence tools
tags:
- System Builder
- Junior Software Architect
- v6
---

> Before setting up a BI connection, please be aware of the [data privacy and security](/docs/charting#privacy-and-data-security) considerations.
At Agilebase we host an instance of [Apache Superset](https://superset.apache.org) which can be used by customers to create reporting dashboards.

However the setup processes below also applies to third party tools such as Power BI. In fact, any tool which utilises [ODBC](https://en.wikipedia.org/wiki/Open_Database_Connectivity) can be used, such as Excel for example.
Any tool which utilises [ODBC](https://en.wikipedia.org/wiki/Open_Database_Connectivity) can be used, such as Excel for example. Power BI is a common one.

## Initial Setup

The first step is to [contact us](https://agilechilli.com/contact-us/) to request we prepare your account. This will also allow connections from Apache Superset, Power BI or any other tool which can connect to ODBC).

If you wish to use our supplied instance of Superset, we will then set up as many Superset users you require - there is no ongoing cost for these login accounts. Note that Superset logins are separate from Agilebase ones - the usernames and passwords can be different.
The first step is to [contact us](https://agilechilli.com/contact-us/) to request we prepare your account. This will also allow connections from Power BI or any other tool which can connect to ODBC).

If you use Power BI, then the process is as follows
1) Install the PostgreSQL ODBC driver from https://odbc.postgresql.org/. Use the Downloads link and if running on Windows, use the newest driver from the **msi** folder.
2) Use your operating system's control panel to set up the ODBC driver, using the login details we supply. Ensure the SSL mode is set to 'require'.
3) From Power BI, add a connection using the PostgreSQL ODBC driver, *not* the built-in Power BI PostgreSQL driver.

## Sending data to Superset or Power BI
## Sending data to Power BI

A developer with MANAGE privileges on a view's parent table can set this up.

Expand All @@ -52,31 +49,3 @@ Once the view has been set up, external applications will see a new read-only sn
3) Under 'chain workflow', select the reporting view A

Then, when a user opens view B, they will see a button at the top of the screen with the button text set to the name of view A. Pressing it will refresh the view A data sent to external applications.

## Creating dashboards in Superset

> This section applies to Superset only, for Power BI or other instructions please contact us.
Now that you've set up Agilebase to make data available to Superset, you can create charts and dashboards there.

1) Create a 'dataset' in Superset, corresponding to the view you set up above
1) From the *Data* menu at the top, select *datasets*, then click the *+ dataset* button
2) Under *Schema*, select your company name
3) Under *Table*, select the name of the view that you set up above
4) Click *ADD* at the bottom of the dialog (you may need to scroll down)
2) Create the chart
1) Click *Charts* at the top, then *+ Chart*
2) Select the dataset created above
3) Choose a chart type, then *Create New Chart*
4) Drag metrics (e.g. 'COUNT') and fields from the left into the appropriate areas in the middle column
5) Click *Save* and Superset will prompt you to add the chart to a new or existing dashboard
2) Access the dashboard from the *Dashboards* menu at the top

For more details on creating charts and editing dashboards, including video walkthroughs, see [here](https://docs.preset.io/docs/create-a-chart)







14 changes: 8 additions & 6 deletions content/docs/fields/_index.md
Expand Up @@ -5,7 +5,8 @@ type: docs
weight: 40
description: Table fields
tags:
- Architect
- Citizen Developer level 2
- v6
---
Adding fields to a table creates a form by which people (and other sources such as the [API]({{<relref "/docs/integrations">}}) or [workflows]({{<relref "/docs/workflows">}})) can enter data.

Expand All @@ -14,9 +15,8 @@ There are various types of fields and field options which this section will cove
## Adding a field
1. Ensure [development mode]({{<relref "/docs/introduction/development-mode">}}) is toggled on
2. Select the table to add a field to
3. Click on the pencil icon in the toolbar, if necessary, to edit the table
4. Click the _fields_ tab
5. From the controls at the bottom of the list of existing fields:
3. Click on the pencil icon above the record, if necessary, to edit the table
4. From the controls at the top of the list of existing fields:
- Type in a field name, optional description, choose a type and press the _Create Field_ button
6. Optionally, drag and drop the field to a desired location relevant to other fields

Expand All @@ -26,17 +26,19 @@ There are various types of fields and field options which this section will cove
Any description added to the field will be used as inline help. URLs can be included and will be turned into clickable links. See [help]({{<relref "/docs/adding-help">}}) for more information.

## Editing a field
Field name and description (help text) can be altered at any time by clicking them. Fields can be moved on screen by dragging. Options can be altered by clicking the _edit options_ link for each field.
Field name and description (help text) as well as field options can be altered at any time by clicking a field. Fields can be moved on screen by dragging.

However, once set, the field type can't be changed. A number field can't be converted to a text field for example. In particular, a decimal number can't be converted to a whole number field and vice versa, as integers and floating point numbers are different data types.

There is a process available for changing field types, please see [changing field types]({{<relref "/docs/advanced-usage/build-patterns#switching-a-field-from-one-type-to-another">}}) if you need to do that.

## Removing a field
In the _fields_ tab, click the _x_ button to the right of a field.
In the _fields_ panel, click the _x_ button to the right of a field.

If the field is used in any other locations in your application, such as a [view]({{<relref "/docs/views">}}), you'll be alerted to the fact. You'll need to first remove the field from those locations before being able to remove it.

You can also see where fields are used by scrolling to the bottom of the field editing panel and looking under 'Field Uses'.

![Removing a table field](/removing-a-table-field.png)


Expand Down
2 changes: 1 addition & 1 deletion content/docs/fields/field-options/_index.md
Expand Up @@ -5,7 +5,7 @@ type: docs
weight: 55
description: Customise the behaviour and display of fields
tags:
- Architect
- Citizen Developer level 2
---
Choosing suitable options helps make the user experience friendly, and extends the capabilities of applications.

Expand Down
3 changes: 2 additions & 1 deletion content/docs/fields/field-options/checkbox-field-options.md
Expand Up @@ -5,7 +5,8 @@ type: docs
weight: 90
description: Options specific to checkbox (true/false) fields
tags:
- Architect
- Citizen Developer level 2
- v6
---
## Default value
Simply whether the checkbox should default to ticked (true) or un-ticked (false) for new records.
Expand Down
5 changes: 4 additions & 1 deletion content/docs/fields/field-options/common-options.md
Expand Up @@ -5,7 +5,8 @@ type: docs
weight: 50
description: Options common to all fields of any type
tags:
- Architect
- Citizen Developer level 3
- v6
---
## Capitalise field name
By default Agilebase displays field names in Title Case. Un-ticking this option disables that, which can be useful for special cases like e.g. 'pH' or 'Length (m)', which would otherwise show as 'PH' and 'Length (M)'.
Expand All @@ -26,6 +27,8 @@ Two special options are available
* show always - the default state
* show never - useful for hiding fields used for internal purposes, e.g. which help the internal workings of a [workflow]({{<relref "/docs/workflows">}})

> If this option is used on a [separator]({{<relref "/docs/fields/field-types/special-field-types/separators">}}) field, then the visibility rule will apply to the entire block of fields under that separator.
## Lock when value set
If the field is blank, allow a value to be entered, however as soon as it has a value, lock to prevent further editing. The user can manually unlock, but will be prompted for a reason for doing so, which will be logged against the field as a comment.

Expand Down
3 changes: 2 additions & 1 deletion content/docs/fields/field-options/date-field-options.md
Expand Up @@ -5,7 +5,8 @@ type: docs
weight: 80
description: Options specific to date fields
tags:
- Architect
- Citizen Developer level 2
- v6
---
## Accuracy
Whether to record a date as just a year, year and month, year month and day, or with a time: hours, hh:mm, hh:mm:ss.
Expand Down
2 changes: 1 addition & 1 deletion content/docs/fields/field-options/file-field-options.md
Expand Up @@ -5,7 +5,7 @@ type: docs
weight: 130
description: Options specific to file fields, including for generating documents
tags:
- Architect
- Junior Software Architect
---
## Type
The type of document typically stored by this field. Can be
Expand Down
3 changes: 2 additions & 1 deletion content/docs/fields/field-options/number-field-options.md
Expand Up @@ -5,7 +5,8 @@ type: docs
weight: 100
description: Options specific to numeric fields
tags:
- Architect
- Citizen Developer level 2
- v6
---
## Colour outliers
Automatically highlight 'unusual' values of this field in views. This can help pick out values which are notable in some way, for example if a number has been entered without a decimal point by mistake (1253 instead of 12.53) or is a statistical outlier.
Expand Down
Expand Up @@ -5,7 +5,8 @@ type: docs
weight: 120
description: Options specific to cross-reference panel fields
tags:
- Architect
- Citizen Developer level 2
- v6
---
## Tabular display
Rather than displaying rows from the referenced view as panels
Expand Down
3 changes: 2 additions & 1 deletion content/docs/fields/field-options/relation-field-options.md
Expand Up @@ -5,7 +5,8 @@ type: docs
weight: 70
description: Options specific to relation fields, which determine how tables link together
tags:
- Architect
- Citizen Developer level 3
- v6
---
Relations between tables are the 'glue' that holds together an application built using Agilebase. If you'd like to learn more about this fundamental concept, please check out the [relational database concepts]({{<relref "/docs/tables/relational-database-concepts">}}) page.

Expand Down
3 changes: 2 additions & 1 deletion content/docs/fields/field-options/separator-options.md
Expand Up @@ -5,7 +5,8 @@ type: docs
weight: 110
description: Options specific to separators, which form groups of fields into blocks
tags:
- Architect
- Citizen Developer level 2
- v6
---
A [field separator]({{<relref "/docs/fields/field-types/special-field-types/separators">}}) creates a block of fields, starting with the separator and ending at the next one (or the last field in the table).

Expand Down
Expand Up @@ -5,7 +5,7 @@ type: docs
weight: 105
description: Options specific to auto-generated numeric sequence fields
tags:
- Architect
- Citizen Developer level 3
---
## Do not auto-populate
When this is un-ticked, the next number in the sequence will always be generated and saved for this field, whenever a new record is created.
Expand Down
3 changes: 2 additions & 1 deletion content/docs/fields/field-options/text-field-options.md
Expand Up @@ -5,7 +5,8 @@ type: docs
weight: 60
description: Options specific to text fields
tags:
- Architect
- Citizen Developer level 2
- v6
---
## Colour words
When this field is included in a view, highlight it with a colour if the content is one of a number of words. The most up-to-date values to be highlighted are shown in the administrator interface, but as of the latest update of this page, they are
Expand Down
3 changes: 2 additions & 1 deletion content/docs/fields/field-types/_index.md
Expand Up @@ -5,6 +5,7 @@ type: docs
weight: 50
description: A list of field types, the purposes and options of each
tags:
- Architect
- Citizen Developer level 2
- v6
---
These pages describe the various types of fields it is possible to have in an Agilebase application. It is recommended to begin with the basic field types before moving on to dealing with special field types.
3 changes: 2 additions & 1 deletion content/docs/fields/field-types/basic-field-types.md
Expand Up @@ -5,7 +5,8 @@ type: docs
weight: 60
description: Text, number, date/time, auto-generated number sequence and checkbox fields
tags:
- Architect
- Citizen Developer level 2
- v6
---
These are the core types of fields by which data can be entered by users (or other sources such as the API or a workflow).

Expand Down
3 changes: 2 additions & 1 deletion content/docs/fields/field-types/changing-field-types.md
Expand Up @@ -5,7 +5,8 @@ type: docs
weight: 80
description: How to change a field from one type to another
tags:
- Principal Architect
- Software Architect
- v6
---
Once a field has been created, the type can't be changed with the flick of a switch. However there is an easy to follow process to accomplish this.

Expand Down
Expand Up @@ -5,6 +5,7 @@ type: docs
weight: 70
description: Separators, comment feeds, referenced data, file uploads, automatic fields
tags:
- Architect
- Junior Software Architect
- v6
---
These special types of fields are useful beyond basic data entry, for creating rich application functionality and user experiences.
Expand Up @@ -5,7 +5,8 @@ type: docs
weight: 100
description: Metadata fields created and managed by the system
tags:
- Architect
- Junior Software Architect
- v6
---
When every [table]({{<relref "/docs/tables">}}) is created, a series of fields are automatically added. These aren't displayed in the data entry form of a table, but are available to be added into views.

Expand Down
Expand Up @@ -5,7 +5,8 @@ type: docs
weight: 90
description: Comment feeds allow collaboration between users of a system
tags:
- Architect
- Citizen Developer level 2
- v6
---
Adding a comment feed to a table adds a discussion area to a form, transforming its usefulness.

Expand Down

0 comments on commit 4fa60f2

Please sign in to comment.