Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentType code and guidance for linking to ICMS cost measurements #349

Open
duncandewhurst opened this issue Feb 3, 2022 · 0 comments
Labels
codelists This issue relates to the codelists documentation This issue relates to the documentation ICMS This issue relates to the International Cost Management Standard

Comments

@duncandewhurst
Copy link
Contributor

This issue is about linking to ICMS cost measurements from OC4IDS data. There are separate issues about modelling cost measurements in OC4IDS (#287) and adding attributes from ICMS to support cost comparisons (#292).

Proposal

Add the following code to the documentType codelist:

Code Title Description
icmsCostMeasurement ICMS cost measurement A cost measurement for this project, published using the International Cost Management Standard.

Add a brief page to the implementation guidance with the following content. Note that this includes a reference to the .identifiers array proposed in #214.

Connecting OC4IDS and the International Cost Management Standard

This page explains how to connect project data published using OC4IDS to cost measurements published using the International Cost Management Standard (ICMS).

To link a project in OC4IDS to an ICMS cost measurement, add a Document object to the project’s .documents array and set its properties according to the schema; in particular, set:

  • .id incrementally
  • .documentType to ‘icmsCostMeasurement’
  • .title to the title of the cost measurement
  • .url to the URL of the ICMS data

If the ICMS data includes a project identifier in the ICMS_id property, add the identifier to the project’s .identifiers array in OC4IDS.

JSON example

{
  "documents": [
    {
      "id": "1",
      "documentType": "icmsCostMeasurement",
      "title": "Pre-construction Cost Forecast",
      "url": "https://example.com/he/M75-junctions-4-to-5-smart-motorway/results/M75J4-5+pre-construction+forecast.xml",
      "format": "application/xml"
    }
  ]
}

CSV example

documents/0/id documents/0/documentType documents/0/title documents/0/url documents/0/format
1 icmsCostMeasurement Pre-construction Cost Forecast https://example.com/he/M75-junctions-4-to-5-smart-motorway/results/M75J4-5+pre-construction+forecast.xml application/xml
@duncandewhurst duncandewhurst added codelists This issue relates to the codelists documentation This issue relates to the documentation ICMS This issue relates to the International Cost Management Standard labels Feb 3, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
codelists This issue relates to the codelists documentation This issue relates to the documentation ICMS This issue relates to the International Cost Management Standard
Projects
None yet
Development

No branches or pull requests

1 participant