Skip to content

Latest commit

 

History

History
92 lines (60 loc) · 3.32 KB

index.rst

File metadata and controls

92 lines (60 loc) · 3.32 KB
Raw

SPECIAL DATASET FIELDS

COD

The dataset field is called: cod_level

Possible values:

value name display name
not-cod ---
cod-candidate Candidate COD
cod-standard Standard COD
cod-enhanced Enhanced COD

Resource-level Data Time Period

At the resource level there is a field called: daterange_for_data

The values should come in the following format:

  • [{START_DATETIME} TO {END_DATETIME}] OR
  • [{START_DATETIME} TO *] -> for open ended time periods

The field is stored in solr as daterange. Using the "*" means that for filtering purposes the end of the period is infinite.

Examples:

  • [2020-03-11T21:16:48.838 TO 2020-04-12T21:16:49]
  • [2020-03-11T21:16:48.838 TO *]

Fields for Grouping Resources

  • At the resource level:
    • field name: grouping - this is a free text field. Specifies the name of the group to which this resource belongs. It's not mandatory. Example: "Group A", "Jul 1, 2019 - Aug 1, 2019"
    • a resource can only be part of one grouping
  • At the dataset level:
    • a field at the dataset level is needed to decide the order in which the groupings are shown. However, it might not be needed for the user to provide one.
    • field name: x_resource_grouping - this is an automatically computed field:
      • IF resource_grouping (see below) field has been filled then it has the same value as that one
      • ELSE a list of groups is computed based on the groupings found in the resources. The list will be in descending order of the start date specified in the daterange_for_data inside the resource. If a grouping name appears in more than one resource than the latest start date is used.
    • field name: resource_grouping - (json) list of groupings. Does not needed to be filled. One can rely on the automatically computed field mentioned above

Expected Update Frequency

The dataset field is called: data_update_frequency The value of the field is usually the number of days after which a dataset is expected to be updated. The exceptions to this are:

  • As needed (formerly adhoc) has value -2

  • Never has value -1 ( initially the value 0 was used for this but it was decided that 0 is more suitable for live )

    The following patch was used for updating the database:

    update package_extra set value='-1' where key='data_update_frequency' and value='0' and state='active';

  • Live has value 0

Dataseries

There is a dataset field called: dataseries_name.

Permissions: You need to be either sysadmin or have the "Manage Dataseries" permission enabled.

The following API actions exist in order to add (link) or remove (unlink) a dataseries to/from a dataset:

  • /api/action/hdx_dataseries_link. It accepts 2 params:

    • id - the id or name of the dataset
    • dataseries_name

    Example of a POST requerst with a JSON body:

    {
    "id": "sample-dataset-name",
    "dataseries_name": "Sample dataseries"
}

  • /api/action/hdx_dataseries_unlink. It only needs 1 param:

    • id - the id or name of the dataset