Skip to content

Commit

Permalink
Add new features for PoziPublisher including pagination
Browse files Browse the repository at this point in the history
  • Loading branch information
terry-longmacch committed Jan 23, 2024
1 parent 00cbde0 commit 6477b3c
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions admin-guide/publisher.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@ The catalogue is the unit around which the Pozi Publisher workflow is based, eit
| **`[Output]`** | `folder` | Destination folder for catalogue XML files, and also GeoJSON and SLD files for QGIS projects that have the setting `export=true` added to the `Keyword list` in either the project's or individual layer's settings. | `folder=C:\Pozi\Cache` |
| | `name` | Name of destination XML file | `name=deeca-iws-wms-southerngrampians` |
| | `dataFolder` | Destination folder for GeoJSON and SLD files when data is being extracted from a WFS service. If a QGIS project is being used data will be extracted into a subfolder of the output `folder` with the same name as the XML file. To enable data and style file extraction from a QGIS file, add `export=true` to the `Keyword list` either in the project's settings for all WFS layers, or individually to the `Keyword list` of specific layers. | `dataFolder=C:\Pozi\Cache` |
| | `projection` | When data is extracted from a WFS service, the default projection of WGS84 Latitude/Longitude (EPSG:4326) can be overwritten by specifying the EPSG code. | `projection=7855` |
| | `backupFolder` | Destination folder for creating time-stamped backup QGIS files, to enable version control. | `backupFolder=C:\Pozi\Backup` |
| | `searchFolder` | Destination for SearchDB file. In order to set up a field for searching, go to the relevant layer's properties. Make sure the layer is published as WFS, and then add `searchField={fieldName}` into the `Keyword list` for the layer. To also specify an ID field add `idField={idFieldName}` into the `Keyword list`. Settings added in the `Keyword list` should be comma delimited. | `searchFolder=C:\Pozi\Search` |
| | `order` | Comma-delimited list of layers in the order they should be presented in the output file. Regular expressions are recognised, so asterisks (*) should be used if the full name isn't going to be specified. Once the layers in the list have been processed, any remaining layers will be kept in their original order. **Note:** This uses layer names after `Replace` statements have been completed. | `order=*Centre,Kindergartens,Maternal Child Health Centres,Playgrounds,*Court*` |
Expand All @@ -63,6 +64,7 @@ The catalogue is the unit around which the Pozi Publisher workflow is based, eit
| **`[AWS]`** | `bucket` | Destination AWS S3 bucket | `bucket=connect.pozi.com/userdata/gleneira-publisher` |
| | `key` | Key | `key={Add Key}` |
| | `secret` | Secret | `secret={Add Secret}` |
| **`[WFS]`** | `parameters` | Specify extra parameters when calling a WFS service. This is particularly important when calling large datasets that have a limit on records that will be returned on a single call, as it can enable pagination. Firstly, the full data name (defined by the `<Name>` element in the GetCapabilities call) needs to be specified. This is followed by a pipe (\|) character, then the extra parameters that are to be concatenated to the end of the WFS service call. The `cql_filter` parameter is particularly useful for returning subsets of a large dataset - the example limits the records returned to active properties within a specific LGA. When requesting a dataset that requires pagination, it is critical that a `sortBy` criteria is added with a unique field to sort by. Without this the call will fail. | `parameters=open-data-platform:v_property_mp\|cql_filter=prop_lga_code IN (330) AND prop_status='A'&sortBy=prop_pfi` |

## Examples

Expand Down

0 comments on commit 6477b3c

Please sign in to comment.