Skip to content

Commit

Permalink
chapter sequence
Browse files Browse the repository at this point in the history
  • Loading branch information
sjvans committed Aug 23, 2023
1 parent 071afe2 commit c5990c9
Show file tree
Hide file tree
Showing 9 changed files with 21 additions and 21 deletions.
2 changes: 1 addition & 1 deletion about/features.md
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ Following is an index of the features currently covered by CAP, with status and
| [Temporal Data](../guides/temporal-data) | <X/> | <X/> | <X/> |
| [Dynamic Extensibility](../guides/extensibility/) | <X/> | <X/> | <X/> |
| Monitoring / Logging [[Node.js](../node.js/cds-log)\|[Java](../java/observability#logging)] | <Na/> | <X/> | <X/> |
| Audit Logging [[Node.js](../guides/data-privacy/audit-logging)\|[Java](../java/auditlog)] | <Na/> | <X/> | <X/> |
| Audit Logging [[Node.js](../guides/data-privacy/04_audit-logging)\|[Java](../java/auditlog)] | <Na/> | <X/> | <X/> |


<br>
Expand Down
2 changes: 1 addition & 1 deletion get-started/PARKED-using-mock-servers.md
Original file line number Diff line number Diff line change
Expand Up @@ -259,7 +259,7 @@ GET http://localhost:4004/api-business-partner/reset
* [Serving OData APIs](../advanced/odata)
* [Serving SAP Fiori UIs](../advanced/fiori)
* [Deploying to the Cloud](../guides/deployment/)
* [Adding Audit Logging](../guides/data-privacy/audit-logging)
* [Adding Audit Logging](../guides/data-privacy/04_audit-logging)
* [Using Monitoring](../advanced/monitoring) & Analytics
* Adding Tests
* [Using CI/CD](../guides/deployment/cicd)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -66,10 +66,10 @@ The most essential requests you have to answer are those in the table below, wit

| Question / Request | Discipline |
| ------------------------------------------- | -------------------------------------------------------- |
| *When was personal data stored/changed?* |[Audit Logging](audit-logging.md) |
| *What data about me do you have stored?* |[Personal Data Management](pdm.md) |
| *When was personal data stored/changed?* |[Audit Logging](04_audit-logging.md) |
| *What data about me do you have stored?* |[Personal Data Management](02_pdm.md) |
| → "Right of access to personal data" | |
| *Please delete all personal data about me!* |[Retention Management](drm.md) |
| *Please delete all personal data about me!* |[Retention Management](03_drm.md) |
| → "Right to be forgotten" | |

<br>
Expand Down Expand Up @@ -285,5 +285,5 @@ annotate Customers with {
```

::: warning _Warning_
Please see [Audit Logging](./audit-logging.md) for implications before marking data as sensitive.
Please see [Audit Logging](./04_audit-logging.md) for implications before marking data as sensitive.
:::
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ service PDMService {
```

::: tip
Make sure to have [indicated all relevant entities and elements in your domain model](introduction#indicate-privacy).
Make sure to have [indicated all relevant entities and elements in your domain model](01_introduction#indicate-privacy).
:::


Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ In essence, the steps to use that are:

In addition, custom audit logs can be recorded using the programmatic APIs.

As a prerequisite, you have to [indicate entities and elements in your domain model, which will contain personal data](introduction#indicate-privacy).
As a prerequisite, you have to [indicate entities and elements in your domain model, which will contain personal data](01_introduction#indicate-privacy).



Expand Down Expand Up @@ -78,7 +78,7 @@ annotate bookshop.Customers with @PersonalData : {
}
```

Here we again have the four levels of annotations as already described in the chapter [Indicate Personal Data in Your Domain Model](introduction#indicate-privacy).
Here we again have the four levels of annotations as already described in the chapter [Indicate Personal Data in Your Domain Model](01_introduction#indicate-privacy).

When you've annotated your (business) entity like this, the audit logs for read access and data modifications will be written automatically by the underlying CAP framework.

Expand Down Expand Up @@ -146,7 +146,7 @@ annotate bookshop.BillingData with @PersonalData : {
```

Very similarly to the section on 'Data Subject' this entity is as well annotated in four levels.
More details on these annotations can be found in the chapter [Indicate Personal Data in Your Domain Model](introduction#indicate-privacy).
More details on these annotations can be found in the chapter [Indicate Personal Data in Your Domain Model](01_introduction#indicate-privacy).

You may have noticed property `someOtherField` was not annotated. Hence, no modification will be logged.

Expand All @@ -158,7 +158,7 @@ In the section on 'Data Subject' and 'Data Subject Details' we have seen, how to
Now we have a look at classical transactional data.

In the Personal Data Terminology all transactional data like 'Sales Orders', 'Shipments', 'Payments' are summarizes under the classification 'Other', which means they are relevant for Data Privacy, but they are neither 'Data Subject' nor 'Data Subject Details'.
More details on this Terminology can be found in the chapter [Indicate Personal Data in Your Domain Model](introduction#indicate-privacy).
More details on this Terminology can be found in the chapter [Indicate Personal Data in Your Domain Model](01_introduction#indicate-privacy).

In our example we have the entity 'Orders'

Expand All @@ -172,7 +172,7 @@ entity Orders : cuid, managed {
}
```

To ensure proper audit logging we annotate using the usual four levels as described in the chapter [Indicate Personal Data in Your Domain Model](introduction#indicate-privacy).
To ensure proper audit logging we annotate using the usual four levels as described in the chapter [Indicate Personal Data in Your Domain Model](01_introduction#indicate-privacy).

```cds
annotate bookshop.Orders with @PersonalData.EntitySemantics : 'Other'
Expand Down Expand Up @@ -288,12 +288,12 @@ cds env requires.audit-log --profile production

:::

See the [Sample App](./sample-app.md) for more details.
See the [Sample App](./05_sample-app.md) for more details.


## Generic Audit Logging

[The @PersonalData annotations](introduction#indicate-privacy) are all we need to automatically log personal data-related events. Let's see that in action…
[The @PersonalData annotations](01_introduction#indicate-privacy) are all we need to automatically log personal data-related events. Let's see that in action…
1. **Start the server** as usual:
Expand Down
File renamed without changes.
4 changes: 2 additions & 2 deletions guides/security/data-protection-privacy.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,9 +55,9 @@ Also refer to related guides of most important platform services:

CAP provides several [features](../data-privacy/) to help applications meet DPP-requirements:

- The [Personal Data Management (PDM)](../data-privacy/pdm) integration has a configurable **retrieval function**, which can be used to inform data subjects about personal data stored related to them.
- The [Personal Data Management (PDM)](../data-privacy/02_pdm) integration has a configurable **retrieval function**, which can be used to inform data subjects about personal data stored related to them.
- CAP also provides a *fully model-driven* approach to track **changes in personal data** or **read access to sensitive personal data** in the audit log.
Having [declared personal data](../data-privacy/introduction#indicate-privacy) in your model, CAP automatically triggers corresponding [audit log events](../data-privacy/audit-logging).
Having [declared personal data](../data-privacy/01_introduction#indicate-privacy) in your model, CAP automatically triggers corresponding [audit log events](../data-privacy/04_audit-logging).

::: warning
❗ So far, applications have to integrate [SAP Data Retention Manager](https://help.sap.com/docs/DATA_RETENTION_MANAGER) to implement an adequate **erasure function** for personal data out of retention period.
Expand Down
10 changes: 5 additions & 5 deletions menu.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,11 +45,11 @@
- [Temporal Data](guides/temporal-data)
- [Media Data](guides/media-data)
- [Data Privacy](guides/data-privacy/)
- [Basics](guides/data-privacy/introduction)
- [Personal Data Management](guides/data-privacy/pdm)
- [Data Retention Management](guides/data-privacy/drm)
- [Audit Logging](guides/data-privacy/audit-logging)
- [Sample App](guides/data-privacy/sample-app)
- [Basics](guides/data-privacy/01_introduction)
- [Personal Data Management](guides/data-privacy/02_pdm)
- [Data Retention Management](guides/data-privacy/03_drm)
- [Audit Logging](guides/data-privacy/04_audit-logging)
- [Sample App](guides/data-privacy/05_sample-app)

### [Advanced](advanced/)

Expand Down

0 comments on commit c5990c9

Please sign in to comment.