docs(pi-cli): Add the anonymization documentation #3
Conversation
|
🎊 PR Preview 23d52ef has been successfully built and deployed to https://bonitasoft-bonita-process-insights-doc-build_preview-pr-3.surge.sh 🕐 Build time: 0.008s
🤖 By surge-preview |
📝 Check the pages that have been modifiedIn order to merge this pull request, you need to check your updates with the following url. 🔍 Updated pagesThe following pages were updated, please ensure that the display is correct: |
mbource
changed the title
|
🎊 PR Preview 4257612 has been successfully built and deployed to https://bonitasoft-bonita-process-insights-doc-deploy-pr-3.surge.sh 🕐 Build time: 0.008s
🤖 By surge-preview |
modules/cli/pages/index.adoc
Outdated
| database: | ||
| host: localhost | ||
| port: 5432 | ||
| name: bonita | ||
| username: bonita | ||
| password: bpm | ||
| jdbc-url: myJdbcUrl |
There was a problem hiding this comment.
question: can we avoid to duplicate the documentation here and mention that this is available in the documentation embeeded in the distribution?
This risks to be a maintenance issue if we duplicate the content.
There was a problem hiding this comment.
I remove the configuration sample part to avoid duplication/maintenance changes. I did keep the jdbc url explanation for the different database, should I remove it too?
| Remove the whole data line ( only possible on data contract and comment ) | ||
|
|
||
| *Parameters* : | ||
| optional where clause expressed as a regex to match with the value for the configured column. |
There was a problem hiding this comment.
thought: the where clause applies to all actions, so we could document it and give examples in all documented actions
Its configuration also changed recently in PR 352, and it can now be used like this:
arch_contract_data:
val:
actions:
- action: REMOVE_LINE
where:
- column: name
regex: PurchasedLicenseInput\.bypassSysDate
- column: name
regex: PurchasedLicenseInput\.caseCounterStartDate
- column: name
regex: PurchasedLicenseInput\.description
- column: name
regex: PurchasedLicenseInput\.endDate
- column: name
regex: PurchasedLicenseInput\.name
- column: name
regex: PurchasedLicenseInput\.numberCases
- etc. ...There was a problem hiding this comment.
I've changed the configuration sample.
For the rest, how do we document it properly the where clause? How can it be used outside of arch_contract_data? Because it's mostly useful for this table because of the keys.
There was a problem hiding this comment.
@mbource i think it misse some words about maxSize defined by default to 512 as global option. The max size allow to truncate a big text. MasSize could be define also on each action. But it really use for KEEP and Replace.
Add the anonymization documentation for the export tool PI-CLI.
Covers https://bonitasoft.atlassian.net/browse/BON-337