Create Collection Point

This section covers how to create a collection point within your application using the Concur consent management system.

Overview

A collection point refers to a location or page in your application where personal user data is collected, along with the specific purposes for which this data will be used. The npx let-create-collection-point command facilitates the creation of collection points and updates the configuration accordingly.

Prerequisites

Before creating a collection point, ensure that you have:

• Created an application using the npx let-create-application command.

• Ensure that you have .env file with the app_id and previously generated environment variables during the previous creation processes.

Command

To create a collection point, use the following command:

npx let-create-collection-point

Input Parameters

During the execution of npx let-create-collection-point, you will be prompted to input various details related to the collection point:

1. Collection Point Name: Enter the name of the collection point (e.g., "Shopping Page").

2. Data Elements:

   • Enter the variable name(s) that will be used in your application to capture user data (e.g., home_address).

   • For each data element, provide:

     • Title: A user-friendly name for the data element (e.g., "Home Address").

     • Description: A brief description of the data element.

     • Data Owner: The owner(s) of the data element. This can be multiple values.

   • You will be asked if you want to add more data elements; if yes, repeat the process.

3. Consent Expiry Period:

   • Enter the number of days after which the consent expires (e.g., 30 days).

4. Retention Period:

   • Enter the number of days the data element will be retained (e.g., 160 days).

5. Purpose Description:

   • Enter the purpose(s) for collecting the data. This can include multiple purposes, and you will be asked if you want to add more.

Post-Command Updates

consent-template.yaml File

After completing the above steps, the consent-template.yaml file in your project directory will be updated with the details of the new collection point. Below is an example structure of the updated YAML file:

version: "1.0"
organisation_id: "org_id(hexadecimal)"
applications:
  - application_id: "app_id(hexadecimal)"
    type: "web app"
    name: "flipboo"
    stage: "development"
    application_user: "global"
    collection_points_data:
      - cp_id: "6698c6a1bd6d113ade6d8ac4"
        cp_name: "mastibolo"
        cp_status: "active"
        cp_url: "acitve.com"
        data_elements:
          - data_element: "<Blank>"
            data_element_collection_status: "active"
            data_element_title: "address"
            data_element_description: "<Blank>"
            data_owner: "<Blank>"
            legal_basis: "<Blank>"
            retention_period: "<Number> <days, month, year>"
            cross_border: false
            sensitive: false
            encrypted: false
            expiry: "<Number> <days, month, year>"
            purposes:
              - purpose_description: "<masti>"
                purpose_language: "<EN, EU, HIN>"

YAML Structure Breakdown

• version: The version of the consent template format.

• organisation_id: The unique identifier for your organization.

• applications: A list of applications managed by your organization, with each application having:

• collection_points_data: A list of collection points within the application, each containing

• cp_id: A unique identifier for the collection point.

• cp_name: The name of the collection point.

• cp_status: Indicates if the collection point is active.

• cp_url: The URL where the collection point can be customized.

• data_element: The variable or field name used in your application.

• data_element_title: A human-readable name for the data element.

• data_element_description: A brief description of the data element.

• data_element_collection_status: Indicates if the data element is active.

• data_owner: Specifies who owns the user data.

• legal_basis: An internal value that provides the legal justification for data collection.

• retention_period: Specifies how long the data will be retained.

• expiry: Specifies when the data element will become inactive.

• cross_border: Indicates whether the data will be shared with third parties.

• sensitive: Indicates if the data is sensitive.

• encrypted: Indicates if the data is encrypted.