Skip to content

Commit 99c822e

Browse files
authored
Merge pull request #423 from digital-land/msj/add-alt-src
Add Alternate source data
2 parents 1e2eea8 + f24094a commit 99c822e

File tree

1 file changed

+44
-1
lines changed

1 file changed

+44
-1
lines changed

docs/data-operations-manual/How-To-Guides/Adding/Add-an-endpoint.md

Lines changed: 44 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -132,6 +132,49 @@ title: Add an endpoint
132132
1. **Run action workflow (optional)**
133133
Optionally, if you don’t want to wait until the next day, you can manually execute the workflow that usually runs overnight yourself in order to be able to check if the data is actually on the platform. Simply follow the instructions in the [guide for triggering a collection manually](/data-operations-manual/How-To-Guides/Maintaining/Trigger-collection-manually).
134134
135+
136+
## Add Alternate source data
137+
138+
### Infrastructure funding statement
139+
An example scenario is the addition of the Infrastructure funding statement dataset where the endpoint is provided as a .pdf file. In this instance we need to navigate to the `data` **directory** within the `INFRASTRUCTURE-FUNDING-STATEMENT-COLLECTION` **repository** using an editor such as github or Visual studio code.
140+
141+
Within this directory the file [infrastructure-funding.statement.csv](https://github.com/digital-land/infrastructure-funding-statement-collection/blob/main/data/infrastructure-funding-statement.csv) which is ordered by LPA needs to be edited by adding an entry to this list so that it becomes available to processed as an alternative data source.
142+
143+
144+
145+
To do this quickly an existing entry can be copied and the appropaite fields updated accordingly
146+
**"reference,collection,name,documentation-url,document-url,period-start-date,period-end-date,entry-date,start-date,end-date"**
147+
i.e.
148+
```
149+
tewkesbury-council-ifs-24-25,infrastructure-funding-statement,,https://tewkesbury.gov.uk/services/planning/community-infrastructure-levy-cil/developer-contributions/,https://tewkesbury.gov.uk/wp-content/uploads/2025/12/IFS-2024-25-Tewkesbury-Borough-PUBLISH.pdf,01/04/2024,31/03/2025,,,
150+
```
151+
Once this is done save this file and commit it along with an associated pull request (PR) before being merged into the main branch
152+
153+
154+
The next file to be updated is the [lookup.csv](https://github.com/digital-land/config/blob/main/pipeline/infrastructure-funding-statement/lookup.csv) in the `CONFIG` **repository**.
155+
To do this quickly an existing entry can be copied and the appropaite fields updated accordingly
156+
**"prefix,resource,endpoint,entry-number,organisation,reference,entity,entry-date,start-date,end-date"**
157+
i.e.
158+
```
159+
infrastructure-funding-statement,,,,government-organisation:D1342,tewkesbury-council-ifs-24-25,8100202,,,
160+
```
161+
N.B Ensure the value for "reference" field in incremented to the latedt value in the sequence.
162+
163+
164+
Once this is done save this file.
165+
166+
The next file to be updated is the [entity-organisation.csv](https://github.com/digital-land/config/blob/main/pipeline/infrastructure-funding-statement/entity-organisation.csv) in the `CONFIG` **repository**.
167+
To do this quickly an existing entry can be copied and the appropaite fields updated accordingly
168+
**"dataset,entity-minimum,entity-maximum,organisation"**
169+
i.e.
170+
```
171+
infrastructure-funding-statement,8100202,8100202,local-authority:TEW
172+
```
173+
Once this is done save this file.
174+
175+
The changes can then be committed and an associated pull request (PR) raised before being merged into the main branch
176+
177+
135178
## Endpoint edge-cases
136179
137180
### Handling Combined Endpoints
@@ -190,4 +233,4 @@ Whereas [this](https://datasette.planning.data.gov.uk/digital-land/column_field?
190233
191234
When an LPA requests an update to the documentation URL for an existing and active endpoint on our platform, attempting to add the endpoint again from the start will result in an "Duplicate endpoint" error.
192235
193-
Instead, update the source.csv file directly by locating the existing entry for that endpoint and modifying the documentation-url field with the new value provided by the LPA. Once updated, commit the changes.
236+
Instead, update the source.csv file directly by locating the existing entry for that endpoint and modifying the documentation-url field with the new value provided by the LPA. Once updated, commit the changes.

0 commit comments

Comments
 (0)