Testing an import integration in the customer test environment

Plan to test for the use cases of your organisation.

Do not submit personal or confidential data to the test environment.

Personal data include:

• person’s name
• personal email address
• telephone number
• other identifying information.

The customer test environment is shared between many organisations, which means it also contains test data from other organisations.

If you only import a part of your data set through the API, take account of this in planning your tests. For instance, if you only import your service locations, describe the services in the user interface and make sure that the connections are appropriately established through the API or the user interface.

Technical testing ensures that the integration is technically functional and that the data is transferred according to the specifications. It is done to identify and correct possible errors and eliminates any errors that might prevent the deployment to production.

Test every content type that you intend to import to the FSC with your integration. The integration may be used to import:

• services
• service channels
• service collections
• sub-organisations
• connections and related auxiliary information.

Please note that API version 12 only allows published content to be imported and updated.

Use the business rules to plan your test cases.

Plan and carry out your tests

Make sure of the following:

1. the API connection is functional (e.g. access rights and firewall whitelists);
2. adding and updating data works for all available content types. Take note of the business rules and error messages. See the following: Additional information for import integrators, Data update logic for more;
3. archiving of data that has been deleted from the source system is successful;
4. retrieval of archived data is functional. See Additional information for import integrators, Archiving and retrieval for more;
5. errors are handled successfully. Document any incidents, analyse the causes, and implement the necessary fixes;
6. the service times are recorded correctly (see Business rules for service times);
7. multilingual content is recorded correctly;
8. data transfer is successful with the organisation’s typical use cases and normal data volumes.

Plan and carry out appropriate additional tests

• Test the creation of links for adding accessibility information for a service location.

If you are using an ID for an external source system (externalId) to create content:

• Test the creation of content with the externalId. The content types that allow this are organisation, service, and service channel.
• Also test that the externalId-contentId matching works and that the contentId can be used to update data.

Plan for exception management

Plan and describe the procedures to identify, handle and correct exceptions for production use as well.

Possible methods include:

• error log tracking
• monitoring of interface calls
• data transfer reconciliation
• other quality assurance practices.

In the case of an exception or error, make sure that you can identify:

• the content that caused the error;
• the related API call.

Report the results of technical testing to the Agency.

• Use the reporting instructions and template for your report: Integration Technical Readiness Report Template (DOCX, 221.72 kB)Opens in a new window.
• Prepare your test report and submit it to the Digital and Population Data Services Agency at ptv-tuki@dvv.fi.
• The Agency will use the report to consider if your technical testing is sufficient to grant you production IDs to the import API.
• After successful completion of technical testing and new rounds of tests are no longer required, you may proceed to the next stage of testing, which is the responsibility of your organisation’s FSC main user.

Content testing ensures that the data imported to the FSC are:

• equivalent with the source system data;
• up to date;
• compliant with the content and quality requirements of the FSC;
• clear and understandable to the customer.

Correct any deviations in quality in the source system and ensure that they are reflected in the FSC.

You can only deploy your integration to production after clearing all open deviations in quality.

Plan for testing

Test every content type that you intend to import to the FSC with your integration.

The import integration can be used to import:

• services
• service channels
• service collections
• sub-organisations
• connections and related auxiliary information.

Before testing, plan for:

• whether you will check the full data set or a representative sample of different content types;
• which user roles you will need for your tests.

In most cases, the main user role is sufficient.

Verify the information content of your data.

• The service and service channel descriptions are clear, grammatically correct and customer-oriented.
• The service descriptions do not contain addresses, phone numbers, web addresses or other service channel information.
• General descriptions have been correctly connected to the services when they have been used.
• If general descriptions have been used, information in them has not been copied to a separate service description, supplementing the general description instead with an original description.
• All necessary connections have been made between the services and the service channels.
• The service hours, addresses and other details of the service channels are displayed correctly.
• The additional connection information between the service and the service channel is displayed correctly.
• Any machine-generated content is easy to understand and customer-oriented.

Process your findings and deviations

Make sure that the corrections to the content are made in the source system and the impact of the corrections are tested.

Submit your report on content quality

• Once you complete the content quality tests, compile your results into a report and submit it to the Digital and Population Data Services Agency.
• Use the content quality reporting instructions and template for your report: Integration Data Content Quality Report Template (DOCX, 219.11 kB)Opens in a new window.
• The Agency will use your report to assess if your organisation can be granted production IDs to the import API based on content quality assurance.
• In the template, remove sections that do not apply to your integration or leave them blank.

If new iterations of tests are no longer required, the Agency will send the import API production IDs (API account) to the email address noted in the import API access licence application.

Use the test IDs below when testing the PTV API in the customer test environment.

API username: api-1-test.ptv@dvv.fi 
Password: !.WM@nwRKeKd2h78 
Organisation name: Esimerkkilän kaupunki (TESTI) 
Organisation ContentId: 1c0c203c-9d10-4e9e-be33-527da7bc239f 

API username: api-2-test.ptv@dvv.fi 
Password: h9ioheZ8Kos!c_K* 
Organisation name: Kuvitteellinen rannikkolupavirasto, Lounais-Suomen toimipiste (TESTI) 
Organisation ContentId: 1872dc19-b05a-4531-bf86-2720cb378e8a 

API username: api-3-test.ptv@dvv.fi 
Password: q67!kbyD9V8T92BQ 
Organisation name: Kuvitteellinen vesihuoltokuntayhtymä (TESTI) 
Organisation ContentId: 7e212fd1-c0a0-48d5-929b-0af2167738e1 

API username: api-4-test.ptv@dvv.fi 
Password: 6CJ2VdCUpkHPw!!E 
Organisation name: Kuvitteellinen luonnonsuojeluyhdistys ry (TESTI) 
Organisation ContentId: 0b687cfa-2b9b-461f-a807-b31e97b53b6c 

API username: api-5-test.ptv@dvv.fi 
Password: o*WVnivFyWmBnv2X 
Organisation name: Kuvitteellinen Kotihoito Oy (TESTI) 
Organisation ContentId: 81be58dc-b3b3-43a6-8231-c9586c05a08e 

NB! The user interface for API version 12 is not available yet for the customer test environment. We will announce the schedule later. 

To be specified later.