How Can We Help?
Award synchronisation (Views)Award synchronisation (Views)
To have Award synchronisation all the views marked "Mandatory" needs to be available. The grouping in "Base data" etc. is only for giving better overview.
VIEW CREATE STATEMENTS
Download MSSQL server award view create statements
Download Postgres award view create statements
Download Oracle award view create statements
Base data
AWARD_DATA (Mandatory)
This view is used to list all the awards you want to synchronise into Pure. This means that one row should exist in this view pr award you want to have in Pure. For each award you have to specify an AWARD_ID which will be the primary key for this award in the rest of the views. This means that this ID has to be unique for each award and cannot change over time. In the rest of the views, the AWARD_ID will be used to relate content when using in a one-to-many relation.
The rest of the view is used to specify the simple meta data on the award
| Column name | Data type | Size | Mandatory | Note | Sync type. For each field pick on of: 'Yes', 'No', 'Once' |
|---|---|---|---|---|---|
| AWARD_ID | String | 1024 | Yes | The ID of the award in your backend system. This ID will be the primary key for the particular award and can thus not change over time. It will furthermore be used to make the correct connection to related content. | |
| AWARD_TYPE | Locked classification value | 1024 | Yes |
The type of award, possible options are: Base-UK:
Base-DE:
|
|
| TITLE | String(*) | 1024 | Yes | The title of the award | |
| SHORT_TITLE | String(*) | 256 | No | The short title of the award | |
| ACRONYM | String | 64 | No | The acronym for the award | |
| ACTUAL_START_DATE | Date | No | The date where the work based on this award will actually start. | ||
| ACTUAL_END_DATE | Date | No |
End date cannot be set if there is no start date. The date where the work based on this award will end. The status of the award will be calculated based on this date (or the EXPECTED_END_DATE if the ACTUAL_END_DATE is not filled in), so when the exceeded the status will automatically changed to closed. |
||
| EXPECTED_START_DATE | Date | No | If it is not yet know when the work based on this award will start, the expected start date can be set in this field. | ||
| EXPECTED_END_DATE | Date | No |
Expected end date cannot be set if there is no expected start date. If it is not yet know when the work based on this award will end, the expected end date can be set in this field. Please note that if this field is filled in the value of it will be used to calculate the status of the award if the ACTUAL_END_DATE is not filled in. |
||
| AWARD_DATE | Date | Yes | The date this award was or will be awarded. | ||
| CURTAIL_DATE | Date | No | The date of when the award was curtailed. The award is curtailed if the date is set. | ||
| CURTAIL_REASON | String | CLOB | No | The reason why the award has been curtailed. Note if this field is specified, you must also specify the CURTAIL_DATE | |
| COLLABORATIVE_AWARD | Boolean | Yes | Specify whether this is a collaborative award or not. If it is a collaborative award, the collaborators (external organisations) must be specified in the EXTERNAL_AWARD_COLLABORATORS view | ||
| MANAGED_BY_ORG_ID | String | 1024 | Yes | This field is used to specify which internal organisation is managing the award. The MANAGED_BY_ORG_ID must match either a Pure ID, classification defined ID, source ID or Pure UUID of an organisation already present in Pure. | |
| MANAGED_IN_PURE | Boolean | No |
Indicates whether or not an award should be managed inside Pure. If set to TRUE the synchronisation will only import the award and not lock any fields/relations. In subsequent synchronisation runs, the synchronisation will not update the award , unless the MANAGED_IN_PURE state is changed to FALSE. If changed the award will be picked up by the synchronisation and handled as a synchronised content and fields and relations will be locked based on the configuration. The default behaviour for the synchronisation is to consider MANAGED_IN_PURE as FALSE if data us not supplied for it. |
||
| VISIBILITY | String | 12 | No |
The visibility of the award. If you supply a value it must be one of the following: public, campus, restricted, confidential If you do not supply a value the visibility field will be set to public by default. |
|
| PROJECT_ID | String | 1024 | No | The id of the project.The below matching is used. |
|
| WORKFLOW | String | 256 | No | Basic Workflow valid values: entryInProgress, forApproval, approved, validated |
(*) To handle multiple languages _EN or _XX must be added to the column name.
| SQL used to check the quality of the views | Description/Comment | Applicable if |
|---|---|---|
| select AWARD_ID, count(AWARD_ID) from AWARD_DATA group by AWARD_ID having count(AWARD_ID) > 1 | Check for duplicate award ids | |
| select * from AWARD_DATA where AWARD_ID is null or AWARD_TYPE is null or TITLE is null or COLLABORATIVE_AWARD is null or MANAGED_BY_ORG_ID is null | Check for missing mandatory fields | |
|
BASE-UK: BASE-DE: |
Check for invalid award types | |
| select * from AWARD_DATA where VISIBILITY not in ('public', 'campus', 'restricted', 'confidential') | Check for invalid visibility | |
| select * from AWARD_DATA a where not exists (select * from INTERNAL_AWARDHOLDERS ia where a.AWARD_ID = ia.AWARD_ID) | Check if there exists award without any internal awardholders | |
| select AWARD_ID from AWARD_DATA where AWARD_ID not in (select AWARD_ID from INTERNAL_AWARD_ORGANISATIONS) | Check if there exists awards without any internal organisations | |
| select * from AWARD_DATA where CURTAIL_REASON is not null and CURTAIL_DATE is null | Check for CURTAIL_REASON being specified without CURTAIL_DATE is specified | |
| select * from AWARD_DATA a where COLLABORATIVE_AWARD = 1 and not exists (select * from EXTERNAL_AWARD_COLLABORATORS eac where a.AWARD_id = eac.AWARD_id) | Check for missing external collaborators when collaborative award | EXTERNAL_AWARD_COLLABORATORS is available |
INTERNAL_AWARDHOLDERS (Mandatory)
This view is used to specify the internal award holders on the award (i.e. staff from within your institution). One row must be provided pr award holder on the award. It is mandatory to add at least one internal applicant to each award.
| Column name | Data type | Size | Mandatory | Note | Sync type. For each field pick on of: 'Yes', 'No', 'Once' |
|---|---|---|---|---|---|
| AWARD_ID | String | 1024 | Yes | The award to add the award holder to | |
| PERSON_ID | String | 1024 | Yes | The ID of the person to add as an award holder. The PERSON_ID must match either a Pure ID, classification defined ID, source ID or Pure UUID of a person already present in Pure. | |
| ORGANISATION_ID | String | 1024 | Yes | The ID of the organisation that should be added to this award in the content of the supplied award holder. The ORGANISATION_ID must match either a Pure ID, classification defined ID, source ID or Pure UUID of an organisation already present in Pure. Multiple organisations can be added by separating the IDs with the | (pipe) character. | |
| ROLE | Locked classification value | 1024 | Yes |
The role of the Award holder. Possible values are
for Principal Investigator and Co-Investigator. |
|
| ACADEMIC_OWNERSHIP_PERCENTAGE | Double | No | The academic ownership of the award for this award holder. If no value is provided the field will be set to "unspecified" in Pure, which differs from the value 0. Provided values should be between 0 and 1. | ||
| PLANNED_RESEARCHER_COMMITMENT | Double | No | The planned researcher commitment of the award for this award holder. If no value is provided the field will be set to "unspecified" in Pure, which differs from the value 0. Provided values should be between 0 and 1. | ||
| ASSOCIATION_PERIOD_START_DATE | Date | No | The date where the award holders association to the award started. If no date is provided then the ACTUAL_START_DATE from the AWARD_DATA view will be used | ||
| ASSOCIATION_PERIOD_END_DATE | Date | No | The date where the award holders association to the award ended. If no date is provided then the ACTUAL_END_DATE from the AWARD_DATA view will be used |
| SQL used to check the quality of the views | Description/Comment | Applicable if |
|---|---|---|
| select * from INTERNAL_AWARDHOLDERS where AWARD_ID is null or PERSON_ID is null or ORGANISATION_ID is null or ROLE is null | Check for missing mandatory fields | |
| select distinct AWARD_ID from INTERNAL_AWARDHOLDERS ia where not exists (select * from AWARD_DATA a where ia.AWARD_ID = a.AWARD_ID) | Check for reference to non existing award | |
| select * from INTERNAL_AWARDHOLDERS where ACADEMIC_OWNERSHIP_PERCENTAGE < 0 or ACADEMIC_OWNERSHIP_PERCENTAGE > 1 | Check for invalid academic ownership percentage |
EXTERNAL_AWARDHOLDERS (Optional)
This view is used to specify the external award holders on the award (i.e. award holders that do not work for your institution. If you never provide information on external award holders (or do not have them), you should not implement this view.
For each external award holder you have on an award one row should be in the view.
Depending on whether you synchronise external organisations in a separate synchronisation job or not, the view functions a bit differently. Please see the documentation for external applicants on the Application views (EXTERNAL_APPLICANTS) for details on this.
| Column name | Data type | Size | Mandatory | Note | Sync type. For each field pick on of: 'Yes', 'No', 'Once' |
|---|---|---|---|---|---|
| AWARD_ID | String | 1024 | Yes | The award to add the award holder to | |
| FIRSTNAME | String | 1024 | Yes | The awardholders first name. | |
| LASTNAME | String | 1024 | Yes | The awardholders last name. | |
| COUNTRY | Classification (Locked set of values) | 1024 | No | The two digit country code from the ISO-3166 standard. E.g "gb" for United Kingdom, "us" for United States, "de" for Germany. The value is the last part of the countries classification in Pure. | |
| ROLE | Locked classification value | 1024 | Yes |
The role of the Award holder. Possible values are
for Principal Investigator and Co-Investigator. |
|
| EXTERNAL_ORG_NAME | String | 1024 | No | Use this field to specify the name of the external organisation the external award holder is related to. When the synchronisation runs a lookup in exiting external organisations will be made to try to find one with an exact match on the name. If such an external organisation can be found, this one will be used and thus related to the external award holder. If no exact match can be found a new external organisation will be made and related to the external award holder. | |
| EXTERNAL_ORG_TYPE | Classification value (view/edit classification configuration) | 1024 |
When specifying the EXTERNAL_ORG_NAME you can also specify a type for the external organisation. Provide the URI for one of the values in the classification scheme. This type is used for matching the external organisation, unless this type of behavior is disabled in the synchronisation. The type "unknown" organisation type is ignored during matching, to provide the best possible matches. In the cases where a new external organisation is created in Pure as part of the synchronisation, this type will be applied to the created external organisation. In the cases where an existing external organisation is used (e.g. a match was found), this field is disregarded and the type is thus not changed. |
||
| EXTERNAL_ORG_ID | String | 1024 | No | Use this field to specify the ID of the external organisation the external applicant is related to.The EXTERNAL_ORG_ID must match either a Pure ID, source ID or Pure UUID of an external organisation already present in Pure. |
| SQL used to check the quality of the views | Description/Comment | Applicable if |
|---|---|---|
| select * from EXTERNAL_AWARDHOLDERS where AWARD_ID is null or FIRSTNAME is null or LASTNAME is null or ROLE is null | Check for missing mandatory fields | |
| select distinct AWARD_ID from EXTERNAL_AWARDHOLDERS ea where not exists (select * from AWARD_DATA a where ea.AWARD_ID = a.AWARD_ID) | Check for reference to non existing awards | |
| select * from EXTERNAL_AWARDHOLDERS where EXTERNAL_ORG_NAME is not null and EXTERNAL_ORG_ID is not null; | Check if both EXTERNAL_ORG_ID and EXTERNAL_ORG_NAME has been specified |
INTERNAL_AWARD_ORGANISATIONS(Optional)
Besides the internal organisations added though the INTERNAL_AWARDHOLDERS view it is possible to add additional internal organisations. These will be added to the award on a general level, i.e., they will not be related though an award holder.
You should only use this view if you have additional internal organisations you want to add to your awards, and you should only put those organisation that has not already been related though an internal applicant in this view. For these reasons the view is therefore also optional.
| Column name | Data type | Size | Mandatory | Note | Sync type. For each field pick on of: 'Yes', 'No', 'Once' |
|---|---|---|---|---|---|
| AWARD_ID | String | 1024 | Yes | The award to add the applicant organisation to | |
| ORGANISATION_ID | String | 1024 | Yes | The ID of the organisation that should be added to this award. The organisation will be added to the award on a general level, i.e., not though a specific award holder. The ORGANISATION_ID must match either a Pure ID, classification defined ID, source ID or Pure UUID of an organisation already present in Pure. |
| SQL used to check the quality of the views | Description/Comment | Applicable if |
|---|---|---|
| select * from INTERNAL_AWARD_ORGANISATIONS where AWARD_ID is null or ORGANISATION_ID is null | Check for missing mandatory fields | |
| select distinct AWARD_ID from INTERNAL_AWARD_ORGANISATIONS iao where not exists (select * from AWARD_DATA a where iao.AWARD_ID = a.AWARD_ID) | Check for reference to non existing awards |
INT_AWARD_CO_MANAGING_ORG(Optional)
You can insert co-managing-organisations, but remember you can not to insert managedByOrganisation as a co-managing-organisation.
| Column name | Data type | Size | Mandatory | Note | Sync type. For each field pick on of: 'Yes', 'No', 'Once' |
|---|---|---|---|---|---|
| AWARD_ID | String | 1024 | Yes | The award to add the applicant organisation to | |
| ORGANISATION_ID | String | 1024 | Yes | The ID of the organisation that should be added to this award. The organisation will be added to the award on a general level, i.e., not though a specific award holder. The ORGANISATION_ID must match either a Pure ID, classification defined ID, source ID or Pure UUID of an organisation already present in Pure. |
| SQL used to check the quality of the views | Description/Comment | Applicable if |
|---|---|---|
| select * from INT_AWARD_CO_MANAGING_ORG where AWARD_ID is null or ORGANISATION_ID is null | Check for missing mandatory fields | |
| select distinct AWARD_ID from INT_AWARD_CO_MANAGING_ORG iao where not exists (select * from AWARD_DATA a where iao.AWARD_ID = a.AWARD_ID) | Check for reference to non existing awards |
EXTERNAL_AWARD_ORGANISATIONS (Optional)
Besides the external organisations added though the EXTERNAL_AWARDHOLDERS view it is possible to add additional external organisations. These will be added to the award on a general level, i.e., they will not be related though an external applicant.
You should only use this view if you have additional external organisations you want to add to your awards, and you should only put those organisation that has not already been related though an external applicant in this view. For these reasons the view is therefore also optional.
Depending on whether you synchronise external organisations in a separate synchronisation job or not, the view functions a bit differently. Please see the documentation for external applicants on the Application views (EXTERNAL_APPLICANT_ORGANISATION) for details on this.
| Column name | Data type | Size | Mandatory | Note | Sync type. For each field pick on of: 'Yes', 'No', 'Once' |
|---|---|---|---|---|---|
| AWARD_ID | String | 1024 | Yes | The award to add the award holder organisation to | |
| EXTERNAL_ORG_NAME | String | 1024 | No | Use this field to specify the name of the external organisation. | |
| EXTERNAL_ORG_TYPE | Classification value (view/edit classification configuration) | 1024 | When specifying the EXTERNAL_ORG_NAME you can also specify a type for the external organisation. Provide the URI for one of the values in the classification scheme. This type is used for matching the external organisation, unless this type of behavior is disabled in the synchronisation. The type "unknown" organisation type is ignored during matching, to provide the best possible matches. | ||
| EXTERNAL_ORG_ID | String | 1024 | No | Use this field to specify the ID of the external organisation the external applicant is related to.The EXTERNAL_ORG_ID must match either a Pure ID, source ID or Pure UUID of an external organisation already present in Pure. |
| SQL used to check the quality of the views | Description/Comment | Applicable if |
|---|---|---|
| select distinct AWARD_ID from EXTERNAL_AWARD_ORGANISATIONS eao where not exists (select * from AWARD_DATA a where eao.AWARD_ID = a.AWARD_ID) | Check for reference to non existing awards | |
| select * from EXTERNAL_AWARD_ORGANISATIONS where (EXTERNAL_ORG_NAME is not null and EXTERNAL_ORG_ID is not null) or (EXTERNAL_ORG_NAME is null and EXTERNAL_ORG_ID is null) | Check that either external_org_name or external_org_id is specified |
EXTERNAL_AWARD_COLLABORATORS (Optional)
If your award is a collaborative award you have to specify which external organisations you are collaborating with on the award. Your own internal organisation will be added automatically.
Depending on whether you synchronise external organisations in a separate synchronisation job or not, the view functions a bit differently. Please see the documentation for external applicants on the Application views (EXTERNAL_APPLICATION_COLLABORATORS) for details on this.
| Column name | Data type | Size | Mandatory | Note | Sync type. For each field pick on of: 'Yes', 'No', 'Once' |
|---|---|---|---|---|---|
| AWARD_ID | String | 1024 | Yes | The award to add the collaborator to | |
| EXTERNAL_ORG_NAME | String | 1024 | No | Use this field to specify the name of the external organisation. | |
| EXTERNAL_ORG_TYPE | Classification value (view/edit classification configuration) | 1024 | When specifying the EXTERNAL_ORG_NAME you can also specify a type for the external organisation. Provide the URI for one of the values in the classification scheme. This type is used for matching the external organisation, unless this type of behavior is disabled in the synchronisation. The type "unknown" organisation type is ignored during matching, to provide the best possible matches. | ||
| EXTERNAL_ORG_ID | String | 1024 | No | If Use this field to specify the ID of the external organisation the external applicant is related to.The EXTERNAL_ORG_ID must match either a Pure ID, source ID or Pure UUID of an external organisation already present in Pure. | |
| LEAD_COLLABORATOR | Boolean | No | Specifies the lead collaborator. Only one lead collaborator is allowed per award. If no external collaborators are marked as lead, then the internal organisation will be lead. | ||
| COLLABORATOR_TYPE | Classification value | 1024 | No |
The type of collaborator, allowed options are:
|
| SQL used to check the quality of the views | Description/Comment | Applicable if |
|---|---|---|
| select distinct AWARD_ID from EXTERNAL_AWARD_COLLABORATORS eac where not exists (select * from AWARD_DATA a where eac.AWARD_ID = a.AWARD_ID) | Check for reference to non existing awards | |
| select * from EXTERNAL_AWARD_COLLABORATORS where (EXTERNAL_ORG_NAME is not null and EXTERNAL_ORG_ID is not null) or (EXTERNAL_ORG_NAME is null and EXTERNAL_ORG_ID is null) | Check that either external_org_name or external_org_id is specified |
Award data
AWARD_FINANCIAL_FUNDINGS (Mandatory)
| Column name | Data type | Size | Mandatory | Note | Sync type. For each field pick on of: 'Yes', 'No', 'Once' |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| AWARD_ID | String | 1024 | Yes | The award to add the funding to | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| FUNDING_ID | String | 1024 | Yes |
An ID that identifies this specific funding. This ID is used to relate further content such as classification scheme values, amounts for external collaborators etc. The FUNDING_ID needs to be unique and non-changing per AWARD_ID. E.g. AWARD_ID = 1000 and AWARD_ID = 1, AWARD_ID = 1001 and FUNDING_ID = 1. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| EXTERNAL_ORG_NAME | String | 1024 | Yes (EXTERNAL_ORG_ID or EXTERNAL_ORG_NAME must be present in the view) | Use this field to specify the name of the funding organisation. This will be represented as an external organisation in Pure and related to the award with a "Funder" classification value on the relation | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| EXTERNAL_ORG_TYPE | Classification value (view/edit classification configuration) | 1024 | When specifying the EXTERNAL_ORG_NAME you can also specify a type for the external organisation. Provide the URI for one of the values in the classification scheme. This type is used for matching the external organisation, unless this type of behavior is disabled in the synchronisation. The type "unknown" organisation type is ignored during matching, to provide the best possible matches. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| EXTERNAL_ORG_ID | String | 1024 | Yes (EXTERNAL_ORG_ID or EXTERNAL_ORG_NAME must be present in the view) | Use this field to specify the ID of the external organisation the external applicant is related to.The EXTERNAL_ORG_ID must match either a Pure ID, source ID or Pure UUID of an external organisation already present in Pure. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| FUNDING_PROJECT_SCHEME | String | 1024 | No | The funding project scheme (research programme). | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| AWARDED_AMOUNT_AWARDED_CUR | Double | No |
The awarded amount in the awarded currency
 |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| AWARDED_CURRENCY | Classification value | 1024 | No |
The currency the awarded amount was awarded in. Possible options are listed below. You must provide the ISO code.
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| AWARDED_AMOUNT | Double | Yes | The awarded amount converted to the system currency | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| INSTITUTIONAL_CONTRIBUTION | Double | No | The contribution that the institution must provide for this funding if there is an requirement for the award. 
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| INSTITUTIONAL_FEC | Double | No | The institutional full economic costing (fEC) for the funding. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| FEC_PERCENTAGE | Double | No | This field specifies the fEC percentage. The value '0.1' will be interpreted as 10%, '1' as 100%, '1.5' as 150% etc. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| INSTITUTIONAL_PART | Double | No | The part of the award that the university/institute ("The University" in the example above) will have if this is a collaborative award. Should only be provided if this is a collaborative award. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| VISIBILITY | String | 12 | No |
The visibility of the funding. If you supply a value it must be one of the following: public, campus, restricted If you do not supply a value the visibility field will be set to the value of the award. The award visibility overrules the funding visibility, which means you can't have a restricted award with a public visible funding. It's is possible to have a public visible award with a restricted funding. |
| SQL used to check the quality of the views | Description/Comment | Applicable if |
|---|---|---|
| select * from AWARD_FINANCIAL_FUNDINGS where AWARD_id is null or FUNDING_ID is null | Check for missing mandatory fields | |
| select distinct AWARD_ID from AWARD_FINANCIAL_FUNDINGS aff where not exists (select * from AWARD_DATA a where aff.AWARD_ID = a.AWARD_ID) | Check for reference to non existing awards | |
| select aff1.AWARD_id, aff1.FUNDING_ID from AWARD_FINANCIAL_FUNDINGS aff1 inner join AWARD_FINANCIAL_FUNDINGS aff2 on aff1.AWARD_id = aff2.AWARD_id where aff1.FUNDING_ID = aff2.FUNDING_ID group by aff1.AWARD_id, aff1.FUNDING_ID having count(aff1.FUNDING_ID) > 1 | Check whether the same funding id is used twice for the same award | |
| select * from AWARD_FINANCIAL_FUNDINGS where (EXTERNAL_ORG_NAME is not null and EXTERNAL_ORG_ID is not null) or (EXTERNAL_ORG_NAME is null and EXTERNAL_ORG_ID is null) | Check that either external_org_name or external_org_id is specified | |
| select * from AWARD_FINANCIAL_FUNDINGS where FEC_PERCENTAGE < 0 | Check for invalid fEC percentage | |
| select * from AWARD_FINANCIAL_FUNDINGS aff inner join AWARD_DATA a on aff.AWARD_ID = a.AWARD_ID where INSTITUTIONAL_PART > 0 and a.COLLABORATIVE_AWARD = 0 | Check for institutional part on a non collaborative award | |
| select * from AWARD_FINANCIAL_FUNDINGS where VISIBILITY not in ('public', 'campus', 'restricted'); | Check for invalid visibility |
AWARD_NON_FINANCIAL_FUNDINGS (Optional)
| Column name | Data type | Size | Mandatory | Note | Sync type. For each field pick on of: 'Yes', 'No', 'Once' |
|---|---|---|---|---|---|
| AWARD_ID | String | 1024 | Yes | The award to add the funding to | |
| FUNDING_ID | String | 1024 | Yes |
An ID that identifies this specific funding. This ID is used to relate further content such as classification scheme values, amounts for external collaborators etc. The FUNDING_ID needs to be unique and non-changing per AWARD_ID. E.g. AWARD_ID = 1000 and FUNDING_ID = 1, AWARD_ID = 1001 and FUNDING_ID = 1. |
|
| EXTERNAL_ORG_NAME | String | 1024 | No | Use this field to specify the name of the funding organisation. This will be represented as an external organisation in Pure and related to the award with a "Funder" classification value on the relation | |
| EXTERNAL_ORG_TYPE | Classification value (view/edit classification configuration) | 1024 | When specifying the EXTERNAL_ORG_NAME you can also specify a type for the external organisation. Provide the URI for one of the values in the classification scheme. This type is used for matching the external organisation, unless this type of behavior is disabled in the synchronisation. The type "unknown" organisation type is ignored during matching, to provide the best possible matches. | ||
| EXTERNAL_ORG_ID | String | 1024 | No | Use this field to specify the ID of the external organisation the external applicant is related to.The EXTERNAL_ORG_ID must match either a Pure ID, source ID or Pure UUID of an external organisation already present in Pure. | |
| FUNDING_PROJECT_SCHEME | String | 1024 | No | The funding project scheme (research programme). | |
| ESTIMATED_VALUE | Double | No | |||
| INSTITUTIONAL_ESTIMATED_VALUE | Double | No | Should only be provided if this is a collaborative award. | ||
| DESCRIPTION | String | CLOB | No | ||
| VISIBILITY | String | 12 | No |
The visibility of the funding. If you supply a value it must be one of the following: public, campus, restricted If you do not supply a value the visibility field will be set to the value of the award. The award visibility overrules the funding visibility, which means you can't have a restricted award with a public visible funding. It's is possible to have a public visible award with a restricted funding. |
| SQL used to check the quality of the views | Description/Comment | Applicable if |
|---|---|---|
| select * from AWARD_NON_FINANCIAL_FUNDINGS where AWARD_id is null or FUNDING_ID is null | Check for missing mandatory fields | |
| select distinct AWARD_ID from AWARD_NON_FINANCIAL_FUNDINGS anff where not exists (select * from AWARD_DATA a where anff.AWARD_ID = a.AWARD_ID) | Check for reference to non existing awards | |
| select anff1.AWARD_id, anff1.FUNDING_ID from AWARD_NON_FINANCIAL_FUNDINGS anff1 inner join AWARD_NON_FINANCIAL_FUNDINGS anff2 on anff1.AWARD_id = anff2.AWARD_id where anff1.FUNDING_ID = anff2.FUNDING_ID group by anff1.AWARD_id, anff1.FUNDING_ID having count(anff1.FUNDING_ID) > 1 | Check whether the same funding id is used twice for the same award | |
| select anff.AWARD_ID, anff.FUNDING_ID from AWARD_NON_FINANCIAL_FUNDINGS anff inner join AWARD_FINANCIAL_FUNDINGS aff on anff.AWARD_ID = aff.AWARD_ID where aff.FUNDING_ID = anff.FUNDING_ID | Check whether the same funding id is used twice for the same award as a financial funding or non financial fundings | |
| select * from AWARD_NON_FINANCIAL_FUNDINGS where (EXTERNAL_ORG_NAME is not null and EXTERNAL_ORG_ID is not null) or (EXTERNAL_ORG_NAME is null and EXTERNAL_ORG_ID is null) | Check that either external_org_name or external_org_id is specified | |
| select * from AWARD_NON_FINANCIAL_FUNDINGS where VISIBILITY not in ('public', 'campus', 'restricted') | Check for invalid visibility | |
| select * from AWARD_NON_FINANCIAL_FUNDINGS anff where not exists (select * from BUDGET b where b.AWARD_ID = anff.AWARD_ID and b.FUNDING_ID = anff.FUNDING_ID) | Check if there exists non financial fundings without any budget |
AWARD_COLLABORATOR_SPLIT (Optional)
This view adds awards collaboration
| Column name | Data type | Size | Mandatory | Note | Sync type. For each field pick on of: 'Yes', 'No', 'Once' |
|---|---|---|---|---|---|
| AWARD_ID | String | 1024 | Yes | The award to add the funding to | |
| FUNDING_ID | String | 1024 | Yes | The Funding ID references the the Funding ID (together with the AWARD_ID) provided in the AWARD_FINANCIAL_FUNDINGS view. | |
| EXTERNAL_ORG_NAME | String | 1024 | No | Use this field to specify the name of the funding organisation. This will be represented as an external organisation in Pure and related to the award with a "Funder" classification value on the relation | |
| EXTERNAL_ORG_TYPE | Classification value (view/edit classification configuration) | 1024 | When specifying the EXTERNAL_ORG_NAME you can also specify a type for the external organisation. Provide the URI for one of the values in the classification scheme. This type is used for matching the external organisation, unless this type of behavior is disabled in the synchronisation. The type "unknown" organisation type is ignored during matching, to provide the best possible matches. | ||
| EXTERNAL_ORG_ID | String | 1024 | No | Use this field to specify the ID of the external organisation the external applicant is related to.The EXTERNAL_ORG_ID must match either a Pure ID, source ID or Pure UUID of an external organisation already present in Pure. | |
| COLLABORATORS_SPLIT | Double | No | The amount for the external organisation (collaborator) as illustrated for the "Institutional part" on the image above. |
| SQL used to check the quality of the views | Description/Comment | Applicable if |
|---|---|---|
| select * from AWARD_COLLABORATOR_SPLIT acs where not exists (select * from AWARD_FINANCIAL_FUNDINGS aff, AWARD_NON_FINANCIAL_FUNDINGS anff where (aff.AWARD_ID = acs.AWARD_ID and aff.FUNDING_ID = acs.FUNDING_ID) or (anff.AWARD_ID = acs.AWARD_ID and anff.FUNDING_ID = acs.FUNDING_ID)) | Check that the corresponding non financial funding or financial funding could be found | |
| select * from AWARD_COLLABORATOR_SPLIT acs where not exists (select * from EXTERNAL_AWARD_COLLABORATORS eac where acs.AWARD_ID = eac.AWARD_ID and (eac.EXTERNAL_ORG_NAME is not null and eac.EXTERNAL_ORG_NAME = acs.EXTERNAL_ORG_NAME and eac.EXTERNAL_ORG_TYPE = acs.EXTERNAL_ORG_TYPE) or (eac.EXTERNAL_ORG_ID is not null and eac.EXTERNAL_ORG_ID = acs.EXTERNAL_ORG_ID)) | Checks that a corresponding external organisation could be found in EXTERNAL_AWARD_COLLABORATORS | |
| select * from AWARD_COLLABORATOR_SPLIT where (EXTERNAL_ORG_NAME is not null and EXTERNAL_ORG_ID is not null) or (EXTERNAL_ORG_NAME is null and EXTERNAL_ORG_ID is null) | Check that either external_org_name or external_org_id is specified |
AWARD_FUNDING_CLASSIFICATION (Optional)
| Column name | Data type | Size | Mandatory | Note | Sync type. For each field pick on of: 'Yes', 'No', 'Once' |
|---|---|---|---|---|---|
| AWARD_ID | String | 1024 | Yes | The award to add the funding to | |
| FUNDING_ID | String | 1024 | Yes | The Funding ID references the the Funding ID (together with the AWARD_ID) provided in the AWARD_FINANCIAL_FUNDINGS view. | |
| CLASSIFICATION_VALUE | Classification value | 1024 | Yes |
The classification value. It must be unique for the combination of AWARD_ID and FUNDING_ID. Base-UK: HESA and REF classifications are available. HESA
REF
/dk/atira/pure/funding/refincomesources/10 /dk/atira/pure/funding/refincomesources/11 /dk/atira/pure/funding/refincomesources/12 /dk/atira/pure/funding/refincomesources/13 /dk/atira/pure/funding/refincomesources/14
Base-DE: /dk/atira/pure/project/financingsources/publicReseachCouncil /dk/atira/pure/project/financingsources/publicResearchProgramPublic /dk/atira/pure/project/financingsources/euresearchProgramPublic /dk/atira/pure/project/financingsources/otherPublicSupport /dk/atira/pure/project/financingsources/internalFunding /dk/atira/pure/project/financingsources/privateFunding /dk/atira/pure/project/financingsources/otherPrivateFunding |
| SQL used to check the quality of the views | Description/Comment | Applicable if |
|---|---|---|
| select * from AWARD_FUNDING_CLASSIFICATION where AWARD_ID is null or FUNDING_ID is null or CLASSIFICATION_VALUE is null | Checking for missing mandatory fields | |
| select * from AWARD_FUNDING_CLASSIFICATION afc where not exists (select * from AWARD_FINANCIAL_FUNDINGS aff, AWARD_NON_FINANCIAL_FUNDINGS anff where (aff.AWARD_ID = afc.AWARD_ID and aff.FUNDING_ID = afc.FUNDING_ID) or (anff.AWARD_ID = afc.AWARD_ID and anff.FUNDING_ID = afc.FUNDING_ID)) | Check that the corresponding non financial funding or financial funding could be found |
BUDGET (Optional)
This view provides the budgets for the financial overview below. With Pure version 5.2+ is will be possible to synchronize budgets and expenditure on existing fundings, only the view BUDGET, BUDGET_LINE and EXPENDITURE is required.
| Column name | Data type | Size | Mandatory | Note | Sync type. For each field pick on of: 'Yes', 'No', 'Once' |
|---|---|---|---|---|---|
| AWARD_ID | String | 1024 | Yes | The award to add the budget to | |
| FUNDING_ID | String | 1024 | Yes | The FUNDING_ID references the Funding ID (together with the AWARD_ID) provided in the AWARD_FINANCIAL_FUNDINGS view. | |
| BUDGET_ID | String | 1024 | Yes |
An ID that identifies this specific budget. This ID is used to relate budget lines and expenditure. The BUDGET_ID needs to be unique and non-changing per combination of AWARD_ID and FUNDING_ID. E.g. AWARD_ID = 1000, FUNDING_ID = 1, and BUDGET_ID = 1 |
|
| ORGANISATION_ID | String | 1024 | No (Yes) |
The ID of the organisation this budget is associated with. The ORGANISATION_ID must match either a Pure ID, classification defined ID, source ID or Pure UUID of an organisation already present in Pure. If you have more than one budget per funding then this field is mandatory. |
|
| COST_CENTER | Classification value ( view/edit classification configuration) | 1024 | No (Yes) |
The cost center this budget is associated with. Provide the URI for one of the values in the classification scheme. If you have more than one budget per funding then this field is mandatory. |
| SQL used to check the quality of the views | Description/Comment | Applicable if |
|---|---|---|
| select * from BUDGET where AWARD_id is null or FUNDING_ID is null or BUDGET_ID is null | Check for missing mandatory fields | |
| select * from BUDGET b where not exists (select * from AWARD_FINANCIAL_FUNDINGS aff, AWARD_NON_FINANCIAL_FUNDINGS anff where (aff.AWARD_ID = b.AWARD_ID and aff.FUNDING_ID = b.FUNDING_ID) or (anff.AWARD_ID = b.AWARD_ID and anff.FUNDING_ID = b.FUNDING_ID)) | Check that the corresponding non financial funding or financial funding could be found | |
| select b1.AWARD_id, b1.FUNDING_ID, b1.BUDGET_ID from BUDGET b1 inner join BUDGET b2 on b1.AWARD_id = b2.AWARD_id where b1.FUNDING_ID = b2.FUNDING_ID and b1.BUDGET_ID = b2.BUDGET_ID group by b1.AWARD_id, b1.FUNDING_ID, b1.BUDGET_ID having count(b1.BUDGET_ID) > 1 | Check whether the same budget id is used twice for the same award as a financial funding or non financial fundings | |
| select b1.AWARD_id, b1.FUNDING_ID, b1.BUDGET_ID, b1.ORGANISATION_ID, b1.COST_CENTER from BUDGET b1 inner join BUDGET b2 on b1.AWARD_id = b2.AWARD_id where b1.FUNDING_ID = b2.FUNDING_ID and (b1.ORGANISATION_ID is null or b1.COST_CENTER is null) group by b1.AWARD_id, b1.FUNDING_ID, b1.BUDGET_ID, b1.ORGANISATION_ID, b1.COST_CENTER having count(b1.BUDGET_ID) > 1 | Check whether ORGANISATION_ID and COST_CENTER is set when more than one budget per funding | |
| select * from BUDGET b where not exists (select * from BUDGET_LINE bl where bl.AWARD_ID = b.AWARD_ID and bl.FUNDING_ID = b.FUNDING_ID and bl.BUDGET_ID = b.BUDGET_ID) | Check that at least one budget line is related to this budget |
BUDGET_LINE (Optional)
This view provides the budget lines and values for the financial overview below:
| Column name | Data type | Size | Mandatory | Note | Sync type. For each field pick on of: 'Yes', 'No', 'Once' |
|---|---|---|---|---|---|
| AWARD_ID | String | 1024 | Yes | The award to add the budget line to | |
| FUNDING_ID | String | 1024 | Yes | The FUNDING_ID references the Funding ID (together with the AWARD_ID) provided in the AWARD_FINANCIAL_FUNDINGS view. | |
| BUDGET_ID | String | 1024 | Yes | The BUDGET_ID references the Budget ID (together with the AWARD_ID and FUNDING_ID) provided in the BUDGET view. | |
| BUDGET_LINE | Classification value (view/edit classification configuration) | 1024 | Yes | The budget line to add the budget value for. If you do not want to provide budget against individual budget lines, please make sure the module the module is configured for this and that the budget line classification schema only contains one single classification value called Total. Please consult your Atira project manager to make sure this is setup correctly. | |
| BUDGET_VALUE | Double | Yes | The actual budget value to add to the award. If you use multiple budget lines, you have to provide a budget value for each of them. The total budget will be calculated as the sum of all of these. You do not need to provide a budget value for each of the budget lines you have specified | ||
| COST_CENTER | Classification value ( view/edit classification configuration) | 1024 | No | New in Pure 4.18.0: The cost center this budget line is associated with. Provide the URI for one of the values in the classification scheme. | |
| SPECIFICATION | String | 256 | No | New in Pure 4.18.0: A descriptive text for this budget line. | |
| FUNDER_CONTRIBUTION | Double | No | New in Pure 4.26.0: The funding contribution (GBP) NOTE: A BUDGET LINE YEARLY is needed for this to show | ||
| FEC_PERCENTAGE | Double | No | New in Pure 4.26.0: The FEC percentage |
| SQL used to check the quality of the views | Description/Comment | Applicable if |
|---|---|---|
| select * from BUDGET_LINE where AWARD_id is null or FUNDING_ID is null or BUDGET_ID is null or BUDGET_LINE is null or BUDGET_VALUE is null | Check for missing mandatory fields | |
| select * from BUDGET_LINE bl where not exists (select * from BUDGET b where bl.AWARD_ID = b.AWARD_ID and bl.FUNDING_ID = b.FUNDING_ID and bl.BUDGET_ID = b.BUDGET_ID) | Check that the corresponding budget could be found | |
| select * from BUDGET_LINE bl where not exists (select * from EXPENDITURE e where bl.AWARD_ID = e.AWARD_ID and bl.FUNDING_ID = e.FUNDING_ID and bl.BUDGET_ID = e.BUDGET_ID and bl.BUDGET_LINE = e.BUDGET_LINE) | Check that there exists at least one expenditure related to this budget line |
BUDGET_LINE_YEARLY_BUDGET (Optional, New in Pure 4.18.0)
This view provides the yearly budget for the budget lines. This view is optional and is only to be used if you want to provide yearly budgets to Pure, instead of just a total budget per budget line.
| Column name | Data type | Size | Mandatory | Note | Sync type. For each field pick on of: 'Yes', 'No', 'Once' |
|---|---|---|---|---|---|
| AWARD_ID | String | 1024 | Yes | The award to add the budget line yearly budget to | |
| FUNDING_ID | String | 1024 | Yes | The FUNDING_ID references the Funding ID (together with the AWARD_ID) provided in the AWARD_FINANCIAL_FUNDINGS view. | |
| BUDGET_ID | String | 1024 | Yes | The BUDGET_ID references the Budget ID (together with the AWARD_ID and FUNDING_ID) provided in the BUDGET view. | |
| BUDGET_LINE | Classification value (view/edit classification configuration) | 1024 | Yes | The BUDGET_LINE references the BUDGET_LINE in the BUDGET_LINE view (together with the AWARD_ID, FUNDING_ID and BUDGET_ID) provided in the BUDGET view. | |
| YEAR | Integer | Yes | The year for the budget value. Eg. 2012 | ||
| BUDGET_VALUE | Double | Yes | The actual budget value to add to the award for the specified year. If you use multiple budget lines, you have to provide a budget value for each of them. The total budget will be calculated as the sum of all of these. You do not need to provide a budget value for each of the budget lines you have specified |
EXPENDITURE (OPTIONAL)
This view provide data to the expenditure overview below.
| Column name | Data type | Size | Mandatory | Note | Sync type. For each field pick on of: 'Yes', 'No', 'Once' |
|---|---|---|---|---|---|
| AWARD_ID | String | 1024 | Yes | The award to add the expenditure to | |
| FUNDING_ID | String | 1024 | Yes | The FUNDING_ID references the the Funding ID (together with the AWARD_ID) provided in the AWARD_FINANCIAL_FUNDINGS view. | |
| BUDGET_ID | String | 1024 | Yes | The BUDGET_ID references the Budget ID (together with the AWARD_ID and FUNDING_ID) provided in the BUDGET view. | |
| BUDGET_LINE | Classification value (view/edit classification configuration) | 1024 | Yes | The budget line to add the budget value for. If you do not want to provide budget against individual budget lines, please make sure the module the module is configured for this and that the budget line classification schema only contains one single classification value called Total. Please consult your Atira project manager so make sure this is setup correctly. | |
| YEAR | Integer | Yes | The year for the expenditure value. Eg. 2012 | ||
| MONTH | Integer | Yes | The month for the expenditure value. Eg. 10 | ||
| EXPENDITURE_VALUE | Double | Yes | The actual expenditure value to add to the award. If you use multiple budget lines, you have to provide a expenditure value for each of them. The total expenditure will be calculated as the sum of all of these. You do not need to provide a expenditure value for each of the budget lines you have specified. |
| SQL used to check the quality of the views | Description/Comment | Applicable if |
|---|---|---|
| select * from EXPENDITURE where AWARD_id is null or FUNDING_ID is null or BUDGET_ID is null or BUDGET_LINE is null or YEAR is null or MONTH is null or EXPENDITURE_VALUE is null | Check for missing mandatory fields | |
| select * from EXPENDITURE e where not exists (select * from BUDGET_LINE bl where bl.AWARD_ID = e.AWARD_ID and bl.FUNDING_ID = e.FUNDING_ID and bl.BUDGET_ID = e.BUDGET_ID and bl.BUDGET_LINE = e.BUDGET_LINE) | Check for reference to non existing budget line |
Additional data
INT_AWARDHOLDERS_COMMITMENT (Optional)
This view is used to specify the internal award holders researcher commitment on the award . One row must be provided pr award holder on the award pr month.
| Column name | Data type | Size | Mandatory | Note | Sync type. For each field pick on of: 'Yes', 'No', 'Once' |
|---|---|---|---|---|---|
| AWARD_ID | String | 1024 | Yes | The project to add the award holder to. | |
| PERSON_ID | String | 1024 | Yes | The ID of the person to add as an award holder. The PERSON_ID must match one of the PERSON_ID rows provided in the person/staff synchronisation. | |
| YEAR | Integer | Yes | The year for the researcher commitment. Eg. 2012. | ||
| MONTH | Integer | Yes | The month for the researcher commitment Eg. 7 for July. | ||
| PLANNED_COMMITMENT_PERCENTAGE | Double | No | The planned researcher commitment of the award for this award holder for this month. If no value is provided the field will be set to "unspecified" in Pure, which differs from the value 0. Provided values should be between 0 and 1. | ||
| ACTUAL_COMMITMENT_PERCENTAGE | Double | No | The actual researcher commitment of the award for this award holder for this month. If no value is provided the field will be set to "unspecified" in Pure, which differs from the value 0. Provided values should be between 0 and 1. |
| SQL used to check the quality of the views | Description/Comment | Applicable if |
|---|---|---|
| select * from INT_AWARDHOLDERS_COMMITMENT where AWARD_id is null or PERSON_ID is null YEAR is null or MONTH is null | Check for missing mandatory fields | |
| select * from INT_AWARDHOLDERS_COMMITMENT c where not exists (select * from INTERNAL_AWARDHOLDERS p where p.AWARD_ID = c.AWARD_ID and p.PERSON_ID = c.PERSON_ID) | Check for reference to non existing internal award holders |
AWARD_AWARD_RELATION (Optional)
This view is used to specify the relation between different types of awards.
| Column name | Data type | Size | Mandatory | Note | Sync type. For each field pick on of: 'Yes', 'No', 'Once' |
|---|---|---|---|---|---|
| AWARD_ID | String | 1024 | Yes | ||
| TARGET_AWARD_ID | String | 1024 | Yes |
| SQL used to check the quality of the views | Description/Comment | Applicable if |
|---|---|---|
| select * from AWARD_AWARD_RELATION where AWARD_ID is null or TARGET_AWARD_ID is null or AWARD_ID = TARGET_AWARD_ID | Check for missing mandatory fields | |
| select distinct AWARD_ID from AWARD_AWARD_RELATION aap where not exists (select * from AWARD_DATA a where aap.AWARD_ID = a.AWARD_ID) | Check for reference to non existing awards | |
| select distinct TARGET_AWARD_ID from AWARD_AWARD_RELATION aap where not exists (select * from AWARD_DATA a where aap.TARGET_AWARD_ID = a.AWARD_ID) | Check for reference to non existing target awards |
AWARD_APPLICATION_RELATION (Optional)
This view is used to specify the relation between awards and applications.
| Column name | Data type | Size | Mandatory | Note | Sync type. For each field pick on of: 'Yes', 'No', 'Once' |
|---|---|---|---|---|---|
| AWARD_ID | String | 1024 | Yes | The ID of the award that you want to relate to an application. | |
| APPLICATION_ID | String | 1024 | Yes | The ID of the application that you want to be related to the award with the AWARD_ID. |
| SQL used to check the quality of the views | Description/Comment | Applicable if |
|---|---|---|
| select distinct AWARD_ID from AWARD_APPLICATION_RELATION aar where not exists (select * from AWARD_DATA a where aar.AWARD_ID = a.AWARD_ID) | Check for reference to non existing awards | |
| select distinct APPLICATION_ID from AWARD_APPLICATION_RELATION aar where not exists (select * from APPLICATION_DATA a where aar.APPLICATION_ID = a.APPLICATION_ID) | Check for reference to non existing applications |
AWARD_ACTIVITY_TYPE (Optional)
This view is used for classifying your award with one or more Nature of activity types. The Nature of activity type is a classification scheme so you can select your own value to chose from, typical examples could be "Research", "Clinical trial" etc. Since you are allowed to select more than one Nature of activity type for each award you have to supply this data in a separate view, mapping the AWARD_ID to the classification scheme value URI.
If you do not want to synchronise any Nature of activity types to your awards at all you should not implement this view
| Column name | Data type | Size | Mandatory | Note | Sync type. For each field pick on of: 'Yes', 'No', 'Once' |
|---|---|---|---|---|---|
| AWARD_ID | String | 1024 | Yes | ||
| ACTIVITY_TYPE | Classification value (view/edit classification configuration) | 1024 | Yes | Nature of activity type. Provide the classification key (e.g. "research") for one of the values in the classification scheme. |
| SQL used to check the quality of the views | Description/Comment | Applicable if |
|---|---|---|
| select * from AWARD_ACTIVITY_TYPE where AWARD_ID is null or ACTIVITY_TYPE is null | Check for missing mandatory fields | |
| select distinct AWARD_ID from AWARD_ACTIVITY_TYPE aat where not exists (select * from AWARD_DATA a where aat.AWARD_ID = a.AWARD_ID) | Check for reference to non existing awards |
AWARD_DESCRIPTIONS (Optional)
An award can have a number of descriptions. How many should be available in your system is controlled by a classification scheme. Adding more types of descriptions to your award is thus just a matter of adding more values to this classification scheme. Please note that all award will have all the description fields though.
Since you can have multiple descriptions on an award, you have to supply these via a separate view. In this you relate the AWARD_ID, description classification scheme value URI and the description itself.
If you do not want to synchronise any descriptions into your award you should not implement this view.
| Column name | Data type | Size | Mandatory | Note | Sync type. For each field pick on of: 'Yes', 'No', 'Once' |
|---|---|---|---|---|---|
| AWARD_ID | String | 1024 | Yes | The award to add the description to | |
| DESCRIPTION_TYPE | Classification value (view/edit classification configuration) | 1024 | Yes | The type of description to add. Provide the URI for one of the values in the classification scheme. | |
| DESCRIPTION_TEXT | String(*) | CLOB | Yes | The actual description text |
(*) To handle multiple languages _EN or _XX must be added to the column name.
| SQL used to check the quality of the views | Description/Comment | Applicable if |
|---|---|---|
| select * from AWARD_DESCRIPTIONS where AWARD_ID is null or DESCRIPTION_TYPE is null or DESCRIPTION_TEXT is null | Check for missing mandatory fields | |
| select distinct AWARD_ID from AWARD_DESCRIPTIONS ad where not exists (select * from AWARD_DATA a where ad.AWARD_ID = a.AWARD_ID) | Check for reference to non existing awards |
AWARD_IDS (Optional)
An award can be known by multiple ID's in different systems. This could be you award management system, costing system, the funders system (funder reference code) or similar. For each award you have to supply an AWARD_ID which will be this awards primary ID. Besides this you have the posibility to add any other ID's you would like to have stored against the award.
Which other ID's you can add to an award is controlled via a classification scheme, so you can tailor this to your specific needs.
Since you can have multiple ID's against an award, you have to supply these additional ones in a separate view. In this you relate the AWARD_ID, ID classification scheme value URI and the actual ID.
If you do not want to synchronised more ID's than the AWARD_ID you should not implement this view.
| Column name | Data type | Size | Mandatory | Note | Sync type. For each field pick on of: 'Yes', 'No', 'Once' |
|---|---|---|---|---|---|
| AWARD_ID | String | 1024 | Yes | The award to add the ID to | |
| ID_SOURCE | Classification value (view/edit classification configuration) | 1024 | Yes | The source where this ID is related to. Provide the URI for one of the values in the classification scheme | |
| ID | String | 64 | Yes | The actual ID value |
| SQL used to check the quality of the views | Description/Comment | Applicable if |
|---|---|---|
| select * from AWARD_IDS where AWARD_ID is null or ID_SOURCE is null or ID is null | Check for missing mandatory fields | |
| select distinct AWARD_ID from AWARD_IDS ai where not exists (select * from AWARD_DATA a where ai.AWARD_ID = a.AWARD_ID) | Check for reference to non existing awards |
AWARD_KEYWORDS (Optional)
This view contains the information about AWARD keywords. There is three different types of keywords you can synchronise.
- Structured keywords only. Here you must specify the LOGICAL_NAME and TYPE column to identify what keyword you want to add.
- Structured keywords and free keywords. Here you must specify LOGICAL_NAME, TYPE, and FREE_KEYWORD. Note the keyword group with the LOGICAL_NAME must support free keywords.
- Free keywords only. Here you must specify LOGICAL_NAME and FREE_KEYWORD. Note the keyword group with the LOGICAL_NAME must support free keywords without structured keywords.
Column name |
Data type |
Size |
Mandatory |
Note |
Sync type. For each field pick on of: 'Yes', 'No', 'Once' |
|---|---|---|---|---|---|
| AWARD_ID | String | 1024 | Yes | The ID for the AWARD to add this keyword. The AWARD_ID must exist in the AWARD_DATA view above. | |
| LOGICAL_NAME | String | 1024 | Yes | The logical name of the keyword group configuration in Pure, e.g. 'keywordContainers' NOTE there must exists a keyword group for AWARD which has the specified logical name | |
| TYPE | Classification | 255 | no | The type of structured keyword to add. Note you must provide the last part of the uri (key) of the classification you want to use. Note the allowed types depends on what classifications are in the keyword group with the provided logical name. I.e. if the classification scheme is Keywords (/dk/atira/pure/core/keywords) then a valid type value is 'A/AC' which will result in the keyword 'AC Collections. Series. Collected works' | |
| FREE_KEYWORD | String(*) | 1024 | no |
The free keyword to add. If no locale is specified in the column name, the keyword is added to all supported locales. If locales are provided, all supported locales must be specified To provide a locale you need to suffix the language to the column name and create a column for each supported locale. In the case of French and English this would result in the following columns: FREE_KEYWORD_EN FREE_KEYWORD_FR If locales are specified FREE_KEYWORD must not be present in your view without a locale suffix. The language should be appended in ISO 639-1 (two-letter codes) |
AWARD_LINKS (Optional)
This view contains the information about award links.
Column name |
Data type |
Size |
Mandatory |
Note |
Sync type. For each field pick on of: 'Yes', 'No', 'Once' (mandatory fields cannot be 'No') |
|---|---|---|---|---|---|
| AWARD_ID | String | 1024 | Yes | The ID of the award the link will be added to. The AWARD_ID must exist in the AWARD_DATA view above. | |
| LINK_ID | String | 1024 | Yes | The ID of the link added, if links is not available in your source system, use row index | |
| LINK_URL | String | 1024 | Yes | The Uniform Resource Locator (URL) | |
| LINK_TYPE | Classification | 255 | No | The type of URL provided, this is an optional structured classifier. You must provide the last part of the URI (the classification key) of the classification you want to use. This classification has to exists in the list of possible link types for awards in Pure |
|
| LINK_DESCRIPTION | String(*) | 1024 | No_ |
A description for the link. Descriptions has to be added for all supported submission locales in your Pure system. LINK_DESCRIPTION_EN If locales are specified LINK_DESCRIPTION must not be present in your view without a language suffix. |
AWARD_DOCUMENT - Available from Pure 5.5.x
| Column name | Data type | Size | Mandatory | Note |
|---|---|---|---|---|
| AWARD_ID | String | 1024 | Yes | The unique value for the thesis |
| DOCUMENT_ID | String | 1024 | Yes | The unique value for the student thesis document relation |
| TYPE | Classification | 1024 | Yes | Value from classification scheme /dk/atira/pure/core/document/types |
| VALUE | String/Blob | 1024 | Yes | Where to fetch the document from for example an URL. Use Blob if BYTE protocol is used |
| PROTOCOL | String | 1024 | Yes |
The following protocols are supported: BYTE, FILE & HTTP It is important that the value used is exactly identical to the above mentioned. |
| FILE_NAME | String | 1024 | No | The document filename |
| MIME_TYPE | String | 1024 | No | The document mimetype |
| FILE_TITLE | String | 1024 | No | The document title |
| VISIBILITY | String | 1024 | No |
If you want to you can set the visibility of the person. It can be either Publicly available, Campus (IP address) or Restricted to Pure users. If you supply a value it must be one of the following: public, campus, restricted If no value is specified, Publicly available will be selected automatically. |
AWARD_STATUS - Available from Pure 5.6.1 - Award management only
| Column name | Data type | Size | Mandatory | Note |
|---|---|---|---|---|
| AWARD_ID | String | 1024 | Yes | The award to add the status to |
| STATUS | String | 1024 | Yes |
The status of the award. Valid values:
Depending on the status STATUS_DATE and REASON might become required. |
| STATUS_DATE | Date | 1024 | No | The date used for describing when the award was either approved or terminated |
| REASON | String | 1024 | No |
Why the award was terminated. Valid values:
|
| REASON_DESCRIPTION | String | 1024 | No | A description of why the award was terminated. |
Published at November 17, 2023