Skip to content

Commit

Permalink
Merge branch '1.1-dev' into primer_0.1
Browse files Browse the repository at this point in the history
  • Loading branch information
jpmckinney committed Jul 31, 2021
2 parents d8e2d39 + 42b93ac commit 99ecc80
Show file tree
Hide file tree
Showing 35 changed files with 337 additions and 2,132 deletions.
60 changes: 30 additions & 30 deletions .tx/config
Original file line number Diff line number Diff line change
Expand Up @@ -19,12 +19,6 @@ source_file = build/locale/index.pot
source_lang = en
type = PO

[open-contracting-standard-1-1.theme]
file_filter = docs/locale/<lang>/LC_MESSAGES/theme.po
source_file = build/locale/theme.pot
source_lang = en
type = PO

[open-contracting-standard-1-1.privacy-notice]
file_filter = docs/locale/<lang>/LC_MESSAGES/privacy-notice.po
source_file = build/locale/privacy-notice.pot
Expand All @@ -43,6 +37,12 @@ source_file = build/locale/sphinx.pot
source_lang = en
type = PO

[open-contracting-standard-1-1.theme]
file_filter = docs/locale/<lang>/LC_MESSAGES/theme.po
source_file = build/locale/theme.pot
source_lang = en
type = PO

[open-contracting-standard-1-1.getting_started--building_blocks]
file_filter = docs/locale/<lang>/LC_MESSAGES/getting_started/building_blocks.po
source_file = build/locale/getting_started/building_blocks.pot
Expand Down Expand Up @@ -181,21 +181,27 @@ source_file = build/locale/guidance/map/amendments.pot
source_lang = en
type = PO

[open-contracting-standard-1-1.guidance--map--award_notices_decisions]
file_filter = docs/locale/<lang>/LC_MESSAGES/guidance/map/award_notices_decisions.po
source_file = build/locale/guidance/map/award_notices_decisions.pot
[open-contracting-standard-1-1.guidance--map--awards_contracts]
file_filter = docs/locale/<lang>/LC_MESSAGES/guidance/map/awards_contracts.po
source_file = build/locale/guidance/map/awards_contracts.pot
source_lang = en
type = PO

[open-contracting-standard-1-1.guidance--map--awards_contracts_buyers_suppliers]
file_filter = docs/locale/<lang>/LC_MESSAGES/guidance/map/awards_contracts_buyers_suppliers.po
source_file = build/locale/guidance/map/awards_contracts_buyers_suppliers.pot
[open-contracting-standard-1-1.guidance--map--beneficial_ownership]
file_filter = docs/locale/<lang>/LC_MESSAGES/guidance/map/beneficial_ownership.po
source_file = build/locale/guidance/map/beneficial_ownership.pot
source_lang = en
type = PO

[open-contracting-standard-1-1.guidance--map--consortia]
file_filter = docs/locale/<lang>/LC_MESSAGES/guidance/map/consortia.po
source_file = build/locale/guidance/map/consortia.pot
[open-contracting-standard-1-1.guidance--map--buyers_suppliers]
file_filter = docs/locale/<lang>/LC_MESSAGES/guidance/map/buyers_suppliers.po
source_file = build/locale/guidance/map/buyers_suppliers.pot
source_lang = en
type = PO

[open-contracting-standard-1-1.guidance--map--electronic_catalogues]
file_filter = docs/locale/<lang>/LC_MESSAGES/guidance/map/electronic_catalogues.po
source_file = build/locale/guidance/map/electronic_catalogues.pot
source_lang = en
type = PO

Expand All @@ -205,15 +211,15 @@ source_file = build/locale/guidance/map/extensions.pot
source_lang = en
type = PO

[open-contracting-standard-1-1.guidance--map--localization]
file_filter = docs/locale/<lang>/LC_MESSAGES/guidance/map/localization.po
source_file = build/locale/guidance/map/localization.pot
[open-contracting-standard-1-1.guidance--map--linked_standards]
file_filter = docs/locale/<lang>/LC_MESSAGES/guidance/map/linked_standards.po
source_file = build/locale/guidance/map/linked_standards.pot
source_lang = en
type = PO

[open-contracting-standard-1-1.guidance--map--mapping_awards_contracts]
file_filter = docs/locale/<lang>/LC_MESSAGES/guidance/map/mapping_awards_contracts.po
source_file = build/locale/guidance/map/mapping_awards_contracts.pot
[open-contracting-standard-1-1.guidance--map--localization]
file_filter = docs/locale/<lang>/LC_MESSAGES/guidance/map/localization.po
source_file = build/locale/guidance/map/localization.pot
source_lang = en
type = PO

Expand Down Expand Up @@ -259,21 +265,15 @@ source_file = build/locale/guidance/map/pre-qualification.pot
source_lang = en
type = PO

[open-contracting-standard-1-1.guidance--map--purchase_orders]
file_filter = docs/locale/<lang>/LC_MESSAGES/guidance/map/purchase_orders.po
source_file = build/locale/guidance/map/purchase_orders.pot
source_lang = en
type = PO

[open-contracting-standard-1-1.guidance--map--related_processes]
file_filter = docs/locale/<lang>/LC_MESSAGES/guidance/map/related_processes.po
source_file = build/locale/guidance/map/related_processes.pot
source_lang = en
type = PO

[open-contracting-standard-1-1.guidance--map--unsuccessful_tender]
file_filter = docs/locale/<lang>/LC_MESSAGES/guidance/map/unsuccessful_tender.po
source_file = build/locale/guidance/map/unsuccessful_tender.pot
[open-contracting-standard-1-1.guidance--map--unsuccessful_processes]
file_filter = docs/locale/<lang>/LC_MESSAGES/guidance/map/unsuccessful_processes.po
source_file = build/locale/guidance/map/unsuccessful_processes.pot
source_lang = en
type = PO

Expand Down
3 changes: 2 additions & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,8 @@
r'^http://www.eprocurementtoolkit.org/sites/default/files/2016-11/OCDS_Implemetation_Methodology_0.pdf#page=27$',
# Ignore unwanted links created by linkify.
r'^http://buyandsell.gc.ca$',
r'^http://release.id$',
r'^http://(?:identifier|release).id$',
r'^http://vnd\.',
# Ignore expected redirects.
r'^https://docs.google.com/spreadsheets/d/[^/]+/pub?gid=\d+&single=true&output=csv$',
]
Expand Down
65 changes: 28 additions & 37 deletions docs/guidance/map.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,15 @@
# Map

This phase is about documenting your sources of contracting data, and documenting how that data "maps" to OCDS – that is, identifying which [data elements](https://en.wikipedia.org/wiki/Data_element) within your data sources match which OCDS [fields](../../schema/reference) and [codes](../../schema/codelists). The mapping phase is one of the longest and most important steps in the implementation process.
This phase is about documenting your sources of contracting data, and documenting how that data "maps" to OCDS – that is, identifying which [data elements](https://en.wikipedia.org/wiki/Data_element) within your data sources match which OCDS [fields](../../schema/reference) and [codes](../../schema/codelists). The mapping phase is one of the longest and most important steps in the implementation process.

When starting out, consider working in parallel on the map and build phases, because the choices you make at the build stage might affect how you need to map your data. For example, your choice of architecture might determine whether you are able to publish a change history using releases and records.

If your contracting processes are managed on paper, using local spreadsheets or via unstructured electronic documents, and you’re reusing one of the existing [tools for collecting OCDS data](build/data_collection_tools), then please [get in touch with the OCDS Helpdesk](../support/index.md#ocds-helpdesk) for guidance on how to identify which OCDS fields match your local concepts.

Mapping data to OCDS is not always easy. Before writing any software, this phase is an opportunity to:

* Catch errors early on
* Identify [hard cases](#mapping-the-hard-cases) that need more attention
* Identify [hard cases](#deal-with-the-hard-cases) that need more attention
* Get input from the [OCDS Helpdesk](../../support/index)

The documentation you produce can also later be included in your [Data User Guide](publish.md#finalize-your-publication-policy).
Expand All @@ -34,43 +36,30 @@ Once complete, you can:
* Fill in the _Source systems_ sub-section of your [Publication Plan](https://www.open-contracting.org/resources/ocds-publication-plan-template/).
* Fill in the _Systems_ sheet of your Field-Level Mapping (introduced below).

## Map your data to OCDS

To make this step easier we provide templates to list the data elements within your data sources, and map them to either:
## Localize OCDS to your context

* OCDS [fields](../../schema/reference), using the [Field-Level Mapping Template](https://www.open-contracting.org/resources/ocds-field-level-mapping-template/) ([read the tutorial](https://www.open-contracting.org/resources/ocds-1-1-mapping-template-guidance/))
* OCDS [codes](../../schema/codelists), using the [Codelist Mapping Template](https://www.open-contracting.org/resources/ocds-1-1-codelist-mapping-template/) ([read the tutorial](https://www.open-contracting.org/resources/ocds-1-1-codelist-mapping-template-guidance/))

If your contracting data is managed on paper or in unstructured electronic documents, you should use the templates to list the data elements in those data sources and map them to OCDS.

You can [contact the OCDS Helpdesk](../support/index.md#ocds-helpdesk) for support and guidance on using the mapping templates.

Before working on mapping individual fields and codes, consider whether to first [localize OCDS](map/localization) to your context. Localization can be useful when you need to map several different systems, or when multiple organizations will work on implementing OCDS in your country.
Before mapping individual fields and codes, consider whether to first [localize OCDS](map/localization) to your context. Localization can be useful when you need to map several different systems, or when multiple organizations will work on implementing OCDS in your country.

```{toctree}
:hidden:
map/localization
```

### Mapping organization identifiers

[Organization identifiers](../schema/identifiers.md#organization-ids) in OCDS are made up of two parts:
## Download the mapping templates

* An org-id code, identifying the register from the which the identifier is drawn
* The identifier for the organization, drawn from the register
To make the mapping easier we provide templates to list the data elements within your data sources, and map them to either:

The [organization identifiers worked example](../guidance/map/organization_identifiers) shows how this works in practice.

Use [org-id.guide](http://org-id.guide) to find the code for the register your identifiers are drawn from. If no code exists for the register, contact the [OCDS Helpdesk](../../support/index).
* OCDS [fields](../../schema/reference), using the [Field-Level Mapping Template](https://www.open-contracting.org/resources/ocds-field-level-mapping-template/) ([read the tutorial](https://www.open-contracting.org/resources/ocds-1-1-mapping-template-guidance/))
* OCDS [codes](../../schema/codelists), using the [Codelist Mapping Template](https://www.open-contracting.org/resources/ocds-1-1-codelist-mapping-template/) ([read the tutorial](https://www.open-contracting.org/resources/ocds-1-1-codelist-mapping-template-guidance/))

### Working in parallel
If your contracting data is managed on paper or in unstructured electronic documents, you should use the templates to list the data elements in those data sources and map them to OCDS.

Working in parallel on the map and build phases can be useful, because the choices you make at the build stage might affect how you need to map your data. For example, your choice of architecture might determine whether you are able to publish a change history using releases and records.
You can [contact the OCDS Helpdesk](../support/index.md#ocds-helpdesk) for support and guidance on using the mapping templates.

### Splitting up the work
## Split up the work

You can complete this step in parts. For example, you might choose to split your mapping by any of the following:
You can complete the mapping in parts. For example, you might choose to split your mapping by any of the following:

* **data source** (e-procurement system, contract management system, [financial management information system](https://www.worldbank.org/en/topic/governance/brief/financial-management-information-systems-fmis), etc.)
* **contracting process type** (open procedure, selective procedure, concession contract, framework agreement, etc.)
Expand All @@ -83,29 +72,31 @@ It is also important to focus on the data elements whose disclosure was prioriti

Whichever approach you take, it's important that your eventual OCDS publication contain at least as much information as your other public datasets of contracting data; otherwise, users are less likely to use your OCDS publication.

### Mapping the hard cases
## Deal with the hard cases

Mapping data to OCDS is not always obvious. Please refer to our how-to guides and worked examples to learn how to map data for specific cases:
Mapping data to OCDS is not always obvious. Please refer to our how-to guides and worked examples to learn how to map data for specific hard cases:

```{toctree}
:maxdepth: 2
:titlesonly:
map/unsuccessful_processes
map/related_processes
map/pre-qualification
map/awards_contracts
map/electronic_catalogues
map/amendments
map/awards_contracts_buyers_suppliers
map/beneficial_ownership
map/milestones
map/organization_classifications
map/buyers_suppliers
map/organization_reference
map/organization_identifiers
map/organization_personal_identifiers
map/organization_reference
map/organizational_units
map/pre-qualification
map/related_processes
map/unsuccessful_tender
map/organization_classifications
map/beneficial_ownership
```

## Extensions
## Consider using extensions

Some data elements might not match any field or code in OCDS. To cover such cases, you can add fields and codes to OCDS using [extensions](map/extensions).

Expand All @@ -125,7 +116,7 @@ Some data elements might not match any field or code in OCDS. To cover such case
map/extensions
```

## Linked standards
## Link OCDS with other standards

Not all information that is related to a contracting process belongs in OCDS. For example, a company's annual filings and incorporation status are typically managed in a company registry, outside the lifecycle of a contracting process.

Expand All @@ -137,7 +128,7 @@ For guidance on integrating your OCDS data with these related datasets, refer to
map/linked_standards
```

## Wrapping up
## Wrap up

Once complete, you can:

Expand Down
42 changes: 0 additions & 42 deletions docs/guidance/map/award_notices_decisions.md

This file was deleted.

Loading

0 comments on commit 99ecc80

Please sign in to comment.