Logging Purpose of Request

When audit logging is enabled, Cadenza logs user interactions, such as accessing workbooks or executing actions on Navigator entries. For the evaluation of these logging entries, the purpose of the user’s request may also be relevant. This purpose of request can be queried by the user and logged so that the reason for using the data can be traced at a later date. For example, logging the purpose of a request is useful if certain data can only be used for legal reasons.

The current purpose of request is displayed prominently in the Cadenza main bar and can be changed by the user at any time according to his or her current task.

Requirements

Audit logging must be enabled.
Purpose_Of_Request plugin activated
purposeofrequest settings adjusted

Adjusting the Configuration

Configuring the form for entering the query purpose

To provide the form the user enters the purpose of request, the purposeofrequest settings must be configured according to the following example:

XML
YAML
Environment Variables

purposeofrequest-config.xml configuration file

<purposeOfRequestConfiguration>
  <firstField>
    <textfield mandatory="false">
      <printName>Why do you want to use Cadenza?</printName>
      <description>You can optionally enter your purpose of request.</description>
    </textfield>
   </firstField>
   <secondField>
    <select mandatory="true">
      <printName>Select apurpose of request.</printName>
      <options>
        <option>It`s so nice and shiny.</option>
        <option>I like geo data.</option>
        <option>Can you have fun without it?</option>
      </options>
      <description>Please select the purpose of request from the list.</description>
    </select>
  </secondField>
</purposeOfRequestConfiguration>

myConfig.yaml

cadenzaconfig:
  ...
    purposeofrequest:
      firstField:
        textfield:
          mandatory: false
          printName: "Why do you want to use Cadenza?"
          description: "You can optionally enter your purpose of request."
      secondField:
        select:
          mandatory: true
          printName: "Select apurpose of request."
          description: "Please select the purpose of request from the list."
          options:
          - "It`s so nice and shiny."
          - "I like geo data."
          - "Can you have fun without it?"
  ...

Figure 1. Form example