diff --git a/CHANGELOG.md b/CHANGELOG.md index 87505881a..74c048e88 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,22 @@ sheets becomes or updates a module, its vendor, a usage for the municipality and a contact person for its owner; a repeat import matches on APPID, so it updates instead of duplicating. See `docs/features/cmdb-import.md`. +- CMDB import: on an OpenRegister with the migration-pack editor + (openregister#4602), the import runs the mapping packs kept in + OpenRegister's migration pack store, where an administrator edits them. + The `SeedCmdbImportPacks` repair step stores them on install and upgrade; + a pack nobody edited follows newer releases, an edited one is kept. + Viewing the mapping writes nothing. An older OpenRegister keeps the packs + that ship with stackiq. +- CMDB import, repeat imports: applications that left the CMDB sheets are + archived when the sheet "Gearchiveerde Applicaties" lists them and moved to + OpenRegister's trash when no sheet does; one that returns is unarchived or + restored, never duplicated. The new option `missingRecords` (`archive`, the + default, or `keep`) is a choice in the CMDB import section, and the report + counts archived, unarchived, deleted and restored applications. The module + (0.3.9) and usage (1.5.7) schemas opt into OpenRegister's archive state, and + the Applications and Applications in use pages get an "Archived" quick + filter. (cmdb-import-archive-reconciliation) ### Changed - EOL feed: the register and schema slugs the feature reads from are corrected. diff --git a/appinfo/info.xml b/appinfo/info.xml index 895cb48bc..aa719115b 100644 --- a/appinfo/info.xml +++ b/appinfo/info.xml @@ -50,7 +50,7 @@ Vrij en open source onder de EUPL-licentie. **Ondersteuning:** Voor ondersteuning, neem contact op via support@conduction.nl. Voor een Service Level Agreement (SLA), neem contact op via sales@conduction.nl. ]]> - 0.2.5-unstable.20261008120000 + 0.2.6-unstable.20261012120000 EUPL-1.2 Conduction Stackiq @@ -250,6 +250,14 @@ Vrij en open source onder de EUPL-licentie. instead of failing. --> OCA\Stackiq\Repair\RenameDutchCatalogValues + + OCA\Stackiq\Repair\SeedCmdbImportPacks OCA\Stackiq\Repair\RepointEolSyncConfig OCA\Stackiq\Repair\InitializeSettings + + OCA\Stackiq\Repair\SeedCmdbImportPacks diff --git a/appinfo/routes.php b/appinfo/routes.php index 0eab59877..5558d9de5 100644 --- a/appinfo/routes.php +++ b/appinfo/routes.php @@ -109,6 +109,9 @@ // @spec openspec/changes/cmdb-export-import/tasks.md#task-8 ['name' => 'cmdbImport#import', 'url' => '/api/cmdb-import', 'verb' => 'POST'], ['name' => 'cmdbImport#cancel', 'url' => '/api/cmdb-import/{operationId}/cancel', 'verb' => 'POST'], + // The mapping the CMDB import uses, read-only — same posture as the import (Nextcloud admins only, CSRF). + // @spec openspec/changes/cmdb-import-mapping-view/specs/cmdb-export-import/spec.md#requirement-the-admin-settings-shall-show-the-mapping-the-import-uses-req-cmdb-020 + ['name' => 'settings#getCmdbImportMapping', 'url' => '/api/settings/cmdb-import/mapping', 'verb' => 'GET'], // User Groups management routes ['name' => 'settings#getGenericUserGroups', 'url' => '/api/settings/user-groups/generic', 'verb' => 'GET'], diff --git a/composer.lock b/composer.lock index b046bd3af..0ad6814c4 100644 --- a/composer.lock +++ b/composer.lock @@ -9968,16 +9968,16 @@ }, { "name": "symfony/yaml", - "version": "v6.4.40", + "version": "v6.4.48", "source": { "type": "git", "url": "https://github.com/symfony/yaml.git", - "reference": "68dcd1f1602dac9d9221e25729683e0ce8733f3b" + "reference": "91288fddb497a598b564343ea663ea272370a7dc" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/symfony/yaml/zipball/68dcd1f1602dac9d9221e25729683e0ce8733f3b", - "reference": "68dcd1f1602dac9d9221e25729683e0ce8733f3b", + "url": "https://api.github.com/repos/symfony/yaml/zipball/91288fddb497a598b564343ea663ea272370a7dc", + "reference": "91288fddb497a598b564343ea663ea272370a7dc", "shasum": "" }, "require": { @@ -10020,7 +10020,7 @@ "description": "Loads and dumps YAML files", "homepage": "https://symfony.com", "support": { - "source": "https://github.com/symfony/yaml/tree/v6.4.40" + "source": "https://github.com/symfony/yaml/tree/v6.4.48" }, "funding": [ { @@ -10040,7 +10040,7 @@ "type": "tidelift" } ], - "time": "2026-05-19T20:33:22+00:00" + "time": "2026-10-12T09:18:28+00:00" }, { "name": "theseer/tokenizer", diff --git a/docs/features/README.md b/docs/features/README.md index 7fa964f0a..c57ff8486 100644 --- a/docs/features/README.md +++ b/docs/features/README.md @@ -158,7 +158,7 @@ The ArchiMate integration maps GEMMA Softwarecatalogus objects to ArchiMate appl ## CMDB Import -Import a TOPdesk CMDB export (`.xlsx`) for one municipality from the **CMDB import** section of the admin settings. Every application row of the two CMDB sheets ("Onbeh Applicaties CMDB" and "Beheerde Applicaties CMDB") becomes or updates a module, its vendor as a Supplier organisation, a usage that links it to the municipality and records whether maintenance is arranged, and a contact person for its owner (identity in Nextcloud Contacts, never public). A repeat import matches on APPID per municipality, so it updates instead of duplicating, and leaves applications missing from the newer export as they are. The column mapping is declarative JSON executed by OpenRegister's mapping engine. +Import a TOPdesk CMDB export (`.xlsx`) for one municipality from the **CMDB import** section of the admin settings. Every application row of the two CMDB sheets ("Onbeh Applicaties CMDB" and "Beheerde Applicaties CMDB") becomes or updates a module, its vendor as a Supplier organisation, a usage that links it to the municipality and records whether maintenance is arranged, and a contact person for its owner (identity in Nextcloud Contacts, never public). A repeat import matches on APPID per municipality, so it updates instead of duplicating. By default it archives the applications that moved to the sheet "Gearchiveerde Applicaties" and moves those on no sheet any more to OpenRegister's trash, and brings either back when it returns; the admin can choose to keep them instead. The Applications and Applications in use pages list the archive under the quick filter "Archived". The column mapping is declarative JSON executed by OpenRegister's mapping engine. See [CMDB import](cmdb-import.md) for the steps, the expected file structure, the error codes and how to adjust the mapping. diff --git a/docs/features/cmdb-import.md b/docs/features/cmdb-import.md index b9d505abc..b54fad71e 100644 --- a/docs/features/cmdb-import.md +++ b/docs/features/cmdb-import.md @@ -17,9 +17,11 @@ updates: in Nextcloud Contacts. Owners are never readable by the public. All of it is stored as OpenRegister objects in the stackiq register. Import a -newer export later and the same applications are updated, not duplicated. +newer export later and the same applications are updated, not duplicated; +applications that left the export are archived or moved to the trash (see +[Repeat imports](#repeat-imports)). -Specification: [`openspec/specs/cmdb-export-import/spec.md`](https://github.com/ConductionNL/stackiq/blob/development/openspec/specs/cmdb-export-import/spec.md) (change archived in [`openspec/changes/archive/2026-10-05-cmdb-export-import/`](https://github.com/ConductionNL/stackiq/tree/development/openspec/changes/archive/2026-10-05-cmdb-export-import)). +Specification: [`openspec/specs/cmdb-export-import/spec.md`](https://github.com/ConductionNL/stackiq/blob/development/openspec/specs/cmdb-export-import/spec.md) (change archived in [`openspec/changes/archive/2026-10-05-cmdb-export-import/`](https://github.com/ConductionNL/stackiq/tree/development/openspec/changes/archive/2026-10-05-cmdb-export-import); archiving and deleting on a repeat import in [`openspec/changes/cmdb-import-archive-reconciliation/`](https://github.com/ConductionNL/stackiq/tree/development/openspec/changes/cmdb-import-archive-reconciliation)). ## Who can import @@ -77,9 +79,16 @@ page in stackiq. and the summary counts them as *created unpublished*. Applications that were imported before keep their publication as it is, whichever you choose. -6. Press **Import**. A progress bar shows how many rows have been processed. - **Cancel import** stops the import before the next row; rows that were - already processed stay imported. The section says whether the server +6. **Applications missing from the export.** **Archive or delete them** is + the default: an application of this municipality that is on neither CMDB + sheet any more is archived or moved to the trash after the last row (see + [Repeat imports](#repeat-imports)). Choose **Keep them as they are** to + leave such applications untouched. +7. Press **Import**. A progress bar shows how many rows have been processed. + **Cancel import** stops the import before the next row, or, while the + applications are compared with the export, before the next application; + what was already processed stays: the rows imported, and the applications + archived or deleted so far. The section says whether the server accepted the cancel; one pressed before the server has started on the rows cannot take effect yet, and the section says so. @@ -92,11 +101,16 @@ When the import finishes, the section shows: - the **summary**: rows read, created, updated, unchanged, skipped, failed and warnings, and, when publishing was off, how many applications were - created unpublished; + created unpublished; after a repeat import also how many applications + were archived, unarchived, deleted (moved to the trash) or restored, when + there are any. The sentence above it, which a screen reader announces, + names those counts too, for example *Applications: 1 archived, 1 deleted.*; - **warnings for the whole file**, for example an optional column that is missing; - the **rows** table: sheet, row number, APPID, application, outcome, - and the reasons and warnings for that row. Filter it with **Show rows with + and the reasons and warnings for that row. An application archived or + deleted because it left the export has no row number; its sheet is + `Gearchiveerde Applicaties` when that sheet listed it. Filter it with **Show rows with outcome**, and sort it by clicking a column header. It shows 100 rows at a time; **Show 100 more rows** adds the next ones. The application name links to the module in stackiq. @@ -106,8 +120,15 @@ the same organisation. ## The file -The import reads the two CMDB sheets of the export and ignores all others, -including the `Invoer` sheets they are derived from: +The import reads the two CMDB sheets of the export, and of the sheet +`Gearchiveerde Applicaties` only the `APPID` column (see +[Repeat imports](#repeat-imports)). It ignores all other sheets, including +the `Invoer` sheets they are derived from. The archive sheet is read in every +import, also with **Keep them as they are**, and it is bounded like the two +CMDB sheets (see [Limits](#limits)): an archive sheet over the limits refuses +the import even when you keep missing applications. Delete the sheet from a +copy of the export to import it without one; the import then archives and +never deletes. | Sheet | What it holds | Recorded on the usage | |---|---|---| @@ -120,8 +141,8 @@ surrounding spaces and a trailing `:` or `⚡` do not matter, and the order of the columns does not matter. A column that one sheet has and the other has not (such as `Nickname`, only on `Beheerde Applicaties CMDB`) is optional on the sheet that lacks it. Empty rows, including formatted rows below the data, -are ignored and not counted. A sheet may hold at most 10,000 rows with data -by default (see [Limits](#limits)). +are ignored and not counted. A sheet, the archive sheet included, may hold at +most 10,000 rows with data by default (see [Limits](#limits)). Two columns are **required** on every CMDB sheet that is present: `APPID` and `Applicatie Naam`. Every other column is optional; when one is missing, @@ -150,6 +171,10 @@ date stored there, including one set by hand. ### Columns and where they go +This is the mapping as it ships. On an OpenRegister with the migration-pack +editor an administrator can change it there (see +[Viewing and editing the mapping](#viewing-and-editing-the-mapping)). + | Column | Goes to | Rule | |---|---|---| | APPID | module external number, and the match key | required, see [Repeat imports](#repeat-imports) | @@ -213,9 +238,9 @@ colliding. - **Known APPID, nothing changed**: nothing is saved; the row is reported as *unchanged*. Importing the same export twice creates nothing the second time. -- **APPID missing from a newer export**: the application, its usage and - its contact persons are left as they are. They are not changed, depublished - or deleted. +- **APPID missing from a newer export**: see + [Applications that left the export](#applications-that-left-the-export) + below. - Each application keeps exactly one usage for the municipality. - **Known APPID, but the application belongs to another organisation**: an application found by its match key is only updated when the municipality @@ -243,6 +268,61 @@ OpenRegister refuses to save it, that row is reported as *failed* with the step that failed, and the other rows are imported. Importing again completes the failed row. +### Applications that left the export + +With **Archive or delete them** (the default; `missingRecords=archive` in +the API), the import compares the municipality's applications with the +export after the last row. It looks only at the municipality's own usages +and the applications its import created, never at an application only +another organisation uses or one added by hand. For an application whose +APPID is on neither CMDB sheet: + +| The APPID is | The application and its usage | +|---|---| +| on the sheet `Gearchiveerde Applicaties` | are **archived**: OpenRegister's archive state, with the reason `cmdb-import: on sheet "Gearchiveerde Applicaties"`. Reported as *archived*. | +| on no sheet at all | are **deleted**: moved to OpenRegister's trash, where they stay restorable for 30 days. Reported as *deleted*. | +| on no sheet, but the archive sheet cannot be relied on: the workbook has no sheet `Gearchiveerde Applicaties`, the sheet has no `APPID` column, or an `APPID` in it has no cached value (a formula whose result the file does not store), or an `APPID` on one of the two CMDB sheets has no cached value (the import cannot tell which application that row stands for) | are **archived**, never deleted. Each case has its own warning in the result: *sheet not found*, *no column APPID*, or *an APPID without a cached value in row …* (for more rows: *in N rows (…)*, naming the first ten; for a CMDB sheet the warning names that sheet). Such a workbook therefore never moves anything to the trash. | + +An archived or deleted application disappears from the stackiq lists, from +OpenCatalogi and from Portaliq's **Software we use**. In stackiq, the quick +filter **Archived** on the **Applications** and **Applications in use** pages +lists the archive. On the **Applications** page the **Archived** tab lists +the whole archive: it ignores the GEMMA filters (the page says so in a note above the list while that tab is active), because +their counts and matches describe the working set, which leaves archived +applications out. The search in the **Search** sidebar does apply to that tab. An OpenCatalogi caller finds archived applications by +adding `_archived=true` to its request. Contact persons are never archived +or deleted: an owner is shared with the municipality's other applications. +An application that is already in the state the export asks for is left +alone and not reported again. + +When an archived or deleted application **returns** in a later export, it is +taken out of the archive (*unarchived*) or out of the trash (*restored*), +and then updated as usual. No second application is created. With **Update +existing records** off, it is skipped as `exists` and stays archived or in +the trash. When an application was deleted by hand and a later import +created it again, the working one is updated and the deleted one stays in +the trash. + +The comparison runs only when the import went through all rows: an import +cancelled or failed before the comparison archives or deletes nothing. +**Cancel import** during the comparison stops it before the next +application; what was archived or deleted until then stays so, and the +result lists it. During the comparison the progress line reads +*Checking the applications of this municipality against the export* without +a count, and the bar stays full: the comparison covers every application of +the municipality, not only the ones missing from the export, so its length +is not known in rows. Each +application is handled on its own; one that cannot be archived is reported +as *failed* with the step (`archive`, `restore` or `delete`) and the others +continue. Archiving needs module schema 0.3.9 and usage schema 1.5.7 or +later, which declare that their objects can be archived; on an older register configuration each application fails +with the step `archive`, and **Force Update** at the top of the stackiq admin +settings fixes it. + +With **Keep them as they are** (`missingRecords=keep`), the application, its +usage and its contact persons are left as they are: not changed, archived, +depublished or deleted. + ## Owners The owner becomes a **contact person of the municipality**, never a @@ -281,20 +361,21 @@ and the section shows the reason and the error code. | Error code | What it means | What to do | |---|---|---| | `NOT_XLSX` | The file is not an Excel workbook: wrong extension, or the content is not an `.xlsx` package. | Save the export as Excel workbook (`.xlsx`). | -| `FILE_TOO_LARGE` | The file is larger than the upload limit (10 MB by default). The message names the limit in force. | Remove sheets the import does not read, or split the export. | +| `FILE_TOO_LARGE` | The file is larger than the upload limit (10 MB by default). The message names the limit in force. | Remove sheets the import does not read. Or split the export and import every part with **Keep them as they are**: an import that archives treats the applications of the other parts as missing. Applications that left the export are then not archived or deleted. | | `NO_FILE_UPLOADED` | No file arrived. | Choose the file again. | | `MUNICIPALITY_REQUIRED` | No municipality was chosen. | Pick or type a municipality. | | `MUNICIPALITY_INVALID` | The chosen organisation does not exist or is not of type Municipality. | Pick an organisation of type Municipality, or type a new name. | | `NO_SOURCE_SHEET` | Neither `Onbeh Applicaties CMDB` nor `Beheerde Applicaties CMDB` is in the workbook. | Check the sheet names; they must match exactly. | | `MISSING_COLUMN` | A present CMDB sheet has no `APPID` or `Applicatie Naam` column. The message names the sheet and the column. | Add the column to that sheet. | -| `TOO_MANY_ROWS` | A CMDB sheet has more rows with data than the row limit (10,000 by default). The message names the sheet and the limit. | Split the export and import the parts one after the other. | -| `WORKBOOK_TOO_LARGE` | Unpacked, the workbook is larger than the import reads: 50 MB in all, 10 MB for one sheet the import reads or for the table of texts the sheets share, or more than 200,000 different texts, by default. Sheets the import does not read may be larger than 10 MB. An `.xlsx` is a compressed package, so a file of a few MB can unpack to far more. The message names the limit, and for a sheet the sheet and its unpacked size. | For a sheet that is too large: split its rows over two copies of the export and import them one after the other. For a workbook that is too large in all: delete the sheets the import does not read from a copy and import that copy. | +| `TOO_MANY_ROWS` | A CMDB sheet has more rows with data than the row limit (10,000 by default). The message names the sheet and the limit. | Split the export and import the parts one after the other with **Keep them as they are**: an import that archives treats the applications of the other parts as missing. Applications that left the export are then not archived or deleted. | +| `WORKBOOK_TOO_LARGE` | Unpacked, the workbook is larger than the import reads: 50 MB in all, 10 MB for one sheet the import reads (the two CMDB sheets and the archive sheet, in every import) or for the table of texts the sheets share, or more than 200,000 different texts, by default. Sheets the import does not read may be larger than 10 MB. An `.xlsx` is a compressed package, so a file of a few MB can unpack to far more. The message names the limit, and for a sheet the sheet and its unpacked size. | For a sheet that is too large: split its rows over two copies of the export and import both with **Keep them as they are**. For a workbook that is too large in all: delete the sheets the import does not read from a copy and import that copy. | | `MUNICIPALITY_AMBIGUOUS` | More than one municipality has the typed name. The import does not guess which one. | Pick the municipality from the list instead of typing its name. | | `IMPORT_IN_PROGRESS` | Another CMDB import is running. Only one import runs at a time. | Wait until it has finished and try again. | | `FIELD_INVALID` | A form field of the request has a value the import does not accept, for example an `updateExisting` or `publish` that is neither `true` nor `false`. The message names the field. | Not reachable from the section; reported for API callers. | | `UPLOAD_FAILED` | The file reached the server but could not be stored there. | Try again; the Nextcloud log has the details. | -| `MISSING_RECORDS_UNSUPPORTED` | The request asked to mark or remove records missing from the export. Only keeping them is supported. | Not reachable from the section; reported for API callers. | -| `MAPPING_UNAVAILABLE` | OpenRegister's mapping engine is missing, or one of the mapping files is invalid. | Update OpenRegister. If you changed a mapping file, check it against the Nextcloud log. | +| `MISSING_RECORDS_UNSUPPORTED` | The request asked for something other than `keep` or `archive` for records missing from the export, for example `mark` or `remove`. The details list the accepted values. | Not reachable from the section; reported for API callers. | +| `ARCHIVE_UNAVAILABLE` | **Archive or delete them** was chosen, but the OpenRegister on this server cannot archive or restore objects (it is missing or too old). Nothing was read or written. | Choose **Keep them as they are** and import again, or update OpenRegister. | +| `MAPPING_UNAVAILABLE` | OpenRegister's mapping engine or pack store is missing, or a mapping pack is invalid or breaks a rule of the import. The message names the pack when one is at fault. | Update or enable OpenRegister. If you changed a pack, correct it in OpenRegister; see [Viewing and editing the mapping](#viewing-and-editing-the-mapping). | | `READER_UNAVAILABLE` | The Excel reader that ships with OpenRegister cannot be loaded. | Make sure OpenRegister is installed and enabled. | | `NOT_CONFIGURED` | The stackiq register or its schemas cannot be found. | Run **Auto Configure** at the top of the stackiq admin settings. | | `SCHEMA_OUTDATED` | A stackiq schema lacks a property the import recognises records by, for example `externalKey` on the module schema, or the module schema is older than version 0.3.8: it has no `applicationType`, or `externalKey` lacks the rule that only an administrator may change it. Importing anyway would create every application again, or leave the import key open to every editor. The message names the schema. | Press **Force Update** at the top of the stackiq admin settings to import the register configuration again. | @@ -322,44 +403,132 @@ every import: | Setting | Default | What it limits | |---|---|---| | `maxFileBytes` | `10485760` (10 MB) | the size of the uploaded file | -| `maxRowsPerSheet` | `10000` | the rows with data on one CMDB sheet | +| `maxRowsPerSheet` | `10000` | the rows with data on one CMDB sheet, and on the archive sheet | | `maxUncompressedBytes` | `52428800` (50 MB) | the size of the workbook once unpacked, checked before a sheet is parsed | -| `maxPartBytes` | `10485760` (10 MB) | the size of one part the import parses once unpacked, such as a source sheet or the shared-strings table, checked before a sheet is parsed; a sheet the import does not read may be larger, and is read as an empty sheet | +| `maxPartBytes` | `10485760` (10 MB) | the size of one part the import parses once unpacked, such as a source sheet or the shared-strings table, checked before a sheet is parsed; a sheet the import does not read may be larger, and is read as an empty sheet; the archive sheet is read, so it is bounded like a CMDB sheet | | `maxSharedStrings` | `200000` | the number of different texts in the workbook's shared-strings table, each formatted piece of a text with mixed formatting counted as one more, also in text written in a cell itself, counted before a sheet is parsed | -| `maxReferencedStringBytes` | `67108864` (64 MB) | the shared text all cells of the workbook reference together, counted once per cell and once per CMDB sheet before a sheet is parsed; a long text that many cells repeat counts as often as it is repeated | +| `maxReferencedStringBytes` | `67108864` (64 MB) | the shared text all cells of the workbook reference together, counted once per cell and once per sheet the import reads (the two CMDB sheets and the archive sheet, also when the workbook has no archive sheet) before a sheet is parsed; a long text that many cells repeat counts as often as it is repeated | The section's help text shows the defaults; when the server refuses a file, the message shows the limit the server applied. A larger file also has to pass PHP's `upload_max_filesize` and `post_max_size` and the web server's -request size limit. Like the mapping files, the profile is part of the app: -a change made on the server is overwritten by the next app update. - -## Adjusting the mapping - -The mapping from columns to fields is not in code. It is a set of JSON files -in `lib/Settings/cmdb-import/`, executed by OpenRegister's mapping engine: - -| File | What it maps | +request size limit. The profile is part of the app: a change made on the +server is overwritten by the next app update. + +## Viewing and editing the mapping + +**What you need.** Editing the mapping needs an OpenRegister with the +migration-pack editor, whose pack writes are admin-only and need a CSRF +token (added in [openregister#4602](https://github.com/ConductionNL/openregister/pull/4602); +the first OpenRegister release that contains it). On an older OpenRegister +nothing is stored in OpenRegister and there is nothing to edit: the import +runs the packs that ship with stackiq, and the import result says so. +Changing those shipped files on the server does not last, because the next +app update replaces them. Once the packs have been stored in OpenRegister, +the import does not fall back to the shipped copies: when OpenRegister's +pack store is gone, it refuses with `MAPPING_UNAVAILABLE` until OpenRegister +is back. + +The mapping from export columns to stackiq fields is not in code. It is a +set of mapping packs that OpenRegister's mapping engine runs, one per kind of +record the import writes. With the editor, four of them are kept in +OpenRegister, where you can view and change them: + +| Pack (in OpenRegister) | What it maps | |---|---| -| `topdesk-profile.json` | the sheets, the constant each sheet adds to its rows (`Beheer`) and the columns it is known to lack, the match column, the required, date and id columns, the placeholder values that mean empty, the limits, and which pack is used for which target | -| `topdesk-module.json` | a row to the module (hosting model and BBN lookups) | -| `topdesk-manufacturer.json` | "Vendor" to the Supplier organisation | -| `topdesk-municipality.json` | a typed municipality name to a new organisation | -| `topdesk-usage.json` | a row to the usage (status and TIME lookups, dates, annotation) | -| `topdesk-business-owner.json` | the owner columns | - -Each pack has a list of `fieldMappings`, one per column: `source` (the column -name in the export), `target` (the field), optionally `required`, and a -`transform` such as `trim`, `date` or a `lookup` with a `map` of export values -to stored values. For example, to accept a new "Applicatiesoort" value, add -it to the `map` of the hosting-model lookup in `topdesk-module.json`: - -```json -"Cloud": ["SaaS"] -``` - -To accept a new "Applicatie Status" value, add it to the `map` of the status -lookup in `topdesk-usage.json`. The packs are checked by OpenRegister when an import -starts; an invalid pack stops the import with `MAPPING_UNAVAILABLE` before -any row is read. A mapping file changed on the server is overwritten by the -next app update, so propose lasting changes to the app itself. +| `stackiq-topdesk-module` | a row to the application (hosting model and BBN lookups, dates) | +| `stackiq-topdesk-manufacturer` | "Vendor" to the Supplier organisation | +| `stackiq-topdesk-usage` | a row to the usage (status and TIME lookups, phase-out date, internal note) | +| `stackiq-topdesk-business-owner` | the owner columns | + +When OpenRegister has the editor, stackiq puts these four packs into +OpenRegister when it is installed or updated, and an import stores any that +is missing. From then on the import runs what is saved in OpenRegister. The +mapping endpoint (`GET /index.php/apps/stackiq/api/settings/cmdb-import/mapping`, +Nextcloud admins only) answers, per pack, where the import takes it from +(OpenRegister, or the copy that ships with stackiq), its version and the +link to its editor in OpenRegister. Reading it changes nothing: it does not +store or update a pack. + +**In the settings.** Open **Administration settings → Stackiq → CMDB import** +and press **Mapping** under the import form. One table lists the sheets the +import reads and its match, name, required and date columns; a second table +lists the four packs, each with where the import takes it from, its version +and, for a pack kept in OpenRegister, an **Edit in OpenRegister** link. The +municipality pack is not listed: it maps the municipality you choose for the +import, not a column. Opening the page changes nothing. + +Each pack has a list of field mappings, one per column: the column name in +the export, the field it goes to, whether it is required, and a +transformation such as trim, a date, or a lookup table of export values to +stored values. For example, to accept a new "Applicatie Status" value, add it +to the lookup table of the status mapping in `stackiq-topdesk-usage`. To +accept a new "Applicatiesoort" value as a hosting model, add it to the lookup +table of the hosting-model mapping in `stackiq-topdesk-module`, for example +`Cloud` → `SaaS`. When a pack maps a column with a date transformation, the +import reads that column as an Excel date. + +**What the import refuses.** The import writes past OpenRegister's access +rules, so it checks every pack before it reads a row. It refuses a pack, with +`MAPPING_UNAVAILABLE` and the name and id of the pack, when: + +- OpenRegister finds the pack invalid; +- the application name, the APPID (to the source number), the vendor name or + the owner name is no longer mapped, or no longer marked required; +- a mapping or a default writes a field the pack may not write. A pack may + write any plain field of the record it writes (the application, the + organisation or the usage), as the register defines it; the owner pack + writes the name and the role only. Refused are the fields the import sets + itself (the import key, the provider, the consumer, the application of a + usage, the business owner, the type of an organisation: a Supplier stays a + Supplier), every link to another record, files, the publication dates, the + fields the register hides from forms or calculates (the service desk + exchange's keys and stamps, the suggested TIME classification) and the + installed version the service desk owns, and the fields only an + administrator or the catalogue sets, such as an organisation's status and + who registered it. The status and registration + defaults of the vendor and municipality packs stay as shipped. + +The mapping endpoint answers the same reason, with the link to the pack's +editor in `details.editUrl`, and the **Mapping** block shows it with an +**Edit in OpenRegister** link, so you can correct the pack there. After saving +it, reload the settings page: **Mapping** then shows the new version, or the +reason the pack is still refused. + +**What the Mapping block shows.** Below the table of packs, each pack has a +collapsible block "Columns and fields": which column of the export goes to +which field, whether the mapping is required and which transform it uses, and +the rules for what the import writes (the values it sets, the fields written +only on a new record, the fields it never writes on an existing record). When +an unedited pack in OpenRegister is older than the shipped one, the row says +"Update pending": the next import replaces it with the shipped version. + +**What a pack does not change.** Which sheets are read, the APPID and +"Applicatie Naam" columns, the values that mean empty (`NB`), the constant +each sheet adds (`Beheer geregeld: ja` or `nee`) and the limits are part of +the app (`lib/Settings/cmdb-import/topdesk-profile.json`) and cannot be +changed; the **Mapping** block shows the sheets and the match, name, required +and date columns, not the empty values, the constants or the limits. The +municipality is mapped from the name you choose for the import, not from the +export; that pack is not stored in OpenRegister and the block does not list it. + +**Reading more columns.** The import reads only the columns the mapping +names. When you map a new column in a pack, the import reads that column from +then on. + +**One mapping per Nextcloud.** The packs in OpenRegister apply to every +import on this Nextcloud, whatever the municipality. + +**App updates.** A pack you have not changed follows the app: when an update +ships a newer version, the stored pack is replaced by it (the mapping +endpoint already shows the new pack, with `updatePending` true, before the +next import runs). A pack you changed +is never overwritten, also not when you save it while an import is updating +it. When an update ships a newer version of a pack you changed, the mapping +endpoint reports it (`newerShipped`) and the **Mapping** block says so; compare the two and copy what you need +into your pack in OpenRegister. + +**Back to the shipped pack.** Delete the pack in OpenRegister. The next +import, or the next app update, puts the shipped pack back. Do not rename a +pack: the import finds it by its id (such as `stackiq-topdesk-usage`), and +refuses to run while a pack it stored has another id. diff --git a/l10n/en.js b/l10n/en.js index b6a7dd164..108dd98c4 100644 --- a/l10n/en.js +++ b/l10n/en.js @@ -972,7 +972,6 @@ OC.L10N.register( "Error code: {code}": "Error code: {code}", "Excel workbook (.xlsx), at most 10 MB, with the sheet \"Onbeh Applicaties CMDB\" or \"Beheerde Applicaties CMDB\".": "Excel workbook (.xlsx), at most 10 MB, with the sheet \"Onbeh Applicaties CMDB\" or \"Beheerde Applicaties CMDB\".", "Existing municipalities could not be loaded. You can still type the name of a municipality.": "Existing municipalities could not be loaded. You can still type the name of a municipality.", - "Expected a sheet named \"{first}\" or \"{second}\". Sheet names must match exactly.": "Expected a sheet named \"{first}\" or \"{second}\". Sheet names must match exactly.", "Failed": "Failed", "Import": "Import", "Import a TOPdesk CMDB export (.xlsx) as the applications one municipality uses": "Import a TOPdesk CMDB export (.xlsx) as the applications one municipality uses", @@ -980,7 +979,7 @@ OC.L10N.register( "Import for {name} cancelled after {read} rows.": "Import for {name} cancelled after {read} rows.", "Import for {name} finished. {read} rows read: {created} created, {updated} updated, {unchanged} unchanged.": "Import for {name} finished. {read} rows read: {created} created, {updated} updated, {unchanged} unchanged.", "Import progress": "Import progress", - "Importing a newer export again updates the same applications, matched on APPID per municipality. Applications missing from it are left as they are.": "Importing a newer export again updates the same applications, matched on APPID per municipality. Applications missing from it are left as they are.", + "Importing a newer export again updates the same applications, matched on APPID per municipality. Applications missing from it are archived or deleted, unless you choose to keep them.": "Importing a newer export again updates the same applications, matched on APPID per municipality. Applications missing from it are archived or deleted, unless you choose to keep them.", "Importing the export…": "Importing the export…", "Importing…": "Importing…", "APPID": "APPID", @@ -989,15 +988,14 @@ OC.L10N.register( "No rows with this outcome": "No rows with this outcome", "Nothing more is known on this page; the Nextcloud log has the details.": "Nothing more is known on this page; the Nextcloud log has the details.", "Only Nextcloud administrators can import a CMDB export.": "Only Nextcloud administrators can import a CMDB export.", - "OpenRegister's mapping engine is missing or a mapping file is invalid. Update OpenRegister and check the Nextcloud log.": "OpenRegister's mapping engine is missing or a mapping file is invalid. Update OpenRegister and check the Nextcloud log.", + "OpenRegister's mapping engine is missing, or a mapping pack is invalid or breaks a rule of the import. The reason below names the pack: correct it in OpenRegister, or check the Nextcloud log.": "OpenRegister's mapping engine is missing, or a mapping pack is invalid or breaks a rule of the import. The reason below names the pack: correct it in OpenRegister, or check the Nextcloud log.", "Outcome": "Outcome", "Pick an existing municipality or type the name of a new one.": "Pick an existing municipality or type the name of a new one.", - "Pick an existing organisation of type Municipality, or type a new name and press Enter.": "Pick an existing organisation of type Municipality, or type a new name and press Enter.", "Pick an organisation of type Municipality, or type the name of a new one.": "Pick an organisation of type Municipality, or type the name of a new one.", "Reasons and warnings": "Reasons and warnings", "Records missing from the export can only be kept.": "Records missing from the export can only be kept.", "Reload the page and try again.": "Reload the page and try again.", - "Remove sheets the import does not read, or split the export, and try again.": "Remove sheets the import does not read, or split the export, and try again.", + "Remove sheets the import does not read and try again. Or split the export and import every part with \"Keep them as they are\".": "Remove sheets the import does not read and try again. Or split the export and import every part with \"Keep them as they are\".", "Row": "Row", "Row 1 holds the column names. \"APPID\" and \"Applicatie Naam\" are required; column order does not matter.": "Row 1 holds the column names. \"APPID\" and \"Applicatie Naam\" are required; column order does not matter.", "Rows": "Rows", @@ -1015,7 +1013,7 @@ OC.L10N.register( "The import failed unexpectedly.": "The import failed unexpectedly.", "The import mapping cannot run.": "The import mapping cannot run.", "The import reads workbooks with the spreadsheet library that ships with OpenRegister. Make sure OpenRegister is installed and enabled.": "The import reads workbooks with the spreadsheet library that ships with OpenRegister. Make sure OpenRegister is installed and enabled.", - "The import was cancelled. The rows processed before it stopped are kept.": "The import was cancelled. The rows processed before it stopped are kept.", + "The import was cancelled. The rows and applications processed before it stopped are kept.": "The import was cancelled. The rows and applications processed before it stopped are kept.", "The organisation register is not configured, so existing municipalities cannot be listed. You can still type the name of a municipality.": "The organisation register is not configured, so existing municipalities cannot be listed. You can still type the name of a municipality.", "The server could not be reached.": "The server could not be reached.", "The sheet \"{sheet}\" has no column \"{column}\".": "The sheet \"{sheet}\" has no column \"{column}\".", @@ -1036,7 +1034,24 @@ OC.L10N.register( "The stackiq register or its schemas cannot be found. Run Auto Configure at the top of this page, then try again.": "The stackiq register or its schemas cannot be found. Run Auto Configure at the top of this page, then try again.", "Choose a municipality or enter the name of a new one.": "Choose a municipality or enter the name of a new one.", "No running CMDB import has this id.": "No running CMDB import has this id.", - "Only keeping records that are missing from the export is supported.": "Only keeping records that are missing from the export is supported.", + "Applications missing from the export can only be archived or kept.": "Applications missing from the export can only be archived or kept.", + "Applications missing from the export cannot be archived: OpenRegister is missing or too old. Choose to keep them, or update OpenRegister.": "Applications missing from the export cannot be archived: OpenRegister is missing or too old. Choose to keep them, or update OpenRegister.", + "Sheet \"%1$s\" has no column \"%2$s\", so applications missing from the export are archived, not deleted.": "Sheet \"%1$s\" has no column \"%2$s\", so applications missing from the export are archived, not deleted.", + "Sheet \"%1$s\" has an APPID without a cached value in row %2$s, so applications missing from the export are archived, not deleted.": "Sheet \"%1$s\" has an APPID without a cached value in row %2$s, so applications missing from the export are archived, not deleted.", + "Sheet \"%1$s\" has an APPID without a cached value in %2$s rows (%3$s), so applications missing from the export are archived, not deleted.": "Sheet \"%1$s\" has an APPID without a cached value in %2$s rows (%3$s), so applications missing from the export are archived, not deleted.", + "Sheet \"%s\" was not found, so applications missing from the export are archived, not deleted.": "Sheet \"%s\" was not found, so applications missing from the export are archived, not deleted.", + "Unarchived": "Unarchived", + "Restored": "Restored", + "Archived": "Archived", + "Deleted": "Deleted", + "Applications missing from the export": "Applications missing from the export", + "Archive or delete them": "Archive or delete them", + "Keep them as they are": "Keep them as they are", + "An application of this municipality that is on no CMDB sheet any more is archived when the sheet \"{archive}\" lists it, and moved to the trash when no sheet does. Both disappear from the lists, from OpenCatalogi and from Portaliq; one that returns in a later export is brought back. When that sheet is missing, has no APPID column, or has an APPID without a cached value, applications are only archived and the result says so. Choose Keep to leave them as they are.": "An application of this municipality that is on no CMDB sheet any more is archived when the sheet \"{archive}\" lists it, and moved to the trash when no sheet does. Both disappear from the lists, from OpenCatalogi and from Portaliq; one that returns in a later export is brought back. When that sheet is missing, has no APPID column, or has an APPID without a cached value, applications are only archived and the result says so. Choose Keep to leave them as they are.", + "An application of this municipality that is on no CMDB sheet any more is archived. It disappears from the lists, from OpenCatalogi and from Portaliq; one that returns in a later export is brought back. Choose Keep to leave such applications as they are.": "An application of this municipality that is on no CMDB sheet any more is archived. It disappears from the lists, from OpenCatalogi and from Portaliq; one that returns in a later export is brought back. Choose Keep to leave such applications as they are.", + "Applications missing from the export cannot be archived.": "Applications missing from the export cannot be archived.", + "OpenRegister is missing or too old to archive objects. Choose \"Keep them as they are\" and import again, or update OpenRegister. Nothing was imported.": "OpenRegister is missing or too old to archive objects. Choose \"Keep them as they are\" and import again, or update OpenRegister. Nothing was imported.", + "Checking the applications of this municipality against the export": "Checking the applications of this municipality against the export", "Sheet \"%1$s\" has more than %2$s rows.": "Sheet \"%1$s\" has more than %2$s rows.", "Sheet \"%1$s\" has no column \"%2$s\".": "Sheet \"%1$s\" has no column \"%2$s\".", "Stackiq is not configured: the register or its schemas cannot be found.": "Stackiq is not configured: the register or its schemas cannot be found.", @@ -1044,7 +1059,10 @@ OC.L10N.register( "The file is larger than the maximum of %s MB.": "The file is larger than the maximum of %s MB.", "The file is not an Excel workbook (.xlsx).": "The file is not an Excel workbook (.xlsx).", "The import failed. The details are in the Nextcloud log.": "The import failed. The details are in the Nextcloud log.", - "The import mapping cannot run: OpenRegister is missing or a mapping file is invalid.": "The import mapping cannot run: OpenRegister is missing or a mapping file is invalid.", + "The import mapping cannot run: OpenRegister is missing, or a mapping pack is invalid or unavailable.": "The import mapping cannot run: OpenRegister is missing, or a mapping pack is invalid or unavailable.", + "The import mapping cannot run: the OpenRegister migration pack %s is invalid or cannot be read. The details are in the Nextcloud log.": "The import mapping cannot run: the OpenRegister migration pack %s is invalid or cannot be read. The details are in the Nextcloud log.", + "The import mapping cannot be shown: OpenRegister is missing, or a mapping pack is invalid or unavailable.": "The import mapping cannot be shown: OpenRegister is missing, or a mapping pack is invalid or unavailable.", + "OpenRegister's migration pack store is not available, so this import used the mapping that ships with stackiq.": "OpenRegister's migration pack store is not available, so this import used the mapping that ships with stackiq.", "The workbook has neither of the sheets %s.": "The workbook has neither of the sheets %s.", "Column \"%1$s\": %2$s": "Column \"%1$s\": %2$s", "Optional column \"%s\" not found": "Optional column \"%s\" not found", @@ -1084,15 +1102,13 @@ OC.L10N.register( "The server could not store the uploaded file. The details are in the Nextcloud log.": "The server could not store the uploaded file. The details are in the Nextcloud log.", "The file is larger than {size}, the most the import accepts.": "The file is larger than {size}, the most the import accepts.", "The file is larger than the server accepts.": "The file is larger than the server accepts.", - "A source sheet may hold at most {limit} rows. Split the export and import the parts one after the other.": "A source sheet may hold at most {limit} rows. Split the export and import the parts one after the other.", - "Split the export and import the parts one after the other.": "Split the export and import the parts one after the other.", - "Excel workbook (.xlsx) with the sheet \"{first}\" or \"{second}\". By default the file may be at most {size}.": "Excel workbook (.xlsx) with the sheet \"{first}\" or \"{second}\". By default the file may be at most {size}.", - "The sheets \"{first}\" (applications without arranged maintenance) and \"{second}\" (with arranged maintenance) are read; other sheets, including the \"Invoer\" sheets, are ignored.": "The sheets \"{first}\" (applications without arranged maintenance) and \"{second}\" (with arranged maintenance) are read; other sheets, including the \"Invoer\" sheets, are ignored.", + "A source sheet may hold at most {limit} rows. Split the export and import the parts one after the other with \"Keep them as they are\".": "A source sheet may hold at most {limit} rows. Split the export and import the parts one after the other with \"Keep them as they are\".", + "Split the export and import the parts one after the other with \"Keep them as they are\".": "Split the export and import the parts one after the other with \"Keep them as they are\".", "The page got no answer from the import.": "The page got no answer from the import.", "The connection was cut off before the import answered, so it may still be running or may have finished. Wait a few minutes and check the applications of the municipality before you import again. Importing the same file again creates no duplicates.": "The connection was cut off before the import answered, so it may still be running or may have finished. Wait a few minutes and check the applications of the municipality before you import again. Importing the same file again creates no duplicates.", "The import cannot be cancelled now: the server has not started its rows yet, or has already finished them. If the import keeps running, press Cancel import again in a moment.": "The import cannot be cancelled now: the server has not started its rows yet, or has already finished them. If the import keeps running, press Cancel import again in a moment.", "The import could not be cancelled: {reason}": "The import could not be cancelled: {reason}", - "Cancelling the import. It stops before the next row; the rows already processed stay imported.": "Cancelling the import. It stops before the next row; the rows already processed stay imported.", + "Cancelling the import. It stops before the next row or, while the applications are compared with the export, before the next application; what was already processed stays.": "Cancelling the import. It stops before the next row or, while the applications are compared with the export, before the next application; what was already processed stays.", "Showing {shown} of {total} rows.": "Showing {shown} of {total} rows.", "Show {count} more rows": "Show {count} more rows", "The request field \"{field}\" has a value the import does not accept.": "The request field \"{field}\" has a value the import does not accept.", @@ -1123,14 +1139,74 @@ OC.L10N.register( "conflict: the application with this import key is used by another organisation, so it is not changed": "conflict: the application with this import key is used by another organisation, so it is not changed", "When on, a re-import overwrites the application's name, descriptions, application type, hosting model, BBN level, source fields and supplier, and the usage's status, phase-out date and business owner, with the values from the export. The usage's TIME classification and internal note are only set when the usage is created or the field is empty, so changes made in stackiq stay.": "When on, a re-import overwrites the application's name, descriptions, application type, hosting model, BBN level, source fields and supplier, and the usage's status, phase-out date and business owner, with the values from the export. The usage's TIME classification and internal note are only set when the usage is created or the field is empty, so changes made in stackiq stay.", "An .xlsx file is compressed, so a file of a few MB can be much larger once unpacked. Nothing was imported.": "An .xlsx file is compressed, so a file of a few MB can be much larger once unpacked. Nothing was imported.", - "Split the rows over two copies of the export and import them one after the other.": "Split the rows over two copies of the export and import them one after the other.", + "Split the rows over two copies of the export and import both with \"Keep them as they are\": an import that archives treats the applications of the other copy as missing.": "Split the rows over two copies of the export and import both with \"Keep them as they are\": an import that archives treats the applications of the other copy as missing.", "The sheet \"{sheet}\" is too large to import: unpacked it is {size}, and the import reads at most {limit} of one sheet.": "The sheet \"{sheet}\" is too large to import: unpacked it is {size}, and the import reads at most {limit} of one sheet.", "The part {part} of the workbook is too large to import: unpacked it is {size}, and the import reads at most {limit} of one part.": "The part {part} of the workbook is too large to import: unpacked it is {size}, and the import reads at most {limit} of one part.", - "Delete the sheets the import does not read from a copy of the export (it reads only \"{first}\" and \"{second}\"), and import that copy.": "Delete the sheets the import does not read from a copy of the export (it reads only \"{first}\" and \"{second}\"), and import that copy.", "The workbook holds more than {count} different texts, the most the import reads.": "The workbook holds more than {count} different texts, the most the import reads.", "Together, the cells of the workbook reference more than {size} of shared text, the most the import reads.": "Together, the cells of the workbook reference more than {size} of shared text, the most the import reads.", "In development since": "In development since", "In use since": "In use since", + "Application (module)": "Application (module)", + "Supplier organisation (Vendor)": "Supplier organisation (Vendor)", + "Business owner (contact person)": "Business owner (contact person)", + "Loading the mapping…": "Loading the mapping…", + "The mapping could not be loaded.": "The mapping could not be loaded.", + "Sheets read": "Sheets read", + "Match column": "Match column", + "Name column": "Name column", + "Required columns": "Required columns", + "Date columns": "Date columns", + "The import mapping could not be read. The details are in the Nextcloud log.": "The import mapping could not be read. The details are in the Nextcloud log.", + "Mapping": "Mapping", + "OpenRegister's pack store is not available, so the import uses the mapping shipped with stackiq. Update or enable OpenRegister to view and edit the mapping there.": "OpenRegister's pack store is not available, so the import uses the mapping shipped with stackiq. Update or enable OpenRegister to view and edit the mapping there.", + "OpenRegister": "OpenRegister", + "Shipped file": "Shipped file", + "Version {version}": "Version {version}", + "Version {version} (shipped: {shipped})": "Version {version} (shipped: {shipped})", + "Edited": "Edited", + "Edit in OpenRegister": "Edit in OpenRegister", + "Edit in OpenRegister: {target} (opens in a new tab)": "Edit in OpenRegister: {target} (opens in a new tab)", + "Stackiq ships a newer version of this pack ({version}). It was not applied, because the pack was edited in OpenRegister. Delete the pack there to use the shipped version from the next import on; your edits are then lost.": "Stackiq ships a newer version of this pack ({version}). It was not applied, because the pack was edited in OpenRegister. Delete the pack there to use the shipped version from the next import on; your edits are then lost.", + "Excel workbook (.xlsx) with the sheet {sheets}. By default the file may be at most {size}.": "Excel workbook (.xlsx) with the sheet {sheets}. By default the file may be at most {size}.", + "Excel workbook (.xlsx) with one of the sheets {sheets}. By default the file may be at most {size}.": "Excel workbook (.xlsx) with one of the sheets {sheets}. By default the file may be at most {size}.", + "The sheet {sheets} is read, and of the sheet \"{archive}\" only the APPID column; other sheets, including the \"Invoer\" sheets, are ignored.": "The sheet {sheets} is read, and of the sheet \"{archive}\" only the APPID column; other sheets, including the \"Invoer\" sheets, are ignored.", + "The sheets {sheets} are read, and of the sheet \"{archive}\" only the APPID column; other sheets, including the \"Invoer\" sheets, are ignored.": "The sheets {sheets} are read, and of the sheet \"{archive}\" only the APPID column; other sheets, including the \"Invoer\" sheets, are ignored.", + "Expected the sheet {sheets}. Sheet names must match exactly.": "Expected the sheet {sheets}. Sheet names must match exactly.", + "Expected one of the sheets {sheets}. Sheet names must match exactly.": "Expected one of the sheets {sheets}. Sheet names must match exactly.", + "Delete the sheets the import does not read from a copy of the export (it reads {sheets}, and the APPID column of \"{archive}\"), and import that copy.": "Delete the sheets the import does not read from a copy of the export (it reads {sheets}, and the APPID column of \"{archive}\"), and import that copy.", + "The sheet {sheets} is read; other sheets, including the \"Invoer\" sheets, are ignored.": "The sheet {sheets} is read; other sheets, including the \"Invoer\" sheets, are ignored.", + "The sheets {sheets} are read; other sheets, including the \"Invoer\" sheets, are ignored.": "The sheets {sheets} are read; other sheets, including the \"Invoer\" sheets, are ignored.", + "Delete the sheets the import does not read from a copy of the export (it reads only {sheets}), and import that copy.": "Delete the sheets the import does not read from a copy of the export (it reads only {sheets}), and import that copy.", + "A pack deleted in OpenRegister is restored from the shipped file at the next import.": "A pack deleted in OpenRegister is restored from the shipped file at the next import.", + "Choose a municipality, or type a new name and press Enter.": "Choose a municipality, or type a new name and press Enter.", + "Kind of record": "Kind of record", + "New applications become visible to everyone, also without logging in.": "New applications become visible to everyone, also without logging in.", + "Overwrites applications imported before with the values from the export. The (i) button above lists the fields.": "Overwrites applications imported before with the values from the export. The (i) button above lists the fields.", + "Stored in": "Stored in", + "The export": "The export", + "Which columns of the export the next import reads, and where each column goes.": "Which columns of the export the next import reads, and where each column goes.", + "Packs": "Packs", + "Update pending: shipped {version} replaces stored {storedVersion} at the next import.": "Update pending: shipped {version} replaces stored {storedVersion} at the next import.", + "Columns and fields: {target}": "Columns and fields: {target}", + "Which column of the export goes to which field": "Which column of the export goes to which field", + "Column of the export": "Column of the export", + "Field": "Field", + "Transform": "Transform", + "Yes": "Yes", + "No": "No", + "What the import writes": "What the import writes", + "Set on every record": "Set on every record", + "Set on a new record only": "Set on a new record only", + "Written on a new record, or on an existing one only when empty": "Written on a new record, or on an existing one only when empty", + "Never written on an existing record": "Never written on an existing record", + "The mapping could not be loaded. Open Mapping for the reason.": "The mapping could not be loaded. Open Mapping for the reason.", + "{count} archived": "{count} archived", + "{count} unarchived": "{count} unarchived", + "{count} deleted": "{count} deleted", + "{count} restored": "{count} restored", + "Applications: {changes}.": "Applications: {changes}.", + "This tab lists the whole archive. It ignores the GEMMA filters.": "This tab lists the whole archive. It ignores the GEMMA filters.", + "Applications no longer in the export are archived or moved to the trash. The (i) button above explains when.": "Applications no longer in the export are archived or moved to the trash. The (i) button above explains when.", "Not signed in": "Not signed in", "At most %s contact persons per request": "At most %s contact persons per request", "Loading the name": "Loading the name", diff --git a/l10n/en.json b/l10n/en.json index 9706ca8ce..95a57c106 100644 --- a/l10n/en.json +++ b/l10n/en.json @@ -971,7 +971,6 @@ "Error code: {code}": "Error code: {code}", "Excel workbook (.xlsx), at most 10 MB, with the sheet \"Onbeh Applicaties CMDB\" or \"Beheerde Applicaties CMDB\".": "Excel workbook (.xlsx), at most 10 MB, with the sheet \"Onbeh Applicaties CMDB\" or \"Beheerde Applicaties CMDB\".", "Existing municipalities could not be loaded. You can still type the name of a municipality.": "Existing municipalities could not be loaded. You can still type the name of a municipality.", - "Expected a sheet named \"{first}\" or \"{second}\". Sheet names must match exactly.": "Expected a sheet named \"{first}\" or \"{second}\". Sheet names must match exactly.", "Failed": "Failed", "Import": "Import", "Import a TOPdesk CMDB export (.xlsx) as the applications one municipality uses": "Import a TOPdesk CMDB export (.xlsx) as the applications one municipality uses", @@ -979,7 +978,7 @@ "Import for {name} cancelled after {read} rows.": "Import for {name} cancelled after {read} rows.", "Import for {name} finished. {read} rows read: {created} created, {updated} updated, {unchanged} unchanged.": "Import for {name} finished. {read} rows read: {created} created, {updated} updated, {unchanged} unchanged.", "Import progress": "Import progress", - "Importing a newer export again updates the same applications, matched on APPID per municipality. Applications missing from it are left as they are.": "Importing a newer export again updates the same applications, matched on APPID per municipality. Applications missing from it are left as they are.", + "Importing a newer export again updates the same applications, matched on APPID per municipality. Applications missing from it are archived or deleted, unless you choose to keep them.": "Importing a newer export again updates the same applications, matched on APPID per municipality. Applications missing from it are archived or deleted, unless you choose to keep them.", "Importing the export…": "Importing the export…", "Importing…": "Importing…", "APPID": "APPID", @@ -988,15 +987,14 @@ "No rows with this outcome": "No rows with this outcome", "Nothing more is known on this page; the Nextcloud log has the details.": "Nothing more is known on this page; the Nextcloud log has the details.", "Only Nextcloud administrators can import a CMDB export.": "Only Nextcloud administrators can import a CMDB export.", - "OpenRegister's mapping engine is missing or a mapping file is invalid. Update OpenRegister and check the Nextcloud log.": "OpenRegister's mapping engine is missing or a mapping file is invalid. Update OpenRegister and check the Nextcloud log.", + "OpenRegister's mapping engine is missing, or a mapping pack is invalid or breaks a rule of the import. The reason below names the pack: correct it in OpenRegister, or check the Nextcloud log.": "OpenRegister's mapping engine is missing, or a mapping pack is invalid or breaks a rule of the import. The reason below names the pack: correct it in OpenRegister, or check the Nextcloud log.", "Outcome": "Outcome", "Pick an existing municipality or type the name of a new one.": "Pick an existing municipality or type the name of a new one.", - "Pick an existing organisation of type Municipality, or type a new name and press Enter.": "Pick an existing organisation of type Municipality, or type a new name and press Enter.", "Pick an organisation of type Municipality, or type the name of a new one.": "Pick an organisation of type Municipality, or type the name of a new one.", "Reasons and warnings": "Reasons and warnings", "Records missing from the export can only be kept.": "Records missing from the export can only be kept.", "Reload the page and try again.": "Reload the page and try again.", - "Remove sheets the import does not read, or split the export, and try again.": "Remove sheets the import does not read, or split the export, and try again.", + "Remove sheets the import does not read and try again. Or split the export and import every part with \"Keep them as they are\".": "Remove sheets the import does not read and try again. Or split the export and import every part with \"Keep them as they are\".", "Row": "Row", "Row 1 holds the column names. \"APPID\" and \"Applicatie Naam\" are required; column order does not matter.": "Row 1 holds the column names. \"APPID\" and \"Applicatie Naam\" are required; column order does not matter.", "Rows": "Rows", @@ -1014,7 +1012,7 @@ "The import failed unexpectedly.": "The import failed unexpectedly.", "The import mapping cannot run.": "The import mapping cannot run.", "The import reads workbooks with the spreadsheet library that ships with OpenRegister. Make sure OpenRegister is installed and enabled.": "The import reads workbooks with the spreadsheet library that ships with OpenRegister. Make sure OpenRegister is installed and enabled.", - "The import was cancelled. The rows processed before it stopped are kept.": "The import was cancelled. The rows processed before it stopped are kept.", + "The import was cancelled. The rows and applications processed before it stopped are kept.": "The import was cancelled. The rows and applications processed before it stopped are kept.", "The organisation register is not configured, so existing municipalities cannot be listed. You can still type the name of a municipality.": "The organisation register is not configured, so existing municipalities cannot be listed. You can still type the name of a municipality.", "The server could not be reached.": "The server could not be reached.", "The sheet \"{sheet}\" has no column \"{column}\".": "The sheet \"{sheet}\" has no column \"{column}\".", @@ -1035,7 +1033,24 @@ "The stackiq register or its schemas cannot be found. Run Auto Configure at the top of this page, then try again.": "The stackiq register or its schemas cannot be found. Run Auto Configure at the top of this page, then try again.", "Choose a municipality or enter the name of a new one.": "Choose a municipality or enter the name of a new one.", "No running CMDB import has this id.": "No running CMDB import has this id.", - "Only keeping records that are missing from the export is supported.": "Only keeping records that are missing from the export is supported.", + "Applications missing from the export can only be archived or kept.": "Applications missing from the export can only be archived or kept.", + "Applications missing from the export cannot be archived: OpenRegister is missing or too old. Choose to keep them, or update OpenRegister.": "Applications missing from the export cannot be archived: OpenRegister is missing or too old. Choose to keep them, or update OpenRegister.", + "Sheet \"%1$s\" has no column \"%2$s\", so applications missing from the export are archived, not deleted.": "Sheet \"%1$s\" has no column \"%2$s\", so applications missing from the export are archived, not deleted.", + "Sheet \"%1$s\" has an APPID without a cached value in row %2$s, so applications missing from the export are archived, not deleted.": "Sheet \"%1$s\" has an APPID without a cached value in row %2$s, so applications missing from the export are archived, not deleted.", + "Sheet \"%1$s\" has an APPID without a cached value in %2$s rows (%3$s), so applications missing from the export are archived, not deleted.": "Sheet \"%1$s\" has an APPID without a cached value in %2$s rows (%3$s), so applications missing from the export are archived, not deleted.", + "Sheet \"%s\" was not found, so applications missing from the export are archived, not deleted.": "Sheet \"%s\" was not found, so applications missing from the export are archived, not deleted.", + "Unarchived": "Unarchived", + "Restored": "Restored", + "Archived": "Archived", + "Deleted": "Deleted", + "Applications missing from the export": "Applications missing from the export", + "Archive or delete them": "Archive or delete them", + "Keep them as they are": "Keep them as they are", + "An application of this municipality that is on no CMDB sheet any more is archived when the sheet \"{archive}\" lists it, and moved to the trash when no sheet does. Both disappear from the lists, from OpenCatalogi and from Portaliq; one that returns in a later export is brought back. When that sheet is missing, has no APPID column, or has an APPID without a cached value, applications are only archived and the result says so. Choose Keep to leave them as they are.": "An application of this municipality that is on no CMDB sheet any more is archived when the sheet \"{archive}\" lists it, and moved to the trash when no sheet does. Both disappear from the lists, from OpenCatalogi and from Portaliq; one that returns in a later export is brought back. When that sheet is missing, has no APPID column, or has an APPID without a cached value, applications are only archived and the result says so. Choose Keep to leave them as they are.", + "An application of this municipality that is on no CMDB sheet any more is archived. It disappears from the lists, from OpenCatalogi and from Portaliq; one that returns in a later export is brought back. Choose Keep to leave such applications as they are.": "An application of this municipality that is on no CMDB sheet any more is archived. It disappears from the lists, from OpenCatalogi and from Portaliq; one that returns in a later export is brought back. Choose Keep to leave such applications as they are.", + "Applications missing from the export cannot be archived.": "Applications missing from the export cannot be archived.", + "OpenRegister is missing or too old to archive objects. Choose \"Keep them as they are\" and import again, or update OpenRegister. Nothing was imported.": "OpenRegister is missing or too old to archive objects. Choose \"Keep them as they are\" and import again, or update OpenRegister. Nothing was imported.", + "Checking the applications of this municipality against the export": "Checking the applications of this municipality against the export", "Sheet \"%1$s\" has more than %2$s rows.": "Sheet \"%1$s\" has more than %2$s rows.", "Sheet \"%1$s\" has no column \"%2$s\".": "Sheet \"%1$s\" has no column \"%2$s\".", "Stackiq is not configured: the register or its schemas cannot be found.": "Stackiq is not configured: the register or its schemas cannot be found.", @@ -1043,7 +1058,10 @@ "The file is larger than the maximum of %s MB.": "The file is larger than the maximum of %s MB.", "The file is not an Excel workbook (.xlsx).": "The file is not an Excel workbook (.xlsx).", "The import failed. The details are in the Nextcloud log.": "The import failed. The details are in the Nextcloud log.", - "The import mapping cannot run: OpenRegister is missing or a mapping file is invalid.": "The import mapping cannot run: OpenRegister is missing or a mapping file is invalid.", + "The import mapping cannot run: OpenRegister is missing, or a mapping pack is invalid or unavailable.": "The import mapping cannot run: OpenRegister is missing, or a mapping pack is invalid or unavailable.", + "The import mapping cannot run: the OpenRegister migration pack %s is invalid or cannot be read. The details are in the Nextcloud log.": "The import mapping cannot run: the OpenRegister migration pack %s is invalid or cannot be read. The details are in the Nextcloud log.", + "The import mapping cannot be shown: OpenRegister is missing, or a mapping pack is invalid or unavailable.": "The import mapping cannot be shown: OpenRegister is missing, or a mapping pack is invalid or unavailable.", + "OpenRegister's migration pack store is not available, so this import used the mapping that ships with stackiq.": "OpenRegister's migration pack store is not available, so this import used the mapping that ships with stackiq.", "The workbook has neither of the sheets %s.": "The workbook has neither of the sheets %s.", "Column \"%1$s\": %2$s": "Column \"%1$s\": %2$s", "Optional column \"%s\" not found": "Optional column \"%s\" not found", @@ -1083,15 +1101,13 @@ "The server could not store the uploaded file. The details are in the Nextcloud log.": "The server could not store the uploaded file. The details are in the Nextcloud log.", "The file is larger than {size}, the most the import accepts.": "The file is larger than {size}, the most the import accepts.", "The file is larger than the server accepts.": "The file is larger than the server accepts.", - "A source sheet may hold at most {limit} rows. Split the export and import the parts one after the other.": "A source sheet may hold at most {limit} rows. Split the export and import the parts one after the other.", - "Split the export and import the parts one after the other.": "Split the export and import the parts one after the other.", - "Excel workbook (.xlsx) with the sheet \"{first}\" or \"{second}\". By default the file may be at most {size}.": "Excel workbook (.xlsx) with the sheet \"{first}\" or \"{second}\". By default the file may be at most {size}.", - "The sheets \"{first}\" (applications without arranged maintenance) and \"{second}\" (with arranged maintenance) are read; other sheets, including the \"Invoer\" sheets, are ignored.": "The sheets \"{first}\" (applications without arranged maintenance) and \"{second}\" (with arranged maintenance) are read; other sheets, including the \"Invoer\" sheets, are ignored.", + "A source sheet may hold at most {limit} rows. Split the export and import the parts one after the other with \"Keep them as they are\".": "A source sheet may hold at most {limit} rows. Split the export and import the parts one after the other with \"Keep them as they are\".", + "Split the export and import the parts one after the other with \"Keep them as they are\".": "Split the export and import the parts one after the other with \"Keep them as they are\".", "The page got no answer from the import.": "The page got no answer from the import.", "The connection was cut off before the import answered, so it may still be running or may have finished. Wait a few minutes and check the applications of the municipality before you import again. Importing the same file again creates no duplicates.": "The connection was cut off before the import answered, so it may still be running or may have finished. Wait a few minutes and check the applications of the municipality before you import again. Importing the same file again creates no duplicates.", "The import cannot be cancelled now: the server has not started its rows yet, or has already finished them. If the import keeps running, press Cancel import again in a moment.": "The import cannot be cancelled now: the server has not started its rows yet, or has already finished them. If the import keeps running, press Cancel import again in a moment.", "The import could not be cancelled: {reason}": "The import could not be cancelled: {reason}", - "Cancelling the import. It stops before the next row; the rows already processed stay imported.": "Cancelling the import. It stops before the next row; the rows already processed stay imported.", + "Cancelling the import. It stops before the next row or, while the applications are compared with the export, before the next application; what was already processed stays.": "Cancelling the import. It stops before the next row or, while the applications are compared with the export, before the next application; what was already processed stays.", "Showing {shown} of {total} rows.": "Showing {shown} of {total} rows.", "Show {count} more rows": "Show {count} more rows", "The request field \"{field}\" has a value the import does not accept.": "The request field \"{field}\" has a value the import does not accept.", @@ -1122,14 +1138,74 @@ "conflict: the application with this import key is used by another organisation, so it is not changed": "conflict: the application with this import key is used by another organisation, so it is not changed", "When on, a re-import overwrites the application's name, descriptions, application type, hosting model, BBN level, source fields and supplier, and the usage's status, phase-out date and business owner, with the values from the export. The usage's TIME classification and internal note are only set when the usage is created or the field is empty, so changes made in stackiq stay.": "When on, a re-import overwrites the application's name, descriptions, application type, hosting model, BBN level, source fields and supplier, and the usage's status, phase-out date and business owner, with the values from the export. The usage's TIME classification and internal note are only set when the usage is created or the field is empty, so changes made in stackiq stay.", "An .xlsx file is compressed, so a file of a few MB can be much larger once unpacked. Nothing was imported.": "An .xlsx file is compressed, so a file of a few MB can be much larger once unpacked. Nothing was imported.", - "Split the rows over two copies of the export and import them one after the other.": "Split the rows over two copies of the export and import them one after the other.", + "Split the rows over two copies of the export and import both with \"Keep them as they are\": an import that archives treats the applications of the other copy as missing.": "Split the rows over two copies of the export and import both with \"Keep them as they are\": an import that archives treats the applications of the other copy as missing.", "The sheet \"{sheet}\" is too large to import: unpacked it is {size}, and the import reads at most {limit} of one sheet.": "The sheet \"{sheet}\" is too large to import: unpacked it is {size}, and the import reads at most {limit} of one sheet.", "The part {part} of the workbook is too large to import: unpacked it is {size}, and the import reads at most {limit} of one part.": "The part {part} of the workbook is too large to import: unpacked it is {size}, and the import reads at most {limit} of one part.", - "Delete the sheets the import does not read from a copy of the export (it reads only \"{first}\" and \"{second}\"), and import that copy.": "Delete the sheets the import does not read from a copy of the export (it reads only \"{first}\" and \"{second}\"), and import that copy.", "The workbook holds more than {count} different texts, the most the import reads.": "The workbook holds more than {count} different texts, the most the import reads.", "Together, the cells of the workbook reference more than {size} of shared text, the most the import reads.": "Together, the cells of the workbook reference more than {size} of shared text, the most the import reads.", "In development since": "In development since", "In use since": "In use since", + "Application (module)": "Application (module)", + "Supplier organisation (Vendor)": "Supplier organisation (Vendor)", + "Business owner (contact person)": "Business owner (contact person)", + "Loading the mapping…": "Loading the mapping…", + "The mapping could not be loaded.": "The mapping could not be loaded.", + "Sheets read": "Sheets read", + "Match column": "Match column", + "Name column": "Name column", + "Required columns": "Required columns", + "Date columns": "Date columns", + "The import mapping could not be read. The details are in the Nextcloud log.": "The import mapping could not be read. The details are in the Nextcloud log.", + "Mapping": "Mapping", + "OpenRegister's pack store is not available, so the import uses the mapping shipped with stackiq. Update or enable OpenRegister to view and edit the mapping there.": "OpenRegister's pack store is not available, so the import uses the mapping shipped with stackiq. Update or enable OpenRegister to view and edit the mapping there.", + "OpenRegister": "OpenRegister", + "Shipped file": "Shipped file", + "Version {version}": "Version {version}", + "Version {version} (shipped: {shipped})": "Version {version} (shipped: {shipped})", + "Edited": "Edited", + "Edit in OpenRegister": "Edit in OpenRegister", + "Edit in OpenRegister: {target} (opens in a new tab)": "Edit in OpenRegister: {target} (opens in a new tab)", + "Stackiq ships a newer version of this pack ({version}). It was not applied, because the pack was edited in OpenRegister. Delete the pack there to use the shipped version from the next import on; your edits are then lost.": "Stackiq ships a newer version of this pack ({version}). It was not applied, because the pack was edited in OpenRegister. Delete the pack there to use the shipped version from the next import on; your edits are then lost.", + "Excel workbook (.xlsx) with the sheet {sheets}. By default the file may be at most {size}.": "Excel workbook (.xlsx) with the sheet {sheets}. By default the file may be at most {size}.", + "Excel workbook (.xlsx) with one of the sheets {sheets}. By default the file may be at most {size}.": "Excel workbook (.xlsx) with one of the sheets {sheets}. By default the file may be at most {size}.", + "The sheet {sheets} is read, and of the sheet \"{archive}\" only the APPID column; other sheets, including the \"Invoer\" sheets, are ignored.": "The sheet {sheets} is read, and of the sheet \"{archive}\" only the APPID column; other sheets, including the \"Invoer\" sheets, are ignored.", + "The sheets {sheets} are read, and of the sheet \"{archive}\" only the APPID column; other sheets, including the \"Invoer\" sheets, are ignored.": "The sheets {sheets} are read, and of the sheet \"{archive}\" only the APPID column; other sheets, including the \"Invoer\" sheets, are ignored.", + "Expected the sheet {sheets}. Sheet names must match exactly.": "Expected the sheet {sheets}. Sheet names must match exactly.", + "Expected one of the sheets {sheets}. Sheet names must match exactly.": "Expected one of the sheets {sheets}. Sheet names must match exactly.", + "Delete the sheets the import does not read from a copy of the export (it reads {sheets}, and the APPID column of \"{archive}\"), and import that copy.": "Delete the sheets the import does not read from a copy of the export (it reads {sheets}, and the APPID column of \"{archive}\"), and import that copy.", + "The sheet {sheets} is read; other sheets, including the \"Invoer\" sheets, are ignored.": "The sheet {sheets} is read; other sheets, including the \"Invoer\" sheets, are ignored.", + "The sheets {sheets} are read; other sheets, including the \"Invoer\" sheets, are ignored.": "The sheets {sheets} are read; other sheets, including the \"Invoer\" sheets, are ignored.", + "Delete the sheets the import does not read from a copy of the export (it reads only {sheets}), and import that copy.": "Delete the sheets the import does not read from a copy of the export (it reads only {sheets}), and import that copy.", + "A pack deleted in OpenRegister is restored from the shipped file at the next import.": "A pack deleted in OpenRegister is restored from the shipped file at the next import.", + "Choose a municipality, or type a new name and press Enter.": "Choose a municipality, or type a new name and press Enter.", + "Kind of record": "Kind of record", + "New applications become visible to everyone, also without logging in.": "New applications become visible to everyone, also without logging in.", + "Overwrites applications imported before with the values from the export. The (i) button above lists the fields.": "Overwrites applications imported before with the values from the export. The (i) button above lists the fields.", + "Stored in": "Stored in", + "The export": "The export", + "Which columns of the export the next import reads, and where each column goes.": "Which columns of the export the next import reads, and where each column goes.", + "Packs": "Packs", + "Update pending: shipped {version} replaces stored {storedVersion} at the next import.": "Update pending: shipped {version} replaces stored {storedVersion} at the next import.", + "Columns and fields: {target}": "Columns and fields: {target}", + "Which column of the export goes to which field": "Which column of the export goes to which field", + "Column of the export": "Column of the export", + "Field": "Field", + "Transform": "Transform", + "Yes": "Yes", + "No": "No", + "What the import writes": "What the import writes", + "Set on every record": "Set on every record", + "Set on a new record only": "Set on a new record only", + "Written on a new record, or on an existing one only when empty": "Written on a new record, or on an existing one only when empty", + "Never written on an existing record": "Never written on an existing record", + "The mapping could not be loaded. Open Mapping for the reason.": "The mapping could not be loaded. Open Mapping for the reason.", + "{count} archived": "{count} archived", + "{count} unarchived": "{count} unarchived", + "{count} deleted": "{count} deleted", + "{count} restored": "{count} restored", + "Applications: {changes}.": "Applications: {changes}.", + "This tab lists the whole archive. It ignores the GEMMA filters.": "This tab lists the whole archive. It ignores the GEMMA filters.", + "Applications no longer in the export are archived or moved to the trash. The (i) button above explains when.": "Applications no longer in the export are archived or moved to the trash. The (i) button above explains when.", "Not signed in": "Not signed in", "At most %s contact persons per request": "At most %s contact persons per request", "Loading the name": "Loading the name", diff --git a/l10n/nl.js b/l10n/nl.js index c8b826d69..7ed0533e2 100644 --- a/l10n/nl.js +++ b/l10n/nl.js @@ -1040,7 +1040,6 @@ OC.L10N.register( "Error code: {code}": "Foutcode: {code}", "Excel workbook (.xlsx), at most 10 MB, with the sheet \"Onbeh Applicaties CMDB\" or \"Beheerde Applicaties CMDB\".": "Excel-werkmap (.xlsx), hoogstens 10 MB, met het tabblad \"Onbeh Applicaties CMDB\" of \"Beheerde Applicaties CMDB\".", "Existing municipalities could not be loaded. You can still type the name of a municipality.": "Bestaande gemeenten konden niet worden geladen. U kunt nog steeds de naam van een gemeente typen.", - "Expected a sheet named \"{first}\" or \"{second}\". Sheet names must match exactly.": "Verwacht werd een tabblad met de naam \"{first}\" of \"{second}\". De naam van het tabblad moet precies overeenkomen.", "Failed": "Mislukt", "Import": "Importeren", "Import a TOPdesk CMDB export (.xlsx) as the applications one municipality uses": "Importeer een TOPdesk CMDB-export (.xlsx) als de applicaties die één gemeente gebruikt", @@ -1048,7 +1047,7 @@ OC.L10N.register( "Import for {name} cancelled after {read} rows.": "Import voor {name} geannuleerd na {read} rijen.", "Import for {name} finished. {read} rows read: {created} created, {updated} updated, {unchanged} unchanged.": "Import voor {name} voltooid. {read} rijen gelezen: {created} aangemaakt, {updated} bijgewerkt, {unchanged} ongewijzigd.", "Import progress": "Voortgang van de import", - "Importing a newer export again updates the same applications, matched on APPID per municipality. Applications missing from it are left as they are.": "Een nieuwere export opnieuw importeren werkt dezelfde applicaties bij, herkend aan het APPID per gemeente. Applicaties die er niet meer in staan, blijven zoals ze zijn.", + "Importing a newer export again updates the same applications, matched on APPID per municipality. Applications missing from it are archived or deleted, unless you choose to keep them.": "Een nieuwere export opnieuw importeren werkt dezelfde applicaties bij, herkend aan het APPID per gemeente. Applicaties die er niet meer in staan, worden gearchiveerd of verwijderd, tenzij je kiest ze te laten zoals ze zijn.", "Importing the export…": "De export wordt geïmporteerd…", "Importing…": "Importeren…", "APPID": "APPID", @@ -1057,15 +1056,14 @@ OC.L10N.register( "No rows with this outcome": "Geen rijen met dit resultaat", "Nothing more is known on this page; the Nextcloud log has the details.": "Op deze pagina is niet meer bekend; het Nextcloud-logboek bevat de details.", "Only Nextcloud administrators can import a CMDB export.": "Alleen Nextcloud-beheerders kunnen een CMDB-export importeren.", - "OpenRegister's mapping engine is missing or a mapping file is invalid. Update OpenRegister and check the Nextcloud log.": "De mapping-engine van OpenRegister ontbreekt of een mappingbestand is ongeldig. Werk OpenRegister bij en bekijk het Nextcloud-logboek.", + "OpenRegister's mapping engine is missing, or a mapping pack is invalid or breaks a rule of the import. The reason below names the pack: correct it in OpenRegister, or check the Nextcloud log.": "De mapping-engine van OpenRegister ontbreekt, of een mappingpakket is ongeldig of breekt een regel van de import. De reden hieronder noemt het pakket: herstel het in OpenRegister, of bekijk het Nextcloud-logboek.", "Outcome": "Resultaat", "Pick an existing municipality or type the name of a new one.": "Kies een bestaande gemeente of typ de naam van een nieuwe.", - "Pick an existing organisation of type Municipality, or type a new name and press Enter.": "Kies een bestaande organisatie van het type Gemeente, of typ een nieuwe naam en druk op Enter.", "Pick an organisation of type Municipality, or type the name of a new one.": "Kies een organisatie van het type Gemeente, of typ de naam van een nieuwe.", "Reasons and warnings": "Redenen en waarschuwingen", "Records missing from the export can only be kept.": "Records die in de export ontbreken, kunnen alleen worden behouden.", "Reload the page and try again.": "Laad de pagina opnieuw en probeer het nog eens.", - "Remove sheets the import does not read, or split the export, and try again.": "Verwijder tabbladen die de import niet leest, of splits de export, en probeer het opnieuw.", + "Remove sheets the import does not read and try again. Or split the export and import every part with \"Keep them as they are\".": "Verwijder tabbladen die de import niet leest en probeer het opnieuw. Of splits de export en importeer elk deel met \"Laat ze zoals ze zijn\".", "Row": "Rij", "Row 1 holds the column names. \"APPID\" and \"Applicatie Naam\" are required; column order does not matter.": "Rij 1 bevat de kolomnamen. \"APPID\" en \"Applicatie Naam\" zijn verplicht; de volgorde van de kolommen maakt niet uit.", "Rows": "Rijen", @@ -1083,7 +1081,7 @@ OC.L10N.register( "The import failed unexpectedly.": "De import is onverwacht mislukt.", "The import mapping cannot run.": "De mapping van de import kan niet worden uitgevoerd.", "The import reads workbooks with the spreadsheet library that ships with OpenRegister. Make sure OpenRegister is installed and enabled.": "De import leest werkmappen met de spreadsheetbibliotheek die met OpenRegister wordt meegeleverd. Zorg dat OpenRegister is geïnstalleerd en ingeschakeld.", - "The import was cancelled. The rows processed before it stopped are kept.": "De import is geannuleerd. De rijen die vóór het stoppen zijn verwerkt, blijven behouden.", + "The import was cancelled. The rows and applications processed before it stopped are kept.": "De import is geannuleerd. De rijen en applicaties die vóór het stoppen zijn verwerkt, blijven behouden.", "The organisation register is not configured, so existing municipalities cannot be listed. You can still type the name of a municipality.": "Het organisatieregister is niet ingesteld, dus bestaande gemeenten kunnen niet worden getoond. U kunt nog steeds de naam van een gemeente typen.", "The server could not be reached.": "De server is niet bereikbaar.", "The sheet \"{sheet}\" has no column \"{column}\".": "Het tabblad \"{sheet}\" heeft geen kolom \"{column}\".", @@ -1104,7 +1102,24 @@ OC.L10N.register( "The stackiq register or its schemas cannot be found. Run Auto Configure at the top of this page, then try again.": "Het stackiq-register of de schema's ervan zijn niet gevonden. Voer bovenaan deze pagina Auto Configure uit en probeer het daarna opnieuw.", "Choose a municipality or enter the name of a new one.": "Kies een gemeente of voer de naam van een nieuwe in.", "No running CMDB import has this id.": "Er loopt geen CMDB-import met deze id.", - "Only keeping records that are missing from the export is supported.": "Alleen het behouden van records die in de export ontbreken, wordt ondersteund.", + "Applications missing from the export can only be archived or kept.": "Applicaties die in de export ontbreken, kunnen alleen worden gearchiveerd of behouden.", + "Applications missing from the export cannot be archived: OpenRegister is missing or too old. Choose to keep them, or update OpenRegister.": "Applicaties die in de export ontbreken, kunnen niet worden gearchiveerd: OpenRegister ontbreekt of is te oud. Kies ervoor ze te behouden, of werk OpenRegister bij.", + "Sheet \"%1$s\" has no column \"%2$s\", so applications missing from the export are archived, not deleted.": "Tabblad \"%1$s\" heeft geen kolom \"%2$s\", dus applicaties die in de export ontbreken, worden gearchiveerd en niet verwijderd.", + "Sheet \"%1$s\" has an APPID without a cached value in row %2$s, so applications missing from the export are archived, not deleted.": "Tabblad \"%1$s\" heeft een APPID zonder opgeslagen waarde in rij %2$s, dus applicaties die in de export ontbreken, worden gearchiveerd en niet verwijderd.", + "Sheet \"%1$s\" has an APPID without a cached value in %2$s rows (%3$s), so applications missing from the export are archived, not deleted.": "Tabblad \"%1$s\" heeft een APPID zonder opgeslagen waarde in %2$s rijen (%3$s), dus applicaties die in de export ontbreken, worden gearchiveerd en niet verwijderd.", + "Sheet \"%s\" was not found, so applications missing from the export are archived, not deleted.": "Tabblad \"%s\" is niet gevonden, dus applicaties die in de export ontbreken, worden gearchiveerd en niet verwijderd.", + "Unarchived": "Uit archief gehaald", + "Restored": "Hersteld", + "Archived": "Gearchiveerd", + "Deleted": "Verwijderd", + "Applications missing from the export": "Applicaties die in de export ontbreken", + "Archive or delete them": "Archiveren of verwijderen", + "Keep them as they are": "Laat ze zoals ze zijn", + "An application of this municipality that is on no CMDB sheet any more is archived when the sheet \"{archive}\" lists it, and moved to the trash when no sheet does. Both disappear from the lists, from OpenCatalogi and from Portaliq; one that returns in a later export is brought back. When that sheet is missing, has no APPID column, or has an APPID without a cached value, applications are only archived and the result says so. Choose Keep to leave them as they are.": "Een applicatie van deze gemeente die op geen enkel CMDB-tabblad meer staat, wordt gearchiveerd als het tabblad \"{archive}\" haar noemt, en naar de prullenbak verplaatst als geen enkel tabblad dat doet. Beide verdwijnen uit de lijsten, uit OpenCatalogi en uit Portaliq; een applicatie die in een latere export terugkomt, wordt teruggezet. Ontbreekt dat tabblad, heeft het geen kolom APPID of heeft een APPID geen opgeslagen waarde, dan worden applicaties alleen gearchiveerd en zegt het resultaat dat. Kies Laat ze zoals ze zijn om ze ongemoeid te laten.", + "An application of this municipality that is on no CMDB sheet any more is archived. It disappears from the lists, from OpenCatalogi and from Portaliq; one that returns in a later export is brought back. Choose Keep to leave such applications as they are.": "Een applicatie van deze gemeente die op geen enkel CMDB-tabblad meer staat, wordt gearchiveerd. Ze verdwijnt uit de lijsten, uit OpenCatalogi en uit Portaliq; een applicatie die in een latere export terugkomt, wordt teruggezet. Kies Laat ze zoals ze zijn om zulke applicaties ongemoeid te laten.", + "Applications missing from the export cannot be archived.": "Applicaties die in de export ontbreken, kunnen niet worden gearchiveerd.", + "OpenRegister is missing or too old to archive objects. Choose \"Keep them as they are\" and import again, or update OpenRegister. Nothing was imported.": "OpenRegister ontbreekt of is te oud om objecten te archiveren. Kies \"Laat ze zoals ze zijn\" en importeer opnieuw, of werk OpenRegister bij. Er is niets geïmporteerd.", + "Checking the applications of this municipality against the export": "De applicaties van deze gemeente met de export vergelijken", "Sheet \"%1$s\" has more than %2$s rows.": "Tabblad \"%1$s\" heeft meer dan %2$s rijen.", "Sheet \"%1$s\" has no column \"%2$s\".": "Tabblad \"%1$s\" heeft geen kolom \"%2$s\".", "Stackiq is not configured: the register or its schemas cannot be found.": "Stackiq is niet ingesteld: het register of de schema's ervan zijn niet gevonden.", @@ -1112,7 +1127,10 @@ OC.L10N.register( "The file is larger than the maximum of %s MB.": "Het bestand is groter dan het maximum van %s MB.", "The file is not an Excel workbook (.xlsx).": "Het bestand is geen Excel-werkmap (.xlsx).", "The import failed. The details are in the Nextcloud log.": "De import is mislukt. De details staan in het Nextcloud-logboek.", - "The import mapping cannot run: OpenRegister is missing or a mapping file is invalid.": "De mapping van de import kan niet worden uitgevoerd: OpenRegister ontbreekt of een mappingbestand is ongeldig.", + "The import mapping cannot run: OpenRegister is missing, or a mapping pack is invalid or unavailable.": "De mapping van de import kan niet worden uitgevoerd: OpenRegister ontbreekt, of een mappingpakket is ongeldig of niet beschikbaar.", + "The import mapping cannot run: the OpenRegister migration pack %s is invalid or cannot be read. The details are in the Nextcloud log.": "De mapping van de import kan niet worden uitgevoerd: het migratiepakket %s in OpenRegister is ongeldig of kan niet worden gelezen. De details staan in het Nextcloud-logboek.", + "The import mapping cannot be shown: OpenRegister is missing, or a mapping pack is invalid or unavailable.": "De mapping van de import kan niet worden getoond: OpenRegister ontbreekt, of een mappingpakket is ongeldig of niet beschikbaar.", + "OpenRegister's migration pack store is not available, so this import used the mapping that ships with stackiq.": "De opslag voor migratiepakketten van OpenRegister is niet beschikbaar, dus deze import gebruikte de mapping die met stackiq wordt meegeleverd.", "The workbook has neither of the sheets %s.": "De werkmap bevat geen van de tabbladen %s.", "Column \"%1$s\": %2$s": "Kolom \"%1$s\": %2$s", "Optional column \"%s\" not found": "Optionele kolom \"%s\" niet gevonden", @@ -1152,15 +1170,13 @@ OC.L10N.register( "The server could not store the uploaded file. The details are in the Nextcloud log.": "De server kon het geüploade bestand niet opslaan. De details staan in het Nextcloud-logboek.", "The file is larger than {size}, the most the import accepts.": "Het bestand is groter dan {size}, het maximum dat de import accepteert.", "The file is larger than the server accepts.": "Het bestand is groter dan de server accepteert.", - "A source sheet may hold at most {limit} rows. Split the export and import the parts one after the other.": "Een brontabblad mag hoogstens {limit} rijen bevatten. Splits de export en importeer de delen na elkaar.", - "Split the export and import the parts one after the other.": "Splits de export en importeer de delen na elkaar.", - "Excel workbook (.xlsx) with the sheet \"{first}\" or \"{second}\". By default the file may be at most {size}.": "Excel-werkmap (.xlsx) met het tabblad \"{first}\" of \"{second}\". Standaard mag het bestand hoogstens {size} zijn.", - "The sheets \"{first}\" (applications without arranged maintenance) and \"{second}\" (with arranged maintenance) are read; other sheets, including the \"Invoer\" sheets, are ignored.": "De tabbladen \"{first}\" (applicaties zonder geregeld beheer) en \"{second}\" (met geregeld beheer) worden gelezen; andere tabbladen, ook de \"Invoer\"-tabbladen, worden genegeerd.", + "A source sheet may hold at most {limit} rows. Split the export and import the parts one after the other with \"Keep them as they are\".": "Een brontabblad mag hoogstens {limit} rijen bevatten. Splits de export en importeer de delen na elkaar met \"Laat ze zoals ze zijn\".", + "Split the export and import the parts one after the other with \"Keep them as they are\".": "Splits de export en importeer de delen na elkaar met \"Laat ze zoals ze zijn\".", "The page got no answer from the import.": "De pagina kreeg geen antwoord van de import.", "The connection was cut off before the import answered, so it may still be running or may have finished. Wait a few minutes and check the applications of the municipality before you import again. Importing the same file again creates no duplicates.": "De verbinding werd verbroken voordat de import antwoordde, dus de import kan nog bezig zijn of al klaar zijn. Wacht een paar minuten en controleer de applicaties van de gemeente voordat u opnieuw importeert. Hetzelfde bestand opnieuw importeren maakt geen dubbele records aan.", "The import cannot be cancelled now: the server has not started its rows yet, or has already finished them. If the import keeps running, press Cancel import again in a moment.": "De import kan nu niet worden geannuleerd: de server is nog niet aan de rijen begonnen, of is er al mee klaar. Loopt de import door, druk dan zo dadelijk opnieuw op Import annuleren.", "The import could not be cancelled: {reason}": "De import kon niet worden geannuleerd: {reason}", - "Cancelling the import. It stops before the next row; the rows already processed stay imported.": "De import wordt geannuleerd. Hij stopt voor de volgende rij; de rijen die al verwerkt zijn blijven geïmporteerd.", + "Cancelling the import. It stops before the next row or, while the applications are compared with the export, before the next application; what was already processed stays.": "De import wordt geannuleerd. Hij stopt voor de volgende rij of, tijdens het vergelijken van de applicaties met de export, voor de volgende applicatie; wat al verwerkt is blijft staan.", "Showing {shown} of {total} rows.": "{shown} van {total} rijen weergegeven.", "Show {count} more rows": "Toon nog {count} rijen", "The request field \"{field}\" has a value the import does not accept.": "Het veld \"{field}\" van het verzoek heeft een waarde die de import niet accepteert.", @@ -1191,14 +1207,74 @@ OC.L10N.register( "conflict: the application with this import key is used by another organisation, so it is not changed": "conflict: de applicatie met deze importsleutel wordt door een andere organisatie gebruikt en wordt daarom niet gewijzigd", "When on, a re-import overwrites the application's name, descriptions, application type, hosting model, BBN level, source fields and supplier, and the usage's status, phase-out date and business owner, with the values from the export. The usage's TIME classification and internal note are only set when the usage is created or the field is empty, so changes made in stackiq stay.": "Staat dit aan, dan overschrijft een herhaalde import de naam, de omschrijvingen, het applicatietype, het hostingmodel, het BBN-niveau, de bronvelden en de leverancier van de applicatie, en de status, de uitfaseerdatum en de functioneel eigenaar van het gebruik, met de waarden uit de export. De TIME-classificatie en de interne notitie van het gebruik worden alleen gezet wanneer het gebruik wordt aangemaakt of het veld leeg is, zodat wijzigingen in stackiq blijven staan.", "An .xlsx file is compressed, so a file of a few MB can be much larger once unpacked. Nothing was imported.": "Een .xlsx-bestand is gecomprimeerd: een bestand van een paar MB kan uitgepakt veel groter zijn. Er is niets geïmporteerd.", - "Split the rows over two copies of the export and import them one after the other.": "Verdeel de rijen over twee kopieën van de export en importeer die na elkaar.", + "Split the rows over two copies of the export and import both with \"Keep them as they are\": an import that archives treats the applications of the other copy as missing.": "Verdeel de rijen over twee kopieën van de export en importeer beide met \"Laat ze zoals ze zijn\": een import die archiveert, ziet de applicaties van de andere kopie als ontbrekend.", "The sheet \"{sheet}\" is too large to import: unpacked it is {size}, and the import reads at most {limit} of one sheet.": "Het tabblad \"{sheet}\" is te groot om te importeren: uitgepakt is het {size}, en de import leest van één tabblad hooguit {limit}.", "The part {part} of the workbook is too large to import: unpacked it is {size}, and the import reads at most {limit} of one part.": "Het onderdeel {part} van de werkmap is te groot om te importeren: uitgepakt is het {size}, en de import leest van één onderdeel hooguit {limit}.", - "Delete the sheets the import does not read from a copy of the export (it reads only \"{first}\" and \"{second}\"), and import that copy.": "Verwijder in een kopie van de export de tabbladen die de import niet leest (hij leest alleen \"{first}\" en \"{second}\"), en importeer die kopie.", "The workbook holds more than {count} different texts, the most the import reads.": "De werkmap bevat meer dan {count} verschillende teksten, het maximum dat de import leest.", "Together, the cells of the workbook reference more than {size} of shared text, the most the import reads.": "Samen verwijzen de cellen van de werkmap naar meer dan {size} gedeelde tekst, het maximum dat de import leest.", "In development since": "In ontwikkeling sinds", "In use since": "In gebruik sinds", + "Application (module)": "Applicatie (module)", + "Supplier organisation (Vendor)": "Leveranciersorganisatie (Vendor)", + "Business owner (contact person)": "Business owner (contactpersoon)", + "Loading the mapping…": "Mapping laden…", + "The mapping could not be loaded.": "De mapping kon niet worden geladen.", + "Sheets read": "Gelezen tabbladen", + "Match column": "Koppelkolom", + "Name column": "Naamkolom", + "Required columns": "Verplichte kolommen", + "Date columns": "Datumkolommen", + "The import mapping could not be read. The details are in the Nextcloud log.": "De mapping van de import kon niet worden gelezen. De details staan in het Nextcloud-logboek.", + "Mapping": "Mapping", + "OpenRegister's pack store is not available, so the import uses the mapping shipped with stackiq. Update or enable OpenRegister to view and edit the mapping there.": "De packopslag van OpenRegister is niet beschikbaar, dus de import gebruikt de mapping die met stackiq wordt meegeleverd. Werk OpenRegister bij of schakel het in om de mapping daar te bekijken en te bewerken.", + "OpenRegister": "OpenRegister", + "Shipped file": "Meegeleverd bestand", + "Version {version}": "Versie {version}", + "Version {version} (shipped: {shipped})": "Versie {version} (meegeleverd: {shipped})", + "Edited": "Bewerkt", + "Edit in OpenRegister": "Bewerken in OpenRegister", + "Edit in OpenRegister: {target} (opens in a new tab)": "Bewerken in OpenRegister: {target} (opent in een nieuw tabblad)", + "Stackiq ships a newer version of this pack ({version}). It was not applied, because the pack was edited in OpenRegister. Delete the pack there to use the shipped version from the next import on; your edits are then lost.": "Stackiq levert een nieuwere versie van dit pack mee ({version}). Die is niet toegepast, omdat het pack in OpenRegister is bewerkt. Verwijder het pack daar om vanaf de volgende import de meegeleverde versie te gebruiken; de wijzigingen gaan dan verloren.", + "Excel workbook (.xlsx) with the sheet {sheets}. By default the file may be at most {size}.": "Excel-werkmap (.xlsx) met het tabblad {sheets}. Standaard mag het bestand hoogstens {size} zijn.", + "Excel workbook (.xlsx) with one of the sheets {sheets}. By default the file may be at most {size}.": "Excel-werkmap (.xlsx) met een van de tabbladen {sheets}. Standaard mag het bestand hoogstens {size} zijn.", + "The sheet {sheets} is read, and of the sheet \"{archive}\" only the APPID column; other sheets, including the \"Invoer\" sheets, are ignored.": "Het tabblad {sheets} wordt gelezen, en van het tabblad \"{archive}\" alleen de kolom APPID; andere tabbladen, ook de \"Invoer\"-tabbladen, worden genegeerd.", + "The sheets {sheets} are read, and of the sheet \"{archive}\" only the APPID column; other sheets, including the \"Invoer\" sheets, are ignored.": "De tabbladen {sheets} worden gelezen, en van het tabblad \"{archive}\" alleen de kolom APPID; andere tabbladen, ook de \"Invoer\"-tabbladen, worden genegeerd.", + "Expected the sheet {sheets}. Sheet names must match exactly.": "Verwacht werd het tabblad {sheets}. De naam van het tabblad moet precies overeenkomen.", + "Expected one of the sheets {sheets}. Sheet names must match exactly.": "Verwacht werd een van de tabbladen {sheets}. De namen van de tabbladen moeten precies overeenkomen.", + "Delete the sheets the import does not read from a copy of the export (it reads {sheets}, and the APPID column of \"{archive}\"), and import that copy.": "Verwijder in een kopie van de export de tabbladen die de import niet leest (hij leest {sheets}, en de kolom APPID van \"{archive}\"), en importeer die kopie.", + "The sheet {sheets} is read; other sheets, including the \"Invoer\" sheets, are ignored.": "Het tabblad {sheets} wordt gelezen; andere tabbladen, ook de \"Invoer\"-tabbladen, worden genegeerd.", + "The sheets {sheets} are read; other sheets, including the \"Invoer\" sheets, are ignored.": "De tabbladen {sheets} worden gelezen; andere tabbladen, ook de \"Invoer\"-tabbladen, worden genegeerd.", + "Delete the sheets the import does not read from a copy of the export (it reads only {sheets}), and import that copy.": "Verwijder in een kopie van de export de tabbladen die de import niet leest (hij leest alleen {sheets}), en importeer die kopie.", + "A pack deleted in OpenRegister is restored from the shipped file at the next import.": "Een pack dat in OpenRegister is verwijderd, wordt bij de volgende import hersteld uit het meegeleverde bestand.", + "Choose a municipality, or type a new name and press Enter.": "Kies een gemeente, of typ een nieuwe naam en druk op Enter.", + "Kind of record": "Soort gegeven", + "New applications become visible to everyone, also without logging in.": "Nieuwe applicaties worden voor iedereen zichtbaar, ook zonder in te loggen.", + "Overwrites applications imported before with the values from the export. The (i) button above lists the fields.": "Overschrijft eerder geïmporteerde applicaties met de waarden uit de export. De (i)-knop bovenaan noemt de velden.", + "Stored in": "Opgeslagen in", + "The export": "De export", + "Which columns of the export the next import reads, and where each column goes.": "Welke kolommen van de export de volgende import leest, en waar elke kolom heen gaat.", + "Packs": "Packs", + "Update pending: shipped {version} replaces stored {storedVersion} at the next import.": "Update in afwachting: de meegeleverde versie {version} vervangt de opgeslagen versie {storedVersion} bij de volgende import.", + "Columns and fields: {target}": "Kolommen en velden: {target}", + "Which column of the export goes to which field": "Welke kolom van de export naar welk veld gaat", + "Column of the export": "Kolom van de export", + "Field": "Veld", + "Transform": "Omzetting", + "Yes": "Ja", + "No": "Nee", + "What the import writes": "Wat de import schrijft", + "Set on every record": "Op elk record gezet", + "Set on a new record only": "Alleen op een nieuw record gezet", + "Written on a new record, or on an existing one only when empty": "Op een nieuw record geschreven, of op een bestaand record alleen als de waarde leeg is", + "Never written on an existing record": "Nooit geschreven op een bestaand record", + "The mapping could not be loaded. Open Mapping for the reason.": "De mapping kon niet worden geladen. Open Mapping voor de reden.", + "{count} archived": "{count} gearchiveerd", + "{count} unarchived": "{count} uit het archief gehaald", + "{count} deleted": "{count} verwijderd", + "{count} restored": "{count} teruggezet", + "Applications: {changes}.": "Applicaties: {changes}.", + "This tab lists the whole archive. It ignores the GEMMA filters.": "Dit tabblad toont het hele archief. De GEMMA-filters worden genegeerd.", + "Applications no longer in the export are archived or moved to the trash. The (i) button above explains when.": "Applicaties die niet meer in de export staan, worden gearchiveerd of naar de prullenbak verplaatst. De (i)-knop bovenaan legt uit wanneer.", "Not signed in": "Niet aangemeld", "At most %s contact persons per request": "Ten hoogste %s contactpersonen per verzoek", "Loading the name": "De naam wordt geladen", diff --git a/l10n/nl.json b/l10n/nl.json index 454dacae9..20e6df066 100644 --- a/l10n/nl.json +++ b/l10n/nl.json @@ -1039,7 +1039,6 @@ "Error code: {code}": "Foutcode: {code}", "Excel workbook (.xlsx), at most 10 MB, with the sheet \"Onbeh Applicaties CMDB\" or \"Beheerde Applicaties CMDB\".": "Excel-werkmap (.xlsx), hoogstens 10 MB, met het tabblad \"Onbeh Applicaties CMDB\" of \"Beheerde Applicaties CMDB\".", "Existing municipalities could not be loaded. You can still type the name of a municipality.": "Bestaande gemeenten konden niet worden geladen. U kunt nog steeds de naam van een gemeente typen.", - "Expected a sheet named \"{first}\" or \"{second}\". Sheet names must match exactly.": "Verwacht werd een tabblad met de naam \"{first}\" of \"{second}\". De naam van het tabblad moet precies overeenkomen.", "Failed": "Mislukt", "Import": "Importeren", "Import a TOPdesk CMDB export (.xlsx) as the applications one municipality uses": "Importeer een TOPdesk CMDB-export (.xlsx) als de applicaties die één gemeente gebruikt", @@ -1047,7 +1046,7 @@ "Import for {name} cancelled after {read} rows.": "Import voor {name} geannuleerd na {read} rijen.", "Import for {name} finished. {read} rows read: {created} created, {updated} updated, {unchanged} unchanged.": "Import voor {name} voltooid. {read} rijen gelezen: {created} aangemaakt, {updated} bijgewerkt, {unchanged} ongewijzigd.", "Import progress": "Voortgang van de import", - "Importing a newer export again updates the same applications, matched on APPID per municipality. Applications missing from it are left as they are.": "Een nieuwere export opnieuw importeren werkt dezelfde applicaties bij, herkend aan het APPID per gemeente. Applicaties die er niet meer in staan, blijven zoals ze zijn.", + "Importing a newer export again updates the same applications, matched on APPID per municipality. Applications missing from it are archived or deleted, unless you choose to keep them.": "Een nieuwere export opnieuw importeren werkt dezelfde applicaties bij, herkend aan het APPID per gemeente. Applicaties die er niet meer in staan, worden gearchiveerd of verwijderd, tenzij je kiest ze te laten zoals ze zijn.", "Importing the export…": "De export wordt geïmporteerd…", "Importing…": "Importeren…", "APPID": "APPID", @@ -1056,15 +1055,14 @@ "No rows with this outcome": "Geen rijen met dit resultaat", "Nothing more is known on this page; the Nextcloud log has the details.": "Op deze pagina is niet meer bekend; het Nextcloud-logboek bevat de details.", "Only Nextcloud administrators can import a CMDB export.": "Alleen Nextcloud-beheerders kunnen een CMDB-export importeren.", - "OpenRegister's mapping engine is missing or a mapping file is invalid. Update OpenRegister and check the Nextcloud log.": "De mapping-engine van OpenRegister ontbreekt of een mappingbestand is ongeldig. Werk OpenRegister bij en bekijk het Nextcloud-logboek.", + "OpenRegister's mapping engine is missing, or a mapping pack is invalid or breaks a rule of the import. The reason below names the pack: correct it in OpenRegister, or check the Nextcloud log.": "De mapping-engine van OpenRegister ontbreekt, of een mappingpakket is ongeldig of breekt een regel van de import. De reden hieronder noemt het pakket: herstel het in OpenRegister, of bekijk het Nextcloud-logboek.", "Outcome": "Resultaat", "Pick an existing municipality or type the name of a new one.": "Kies een bestaande gemeente of typ de naam van een nieuwe.", - "Pick an existing organisation of type Municipality, or type a new name and press Enter.": "Kies een bestaande organisatie van het type Gemeente, of typ een nieuwe naam en druk op Enter.", "Pick an organisation of type Municipality, or type the name of a new one.": "Kies een organisatie van het type Gemeente, of typ de naam van een nieuwe.", "Reasons and warnings": "Redenen en waarschuwingen", "Records missing from the export can only be kept.": "Records die in de export ontbreken, kunnen alleen worden behouden.", "Reload the page and try again.": "Laad de pagina opnieuw en probeer het nog eens.", - "Remove sheets the import does not read, or split the export, and try again.": "Verwijder tabbladen die de import niet leest, of splits de export, en probeer het opnieuw.", + "Remove sheets the import does not read and try again. Or split the export and import every part with \"Keep them as they are\".": "Verwijder tabbladen die de import niet leest en probeer het opnieuw. Of splits de export en importeer elk deel met \"Laat ze zoals ze zijn\".", "Row": "Rij", "Row 1 holds the column names. \"APPID\" and \"Applicatie Naam\" are required; column order does not matter.": "Rij 1 bevat de kolomnamen. \"APPID\" en \"Applicatie Naam\" zijn verplicht; de volgorde van de kolommen maakt niet uit.", "Rows": "Rijen", @@ -1082,7 +1080,7 @@ "The import failed unexpectedly.": "De import is onverwacht mislukt.", "The import mapping cannot run.": "De mapping van de import kan niet worden uitgevoerd.", "The import reads workbooks with the spreadsheet library that ships with OpenRegister. Make sure OpenRegister is installed and enabled.": "De import leest werkmappen met de spreadsheetbibliotheek die met OpenRegister wordt meegeleverd. Zorg dat OpenRegister is geïnstalleerd en ingeschakeld.", - "The import was cancelled. The rows processed before it stopped are kept.": "De import is geannuleerd. De rijen die vóór het stoppen zijn verwerkt, blijven behouden.", + "The import was cancelled. The rows and applications processed before it stopped are kept.": "De import is geannuleerd. De rijen en applicaties die vóór het stoppen zijn verwerkt, blijven behouden.", "The organisation register is not configured, so existing municipalities cannot be listed. You can still type the name of a municipality.": "Het organisatieregister is niet ingesteld, dus bestaande gemeenten kunnen niet worden getoond. U kunt nog steeds de naam van een gemeente typen.", "The server could not be reached.": "De server is niet bereikbaar.", "The sheet \"{sheet}\" has no column \"{column}\".": "Het tabblad \"{sheet}\" heeft geen kolom \"{column}\".", @@ -1103,7 +1101,24 @@ "The stackiq register or its schemas cannot be found. Run Auto Configure at the top of this page, then try again.": "Het stackiq-register of de schema's ervan zijn niet gevonden. Voer bovenaan deze pagina Auto Configure uit en probeer het daarna opnieuw.", "Choose a municipality or enter the name of a new one.": "Kies een gemeente of voer de naam van een nieuwe in.", "No running CMDB import has this id.": "Er loopt geen CMDB-import met deze id.", - "Only keeping records that are missing from the export is supported.": "Alleen het behouden van records die in de export ontbreken, wordt ondersteund.", + "Applications missing from the export can only be archived or kept.": "Applicaties die in de export ontbreken, kunnen alleen worden gearchiveerd of behouden.", + "Applications missing from the export cannot be archived: OpenRegister is missing or too old. Choose to keep them, or update OpenRegister.": "Applicaties die in de export ontbreken, kunnen niet worden gearchiveerd: OpenRegister ontbreekt of is te oud. Kies ervoor ze te behouden, of werk OpenRegister bij.", + "Sheet \"%1$s\" has no column \"%2$s\", so applications missing from the export are archived, not deleted.": "Tabblad \"%1$s\" heeft geen kolom \"%2$s\", dus applicaties die in de export ontbreken, worden gearchiveerd en niet verwijderd.", + "Sheet \"%1$s\" has an APPID without a cached value in row %2$s, so applications missing from the export are archived, not deleted.": "Tabblad \"%1$s\" heeft een APPID zonder opgeslagen waarde in rij %2$s, dus applicaties die in de export ontbreken, worden gearchiveerd en niet verwijderd.", + "Sheet \"%1$s\" has an APPID without a cached value in %2$s rows (%3$s), so applications missing from the export are archived, not deleted.": "Tabblad \"%1$s\" heeft een APPID zonder opgeslagen waarde in %2$s rijen (%3$s), dus applicaties die in de export ontbreken, worden gearchiveerd en niet verwijderd.", + "Sheet \"%s\" was not found, so applications missing from the export are archived, not deleted.": "Tabblad \"%s\" is niet gevonden, dus applicaties die in de export ontbreken, worden gearchiveerd en niet verwijderd.", + "Unarchived": "Uit archief gehaald", + "Restored": "Hersteld", + "Archived": "Gearchiveerd", + "Deleted": "Verwijderd", + "Applications missing from the export": "Applicaties die in de export ontbreken", + "Archive or delete them": "Archiveren of verwijderen", + "Keep them as they are": "Laat ze zoals ze zijn", + "An application of this municipality that is on no CMDB sheet any more is archived when the sheet \"{archive}\" lists it, and moved to the trash when no sheet does. Both disappear from the lists, from OpenCatalogi and from Portaliq; one that returns in a later export is brought back. When that sheet is missing, has no APPID column, or has an APPID without a cached value, applications are only archived and the result says so. Choose Keep to leave them as they are.": "Een applicatie van deze gemeente die op geen enkel CMDB-tabblad meer staat, wordt gearchiveerd als het tabblad \"{archive}\" haar noemt, en naar de prullenbak verplaatst als geen enkel tabblad dat doet. Beide verdwijnen uit de lijsten, uit OpenCatalogi en uit Portaliq; een applicatie die in een latere export terugkomt, wordt teruggezet. Ontbreekt dat tabblad, heeft het geen kolom APPID of heeft een APPID geen opgeslagen waarde, dan worden applicaties alleen gearchiveerd en zegt het resultaat dat. Kies Laat ze zoals ze zijn om ze ongemoeid te laten.", + "An application of this municipality that is on no CMDB sheet any more is archived. It disappears from the lists, from OpenCatalogi and from Portaliq; one that returns in a later export is brought back. Choose Keep to leave such applications as they are.": "Een applicatie van deze gemeente die op geen enkel CMDB-tabblad meer staat, wordt gearchiveerd. Ze verdwijnt uit de lijsten, uit OpenCatalogi en uit Portaliq; een applicatie die in een latere export terugkomt, wordt teruggezet. Kies Laat ze zoals ze zijn om zulke applicaties ongemoeid te laten.", + "Applications missing from the export cannot be archived.": "Applicaties die in de export ontbreken, kunnen niet worden gearchiveerd.", + "OpenRegister is missing or too old to archive objects. Choose \"Keep them as they are\" and import again, or update OpenRegister. Nothing was imported.": "OpenRegister ontbreekt of is te oud om objecten te archiveren. Kies \"Laat ze zoals ze zijn\" en importeer opnieuw, of werk OpenRegister bij. Er is niets geïmporteerd.", + "Checking the applications of this municipality against the export": "De applicaties van deze gemeente met de export vergelijken", "Sheet \"%1$s\" has more than %2$s rows.": "Tabblad \"%1$s\" heeft meer dan %2$s rijen.", "Sheet \"%1$s\" has no column \"%2$s\".": "Tabblad \"%1$s\" heeft geen kolom \"%2$s\".", "Stackiq is not configured: the register or its schemas cannot be found.": "Stackiq is niet ingesteld: het register of de schema's ervan zijn niet gevonden.", @@ -1111,7 +1126,10 @@ "The file is larger than the maximum of %s MB.": "Het bestand is groter dan het maximum van %s MB.", "The file is not an Excel workbook (.xlsx).": "Het bestand is geen Excel-werkmap (.xlsx).", "The import failed. The details are in the Nextcloud log.": "De import is mislukt. De details staan in het Nextcloud-logboek.", - "The import mapping cannot run: OpenRegister is missing or a mapping file is invalid.": "De mapping van de import kan niet worden uitgevoerd: OpenRegister ontbreekt of een mappingbestand is ongeldig.", + "The import mapping cannot run: OpenRegister is missing, or a mapping pack is invalid or unavailable.": "De mapping van de import kan niet worden uitgevoerd: OpenRegister ontbreekt, of een mappingpakket is ongeldig of niet beschikbaar.", + "The import mapping cannot run: the OpenRegister migration pack %s is invalid or cannot be read. The details are in the Nextcloud log.": "De mapping van de import kan niet worden uitgevoerd: het migratiepakket %s in OpenRegister is ongeldig of kan niet worden gelezen. De details staan in het Nextcloud-logboek.", + "The import mapping cannot be shown: OpenRegister is missing, or a mapping pack is invalid or unavailable.": "De mapping van de import kan niet worden getoond: OpenRegister ontbreekt, of een mappingpakket is ongeldig of niet beschikbaar.", + "OpenRegister's migration pack store is not available, so this import used the mapping that ships with stackiq.": "De opslag voor migratiepakketten van OpenRegister is niet beschikbaar, dus deze import gebruikte de mapping die met stackiq wordt meegeleverd.", "The workbook has neither of the sheets %s.": "De werkmap bevat geen van de tabbladen %s.", "Column \"%1$s\": %2$s": "Kolom \"%1$s\": %2$s", "Optional column \"%s\" not found": "Optionele kolom \"%s\" niet gevonden", @@ -1151,15 +1169,13 @@ "The server could not store the uploaded file. The details are in the Nextcloud log.": "De server kon het geüploade bestand niet opslaan. De details staan in het Nextcloud-logboek.", "The file is larger than {size}, the most the import accepts.": "Het bestand is groter dan {size}, het maximum dat de import accepteert.", "The file is larger than the server accepts.": "Het bestand is groter dan de server accepteert.", - "A source sheet may hold at most {limit} rows. Split the export and import the parts one after the other.": "Een brontabblad mag hoogstens {limit} rijen bevatten. Splits de export en importeer de delen na elkaar.", - "Split the export and import the parts one after the other.": "Splits de export en importeer de delen na elkaar.", - "Excel workbook (.xlsx) with the sheet \"{first}\" or \"{second}\". By default the file may be at most {size}.": "Excel-werkmap (.xlsx) met het tabblad \"{first}\" of \"{second}\". Standaard mag het bestand hoogstens {size} zijn.", - "The sheets \"{first}\" (applications without arranged maintenance) and \"{second}\" (with arranged maintenance) are read; other sheets, including the \"Invoer\" sheets, are ignored.": "De tabbladen \"{first}\" (applicaties zonder geregeld beheer) en \"{second}\" (met geregeld beheer) worden gelezen; andere tabbladen, ook de \"Invoer\"-tabbladen, worden genegeerd.", + "A source sheet may hold at most {limit} rows. Split the export and import the parts one after the other with \"Keep them as they are\".": "Een brontabblad mag hoogstens {limit} rijen bevatten. Splits de export en importeer de delen na elkaar met \"Laat ze zoals ze zijn\".", + "Split the export and import the parts one after the other with \"Keep them as they are\".": "Splits de export en importeer de delen na elkaar met \"Laat ze zoals ze zijn\".", "The page got no answer from the import.": "De pagina kreeg geen antwoord van de import.", "The connection was cut off before the import answered, so it may still be running or may have finished. Wait a few minutes and check the applications of the municipality before you import again. Importing the same file again creates no duplicates.": "De verbinding werd verbroken voordat de import antwoordde, dus de import kan nog bezig zijn of al klaar zijn. Wacht een paar minuten en controleer de applicaties van de gemeente voordat u opnieuw importeert. Hetzelfde bestand opnieuw importeren maakt geen dubbele records aan.", "The import cannot be cancelled now: the server has not started its rows yet, or has already finished them. If the import keeps running, press Cancel import again in a moment.": "De import kan nu niet worden geannuleerd: de server is nog niet aan de rijen begonnen, of is er al mee klaar. Loopt de import door, druk dan zo dadelijk opnieuw op Import annuleren.", "The import could not be cancelled: {reason}": "De import kon niet worden geannuleerd: {reason}", - "Cancelling the import. It stops before the next row; the rows already processed stay imported.": "De import wordt geannuleerd. Hij stopt voor de volgende rij; de rijen die al verwerkt zijn blijven geïmporteerd.", + "Cancelling the import. It stops before the next row or, while the applications are compared with the export, before the next application; what was already processed stays.": "De import wordt geannuleerd. Hij stopt voor de volgende rij of, tijdens het vergelijken van de applicaties met de export, voor de volgende applicatie; wat al verwerkt is blijft staan.", "Showing {shown} of {total} rows.": "{shown} van {total} rijen weergegeven.", "Show {count} more rows": "Toon nog {count} rijen", "The request field \"{field}\" has a value the import does not accept.": "Het veld \"{field}\" van het verzoek heeft een waarde die de import niet accepteert.", @@ -1190,14 +1206,74 @@ "conflict: the application with this import key is used by another organisation, so it is not changed": "conflict: de applicatie met deze importsleutel wordt door een andere organisatie gebruikt en wordt daarom niet gewijzigd", "When on, a re-import overwrites the application's name, descriptions, application type, hosting model, BBN level, source fields and supplier, and the usage's status, phase-out date and business owner, with the values from the export. The usage's TIME classification and internal note are only set when the usage is created or the field is empty, so changes made in stackiq stay.": "Staat dit aan, dan overschrijft een herhaalde import de naam, de omschrijvingen, het applicatietype, het hostingmodel, het BBN-niveau, de bronvelden en de leverancier van de applicatie, en de status, de uitfaseerdatum en de functioneel eigenaar van het gebruik, met de waarden uit de export. De TIME-classificatie en de interne notitie van het gebruik worden alleen gezet wanneer het gebruik wordt aangemaakt of het veld leeg is, zodat wijzigingen in stackiq blijven staan.", "An .xlsx file is compressed, so a file of a few MB can be much larger once unpacked. Nothing was imported.": "Een .xlsx-bestand is gecomprimeerd: een bestand van een paar MB kan uitgepakt veel groter zijn. Er is niets geïmporteerd.", - "Split the rows over two copies of the export and import them one after the other.": "Verdeel de rijen over twee kopieën van de export en importeer die na elkaar.", + "Split the rows over two copies of the export and import both with \"Keep them as they are\": an import that archives treats the applications of the other copy as missing.": "Verdeel de rijen over twee kopieën van de export en importeer beide met \"Laat ze zoals ze zijn\": een import die archiveert, ziet de applicaties van de andere kopie als ontbrekend.", "The sheet \"{sheet}\" is too large to import: unpacked it is {size}, and the import reads at most {limit} of one sheet.": "Het tabblad \"{sheet}\" is te groot om te importeren: uitgepakt is het {size}, en de import leest van één tabblad hooguit {limit}.", "The part {part} of the workbook is too large to import: unpacked it is {size}, and the import reads at most {limit} of one part.": "Het onderdeel {part} van de werkmap is te groot om te importeren: uitgepakt is het {size}, en de import leest van één onderdeel hooguit {limit}.", - "Delete the sheets the import does not read from a copy of the export (it reads only \"{first}\" and \"{second}\"), and import that copy.": "Verwijder in een kopie van de export de tabbladen die de import niet leest (hij leest alleen \"{first}\" en \"{second}\"), en importeer die kopie.", "The workbook holds more than {count} different texts, the most the import reads.": "De werkmap bevat meer dan {count} verschillende teksten, het maximum dat de import leest.", "Together, the cells of the workbook reference more than {size} of shared text, the most the import reads.": "Samen verwijzen de cellen van de werkmap naar meer dan {size} gedeelde tekst, het maximum dat de import leest.", "In development since": "In ontwikkeling sinds", "In use since": "In gebruik sinds", + "Application (module)": "Applicatie (module)", + "Supplier organisation (Vendor)": "Leveranciersorganisatie (Vendor)", + "Business owner (contact person)": "Business owner (contactpersoon)", + "Loading the mapping…": "Mapping laden…", + "The mapping could not be loaded.": "De mapping kon niet worden geladen.", + "Sheets read": "Gelezen tabbladen", + "Match column": "Koppelkolom", + "Name column": "Naamkolom", + "Required columns": "Verplichte kolommen", + "Date columns": "Datumkolommen", + "The import mapping could not be read. The details are in the Nextcloud log.": "De mapping van de import kon niet worden gelezen. De details staan in het Nextcloud-logboek.", + "Mapping": "Mapping", + "OpenRegister's pack store is not available, so the import uses the mapping shipped with stackiq. Update or enable OpenRegister to view and edit the mapping there.": "De packopslag van OpenRegister is niet beschikbaar, dus de import gebruikt de mapping die met stackiq wordt meegeleverd. Werk OpenRegister bij of schakel het in om de mapping daar te bekijken en te bewerken.", + "OpenRegister": "OpenRegister", + "Shipped file": "Meegeleverd bestand", + "Version {version}": "Versie {version}", + "Version {version} (shipped: {shipped})": "Versie {version} (meegeleverd: {shipped})", + "Edited": "Bewerkt", + "Edit in OpenRegister": "Bewerken in OpenRegister", + "Edit in OpenRegister: {target} (opens in a new tab)": "Bewerken in OpenRegister: {target} (opent in een nieuw tabblad)", + "Stackiq ships a newer version of this pack ({version}). It was not applied, because the pack was edited in OpenRegister. Delete the pack there to use the shipped version from the next import on; your edits are then lost.": "Stackiq levert een nieuwere versie van dit pack mee ({version}). Die is niet toegepast, omdat het pack in OpenRegister is bewerkt. Verwijder het pack daar om vanaf de volgende import de meegeleverde versie te gebruiken; de wijzigingen gaan dan verloren.", + "Excel workbook (.xlsx) with the sheet {sheets}. By default the file may be at most {size}.": "Excel-werkmap (.xlsx) met het tabblad {sheets}. Standaard mag het bestand hoogstens {size} zijn.", + "Excel workbook (.xlsx) with one of the sheets {sheets}. By default the file may be at most {size}.": "Excel-werkmap (.xlsx) met een van de tabbladen {sheets}. Standaard mag het bestand hoogstens {size} zijn.", + "The sheet {sheets} is read, and of the sheet \"{archive}\" only the APPID column; other sheets, including the \"Invoer\" sheets, are ignored.": "Het tabblad {sheets} wordt gelezen, en van het tabblad \"{archive}\" alleen de kolom APPID; andere tabbladen, ook de \"Invoer\"-tabbladen, worden genegeerd.", + "The sheets {sheets} are read, and of the sheet \"{archive}\" only the APPID column; other sheets, including the \"Invoer\" sheets, are ignored.": "De tabbladen {sheets} worden gelezen, en van het tabblad \"{archive}\" alleen de kolom APPID; andere tabbladen, ook de \"Invoer\"-tabbladen, worden genegeerd.", + "Expected the sheet {sheets}. Sheet names must match exactly.": "Verwacht werd het tabblad {sheets}. De naam van het tabblad moet precies overeenkomen.", + "Expected one of the sheets {sheets}. Sheet names must match exactly.": "Verwacht werd een van de tabbladen {sheets}. De namen van de tabbladen moeten precies overeenkomen.", + "Delete the sheets the import does not read from a copy of the export (it reads {sheets}, and the APPID column of \"{archive}\"), and import that copy.": "Verwijder in een kopie van de export de tabbladen die de import niet leest (hij leest {sheets}, en de kolom APPID van \"{archive}\"), en importeer die kopie.", + "The sheet {sheets} is read; other sheets, including the \"Invoer\" sheets, are ignored.": "Het tabblad {sheets} wordt gelezen; andere tabbladen, ook de \"Invoer\"-tabbladen, worden genegeerd.", + "The sheets {sheets} are read; other sheets, including the \"Invoer\" sheets, are ignored.": "De tabbladen {sheets} worden gelezen; andere tabbladen, ook de \"Invoer\"-tabbladen, worden genegeerd.", + "Delete the sheets the import does not read from a copy of the export (it reads only {sheets}), and import that copy.": "Verwijder in een kopie van de export de tabbladen die de import niet leest (hij leest alleen {sheets}), en importeer die kopie.", + "A pack deleted in OpenRegister is restored from the shipped file at the next import.": "Een pack dat in OpenRegister is verwijderd, wordt bij de volgende import hersteld uit het meegeleverde bestand.", + "Choose a municipality, or type a new name and press Enter.": "Kies een gemeente, of typ een nieuwe naam en druk op Enter.", + "Kind of record": "Soort gegeven", + "New applications become visible to everyone, also without logging in.": "Nieuwe applicaties worden voor iedereen zichtbaar, ook zonder in te loggen.", + "Overwrites applications imported before with the values from the export. The (i) button above lists the fields.": "Overschrijft eerder geïmporteerde applicaties met de waarden uit de export. De (i)-knop bovenaan noemt de velden.", + "Stored in": "Opgeslagen in", + "The export": "De export", + "Which columns of the export the next import reads, and where each column goes.": "Welke kolommen van de export de volgende import leest, en waar elke kolom heen gaat.", + "Packs": "Packs", + "Update pending: shipped {version} replaces stored {storedVersion} at the next import.": "Update in afwachting: de meegeleverde versie {version} vervangt de opgeslagen versie {storedVersion} bij de volgende import.", + "Columns and fields: {target}": "Kolommen en velden: {target}", + "Which column of the export goes to which field": "Welke kolom van de export naar welk veld gaat", + "Column of the export": "Kolom van de export", + "Field": "Veld", + "Transform": "Omzetting", + "Yes": "Ja", + "No": "Nee", + "What the import writes": "Wat de import schrijft", + "Set on every record": "Op elk record gezet", + "Set on a new record only": "Alleen op een nieuw record gezet", + "Written on a new record, or on an existing one only when empty": "Op een nieuw record geschreven, of op een bestaand record alleen als de waarde leeg is", + "Never written on an existing record": "Nooit geschreven op een bestaand record", + "The mapping could not be loaded. Open Mapping for the reason.": "De mapping kon niet worden geladen. Open Mapping voor de reden.", + "{count} archived": "{count} gearchiveerd", + "{count} unarchived": "{count} uit het archief gehaald", + "{count} deleted": "{count} verwijderd", + "{count} restored": "{count} teruggezet", + "Applications: {changes}.": "Applicaties: {changes}.", + "This tab lists the whole archive. It ignores the GEMMA filters.": "Dit tabblad toont het hele archief. De GEMMA-filters worden genegeerd.", + "Applications no longer in the export are archived or moved to the trash. The (i) button above explains when.": "Applicaties die niet meer in de export staan, worden gearchiveerd of naar de prullenbak verplaatst. De (i)-knop bovenaan legt uit wanneer.", "Not signed in": "Niet aangemeld", "At most %s contact persons per request": "Ten hoogste %s contactpersonen per verzoek", "Loading the name": "De naam wordt geladen", diff --git a/lib/Controller/CmdbImportController.php b/lib/Controller/CmdbImportController.php index 7d1c00a8f..8eaf1a3c2 100644 --- a/lib/Controller/CmdbImportController.php +++ b/lib/Controller/CmdbImportController.php @@ -86,7 +86,8 @@ public function __construct( * Import a TOPdesk CMDB export for one municipality. * * Multipart fields: `cmdbFile`, `municipalityUuid` or `municipalityName`, - * `updateExisting` (default true), `publish` (default true), `missingRecords` (only `keep`) and + * `updateExisting` (default true), `publish` (default true), `missingRecords` (`keep` or `archive`, + * default `archive`) and * `operationId` (pattern `cmdb-` plus 8 to 64 letters, digits or hyphens). * * @return JSONResponse The report (200), or an error envelope with the contract code. @@ -94,6 +95,7 @@ public function __construct( * @auth admin-only the import writes with RBAC and multitenancy off, across tenants, so only a full Nextcloud admin may run it. * * @spec openspec/changes/cmdb-export-import/tasks.md#task-8 + * @spec openspec/changes/cmdb-import-archive-reconciliation/specs/cmdb-export-import/spec.md#requirement-records-missing-from-a-newer-export-shall-be-archived-by-default-or-kept-on-request-req-cmdb-012 */ public function import(): JSONResponse { try { @@ -247,15 +249,21 @@ protected function iniBytes(string $name): ?int { * @return array{path: string, options: array}|JSONResponse The import input, or the first error. * * @spec openspec/changes/cmdb-export-import/tasks.md#task-8 + * @spec openspec/changes/cmdb-import-archive-reconciliation/specs/cmdb-export-import/spec.md#requirement-records-missing-from-a-newer-export-shall-be-archived-by-default-or-kept-on-request-req-cmdb-012 */ private function readOptions(string $path, string $fileName): array|JSONResponse { - $missingRecords = $this->stringParam(name: 'missingRecords', default: 'keep'); + $missingRecords = $this->stringParam(name: 'missingRecords', default: CmdbExportImportService::DEFAULT_MISSING_RECORDS); if ($missingRecords === null) { return $this->invalidField(field: 'missingRecords'); } - if ($this->importService->supportsMissingRecords(mode: $missingRecords) === false) { - return $this->error(code: 'MISSING_RECORDS_UNSUPPORTED', status: Http::STATUS_UNPROCESSABLE_ENTITY, details: ['accepted' => ['keep']]); + $accepted = $this->importService->missingRecordsModes(); + if (in_array($missingRecords, $accepted, true) === false) { + return $this->error( + code: 'MISSING_RECORDS_UNSUPPORTED', + status: Http::STATUS_UNPROCESSABLE_ENTITY, + details: ['accepted' => $accepted] + ); } // An unrecognised value is refused rather than read as true: true is the mode that overwrites. @@ -293,6 +301,7 @@ private function readOptions(string $path, string $fileName): array|JSONResponse 'municipalityName' => $municipalityName, 'updateExisting' => $updateExisting, 'publish' => $publish, + 'missingRecords' => $missingRecords, 'operationId' => $this->request->getParam('operationId'), 'fileName' => basename(str_replace('\\', '/', $fileName)), ], @@ -384,6 +393,8 @@ private function error(string $code, int $status, array $details = []): JSONResp * @return string * * @SuppressWarnings(PHPMD.CyclomaticComplexity) One branch per contract error code. + * + * @spec openspec/changes/cmdb-import-mapping-view/tasks.md#task-1 */ private function message(string $code, array $details): string { $megabytes = (string)round((int)($details['maxBytes'] ?? $this->importService->maxFileBytes()) / 1048576, 1); @@ -394,14 +405,14 @@ private function message(string $code, array $details): string { 'NO_FILE_UPLOADED' => $this->l10n->t('No file was uploaded.'), 'NOT_XLSX' => $this->l10n->t('The file is not an Excel workbook (.xlsx).'), 'FILE_TOO_LARGE' => $this->l10n->t('The file is larger than the maximum of %s MB.', [$megabytes]), - 'MISSING_RECORDS_UNSUPPORTED' => $this->l10n->t('Only keeping records that are missing from the export is supported.'), + 'MISSING_RECORDS_UNSUPPORTED' => $this->l10n->t('Applications missing from the export can only be archived or kept.'), 'FIELD_INVALID' => $this->fieldMessage(field: (string)($details['field'] ?? ''), accepted: $accepted), 'MUNICIPALITY_REQUIRED' => $this->l10n->t('Choose a municipality or enter the name of a new one.'), 'MUNICIPALITY_INVALID' => $this->l10n->t('The chosen organisation is not a municipality.'), 'NO_SOURCE_SHEET' => $this->l10n->t('The workbook has neither of the sheets %s.', [$expected]), 'MISSING_COLUMN' => $this->l10n->t('Sheet "%1$s" has no column "%2$s".', [(string)($details['sheet'] ?? ''), (string)($details['column'] ?? '')]), 'TOO_MANY_ROWS' => $this->l10n->t('Sheet "%1$s" has more than %2$s rows.', [(string)($details['sheet'] ?? ''), (string)($details['limit'] ?? '')]), - 'MAPPING_UNAVAILABLE' => $this->l10n->t('The import mapping cannot run: OpenRegister is missing or a mapping file is invalid.'), + 'MAPPING_UNAVAILABLE' => $this->mappingMessage(details: $details), 'READER_UNAVAILABLE' => $this->l10n->t('The Excel reader is not available: OpenRegister is missing or incomplete.'), 'NOT_CONFIGURED' => $this->l10n->t('Stackiq is not configured: the register or its schemas cannot be found.'), 'OPERATION_NOT_FOUND' => $this->l10n->t('No running CMDB import has this id.'), @@ -410,10 +421,38 @@ private function message(string $code, array $details): string { 'SCHEMA_OUTDATED' => $this->l10n->t('The stackiq register is out of date; import its configuration again.'), 'IMPORT_IN_PROGRESS' => $this->l10n->t('Another CMDB import is running; try again when it has finished.'), 'MUNICIPALITY_AMBIGUOUS' => $this->l10n->t('Several municipalities have this name; choose one from the list.'), + 'ARCHIVE_UNAVAILABLE' => $this->l10n->t( + 'Applications missing from the export cannot be archived: OpenRegister is missing or too old. Choose to keep them, or update OpenRegister.' + ), default => $this->l10n->t('The import failed. The details are in the Nextcloud log.'), }; }//end message() + /** + * The message of MAPPING_UNAVAILABLE, naming the OpenRegister migration pack when one is at fault. + * + * @param array $details The details: `pack` and `packId` for a pack stored in OpenRegister. + * + * @return string + * + * @spec openspec/changes/cmdb-import-mapping-view/tasks.md#task-1 + */ + private function mappingMessage(array $details): string { + $pack = ($details['pack'] ?? null); + if (is_string($pack) === false || $pack === '') { + return $this->l10n->t('The import mapping cannot run: OpenRegister is missing, or a mapping pack is invalid or unavailable.'); + } + + if (is_int($details['packId'] ?? null) === true) { + $pack .= ' (id ' . $details['packId'] . ')'; + } + + return $this->l10n->t( + 'The import mapping cannot run: the OpenRegister migration pack %s is invalid or cannot be read. The details are in the Nextcloud log.', + [$pack] + ); + }//end mappingMessage() + /** * The message of FIELD_INVALID, naming the accepted values when the field has a fixed set. * diff --git a/lib/Controller/SettingsController.php b/lib/Controller/SettingsController.php index 2e5fd4b2e..f4faa4bf7 100644 --- a/lib/Controller/SettingsController.php +++ b/lib/Controller/SettingsController.php @@ -26,8 +26,10 @@ use OCA\OpenRegister\Contract\ObjectServiceInterface; use OCA\OpenRegister\Service\ConfigurationService; +use OCA\Stackiq\Exception\CmdbImportException; use OCA\Stackiq\Service\ArchiMateImportService; use OCA\Stackiq\Service\ArchiMateService; +use OCA\Stackiq\Service\Cmdb\CmdbImportProfile; use OCA\Stackiq\Service\ConnectionReportService; use OCA\Stackiq\Service\EolSyncService; use OCA\Stackiq\Service\OrganizationSyncService; @@ -42,7 +44,9 @@ use OCP\IAppConfig; use OCP\IConfig; use OCP\IGroupManager; +use OCP\IL10N; use OCP\IRequest; +use OCP\IURLGenerator; use OCP\IUserSession; use Psr\Container\ContainerInterface; use Psr\Log\LoggerInterface; @@ -64,6 +68,20 @@ */ class SettingsController extends Controller { + /** + * The longest loader reason the CMDB mapping endpoint answers, in characters. + * + * @var int + */ + private const REASON_MAX_LENGTH = 500; + + /** + * OpenRegister's single-page catch-all route, which serves its migration-pack editor. + * + * @var string + */ + private const OPENREGISTER_PAGE_ROUTE = 'openregister.dashboard.catchAll'; + /** * The OpenRegister object service. * @@ -88,10 +106,14 @@ class SettingsController extends Controller { * @param EolSyncService $eolSyncService The EOL feed sync orchestration service. * @param LoggerInterface $logger The logger instance. * @param ConnectionReportService|null $connectionReports Asks integriq to look again after an email settings save. + * @param CmdbImportProfile|null $cmdbImportProfile The CMDB import profile and packs; null builds the shipped one. + * @param IL10N|null $l10n Translations of the CMDB mapping messages. + * @param IURLGenerator|null $urlGenerator Builds the link to a CMDB mapping pack's editor in OpenRegister. * * @SuppressWarnings(PHPMD.ExcessiveParameterList) * * @spec openspec/changes/adopt-connection-registry/specs/admin-integrations/spec.md#requirement-req-stackiq-conn-002-a-save-asks-integriq-to-look-again-and-a-run-reports-what-it-met + * @spec openspec/changes/cmdb-import-mapping-view/specs/cmdb-export-import/spec.md#requirement-the-admin-settings-shall-show-the-mapping-the-import-uses-req-cmdb-020 */ public function __construct( $appName, @@ -108,6 +130,9 @@ public function __construct( private readonly EolSyncService $eolSyncService, private readonly LoggerInterface $logger, private readonly ?ConnectionReportService $connectionReports = null, + private readonly ?CmdbImportProfile $cmdbImportProfile = null, + private readonly ?IL10N $l10n = null, + private readonly ?IURLGenerator $urlGenerator = null, ) { parent::__construct(appName: $appName, request: $request); @@ -3883,4 +3908,131 @@ public function getEolSyncStatus(): JSONResponse { return $this->buildConfigReadErrorResponse(operationLabel: 'get EOL sync status', exception: $e); } }//end getEolSyncStatus() + + /** + * The column mapping the CMDB import uses, read-only, with where each pack is edited. + * + * Loads the import profile and its packs through the loader the import + * uses (CmdbImportProfile), so the answer is what the next import runs: + * each sheet pack from OpenRegister's migration-pack store when it holds + * it, otherwise the shipped file. Success is the flat + * `{profile, packs, openRegisterPacks}`; every pack carries its source and + * versions and an `editUrl`, the absolute link to its editor in + * OpenRegister, or null when it is not stored there. A failure uses the + * import's error envelope, so the section shows it like an import error, + * with the loader's reason in `details.reason` because the admin who + * edited a pack needs to know which pack and why; a pack stored in + * OpenRegister is also named in `details.pack` and `details.packId`, with + * `details.editUrl` linking to its editor so the admin can correct it. That reason is the + * loader's message cut to its first line and REASON_MAX_LENGTH characters: + * the file or the OpenRegister pack and its id, the broken rule and the + * configuration value it refused, never a workbook cell or a person. + * + * @return JSONResponse `{profile, packs, openRegisterPacks}` (200), 503 MAPPING_UNAVAILABLE, or 500 IMPORT_FAILED. + * + * @auth admin-only the import's configuration; the import writes with RBAC and multitenancy off, so its view keeps that posture. + * + * @spec openspec/changes/cmdb-import-mapping-view/specs/cmdb-export-import/spec.md#requirement-the-admin-settings-shall-show-the-mapping-the-import-uses-req-cmdb-020 + * @spec openspec/changes/cmdb-import-mapping-view/tasks.md#task-3 + */ + public function getCmdbImportMapping(): JSONResponse { + $profile = ($this->cmdbImportProfile ?? new CmdbImportProfile(container: $this->container)); + + try { + $overview = $profile->mappingOverview(); + } catch (CmdbImportException $e) { + $this->logger->info( + 'SettingsController: CMDB import mapping unavailable', + ['error' => $e->getErrorCode(), 'reason' => $e->getMessage()] + ); + $details = array_merge($e->getDetails(), ['reason' => self::boundedReason(message: $e->getMessage())]); + if (is_int($details['packId'] ?? null) === true) { + $details['editUrl'] = $this->packEditUrl(packId: $details['packId']); + } + + return new JSONResponse( + [ + 'success' => false, + 'error' => $e->getErrorCode(), + 'message' => ( + $this->l10n?->t('The import mapping cannot be shown: OpenRegister is missing, or a mapping pack is invalid or unavailable.') + ?? 'The import mapping cannot be shown: OpenRegister is missing, or a mapping pack is invalid or unavailable.' + ), + 'details' => (object)$details, + ], + $e->getHttpStatus() + ); + } catch (\Throwable $e) { + $this->logger->error('SettingsController: CMDB import mapping failed', ['exception' => $e]); + return new JSONResponse( + [ + 'success' => false, + 'error' => 'IMPORT_FAILED', + 'message' => ( + $this->l10n?->t('The import mapping could not be read. The details are in the Nextcloud log.') + ?? 'The import mapping could not be read. The details are in the Nextcloud log.' + ), + 'details' => (object)[], + ], + Http::STATUS_INTERNAL_SERVER_ERROR + ); + }//end try + + foreach ($overview['packs'] as $index => $pack) { + $overview['packs'][$index]['editUrl'] = $this->packEditUrl(packId: ($pack['packId'] ?? null)); + } + + return new JSONResponse($overview, Http::STATUS_OK); + }//end getCmdbImportMapping() + + /** + * The absolute link to a migration pack's editor in OpenRegister. + * + * Built from OpenRegister's catch-all page route, so an instance that + * needs `/index.php` in its URLs gets it. + * + * @param int|null $packId The OpenRegister row id, or null for a pack that is not stored there. + * + * @return string|null Null when the pack is not stored in OpenRegister or the link cannot be built. + * + * @spec openspec/changes/cmdb-import-mapping-view/tasks.md#task-3 + */ + private function packEditUrl(?int $packId): ?string { + if ($packId === null || $this->urlGenerator === null) { + return null; + } + + $path = 'migration-packs/' . $packId; + try { + $url = $this->urlGenerator->linkToRouteAbsolute(self::OPENREGISTER_PAGE_ROUTE, ['path' => $path]); + } catch (\Throwable $e) { + $this->logger->info('SettingsController: no link to the OpenRegister pack editor', ['exception' => get_class($e)]); + return null; + } + + // Nextcloud's router answers an unknown route with an empty path, which would link to the instance's front page. + if (str_ends_with($url, '/' . $path) === false) { + return null; + } + + return $url; + }//end packEditUrl() + + /** + * A loader message as the mapping endpoint answers it: its first line, at most REASON_MAX_LENGTH characters. + * + * @param string $message The CmdbImportException message. + * + * @return string + * + * @spec openspec/changes/cmdb-import-mapping-view/specs/cmdb-export-import/spec.md#requirement-the-admin-settings-shall-show-the-mapping-the-import-uses-req-cmdb-020 + */ + private static function boundedReason(string $message): string { + $firstLine = strtok($message, "\r\n"); + if ($firstLine === false) { + return ''; + } + + return mb_substr($firstLine, 0, self::REASON_MAX_LENGTH); + }//end boundedReason() }//end class diff --git a/lib/Exception/CmdbImportException.php b/lib/Exception/CmdbImportException.php index 31404c505..65127a9fe 100644 --- a/lib/Exception/CmdbImportException.php +++ b/lib/Exception/CmdbImportException.php @@ -50,6 +50,7 @@ class CmdbImportException extends RuntimeException { public const SCHEMA_OUTDATED = 'SCHEMA_OUTDATED'; public const IMPORT_IN_PROGRESS = 'IMPORT_IN_PROGRESS'; public const MUNICIPALITY_AMBIGUOUS = 'MUNICIPALITY_AMBIGUOUS'; + public const ARCHIVE_UNAVAILABLE = 'ARCHIVE_UNAVAILABLE'; /** * HTTP status per error code. @@ -70,6 +71,7 @@ class CmdbImportException extends RuntimeException { self::SCHEMA_OUTDATED => 503, self::IMPORT_IN_PROGRESS => 409, self::MUNICIPALITY_AMBIGUOUS => 422, + self::ARCHIVE_UNAVAILABLE => 503, ]; /** diff --git a/lib/Repair/SeedCmdbImportPacks.php b/lib/Repair/SeedCmdbImportPacks.php new file mode 100644 index 000000000..3d911e9b4 --- /dev/null +++ b/lib/Repair/SeedCmdbImportPacks.php @@ -0,0 +1,146 @@ + + * @copyright 2026 Conduction B.V. + * @license EUPL-1.2 https://joinup.ec.europa.eu/collection/eupl/eupl-text-eupl-12 + * @link https://github.com/ConductionNL/stackiq + * + * @spec openspec/changes/cmdb-import-mapping-view/tasks.md#task-2 + * + * SPDX-FileCopyrightText: 2026 Conduction B.V. + * SPDX-License-Identifier: EUPL-1.2 + */ + +declare(strict_types=1); + +namespace OCA\Stackiq\Repair; + +use OCA\Stackiq\Service\Cmdb\CmdbImportPackStore; +use OCA\Stackiq\Service\Cmdb\CmdbImportProfile; +use OCP\Migration\IOutput; +use OCP\Migration\IRepairStep; +use Psr\Log\LoggerInterface; +use Throwable; + +/** + * Seeds and updates the CMDB import packs in OpenRegister's migration-pack store. + * + * @spec openspec/changes/cmdb-import-mapping-view/tasks.md#task-2 + */ +class SeedCmdbImportPacks implements IRepairStep { + /** + * Constructor. + * + * @param CmdbImportProfile $profile Reads and validates the shipped packs. + * @param CmdbImportPackStore $store OpenRegister's migration-pack store. + * @param LoggerInterface $logger Logger for seed diagnostics. + * + * @spec openspec/changes/cmdb-import-mapping-view/tasks.md#task-2 + */ + public function __construct( + private readonly CmdbImportProfile $profile, + private readonly CmdbImportPackStore $store, + private readonly LoggerInterface $logger, + ) { + }//end __construct() + + /** + * The name of this repair step. + * + * @return string + * + * @spec openspec/changes/cmdb-import-mapping-view/tasks.md#task-2 + */ + public function getName(): string { + return 'Seed the CMDB import mapping packs into OpenRegister'; + }//end getName() + + /** + * Seed the missing packs and update the unedited ones. + * + * @param IOutput $output Output interface for status messages. + * + * @return void + * + * @spec openspec/changes/cmdb-import-mapping-view/tasks.md#task-2 + */ + public function run(IOutput $output): void { + if ($this->store->isAvailable() === false) { + $output->info('OpenRegister migration pack store not available; CMDB import packs not seeded'); + return; + } + + try { + $packs = $this->profile->shippedEditablePacks(); + } catch (Throwable $e) { + $this->logger->warning('[SeedCmdbImportPacks] shipped packs unreadable: ' . $e->getMessage()); + $output->warning('CMDB import packs not seeded: ' . $e->getMessage()); + return; + } + + foreach ($packs as $shipped) { + $this->seed(output: $output, shipped: $shipped); + } + }//end run() + + /** + * Seed or update one pack, and report what happened. + * + * @param IOutput $output Output interface for status messages. + * @param array $shipped The shipped pack. + * + * @return void + * + * @spec openspec/changes/cmdb-import-mapping-view/tasks.md#task-2 + */ + private function seed(IOutput $output, array $shipped): void { + $slug = (string)($shipped['id'] ?? ''); + try { + $stored = $this->store->resolve(shipped: $shipped); + } catch (Throwable $e) { + $this->logger->warning('[SeedCmdbImportPacks] ' . $slug . ': ' . $e->getMessage()); + $output->warning('CMDB import pack ' . $slug . ' not seeded: ' . $e->getMessage()); + return; + } + + $where = $slug . ' (id ' . $stored['id'] . ')'; + if ($stored['outcome'] === CmdbImportPackStore::SEEDED) { + $output->info('Seeded CMDB import pack ' . $where); + return; + } + + if ($stored['outcome'] === CmdbImportPackStore::UPDATED) { + $output->info('Updated unedited CMDB import pack ' . $where . ' to version ' . $stored['version']); + return; + } + + if ($stored['newerShipped'] === true) { + $output->warning( + 'CMDB import pack ' . $where . ' was edited in OpenRegister and is kept; this release ships version ' + . (string)($shipped['version'] ?? '') . ', which is not applied' + ); + return; + } + + $output->info('CMDB import pack ' . $where . ' already present'); + }//end seed() +}//end class diff --git a/lib/Service/Cmdb/CmdbImportPackMarker.php b/lib/Service/Cmdb/CmdbImportPackMarker.php new file mode 100644 index 000000000..5d41765f9 --- /dev/null +++ b/lib/Service/Cmdb/CmdbImportPackMarker.php @@ -0,0 +1,175 @@ + + * @copyright 2026 Conduction B.V. + * @license EUPL-1.2 https://joinup.ec.europa.eu/collection/eupl/eupl-text-eupl-12 + * @link https://github.com/ConductionNL/stackiq + * + * @spec openspec/changes/cmdb-import-mapping-view/tasks.md#task-1 + * + * SPDX-FileCopyrightText: 2026 Conduction B.V. + * SPDX-License-Identifier: EUPL-1.2 + */ + +declare(strict_types=1); + +namespace OCA\Stackiq\Service\Cmdb; + +/** + * Adds, reads and compares the seed marker of a stored pack. + * + * @spec openspec/changes/cmdb-import-mapping-view/tasks.md#task-1 + */ +class CmdbImportPackMarker { + /** + * The definition key that records what stackiq seeded. + */ + public const KEY = 'x-stackiq'; + + /** + * The hash stackiq records for a shipped pack: sha256 of its canonical JSON. + * + * @param array $pack The pack, without the marker. + * + * @return string + * + * @spec openspec/changes/cmdb-import-mapping-view/tasks.md#task-1 + */ + public function hash(array $pack): string { + $json = json_encode($this->canonical(value: $pack), JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE | JSON_PRESERVE_ZERO_FRACTION); + return hash('sha256', (string)$json); + }//end hash() + + /** + * The shipped pack as it is stored: with the marker. + * + * @param array $shipped The shipped pack. + * + * @return array + * + * @spec openspec/changes/cmdb-import-mapping-view/tasks.md#task-1 + */ + public function seed(array $shipped): array { + $definition = $this->strip(definition: $shipped); + $definition[self::KEY] = [ + 'shippedVersion' => (string)($shipped['version'] ?? ''), + 'shippedHash' => $this->hash(pack: $definition), + ]; + + return $definition; + }//end seed() + + /** + * A stored definition without the marker: the pack the engine runs. + * + * @param array $definition The stored definition. + * + * @return array + * + * @spec openspec/changes/cmdb-import-mapping-view/tasks.md#task-1 + */ + public function strip(array $definition): array { + unset($definition[self::KEY]); + return $definition; + }//end strip() + + /** + * Whether a stored definition differs from what stackiq seeded. + * + * @param array $definition The stored definition. + * + * @return bool|null Null when it carries no marker, so nobody knows what was seeded. + * + * @spec openspec/changes/cmdb-import-mapping-view/tasks.md#task-1 + */ + public function isEdited(array $definition): ?bool { + $recorded = $this->recordedHash(definition: $definition); + if ($recorded === null) { + return null; + } + + return $this->hash(pack: $this->strip(definition: $definition)) !== $recorded; + }//end isEdited() + + /** + * Whether a stored pack nobody edited was seeded from another shipped pack than this one. + * + * @param array $definition The stored definition. + * @param array $shipped The shipped pack. + * + * @return bool + * + * @spec openspec/changes/cmdb-import-mapping-view/tasks.md#task-1 + */ + public function isOutdated(array $definition, array $shipped): bool { + return $this->isEdited(definition: $definition) === false + && $this->recordedHash(definition: $definition) !== $this->hash(pack: $shipped); + }//end isOutdated() + + /** + * Whether an edited stored pack was seeded from a shipped pack that has changed since. + * + * @param array $definition The stored definition. + * @param array $shipped The shipped pack. + * + * @return bool + * + * @spec openspec/changes/cmdb-import-mapping-view/tasks.md#task-1 + */ + public function isNewerShipped(array $definition, array $shipped): bool { + return $this->isEdited(definition: $definition) === true + && $this->recordedHash(definition: $definition) !== $this->hash(pack: $shipped); + }//end isNewerShipped() + + /** + * The hash the marker of a stored definition records. + * + * @param array $definition The stored definition. + * + * @return string|null + * + * @spec openspec/changes/cmdb-import-mapping-view/tasks.md#task-1 + */ + private function recordedHash(array $definition): ?string { + $hash = ($definition[self::KEY]['shippedHash'] ?? null); + if (is_string($hash) === false || $hash === '') { + return null; + } + + return $hash; + }//end recordedHash() + + /** + * A value with every object's keys sorted, recursively. + * + * @param mixed $value The value. + * + * @return mixed + * + * @spec openspec/changes/cmdb-import-mapping-view/tasks.md#task-1 + */ + private function canonical(mixed $value): mixed { + if (is_array($value) === false) { + return $value; + } + + if (array_is_list($value) === false) { + ksort($value, SORT_STRING); + } + + return array_map(fn ($item) => $this->canonical(value: $item), $value); + }//end canonical() +}//end class diff --git a/lib/Service/Cmdb/CmdbImportPackRules.php b/lib/Service/Cmdb/CmdbImportPackRules.php new file mode 100644 index 000000000..9da72dbce --- /dev/null +++ b/lib/Service/Cmdb/CmdbImportPackRules.php @@ -0,0 +1,403 @@ + + * @copyright 2026 Conduction B.V. + * @license EUPL-1.2 https://joinup.ec.europa.eu/collection/eupl/eupl-text-eupl-12 + * @link https://github.com/ConductionNL/stackiq + * + * @spec openspec/changes/cmdb-import-mapping-view/tasks.md#task-1 + * + * SPDX-FileCopyrightText: 2026 Conduction B.V. + * SPDX-License-Identifier: EUPL-1.2 + */ + +declare(strict_types=1); + +namespace OCA\Stackiq\Service\Cmdb; + +use OCA\Stackiq\Exception\CmdbImportException; + +/** + * Lists the import rules a pack breaks. + * + * @spec openspec/changes/cmdb-import-mapping-view/tasks.md#task-1 + */ +class CmdbImportPackRules { + /** + * The fields a pack must map with `required: true`, per target. + * + * The import keys a module on its APPID and recognises a manufacturer, + * a municipality and an owner by name; without them it cannot match. + * + * @var array> + */ + private const REQUIRED_TARGETS = [ + 'module' => ['name', 'externalNumber'], + 'manufacturer' => ['name'], + 'municipality' => ['name'], + 'usage' => [], + 'businessOwner' => ['name'], + ]; + + /** + * The register schema a target writes into; a field a pack maps must be a plain property of it. + * + * @var array + */ + private const TARGET_SCHEMAS = [ + 'module' => 'module', + 'manufacturer' => 'organization', + 'municipality' => 'organization', + 'usage' => 'usage', + ]; + + /** + * The fields a pack may map or default for a target that writes into no schema. + * + * The business owner is resolved in Nextcloud Contacts by name, with the + * role on the contact person, so it has no schema to read its fields from. + * + * @var array> + */ + private const FIELDS_WITHOUT_SCHEMA = [ + 'businessOwner' => ['name', 'role'], + ]; + + /** + * Fields no pack may write: object metadata, and the keys and relations the import sets itself. + * + * @var array + */ + private const MANAGED_FIELDS = ['@self', 'id', 'provider', 'consumer', 'module', 'externalKey', 'businessOwner']; + + /** + * Fields only the catalogue or an administrator sets: the publication dates and the admin fields. + * + * The pinned defaults below may still set some of them, as shipped. + * + * @var array + */ + private const PROTECTED_FIELDS = [ + 'publicationDate', + 'depublicationDate', + 'registeredBy', + 'registrationStatus', + 'mergedInto', + 'contactsUid', + 'pki', + 'xml', + ]; + + /** + * Further protected fields per target: an organisation's approval status, a module's type and the version the service desk records as installed. + * + * @var array> + */ + private const PROTECTED_TARGET_FIELDS = [ + 'module' => ['type'], + 'manufacturer' => ['status'], + 'municipality' => ['status'], + 'usage' => ['installedVersion'], + ]; + + /** + * Further match keys per target: the import finds an organisation by name and type. + * + * @var array> + */ + private const MATCH_FIELDS = ['manufacturer' => ['type'], 'municipality' => ['type']]; + + /** + * Defaults a pack must keep as shipped, per target. + * + * The organisation type is a match key; the status and who registered it + * are admin fields that a pack may set only to these values. + * + * @var array> + */ + private const PINNED_DEFAULTS = [ + 'manufacturer' => ['type' => 'Supplier', 'status' => 'Active', 'registeredBy' => 'Supplier'], + 'municipality' => ['type' => 'Municipality', 'status' => 'Active'], + ]; + + /** + * The register's properties per schema with why no pack may write them, read once. + * + * @var CmdbRegisterSchemaFields|null + */ + private ?CmdbRegisterSchemaFields $registerSchema = null; + + /** + * Constructor. + * + * @param string|null $settingsDirectory Directory of the register file and its fragments; null is the shipped one. + * + * @spec openspec/changes/cmdb-import-mapping-view/tasks.md#task-1 + */ + public function __construct( + private ?string $settingsDirectory = null, + ) { + if ($this->settingsDirectory === null) { + $this->settingsDirectory = __DIR__ . '/../../Settings'; + } + }//end __construct() + + /** + * The rules a pack breaks, as readable sentences; empty when it follows them all. + * + * @param string $target The profile target. + * @param array $pack The pack, validated by OpenRegister. + * @param array $profile The decoded import profile. + * + * @return array + * + * @throws CmdbImportException MAPPING_UNAVAILABLE when the register cannot be read. + * + * @spec openspec/changes/cmdb-import-mapping-view/tasks.md#task-1 + */ + public function violations(string $target, array $pack, array $profile): array { + $never = $profile['neverWritten'][$target] ?? []; + if (is_array($never) === false) { + $never = []; + } + + $refused = [ + 'managed' => array_merge(self::MANAGED_FIELDS, (self::MATCH_FIELDS[$target] ?? []), array_map('strval', $never)), + 'protected' => array_merge(self::PROTECTED_FIELDS, (self::PROTECTED_TARGET_FIELDS[$target] ?? [])), + 'relation' => $this->fieldsWithReason(target: $target, reason: 'relation'), + 'system' => $this->fieldsWithReason(target: $target, reason: 'system'), + ]; + $allowed = array_values(array_diff($this->targetFields(target: $target), ...array_values($refused))); + + return array_values( + array_unique( + array_merge( + $this->requiredViolations(target: $target, pack: $pack, keyColumn: (string)($profile['keyColumn'] ?? 'APPID')), + $this->mappingViolations(target: $target, pack: $pack, allowed: $allowed, refused: $refused), + $this->defaultViolations(target: $target, pack: $pack, allowed: $allowed, refused: $refused) + ) + ) + ); + }//end violations() + + /** + * The required mappings a pack lacks. + * + * @param string $target The target. + * @param array $pack The pack. + * @param string $keyColumn The match key column. + * + * @return array + * + * @spec openspec/changes/cmdb-import-mapping-view/tasks.md#task-1 + */ + private function requiredViolations(string $target, array $pack, string $keyColumn): array { + $violations = []; + foreach ((self::REQUIRED_TARGETS[$target] ?? []) as $field) { + if ($this->hasRequiredMapping(pack: $pack, field: $field, keyColumn: $keyColumn) === true) { + continue; + } + + if ($field === 'externalNumber') { + $violations[] = 'the key column "' . $keyColumn . '" must be mapped to "externalNumber" as required'; + continue; + } + + $violations[] = '"' . $field . '" must be mapped as required'; + } + + return $violations; + }//end requiredViolations() + + /** + * Whether a pack maps a field as required; `externalNumber` only from the key column. + * + * @param array $pack The pack. + * @param string $field The field. + * @param string $keyColumn The match key column. + * + * @return bool + * + * @spec openspec/changes/cmdb-import-mapping-view/tasks.md#task-1 + */ + private function hasRequiredMapping(array $pack, string $field, string $keyColumn): bool { + foreach (($pack['fieldMappings'] ?? []) as $mapping) { + if (is_array($mapping) === false || ($mapping['target'] ?? null) !== $field || ($mapping['required'] ?? false) !== true) { + continue; + } + + if ($field !== 'externalNumber' || ($mapping['source'] ?? null) === $keyColumn) { + return true; + } + } + + return false; + }//end hasRequiredMapping() + + /** + * The mapped targets a pack may not write. + * + * @param string $target The target. + * @param array $pack The pack. + * @param array $allowed The fields it may write. + * @param array> $refused The refused fields, per reason. + * + * @return array + * + * @spec openspec/changes/cmdb-import-mapping-view/tasks.md#task-1 + */ + private function mappingViolations(string $target, array $pack, array $allowed, array $refused): array { + $violations = []; + foreach (($pack['fieldMappings'] ?? []) as $mapping) { + $field = (string)($mapping['target'] ?? ''); + if (in_array($field, $allowed, true) === false) { + $violations[] = self::fieldViolation(field: $field, refused: $refused, target: $target); + } + } + + return $violations; + }//end mappingViolations() + + /** + * The defaults a pack may not set, and the pinned defaults it changed. + * + * @param string $target The target. + * @param array $pack The pack. + * @param array $allowed The fields it may write. + * @param array> $refused The refused fields, per reason. + * + * @return array + * + * @spec openspec/changes/cmdb-import-mapping-view/tasks.md#task-1 + */ + private function defaultViolations(string $target, array $pack, array $allowed, array $refused): array { + $defaults = $pack['defaults'] ?? []; + if (is_array($defaults) === false) { + $defaults = []; + } + + $pinned = (self::PINNED_DEFAULTS[$target] ?? []); + $violations = []; + foreach (array_keys($defaults) as $field) { + $field = (string)$field; + if (array_key_exists($field, $pinned) === false && in_array($field, $allowed, true) === false) { + $violations[] = 'default ' . self::fieldViolation(field: $field, refused: $refused, target: $target); + } + } + + foreach ($pinned as $field => $value) { + if (($defaults[$field] ?? null) !== $value) { + $violations[] = 'default "' . $field . '" must stay "' . $value . '"'; + } + } + + return $violations; + }//end defaultViolations() + + /** + * Why a field may not be written. + * + * @param string $field The field. + * @param array> $refused The refused fields, per reason. + * @param string $target The target. + * + * @return string + * + * @spec openspec/changes/cmdb-import-mapping-view/tasks.md#task-1 + */ + private static function fieldViolation(string $field, array $refused, string $target): string { + if (in_array($field, $refused['managed'], true) === true) { + return '"' . $field . '" is set by the import and cannot be mapped'; + } + + if (in_array($field, $refused['protected'], true) === true) { + return '"' . $field . '" is set outside the import and cannot be mapped'; + } + + if (in_array($field, $refused['system'], true) === true) { + return '"' . $field . '" is set outside the import and cannot be mapped'; + } + + if (in_array($field, $refused['relation'], true) === true) { + return '"' . $field . '" is a relation or a file and cannot be mapped'; + } + + return '"' . $field . '" is not a field the ' . $target . ' pack may map'; + }//end fieldViolation() + + /** + * The properties per schema of the register stackiq ships, fragments included, each with why no pack may write it. + * + * @return array> + * + * @throws CmdbImportException MAPPING_UNAVAILABLE when the register file or one of its fragments cannot be read. + * + * @spec openspec/changes/cmdb-import-mapping-view/tasks.md#task-1 + */ + private function schemaFields(): array { + if ($this->registerSchema === null) { + $this->registerSchema = new CmdbRegisterSchemaFields(settingsDirectory: (string)$this->settingsDirectory); + } + + return $this->registerSchema->fields(); + }//end schemaFields() + + /** + * The properties of a target's schema, or the fixed fields of a target without one. + * + * @param string $target The target. + * + * @return array + * + * @throws CmdbImportException MAPPING_UNAVAILABLE when the register cannot be read. + * + * @spec openspec/changes/cmdb-import-mapping-view/tasks.md#task-1 + */ + private function targetFields(string $target): array { + $schema = (self::TARGET_SCHEMAS[$target] ?? null); + if ($schema === null) { + return (self::FIELDS_WITHOUT_SCHEMA[$target] ?? []); + } + + return array_map('strval', array_keys(($this->schemaFields()[$schema] ?? []))); + }//end targetFields() + + /** + * The properties of a target's schema that no pack may write for one reason. + * + * @param string $target The target. + * @param string $reason `relation` or `system`. + * + * @return array + * + * @throws CmdbImportException MAPPING_UNAVAILABLE when the register cannot be read. + * + * @spec openspec/changes/cmdb-import-mapping-view/tasks.md#task-1 + */ + private function fieldsWithReason(string $target, string $reason): array { + $schema = (self::TARGET_SCHEMAS[$target] ?? null); + if ($schema === null) { + return []; + } + + $fields = array_filter(($this->schemaFields()[$schema] ?? []), static fn (string $why): bool => $why === $reason); + return array_map('strval', array_keys($fields)); + }//end fieldsWithReason() + +}//end class diff --git a/lib/Service/Cmdb/CmdbImportPackStore.php b/lib/Service/Cmdb/CmdbImportPackStore.php new file mode 100644 index 000000000..f046b13c1 --- /dev/null +++ b/lib/Service/Cmdb/CmdbImportPackStore.php @@ -0,0 +1,586 @@ + + * @copyright 2026 Conduction B.V. + * @license EUPL-1.2 https://joinup.ec.europa.eu/collection/eupl/eupl-text-eupl-12 + * @link https://github.com/ConductionNL/stackiq + * + * @spec openspec/changes/cmdb-import-mapping-view/tasks.md#task-1 + * + * SPDX-FileCopyrightText: 2026 Conduction B.V. + * SPDX-License-Identifier: EUPL-1.2 + */ + +declare(strict_types=1); + +namespace OCA\Stackiq\Service\Cmdb; + +use OCA\Stackiq\AppInfo\Application; +use OCA\Stackiq\Exception\CmdbImportException; +use OCP\AppFramework\Db\DoesNotExistException; +use OCP\IAppConfig; +use Psr\Container\ContainerInterface; +use Throwable; + +/** + * Seeds, finds and updates the CMDB import packs in OpenRegister. + * + * @spec openspec/changes/cmdb-import-mapping-view/tasks.md#task-1 + */ +class CmdbImportPackStore { + /** + * OpenRegister's migration-pack service (not a public contract). + */ + public const SERVICE_CLASS = 'OCA\OpenRegister\Service\MigrationPackService'; + + /** + * App config key: the OpenRegister row id per pack slug, as JSON. + */ + public const CONFIG_KEY = 'cmdb_import_pack_ids'; + + /** + * The store resolved the pack as it was. + */ + public const FOUND = 'found'; + + /** + * The store created the pack from the shipped file. + */ + public const SEEDED = 'seeded'; + + /** + * The store replaced an unedited pack with a newer shipped one. + */ + public const UPDATED = 'updated'; + + /** + * A class only an OpenRegister with the hardened pack store has. + * + * It ships with the CSRF-protected, admin-only pack writes and the lock on + * a built-in pack's slug. + */ + public const HARDENED_CLASS = 'OCA\OpenRegister\Exception\BuiltinPackSlugLockedException'; + + /** + * OpenRegister's controller for the pack routes; its write methods must be admin-only and CSRF-protected. + */ + public const CONTROLLER_CLASS = 'OCA\OpenRegister\Controller\MigrationPacksController'; + + /** + * The exception OpenRegister throws when a pack was saved after the caller read it. + */ + public const PACK_CHANGED_CLASS = 'OCA\OpenRegister\Exception\PackChangedException'; + + + /** + * Decides whether OpenRegister's store may be used, and hands out its service. + * + * @var CmdbImportPackStoreProbe + */ + private readonly CmdbImportPackStoreProbe $probe; + + /** + * Reads and writes the seed marker. + * + * @var CmdbImportPackMarker + */ + private readonly CmdbImportPackMarker $marker; + + /** + * Constructor. + * + * @param ContainerInterface $container Resolves OpenRegister's service, and the app config when none is given. + * @param IAppConfig|null $appConfig Keeps the row ids; null resolves it from the container. + * @param string $hardenedClass The class that marks an OpenRegister with the hardened pack store. + * @param string $controllerClass The controller whose write methods must be guarded. + * + * @spec openspec/changes/cmdb-import-mapping-view/tasks.md#task-1 + */ + public function __construct( + private readonly ContainerInterface $container, + private ?IAppConfig $appConfig = null, + private readonly string $hardenedClass = self::HARDENED_CLASS, + private readonly string $controllerClass = self::CONTROLLER_CLASS, + ) { + $this->marker = new CmdbImportPackMarker(); + $this->probe = new CmdbImportPackStoreProbe( + container: $this->container, + serviceClass: self::SERVICE_CLASS, + hardenedClass: $this->hardenedClass, + controllerClass: $this->controllerClass + ); + }//end __construct() + + /** + * Whether OpenRegister's migration-pack store can be used. + * + * Only an OpenRegister with the hardened pack store counts: it has + * HARDENED_CLASS, and no write method of its pack controller carries an + * attribute or annotation that skips the CSRF check or admits non-admins. + * + * @return bool + * + * @spec openspec/changes/cmdb-import-mapping-view/tasks.md#task-1 + */ + public function isAvailable(): bool { + return $this->service() !== null; + }//end isAvailable() + + /** + * The OpenRegister row ids this store resolved before, per pack slug. + * + * Not empty means the packs were stored in OpenRegister once, so the + * import may no longer fall back to the shipped files. + * + * @return array + * + * @spec openspec/changes/cmdb-import-mapping-view/tasks.md#task-1 + */ + public function recordedPackIds(): array { + $config = $this->appConfig(); + if ($config === null) { + return []; + } + + $decoded = json_decode($config->getValueString(Application::APP_ID, self::CONFIG_KEY, ''), true); + if (is_array($decoded) === false) { + return []; + } + + $ids = []; + foreach ($decoded as $slug => $id) { + if (is_string($slug) === true && is_int($id) === true && $id > 0) { + $ids[$slug] = $id; + } + } + + return $ids; + }//end recordedPackIds() + + /** + * Refuse the shipped files once the packs were stored in OpenRegister. + * + * Called when the store is not available: before any pack was stored + * there the import may use the shipped files; afterwards that would + * silently drop an administrator's edit. + * + * @return void + * + * @throws CmdbImportException MAPPING_UNAVAILABLE naming the packs the store held. + * + * @spec openspec/changes/cmdb-import-mapping-view/tasks.md#task-1 + */ + public function assertShippedFallbackAllowed(): void { + $named = []; + foreach ($this->recordedPackIds() as $slug => $id) { + $named[] = $slug . ' (id ' . $id . ')'; + } + + if ($named === []) { + return; + } + + throw new CmdbImportException( + errorCode: CmdbImportException::MAPPING_UNAVAILABLE, + message: 'OpenRegister migration pack store is not available, but it holds the CMDB import packs ' + . implode(', ', $named) . '; the import does not fall back to the shipped files', + details: ['packs' => $this->recordedPackIds()] + ); + }//end assertShippedFallbackAllowed() + + /** + * The stored pack for a shipped pack, read only: nothing is created, updated or recorded. + * + * For a view of the mapping. The import run and the seed step use resolve(), + * which writes. An unedited stored pack that the next import run replaces + * is answered as that run will see it: the shipped pack and its version, + * with `updatePending` true; nothing is written. + * + * @param array $shipped The shipped pack, already validated. + * + * @return array|null As resolve(), with outcome found; null when the store holds no such pack. + * + * @throws CmdbImportException MAPPING_UNAVAILABLE when the store is missing or fails, + * or when the pack was renamed in OpenRegister. + * + * @spec openspec/changes/cmdb-import-mapping-view/tasks.md#task-1 + */ + public function find(array $shipped): ?array { + $service = $this->requireService(); + $slug = (string)($shipped['id'] ?? ''); + $entity = $this->findBySlug(service: $service, slug: $slug); + if ($entity === null) { + $this->assertNotRenamed(service: $service, slug: $slug); + return null; + } + + $answer = $this->describe(entity: $entity, slug: $slug, shipped: $shipped, outcome: self::FOUND); + if ($this->updateWouldRun(entity: $entity, shipped: $shipped) === true) { + $answer['pack'] = $shipped; + $answer['version'] = (string)($shipped['version'] ?? ''); + $answer['updatePending'] = true; + } + + return $answer; + }//end find() + + /** + * Whether the next import run replaces this stored pack with the shipped one. + * + * Only an unedited, outdated pack whose last save is known: without an + * `updatedAt` the update cannot be guarded against an edit in between, so + * the stored pack is kept. + * + * @param object $entity The stored pack as read. + * @param array $shipped The shipped pack. + * + * @return bool + * + * @spec openspec/changes/cmdb-import-mapping-view/tasks.md#task-1 + */ + private function updateWouldRun(object $entity, array $shipped): bool { + return $entity->getUpdatedAt() !== null + && $this->marker->isOutdated(definition: self::definitionOf(entity: $entity), shipped: $shipped) === true; + }//end updateWouldRun() + + /** + * The stored pack for a shipped pack: found, seeded when missing, or updated when unedited and outdated. + * + * The answer holds the stored definition, the pack the engine runs (the + * definition without the marker), whether it was edited (null when it + * carries no marker) and whether an edit kept a newer shipped pack out. + * + * @param array $shipped The shipped pack, already validated. + * + * @return array id (int), slug, version, definition (stored, with the marker), + * pack (without it), edited (bool|null), newerShipped (bool) and outcome. + * + * @throws CmdbImportException MAPPING_UNAVAILABLE when the store is missing or fails, + * or when the pack was renamed in OpenRegister. A create + * that fails because another request seeded the pack + * first is no failure: that pack is used. + * + * @spec openspec/changes/cmdb-import-mapping-view/tasks.md#task-1 + */ + public function resolve(array $shipped): array { + $service = $this->requireService(); + $slug = (string)($shipped['id'] ?? ''); + $outcome = self::FOUND; + $entity = $this->findBySlug(service: $service, slug: $slug); + if ($entity === null) { + $this->assertNotRenamed(service: $service, slug: $slug); + try { + $entity = $this->write( + slug: $slug, + action: 'seeded', + call: fn (): object => $service->create(definition: $this->marker->seed(shipped: $shipped), ownerUid: null, builtin: true) + ); + $outcome = self::SEEDED; + } catch (CmdbImportException $e) { + // Another request can seed the pack between the lookup and the create; the row it stored is the pack. + $entity = $this->findBySlug(service: $service, slug: $slug); + if ($entity === null) { + throw $e; + } + } + } elseif ($this->updateWouldRun(entity: $entity, shipped: $shipped) === true) { + [$entity, $outcome] = $this->updateUnedited(service: $service, entity: $entity, slug: $slug, shipped: $shipped); + } + + $this->record(slug: $slug, id: (int)$entity->getId()); + return $this->describe(entity: $entity, slug: $slug, shipped: $shipped, outcome: $outcome); + }//end resolve() + + /** + * Replace an unedited stored pack with the newer shipped one, unless someone saved it since it was read. + * + * The update carries the read pack's `updatedAt`, so an administrator's + * edit saved in between is refused by OpenRegister instead of overwritten; + * that edit is then read back and kept. resolve() calls this + * only for a pack with an `updatedAt` (see updateWouldRun()). + * + * @param object $service OpenRegister's service. + * @param object $entity The stored pack as read. + * @param string $slug The pack slug. + * @param array $shipped The shipped pack. + * + * @return array{0: object, 1: string} The stored entity and the outcome (updated, or found when an edit came in between). + * + * @throws CmdbImportException MAPPING_UNAVAILABLE when the update fails otherwise. + * + * @spec openspec/changes/cmdb-import-mapping-view/tasks.md#task-1 + */ + private function updateUnedited(object $service, object $entity, string $slug, array $shipped): array { + $id = (int)$entity->getId(); + $readAt = $entity->getUpdatedAt()?->getTimestamp(); + try { + $updated = $this->write( + slug: $slug, + action: 'updated', + call: fn (): object => $service->update(id: $id, definition: $this->marker->seed(shipped: $shipped), expectedUpdatedAt: $readAt) + ); + return [$updated, self::UPDATED]; + } catch (CmdbImportException $e) { + $current = null; + if (is_a($e->getPrevious(), self::PACK_CHANGED_CLASS) === true) { + $current = $this->findBySlug(service: $service, slug: $slug); + } + + if ($current === null) { + throw $e; + } + + return [$current, self::FOUND]; + } + }//end updateUnedited() + + /** + * What resolve() and find() answer for a stored pack. + * + * @param object $entity The MigrationPack entity. + * @param string $slug The pack slug. + * @param array $shipped The shipped pack. + * @param string $outcome found, seeded or updated. + * + * @return array + * + * @spec openspec/changes/cmdb-import-mapping-view/tasks.md#task-1 + */ + private function describe(object $entity, string $slug, array $shipped, string $outcome): array { + $definition = self::definitionOf(entity: $entity); + return [ + 'id' => (int)$entity->getId(), + 'slug' => $slug, + 'version' => (string)($definition['version'] ?? ''), + 'storedVersion' => (string)($definition['version'] ?? ''), + 'definition' => $definition, + 'pack' => $this->marker->strip(definition: $definition), + 'edited' => $this->marker->isEdited(definition: $definition), + 'newerShipped' => $this->marker->isNewerShipped(definition: $definition, shipped: $shipped), + 'outcome' => $outcome, + 'updatePending' => false, + ]; + }//end describe() + + /** + * OpenRegister's service, or a refusal when the store is not available. + * + * @return object + * + * @throws CmdbImportException MAPPING_UNAVAILABLE when the store is not available. + * + * @spec openspec/changes/cmdb-import-mapping-view/tasks.md#task-1 + */ + private function requireService(): object { + $service = $this->service(); + if ($service === null) { + throw new CmdbImportException( + errorCode: CmdbImportException::MAPPING_UNAVAILABLE, + message: 'OpenRegister MigrationPackService is not available' + ); + } + + return $service; + }//end requireService() + + /** + * The decoded definition of a stored pack. + * + * @param object $entity The MigrationPack entity. + * + * @return array + * + * @spec openspec/changes/cmdb-import-mapping-view/tasks.md#task-1 + */ + private static function definitionOf(object $entity): array { + $definition = $entity->getDefinitionArray(); + if (is_array($definition) === false) { + return []; + } + + return $definition; + }//end definitionOf() + + /** + * Find a stored pack by slug. + * + * @param object $service OpenRegister's service. + * @param string $slug The pack slug. + * + * @return object|null The entity, or null when no pack has the slug. + * + * @throws CmdbImportException MAPPING_UNAVAILABLE when the lookup fails otherwise. + * + * @spec openspec/changes/cmdb-import-mapping-view/tasks.md#task-1 + */ + private function findBySlug(object $service, string $slug): ?object { + try { + return $service->findByPackSlug(packSlug: $slug); + } catch (DoesNotExistException $e) { + return null; + } catch (Throwable $e) { + throw new CmdbImportException( + errorCode: CmdbImportException::MAPPING_UNAVAILABLE, + message: 'OpenRegister migration pack ' . $slug . ' could not be read: ' . get_class($e), + details: ['pack' => $slug], + previous: $e + ); + } + }//end findBySlug() + + /** + * Refuse when the row recorded for a slug still exists under another slug. + * + * A renamed pack is one the import no longer reads, so seeding a second + * one would let the administrator edit a pack that never runs. + * + * @param object $service OpenRegister's service. + * @param string $slug The pack slug. + * + * @return void + * + * @throws CmdbImportException MAPPING_UNAVAILABLE when the pack was renamed or the lookup fails. + * + * @spec openspec/changes/cmdb-import-mapping-view/tasks.md#task-1 + */ + private function assertNotRenamed(object $service, string $slug): void { + $id = ($this->recordedPackIds()[$slug] ?? null); + if ($id === null) { + return; + } + + try { + $entity = $service->find(id: $id); + } catch (DoesNotExistException $e) { + // Deleted: seeding it again restores the shipped pack. + return; + } catch (Throwable $e) { + throw new CmdbImportException( + errorCode: CmdbImportException::MAPPING_UNAVAILABLE, + message: 'OpenRegister migration pack ' . $slug . ' (id ' . $id . ') could not be read: ' . get_class($e), + details: ['pack' => $slug, 'packId' => $id], + previous: $e + ); + } + + throw new CmdbImportException( + errorCode: CmdbImportException::MAPPING_UNAVAILABLE, + message: 'OpenRegister migration pack id ' . $id . ' was renamed from ' . $slug . ' to ' + . (string)$entity->getPackSlug() . '; the import reads it by the id ' . $slug . ' only, so rename it back', + details: ['pack' => $slug, 'packId' => $id] + ); + }//end assertNotRenamed() + + /** + * Create or update a stored pack, turning a failure into MAPPING_UNAVAILABLE. + * + * @param string $slug The pack slug. + * @param string $action What the call does, for the message. + * @param callable(): object $call The service call. + * + * @return object The entity. + * + * @throws CmdbImportException MAPPING_UNAVAILABLE when the call fails. + * + * @spec openspec/changes/cmdb-import-mapping-view/tasks.md#task-1 + */ + private function write(string $slug, string $action, callable $call): object { + try { + return $call(); + } catch (Throwable $e) { + throw new CmdbImportException( + errorCode: CmdbImportException::MAPPING_UNAVAILABLE, + message: 'OpenRegister migration pack ' . $slug . ' could not be ' . $action . ': ' . get_class($e), + details: ['pack' => $slug], + previous: $e + ); + } + }//end write() + + /** + * Remember the row id of a slug in the app config, when it changed. + * + * @param string $slug The pack slug. + * @param int $id The row id. + * + * @return void + * + * @spec openspec/changes/cmdb-import-mapping-view/tasks.md#task-1 + */ + private function record(string $slug, int $id): void { + $config = $this->appConfig(); + if ($config === null) { + return; + } + + $ids = $this->recordedPackIds(); + if (($ids[$slug] ?? null) === $id) { + return; + } + + $ids[$slug] = $id; + ksort($ids); + $config->setValueString(Application::APP_ID, self::CONFIG_KEY, (string)json_encode($ids)); + }//end record() + + /** + * OpenRegister's service; null on an OpenRegister without the hardened pack store. + * + * @return object|null + * + * @spec openspec/changes/cmdb-import-mapping-view/tasks.md#task-1 + */ + private function service(): ?object { + return $this->probe->service(); + }//end service() + + /** + * The app config, resolved from the container when it was not given. + * + * @return IAppConfig|null + * + * @spec openspec/changes/cmdb-import-mapping-view/tasks.md#task-1 + */ + private function appConfig(): ?IAppConfig { + if ($this->appConfig !== null) { + return $this->appConfig; + } + + try { + if ($this->container->has(IAppConfig::class) === true) { + $config = $this->container->get(IAppConfig::class); + if ($config instanceof IAppConfig) { + $this->appConfig = $config; + } + } + } catch (Throwable $e) { + // No app config in this container: nothing is recorded. + $this->appConfig = null; + } + + return $this->appConfig; + }//end appConfig() +}//end class diff --git a/lib/Service/Cmdb/CmdbImportPackStoreProbe.php b/lib/Service/Cmdb/CmdbImportPackStoreProbe.php new file mode 100644 index 000000000..4c41b8b66 --- /dev/null +++ b/lib/Service/Cmdb/CmdbImportPackStoreProbe.php @@ -0,0 +1,205 @@ + + * @copyright 2026 Conduction B.V. + * @license EUPL-1.2 https://joinup.ec.europa.eu/collection/eupl/eupl-text-eupl-12 + * @link https://github.com/ConductionNL/stackiq + * + * @spec openspec/changes/cmdb-import-mapping-view/tasks.md#task-1 + * + * SPDX-FileCopyrightText: 2026 Conduction B.V. + * SPDX-License-Identifier: EUPL-1.2 + */ + +declare(strict_types=1); + +namespace OCA\Stackiq\Service\Cmdb; + +use Psr\Container\ContainerInterface; +use ReflectionAttribute; +use ReflectionClass; +use ReflectionMethod; +use Throwable; + +/** + * Resolves OpenRegister's pack service when the store may be used. + * + * @spec openspec/changes/cmdb-import-mapping-view/tasks.md#task-1 + */ +final class CmdbImportPackStoreProbe { + /** + * The methods the store calls on OpenRegister's service. + * + * @var array + */ + private const SERVICE_METHODS = ['findByPackSlug', 'find', 'create', 'update']; + + /** + * The controller methods that write packs. + * + * @var array + */ + private const WRITE_METHODS = ['create', 'update', 'destroy', 'import', 'preview']; + + /** + * The attributes and annotations that would open a write route to non-admins or skip its CSRF check. + * + * @var array + */ + private const OPENING_MARKERS = ['NoCSRFRequired', 'NoAdminRequired', 'PublicPage', 'AuthorizedAdminSetting']; + + /** + * The service, once resolved; false when the store may not be used. + * + * @var object|false|null + */ + private object|false|null $service = null; + + /** + * Constructor. + * + * @param ContainerInterface $container Resolves OpenRegister's service. + * @param string $serviceClass OpenRegister's pack service. + * @param string $hardenedClass The class that marks an OpenRegister with the hardened pack store. + * @param string $controllerClass The controller whose write methods must be guarded. + * + * @spec openspec/changes/cmdb-import-mapping-view/tasks.md#task-1 + */ + public function __construct( + private readonly ContainerInterface $container, + private readonly string $serviceClass, + private readonly string $hardenedClass, + private readonly string $controllerClass, + ) { + }//end __construct() + + /** + * OpenRegister's service, resolved once; null when the store may not be used. + * + * @return object|null + * + * @spec openspec/changes/cmdb-import-mapping-view/tasks.md#task-1 + */ + public function service(): ?object { + if ($this->service === null) { + $this->service = false; + try { + $this->service = $this->resolve(); + } catch (Throwable $e) { + // OpenRegister is missing or its service cannot be built: the store is not available. + $this->service = false; + } + } + + if ($this->service === false) { + return null; + } + + return $this->service; + }//end service() + + /** + * The service when every condition holds, false otherwise. + * + * @return object|false + * + * @spec openspec/changes/cmdb-import-mapping-view/tasks.md#task-1 + */ + private function resolve(): object|false { + if (class_exists($this->hardenedClass) === false + || self::writesAreGuarded(controllerClass: $this->controllerClass) === false + || $this->container->has($this->serviceClass) === false + ) { + return false; + } + + $service = $this->container->get($this->serviceClass); + if (is_object($service) === false || self::hasMethods(service: $service) === false) { + return false; + } + + return $service; + }//end resolve() + + /** + * Whether every pack write method of the controller is admin-only and CSRF-protected. + * + * Nextcloud opens a route with an attribute or a docblock annotation, so + * a method that carries none of the opening markers keeps the default: + * admins only, with a CSRF token. + * + * @param string $controllerClass The controller class. + * + * @return bool False when the class or a write method is missing, or a write method is opened. + * + * @spec openspec/changes/cmdb-import-mapping-view/tasks.md#task-1 + */ + private static function writesAreGuarded(string $controllerClass): bool { + if (class_exists($controllerClass) === false) { + return false; + } + + $class = new ReflectionClass($controllerClass); + foreach (self::WRITE_METHODS as $name) { + if ($class->hasMethod($name) === false || self::isOpened(method: $class->getMethod($name)) === true) { + return false; + } + } + + return true; + }//end writesAreGuarded() + + /** + * Whether a controller method carries an attribute or annotation that opens its route. + * + * @param ReflectionMethod $method The method. + * + * @return bool + * + * @spec openspec/changes/cmdb-import-mapping-view/tasks.md#task-1 + */ + private static function isOpened(ReflectionMethod $method): bool { + $attributes = array_map( + static fn (ReflectionAttribute $attribute): string => substr((string)strrchr('\\' . $attribute->getName(), '\\'), 1), + $method->getAttributes() + ); + $doc = (string)$method->getDocComment(); + foreach (self::OPENING_MARKERS as $marker) { + if (in_array($marker, $attributes, true) === true || str_contains($doc, '@' . $marker) === true) { + return true; + } + } + + return false; + }//end isOpened() + + /** + * Whether a resolved service has every method the store calls. + * + * @param object $service The service. + * + * @return bool + * + * @spec openspec/changes/cmdb-import-mapping-view/tasks.md#task-1 + */ + private static function hasMethods(object $service): bool { + foreach (self::SERVICE_METHODS as $method) { + if (method_exists($service, $method) === false) { + return false; + } + } + + return true; + }//end hasMethods() +}//end class diff --git a/lib/Service/Cmdb/CmdbImportProfile.php b/lib/Service/Cmdb/CmdbImportProfile.php index 1e8805c90..797ae0431 100644 --- a/lib/Service/Cmdb/CmdbImportProfile.php +++ b/lib/Service/Cmdb/CmdbImportProfile.php @@ -11,10 +11,18 @@ * mean empty, which constants a sheet adds to its rows, and which columns * may be read at all (the allowlist, design D3). * + * The four sheet packs come from OpenRegister's migration-pack store when it + * is available (CmdbImportPackStore), so an administrator's edit there is + * what the import runs; the shipped files are the seed. The municipality + * pack maps the request options and always comes from its file. A pack from + * either source must pass the validator and the import's own rules + * (CmdbImportPackRules). + * * `PackDefinitionValidator` is not part of OpenRegister's `Contract` - * namespace, so it is resolved defensively. When it is missing, or a shipped - * pack is invalid, loading throws `MAPPING_UNAVAILABLE` (503) before any - * row is read (REQ-CMDB-005). + * namespace, so it is resolved defensively. When it is missing, a pack is + * invalid or breaks a rule, or the store that holds the packs is gone, + * loading throws `MAPPING_UNAVAILABLE` (503) before any row is read + * (REQ-CMDB-005, REQ-CMDB-021). * * @category Service * @package OCA\Stackiq\Service\Cmdb @@ -24,6 +32,7 @@ * @link https://github.com/ConductionNL/stackiq * * @spec openspec/changes/cmdb-export-import/tasks.md#task-3 + * @spec openspec/changes/cmdb-import-mapping-view/tasks.md#task-1 * * SPDX-FileCopyrightText: 2026 Conduction B.V. * SPDX-License-Identifier: EUPL-1.2 @@ -47,6 +56,8 @@ * @SuppressWarnings(PHPMD.TooManyMethods) The same accessors, plus the loader's small private helpers. * @SuppressWarnings(PHPMD.ExcessiveClassComplexity) The accessors each guard against a * malformed profile value; the sum passes the threshold, no single method is complex. + * @SuppressWarnings(PHPMD.ExcessiveClassLength) The same accessors with their docblocks, and the + * loader that picks each pack's source; the store, the marker and the import rules are classes of their own. */ class CmdbImportProfile { /** @@ -86,6 +97,16 @@ class CmdbImportProfile { */ public const DEFAULT_MAX_REFERENCED_STRING_BYTES = 67108864; + /** + * The targets whose pack an administrator edits in OpenRegister. + * + * The municipality pack maps the request options, not a sheet, so it + * stays a shipped file. + * + * @var array + */ + public const EDITABLE_TARGETS = ['module', 'manufacturer', 'usage', 'businessOwner']; + /** * Sources of the municipality pack that come from the request, not from a sheet. * @@ -93,6 +114,11 @@ class CmdbImportProfile { */ private const OPTION_SOURCES = ['municipalityName']; + /** + * The separator of a concat mapping when the pack names none (OpenRegister's default). + */ + private const DEFAULT_CONCAT_SEPARATOR = ' '; + /** * The decoded profile, once loaded. * @@ -107,64 +133,205 @@ class CmdbImportProfile { */ private array $packs = []; + /** + * Where each loaded pack came from, per target. + * + * @var array> Per target: source, packId, storedVersion, shippedVersion, edited, newerShipped, updatePending. + */ + private array $sources = []; + + /** + * Whether OpenRegister's pack store was available when the packs were loaded. + * + * @var bool + */ + private bool $storeAvailable = false; + + /** + * The import rules every pack must follow. + * + * @var CmdbImportPackRules + */ + private readonly CmdbImportPackRules $rules; + /** * Constructor. * * @param ContainerInterface $container Resolves OpenRegister's validator. * @param string|null $directory Directory of the profile and packs; null is the shipped one. * @param string $profileFile File name of the profile inside the directory. + * @param CmdbImportPackStore|null $packStore OpenRegister's pack store; null builds one on the container. * * @spec openspec/changes/cmdb-export-import/tasks.md#task-3 + * @spec openspec/changes/cmdb-import-mapping-view/tasks.md#task-1 */ public function __construct( private readonly ContainerInterface $container, private ?string $directory = null, private readonly string $profileFile = 'topdesk-profile.json', + private ?CmdbImportPackStore $packStore = null, ) { if ($this->directory === null) { $this->directory = __DIR__ . '/../../Settings/cmdb-import'; } + + $this->rules = new CmdbImportPackRules(); }//end __construct() /** * Load the profile and validate every pack it names. * + * Each sheet pack is taken from OpenRegister's pack store when the store + * is available, seeded from its shipped file when it is missing there, and + * otherwise from the shipped file. Once the packs were stored in + * OpenRegister, a store that is gone fails closed: the import never falls + * back to the files and silently drops an administrator's edit. + * + * The import run and the seed step load this way; viewing the mapping + * uses loadForView(), which writes nothing. + * * @return void * - * @throws CmdbImportException MAPPING_UNAVAILABLE when the validator is missing, - * or the profile or a pack is unreadable or invalid. + * @throws CmdbImportException MAPPING_UNAVAILABLE when the validator is missing, the profile + * or a pack is unreadable, invalid or breaks an import rule, or + * the store that holds the packs is not available. * * @spec openspec/changes/cmdb-export-import/tasks.md#task-3 + * @spec openspec/changes/cmdb-import-mapping-view/tasks.md#task-1 */ public function load(): void { + $this->loadPacks(storedPack: fn (CmdbImportPackStore $store, array $shipped): array => $store->resolve(shipped: $shipped)); + }//end load() + + /** + * Load the profile and validate every pack it names, reading the store only. + * + * A pack the store does not hold yet is taken from its shipped file, and + * nothing is seeded, updated or recorded: viewing the mapping changes + * neither OpenRegister nor stackiq's app config. The next import run + * seeds and updates as load() does. + * + * @return void + * + * @throws CmdbImportException MAPPING_UNAVAILABLE as load(). + * + * @spec openspec/changes/cmdb-import-mapping-view/specs/cmdb-export-import/spec.md#requirement-the-admin-settings-shall-show-the-mapping-the-import-uses-req-cmdb-020 + */ + public function loadForView(): void { + $this->loadPacks(storedPack: fn (CmdbImportPackStore $store, array $shipped): ?array => $store->find(shipped: $shipped)); + }//end loadForView() + + /** + * Load the profile and the packs, taking each editable pack from the store as the callback answers it. + * + * @param callable $storedPack (store, shipped pack) => the stored pack, or null to use the shipped file. + * + * @return void + * + * @throws CmdbImportException MAPPING_UNAVAILABLE as load(). + * + * @spec openspec/changes/cmdb-import-mapping-view/tasks.md#task-1 + */ + private function loadPacks(callable $storedPack): void { $validator = $this->resolveValidator(); $profile = $this->decodeFile(fileName: $this->profileFile); + $store = $this->packStore(); + $storeAvailable = $store->isAvailable(); + if ($storeAvailable === false) { + $store->assertShippedFallbackAllowed(); + } $packs = []; + $sources = []; foreach (self::TARGETS as $target) { - $fileName = $profile['packs'][$target] ?? null; - if (is_string($fileName) === false || $fileName === '' || basename($fileName) !== $fileName) { - throw new CmdbImportException( - errorCode: CmdbImportException::MAPPING_UNAVAILABLE, - message: 'CMDB import profile names no pack for target ' . $target - ); + $fileName = (string)($profile['packs'][$target] ?? ''); + $shipped = $this->readShippedPack(profile: $profile, target: $target, validator: $validator); + $pack = $shipped; + $label = 'CMDB mapping pack ' . $fileName; + $details = []; + $source = [ + 'source' => 'file', + 'packId' => null, + 'storedVersion' => null, + 'shippedVersion' => (string)($shipped['version'] ?? ''), + 'edited' => null, + 'newerShipped' => false, + 'updatePending' => false, + ]; + + $stored = null; + if ($storeAvailable === true && in_array($target, self::EDITABLE_TARGETS, true) === true) { + $stored = $storedPack($store, $shipped); } - $pack = $this->decodeFile(fileName: $fileName); - $errors = $validator->validate($pack); - if (is_array($errors) === true && $errors !== []) { - throw new CmdbImportException( - errorCode: CmdbImportException::MAPPING_UNAVAILABLE, - message: 'CMDB mapping pack ' . $fileName . ' is invalid: ' . implode('; ', array_map('strval', $errors)) + if ($stored !== null) { + $pack = $stored['pack']; + $label = 'OpenRegister migration pack ' . $stored['slug'] . ' (id ' . $stored['id'] . ')'; + $details = ['pack' => $stored['slug'], 'packId' => $stored['id']]; + $this->assertValidPack(validator: $validator, pack: $pack, label: $label, details: $details); + $source = array_merge( + $source, + [ + 'source' => 'openregister', + 'packId' => $stored['id'], + 'storedVersion' => $stored['storedVersion'], + 'edited' => $stored['edited'], + 'newerShipped' => $stored['newerShipped'], + 'updatePending' => $stored['updatePending'], + ] ); } + $this->assertImportRules(target: $target, pack: $pack, profile: $profile, label: $label, details: $details); $packs[$target] = $pack; - } + $sources[$target] = $source; + }//end foreach $this->profile = $profile; $this->packs = $packs; - }//end load() + $this->sources = $sources; + $this->storeAvailable = $storeAvailable; + }//end loadPacks() + + /** + * The shipped packs an administrator edits in OpenRegister, validated, per target. + * + * The seed step stores these; it reads them without touching the store. + * + * @return array> + * + * @throws CmdbImportException MAPPING_UNAVAILABLE when the validator is missing or a file is unreadable or invalid. + * + * @spec openspec/changes/cmdb-import-mapping-view/tasks.md#task-2 + */ + public function shippedEditablePacks(): array { + $validator = $this->resolveValidator(); + $profile = $this->decodeFile(fileName: $this->profileFile); + + $packs = []; + foreach (self::EDITABLE_TARGETS as $target) { + $packs[$target] = $this->readShippedPack(profile: $profile, target: $target, validator: $validator); + } + + return $packs; + }//end shippedEditablePacks() + + /** + * Whether the import uses the shipped files because OpenRegister's pack store is not available. + * + * Only true while the packs were never stored there; afterwards a missing + * store fails the load instead. + * + * @return bool + * + * @throws CmdbImportException MAPPING_UNAVAILABLE when loading fails. + * + * @spec openspec/changes/cmdb-import-mapping-view/tasks.md#task-1 + */ + public function usesShippedFallback(): bool { + $this->profile(); + return $this->storeAvailable === false; + }//end usesShippedFallback() /** * The upload limit in bytes, readable without validating the packs. @@ -332,6 +499,42 @@ public function sheetNames(): array { return array_column($this->sheets(), 'name'); }//end sheetNames() + /** + * The name of the archive sheet, or null when the profile names none. + * + * The archive sheet lists the applications the municipality archived; the + * import reads only its key column (`archiveSheet.name` in the profile). + * + * @return string|null + * + * @spec openspec/changes/cmdb-import-archive-reconciliation/specs/cmdb-export-import/spec.md#requirement-an-application-missing-from-the-cmdb-sheets-shall-be-archived-when-the-archive-sheet-lists-it-and-soft-deleted-when-no-sheet-does-req-cmdb-015 + */ + public function archiveSheetName(): ?string { + $name = $this->profile()['archiveSheet']['name'] ?? null; + if (is_string($name) === false || $name === '' || in_array($name, $this->sheetNames(), true) === true) { + return null; + } + + return $name; + }//end archiveSheetName() + + /** + * Every sheet the reader may parse: the source sheets, then the archive sheet. + * + * @return array + * + * @spec openspec/changes/cmdb-import-archive-reconciliation/specs/cmdb-export-import/spec.md#requirement-an-application-missing-from-the-cmdb-sheets-shall-be-archived-when-the-archive-sheet-lists-it-and-soft-deleted-when-no-sheet-does-req-cmdb-015 + */ + public function readSheetNames(): array { + $names = $this->sheetNames(); + $archive = $this->archiveSheetName(); + if ($archive !== null) { + $names[] = $archive; + } + + return $names; + }//end readSheetNames() + /** * The rank of a sheet when an APPID is on more than one: lower wins. * @@ -469,14 +672,40 @@ public function requiredColumns(): array { }//end requiredColumns() /** - * Columns that hold Excel serial dates. + * Columns that hold Excel serial dates: the profile's, plus every column a pack maps with a date transform. + * + * A pack edited in OpenRegister can map a new column to a date; that + * column is converted too, so the date transform gets `Y-m-d` and not an + * Excel serial number. * * @return array * * @spec openspec/changes/cmdb-export-import/tasks.md#task-4 + * @spec openspec/changes/cmdb-import-mapping-view/tasks.md#task-1 */ public function dateColumns(): array { - return $this->stringList(key: 'dateColumns'); + $columns = $this->stringList(key: 'dateColumns'); + foreach (self::TARGETS as $target) { + if ($target === 'municipality') { + continue; + } + + foreach (($this->pack(target: $target)['fieldMappings'] ?? []) as $mapping) { + if (is_array($mapping) === true && ($mapping['transform']['type'] ?? null) === 'date') { + $columns[] = (string)($mapping['source'] ?? ''); + } + } + } + + $constants = $this->constantColumns(); + return array_values( + array_unique( + array_filter( + $columns, + fn (string $column): bool => $column !== '' && in_array($column, $constants, true) === false + ) + ) + ); }//end dateColumns() /** @@ -574,19 +803,65 @@ public function neverWrittenOnUpdate(string $target): array { }//end neverWrittenOnUpdate() /** - * The accepted values of the missingRecords option. + * The separator of the concat mapping that writes a field, or null when no concat mapping writes it. + * + * The import drops the empty parts of a concatenated note; it splits on + * the separator the pack uses, which an administrator can change. A later + * plain mapping of the same field does not cancel it: the engine skips a + * mapping whose column is empty, so the concatenated value can still be + * the one kept, and the cleanup does no harm to a plain value. With several + * concat mappings, the last one's separator counts. + * + * @param string $target The profile target. + * @param string $field The target field. + * + * @return string|null + * + * @spec openspec/changes/cmdb-import-mapping-view/tasks.md#task-1 + */ + public function concatSeparator(string $target, string $field): ?string { + $separator = null; + foreach (($this->pack(target: $target)['fieldMappings'] ?? []) as $mapping) { + if (is_array($mapping) === false || ($mapping['target'] ?? null) !== $field) { + continue; + } + + if (($mapping['transform']['type'] ?? null) !== 'concat') { + continue; + } + + $separator = ($mapping['transform']['separator'] ?? self::DEFAULT_CONCAT_SEPARATOR); + if (is_string($separator) === false || $separator === '') { + $separator = self::DEFAULT_CONCAT_SEPARATOR; + } + } + + return $separator; + }//end concatSeparator() + + /** + * The accepted values of the missingRecords option, readable without validating the packs. + * + * The controller checks the option before the import runs, so, like + * maxFileBytes(), this must not depend on OpenRegister being available. * * @return array * - * @spec openspec/changes/cmdb-export-import/tasks.md#task-8 + * @spec openspec/changes/cmdb-import-archive-reconciliation/specs/cmdb-export-import/spec.md#requirement-records-missing-from-a-newer-export-shall-be-archived-by-default-or-kept-on-request-req-cmdb-012 */ public function missingRecordsModes(): array { - $modes = $this->stringList(key: 'missingRecords'); - if ($modes === []) { + try { + $profile = $this->profile ?? $this->decodeFile(fileName: $this->profileFile); + } catch (CmdbImportException $e) { + return ['keep']; + } + + $modes = $profile['missingRecords'] ?? []; + if (is_array($modes) === false || $modes === []) { return ['keep']; } - return $modes; + return array_values(array_map('strval', $modes)); }//end missingRecordsModes() /** @@ -626,7 +901,115 @@ public function referencedColumns(): array { }//end referencedColumns() /** - * The loaded profile. + * The profile and the packs as the admin settings show them: what the next import runs. + * + * Loads and validates everything first, so a broken pack throws here as + * it does when an import starts. The transform of each field mapping is + * passed through as the pack stores it, so no key the engine reads is + * hidden from the admin; `required` is normalised to a boolean. Each pack + * also carries the write rules the import applies on top of the mapping: + * `defaults` (pack values set on every write), `createOnlyDefaults` + * (values set on create only, not mapped columns), `createOnlyFields` (mapped + * fields written on create or, on update, only when the stored value is + * empty; a key of `createOnlyDefaults` only when it is also mapped) and `neverWritten` (fields the + * import never writes on an existing object). It also says where it came + * from (`source`, `packId`, the stored and the shipped version, whether it + * was edited and whether a newer shipped pack was left out because of + * that) and whether it is edited in OpenRegister (`editable`). + * + * @return array{profile: array, packs: array>, openRegisterPacks: bool} + * + * @throws CmdbImportException MAPPING_UNAVAILABLE when the validator is missing, + * or the profile or a pack is unreadable or invalid. + * + * @spec openspec/changes/cmdb-import-mapping-view/specs/cmdb-export-import/spec.md#requirement-the-admin-settings-shall-show-the-mapping-the-import-uses-req-cmdb-020 + * @spec openspec/changes/cmdb-import-mapping-view/tasks.md#task-3 + */ + public function mappingOverview(): array { + $profile = $this->profile(); + + $packs = []; + foreach (self::TARGETS as $target) { + $pack = $this->pack(target: $target); + $mappings = []; + foreach (($pack['fieldMappings'] ?? []) as $mapping) { + if (is_array($mapping) === false) { + continue; + } + + $transform = $mapping['transform'] ?? null; + if (is_array($transform) === false) { + $transform = null; + } + + $mappings[] = [ + 'source' => (string)($mapping['source'] ?? ''), + 'target' => (string)($mapping['target'] ?? ''), + 'required' => (bool)($mapping['required'] ?? false), + 'transform' => $transform, + ]; + } + + // A create-only default that is not a mapped field (the module type) is a + // value the import sets on create; merge() never reads it on update, so it + // is listed under createOnlyDefaults only. A mapped field keeps its place + // in createOnlyFields, since merge() guards it on update. + $createOnlyDefaults = $this->createOnlyDefaults(target: $target); + $unmappedDefaults = array_diff(array_map('strval', array_keys($createOnlyDefaults)), array_column($mappings, 'target')); + $createOnlyFields = array_values(array_diff($this->createOnlyFields(target: $target), $unmappedDefaults)); + + $defaults = $pack['defaults'] ?? []; + if (is_array($defaults) === false) { + $defaults = []; + } + + $packs[] = array_merge( + [ + 'target' => $target, + 'file' => (string)($profile['packs'][$target] ?? ''), + 'id' => (string)($pack['id'] ?? ''), + 'name' => (string)($pack['name'] ?? ''), + 'version' => (string)($pack['version'] ?? ''), + 'description' => (string)($pack['description'] ?? ''), + 'fieldMappings' => $mappings, + 'defaults' => $defaults, + 'createOnlyDefaults' => $createOnlyDefaults, + 'createOnlyFields' => $createOnlyFields, + 'neverWritten' => $this->neverWrittenOnUpdate(target: $target), + ], + $this->sources[$target], + ['editable' => in_array($target, self::EDITABLE_TARGETS, true)] + ); + }//end foreach + + return [ + 'profile' => [ + 'id' => (string)($profile['id'] ?? ''), + 'name' => (string)($profile['name'] ?? ''), + 'version' => (string)($profile['version'] ?? ''), + 'profileFile' => $this->profileFile, + 'sheets' => $this->sheets(), + 'archiveSheet' => $this->archiveSheetName(), + 'sheetPrecedence' => $this->stringList(key: 'sheetPrecedence'), + 'keyColumn' => $this->keyColumn(), + 'nameColumn' => $this->nameColumn(), + 'requiredColumns' => $this->requiredColumns(), + 'dateColumns' => $this->dateColumns(), + 'idColumns' => $this->idColumns(), + 'emptyValues' => $this->emptyValues(), + 'externalKeyPrefix' => $this->externalKeyPrefix(), + 'missingRecords' => $this->missingRecordsModes(), + ], + 'packs' => $packs, + 'openRegisterPacks' => $this->storeAvailable, + ]; + }//end mappingOverview() + + /** + * The loaded profile; loaded read only when nothing loaded it yet. + * + * The import run calls load() itself before it reads a row, so a lazy + * load is a read: the limits, the sheet names or the mapping view. * * @return array * @@ -634,7 +1017,7 @@ public function referencedColumns(): array { */ private function profile(): array { if ($this->profile === null) { - $this->load(); + $this->loadForView(); } return ($this->profile ?? []); @@ -656,6 +1039,107 @@ private function stringList(string $key): array { return array_values(array_map('strval', $value)); }//end stringList() + /** + * OpenRegister's pack store, built on the container when none was injected. + * + * @return CmdbImportPackStore + * + * @spec openspec/changes/cmdb-import-mapping-view/tasks.md#task-1 + */ + private function packStore(): CmdbImportPackStore { + if ($this->packStore === null) { + $this->packStore = new CmdbImportPackStore(container: $this->container); + } + + return $this->packStore; + }//end packStore() + + /** + * Read and validate the shipped pack of a target. + * + * @param array $profile The decoded profile. + * @param string $target The target. + * @param object $validator OpenRegister's validator. + * + * @return array + * + * @throws CmdbImportException MAPPING_UNAVAILABLE when the profile names no pack or the file is unreadable or invalid. + * + * @spec openspec/changes/cmdb-import-mapping-view/tasks.md#task-1 + */ + private function readShippedPack(array $profile, string $target, object $validator): array { + $fileName = $profile['packs'][$target] ?? null; + if (is_string($fileName) === false || $fileName === '' || basename($fileName) !== $fileName) { + throw new CmdbImportException( + errorCode: CmdbImportException::MAPPING_UNAVAILABLE, + message: 'CMDB import profile names no pack for target ' . $target + ); + } + + $pack = $this->decodeFile(fileName: $fileName); + $this->assertValidPack(validator: $validator, pack: $pack, label: 'CMDB mapping pack ' . $fileName); + + return $pack; + }//end readShippedPack() + + /** + * Refuse a pack OpenRegister's validator refuses. + * + * @param object $validator OpenRegister's validator. + * @param array $pack The pack. + * @param string $label The pack as the message names it: its file, or its OpenRegister slug and id. + * @param array $details The exception details: the OpenRegister pack and its id, for a stored pack. + * + * @return void + * + * @throws CmdbImportException MAPPING_UNAVAILABLE when the pack is invalid. + * + * @spec openspec/changes/cmdb-import-mapping-view/tasks.md#task-1 + */ + private function assertValidPack(object $validator, array $pack, string $label, array $details = []): void { + $errors = $validator->validate($pack); + if (is_array($errors) === true && $errors !== []) { + throw new CmdbImportException( + errorCode: CmdbImportException::MAPPING_UNAVAILABLE, + message: $label . ' is invalid: ' . implode('; ', array_map('strval', $errors)), + details: $details + ); + } + }//end assertValidPack() + + /** + * Refuse a pack that breaks a rule of the import, which the validator does not know. + * + * The import writes with OpenRegister's RBAC and multitenancy off, so a + * pack may map any plain property of its target schema, never the + * object's metadata, the keys the import sets itself, a relation, a file, + * a field the register hides from forms or calculates, the publication + * dates or an admin field, and must keep the mappings the + * import matches records on (REQ-CMDB-021, CmdbImportPackRules). + * + * @param string $target The target. + * @param array $pack The validated pack. + * @param array $profile The decoded profile. + * @param string $label The pack as the message names it. + * @param array $details The exception details: the OpenRegister pack and its id, for a stored pack. + * + * @return void + * + * @throws CmdbImportException MAPPING_UNAVAILABLE when the pack breaks a rule, or the register cannot be read. + * + * @spec openspec/changes/cmdb-import-mapping-view/tasks.md#task-1 + */ + private function assertImportRules(string $target, array $pack, array $profile, string $label, array $details): void { + $violations = $this->rules->violations(target: $target, pack: $pack, profile: $profile); + if ($violations !== []) { + throw new CmdbImportException( + errorCode: CmdbImportException::MAPPING_UNAVAILABLE, + message: $label . ' breaks a rule of the CMDB import: ' . implode('; ', $violations), + details: $details + ); + } + }//end assertImportRules() + /** * Resolve OpenRegister's pack validator. * diff --git a/lib/Service/Cmdb/CmdbImportReport.php b/lib/Service/Cmdb/CmdbImportReport.php index 730365fde..2615c8b07 100644 --- a/lib/Service/Cmdb/CmdbImportReport.php +++ b/lib/Service/Cmdb/CmdbImportReport.php @@ -36,6 +36,10 @@ class CmdbImportReport { public const UNCHANGED = 'unchanged'; public const SKIPPED = 'skipped'; public const FAILED = 'failed'; + public const ARCHIVED = 'archived'; + public const UNARCHIVED = 'unarchived'; + public const DELETED = 'deleted'; + public const RESTORED = 'restored'; /** * The row entries, in processing order. @@ -90,7 +94,7 @@ public function __construct( * Add one row outcome. * * @param string $sheet The sheet name. - * @param int $row The 1-based sheet row number. + * @param int $row The 1-based sheet row number, or 0 for an application the reconciliation archived or deleted. * @param string $appId The APPID ('' when missing). * @param string $name The application name ('' when missing). * @param string $outcome One of the outcome constants. @@ -180,14 +184,25 @@ public function markCancelled(): void { }//end markCancelled() /** - * The number of rows processed so far. + * Whether the run stopped on a cancel. + * + * @return bool + * + * @spec openspec/changes/cmdb-import-archive-reconciliation/specs/cmdb-export-import/spec.md#requirement-an-application-missing-from-the-cmdb-sheets-shall-be-archived-when-the-archive-sheet-lists-it-and-soft-deleted-when-no-sheet-does-req-cmdb-015 + */ + public function isCancelled(): bool { + return $this->cancelled; + }//end isCancelled() + + /** + * The number of sheet rows processed so far; reconciliation entries (row 0) are not sheet rows. * * @return int * * @spec openspec/changes/cmdb-export-import/tasks.md#task-7 */ public function processed(): int { - return count($this->rows); + return count(array_filter($this->rows, static fn (array $row): bool => $row['row'] > 0)); }//end processed() /** @@ -195,21 +210,28 @@ public function processed(): int { * * `unpublished` counts the modules created without a publication date; * a row whose module was created but whose usage then failed counts too. + * `processed` counts sheet rows only; every outcome, also of a + * reconciliation entry, is counted under its own key. * * @return array{rowsRead: int, processed: int, created: int, updated: int, unchanged: int, skipped: int, failed: int, - * warnings: int, unpublished: int} + * archived: int, unarchived: int, deleted: int, restored: int, warnings: int, unpublished: int} * * @spec openspec/changes/cmdb-export-import/tasks.md#task-7 + * @spec openspec/changes/cmdb-import-archive-reconciliation/specs/cmdb-export-import/spec.md#requirement-an-application-missing-from-the-cmdb-sheets-shall-be-archived-when-the-archive-sheet-lists-it-and-soft-deleted-when-no-sheet-does-req-cmdb-015 */ public function summary(): array { $summary = [ 'rowsRead' => $this->rowsRead, - 'processed' => count($this->rows), + 'processed' => $this->processed(), self::CREATED => 0, self::UPDATED => 0, self::UNCHANGED => 0, self::SKIPPED => 0, self::FAILED => 0, + self::ARCHIVED => 0, + self::UNARCHIVED => 0, + self::DELETED => 0, + self::RESTORED => 0, 'warnings' => 0, 'unpublished' => $this->unpublished, ]; diff --git a/lib/Service/Cmdb/CmdbRegisterSchemaFields.php b/lib/Service/Cmdb/CmdbRegisterSchemaFields.php new file mode 100644 index 000000000..5394bbf72 --- /dev/null +++ b/lib/Service/Cmdb/CmdbRegisterSchemaFields.php @@ -0,0 +1,251 @@ + + * @copyright 2026 Conduction B.V. + * @license EUPL-1.2 https://joinup.ec.europa.eu/collection/eupl/eupl-text-eupl-12 + * @link https://github.com/ConductionNL/stackiq + * + * @spec openspec/changes/cmdb-import-mapping-view/tasks.md#task-1 + * + * SPDX-FileCopyrightText: 2026 Conduction B.V. + * SPDX-License-Identifier: EUPL-1.2 + */ + +declare(strict_types=1); + +namespace OCA\Stackiq\Service\Cmdb; + +use OCA\Stackiq\Exception\CmdbImportException; + +/** + * Reads the register's properties per schema and why no pack may write them. + * + * @spec openspec/changes/cmdb-import-mapping-view/tasks.md#task-1 + */ +class CmdbRegisterSchemaFields { + + /** + * Per schema, once read: each property name and why no pack may write it. + * + * @var array>|null + */ + private ?array $fields = null; + + /** + * Constructor. + * + * @param string $settingsDirectory Directory of the register file and its fragments. + * + * @spec openspec/changes/cmdb-import-mapping-view/tasks.md#task-1 + */ + public function __construct( + private string $settingsDirectory, + ) { + }//end __construct() + + /** + * The properties per schema of the register stackiq ships, fragments included, each with why no pack may write it. + * + * A property is refused when any of its definitions makes it a relation + * or a file (`relation`), or hides it from forms or calculates it (`system`); + * a relation wins. + * + * @return array> + * + * @throws CmdbImportException MAPPING_UNAVAILABLE when the register file or one of its fragments cannot be read. + * + * @spec openspec/changes/cmdb-import-mapping-view/tasks.md#task-1 + */ + public function fields(): array { + if ($this->fields !== null) { + return $this->fields; + } + + $decodedFiles = $this->registerDocuments(); + + $fields = []; + foreach ($decodedFiles as $decoded) { + foreach (($decoded['components']['schemas'] ?? []) as $schema => $definition) { + $calculations = (array)($definition['configuration']['x-openregister-calculations'] ?? []); + foreach ((array)($definition['properties'] ?? []) as $property => $propertyDefinition) { + $reason = self::reasonOf(definition: $propertyDefinition, calculated: array_key_exists((string)$property, $calculations)); + $before = ($fields[(string)$schema][(string)$property] ?? ''); + if ($before !== 'relation' && $reason !== '') { + $before = $reason; + } + + $fields[(string)$schema][(string)$property] = $before; + } + } + } + + $this->fields = $fields; + return $fields; + }//end fields() + + /** + * The register file and every fragment, decoded; fails closed when one cannot be read. + * + * A fragment carries the same protection as the register (a hidden or + * calculated field), so a skipped fragment would let a pack write it. + * + * @return array> + * + * @throws CmdbImportException MAPPING_UNAVAILABLE when the register file or one of its fragments cannot be read. + * + * @spec openspec/changes/cmdb-import-mapping-view/tasks.md#task-1 + */ + private function registerDocuments(): array { + $register = $this->decodeJson(file: $this->settingsDirectory . '/softwarecatalogus_register.json'); + if ($register === null) { + throw new CmdbImportException( + errorCode: CmdbImportException::MAPPING_UNAVAILABLE, + message: 'The stackiq register definition cannot be read, so the CMDB import packs cannot be checked' + ); + } + + $fragments = glob($this->settingsDirectory . '/register.d/*.json'); + if ($fragments === false) { + throw new CmdbImportException( + errorCode: CmdbImportException::MAPPING_UNAVAILABLE, + message: 'The stackiq register fragments cannot be listed, so the CMDB import packs cannot be checked' + ); + } + + $decodedFiles = [$register]; + foreach ($fragments as $file) { + $fragment = $this->decodeJson(file: $file); + if ($fragment === null) { + throw new CmdbImportException( + errorCode: CmdbImportException::MAPPING_UNAVAILABLE, + message: 'The stackiq register fragment ' . basename($file) . ' cannot be read, so the CMDB import packs cannot be checked' + ); + } + + $decodedFiles[] = $fragment; + } + + return $decodedFiles; + }//end registerDocuments() + + /** + * Why no pack may write a property: `relation`, `system`, or '' for a plain, writable one. + * + * @param mixed $definition The property definition. + * @param bool $calculated Whether the schema calculates the property. + * + * @return string + * + * @spec openspec/changes/cmdb-import-mapping-view/tasks.md#task-1 + */ + private static function reasonOf(mixed $definition, bool $calculated): string { + if (self::isRelationOrFile(definition: $definition) === true) { + return 'relation'; + } + + if (self::isSystemOwned(definition: $definition, calculated: $calculated) === true) { + return 'system'; + } + + return ''; + }//end reasonOf() + + /** + * Whether a property definition, or that of its items, points at another object or holds a file. + * + * A reference, an inverse or write-back relation, a uuid, an object + * configuration that relates or names a schema, or a file; a nested + * object with no schema is a plain value. + * + * @param mixed $definition The property definition. + * + * @return bool + * + * @spec openspec/changes/cmdb-import-mapping-view/tasks.md#task-1 + */ + private static function isRelationOrFile(mixed $definition): bool { + if (is_array($definition) === false) { + return false; + } + + $configuration = $definition['objectConfiguration'] ?? []; + if (is_array($configuration) === false) { + $configuration = []; + } + + $markers = array_filter( + [ + ($definition['$ref'] ?? null), + ($definition['inversedBy'] ?? null), + ($definition['writeBack'] ?? null), + ($configuration['schema'] ?? null), + ($definition['format'] ?? null) === 'uuid', + ($configuration['handling'] ?? null) === 'related-object', + ($definition['type'] ?? null) === 'file', + ] + ); + if ($markers !== []) { + return true; + } + + return self::isRelationOrFile(definition: ($definition['items'] ?? null)); + }//end isRelationOrFile() + + /** + * Whether a property definition is hidden from forms or calculated. + * + * Such a field is written by another subsystem (the service desk + * exchange stamps, the calculated suggestions), not edited by people. + * + * @param mixed $definition The property definition. + * @param bool $calculated Whether the schema calculates the property. + * + * @return bool + * + * @spec openspec/changes/cmdb-import-mapping-view/tasks.md#task-1 + */ + private static function isSystemOwned(mixed $definition, bool $calculated): bool { + if ($calculated === true) { + return true; + } + + return is_array($definition) === true && ($definition['hideOnForm'] ?? false) === true; + }//end isSystemOwned() + + /** + * A JSON file decoded to an array, or null when it cannot be read. + * + * @param string $file The file. + * + * @return array|null + * + * @spec openspec/changes/cmdb-import-mapping-view/tasks.md#task-1 + */ + private function decodeJson(string $file): ?array { + $content = false; + if (is_readable($file) === true) { + $content = file_get_contents($file); + } + + if (is_string($content) === false) { + return null; + } + + $decoded = json_decode($content, true); + if (is_array($decoded) === false) { + return null; + } + + return $decoded; + }//end decodeJson() +}//end class diff --git a/lib/Service/Cmdb/CmdbWorkbookReader.php b/lib/Service/Cmdb/CmdbWorkbookReader.php index 3ff3e9184..4b80393b8 100644 --- a/lib/Service/Cmdb/CmdbWorkbookReader.php +++ b/lib/Service/Cmdb/CmdbWorkbookReader.php @@ -42,6 +42,9 @@ * beyond twice the row limit is `TOO_MANY_ROWS`. A read filter then materialises only the * header row and the resolved columns of the rows up to that bound * (CmdbReadFilter), which bounds the cell objects, not the parse. + * 7. The archive sheet ("Gearchiveerde Applicaties"), when the workbook has + * it, counts as a read sheet for every bound above, and only its key + * column is resolved and read (openspec/changes/cmdb-import-archive-reconciliation). * * @category Service * @package OCA\Stackiq\Service\Cmdb @@ -151,17 +154,38 @@ public function isAvailable(): bool { * The sheets are then read twice through a read filter: once for the * header row, once for the resolved columns of the data rows, so no other * cell is ever materialised. + * The archive sheet, when the workbook has it, is read under the same + * bounds as a source sheet, for its key column only. A row whose key is a + * formula without a cached value is read as empty, as on a source sheet, + * and its row number is listed in `archive.uncachedRows`: the sheet then + * lists an application the reader could not see, so a caller must not + * treat the sheet as complete. + * The `appIds` are the raw key-column values as read, in sheet order: + * not trimmed, not normalised and not de-duplicated, and an empty cell + * is an empty entry. Matching them to the stored applications, and any + * normalisation that needs, is the consumer's job. + * The referenced-string budget (`maxReferencedStringBytes`) is divided + * over every sheet in the profile's `readSheetNames()`, so the archive + * sheet always counts as one of them, also in a workbook that has no + * archive sheet: each sheet's share is limit / sheet count (limit / 3 for + * the Topdesk profile). This is deliberate: the bound does not depend on + * what the workbook contains. * * @param string $path The xlsx file, already checked by assertXlsx(). * @param CmdbImportProfile $profile The import profile. * * @return array `rows` (list of {sheet, row, cells, uncached}), `importWarnings` - * (list of {sheet, message}) and `date1904` (bool). + * (list of {sheet, message}), `date1904` (bool), `archive` + * ({sheet, present, keyColumnMissing, appIds, uncachedRows}) and `uncachedKeyRows` + * (source sheet => numbers of the rows dropped as empty because their key is a + * formula without a cached value; a row with other content is in `rows`, its + * `uncached` lists the key). * * @throws CmdbImportException WORKBOOK_TOO_LARGE, READER_UNAVAILABLE, NOT_XLSX, NO_SOURCE_SHEET, * MISSING_COLUMN or TOO_MANY_ROWS. * * @spec openspec/changes/cmdb-export-import/tasks.md#task-4 + * @spec openspec/changes/cmdb-import-archive-reconciliation/specs/cmdb-export-import/spec.md#requirement-an-application-missing-from-the-cmdb-sheets-shall-be-archived-when-the-archive-sheet-lists-it-and-soft-deleted-when-no-sheet-does-req-cmdb-015 */ public function read(string $path, CmdbImportProfile $profile): array { $oversized = $this->assertUncompressedSize(path: $path, limit: $profile->maxUncompressedBytes(), partLimit: $profile->maxPartBytes()); @@ -177,7 +201,7 @@ public function read(string $path, CmdbImportProfile $profile): array { $blank = (new CmdbPartReferences())->assertPartSizes( path: $path, oversized: $oversized, - sourceSheets: $profile->sheetNames(), + sourceSheets: $profile->readSheetNames(), limit: $profile->maxPartBytes(), scanner: $scanner ); @@ -303,10 +327,99 @@ private function readBounded(string $path, CmdbImportProfile $profile, object $s $bounds->assertReferencedStringBytes( path: $path, limit: $profile->maxReferencedStringBytes(), - sheetCount: count($profile->sheetNames()), + sheetCount: count($profile->readSheetNames()), scanner: $scanner ); + ['present' => $present, 'available' => $available] = $this->sourceSheets(path: $path, profile: $profile); + + $archiveSheet = $profile->archiveSheetName(); + $loaded = $present; + if ($archiveSheet !== null && in_array($archiveSheet, $available, true) === true) { + $loaded[] = $archiveSheet; + } + + $limit = $profile->maxRowsPerSheet(); + $lastRow = self::lastReadableRow(limit: $limit); + $this->assertRowSpan(path: $path, sheetNames: $loaded, lastRow: $lastRow, limit: $limit); + + $headers = $this->load(path: $path, sheetNames: $loaded, filter: new CmdbReadFilter(lastRow: 1)); + try { + $resolved = $this->resolveSheets(spreadsheet: $headers, sheetNames: $present, profile: $profile); + $archiveColumns = []; + if ($loaded !== $present) { + // Only the key column of the archive sheet is read; the allowlist does not grow. + $archiveColumns = $this->resolveColumns(worksheet: $headers->getSheetByName($archiveSheet), referenced: [$profile->keyColumn()]); + } + } finally { + $headers->disconnectWorksheets(); + } + + // A sheet without the key column is not read; the import reports it as missing its key column. + $archive = [ + 'sheet' => (string)$archiveSheet, + 'present' => false, + 'keyColumnMissing' => ($loaded !== $present && $archiveColumns === []), + 'appIds' => [], + 'uncachedRows' => [], + ]; + $letters = array_map(static fn (array $columns): array => array_keys($columns), $resolved['columns']); + $loaded = $present; + if ($archiveColumns !== []) { + $letters[$archiveSheet] = array_keys($archiveColumns); + $loaded[] = $archiveSheet; + } + + $spreadsheet = $this->load(path: $path, sheetNames: $loaded, filter: new CmdbReadFilter(lastRow: $lastRow, columns: $letters)); + try { + $uncachedKeyRows = []; + $rows = $this->readSourceRows( + spreadsheet: $spreadsheet, + sheetNames: $present, + columnsPerSheet: $resolved['columns'], + limit: $limit, + keyColumn: $profile->keyColumn(), + uncachedKeyRows: $uncachedKeyRows + ); + if ($archiveColumns !== []) { + $unseen = []; + $archiveRows = $this->readRows( + worksheet: $spreadsheet->getSheetByName($archiveSheet), + columns: $archiveColumns, + sheetName: (string)$archiveSheet, + limit: $limit, + unseen: $unseen + ); + $archive['present'] = true; + $archive['uncachedRows'] = $unseen; + $archive['appIds'] = array_column(array_column($archiveRows, 'cells'), $profile->keyColumn()); + } + + $date1904 = self::usesDate1904(spreadsheet: $spreadsheet); + } finally { + $spreadsheet->disconnectWorksheets(); + } + + return [ + 'rows' => $rows, + 'importWarnings' => $resolved['warnings'], + 'date1904' => $date1904, + 'archive' => $archive, + 'uncachedKeyRows' => $uncachedKeyRows, + ]; + }//end readBounded() + + /** + * The profile's source sheets that the workbook has, and every sheet it has. + * + * @param string $path The xlsx file. + * @param CmdbImportProfile $profile The import profile. + * + * @return array{present: array, available: array} + * + * @throws CmdbImportException NOT_XLSX when the sheet list cannot be read, NO_SOURCE_SHEET when no source sheet is there. + */ + private function sourceSheets(string $path, CmdbImportProfile $profile): array { $reader = $this->newReader(sheetNames: null); try { $available = $reader->listWorksheetNames($path); @@ -328,41 +441,68 @@ private function readBounded(string $path, CmdbImportProfile $profile, object $s ); } - $limit = $profile->maxRowsPerSheet(); - $lastRow = self::lastReadableRow(limit: $limit); - $this->assertRowSpan(path: $path, sheetNames: $present, lastRow: $lastRow, limit: $limit); + return ['present' => $present, 'available' => $available]; + }//end sourceSheets() - $headers = $this->load(path: $path, sheetNames: $present, filter: new CmdbReadFilter(lastRow: 1)); - try { - $resolved = $this->resolveSheets(spreadsheet: $headers, sheetNames: $present, profile: $profile); - } finally { - $headers->disconnectWorksheets(); + /** + * The data rows of the source sheets, in sheet order. + * + * @param object $spreadsheet The spreadsheet, loaded through the data-pass read filter. + * @param array $sheetNames The source sheets the workbook has. + * @param array> $columnsPerSheet Sheet name => column letter => column name. + * @param int $limit The row limit per sheet. + * @param string $keyColumn The key column's name. + * @param array> $uncachedKeyRows Filled, per sheet, with the number of each row that was + * dropped as empty only because its key is a formula + * without a cached value. + * + * @return array> See read(). + * + * @throws CmdbImportException TOO_MANY_ROWS. + */ + private function readSourceRows( + object $spreadsheet, + array $sheetNames, + array $columnsPerSheet, + int $limit, + string $keyColumn, + array &$uncachedKeyRows, + ): array { + $rows = []; + foreach ($sheetNames as $sheetName) { + $unseen = []; + $sheetRows = $this->readRows( + worksheet: $spreadsheet->getSheetByName($sheetName), + columns: $columnsPerSheet[$sheetName], + sheetName: $sheetName, + limit: $limit, + unseen: $unseen, + keyColumn: $keyColumn + ); + if ($unseen !== []) { + $uncachedKeyRows[$sheetName] = array_values((array)$unseen); + } + + array_push($rows, ...$sheetRows); } - $letters = array_map(static fn (array $columns): array => array_keys($columns), $resolved['columns']); - $spreadsheet = $this->load(path: $path, sheetNames: $present, filter: new CmdbReadFilter(lastRow: $lastRow, columns: $letters)); - try { - $rows = []; - foreach ($present as $sheetName) { - $sheetRows = $this->readRows( - worksheet: $spreadsheet->getSheetByName($sheetName), - columns: $resolved['columns'][$sheetName], - sheetName: $sheetName, - limit: $limit - ); - array_push($rows, ...$sheetRows); - } + return $rows; + }//end readSourceRows() - $date1904 = false; - if (method_exists($spreadsheet, 'getExcelCalendar') === true) { - $date1904 = ((int)$spreadsheet->getExcelCalendar() === 1904); - } - } finally { - $spreadsheet->disconnectWorksheets(); + /** + * Whether the workbook uses the 1904 date system. + * + * @param object $spreadsheet The spreadsheet. + * + * @return bool + */ + private static function usesDate1904(object $spreadsheet): bool { + if (method_exists($spreadsheet, 'getExcelCalendar') === false) { + return false; } - return ['rows' => $rows, 'importWarnings' => $resolved['warnings'], 'date1904' => $date1904]; - }//end readBounded() + return ((int)$spreadsheet->getExcelCalendar() === 1904); + }//end usesDate1904() /** * The last row number the data pass reads. @@ -625,12 +765,22 @@ private function resolveColumns(object $worksheet, array $referenced): array { * @param array $columns Column letter => column name. * @param string $sheetName The sheet name. * @param int $limit The maximum number of non-empty rows. + * @param array|null $unseen Filled with the number of each row that read as empty only because + * a formula in it has no cached value; null to not collect them. + * @param string|null $keyColumn When set, only a row whose uncached columns include this one is collected. * * @return array, uncached: array}> * * @throws CmdbImportException TOO_MANY_ROWS. */ - private function readRows(object $worksheet, array $columns, string $sheetName, int $limit): array { + private function readRows( + object $worksheet, + array $columns, + string $sheetName, + int $limit, + ?array &$unseen = null, + ?string $keyColumn = null, + ): array { $rows = []; $lastRow = (int)$worksheet->getHighestDataRow(); for ($rowNumber = 2; $rowNumber <= $lastRow; $rowNumber++) { @@ -640,6 +790,10 @@ private function readRows(object $worksheet, array $columns, string $sheetName, rowNumber: $rowNumber ); if ($empty === true) { + if ($uncached !== [] && $unseen !== null && ($keyColumn === null || in_array($keyColumn, $uncached, true) === true)) { + $unseen[] = $rowNumber; + } + continue; } diff --git a/lib/Service/CmdbExportImportService.php b/lib/Service/CmdbExportImportService.php index 1efc049d7..a96f5f2ca 100644 --- a/lib/Service/CmdbExportImportService.php +++ b/lib/Service/CmdbExportImportService.php @@ -30,7 +30,15 @@ * - `publicationDate` is set to the import's start on create, unless the * admin chose not to publish (`publish` false), and never written on * update; neither is `depublicationDate`. - * - Records missing from a newer export are left untouched. + * - Records missing from a newer export are left untouched with + * `missingRecords` `keep`. With `archive` (the default) the municipality's + * usages and their modules are reconciled after the last row: archived + * when the APPID is on the archive sheet, soft-deleted when it is on no + * sheet, archived only when the workbook has no archive sheet, the sheet + * has no APPID column or an APPID in it has no cached value + * (openspec/changes/cmdb-import-archive-reconciliation, design D5). A + * module or usage matched among archived or soft-deleted objects is + * unarchived or restored before it is updated, never duplicated. * - Owners become contact persons, never Nextcloud user accounts, and no * report entry or log line carries an owner name or e-mail address. * - One import runs per register at a time: every match is find-then-create, @@ -55,6 +63,7 @@ use DateTimeImmutable; use DateTimeZone; +use JsonSerializable; use OCA\OpenRegister\Contract\ObjectServiceInterface; use OCA\Stackiq\Exception\CmdbImportException; use OCA\Stackiq\Service\Cmdb\CmdbImportProfile; @@ -68,6 +77,7 @@ use OCP\Lock\LockedException; use Psr\Container\ContainerInterface; use Psr\Log\LoggerInterface; +use RuntimeException; use Throwable; /** @@ -75,6 +85,12 @@ * * @spec openspec/changes/cmdb-export-import/tasks.md#task-5 * + * @phpstan-type ArchiveSheet array{sheet: string, present: bool, keyColumnMissing: bool, uncachedRows: array, keys: array} + * + * @phpstan-type ScopeExtra array{schemaKey: string, uuid: string, state: array{archived: bool, deleted: bool}} + * @phpstan-type ScopeStates array + * @phpstan-type ScopeEntry array{key: string, usage: object, module: object, states: ScopeStates, extras?: array} + * * @SuppressWarnings(PHPMD.ExcessiveClassComplexity) One import run resolves four linked * object kinds per row (supplier, module, owners, usage), each with its own match rule, * create-only fields and run cache. Splitting them over several classes would hand the @@ -111,6 +127,58 @@ class CmdbExportImportService { */ public const SCHEMA_MAPPER_CLASS = 'OCA\OpenRegister\Db\SchemaMapper'; + /** + * OpenRegister's archive handler, behind POST and DELETE .../archive (not a public contract). + */ + public const ARCHIVE_HANDLER_CLASS = 'OCA\OpenRegister\Service\Object\ArchiveHandler'; + + /** + * OpenRegister's object mapper, whose restoreObject() empties the trash of one object (not a public contract). + */ + public const OBJECT_MAPPER_CLASS = 'OCA\OpenRegister\Db\MagicMapper'; + + /** + * What happens to records missing from the export when the request does not say. + */ + public const DEFAULT_MISSING_RECORDS = 'archive'; + + /** + * The start of every archive reason the import writes, so the audit trail says who archived and why. + */ + private const REASON_PREFIX = 'cmdb-import: '; + + /** + * The search lens that lists the archive alone (OpenRegister's `_archived=true`). + * + * The state of a stored object is read from the lens that found it, never + * from the archive marker of a search result: OpenRegister's list search + * does not hydrate that marker (design D9). + * + * @var array + */ + private const ARCHIVED_LENS = ['_archived' => 'true']; + + /** + * The state of an object found without a lens. + * + * @var array{archived: bool, deleted: bool} + */ + private const STATE_WORKING = ['archived' => false, 'deleted' => false]; + + /** + * The state of an object found with ARCHIVED_LENS. + * + * @var array{archived: bool, deleted: bool} + */ + private const STATE_ARCHIVED = ['archived' => true, 'deleted' => false]; + + /** + * The state of an object found in the trash; whether it was archived too is read when it is restored. + * + * @var array{archived: bool, deleted: bool} + */ + private const STATE_DELETED = ['archived' => false, 'deleted' => true]; + /** * The properties every match search and the module key rely on, per schema. * @@ -178,14 +246,16 @@ class CmdbExportImportService { private const UNMATCHED_STATUSES = ['merged', 'Inactive']; /** - * Page size for loading the organisations a name may match. + * How many row numbers an archive-sheet warning names before it cuts the list. + * + * @var int */ - private const PAGE_SIZE = 500; + private const WARNED_ROWS = 10; /** - * Separator of the concat mapping for the internal note. + * Page size for loading the organisations a name may match. */ - private const NOTE_SEPARATOR = ' / '; + private const PAGE_SIZE = 500; /** * The mapping engine of the current run. @@ -222,6 +292,27 @@ class CmdbExportImportService { */ private array $winningSheets = []; + /** + * The CMDB-sheet rows of this run whose key column the reader could not see (a formula without a cached value). + * + * @var array> Sheet name => row numbers. + */ + private array $unreadableKeyRows = []; + + /** + * OpenRegister's archive handler and object mapper, once resolved. + * + * @var array{handler: object, mapper: object}|null + */ + private ?array $archiveServices = null; + + /** + * The register's soft-deleted modules and usages, read once per run: schema key => uuid => entity. + * + * @var array{module: array, usage: array}|null + */ + private ?array $trash = null; + /** * Contact UIDs by e-mail or display name, per run. * @@ -300,17 +391,16 @@ public function assertXlsx(string $path, string $fileName): void { }//end assertXlsx() /** - * Whether a `missingRecords` value is supported (only `keep`). + * The accepted `missingRecords` values: the profile's modes (`keep`, `archive`); any other is refused. * - * @param string $mode The requested value. - * - * @return bool + * @return array * * @spec openspec/changes/cmdb-export-import/tasks.md#task-8 + * @spec openspec/changes/cmdb-import-archive-reconciliation/specs/cmdb-export-import/spec.md#requirement-records-missing-from-a-newer-export-shall-be-archived-by-default-or-kept-on-request-req-cmdb-012 */ - public function supportsMissingRecords(string $mode): bool { - return $mode === 'keep'; - }//end supportsMissingRecords() + public function missingRecordsModes(): array { + return $this->profile->missingRecordsModes(); + }//end missingRecordsModes() /** * Ask a running import to stop between rows. @@ -349,19 +439,21 @@ public function requestCancel(string $operationId): bool { * * @param string $path The xlsx file, already checked by assertXlsx(). * @param array $options municipalityUuid, municipalityName, updateExisting, publish, - * operationId, and fileName (the upload's name, for the audit log line). + * missingRecords (keep or archive, default archive), operationId, + * and fileName (the upload's name, for the audit log line). * * @return array The report (contract.md). * * @throws CmdbImportException MAPPING_UNAVAILABLE, NOT_CONFIGURED, SCHEMA_OUTDATED, IMPORT_IN_PROGRESS, * WORKBOOK_TOO_LARGE, READER_UNAVAILABLE, NOT_XLSX, NO_SOURCE_SHEET, * MISSING_COLUMN, TOO_MANY_ROWS, MUNICIPALITY_REQUIRED, - * MUNICIPALITY_INVALID or MUNICIPALITY_AMBIGUOUS. + * MUNICIPALITY_INVALID, MUNICIPALITY_AMBIGUOUS or ARCHIVE_UNAVAILABLE. * @throws \Exception An unexpected OpenRegister error outside a row, such as * creating the municipality; rows catch their own. * * @spec openspec/changes/cmdb-export-import/tasks.md#task-5 * @spec openspec/changes/cmdb-export-import/tasks.md#task-7 + * @spec openspec/changes/cmdb-import-archive-reconciliation/specs/cmdb-export-import/spec.md#requirement-an-application-missing-from-the-cmdb-sheets-shall-be-archived-when-the-archive-sheet-lists-it-and-soft-deleted-when-no-sheet-does-req-cmdb-015 */ public function import(string $path, array $options): array { $this->resetRun(); @@ -371,6 +463,10 @@ public function import(string $path, array $options): array { $this->profile->load(); $this->engine = $this->resolveEngine(); $this->coordinates = $this->resolveCoordinates(); + if (self::missingRecordsFrom(options: $options) === 'archive') { + // Refused before the lock and the file: an import that cannot reconcile must not half-run. + $this->archiveServices(); + } $lock = $this->acquireImportLock(register: $this->coordinates['register']); try { @@ -442,29 +538,22 @@ private function acquireImportLock(int $register): string { * @return array The report. * * @spec openspec/changes/cmdb-export-import/tasks.md#task-7 + * @spec openspec/changes/cmdb-import-mapping-view/tasks.md#task-1 + * @spec openspec/changes/cmdb-import-archive-reconciliation/specs/cmdb-export-import/spec.md#requirement-an-application-missing-from-the-cmdb-sheets-shall-be-archived-when-the-archive-sheet-lists-it-and-soft-deleted-when-no-sheet-does-req-cmdb-015 */ private function runImport(string $path, array $options, string $startedAt): array { $workbook = $this->reader->read(path: $path, profile: $this->profile); $municipality = $this->resolveMunicipality(options: $options); $operationId = $this->operationIdFrom(options: $options); + $missingRecords = self::missingRecordsFrom(options: $options); $rows = array_values($workbook['rows']); $report = new CmdbImportReport(operationId: $operationId, rowsRead: count($rows)); $report->setMunicipality(uuid: $municipality['uuid'], name: $municipality['name'], created: $municipality['created']); $report->addImportWarnings(warnings: $this->translateImportWarnings(warnings: $workbook['importWarnings'])); - if ($municipality['created'] === true) { - $report->addImportWarnings( - warnings: [ - [ - 'sheet' => '', - 'message' => $this->l10n->t( - 'No municipality named "%s" was found, so it was created. Check the name if you meant an existing one.', - [$municipality['name']] - ), - ], - ] - ); - } + $archive = $this->archiveSheet(workbook: $workbook); + $this->unreadableKeyRows = $this->unreadableKeyRows(rows: $rows, droppedRows: (array)($workbook['uncachedKeyRows'] ?? [])); + $this->addRunWarnings(report: $report, municipality: $municipality, archive: $archive, missingRecords: $missingRecords); $this->progressTracker->startOperation( operationType: self::OPERATION_TYPE, @@ -488,6 +577,7 @@ private function runImport(string $path, array $options, string $startedAt): arr 'municipalityCreated' => $municipality['created'], 'updateExisting' => $updateExisting, 'publish' => $publish, + 'missingRecords' => $missingRecords, ]; $this->logger->info('CmdbExportImportService: import started', array_merge($audit, ['rows' => count($rows)])); try { @@ -507,6 +597,16 @@ private function runImport(string $path, array $options, string $startedAt): arr $this->progressTracker->updateProgress(processedItems: ($index + 1)); } + if ($missingRecords === 'archive' && $report->isCancelled() === false) { + $this->reconcile( + municipalityUuid: $municipality['uuid'], + archive: $archive, + operationId: $operationId, + processedItems: count($rows), + report: $report + ); + } + $result = $report->toArray(); $this->finishOperation(report: $report->toStoredArray(maxRows: self::STORED_REPORT_ROWS)); } catch (Throwable $e) { @@ -528,6 +628,99 @@ private function runImport(string $path, array $options, string $startedAt): arr return $result; }//end runImport() + /** + * Add the run's own warnings. + * + * A mapping that fell back to the packs shipped with stackiq, an archive sheet that is missing, + * has no key column or has unreadable keys, a CMDB sheet with unreadable keys, and a created + * municipality. + * + * @param CmdbImportReport $report The report. + * @param array{uuid: string, name: string, created: bool} $municipality The consumer, as resolveMunicipality() found it. + * @param ArchiveSheet $archive The archive sheet. + * @param string $missingRecords The import's `missingRecords` mode. + * + * @return void + * + * @spec openspec/changes/archive/2026-10-05-cmdb-export-import/tasks.md#task-7 + * @spec openspec/changes/cmdb-import-archive-reconciliation/specs/cmdb-export-import/spec.md#requirement-an-application-missing-from-the-cmdb-sheets-shall-be-archived-when-the-archive-sheet-lists-it-and-soft-deleted-when-no-sheet-does-req-cmdb-015 + * @spec openspec/changes/cmdb-import-mapping-view/tasks.md#task-1 + */ + private function addRunWarnings(CmdbImportReport $report, array $municipality, array $archive, string $missingRecords): void { + if ($this->profile->usesShippedFallback() === true) { + $report->addImportWarnings( + warnings: [ + [ + 'sheet' => '', + 'message' => $this->l10n->t('OpenRegister\'s migration pack store is not available, so this import used the mapping that ships with stackiq.'), + ], + ] + ); + } + + if ($missingRecords === 'archive' && ($archive['present'] === false || $archive['uncachedRows'] !== [])) { + $report->addImportWarnings(warnings: [['sheet' => $archive['sheet'], 'message' => $this->archiveSheetWarning(archive: $archive)]]); + } + + if ($missingRecords === 'archive') { + foreach ($this->unreadableKeyRows as $sheet => $rowNumbers) { + $cmdbSheet = ['sheet' => $sheet, 'keyColumnMissing' => false, 'uncachedRows' => $rowNumbers]; + $report->addImportWarnings(warnings: [['sheet' => $sheet, 'message' => $this->archiveSheetWarning(archive: $cmdbSheet)]]); + } + } + + if ($municipality['created'] === true) { + $report->addImportWarnings( + warnings: [ + [ + 'sheet' => '', + 'message' => $this->l10n->t( + 'No municipality named "%s" was found, so it was created. Check the name if you meant an existing one.', + [$municipality['name']] + ), + ], + ] + ); + } + }//end addRunWarnings() + + /** + * The CMDB-sheet rows whose key column is a formula without a cached value, per sheet. + * + * Such a row reads as empty and is skipped, so its application may be + * missing from `winningSheets` although it is on a CMDB sheet. A run with + * one is not authoritative for a deletion, as with an archive sheet that + * has an unreadable key. + * + * @param array}> $rows The reader rows. + * @param array> $droppedRows The rows the reader dropped as empty because their key + * has no cached value (they are not in `$rows`), per sheet. + * + * @return array> Sheet name => row numbers. + * + * @spec openspec/changes/cmdb-import-archive-reconciliation/specs/cmdb-export-import/spec.md#requirement-an-application-missing-from-the-cmdb-sheets-shall-be-archived-when-the-archive-sheet-lists-it-and-soft-deleted-when-no-sheet-does-req-cmdb-015 + */ + private function unreadableKeyRows(array $rows, array $droppedRows): array { + $key = $this->profile->keyColumn(); + $found = []; + foreach ($droppedRows as $sheet => $rowNumbers) { + $found[(string)$sheet] = array_map('intval', array_values((array)$rowNumbers)); + } + + foreach ($rows as $row) { + if (in_array($key, ($row['uncached'] ?? []), true) === true) { + $found[$row['sheet']][] = $row['row']; + } + } + + foreach ($found as $sheet => $rowNumbers) { + sort($rowNumbers); + $found[$sheet] = $rowNumbers; + } + + return $found; + }//end unreadableKeyRows() + /** * Process one row in its own error boundary and add its outcome. * @@ -748,11 +941,20 @@ private function translateImportWarnings(array $warnings): array { * @param string $module The module outcome. * @param string $usage The usage outcome. * - * @return string created when the module was created, updated when anything was saved, else unchanged. + * @return string restored when either was restored from the trash, else unarchived when either was + * unarchived, else created when the module was created, updated when anything was saved, + * else unchanged. * * @spec openspec/changes/cmdb-export-import/tasks.md#task-7 + * @spec openspec/changes/cmdb-import-archive-reconciliation/specs/cmdb-export-import/spec.md#requirement-an-application-that-returns-to-the-export-shall-be-unarchived-or-restored-never-duplicated-req-cmdb-016 */ private static function rowOutcome(string $module, string $usage): string { + foreach ([CmdbImportReport::RESTORED, CmdbImportReport::UNARCHIVED] as $revived) { + if ($module === $revived || $usage === $revived) { + return $revived; + } + } + if ($module === CmdbImportReport::CREATED) { return CmdbImportReport::CREATED; } @@ -781,7 +983,7 @@ private function finishOperation(array $report): void { } $this->progressTracker->completeOperation(finalStatistics: ['report' => $report]); - // A cancel that came in after the last row's check has nothing left to stop. + // A cancel that came in after the last check has nothing left to stop. $this->progressTracker->clearCancelRequested(operationId: (string)$report['operationId']); }//end finishOperation() @@ -1028,19 +1230,19 @@ private function resolveManufacturer(array $values, int $rowNumber): ?string { * @param string $matchKey The APPID's match key. * @param array{updateExisting: bool} $options Whether a match is updated. * - * @return array{existing: object|null, uuid: string|null, skipReason: string|null} The stored module, the uuid - * to report for a skipped row, - * and why the row is skipped. + * @return array{existing: array{entity: object, state: array{archived: bool, deleted: bool}}|null, uuid: string|null, skipReason: string|null} + * The stored module with its state, the uuid to report for a skipped row, and why the row is skipped. * * @spec openspec/changes/cmdb-export-import/tasks.md#task-5 + * @spec openspec/changes/cmdb-import-archive-reconciliation/specs/cmdb-export-import/spec.md#requirement-an-application-that-returns-to-the-export-shall-be-unarchived-or-restored-never-duplicated-req-cmdb-016 */ private function matchModule(string $externalKey, string $municipalityUuid, string $matchKey, array $options): array { - $existing = $this->findOne(schemaKey: 'module', filters: ['externalKey' => $externalKey]); + $existing = $this->findInAnyState(schemaKey: 'module', filters: ['externalKey' => $externalKey]); if ($existing === null) { return ['existing' => null, 'uuid' => null, 'skipReason' => null]; } - $uuid = (string)$existing->getUuid(); + $uuid = (string)$existing['entity']->getUuid(); if ($this->moduleBelongsTo(moduleUuid: $uuid, municipalityUuid: $municipalityUuid) === false) { $this->logger->warning( 'CmdbExportImportService: import key belongs to a module another organisation uses; row not imported', @@ -1062,7 +1264,8 @@ private function matchModule(string $externalKey, string $municipalityUuid, stri * * @param array $data The mapped module fields. * @param string $externalKey The module's import key. - * @param object|null $existing The module matchModule() found, or null to create one. + * @param array{entity: object, state: array{archived: bool, deleted: bool}}|null $existing The module matchModule() + * found, or null to create one. * @param string|null $providerUuid The supplier, when there is one. * @param string|null $publicationDate ISO start time of the import for a module that is published * when created, or null to create it unpublished. @@ -1075,7 +1278,7 @@ private function matchModule(string $externalKey, string $municipalityUuid, stri private function importModule( array $data, string $externalKey, - ?object $existing, + ?array $existing, ?string $providerUuid, ?string $publicationDate, CmdbImportReport $report, @@ -1102,6 +1305,8 @@ private function importModule( * together with the usages: the module must already have a usage whose * consumer is this municipality, or, before the first import, no usage * at all. A module only another organisation uses is never taken over. + * This municipality's usage counts in every state: an archived or + * soft-deleted usage still says the module is the municipality's. * * @param string $moduleUuid The module found by its import key. * @param string $municipalityUuid The consumer of this import. @@ -1109,9 +1314,10 @@ private function importModule( * @return bool * * @spec openspec/changes/cmdb-export-import/tasks.md#task-5 + * @spec openspec/changes/cmdb-import-archive-reconciliation/specs/cmdb-export-import/spec.md#requirement-an-application-that-returns-to-the-export-shall-be-unarchived-or-restored-never-duplicated-req-cmdb-016 */ private function moduleBelongsTo(string $moduleUuid, string $municipalityUuid): bool { - if ($this->findOne(schemaKey: 'usage', filters: ['consumer' => $municipalityUuid, 'module' => $moduleUuid]) !== null) { + if ($this->findInAnyState(schemaKey: 'usage', filters: ['consumer' => $municipalityUuid, 'module' => $moduleUuid]) !== null) { return true; } @@ -1123,19 +1329,22 @@ private function moduleBelongsTo(string $moduleUuid, string $municipalityUuid): * * @param array $data The mapped module fields. * @param string $externalKey The match key. - * @param object|null $existing The stored module, or null to create one. + * @param array{entity: object, state: array{archived: bool, deleted: bool}}|null $existing The stored module and its + * state, or null to create one. * @param string|null $providerUuid The supplier, when there is one. * @param string|null $publicationDate ISO start time of the import for a module that is published * when created, or null to create it unpublished. * - * @return array{uuid: string, outcome: string} Outcome created, updated or unchanged. + * @return array{uuid: string, outcome: string} Outcome created, updated or unchanged, or restored or + * unarchived when the stored module was revived first. * * @spec openspec/changes/cmdb-export-import/tasks.md#task-5 + * @spec openspec/changes/cmdb-import-archive-reconciliation/specs/cmdb-export-import/spec.md#requirement-an-application-that-returns-to-the-export-shall-be-unarchived-or-restored-never-duplicated-req-cmdb-016 */ private function upsertModule( array $data, string $externalKey, - ?object $existing, + ?array $existing, ?string $providerUuid, ?string $publicationDate, ): array { @@ -1154,14 +1363,15 @@ private function upsertModule( return ['uuid' => $this->save(schemaKey: 'module', data: $create, uuid: null), 'outcome' => CmdbImportReport::CREATED]; } - $uuid = (string)$existing->getUuid(); - $merged = $this->merge(target: 'module', stored: $existing->getObject(), mapped: $data); + $uuid = (string)$existing['entity']->getUuid(); + $revived = $this->revive(found: $existing); + $merged = $this->merge(target: 'module', stored: $revived['entity']->getObject(), mapped: $data); if ($merged === null) { - return ['uuid' => $uuid, 'outcome' => CmdbImportReport::UNCHANGED]; + return ['uuid' => $uuid, 'outcome' => ($revived['outcome'] ?? CmdbImportReport::UNCHANGED)]; } $this->save(schemaKey: 'module', data: $merged, uuid: $uuid); - return ['uuid' => $uuid, 'outcome' => CmdbImportReport::UPDATED]; + return ['uuid' => $uuid, 'outcome' => ($revived['outcome'] ?? CmdbImportReport::UPDATED)]; }//end upsertModule() /** @@ -1173,18 +1383,22 @@ private function upsertModule( * @param string|null $providerUuid The supplier, when there is one. * @param array{businessOwner: string|null} $owners The owner contact person. * - * @return array{uuid: string, outcome: string} + * @return array{uuid: string, outcome: string} Outcome created, updated or unchanged, or restored or + * unarchived when the stored usage was revived first. * * @spec openspec/changes/cmdb-export-import/tasks.md#task-5 + * @spec openspec/changes/cmdb-import-mapping-view/tasks.md#task-1 + * @spec openspec/changes/cmdb-import-archive-reconciliation/specs/cmdb-export-import/spec.md#requirement-an-application-that-returns-to-the-export-shall-be-unarchived-or-restored-never-duplicated-req-cmdb-016 */ private function upsertUsage(array $data, string $municipalityUuid, string $moduleUuid, ?string $providerUuid, array $owners): array { - if (isset($data['interneAnnotation']) === true && is_string($data['interneAnnotation']) === true) { + $separator = $this->profile->concatSeparator(target: 'usage', field: 'interneAnnotation'); + if ($separator !== null && isset($data['interneAnnotation']) === true && is_string($data['interneAnnotation']) === true) { // The concat mapping leaves an empty part for every empty column; drop those. $parts = array_filter( - array_map('trim', explode(self::NOTE_SEPARATOR, $data['interneAnnotation'])), + array_map('trim', explode($separator, $data['interneAnnotation'])), fn (string $part): bool => $part !== '' ); - $data['interneAnnotation'] = implode(self::NOTE_SEPARATOR, $parts); + $data['interneAnnotation'] = implode($separator, $parts); } $data['consumer'] = $municipalityUuid; @@ -1199,19 +1413,20 @@ private function upsertUsage(array $data, string $municipalityUuid, string $modu } } - $existing = $this->findOne(schemaKey: 'usage', filters: ['consumer' => $municipalityUuid, 'module' => $moduleUuid]); + $existing = $this->findInAnyState(schemaKey: 'usage', filters: ['consumer' => $municipalityUuid, 'module' => $moduleUuid]); if ($existing === null) { return ['uuid' => $this->save(schemaKey: 'usage', data: $data, uuid: null), 'outcome' => CmdbImportReport::CREATED]; } - $uuid = (string)$existing->getUuid(); - $merged = $this->merge(target: 'usage', stored: $existing->getObject(), mapped: $data); + $uuid = (string)$existing['entity']->getUuid(); + $revived = $this->revive(found: $existing); + $merged = $this->merge(target: 'usage', stored: $revived['entity']->getObject(), mapped: $data); if ($merged === null) { - return ['uuid' => $uuid, 'outcome' => CmdbImportReport::UNCHANGED]; + return ['uuid' => $uuid, 'outcome' => ($revived['outcome'] ?? CmdbImportReport::UNCHANGED)]; } $this->save(schemaKey: 'usage', data: $merged, uuid: $uuid); - return ['uuid' => $uuid, 'outcome' => CmdbImportReport::UPDATED]; + return ['uuid' => $uuid, 'outcome' => ($revived['outcome'] ?? CmdbImportReport::UPDATED)]; }//end upsertUsage() /** @@ -1633,7 +1848,7 @@ private function organisationsOfType(string $type): array { }//end organisationsOfType() /** - * The one object matching every filter, or null. + * The working object matching every filter, or null. * * @param string $schemaKey The coordinates key of the schema. * @param array $filters Field => exact value. @@ -1643,10 +1858,67 @@ private function organisationsOfType(string $type): array { * @spec openspec/changes/cmdb-export-import/tasks.md#task-5 */ private function findOne(string $schemaKey, array $filters): ?object { + return $this->search(schemaKey: $schemaKey, filters: $filters, lens: []); + }//end findOne() + + /** + * The object matching every filter in any state, with that state, or null. + * + * A working object wins over an archived one, and an archived one over one + * in the trash: an object deleted by hand may share its import key with the + * one a later import created, and bringing the deleted one back would + * duplicate it. The state is the lens that found the object (design D9): + * a search without a lens finds only working objects, the archive lens only + * archived ones, and the trash is read from OpenRegister's trash listing, + * because its list search cannot return a soft-deleted object. + * + * @param string $schemaKey module or usage. + * @param array $filters Field => exact value. + * + * @return array{entity: object, state: array{archived: bool, deleted: bool}}|null + * + * @spec openspec/changes/cmdb-import-archive-reconciliation/specs/cmdb-export-import/spec.md#requirement-an-application-that-returns-to-the-export-shall-be-unarchived-or-restored-never-duplicated-req-cmdb-016 + */ + private function findInAnyState(string $schemaKey, array $filters): ?array { + $entity = $this->search(schemaKey: $schemaKey, filters: $filters, lens: []); + if ($entity !== null) { + return ['entity' => $entity, 'state' => self::STATE_WORKING]; + } + + $entity = $this->search(schemaKey: $schemaKey, filters: $filters, lens: self::ARCHIVED_LENS); + if ($entity !== null) { + return ['entity' => $entity, 'state' => self::STATE_ARCHIVED]; + } + + foreach (($this->trash()[$schemaKey] ?? []) as $entity) { + if (self::matchesFilters(entity: $entity, filters: $filters) === true) { + return ['entity' => $entity, 'state' => self::STATE_DELETED]; + } + } + + return null; + }//end findInAnyState() + + /** + * The first object a search with one lens returns that matches every filter, or null. + * + * The filters are checked again on the result: a filter OpenRegister cannot + * apply must not turn into a match. + * + * @param string $schemaKey The coordinates key of the schema. + * @param array $filters Field => exact value. + * @param array $lens No lens (working objects) or ARCHIVED_LENS. + * + * @return object|null The entity (ObjectEntityInterface). + * + * @spec openspec/changes/cmdb-import-archive-reconciliation/specs/cmdb-export-import/spec.md#requirement-an-application-that-returns-to-the-export-shall-be-unarchived-or-restored-never-duplicated-req-cmdb-016 + */ + private function search(string $schemaKey, array $filters, array $lens): ?object { $coordinates = $this->coordinates(); $results = $coordinates['objectService']->searchObjects( query: array_merge( ['@self' => ['register' => $coordinates['register'], 'schema' => $coordinates[$schemaKey]], '_limit' => 10], + $lens, $filters ), _rbac: false, @@ -1657,22 +1929,34 @@ private function findOne(string $schemaKey, array $filters): ?object { } foreach ($results as $entity) { - $data = $entity->getObject(); - $matches = true; - foreach ($filters as $field => $value) { - if (self::relationUuid(value: ($data[$field] ?? null)) !== $value) { - $matches = false; - break; - } - } - - if ($matches === true) { + if (self::matchesFilters(entity: $entity, filters: $filters) === true) { return $entity; } } return null; - }//end findOne() + }//end search() + + /** + * Whether an object's data has every filter's value. + * + * @param object $entity The entity (ObjectEntityInterface). + * @param array $filters Field => exact value. + * + * @return bool + * + * @spec openspec/changes/archive/2026-10-05-cmdb-export-import/tasks.md#task-5 + */ + private static function matchesFilters(object $entity, array $filters): bool { + $data = $entity->getObject(); + foreach ($filters as $field => $value) { + if (self::relationUuid(value: ($data[$field] ?? null)) !== $value) { + return false; + } + } + + return true; + }//end matchesFilters() /** * Save an object through OpenRegister and return its uuid. @@ -1699,6 +1983,832 @@ private function save(string $schemaKey, array $data, ?string $uuid): string { return (string)$entity->getUuid(); }//end save() + /** + * The `missingRecords` mode of an import: the option, or DEFAULT_MISSING_RECORDS. + * + * @param array $options The import options. + * + * @return string + * + * @spec openspec/changes/cmdb-import-archive-reconciliation/specs/cmdb-export-import/spec.md#requirement-records-missing-from-a-newer-export-shall-be-archived-by-default-or-kept-on-request-req-cmdb-012 + */ + private static function missingRecordsFrom(array $options): string { + $mode = ($options['missingRecords'] ?? null); + if (is_string($mode) === false || $mode === '') { + return self::DEFAULT_MISSING_RECORDS; + } + + return $mode; + }//end missingRecordsFrom() + + /** + * The archive sheet as the reader found it, with its APPIDs as match keys. + * + * @param array $workbook What the reader returned. + * + * @return ArchiveSheet + * + * @spec openspec/changes/cmdb-import-archive-reconciliation/specs/cmdb-export-import/spec.md#requirement-an-application-missing-from-the-cmdb-sheets-shall-be-archived-when-the-archive-sheet-lists-it-and-soft-deleted-when-no-sheet-does-req-cmdb-015 + */ + private function archiveSheet(array $workbook): array { + $archive = ($workbook['archive'] ?? []); + $key = $this->profile->keyColumn(); + $keys = []; + foreach (($archive['appIds'] ?? []) as $appId) { + $values = $this->normaliser->normalise(cells: [$key => $appId], dateColumns: [], idColumns: $this->profile->idColumns()); + $matchKey = self::matchKey(appId: ($values[$key] ?? '')); + if ($matchKey !== '') { + $keys[$matchKey] = true; + } + } + + return [ + 'sheet' => (string)($archive['sheet'] ?? ($this->profile->archiveSheetName() ?? '')), + 'present' => (($archive['present'] ?? false) === true), + 'keyColumnMissing' => (($archive['keyColumnMissing'] ?? false) === true), + 'uncachedRows' => array_values(array_map('intval', (array)($archive['uncachedRows'] ?? []))), + 'keys' => $keys, + ]; + }//end archiveSheet() + + /** + * The report warning of an archiving import whose archive sheet is absent or has no key column, or has unreadable keys. + * + * Also the warning of a CMDB sheet with unreadable keys: it is handed the sheet's name and rows in the archive sheet's shape. + * + * @param array{sheet: string, keyColumnMissing: bool, uncachedRows: array} $archive The archive sheet, or a CMDB sheet. + * + * @return string + * + * @spec openspec/changes/cmdb-import-archive-reconciliation/specs/cmdb-export-import/spec.md#requirement-an-application-missing-from-the-cmdb-sheets-shall-be-archived-when-the-archive-sheet-lists-it-and-soft-deleted-when-no-sheet-does-req-cmdb-015 + */ + private function archiveSheetWarning(array $archive): string { + if ($archive['uncachedRows'] !== []) { + // A long list is cut: the warning counts the rows and names where to look, not every one. + $count = count($archive['uncachedRows']); + $rows = implode(', ', array_slice($archive['uncachedRows'], 0, self::WARNED_ROWS)); + if ($count > self::WARNED_ROWS) { + $rows .= ', …'; + } + + if ($count === 1) { + return $this->l10n->t( + 'Sheet "%1$s" has an APPID without a cached value in row %2$s, so applications missing from the export are archived, not deleted.', + [$archive['sheet'], $rows] + ); + } + + return $this->l10n->t( + 'Sheet "%1$s" has an APPID without a cached value in %2$s rows (%3$s), so applications missing from the export are archived, not deleted.', + [$archive['sheet'], $count, $rows] + ); + } + + if ($archive['keyColumnMissing'] === true) { + return $this->l10n->t( + 'Sheet "%1$s" has no column "%2$s", so applications missing from the export are archived, not deleted.', + [$archive['sheet'], $this->profile->keyColumn()] + ); + } + + return $this->l10n->t('Sheet "%s" was not found, so applications missing from the export are archived, not deleted.', [$archive['sheet']]); + }//end archiveSheetWarning() + + /** + * Resolve OpenRegister's archive handler and object mapper, failing closed. + * + * @return array{handler: object, mapper: object} The handler, with `archive()` and `unarchive()`, and the + * mapper, with `restoreObject()` and `findDeletedAcrossAllMagicTables()`. + * + * @throws CmdbImportException ARCHIVE_UNAVAILABLE. + * + * @spec openspec/changes/cmdb-import-archive-reconciliation/specs/cmdb-export-import/spec.md#requirement-an-application-missing-from-the-cmdb-sheets-shall-be-archived-when-the-archive-sheet-lists-it-and-soft-deleted-when-no-sheet-does-req-cmdb-015 + */ + private function archiveServices(): array { + if ($this->archiveServices !== null) { + return $this->archiveServices; + } + + $previous = null; + try { + $handler = $this->container->get(static::ARCHIVE_HANDLER_CLASS); + $mapper = $this->container->get(static::OBJECT_MAPPER_CLASS); + } catch (Throwable $e) { + $this->logger->warning('CmdbExportImportService: OpenRegister archive services could not be resolved', ['exception' => get_class($e)]); + $previous = $e; + $handler = null; + $mapper = null; + } + + if (is_object($handler) === false || method_exists($handler, 'archive') === false || method_exists($handler, 'unarchive') === false + || is_object($mapper) === false || method_exists($mapper, 'restoreObject') === false + || method_exists($mapper, 'findDeletedAcrossAllMagicTables') === false + ) { + throw new CmdbImportException( + errorCode: CmdbImportException::ARCHIVE_UNAVAILABLE, + message: 'OpenRegister ArchiveHandler or MagicMapper is not available', + previous: $previous + ); + } + + $this->archiveServices = ['handler' => $handler, 'mapper' => $mapper]; + return $this->archiveServices; + }//end archiveServices() + + /** + * Whether an object as OpenRegister's mapper reads it by uuid is archived and whether it is in the trash. + * + * Read from its `@self` metadata. Only for an object the mapper read + * itself (the one restoreObject() answers): a list search result carries + * no archive marker (design D9). + * + * @param object $entity The entity (ObjectEntityInterface). + * + * @return array{archived: bool, deleted: bool} + * + * @spec openspec/changes/cmdb-import-archive-reconciliation/specs/cmdb-export-import/spec.md#requirement-an-application-that-returns-to-the-export-shall-be-unarchived-or-restored-never-duplicated-req-cmdb-016 + */ + private static function objectState(object $entity): array { + $self = []; + if ($entity instanceof JsonSerializable) { + $serialised = $entity->jsonSerialize(); + if (is_array($serialised) === true && is_array($serialised['@self'] ?? null) === true) { + $self = $serialised['@self']; + } + } + + return [ + 'archived' => (self::isEmptyValue(value: ($self['archived'] ?? null)) === false), + 'deleted' => (self::isEmptyValue(value: ($self['deleted'] ?? null)) === false), + ]; + }//end objectState() + + /** + * Bring a matched module or usage back before it is written: out of the trash, then out of the archive. + * + * OpenRegister refuses a data write to an archived object, and the + * archive handler cannot reach one in the trash, hence the order. The + * trash listing does not say whether an object was archived before it was + * deleted; the restored object, read by the mapper, does. The update then + * starts from that object: the trash listing decodes every string that + * parses as JSON, so its copy of the data must not be written back. + * + * @param array{entity: object, state: array{archived: bool, deleted: bool}} $found The matched entity and its state. + * + * @return array{outcome: string|null, entity: object} restored, unarchived, or null when it was neither, and the + * entity whose data the update starts from. + * + * @throws CmdbImportException ARCHIVE_UNAVAILABLE when the archive services are missing. + * + * @spec openspec/changes/cmdb-import-archive-reconciliation/specs/cmdb-export-import/spec.md#requirement-an-application-that-returns-to-the-export-shall-be-unarchived-or-restored-never-duplicated-req-cmdb-016 + */ + private function revive(array $found): array { + $entity = $found['entity']; + $archived = $found['state']['archived']; + if ($found['state']['deleted'] === false && $archived === false) { + return ['outcome' => null, 'entity' => $entity]; + } + + $uuid = (string)$entity->getUuid(); + $outcome = null; + if ($found['state']['deleted'] === true) { + $restored = $this->restore(uuid: $uuid); + $outcome = CmdbImportReport::RESTORED; + if (is_object($restored) === true && method_exists($restored, 'getObject') === true) { + $entity = $restored; + $archived = self::objectState(entity: $restored)['archived']; + } + } + + if ($archived === true) { + $this->archiveServices()['handler']->unarchive(identifier: $uuid, reason: self::REASON_PREFIX . 'back in the export'); + $outcome = ($outcome ?? CmdbImportReport::UNARCHIVED); + } + + return ['outcome' => $outcome, 'entity' => $entity]; + }//end revive() + + /** + * Take one object out of the trash, and out of this run's copy of the trash. + * + * @param string $uuid The object. + * + * @return mixed What MagicMapper::restoreObject() answers: the object as it reads it. + * + * @throws CmdbImportException ARCHIVE_UNAVAILABLE when the archive services are missing. + * + * @spec openspec/changes/cmdb-import-archive-reconciliation/specs/cmdb-export-import/spec.md#requirement-an-application-that-returns-to-the-export-shall-be-unarchived-or-restored-never-duplicated-req-cmdb-016 + */ + private function restore(string $uuid): mixed { + $restored = $this->archiveServices()['mapper']->restoreObject(uuid: $uuid); + if ($this->trash !== null) { + unset($this->trash['module'][$uuid], $this->trash['usage'][$uuid]); + } + + return $restored; + }//end restore() + + /** + * The register's soft-deleted modules and usages, read once per run. + * + * OpenRegister's list search cannot return a soft-deleted object, whatever + * `_includeDeleted` says, so the trash is read from the trash listing that + * the Deleted page uses (design D9). That listing scans every magic table + * of the instance, so it is read once, lazily, and only this register's + * modules and usages are kept. Its objects carry no archive or trash + * marker; everything in it is deleted. Without the archive services (a + * `keep` import on an OpenRegister without them) the trash cannot be read: + * nothing in it is matched, and the log says so. A listing that throws is + * not cached, so the next row reads it again. + * + * It is read for `keep` as well: matching is not tied to the mode (REQ-CMDB-016), + * and an application a person soft-deleted by hand must be restored, not + * created a second time. The listing cannot be narrowed, so the cost is one + * scan per run, paid on the first row no working or archived object matches. + * + * @return array{module: array, usage: array} Schema key => uuid => entity. + * + * @spec openspec/changes/cmdb-import-archive-reconciliation/specs/cmdb-export-import/spec.md#requirement-an-application-that-returns-to-the-export-shall-be-unarchived-or-restored-never-duplicated-req-cmdb-016 + */ + private function trash(): array { + if ($this->trash !== null) { + return $this->trash; + } + + try { + $services = $this->archiveServices(); + } catch (CmdbImportException $e) { + $this->logger->warning('CmdbExportImportService: OpenRegister trash is not readable; soft-deleted modules and usages are not matched'); + $this->trash = ['module' => [], 'usage' => []]; + return $this->trash; + } + + // Cached only once the listing was read: a listing that fails fails its row, and the + // next row reads it again instead of matching against an empty trash and duplicating. + $coordinates = $this->coordinates(); + $deleted = $services['mapper']->findDeletedAcrossAllMagicTables(limit: null, offset: null, _rbac: false, _multitenancy: false); + $this->trash = self::registerTrash(deleted: $deleted, coordinates: $coordinates); + + return $this->trash; + }//end trash() + + /** + * The modules and usages of this register among the instance's soft-deleted objects. + * + * @param mixed $deleted What MagicMapper::findDeletedAcrossAllMagicTables() answered. + * @param array $coordinates The register and schema ids, from coordinates(). + * + * @return array{module: array, usage: array} Schema key => uuid => entity. + * + * @spec openspec/changes/cmdb-import-archive-reconciliation/specs/cmdb-export-import/spec.md#requirement-an-application-that-returns-to-the-export-shall-be-unarchived-or-restored-never-duplicated-req-cmdb-016 + */ + private static function registerTrash(mixed $deleted, array $coordinates): array { + $trash = ['module' => [], 'usage' => []]; + if (is_array($deleted) === false) { + return $trash; + } + + foreach ($deleted as $entity) { + if (is_object($entity) === false || (string)$entity->getRegister() !== (string)$coordinates['register'] || $entity->getUuid() === null) { + continue; + } + + foreach (['module', 'usage'] as $schemaKey) { + if ((string)$entity->getSchema() === (string)$coordinates[$schemaKey]) { + $trash[$schemaKey][(string)$entity->getUuid()] = $entity; + } + } + } + + return $trash; + }//end registerTrash() + + /** + * Archive or soft-delete every application of the municipality whose APPID left the CMDB sheets. + * + * Runs after the last row of an import that was not cancelled, under the + * same register lock. The whole scope is loaded before anything is + * written, so the paging is not shifted by the writes. Every application + * has its own error boundary. A cancel is honoured before the scope is + * loaded and before each application: what was archived or deleted so far + * stays, and the report says the run was cancelled. + * + * @param string $municipalityUuid The consumer of this import. + * @param ArchiveSheet $archive The archive sheet. + * @param string $operationId The operation id, for the archive reason. + * @param int $processedItems The rows already counted as processed. + * @param CmdbImportReport $report The report. + * + * @return void + * + * @spec openspec/changes/cmdb-import-archive-reconciliation/specs/cmdb-export-import/spec.md#requirement-an-application-missing-from-the-cmdb-sheets-shall-be-archived-when-the-archive-sheet-lists-it-and-soft-deleted-when-no-sheet-does-req-cmdb-015 + */ + private function reconcile(string $municipalityUuid, array $archive, string $operationId, int $processedItems, CmdbImportReport $report): void { + // A cancel that came in during the last row stops the import before anything is archived or deleted. + if ($this->progressTracker->isCancelRequested(operationId: $operationId) === true) { + $report->markCancelled(); + return; + } + + $scope = $this->reconciliationScope(municipalityUuid: $municipalityUuid); + $this->progressTracker->setPhase(phase: 'reconciling', data: ['total_items' => ($processedItems + count($scope))]); + + foreach ($scope as $index => $application) { + if ($this->progressTracker->isCancelRequested(operationId: $operationId) === true) { + $report->markCancelled(); + return; + } + + // Every APPID on a CMDB sheet was handled by its row, whatever the row's outcome. + if (isset($this->winningSheets[$application['key']]) === false) { + $this->reconcileApplication(application: $application, archive: $archive, operationId: $operationId, report: $report); + } + + $this->progressTracker->updateProgress(processedItems: ($processedItems + $index + 1)); + } + }//end reconcile() + + /** + * The municipality's usages, in every state, each with its module when that module carries this municipality's import key. + * + * A usage of a hand-made module, or of a module another organisation + * imported, is left out: only what this municipality's import created is + * reconciled. Working and archived usages are paged with one lens each, + * soft-deleted ones come from the trash (design D9); each object keeps the + * state its lens or the trash gave it. When an import key occurs more than + * once, only the entry the import would match is kept (onePerKey()). + * + * @param string $municipalityUuid The consumer of this import. + * + * @return array}> + * Per application, the APPID's match key, the usage, the module and the state of both by schema key. + * + * @spec openspec/changes/cmdb-import-archive-reconciliation/specs/cmdb-export-import/spec.md#requirement-an-application-missing-from-the-cmdb-sheets-shall-be-archived-when-the-archive-sheet-lists-it-and-soft-deleted-when-no-sheet-does-req-cmdb-015 + */ + private function reconciliationScope(string $municipalityUuid): array { + $usages = $this->usagesInEveryState(municipalityUuid: $municipalityUuid); + + $owned = []; + foreach ($usages as $usage) { + $data = $usage['entity']->getObject(); + $moduleUuid = self::relationUuid(value: ($data['module'] ?? null)); + // The filter is checked again: a filter OpenRegister cannot apply must not widen the scope. + if (self::relationUuid(value: ($data['consumer'] ?? null)) === $municipalityUuid && $moduleUuid !== null && $usage['entity']->getUuid() !== null) { + $owned[] = $usage + ['module' => $moduleUuid]; + } + } + + $prefix = $this->profile->externalKeyPrefix() . ':' . $municipalityUuid . ':'; + $modules = $this->modulesByUuid(uuids: array_values(array_unique(array_column($owned, 'module')))); + $scope = []; + foreach ($owned as $usage) { + $module = ($modules[$usage['module']] ?? null); + if ($module === null) { + continue; + } + + $externalKey = (string)($module['entity']->getObject()['externalKey'] ?? ''); + if (str_starts_with($externalKey, $prefix) === true && strlen($externalKey) > strlen($prefix)) { + $scope[] = [ + 'key' => substr($externalKey, strlen($prefix)), + 'usage' => $usage['entity'], + 'module' => $module['entity'], + 'states' => ['usage' => $usage['state'], 'module' => $module['state']], + ]; + } + } + + return self::onePerKey(scope: $scope); + }//end reconciliationScope() + + /** + * One application per import key: the entry the import would match, with the other usages of the key as extras. + * + * The import takes a working module before an archived one, and an archived + * one before one in the trash (design D4), so a module deleted by hand next + * to the one a later import created is never revived. The reconciliation + * follows the same order: the entry with the best module state is the + * application, the best usage state breaks a tie, and the first one listed + * breaks the rest. The other entries of the key are not dropped: their + * usages, and their modules when those are not in the trash, are carried + * as `extras` and brought to the same state, so a stray usage of a stale + * duplicate does not stay visible. Nothing in the trash is restored for an + * extra, and nothing the application itself holds is listed twice. + * + * @param array $scope The entries. + * + * @return array + * + * @spec openspec/changes/cmdb-import-archive-reconciliation/specs/cmdb-export-import/spec.md#requirement-an-application-missing-from-the-cmdb-sheets-shall-be-archived-when-the-archive-sheet-lists-it-and-soft-deleted-when-no-sheet-does-req-cmdb-015 + */ + private static function onePerKey(array $scope): array { + $preferred = []; + $ranks = []; + $entries = []; + foreach ($scope as $application) { + $rank = ((self::stateRank(state: $application['states']['module']) * 3) + self::stateRank(state: $application['states']['usage'])); + $key = $application['key']; + $entries[$key][] = $application; + if (isset($ranks[$key]) === false || $rank < $ranks[$key]) { + $ranks[$key] = $rank; + $preferred[$key] = $application; + } + } + + foreach ($preferred as $key => $application) { + $preferred[$key]['extras'] = self::extrasOf(application: $application, entries: $entries[$key]); + } + + return array_values($preferred); + }//end onePerKey() + + /** + * The usages and modules of the other entries of a key that the reconciliation brings to the same state. + * + * A usage or module appears once, and not when the application holds it + * itself. One in the trash is left out: it is not visible, and restoring + * a stale duplicate is what the preference rule exists to prevent. + * + * @param ScopeEntry $application The preferred entry of the key. + * @param array $entries Every entry of the key. + * + * @return array Usages first, then modules. + * + * @spec openspec/changes/cmdb-import-archive-reconciliation/specs/cmdb-export-import/spec.md#requirement-an-application-missing-from-the-cmdb-sheets-shall-be-archived-when-the-archive-sheet-lists-it-and-soft-deleted-when-no-sheet-does-req-cmdb-015 + */ + private static function extrasOf(array $application, array $entries): array { + $seen = [(string)$application['usage']->getUuid() => true, (string)$application['module']->getUuid() => true]; + $found = ['usage' => [], 'module' => []]; + foreach ($entries as $entry) { + foreach (['usage', 'module'] as $schemaKey) { + $uuid = (string)$entry[$schemaKey]->getUuid(); + if (isset($seen[$uuid]) === false && $entry['states'][$schemaKey]['deleted'] === false) { + $seen[$uuid] = true; + $found[$schemaKey][] = ['schemaKey' => $schemaKey, 'uuid' => $uuid, 'state' => $entry['states'][$schemaKey]]; + } + } + } + + return array_merge($found['usage'], $found['module']); + }//end extrasOf() + + /** + * How far down the preference order a state is: working 0, archived 1, deleted 2. + * + * @param array{archived: bool, deleted: bool} $state The state. + * + * @return int + * + * @spec openspec/changes/cmdb-import-archive-reconciliation/specs/cmdb-export-import/spec.md#requirement-an-application-missing-from-the-cmdb-sheets-shall-be-archived-when-the-archive-sheet-lists-it-and-soft-deleted-when-no-sheet-does-req-cmdb-015 + */ + private static function stateRank(array $state): int { + if ($state['deleted'] === true) { + return 2; + } + + if ($state['archived'] === true) { + return 1; + } + + return 0; + }//end stateRank() + + /** + * The usages that name this municipality as consumer, in every state, each with that state. + * + * Working and archived usages are paged with one lens each; soft-deleted + * ones come from the trash, which is not filtered by consumer, so the + * caller checks the consumer of every usage. + * + * @param string $municipalityUuid The consumer of this import. + * + * @return array + * + * @spec openspec/changes/cmdb-import-archive-reconciliation/specs/cmdb-export-import/spec.md#requirement-an-application-missing-from-the-cmdb-sheets-shall-be-archived-when-the-archive-sheet-lists-it-and-soft-deleted-when-no-sheet-does-req-cmdb-015 + */ + private function usagesInEveryState(string $municipalityUuid): array { + $coordinates = $this->coordinates(); + $usages = []; + foreach ([[[], self::STATE_WORKING], [self::ARCHIVED_LENS, self::STATE_ARCHIVED]] as [$lens, $state]) { + $offset = 0; + do { + $page = $coordinates['objectService']->searchObjects( + query: array_merge( + [ + '@self' => ['register' => $coordinates['register'], 'schema' => $coordinates['usage']], + 'consumer' => $municipalityUuid, + '_limit' => self::PAGE_SIZE, + '_offset' => $offset, + ], + $lens + ), + _rbac: false, + _multitenancy: false + ); + if (is_array($page) === false) { + $page = []; + } + + foreach ($page as $usage) { + $usages[] = ['entity' => $usage, 'state' => $state]; + } + + $offset += self::PAGE_SIZE; + $pageSize = count($page); + } while ($pageSize === self::PAGE_SIZE); + }//end foreach + + foreach ($this->trash()['usage'] as $usage) { + $usages[] = ['entity' => $usage, 'state' => self::STATE_DELETED]; + } + + return $usages; + }//end usagesInEveryState() + + /** + * The modules with these uuids, in every state, each with its state. + * + * Per chunk of PAGE_SIZE uuids one search without a lens and one with + * the archive lens; the rest is looked up in the trash. + * + * @param array $uuids The module uuids. + * + * @return array Uuid => entity and state. + * + * @spec openspec/changes/cmdb-import-archive-reconciliation/specs/cmdb-export-import/spec.md#requirement-an-application-missing-from-the-cmdb-sheets-shall-be-archived-when-the-archive-sheet-lists-it-and-soft-deleted-when-no-sheet-does-req-cmdb-015 + */ + private function modulesByUuid(array $uuids): array { + $coordinates = $this->coordinates(); + $modules = []; + foreach (array_chunk($uuids, self::PAGE_SIZE) as $chunk) { + // The chunks are disjoint, so a uuid found in an earlier chunk is never overwritten. + $modules += $this->modulesInChunk(chunk: $chunk, coordinates: $coordinates); + } + + foreach ($uuids as $uuid) { + $trashed = ($this->trash()['module'][$uuid] ?? null); + if (isset($modules[$uuid]) === false && $trashed !== null) { + $modules[$uuid] = ['entity' => $trashed, 'state' => self::STATE_DELETED]; + } + } + + return $modules; + }//end modulesByUuid() + + /** + * The working and archived modules of one chunk of uuids; a module both lenses return keeps the first state. + * + * @param array $chunk At most PAGE_SIZE module uuids. + * @param array $coordinates The object service and register and schema ids, from coordinates(). + * + * @return array Uuid => entity and state. + * + * @spec openspec/changes/cmdb-import-archive-reconciliation/specs/cmdb-export-import/spec.md#requirement-an-application-missing-from-the-cmdb-sheets-shall-be-archived-when-the-archive-sheet-lists-it-and-soft-deleted-when-no-sheet-does-req-cmdb-015 + */ + private function modulesInChunk(array $chunk, array $coordinates): array { + $modules = []; + foreach ([[[], self::STATE_WORKING], [self::ARCHIVED_LENS, self::STATE_ARCHIVED]] as [$lens, $state]) { + $results = $coordinates['objectService']->searchObjects( + query: array_merge( + ['@self' => ['register' => $coordinates['register'], 'schema' => $coordinates['module']], '_ids' => $chunk, '_limit' => count($chunk)], + $lens + ), + _rbac: false, + _multitenancy: false + ); + if (is_array($results) === false) { + continue; + } + + foreach ($results as $entity) { + $uuid = (string)$entity->getUuid(); + if (in_array($uuid, $chunk, true) === true && isset($modules[$uuid]) === false) { + $modules[$uuid] = ['entity' => $entity, 'state' => $state]; + } + } + } + + return $modules; + }//end modulesInChunk() + + /** + * Archive or soft-delete one application that left the CMDB sheets, usage first, in its own error boundary. + * + * The writes go in this order: the application's own usage, the other + * usages of its key, its module, the other modules. A failure stops the + * application there and reports one `failed` row (the step and the + * exception class, no list of what was already written). What it leaves: + * a failing own usage leaves everything as it was; a failing extra usage + * leaves the own usage in the new state, that extra and the module as + * they were (so the extra stays visible and the module stays working); + * a failing module leaves every usage in the new state and the module + * as it was. The next import reconciles the application again. + * An application already in the state the export asks for is not reported. + * + * @param ScopeEntry $application The application. + * @param ArchiveSheet $archive The archive sheet. + * @param string $operationId The operation id, for the archive reason. + * @param CmdbImportReport $report The report. + * + * @return void + * + * @spec openspec/changes/cmdb-import-archive-reconciliation/specs/cmdb-export-import/spec.md#requirement-an-application-missing-from-the-cmdb-sheets-shall-be-archived-when-the-archive-sheet-lists-it-and-soft-deleted-when-no-sheet-does-req-cmdb-015 + */ + private function reconcileApplication(array $application, array $archive, string $operationId, CmdbImportReport $report): void { + $moduleData = $application['module']->getObject(); + [ + 'target' => $target, + 'reason' => $reason, + 'sheet' => $sheet, + 'onArchiveSheet' => $onArchiveSheet, + ] = $this->reconcileTarget(key: $application['key'], archive: $archive, operationId: $operationId); + $entry = [ + 'sheet' => $sheet, + 'row' => 0, + 'appId' => (string)($moduleData['externalNumber'] ?? $application['key']), + 'name' => (string)($moduleData['name'] ?? ''), + ]; + + $uuids = ['module' => (string)$application['module']->getUuid(), 'usage' => (string)$application['usage']->getUuid()]; + $step = 'archive'; + $changed = false; + try { + foreach (self::itemsOf(application: $application, restoreDeleted: $onArchiveSheet) as $item) { + foreach (self::transitions(state: $item['state'], target: $target, restoreDeleted: $item['restore']) as $step) { + $this->transition(step: $step, schemaKey: $item['schemaKey'], uuid: $item['uuid'], reason: $reason); + $changed = true; + } + } + } catch (Throwable $e) { + // The module's stored values are taken out of the log line, as a row's cells are. + $values = array_map('strval', array_filter($moduleData, static fn (mixed $value): bool => is_scalar($value))); + $this->failRow(report: $report, entry: $entry, step: $step, e: $e, warnings: [], uuids: [$uuids['module'], $uuids['usage']], values: $values); + return; + } + + if ($changed === true) { + $this->addRow(report: $report, entry: $entry, outcome: $target, moduleUuid: $uuids['module'], usageUuid: $uuids['usage']); + } + }//end reconcileApplication() + + /** + * Where an application that left the CMDB sheets goes, and the archive reason it gets. + * + * Listed on the archive sheet: archived, with that sheet as the reason. + * Otherwise soft-deleted, but only when the workbook is authoritative for + * a deletion: it has the archive sheet and no sheet has a row whose key + * could not be read. In every other case it is archived. + * + * @param string $key The application key. + * @param ArchiveSheet $archive The archive sheet. + * @param string $operationId The operation id, for the archive reason. + * + * @return array{target: string, reason: string, sheet: string, onArchiveSheet: bool} + * + * @spec openspec/changes/cmdb-import-archive-reconciliation/specs/cmdb-export-import/spec.md#requirement-an-application-missing-from-the-cmdb-sheets-shall-be-archived-when-the-archive-sheet-lists-it-and-soft-deleted-when-no-sheet-does-req-cmdb-015 + */ + private function reconcileTarget(string $key, array $archive, string $operationId): array { + if ($archive['present'] === true && isset($archive['keys'][$key]) === true) { + return [ + 'target' => CmdbImportReport::ARCHIVED, + 'reason' => self::REASON_PREFIX . 'on sheet "' . $archive['sheet'] . '" (' . $operationId . ')', + 'sheet' => $archive['sheet'], + 'onArchiveSheet' => true, + ]; + } + + $target = CmdbImportReport::ARCHIVED; + if ($archive['present'] === true && $archive['uncachedRows'] === [] && $this->unreadableKeyRows === []) { + // A sheet with an unreadable key (the archive sheet or a CMDB sheet) may list this application, so the + // workbook is not authoritative for a deletion. + $target = CmdbImportReport::DELETED; + } + + return [ + 'target' => $target, + 'reason' => self::REASON_PREFIX . 'not in the export (' . $operationId . ')', + 'sheet' => '', + 'onArchiveSheet' => false, + ]; + }//end reconcileTarget() + + /** + * What one application brings to the state the export asks for: its usage and the other usages of its key, then its module and the other modules. + * + * Own usage, extra usages, own module, extra modules. Usages come before + * modules, so a failure leaves usages in the new state and a module at + * worst unchanged; it does not leave a module changed under a usage that + * still shows. An extra usage that fails does hold back the module. + * + * Only the application's own objects are restored from the trash, and only + * when `restoreDeleted` says so; the extras never are. + * + * @param ScopeEntry $application The application. + * @param bool $restoreDeleted Whether the application's own objects in the trash are restored to be archived. + * + * @return array + * + * @spec openspec/changes/cmdb-import-archive-reconciliation/specs/cmdb-export-import/spec.md#requirement-an-application-missing-from-the-cmdb-sheets-shall-be-archived-when-the-archive-sheet-lists-it-and-soft-deleted-when-no-sheet-does-req-cmdb-015 + */ + private static function itemsOf(array $application, bool $restoreDeleted): array { + $items = []; + foreach (['usage', 'module'] as $schemaKey) { + // Every usage is written before any module, whoever holds it. + $items[] = [ + 'schemaKey' => $schemaKey, + 'uuid' => (string)$application[$schemaKey]->getUuid(), + 'state' => $application['states'][$schemaKey], + 'restore' => $restoreDeleted, + ]; + foreach (($application['extras'] ?? []) as $extra) { + if ($extra['schemaKey'] === $schemaKey) { + $items[] = $extra + ['restore' => false]; + } + } + } + + return $items; + }//end itemsOf() + + /** + * The steps that bring one module or usage to the state the export asks for (design D5). + * + * Deleted: soft-delete what is not in the trash yet. Archived: archive + * what is working; an object in the trash is restored first only when the + * archive sheet lists it, so a workbook without the sheet never takes + * anything out of the trash. + * + * @param array{archived: bool, deleted: bool} $state The object's state. + * @param string $target archived or deleted. + * @param bool $restoreDeleted Whether an object in the trash is restored to be archived. + * + * @return array delete, restore and archive, in order; empty when nothing changes. + * + * @spec openspec/changes/cmdb-import-archive-reconciliation/specs/cmdb-export-import/spec.md#requirement-an-application-missing-from-the-cmdb-sheets-shall-be-archived-when-the-archive-sheet-lists-it-and-soft-deleted-when-no-sheet-does-req-cmdb-015 + */ + private static function transitions(array $state, string $target, bool $restoreDeleted): array { + if ($target === CmdbImportReport::DELETED) { + if ($state['deleted'] === true) { + return []; + } + + return ['delete']; + } + + if ($state['deleted'] === true) { + if ($restoreDeleted === true) { + return ['restore', 'archive']; + } + + return []; + } + + if ($state['archived'] === true) { + return []; + } + + return ['archive']; + }//end transitions() + + /** + * Run one step through OpenRegister: soft delete, restore from the trash, or archive. + * + * @param string $step delete, restore or archive. + * @param string $schemaKey The coordinates key of the schema. + * @param string $uuid The object. + * @param string $reason The archive reason. + * + * @return void + * + * @throws RuntimeException When OpenRegister does not delete the object. + * + * @spec openspec/changes/cmdb-import-archive-reconciliation/specs/cmdb-export-import/spec.md#requirement-an-application-missing-from-the-cmdb-sheets-shall-be-archived-when-the-archive-sheet-lists-it-and-soft-deleted-when-no-sheet-does-req-cmdb-015 + */ + private function transition(string $step, string $schemaKey, string $uuid, string $reason): void { + if ($step === 'delete') { + $coordinates = $this->coordinates(); + $deleted = $coordinates['objectService']->deleteObject( + uuid: $uuid, + register: $coordinates['register'], + schema: $coordinates[$schemaKey], + _rbac: false, + _multitenancy: false + ); + if ($deleted !== true) { + throw new RuntimeException('OpenRegister did not delete the object'); + } + + return; + } + + if ($step === 'restore') { + $this->restore(uuid: $uuid); + return; + } + + $this->archiveServices()['handler']->archive(identifier: $uuid, reason: $reason); + }//end transition() + /** * Resolve OpenRegister's mapping engine. * @@ -1915,6 +3025,8 @@ private function resetRun(): void { $this->winningSheets = []; $this->contactUids = []; $this->contactPersons = []; + $this->archiveServices = null; + $this->trash = null; }//end resetRun() /** diff --git a/lib/Service/ProgressTracker.php b/lib/Service/ProgressTracker.php index b0c9ce229..5a9706ada 100644 --- a/lib/Service/ProgressTracker.php +++ b/lib/Service/ProgressTracker.php @@ -62,6 +62,11 @@ class ProgressTracker { 'processing_relationships' => ['weight' => 15, 'description' => 'Processing relationships'], 'processing_organizations' => ['weight' => 10, 'description' => 'Processing organizations'], 'processing_views' => ['weight' => 10, 'description' => 'Processing views'], + // The CMDB import's reconciliation of records missing from the source + // (openspec/changes/cmdb-import-archive-reconciliation). Weight 0, so the + // weighted percentage of the ArchiMate import's phases is unchanged; the + // CMDB section computes its own percentage from the item counts. + 'reconciling' => ['weight' => 0, 'description' => 'Reconciling records missing from the source'], 'finalizing' => ['weight' => 5, 'description' => 'Finalizing import'], 'completed' => ['weight' => 0, 'description' => 'Completed'], ]; diff --git a/lib/Settings/cmdb-import/topdesk-business-owner.json b/lib/Settings/cmdb-import/topdesk-business-owner.json index f987d51ee..3bc7e1921 100644 --- a/lib/Settings/cmdb-import/topdesk-business-owner.json +++ b/lib/Settings/cmdb-import/topdesk-business-owner.json @@ -3,7 +3,7 @@ "name": "TOPdesk CMDB export to business owner identity", "description": "The application owner (Applicatie Eigenaar (Persoon)); the value may be a function instead of a name and is used as the display name either way. The import resolves it in Nextcloud Contacts by exact display name and links a contactPerson of the municipality as usage.businessOwner, with the owner's function as its role. No other person column is read.", "sourceFormat": "excel", - "version": "2.0.0", + "version": "1.0.0", "fieldMappings": [ { "source": "Applicatie Eigenaar (Persoon)", "target": "name", "required": true, "transform": { "type": "trim" } }, { "source": "Applicatie Eigenaar (Functie)", "target": "role", "transform": { "type": "trim" } } diff --git a/lib/Settings/cmdb-import/topdesk-manufacturer.json b/lib/Settings/cmdb-import/topdesk-manufacturer.json index dec8b10c9..ae3cb262e 100644 --- a/lib/Settings/cmdb-import/topdesk-manufacturer.json +++ b/lib/Settings/cmdb-import/topdesk-manufacturer.json @@ -3,7 +3,7 @@ "name": "TOPdesk CMDB export to stackiq supplier organisation", "description": "The Vendor column (the maker of the software) becomes one organisation of type Supplier per distinct name, registered as a Supplier so the public catalogue can show it as the module's provider. An empty Vendor means the row has no provider. Leverancier and Hostingpartij are not read.", "sourceFormat": "excel", - "version": "2.1.0", + "version": "1.0.0", "fieldMappings": [ { "source": "Vendor", "target": "name", "required": true, "transform": { "type": "trim" } } ], diff --git a/lib/Settings/cmdb-import/topdesk-module.json b/lib/Settings/cmdb-import/topdesk-module.json index 3a7ca7496..a1f0368c2 100644 --- a/lib/Settings/cmdb-import/topdesk-module.json +++ b/lib/Settings/cmdb-import/topdesk-module.json @@ -3,7 +3,7 @@ "name": "TOPdesk CMDB export to stackiq module", "description": "One application row of a CMDB sheet becomes a stackiq module. A mapping marked required that fails skips the row; any other failing mapping drops that field with a warning. Nickname and Roepnaam both feed shortDescription; Roepnaam wins when both are filled. Applicatiesoort is kept as is in applicationType; only its SaaS/PaaS/IaaS/on-premises values also set the hosting model, every other kind leaves that empty without a warning.", "sourceFormat": "excel", - "version": "2.0.0", + "version": "1.0.0", "fieldMappings": [ { "source": "Applicatie Naam", "target": "name", "required": true, "transform": { "type": "trim" } }, { "source": "APPID", "target": "externalNumber", "required": true, "transform": { "type": "trim" } }, diff --git a/lib/Settings/cmdb-import/topdesk-profile.json b/lib/Settings/cmdb-import/topdesk-profile.json index 79dc43253..a21cf3c15 100644 --- a/lib/Settings/cmdb-import/topdesk-profile.json +++ b/lib/Settings/cmdb-import/topdesk-profile.json @@ -1,8 +1,8 @@ { "id": "topdesk-cmdb", "name": "TOPdesk CMDB export", - "version": "2.0.0", - "description": "How stackiq reads a TOPdesk CMDB export (xlsx): the two CMDB sheets, the key and required columns, date and id columns, values that mean empty, the pack per target and the limits. Columns that neither this profile nor a pack names are never read.", + "version": "1.0.0", + "description": "How stackiq reads a TOPdesk CMDB export (xlsx): the two CMDB sheets, the archive sheet (APPID column only), the key and required columns, date and id columns, values that mean empty, the pack per target, the accepted missingRecords modes and the limits. Columns that neither this profile nor a pack names are never read.", "maxFileBytes": 10485760, "maxRowsPerSheet": 10000, "maxUncompressedBytes": 52428800, @@ -21,6 +21,7 @@ } ], "sheetPrecedence": ["Beheerde Applicaties CMDB", "Onbeh Applicaties CMDB"], + "archiveSheet": { "name": "Gearchiveerde Applicaties" }, "keyColumn": "APPID", "nameColumn": "Applicatie Naam", "requiredColumns": ["APPID", "Applicatie Naam"], @@ -44,5 +45,5 @@ "neverWritten": { "module": ["publicationDate", "depublicationDate"] }, - "missingRecords": ["keep"] + "missingRecords": ["keep", "archive"] } diff --git a/lib/Settings/cmdb-import/topdesk-usage.json b/lib/Settings/cmdb-import/topdesk-usage.json index 0038df197..3edcf7476 100644 --- a/lib/Settings/cmdb-import/topdesk-usage.json +++ b/lib/Settings/cmdb-import/topdesk-usage.json @@ -3,7 +3,7 @@ "name": "TOPdesk CMDB export to stackiq usage", "description": "The usage that links the application to the municipality. The internal note records whether maintenance is arranged (the sheet the row came from), the cluster and the owner's department. An unknown status or TIME value drops the field with a warning.", "sourceFormat": "excel", - "version": "2.0.0", + "version": "1.0.0", "fieldMappings": [ { "source": "Applicatie Status", diff --git a/lib/Settings/register.d/topdesk-cmdb-import.json b/lib/Settings/register.d/topdesk-cmdb-import.json index 5fb300099..977c5db24 100644 --- a/lib/Settings/register.d/topdesk-cmdb-import.json +++ b/lib/Settings/register.d/topdesk-cmdb-import.json @@ -2,7 +2,10 @@ "components": { "schemas": { "module": { - "version": "0.3.8", + "version": "0.3.9", + "configuration": { + "x-openregister-archive": { "enabled": true } + }, "properties": { "externalId": { "type": "string", @@ -72,8 +75,9 @@ } }, "usage": { - "version": "1.5.6", + "version": "1.5.7", "configuration": { + "x-openregister-archive": { "enabled": true }, "x-openregister-lifecycle": { "transitions": { "importAcquisition": { diff --git a/openapi.json b/openapi.json index 7ee628b87..f456fc209 100644 --- a/openapi.json +++ b/openapi.json @@ -62,10 +62,11 @@ "missingRecords": { "type": "string", "enum": [ - "keep" + "keep", + "archive" ], - "default": "keep", - "description": "Only keep is accepted; mark and remove are reserved" + "default": "archive", + "description": "What happens to the municipality's applications whose APPID is no longer on either CMDB sheet. archive: after the last row, archive module and usage when the sheet \"Gearchiveerde Applicaties\" lists the APPID, soft-delete them when no sheet does, and archive only when the workbook has no archive sheet, the sheet has no APPID column, an APPID in it has no cached value, or an APPID on a CMDB sheet has no cached value (that application may be the one the reader could not see); an archived or deleted application that returns is unarchived or restored. keep: leave them as they are. mark and remove are reserved and refused with 422 MISSING_RECORDS_UNSUPPORTED" }, "operationId": { "type": "string", @@ -128,7 +129,7 @@ } }, "422": { - "description": "MISSING_RECORDS_UNSUPPORTED, MUNICIPALITY_REQUIRED, MUNICIPALITY_INVALID, MUNICIPALITY_AMBIGUOUS (more than one live Municipality has the typed name; details.matches lists their uuids), NO_SOURCE_SHEET, MISSING_COLUMN or TOO_MANY_ROWS", + "description": "MISSING_RECORDS_UNSUPPORTED (details.accepted lists keep and archive), MUNICIPALITY_REQUIRED, MUNICIPALITY_INVALID, MUNICIPALITY_AMBIGUOUS (more than one live Municipality has the typed name; details.matches lists their uuids), NO_SOURCE_SHEET, MISSING_COLUMN or TOO_MANY_ROWS", "content": { "application/json": { "schema": { @@ -148,7 +149,7 @@ } }, "503": { - "description": "MAPPING_UNAVAILABLE, READER_UNAVAILABLE, NOT_CONFIGURED, or SCHEMA_OUTDATED (a stackiq schema lacks a property the import matches on, or the module schema predates 0.3.8; details.schema names it and details.missing lists the properties, and externalKey.authorization.update for a missing admin-only write rule)", + "description": "MAPPING_UNAVAILABLE, READER_UNAVAILABLE, NOT_CONFIGURED, or SCHEMA_OUTDATED (a stackiq schema lacks a property the import matches on, or the module schema predates 0.3.8; details.schema names it and details.missing lists the properties, and externalKey.authorization.update for a missing admin-only write rule), or ARCHIVE_UNAVAILABLE (missingRecords=archive, but OpenRegister's archive handler or object mapper is missing; nothing is read or written)", "content": { "application/json": { "schema": { @@ -499,6 +500,10 @@ "unchanged", "skipped", "failed", + "archived", + "unarchived", + "deleted", + "restored", "warnings", "unpublished" ], @@ -524,6 +529,22 @@ "failed": { "type": "integer" }, + "archived": { + "type": "integer", + "description": "Applications whose module and usage this import archived because they left the CMDB sheets" + }, + "unarchived": { + "type": "integer", + "description": "Rows whose archived module or usage this import unarchived before updating it" + }, + "deleted": { + "type": "integer", + "description": "Applications whose module and usage this import soft-deleted because no sheet lists them any more" + }, + "restored": { + "type": "integer", + "description": "Rows whose soft-deleted module or usage this import restored from the trash before updating it" + }, "warnings": { "type": "integer" }, @@ -571,7 +592,8 @@ "type": "string" }, "row": { - "type": "integer" + "type": "integer", + "description": "The sheet row, or 0 for an application the reconciliation archived or deleted" }, "appId": { "type": "string" @@ -586,7 +608,11 @@ "updated", "unchanged", "skipped", - "failed" + "failed", + "archived", + "unarchived", + "deleted", + "restored" ] }, "reasons": { diff --git a/openspec/changes/cmdb-import-archive-reconciliation/.openspec.yaml b/openspec/changes/cmdb-import-archive-reconciliation/.openspec.yaml new file mode 100644 index 000000000..5c0f6674b --- /dev/null +++ b/openspec/changes/cmdb-import-archive-reconciliation/.openspec.yaml @@ -0,0 +1,2 @@ +schema: conduction +created: 2026-10-09 diff --git a/openspec/changes/cmdb-import-archive-reconciliation/design.md b/openspec/changes/cmdb-import-archive-reconciliation/design.md new file mode 100644 index 000000000..5329cc153 --- /dev/null +++ b/openspec/changes/cmdb-import-archive-reconciliation/design.md @@ -0,0 +1,212 @@ +# Design: cmdb-import-archive-reconciliation + +## Context + +The CMDB import (archived change `2026-10-05-cmdb-export-import`) matches rows on `module.externalKey` = `topdesk::` and leaves records that are missing from a newer export untouched (REQ-CMDB-012). The municipality's export carries, next to the two CMDB sheets, a sheet "Gearchiveerde Applicaties" (columns Applicatiecomponent, APPID, Applicatie Code, Applicatie Naam, Roepnaam, Applicatie Status, Bron, Datum Interface, Datum wijziging), derived from the raw "Invoer gearchiveerde appl" sheet. The municipality wants an application that moved there to be archived, and one that is on no sheet any more to be soft-deleted (2026-10-01). + +What OpenRegister offers (origin/beta `ff4dad5c`, identical to development for `lib/`): + +- **Soft delete.** `ObjectServiceInterface::deleteObject(uuid, register, schema, ...)` writes `@self.deleted` (`deletedBy`, `deletedAt`, `purgeDate` 30 days on). Lists exclude deleted objects unless `_includeDeleted=true`, but the list search cannot return one even then (D9). `MagicMapper::findDeletedAcrossAllMagicTables()` lists the trash; `MagicMapper::restoreObject(uuid)` clears the marker. `DeletedController` uses both. +- **Archive.** `ObjectEntity::archive()` / `unarchive()` write and clear `@self.archived` (`by`, `at`, `reason`). `Service\Object\ArchiveHandler::archive()` / `unarchive()` is the service path behind `POST` / `DELETE /api/objects/{register}/{schema}/{id}/archive`: it resolves the object, refuses a schema without `x-openregister-archive: {enabled: true}` (`ArchiveNotOfferedException`), checks `update` on the object for the session user, persists the marker and writes an audit entry. Lists exclude archived objects unless `_archived=true` (only the archive) or `_archived=any`. A read by identifier is unaffected. `SaveObject` refuses a data write to an archived object (`ObjectStateWriteException`). +- **Search lenses** combine in SQL: `_ids`, `_includeDeleted` and `_archived` apply together in `MagicSearchHandler`. Its row conversion, however, drops a soft-deleted row and hydrates no archive marker (D9). + +OpenCatalogi (beta `df25ff75`) passes list parameters through to OpenRegister and forces `_includeDeleted=false`; it has no archive filter of its own, so `_archived=true` reaches OpenRegister unchanged. Portaliq (beta `8287e390`) lists usages with neither lens. Both hide archived and deleted records as they are (decided 2026-10-09). + +## Goals / Non-Goals + +**Goals** + +- A re-import archives what moved to the archive sheet and soft-deletes what left the export entirely, for the imported municipality only. +- A returning application is revived, never duplicated. +- The admin sees and chooses the behaviour, and the report accounts for every archived, unarchived, deleted and restored application. +- Archived applications and usages can be listed in stackiq on request and stay out of OpenCatalogi and Portaliq without a change there. + +**Non-Goals** + +- Hard deletion, the trash's retention, contact persons, suppliers, modules another organisation imported (a module carrying this municipality's import key is this municipality's record, also when another organisation uses it; D5), changes to OpenCatalogi or Portaliq, an archive widget on the detail pages. + +## Architecture Overview + +``` +CmdbImportController::import() missingRecords: keep | archive (default archive); remove → 422 + ▼ +CmdbExportImportService::import() + ├─ resolve ArchiveHandler + MagicMapper (archive mode only; missing → 503 ARCHIVE_UNAVAILABLE) + ├─ lock the register + ├─ CmdbWorkbookReader::read() CMDB sheets as before + the archive sheet's APPID column + ├─ rows, each in its own boundary match module and usage: working, then _archived=true, then the trash (D9) + │ archived match → unarchive, deleted match → restore (and unarchive), then the usual update + └─ reconcile() (archive mode, not cancelled) phase `reconciling`, same lock + page usages (consumer = municipality): working, then _archived=true; deleted ones from the trash + load their modules in batches (_ids: working, then _archived=true; the rest from the trash) + per application: key on CMDB sheets → nothing + key on archive sheet → archive module + usage (restore first when deleted) + key nowhere → soft-delete module + usage, or archive when the sheet is absent or incomplete (D3) + each in its own boundary → report rows archived | deleted | failed + ▼ +OpenRegister: module, usage (archived / deleted markers); contactPerson, organization untouched + ├─▶ OpenCatalogi: archived modules only with _archived=true + └─▶ Portaliq: archived and deleted usages disappear from "Software we use" +``` + +## Decisions + +### D1. "Archived" is OpenRegister's archive state on the module and on the usage + +Decided by the product owner on 2026-10-09. No new field, no new `usage.status` value, no `depublicationDate`. + +- **Alternative: `usage.status` `Archived`.** Rejected: OpenCatalogi drops `status === 'archived'` only on `/api/search`, so `/api/{catalogSlug}` and the federation route would need an OpenCatalogi change and a new beta. +- **Alternative: `module.depublicationDate`.** Rejected: the module read rule does not look at it, and the import never writes it (D6 of the first change). + +Both schemas opt in through the register fragment: `module` 0.3.8 → 0.3.9 and `usage` 1.5.6 → 1.5.7 get `configuration.x-openregister-archive: {"enabled": true}`. Fragments are merged by key union and the loader keeps the highest `version` per schema, so the bump deploys with the existing register import. The `SCHEMA_OUTDATED` check is not widened: an installation whose schemas predate the annotation gets `ArchiveNotOfferedException` per object, which the reconciliation reports as a failed row (D7), and the docs point to Force Update. + +### D2. The option: `keep | archive`, default `archive` + +`CmdbImportProfile::missingRecordsModes()` reads the accepted values from the profile (`["keep", "archive"]`) without validating the packs, like `maxFileBytes()`, because the controller checks the option before the import runs. The default lives in `CmdbExportImportService::DEFAULT_MISSING_RECORDS`. `remove` and `mark` stay reserved: 422 `MISSING_RECORDS_UNSUPPORTED` with `details.accepted` naming both accepted values. The section sends the admin's choice as `missingRecords` and defaults to `archive`. + +With `updateExisting=false`, a matched row is skipped as `exists` before anything is revived, as before: the admin asked to leave existing records alone. + +### D3. Reading the archive sheet + +The profile names the sheet (`archiveSheet.name`: "Gearchiveerde Applicaties"). The reader lists the workbook's sheets, and when the archive sheet is present it is loaded with the CMDB sheets under the same bounds: it counts as a read sheet for `CmdbPartReferences` (an oversized archive sheet is refused, not blanked) and for the referenced-string budget, its row span is bounded like a source sheet, and `TOO_MANY_ROWS` names it. Only its APPID column is resolved and read; the allowlist does not grow. The reader returns `archive: {present, keyColumnMissing, appIds, uncachedRows}` next to `rows`. + +- Sheet absent, or present without an APPID column: `present` false (with `keyColumnMissing`), and the service adds a report warning. The reconciliation then archives every missing application and soft-deletes nothing: a workbook saved without the sheet must not empty the trash-bound set by accident. +- A row whose APPID is a formula without a cached value reads as empty, as on the CMDB sheets (REQ-CMDB-002), so the sheet would silently list one application fewer. The reader therefore lists such rows (their numbers) in `uncachedRows`, and the service treats the sheet like an absent one for the decision between archive and delete: it adds a warning naming the sheet and the rows, archives every missing application and soft-deletes nothing. A tool that saves formulas without cached values must not turn archived applications into trash. The same holds for a CMDB sheet: a row whose APPID has no cached value is skipped, so that application may be on a CMDB sheet and still look absent. The service notes such rows (`unreadableKeyRows`, per sheet) and, with any of them, archives instead of soft-deleting and warns naming the CMDB sheet and the rows, as for the archive sheet. +- The archive sheet's other columns are not read; `Applicatie Status` there is always `Verwijderd` in the municipality's export and adds nothing. + +### D4. Matching widens to archived and deleted objects, and revives what it matches + +`matchModule()` looks the module up by `externalKey` in every state, as D9 reads it; `moduleBelongsTo()` looks up this municipality's usage the same way (a module whose usage is archived still belongs to the municipality), and keeps the working lens for "does any other organisation use it". `upsertUsage()` finds the usage in every state. Whatever is matched is revived before it is written: a soft-deleted object is restored (`MagicMapper::restoreObject()`), and unarchived as well when the restored object says it was archived; an archived one is unarchived (`ArchiveHandler::unarchive()`), because `SaveObject` refuses a write to an archived object. The update starts from the object `restoreObject()` answers, not from the trash listing's copy. The row outcome is `restored` when anything was restored, else `unarchived` when anything was unarchived, else the usual `created | updated | unchanged`. When more than one object matches, `findInAnyState()` takes a working one before an archived one, and an archived one before one in the trash: before this change a module deleted by hand was invisible to the match, so the next import created a second one with the same `externalKey`, and reviving the deleted one would make two live modules. Organisations and contact persons keep the working lens: a deleted supplier is never matched. + +### D5. The reconciliation step + +Runs inside `runImport()` after the row loop, only when the loop finished (not cancelled) and `missingRecords` is `archive`, under the register lock the import already holds. It checks for a cancel once before it loads the scope (a cancel that came in during the last row) and again before each application; a cancel stops it there, keeps what was already archived or deleted, and marks the report cancelled. An exception outside an object's boundary fails the run like any other (`IMPORT_FAILED`, operation `failed`), so a half-done reconciliation is visible. + +Scope: the usages whose `consumer` is the municipality, in every state as D9 reads it: paged with `PAGE_SIZE` without a lens and with `_archived=true`, plus the deleted ones from the trash. Their modules are loaded in chunks of `PAGE_SIZE` with `_ids`, without a lens and with `_archived=true`, and the rest from the trash. Every usage and module keeps the state D9 gave it; the table below decides on that state. Only a module whose `externalKey` starts with `topdesk::` is an imported application; the key after the last `:` is the APPID's match key. A usage without such a module (a hand-made usage, or a module another organisation imported) is left alone. + +Per application, with `processed` = every APPID match key on the CMDB sheets (whatever the row's outcome: a row that failed or was skipped is still in the export) and `archived` = the match keys on the archive sheet: + +| key is | module/usage state | action | outcome | +|---|---|---|---| +| on a CMDB sheet | any | nothing (the row handled it) | — | +| on the archive sheet | working | archive usage, then module | `archived` | +| on the archive sheet | archived | nothing | — | +| on the archive sheet | deleted | restore, then archive | `archived` | +| nowhere, sheet present | working or archived | soft-delete usage, then module | `deleted` | +| nowhere, sheet present | deleted | nothing | — | +| nowhere, sheet absent or incomplete (no key column, `uncachedRows` not empty, or a CMDB-sheet row with an unreadable APPID) | working | archive usage, then module | `archived` | +| nowhere, sheet absent or incomplete | archived or deleted | nothing | — | + +The table decides on one entry per key. When a municipality has several usages and modules under the same import key (D4 says earlier imports created exactly such duplicates, a module deleted by hand next to the one a later import created), the scope keeps the entry the import would match: the best module state wins (working, then archived, then deleted), the best usage state breaks a tie, the first listed breaks the rest. The other usages of the key follow the application, so a stray usage stays visible nowhere: a working or archived usage of a stale duplicate, a second usage of the same module, and a working or archived duplicate module are archived or soft-deleted as the key asks, once, in the same error boundary and the same report row (usages first, then modules). What is in the trash is left as it is: a stale trashed duplicate is not restored into the archive when the key is on the archive sheet, and is not touched when it is on no sheet. + +The writes go in this order: the application's own usage, the other usages of its key, its module, the other modules. A failure stops that application and gives one `failed` report row (step and exception class only). A failing own usage leaves everything as it was; a failing extra usage leaves the own usage in the new state and that extra and the module as they were (the extra stays visible, the module stays working); a failing module leaves every usage in the new state and the module as it was. Never is a module changed while a usage of the key still shows. The next import reconciles the application again. A module another municipality still uses is archived or deleted all the same when this municipality's usage says so: the module carries this municipality's import key, so it is this municipality's record (REQ-CMDB-006 allows a shared module only when the other organisation's usage was added by hand). The archive reason is `cmdb-import: on sheet "Gearchiveerde Applicaties"` or `cmdb-import: not in the export`, plus the operation id, so the audit trail says why. + +Each application runs in its own boundary: a failure is a `failed` row naming the step (`archive`, `restore`, `delete`) and the exception class, as row failures do, and the other applications continue. Contact persons are never touched. + +Progress: the operation gets the phase `reconciling` (added to `ProgressTracker::PHASES` with weight 0, so the ArchiMate import's weighted percentage is unchanged), `total_items` grows by the number of usages in scope, and `processed_items` advances per application; the section's own percentage comes from those counts. + +### D6. The report + +`CmdbImportReport` gains the outcomes `archived`, `unarchived`, `deleted` and `restored`; `summary()` counts them like the others. Reconciliation rows carry the archive sheet's name (for `archived` from the sheet) or an empty sheet, row 0, the APPID (`externalNumber`), the module name and both uuids: no person data. `toStoredArray()` ranks them with the rest. The section shows the four counts as summary tiles when they are non-zero, and the outcome filter offers them. + +### D7. Failure modes + +- `ArchiveHandler` or `MagicMapper` missing, or without a method the import calls (`archive`, `unarchive`, `restoreObject`, `findDeletedAcrossAllMagicTables`): 503 `ARCHIVE_UNAVAILABLE` before the lock is taken, only in archive mode. `keep` needs neither: without them the trash cannot be read, so a soft-deleted module or usage is not matched (the log says so) and a row whose match must be unarchived fails at step `module` or `usage`. +- A schema without `x-openregister-archive`: `ArchiveNotOfferedException` from OpenRegister per object → a failed row with the exception class; the docs say to run Force Update. +- A failure while reviving a matched row: the row fails at step `module` or `usage` like any other row failure. + +### D8. Stackiq UI + +> This section records the decision. The UI code it describes (the quick filters, the `_ids` override and the `src/icons.js` entry) is not part of the reader slice in this PR; it lands in the UI follow-up PR (#1287). + +The Applications (`Modules`, a `FacetedCatalogIndexView` that forwards `quickFilters` to `CnIndexPage`) and Applications in use (`Gebruik`) pages get the quick filter `{"label": "Archived", "filter": {"_archived": "true"}}`. `useSelfFetchList` spreads the active tab's filter into the fetch parameters as they are, so `_archived=true` reaches OpenRegister and the list shows the archive alone. The facet narrowing's `_ids` would compose with it (AND) and hide archived applications the facets do not know; the Archived tab of the Applications page therefore overrides `_ids` with an empty value, so it lists the whole archive and ignores the facets and the search. The icon `ArchiveOutline` is registered in `src/icons.js`. `@conduction/nextcloud-vue` 2.65 renders no `@self.archived` on a detail page or in the sidebar metadata, so the detail pages show no archive state yet; that is a library follow-up, not a stackiq widget. + +### D9. How the import reads the state of a stored object + +Found on a Nextcloud 35 rig with OpenRegister 2.1.37-beta (origin/beta `ff4dad5c`): the second import of the original export left APPID 1234 archived (`unchanged`) and created a second module for APPID 2. `ObjectService::searchObjects()` (via `QueryHandler::searchObjects()` → `MagicMapper::searchObjects()` → `MagicSearchHandler::searchObjects()`) applies the lenses in SQL (`buildFilteredQuery()` → `applyBasicFilters()`, `MagicSearchHandler.php` 2135–2153), but converts each row with `MagicSearchHandler::convertRowToObjectEntity()` (3780), which: + +- reads no `_archived` column, so every result keeps `ObjectEntity::$archived = []` (`ObjectEntity.php` 334) and looks working; +- turns the `_deleted` marker into `new DateTime(...)` (3896–3898), but `DeleteObject` writes it as a JSON object (`DeleteObject.php` 361), so the conversion throws, the row becomes null (4035) and `executeSearchQuery()` skips it (3714): `_includeDeleted=true` returns no soft-deleted object. + +So the import never reads the state from a search result: + +- **Working**: found by a search without a lens. **Archived**: found by a search with `_archived=true` (the archive alone, not deleted). An object is looked up working first, then archived. +- **Deleted**: from `MagicMapper::findDeletedAcrossAllMagicTables(_rbac: false, _multitenancy: false)`, the listing behind the Deleted page, which reads the rows itself (`MagicMapper.php` 7001). It scans every magic table of the instance and pages only after merging them, so the import reads it once per run, lazily, and keeps this register's modules and usages. Its objects carry data but no markers (`MagicMapper::rowToObjectEntity()`, 9131), and that data has every string that parses as JSON decoded ("2" becomes 2), so it is never written back. +- **Deleted and archived**: the trash does not say. `MagicMapper::restoreObject()` clears `_deleted` (10078) and answers the object as the mapper reads it by uuid, through `MagicStatisticsHandler::convertRowToObjectEntity()`, which does decode `_archived` (`MagicStatisticsHandler.php` 631–652). A returning row unarchives it when that object is archived, and updates from it. The reconciliation does not need to know: an object in the trash is either left there or restored and archived, and `ArchiveHandler::archive()` leaves an archived object as it is (`ArchiveHandler.php` 111). + +`ArchiveHandler::unarchive()` clears the marker to SQL NULL, so the object is back in the working lists, and does nothing for an object that is not archived (161). A lookup costs one search for a working match and two for an archived one or none, plus the one trash read per run. When OpenRegister hydrates both markers on search results, this can go back to one search with both lenses; the lens-based reading stays correct either way. + +## API Design + +`POST /api/cmdb-import`: `missingRecords` accepts `keep` and `archive` (default `archive`). The report's `summary` gains `archived`, `unarchived`, `deleted` and `restored`; `rows[].outcome` may be any of the four; reconciliation rows have `row: 0`. New error code 503 `ARCHIVE_UNAVAILABLE`. `MISSING_RECORDS_UNSUPPORTED` keeps its status and gains both accepted values in `details.accepted`. `openapi.json` is updated accordingly. + +## Database Changes + +None. The archive and delete markers are OpenRegister's metadata columns. + +## Mixed-spec rationale (ADR-032) + +The change is `kind: code`. Its only schema delta is the annotation `x-openregister-archive: {enabled: true}` on `module` and `usage` in the existing fragment `topdesk-cmdb-import.json`, with a version bump of both. The annotation is glue for this code: OpenRegister refuses to archive an object of a schema without it, and nothing else in stackiq reads it. It follows the fragment convention (ADR-037) and deploys with the existing register import. + +## Declarative-vs-imperative decision (ADR-031) + +- **Declarative:** which schemas may be archived (`x-openregister-archive` on `module` and `usage`), which sheet is the archive sheet and which option values are accepted (`topdesk-profile.json`), and which list shows the archive (the manifest quick filter `_archived=true`). +- **Imperative, because it is the external-integration exception the first change already claimed:** comparing an uploaded workbook with the register and deciding per application between nothing, archive, unarchive, soft-delete and restore. No `x-openregister-*` block can express "archive when the source lists it as archived and delete when the source no longer lists it": that rule depends on a file the register never sees. The state transitions themselves are OpenRegister's (`ArchiveHandler`, `deleteObject()`, `restoreObject()`); stackiq only decides when to call them. +- **Rule stated once, enforced in code:** the table in D5. + +## Nextcloud Integration + +- Controller: `CmdbImportController::import()` (unchanged auth: Nextcloud admins only, CSRF). +- Services: `CmdbExportImportService` (lenses, revival, reconciliation), `Cmdb\CmdbWorkbookReader` and `Cmdb\CmdbImportProfile` (archive sheet), `Cmdb\CmdbImportReport` (outcomes), `ProgressTracker` (phase). +- OpenRegister: `ObjectServiceInterface::searchObjects()` with `_archived` and `_ids`, `::deleteObject()` (contract); `Service\Object\ArchiveHandler::archive()` / `unarchive()` and `Db\MagicMapper::restoreObject()` / `findDeletedAcrossAllMagicTables()` (container, guarded, like the mapping engine). The handler checks `update` for the session user with RBAC on; the import is admin-only, so the check passes, and the audit entry names the admin. + +## Security Considerations + +- Still admin-only, CSRF-protected, with the file bounds of the first change; the archive sheet is read under the same bounds, APPID column only. +- Scope is the imported municipality's usages; a supplier's or another municipality's module is never archived or deleted through this municipality's import. +- Nothing is hard-deleted; every transition is an OpenRegister audit entry with a reason. +- The report and the logs carry APPIDs, module names and uuids, never owner data; contact persons are untouched. + +## NL Design System + +The section adds one radio group with a help text, built from `NcCheckboxRadioSwitch` like the existing switches, labelled and translated. The quick filter is the library's own chip. + +## File Structure + +``` +lib/Service/CmdbExportImportService.php lenses, revival, reconcile(), state helpers +lib/Service/Cmdb/CmdbWorkbookReader.php the archive sheet +lib/Service/Cmdb/CmdbImportProfile.php archiveSheetName(), readSheetNames(), missingRecordsModes() +lib/Service/Cmdb/CmdbImportReport.php archived | unarchived | deleted | restored +lib/Controller/CmdbImportController.php default archive, accepted values, ARCHIVE_UNAVAILABLE +lib/Exception/CmdbImportException.php ARCHIVE_UNAVAILABLE +lib/Service/ProgressTracker.php phase reconciling +lib/Settings/cmdb-import/topdesk-profile.json archiveSheet, missingRecords +lib/Settings/register.d/topdesk-cmdb-import.json x-openregister-archive, module 0.3.9, usage 1.5.7 +src/utils/cmdbImport.js, src/views/settings/sections/CmdbImport.vue +src/manifest.json, src/manifest.d/usages.json, src/icons.js +tests/Unit/..., tests/fixtures/cmdb/topdesk-archived-applications.xlsx, tests/e2e/spec-coverage/cmdb-import.spec.ts +docs/features/cmdb-import.md, l10n/en.json, l10n/nl.json +``` + +## Seed Data + +No seed objects change. The fragment's three seed modules stay as they are; the `module` and `usage` schemas gain only the archive annotation. + +## Risks / Trade-offs + +- [The default archives on the first re-import after the upgrade] → The section shows the choice with help text; the report lists every archived and deleted application; nothing is hard-deleted. +- [A workbook saved without the archive sheet, or whose archive sheet has no APPID column or an APPID without a cached value, or a CMDB sheet with an APPID without a cached value] → archive only, never delete, plus a warning (D3). +- [A failure part way through an application] → usages are written before modules, so a module is never changed under a usage that still shows; but a failing extra usage leaves the own usage changed, that extra visible and the module unchanged, and the row only says `failed`. The next import retries (D5). +- [Reviving before writing adds calls per returning row] → only for rows whose match is archived or deleted; a row whose module is working costs the same searches as before, a new row one more search (the archive lens). +- [The trash listing scans every magic table of the instance] → read once per import, not per row (D9). +- [OpenRegister internals change shape] → guarded resolution, 503 before the file is read (D7). + +## Migration Plan + +No data migration. The fragment deploys with the existing register import (Force Update on an installation that already has the register). Rollback is a revert of the PR; archived or deleted objects keep their state and can be unarchived or restored by hand. + +## Open Questions + +- Should the library render `@self.archived` on detail pages, so an admin sees why an application is not in the list? (library follow-up) +- Should a module that no usage points at any more be archived as well? Out of scope here. diff --git a/openspec/changes/cmdb-import-archive-reconciliation/proposal.md b/openspec/changes/cmdb-import-archive-reconciliation/proposal.md new file mode 100644 index 000000000..d9685e710 --- /dev/null +++ b/openspec/changes/cmdb-import-archive-reconciliation/proposal.md @@ -0,0 +1,95 @@ +--- +kind: code +depends_on: [] +--- + +# Proposal: cmdb-import-archive-reconciliation + +## Summary + +A repeated CMDB import now reconciles the applications a municipality uses with the newer export. An application whose APPID is no longer on the two CMDB sheets but is listed on the export's sheet "Gearchiveerde Applicaties" is archived: its `module` and the municipality's `usage` get OpenRegister's archive state, so they drop out of every list and search until an admin asks for the archive. An application whose APPID is on no sheet at all is soft-deleted through OpenRegister's trash, from which it can be restored. An application that returns to the export is unarchived, or restored from the trash, and then updated as usual, so no duplicate is ever created. The import option `missingRecords` accepts `keep` and `archive`, and `archive` is the default; the settings section shows the choice. Stackiq's Applications and Applications in use pages get an "Archived" quick filter. The report gets the outcomes `archived`, `unarchived`, `deleted` and `restored`. + +## Motivation + +The first version of the import (openspec/changes/archive/2026-10-05-cmdb-export-import) left records that disappeared from a newer export untouched. The municipality delivers a new export every month and asked on 2026-10-01 (Jira WOO-587, parent WOO-586, epic WOO-281): an application that left the CMDB sheets but is on the archive sheet must be marked as archived and be findable in OpenCatalogi only with an explicit filter; an application that is on no sheet any more must be soft-deleted with the existing functionality. Without this, the catalogue keeps showing applications the municipality retired, and Portaliq keeps listing them under "Software we use". + +OpenRegister already has both states. Its archive state (`@self.archived`, `POST /api/objects/{register}/{schema}/{id}/archive`) keeps an object whole but out of every list unless `_archived=true` or `_archived=any` is asked; its soft delete (`@self.deleted`) puts an object in the trash for 30 days, from which it can be restored. OpenCatalogi passes the list parameters through to OpenRegister, and Portaliq lists usages without either lens, so both apps hide archived and deleted records with no change of their own (decided 2026-10-09). + +## Capabilities + +### New Capabilities + +None. + +### Modified Capabilities + +- `cmdb-export-import`: `missingRecords` becomes `keep | archive` with `archive` as the default (REQ-CMDB-012 modified); the reconciliation of missing records against the archive sheet (REQ-CMDB-015), the return of an archived or deleted application (REQ-CMDB-016) and the archive lens in stackiq (REQ-CMDB-017) are added; the settings section shows the choice (REQ-CMDB-014 modified). The `module` and `usage` schemas opt into OpenRegister's archive state through the register fragment (see design.md, Mixed-spec rationale). + +## Affected Projects + +- [ ] Project: `stackiq`: import service, workbook reader and profile, controller option, register fragment, the "CMDB import" settings section, the manifest quick filters, tests, fixtures, administrator docs and translations. + +## Scope + +### In Scope + +- The sheet "Gearchiveerde Applicaties" (columns Applicatiecomponent, APPID, Applicatie Code, Applicatie Naam, Roepnaam, Applicatie Status, Bron, Datum Interface, Datum wijziging) is read for its APPID column only, when it is present. +- After every row of a completed import: the municipality's usages, with their modules, are compared with the APPIDs on the CMDB sheets and on the archive sheet. Missing and on the archive sheet: module and usage archived. Missing everywhere: module and usage soft-deleted. Without the archive sheet, or when it has no APPID column or an APPID the reader cannot see (a formula without a cached value, on the archive sheet or on a CMDB sheet): archived only, with a warning in the report. +- A returning APPID: an archived module or usage is unarchived, a soft-deleted one is restored from the trash, and the row is then updated as before. +- `missingRecords`: `keep` leaves everything as it is (the behaviour so far), `archive` reconciles and is the default; `remove` stays reserved and is refused. +- The settings section offers the choice with help text; the report shows the new outcomes in its summary and rows. +- `x-openregister-archive` on the `module` and `usage` schemas through the register fragment, with a version bump. +- An "Archived" quick filter on the Applications and Applications in use pages. +- PHPUnit, Jest, a Playwright e2e for the re-import with the archive sheet, a fixture variant, docs and Dutch and English strings. + +### Out of Scope + +- Hard deletion of objects; the trash's own retention (30 days) stays OpenRegister's. +- Changes to the municipality's TOPdesk export, and the raw "Invoer gearchiveerde appl" sheet (the derived "Gearchiveerde Applicaties" sheet is the source). +- Contact persons: the owner of an archived or deleted application stays, because it is shared with the municipality's other applications. +- Modules only other organisations use, and organisations (suppliers) that no application names any more. +- An archive widget on the detail pages: `@conduction/nextcloud-vue` 2.65 does not render `@self.archived`; a follow-up once the library does. +- Changes to OpenCatalogi or Portaliq. + +## Approach + +`CmdbWorkbookReader` loads the archive sheet next to the two CMDB sheets when the workbook has it, under the same size and row bounds, and hands the import service the APPIDs it holds. `CmdbExportImportService` widens the match of a module (by import key) and of a usage (by consumer and module) to archived and soft-deleted objects, and revives what it matches before the usual update. After the last row, when the import was not cancelled and `missingRecords` is `archive`, a reconciliation step pages through the municipality's usages with no lens and with OpenRegister's `_archived=true` lens, reads the trash once through `MagicMapper::findDeletedAcrossAllMagicTables()` (a search with `_includeDeleted=true` returns no deleted rows on the current OpenRegister beta; design.md D9), loads their modules in batches, and archives, unarchives, soft-deletes or restores module and usage through OpenRegister's `ArchiveHandler`, `ObjectServiceInterface::deleteObject()` and `MagicMapper::restoreObject()`, each object in its own error boundary. The step runs under the import's register lock, reports its progress in a phase of its own, and adds its outcomes to the report. Details are in design.md. + +## New Dependencies + +None. `ArchiveHandler` and `MagicMapper` come from OpenRegister, which stackiq already requires; both are resolved through the container behind a guard, like the mapping engine. + +## Impact + +- **Backend**: `lib/Service/CmdbExportImportService.php` (match lenses, revival, reconciliation), `lib/Service/Cmdb/CmdbWorkbookReader.php` and `CmdbImportProfile.php` (archive sheet), `CmdbImportReport.php` (outcomes), `lib/Controller/CmdbImportController.php` (option default and accepted values), `lib/Service/ProgressTracker.php` (phase `reconciling`), `lib/Exception/CmdbImportException.php` (`ARCHIVE_UNAVAILABLE`). +- **Configuration**: `lib/Settings/cmdb-import/topdesk-profile.json` (archive sheet, accepted modes). +- **Schema**: `lib/Settings/register.d/topdesk-cmdb-import.json` declares `x-openregister-archive` on `module` (0.3.9) and `usage` (1.5.7). +- **Frontend**: `src/views/settings/sections/CmdbImport.vue`, `src/utils/cmdbImport.js`, `src/manifest.json`, `src/manifest.d/usages.json`, `src/icons.js`. +- **Data**: a re-import with the default option archives or soft-deletes modules and usages the export no longer lists. Nothing is hard-deleted; a soft-deleted object can be restored from OpenRegister's trash for 30 days. + +## Cross-Project Dependencies + +- **openregister** (consumed, not changed): `ObjectServiceInterface::deleteObject()` (contract), `Service\Object\ArchiveHandler` and `Db\MagicMapper::restoreObject()` and `findDeletedAcrossAllMagicTables()` (not public contracts, guarded), the `_archived` list lens, and the schema annotation `x-openregister-archive`. +- **opencatalogi** and **portaliq** (consumers, not changed): both list through OpenRegister's default lens, so archived and deleted applications disappear from them without a change; an OpenCatalogi caller finds archived applications with `_archived=true` on the existing public routes. + +## Risks + +### Risk 1: A re-import with the new default archives what an admin did not expect +**Severity:** Medium — **Mitigation:** only the municipality's own usages and the modules they point at are in scope, never a supplier's or another municipality's module; nothing is hard-deleted; the choice is visible in the section with help text, and the report lists every archived and deleted application. A cancelled or failed import never reconciles. + +### Risk 2: A workbook without a usable archive sheet soft-deletes everything that moved there +**Severity:** Medium — **Mitigation:** without the sheet, without its APPID column, or with an APPID the reader cannot see on it or on a CMDB sheet (a formula without a cached value), missing applications are archived, never soft-deleted, and the report warns, naming the sheet (and the rows). + +### Risk 3: The archive services are OpenRegister internals +**Severity:** Low — **Mitigation:** resolved through the container behind a guard; when missing, an import with `missingRecords=archive` is refused with 503 `ARCHIVE_UNAVAILABLE` before the file is read, and `keep` still works. + +### Risk 4: The schemas on an installation predate the annotation +**Severity:** Low — **Mitigation:** OpenRegister refuses to archive an object of a schema without `x-openregister-archive`; the import reports that object as failed and the docs point to Force Update, which deploys the fragment. + +## Rollback Strategy + +Revert the PR. Objects archived or soft-deleted by an import keep their state; an admin unarchives them through OpenRegister's object actions or restores them from the trash. The schema annotation may stay deployed without harm. + +## Open Questions + +- Should a module that no usage points at any more (every municipality archived it) be archived as well? Out of scope here; a supplier's module stays. diff --git a/openspec/changes/cmdb-import-archive-reconciliation/specs/cmdb-export-import/spec.md b/openspec/changes/cmdb-import-archive-reconciliation/specs/cmdb-export-import/spec.md new file mode 100644 index 000000000..a3b5cd2e8 --- /dev/null +++ b/openspec/changes/cmdb-import-archive-reconciliation/specs/cmdb-export-import/spec.md @@ -0,0 +1,252 @@ +# cmdb-export-import Specification + +**Status**: in-progress +**Scope**: stackiq +**OpenSpec changes**: +- [cmdb-export-import](../../../archive/2026-10-05-cmdb-export-import/) _(archived 2026-10-05)_ +- [cmdb-import-archive-reconciliation](../../) + +## Purpose + +A repeated CMDB import reconciles the applications a municipality uses with the newer export. An application whose APPID left the two CMDB sheets is archived in OpenRegister's archive state when the export's sheet "Gearchiveerde Applicaties" lists it, and soft-deleted into OpenRegister's trash when no sheet lists it any more; one that returns is unarchived or restored and updated as usual, never duplicated. Archived and deleted applications disappear from OpenCatalogi and Portaliq without a change there, and stackiq lists the archive on request (Jira WOO-587). + +OpenRegister: `OCA\OpenRegister\Contract\ObjectServiceInterface` (`searchObjects()` with no lens and with the `_archived=true` and `_ids` lenses, `deleteObject()`), `Service\Object\ArchiveHandler` (`archive()`, `unarchive()`) and `Db\MagicMapper` (`findDeletedAcrossAllMagicTables()` for the trash, `restoreObject()`) (both resolved through the container behind a guard; why the trash is read that way: design.md D9), and the schema annotation `x-openregister-archive`. + +## ADDED Requirements + +### Requirement: An application missing from the CMDB sheets SHALL be archived when the archive sheet lists it and soft-deleted when no sheet does (REQ-CMDB-015) + +With `missingRecords` `archive`, after every row of an import that was not cancelled and did not fail, the import SHALL reconcile, under the register lock it already holds, every `usage` whose `consumer` is the imported municipality together with the `module` it points at, including archived and soft-deleted ones, and only those whose module carries this municipality's import key (`topdesk::`). It SHALL read the APPID column of the sheet "Gearchiveerde Applicaties" when the workbook has it, under the same size and row bounds as the CMDB sheets and without reading any other column of it. For an application whose APPID is on neither CMDB sheet: when the archive sheet lists the APPID, the import SHALL archive the usage and then the module through OpenRegister's archive state with a reason that names the import, restoring a soft-deleted one from the trash first; when no sheet lists it, the import SHALL soft-delete the usage and then the module through OpenRegister's trash. When the workbook has no archive sheet, or the sheet has no APPID column, or a row of the sheet holds an APPID formula without a cached value (read as empty, as REQ-CMDB-002 has it for the CMDB sheets, and listed by the reader in `archive.uncachedRows`), the import SHALL archive and SHALL NOT soft-delete, and SHALL add a warning to the report; for an uncached row the warning SHALL name the sheet and the row numbers. The same holds when a row of a CMDB sheet holds an APPID formula without a cached value (the row is skipped as empty, so its application may look absent): the import SHALL archive and SHALL NOT soft-delete, and the warning SHALL name that CMDB sheet and the rows. When a municipality has more than one module or usage under the same import key (a module deleted by hand next to the one a later import created), the import SHALL reconcile as the application the one it would match, a working one before an archived one and an archived one before one in the trash, and SHALL bring every other usage of that key, and every other module of it that is not in the trash, to the same state, so no stray usage stays visible; it SHALL leave what is in the trash as it is, so a stale duplicate is never restored into the archive. An application that is already in the state the export asks for SHALL be left alone and not reported. The import SHALL NOT touch contact persons, organisations, modules that carry another municipality's import key or no import key, or usages of another organisation. Each application SHALL be reconciled in its own error boundary: a failure SHALL be a `failed` report row naming the step and the exception class, and the other applications SHALL still be reconciled. The reconciliation SHALL report its progress as the phase `reconciling` of the import's operation. A cancel SHALL also be honoured after the last row and before each application of the reconciliation: the import SHALL stop there, SHALL keep what it archived or deleted so far, and SHALL report the run as cancelled. The report SHALL count `archived` and `deleted` in its summary and SHALL list each as a row with the APPID, the application name and both uuids, never person data. When OpenRegister's archive handler or object mapper is not available, an import with `missingRecords` `archive` SHALL be refused with 503 `ARCHIVE_UNAVAILABLE` before the file is read. + +#### Scenario: An application that moved to the archive sheet is archived +@e2e tests/e2e/spec-coverage/cmdb-import.spec.ts + +- **GIVEN** the modules with APPID `1234` and `2` were imported for "Gemeente Voorbeeldstad" with their usages +- **WHEN** an export is imported in which `1234` is only on "Gearchiveerde Applicaties" and `2` is on no sheet +- **THEN** the module and the usage of `1234` SHALL carry OpenRegister's archive state and the report row SHALL be `archived` +- **AND** the module and the usage of `2` SHALL be in OpenRegister's trash and the report row SHALL be `deleted` +- **AND** the Applications page SHALL list `1234` under the quick filter "Archived" and neither under "All" +- **AND** the owner contact person SHALL be unchanged + +#### Scenario: Without the archive sheet a missing application is archived, never deleted +@e2e exclude Covered by the service test; tests/Unit/Service/CmdbExportImportServiceTest.php testWithoutTheArchiveSheetMissingApplicationsAreArchivedNotDeleted imports a workbook without the sheet and asserts the archive state, no delete, and the warning naming the sheet. + +- **GIVEN** the module with APPID `7` and its usage were imported +- **WHEN** a workbook without "Gearchiveerde Applicaties" that no longer lists `7` is imported +- **THEN** the module and the usage of `7` SHALL be archived and SHALL NOT be deleted +- **AND** the report SHALL carry a warning that the sheet "Gearchiveerde Applicaties" was not found + +#### Scenario: A stale duplicate under the same import key is left in the trash +@e2e exclude Data condition from earlier imports; tests/Unit/Service/CmdbExportImportServiceTest.php testAStaleDuplicateIsNeverRestoredByTheReconciliation stores a working and a trashed module and usage for APPID `7`, lists `7` on the archive sheet, and asserts the working pair is archived, no `restore` happens and the trashed pair stays deleted; testEveryOtherUsageOfAKeyFollowsTheApplication asserts the stray and second usages follow. + +- **GIVEN** a working module with APPID `7` and its usage, and a module with the same import key in the trash with its own usage +- **WHEN** an export without `7` on the CMDB sheets, with `7` on "Gearchiveerde Applicaties", is imported with `archive` +- **THEN** the working module and usage SHALL be archived +- **AND** the module and the usage in the trash SHALL stay there, and nothing SHALL be restored +- **AND** a working usage that points at the module in the trash, or a second usage of the working module, SHALL be archived as well + +#### Scenario: An archive row whose APPID has no cached value never turns an archive into a deletion +@e2e exclude Covered by the service test; tests/Unit/Service/CmdbExportImportServiceTest.php testAnUncachedArchiveRowArchivesInsteadOfDeleting asserts the archive state, no delete, and the warning naming the sheet and the row; tests/Unit/Service/Cmdb/CmdbWorkbookReaderTest.php testAnUncachedArchiveKeyIsListedNotDropped asserts the reader lists the row. + +- **GIVEN** the module with APPID `7` and its usage were imported, and the workbook's archive sheet lists `7` in a formula that carries no cached value +- **WHEN** the workbook is imported with `archive` and `7` is on no CMDB sheet +- **THEN** the module and the usage of `7` SHALL be archived and SHALL NOT be deleted +- **AND** the report SHALL carry a warning naming the sheet "Gearchiveerde Applicaties" and the row + +#### Scenario: A CMDB row whose APPID has no cached value never turns an archive into a deletion +@e2e exclude Covered by the service test; tests/Unit/Service/CmdbExportImportServiceTest.php testAnUncachedCmdbRowArchivesInsteadOfDeleting asserts the archive state, no delete, and the warning naming the CMDB sheet and the row. + +- **GIVEN** the module with APPID `8` and its usage were imported, `8` is on no readable row, and a row of a CMDB sheet holds its APPID in a formula that carries no cached value +- **WHEN** the workbook is imported with `archive` and a readable archive sheet that does not list `8` +- **THEN** the module and the usage of `8` SHALL be archived and SHALL NOT be deleted +- **AND** the report SHALL carry a warning naming the CMDB sheet and the row + +#### Scenario: Keeping missing records, a cancelled import and another municipality leave everything as it is +@e2e exclude Covered by the service test; tests/Unit/Service/CmdbExportImportServiceTest.php testRecordsMissingFromTheExportStayWhenKept, testACancelledImportDoesNotReconcile and testAnotherMunicipalitysUsagesAreNeverReconciled assert no archive, no delete and no reconciliation row. + +- **GIVEN** the modules with APPID `1` and `7` and their usages for "Gemeente Voorbeeldstad", and a usage of `7` for "Gemeente Anders" +- **WHEN** an export with only `1` is imported with `missingRecords` `keep`, or with `archive` but cancelled after row 1 +- **THEN** no module or usage SHALL be archived or deleted +- **AND** when it is imported with `archive` and completes, only the usage of "Gemeente Voorbeeldstad" for `7` and the module SHALL be archived; the usage of "Gemeente Anders" SHALL be untouched + +#### Scenario: A cancel after the last row or during the reconciliation stops it +@e2e exclude Timing-dependent; tests/Unit/Service/CmdbExportImportServiceTest.php testACancelDuringTheLastRowArchivesNothing and testACancelDuringTheReconciliationStopsBeforeTheNextApplication request the cancel at those two moments and assert the transitions and the cancelled report. + +- **GIVEN** the modules with APPID `1`, `7` and `8` and their usages for "Gemeente Voorbeeldstad" +- **WHEN** an export with only `1`, and `7` and `8` on the archive sheet, is imported with `archive` and a cancel arrives while row `1` is processed +- **THEN** no module or usage SHALL be archived or deleted, and the report SHALL be cancelled +- **AND** when the cancel arrives instead while `7` is archived, `7` SHALL stay archived, `8` SHALL be left as it is, and the report SHALL be cancelled + +#### Scenario: One application that cannot be archived does not stop the others +@e2e exclude Fault injection; tests/Unit/Service/CmdbExportImportServiceTest.php testAFailingArchiveIsAFailedRowAndTheOthersAreReconciled makes the archive of one application throw and asserts a failed row naming the step, the other application archived, and the log line without a name. + +- **GIVEN** the modules with APPID `7` and `8` left the export and are on the archive sheet +- **WHEN** archiving `7` throws +- **THEN** the report SHALL list `7` as `failed` with the step `archive` and the exception class +- **AND** `8` SHALL be archived + +#### Scenario: Without the archive services an archiving import is refused before reading +@e2e exclude Environment condition; tests/Unit/Service/CmdbExportImportServiceTest.php testMissingArchiveServicesRefuseAnArchivingImport asserts 503 ARCHIVE_UNAVAILABLE with no read and no save, and that keep still imports; tests/Unit/Controller/CmdbImportControllerTest.php asserts the status and the translated message. + +- **GIVEN** an OpenRegister without `ArchiveHandler` +- **WHEN** an export is imported with `missingRecords` `archive` +- **THEN** the endpoint SHALL answer 503 with error `ARCHIVE_UNAVAILABLE` and nothing SHALL be read or written +- **AND** the same export with `keep` SHALL be imported + +### Requirement: An application that returns to the export SHALL be unarchived or restored, never duplicated (REQ-CMDB-016) + +The import SHALL match a module by its import key, and a usage by consumer and module, among archived and soft-deleted objects as well as working ones. Before it updates a matched module or usage that is archived, it SHALL unarchive it through OpenRegister's archive state; before it updates one that is soft-deleted, it SHALL restore it from the trash. It SHALL then update the row as REQ-CMDB-006 and REQ-CMDB-009 describe, and SHALL NOT create a second module or usage. The row's outcome SHALL be `restored` when a module or usage was restored, else `unarchived` when one was unarchived, else the usual outcome; the summary SHALL count both. With `updateExisting` false the row SHALL be skipped as `exists` and nothing SHALL be revived. When more than one module or usage matches, the import SHALL take a working one before an archived one, and an archived one before one in the trash, so a module deleted by hand next to the one a later import created SHALL NOT be restored. Organisations and contact persons SHALL keep matching among working objects only. + +#### Scenario: An archived application returns to the export +@e2e tests/e2e/spec-coverage/cmdb-import.spec.ts + +- **GIVEN** the module and the usage of APPID `1234` are archived and those of APPID `2` are in the trash +- **WHEN** an export that lists both on the CMDB sheets is imported +- **THEN** the report SHALL show `1234` as `unarchived` and `2` as `restored` +- **AND** there SHALL still be one module and one usage for each +- **AND** both SHALL be listed again without a lens + +#### Scenario: A returning application is not revived when existing records are not updated +@e2e exclude Covered by the service test; tests/Unit/Service/CmdbExportImportServiceTest.php testUpdateExistingFalseLeavesAnArchivedMatchArchived asserts the row is skipped as `exists`, the archive state stays and no object is created. + +- **GIVEN** the module and the usage of APPID `7` are archived +- **WHEN** a row with APPID `7` is imported with `updateExisting` false +- **THEN** the row SHALL be skipped with reason `exists` +- **AND** both SHALL stay archived, and no module or usage SHALL be created + +#### Scenario: A working match wins over a deleted one with the same import key +@e2e exclude Data condition from earlier imports; tests/Unit/Service/CmdbExportImportServiceTest.php testAWorkingMatchWinsOverADeletedOneWithTheSameKey stores a deleted module and usage ahead of the working ones and asserts the working ones are updated and nothing is restored. + +- **GIVEN** a module with APPID `7` in the trash and a working module with the same import key, each with a usage of "Gemeente Voorbeeldstad" +- **WHEN** a row with APPID `7` is imported +- **THEN** the working module and its usage SHALL be updated +- **AND** the module and the usage in the trash SHALL stay there, and nothing SHALL be restored + +### Requirement: Archived applications and usages SHALL be listable in stackiq and SHALL stay out of OpenCatalogi and Portaliq by default (REQ-CMDB-017) + +The `module` and `usage` schemas SHALL declare `x-openregister-archive` with `enabled` true through the register fragment `topdesk-cmdb-import.json`, as `module` 0.3.9 and `usage` 1.5.7, so OpenRegister offers the archive state on both. Stackiq's Applications and Applications in use pages SHALL offer a quick filter "Archived" that lists the archive alone (`_archived=true`). No change SHALL be made to OpenCatalogi or Portaliq: both list through OpenRegister's default lens, so an archived or deleted application is not in OpenCatalogi's search results or in Portaliq's "Software we use", and an OpenCatalogi caller finds archived applications with `_archived=true` on the existing routes. + +#### Scenario: The merged register offers the archive state on both schemas +@e2e exclude Configuration; tests/Unit/Settings/TopdeskCmdbFragmentTest.php testTheMergedSchemasOfferTheArchiveState asserts the versions and the annotation after merging every fragment. + +- **GIVEN** every register fragment merged in filename order +- **THEN** `module` SHALL be version 0.3.9 and `usage` 1.5.7 +- **AND** both SHALL declare `configuration.x-openregister-archive.enabled` true, and the usage lifecycle of 1.5.6 SHALL still be declared + +#### Scenario: The Applications page lists the archive on request +@e2e tests/e2e/spec-coverage/cmdb-import.spec.ts + +- **GIVEN** the module of APPID `1234` is archived +- **WHEN** an admin opens the Applications page +- **THEN** the module SHALL NOT be listed +- **AND** under the quick filter "Archived" it SHALL be listed + +## MODIFIED Requirements + +### Requirement: Records missing from a newer export SHALL be archived by default or kept on request (REQ-CMDB-012) + +The import SHALL accept `missingRecords` with the values `keep` and `archive`; `archive` is the default. With `keep` it SHALL NOT change, archive, depublish or delete a module, usage, organisation or contact person because its APPID is absent from the upload. With `archive` it SHALL reconcile as REQ-CMDB-015 describes. Any other value, including the reserved `mark` and `remove`, SHALL be refused with 422 `MISSING_RECORDS_UNSUPPORTED`, naming both accepted values in `details.accepted`. The accepted values SHALL be declared in the import profile. + +(Previously: `keep` was the only accepted value and the default; records missing from a newer export were always left untouched.) + +#### Scenario: An application dropped from the export stays when records are kept +@e2e exclude Covered by the service test; tests/Unit/Service/CmdbExportImportServiceTest.php testRecordsMissingFromTheExportStayWhenKept imports two rows, then one with `missingRecords` `keep`, and asserts the other module and usage are unchanged. + +- **GIVEN** the modules with APPID `1` and `7` were imported for "Gemeente Voorbeeldstad" +- **WHEN** a newer export that only contains APPID `1` is imported with `missingRecords` `keep` +- **THEN** the module with APPID `7` and its usage SHALL be unchanged + +#### Scenario: Without the option a missing application is reconciled +@e2e exclude Validation; tests/Unit/Controller/CmdbImportControllerTest.php testMissingRecordsDefaultsToArchive asserts the service receives `archive` when the field is absent and the sent value otherwise. + +- **GIVEN** a valid export +- **WHEN** a Nextcloud admin posts it without `missingRecords` +- **THEN** the import SHALL run with `archive` + +#### Scenario: A reserved value is refused +@e2e exclude Validation; tests/Unit/Controller/CmdbImportControllerTest.php testAReservedMissingRecordsValueIsRefused. + +- **GIVEN** a valid export +- **WHEN** a Nextcloud admin posts it with `missingRecords=remove` +- **THEN** the endpoint SHALL answer 422 with error `MISSING_RECORDS_UNSUPPORTED` and `details.accepted` `["keep", "archive"]` +- **AND** no object SHALL be written + +### Requirement: The admin settings SHALL offer a CMDB import section (REQ-CMDB-014) + +Stackiq's admin settings page SHALL show a section "CMDB import", rendered by the settings page and not registered as an in-app route. The section SHALL let the admin choose an existing municipality or type the name of a new one, choose an `.xlsx` file, choose what happens to applications missing from the export (archive, the default, or keep) with a one-sentence help text that says what each does and the details in the section's information panel, and start the import. While the import runs it SHALL show a progress bar and a Cancel button. Afterwards it SHALL show the summary, including the archived, unarchived, deleted and restored counts when they are not zero, and a report table that can be filtered by outcome, including those four; a reconciliation row SHALL show no row number. The section SHALL also show the mapping the import uses (REQ-CMDB-020), as tables: the export's sheets and columns, and per sheet pack its source, its version, a hint when a newer shipped pack was not applied, and a link "Edit in OpenRegister" when the pack has an `editUrl`; the municipality pack, which maps the import options and no column, SHALL NOT be listed. When the endpoint answers 503 for a stored pack, the error SHALL carry the same link from `details.editUrl`. The section SHALL offer no editing of the mapping itself. The sheet names in its help text SHALL come from that mapping, every sheet it names and in its order, whatever their number, and so SHALL the archive sheet its texts name, with no archive sheet when the profile names none; the shipped names are the fallback until the mapping has loaded or when it cannot be loaded. Every control SHALL have a visible label, and every string SHALL be translatable. + +(Previously: the section had no mapping block, and the sheet names in its help text were a constant in the page, which could drift from the profile on the server. This block also carries the missing-applications choice, the four counts and the reconciliation rows of cmdb-import-archive-reconciliation, which modifies REQ-CMDB-014 too (before it, the request always sent `keep`); both changes carry this same block, so archiving them in either order leaves the whole requirement.) + +#### Scenario: The admin runs an import from the settings page +@e2e tests/e2e/spec-coverage/cmdb-import.spec.ts + +- **GIVEN** a Nextcloud admin on stackiq's admin settings page +- **WHEN** they choose "Gemeente Voorbeeldstad", choose the anonymised export and press "Import" +- **THEN** a progress bar SHALL appear while the import runs +- **AND** afterwards the summary and the report table SHALL be shown +- **AND** filtering the table on `created` SHALL show the two imported rows + +#### Scenario: The admin chooses to keep missing applications +@e2e tests/e2e/spec-coverage/cmdb-import.spec.ts + +- **GIVEN** the section +- **WHEN** the admin selects "Keep them as they are" and starts the import +- **THEN** the request SHALL carry `missingRecords=keep` +- **AND** without a choice it SHALL carry `missingRecords=archive` + +#### Scenario: The sheet names in the help come from the server +@e2e tests/e2e/spec-coverage/cmdb-import-mapping.spec.ts + +- **GIVEN** a Nextcloud admin on stackiq's admin settings page +- **WHEN** the mapping endpoint has answered +- **THEN** the help text under the file control SHALL name the sheets the endpoint returned +- **AND** a profile with one, two or three sheets SHALL give a help text and an info text that name exactly those sheets, with no sheet the profile does not name and no description tied to a sheet's position +- **AND** when the endpoint fails, it SHALL name the shipped sheets and the mapping block SHALL show the error + +#### Scenario: The archive sheet in the help comes from the server +@e2e exclude Not driven in e2e yet: the texts are derived in the page from the endpoint's answer, and src/views/settings/sections/CmdbImport.spec.js emits mappings with the archive sheet "Archief" and with none and asserts the info text, the missing-applications paragraph and the too-large hint; the route intercept in tests/e2e/spec-coverage/cmdb-import-mapping.spec.ts could drive it as well. + +- **GIVEN** the mapping endpoint answers `profile.archiveSheet` `Archief` +- **WHEN** the section renders its information panel and a too-large error +- **THEN** the info text, the paragraph on applications missing from the export and the hint SHALL name the sheet `Archief` +- **AND** when it answers `null`, none of them SHALL name an archive sheet, and the paragraph SHALL say that the import only archives + +#### Scenario: The section lists the mapping and links each pack to its editor +@e2e tests/e2e/spec-coverage/cmdb-import-mapping.spec.ts + +- **GIVEN** a Nextcloud admin on stackiq's admin settings page +- **WHEN** the mapping block of the "CMDB import" section has loaded +- **THEN** a table of the export SHALL list the sheets read and the match, name, required and date columns, and a table of the packs SHALL show each of the four sheet packs with its source and version and a link "Edit in OpenRegister" to its `editUrl` +- **AND** the municipality pack, which maps the import options and no column, SHALL NOT be listed +- **AND** when the endpoint answers 503 for a stored pack, the error SHALL show a link "Edit in OpenRegister" to its `details.editUrl` +- **AND** the block SHALL hold no input field + +#### Scenario: An edited pack whose newer shipped version was not applied says so +@e2e exclude Needs a stackiq release that ships a newer pack than the one installed; tests/vitest/cmdbImportMapping.spec.js mounts the block with an edited usage pack whose `newerShipped` is true and asserts the hint, and its absence for the unedited module pack. + +- **GIVEN** the mapping endpoint answers an edited usage pack with `newerShipped` `true` and `shippedVersion` `1.1.0` +- **WHEN** the mapping block renders +- **THEN** the usage row SHALL say that stackiq ships version `1.1.0`, that it was not applied because the pack was edited, and how to use the shipped version +- **AND** a row whose `newerShipped` is `false` SHALL show no such hint + +## Non-Functional Requirements + +- **Performance:** the reconciliation SHALL page the municipality's usages with the import's page size and load their modules in one search per page, so an export of 1,100 rows adds a handful of searches, and SHALL make no write for an application that is already in the state the export asks for. +- **Security:** unchanged from the first change; the archive sheet is read under the same bounds, APPID column only; the scope is the imported municipality's usages; nothing is hard-deleted; every state change is an OpenRegister audit entry. +- **Privacy:** reconciliation rows and log lines carry APPIDs, module names and uuids only; contact persons are never touched. +- **Accessibility:** Target WCAG 2.2 AA. The new choice is a labelled radio group (SC 1.3.1, 3.3.2; gates `form-label-association`, `nc-input-labels`) with help text; the summary tiles and the outcome filter follow the existing pattern. New in 2.2: 2.4.11, 2.5.8 and 3.3.7 apply as before; 2.5.7, 3.2.6 and 3.3.8 do not apply (no dragging, no help mechanism, no authentication). +- **Internationalization:** Dutch and English MUST be supported (ADR-005) for the choice, the outcomes, the warning and the error message. + +## Acceptance Criteria + +- [ ] A re-import with the archive sheet archives the application that moved there and soft-deletes the one on no sheet; the report shows `archived` and `deleted`. +- [ ] Importing the original export again unarchives and restores them; no duplicate is created. +- [ ] With "Keep them as they are" nothing is archived or deleted. +- [ ] The Applications and Applications in use pages list archived records only under "Archived". +- [ ] OpenCatalogi's search and Portaliq's "Software we use" no longer show an archived application; `_archived=true` on OpenCatalogi's route finds it. + +## Notes + +- The decision table per application is in the change's [design.md](../../design.md), D5. +- The library does not render `@self.archived` on detail pages yet; a follow-up for `@conduction/nextcloud-vue`. +- REQ-CMDB-014 is modified by this change and by cmdb-import-mapping-view; both carry the same block, which holds what each adds, so archiving them in either order leaves the whole requirement. A change to that block goes into both. diff --git a/openspec/changes/cmdb-import-archive-reconciliation/tasks.md b/openspec/changes/cmdb-import-archive-reconciliation/tasks.md new file mode 100644 index 000000000..cf59a6d3d --- /dev/null +++ b/openspec/changes/cmdb-import-archive-reconciliation/tasks.md @@ -0,0 +1,94 @@ +# Tasks: cmdb-import-archive-reconciliation + +Spec: `openspec/changes/cmdb-import-archive-reconciliation/specs/cmdb-export-import/spec.md` (`SPEC` below). Design: `design.md` (the decision table in D5 is authoritative for what happens per application). + +## Implementation Tasks + +Status in this PR (the reconciliation slice, on top of the reader slice): Tasks 1-5 are implemented in #1286 (the reader's tasks 1-2 come from the base PR). Task 6 (the UI) is implemented in #1287; task 7 has its fixture, docs and e2e spec written there, and the Playwright run is the one thing not done yet. + +### Task 1: Schema opt-in and the import profile +- **spec_ref**: `SPEC#requirement-archived-applications-and-usages-shall-be-listable-in-stackiq-and-shall-stay-out-of-opencatalogi-and-portaliq-by-default-req-cmdb-017`, `SPEC#requirement-records-missing-from-a-newer-export-shall-be-archived-by-default-or-kept-on-request-req-cmdb-012` +- **files**: `lib/Settings/register.d/topdesk-cmdb-import.json`, `lib/Settings/cmdb-import/topdesk-profile.json`, `lib/Service/Cmdb/CmdbImportProfile.php`, `tests/Unit/Settings/TopdeskCmdbFragmentTest.php`, `tests/Unit/Settings/PublicationFieldRulesTest.php`, `tests/Unit/Service/Cmdb/CmdbImportProfileTest.php` +- **acceptance_criteria**: + - GIVEN every register fragment merged in filename order THEN `module` is 0.3.9 and `usage` is 1.5.7, both with `configuration.x-openregister-archive.enabled` true, and the usage lifecycle of 1.5.6 is still there + - GIVEN the profile THEN `archiveSheetName()` is "Gearchiveerde Applicaties", `readSheetNames()` lists the two CMDB sheets plus the archive sheet, and `missingRecordsModes()` is `["keep", "archive"]` without OpenRegister +- [x] Implement +- [x] Test + +### Task 2: The reader reads the archive sheet's APPIDs +- **spec_ref**: `SPEC#requirement-an-application-missing-from-the-cmdb-sheets-shall-be-archived-when-the-archive-sheet-lists-it-and-soft-deleted-when-no-sheet-does-req-cmdb-015` +- **files**: `lib/Service/Cmdb/CmdbWorkbookReader.php`, `tests/Unit/Service/Cmdb/CmdbWorkbookReaderTest.php` +- **acceptance_criteria**: + - GIVEN the anonymised fixture THEN `read()` returns `archive.present` true and `archive.appIds` `["1198"]`, and the rows of the CMDB sheets are unchanged + - GIVEN a workbook without the sheet, or with the sheet but without an APPID column THEN `archive.present` is false (and `keyColumnMissing` says which), and the CMDB rows are still read + - GIVEN an archive sheet whose APPID cell is a formula without a cached value THEN `archive.uncachedRows` lists its row and `appIds` does not, so the service can refuse to soft-delete (task 4) + - GIVEN an archive sheet beyond the row limit THEN `TOO_MANY_ROWS` names it; only its APPID column is materialised +- [x] Implement +- [x] Test + +### Task 3: Matching revives archived and deleted applications +- **spec_ref**: `SPEC#requirement-an-application-that-returns-to-the-export-shall-be-unarchived-or-restored-never-duplicated-req-cmdb-016` +- **files**: `lib/Service/CmdbExportImportService.php`, `lib/Service/Cmdb/CmdbImportReport.php`, `tests/Unit/Service/CmdbExportImportServiceTest.php`, `tests/Unit/Service/Cmdb/CmdbImportReportTest.php` +- **acceptance_criteria**: + - GIVEN an archived module and usage for an APPID WHEN a row with that APPID is imported THEN both are unarchived before the update, no second module or usage exists, and the row's outcome is `unarchived` + - GIVEN a soft-deleted module and usage WHEN the row returns THEN both are restored from the trash and the outcome is `restored` + - GIVEN only the usage archived or soft-deleted THEN the usage alone is unarchived or restored, with that outcome, and no second usage exists + - GIVEN a module and usage soft-deleted while archived THEN both are restored and unarchived, the outcome is `restored`, and the update starts from the restored object (design D9) + - GIVEN OpenRegister's search results (no archive marker; no soft-deleted row, `_includeDeleted` or not) THEN the state comes from the lens that found the object and from the trash listing, read once per import (design D9) + - GIVEN `updateExisting` false THEN the row is skipped as `exists` and nothing is revived + - GIVEN a deleted and a working module (and usage) sharing one import key THEN the working one is updated and nothing is restored +- [x] Implement +- [x] Test + +### Task 4: Reconciliation after the rows +- **spec_ref**: `SPEC#requirement-an-application-missing-from-the-cmdb-sheets-shall-be-archived-when-the-archive-sheet-lists-it-and-soft-deleted-when-no-sheet-does-req-cmdb-015` +- **files**: `lib/Service/CmdbExportImportService.php`, `lib/Service/ProgressTracker.php`, `lib/Exception/CmdbImportException.php`, `tests/Unit/Service/CmdbExportImportServiceTest.php` +- **acceptance_criteria**: + - GIVEN APPIDs 1 and 7 imported WHEN an export with row 1 and 7 on the archive sheet is imported THEN module and usage of 7 are archived with a reason, the report row is `archived`, and the owner contact person is untouched + - GIVEN APPID 7 on no sheet THEN module and usage are soft-deleted and the row is `deleted`; GIVEN the archive sheet absent, without an APPID column, or with an APPID that has no cached value, or a CMDB-sheet row whose APPID has no cached value THEN they are archived instead and the report warns + - GIVEN APPID 7 soft-deleted and listed on the archive sheet THEN module and usage are restored and archived; GIVEN it already archived or, when on no sheet, already deleted THEN nothing is written + - GIVEN a working pair and a trashed pair under the same import key and the key on the archive sheet THEN the working pair is archived, nothing is restored and the trashed pair stays deleted; GIVEN a further working usage of the key (of the trashed module, or a second one of the working module) THEN it is archived or deleted with the application + - GIVEN `missingRecords` `keep`, a cancelled import, or a usage of another municipality THEN nothing is archived or deleted + - GIVEN a cancel during the last row THEN nothing is archived or deleted; GIVEN a cancel during the reconciliation THEN it stops before the next application and the report is cancelled + - GIVEN the archive of one application throws THEN that application is a `failed` row and the others are reconciled; GIVEN no ArchiveHandler THEN 503 `ARCHIVE_UNAVAILABLE` before reading + - GIVEN the step runs THEN the operation is in phase `reconciling` and its progress advances per application +- [x] Implement +- [x] Test + +### Task 5: Controller option +- **spec_ref**: `SPEC#requirement-records-missing-from-a-newer-export-shall-be-archived-by-default-or-kept-on-request-req-cmdb-012` +- **files**: `lib/Controller/CmdbImportController.php`, `tests/Unit/Controller/CmdbImportControllerTest.php`, `openapi.json`, `postman/stackiq-tests.json`, `l10n/en.json`, `l10n/nl.json` +- **acceptance_criteria**: + - GIVEN no `missingRecords` THEN the service receives `archive`; GIVEN `keep` or `archive` THEN it is passed through; GIVEN `remove` or `mark` THEN 422 `MISSING_RECORDS_UNSUPPORTED` with `details.accepted` `["keep", "archive"]` and no import + - GIVEN `ARCHIVE_UNAVAILABLE` from the service THEN 503 with its own translated message +- [x] Implement +- [x] Test + +### Task 6: Settings section, report words and the archive quick filter +- **spec_ref**: `SPEC#requirement-the-admin-settings-shall-offer-a-cmdb-import-section-req-cmdb-014`, `SPEC#requirement-archived-applications-and-usages-shall-be-listable-in-stackiq-and-shall-stay-out-of-opencatalogi-and-portaliq-by-default-req-cmdb-017` +- **files**: `src/views/settings/sections/CmdbImport.vue`, `src/utils/cmdbImport.js`, `src/utils/cmdbImport.spec.js`, `src/views/settings/sections/CmdbImport.spec.js`, `tests/vitest/cmdbArchiveQuickFilter.spec.js`, `src/manifest.json`, `src/manifest.d/usages.json`, `src/icons.js`, `l10n/en.json`, `l10n/nl.json` +- **acceptance_criteria**: + - GIVEN the section THEN a labelled choice "Applications missing from the export" offers Archive (default) and Keep with help text, and `buildImportForm()` sends the choice as `missingRecords` + - GIVEN a report with the new outcomes THEN the summary shows their tiles, the outcome filter offers them, and a reconciliation row shows no row number + - GIVEN the Applications and Applications in use pages THEN a quick filter "Archived" sends `_archived=true` + - GIVEN the Applications page with the "Archived" tab active THEN a note under the toolbar says the tab ignores the GEMMA filters, and it is gone on any other tab + - Every new string is in `l10n/en.json` and `l10n/nl.json`, and the generated `l10n/*.js` are current +- [x] Implement +- [x] Test + +### Task 7: Fixture, docs and e2e +- **spec_ref**: `SPEC#requirement-an-application-missing-from-the-cmdb-sheets-shall-be-archived-when-the-archive-sheet-lists-it-and-soft-deleted-when-no-sheet-does-req-cmdb-015` +- **files**: `tests/fixtures/cmdb/build-fixtures.py`, `tests/fixtures/cmdb/topdesk-archived-applications.xlsx`, `tests/fixtures/cmdb/README.md`, `tests/Unit/Fixtures/CmdbFixtureHygieneTest.php`, `tests/Unit/Service/Cmdb/CmdbWorkbookReaderTest.php`, `tests/Unit/Service/CmdbExportImportServiceTest.php`, `tests/e2e/spec-coverage/cmdb-import.spec.ts`, `docs/features/cmdb-import.md`, `docs/features/README.md`, `CHANGELOG.md` +- **acceptance_criteria**: + - GIVEN `build-fixtures.py` THEN it derives `topdesk-archived-applications.xlsx`: APPID 1234 on the archive sheet only, APPID 2 on no sheet, both CMDB sheets present and empty; the hygiene test passes on it + - GIVEN the e2e THEN after the first import, importing the variant archives 1234 and soft-deletes 2, the Applications page lists 1234 under "Archived", and importing the original again reports 1234 `unarchived` and 2 `restored` with the object counts back to the first import's + - GIVEN the docs THEN "Repeat imports" describes archive, soft delete, the archive sheet, the option and the return of an application, and the error table has `ARCHIVE_UNAVAILABLE` and the new meaning of `MISSING_RECORDS_UNSUPPORTED` +- [x] Implement +- [ ] Test + - Status: PHPUnit covers the fixture round trip (testTheArchivedApplicationsFixtureArchivesDeletesAndBringsBack); the Playwright test is written and not run yet, because no Nextcloud was reachable from the worktree. + +## Quality checklist + +- PHPUnit for every new rule in the service, the reader and the controller; the fixture hygiene test covers the new variant +- Jest for the section's request and the report words; Playwright for the re-import with the archive sheet +- `composer test:unit`, `composer phpcs`, `composer lint`, `npm run test:unit`, `npm run lint`, `npm run format`, `npm run test:l10n`, `npm run check:l10n-js`, `npm run check:manifest`, `npm run check:schema-l10n` and `npm run check:vue-demi` pass diff --git a/openspec/changes/cmdb-import-mapping-view/.openspec.yaml b/openspec/changes/cmdb-import-mapping-view/.openspec.yaml new file mode 100644 index 000000000..5c0f6674b --- /dev/null +++ b/openspec/changes/cmdb-import-mapping-view/.openspec.yaml @@ -0,0 +1,2 @@ +schema: conduction +created: 2026-10-09 diff --git a/openspec/changes/cmdb-import-mapping-view/design.md b/openspec/changes/cmdb-import-mapping-view/design.md new file mode 100644 index 000000000..f5cab267f --- /dev/null +++ b/openspec/changes/cmdb-import-mapping-view/design.md @@ -0,0 +1,167 @@ +# Design: cmdb-import-mapping-view + +## Context + +The CMDB import (archived change `2026-10-05-cmdb-export-import`) maps a TOPdesk export through `lib/Settings/cmdb-import/topdesk-profile.json` and five migration packs, loaded and validated by `CmdbImportProfile` and executed by OpenRegister's `MappingEngine`. The packs are OpenRegister migration-pack documents (`fieldMappings` with `trim`, `date`, `lookup`, `concat` transforms, `defaults`, `idStrategy`). OpenRegister already stores such documents in `openregister_migration_packs` through `MigrationPackService`, with CRUD at `/api/migration-packs` for admins. On 2026-10-12 it was decided that the mapping lives in OpenRegister: the administrator edits the packs there, and the import runs what is stored. + +## Goals / Non-Goals + +**Goals** + +- The import runs the pack the administrator saved in OpenRegister, unchanged. +- An edit is never lost: not overwritten by an update, never silently replaced by the shipped file. +- An edit cannot make the import write what it must not write. +- The mapping endpoint tells where each pack comes from and links to its editor; the settings section that shows it is part of #1289. + +**Non-Goals** + +- The editor screens (OpenRegister's change). +- Editing the municipality pack or the import profile. +- A mapping per municipality. + +## Architecture Overview + +``` +Install / upgrade Import or GET /api/settings/cmdb-import/mapping + SeedCmdbImportPacks (repair) CmdbImportProfile::load() + │ │ for module, manufacturer, usage, businessOwner + ▼ ▼ + CmdbImportPackStore::resolve(shipped) ◄────────┘ municipality: shipped file only + │ findByPackSlug → absent: create(builtin, + x-stackiq) + │ unedited + outdated: update(shipped + x-stackiq) + │ edited: keep (newerShipped) + ▼ + OpenRegister MigrationPackService ── openregister_migration_packs + │ + CmdbImportPackRules (required mappings, writable fields) + PackDefinitionValidator + │ + MappingEngine::mapRow() (import) SettingsController: + editUrl (IURLGenerator) +``` + +## Decisions + +### D1. The endpoint lives in `SettingsController` and reuses `CmdbImportProfile` + +The route sits with the other `/api/settings/*` reads, and `SettingsController` gets `CmdbImportProfile`, `IL10N` and `IURLGenerator` as optional, trailing constructor arguments, so the existing tests that build the controller positionally keep working and Nextcloud's container injects them. The method loads through `CmdbImportProfile::load()`, the loader the import uses, so the view can never show a mapping the import would refuse. + +### D2. Admin-only, CSRF, the import's error envelope + +The method carries no auth attribute (Nextcloud's default: admins with a CSRF token), with `@auth admin-only` and its reason, as `CmdbImportController` does. Success is the flat `{profile, packs, openRegisterPacks}` (ADR-050). Failure is the import's envelope `{success: false, error, message, details}`; `details.reason` carries the loader's message cut to its first line and 500 characters, and a pack stored in OpenRegister is also named in `details.pack` and `details.packId`. The import's own 503 names the pack in its `message` from the same details; the full reason goes to the Nextcloud log. The reason names the file or the pack, the broken rule and the configuration value it refused, never a workbook cell or a person. + +### D3. The transform and the write rules are shown as stored + +`fieldMappings[].transform` is passed through as the pack stores it. The write rules the import applies besides the mapping are answered per pack (`defaults`, `createOnlyDefaults`, `createOnlyFields`, `neverWritten`), built from the accessors the import uses. A create-only default that is not a mapped field, such as the module `type`, is answered in `createOnlyDefaults` only: `merge()` never reads it on update, so `createOnlyFields` leaves it out. A mapped field with a create default stays in `createOnlyFields`. + +### D4. The section takes the sheet names from the endpoint, with the constant as fallback + +Unchanged from the first version: the help text computes the sheet names from the endpoint's answer, or from `PROFILE_DEFAULTS.sheets` until it arrives or when it fails. The help text, the info text and the missing-sheet and too-large hints name every sheet the profile lists, whatever their number: they are built from the list (`quotedSheetList`), not from its first two entries, and say nothing that depends on a sheet's position. The archive sheet those texts name comes from the endpoint's `profile.archiveSheet` the same way, with `PROFILE_DEFAULTS.archiveSheet` as the fallback; when the profile names none, the texts leave it out and the information panel says the import only archives. + +### D5. The packs live in OpenRegister's migration-pack store, found by slug + +The four sheet packs are stored as OpenRegister migration packs and found by their slug (`stackiq-topdesk-module`, …). That is the format the packs already have and the engine the import already calls, so what the administrator edits is exactly what runs, with OpenRegister's validator on save (422) and on import (503). + +- **Alternative: OpenRegister's Twig mapping entity (`/api/mappings`).** Rejected: lookups, `required` and dates would become Twig templates, validation would no longer be structural, and errors would lose their row and column; the import engine would have to be rewritten. +- **Alternative: packs as register objects, like Integriq's mappings.** Rejected: a third mapping store next to the one OpenRegister already has, with the validator duplicated in a listener. + +The municipality pack maps the import options (`municipalityName`), not a sheet, so it stays a shipped file and is answered with `editable: false`. The import profile stays a shipped file: its limits guard memory and zip bombs, and its sheets, key column and write rules are stackiq semantics. + +OpenRegister's pack store has no organisation column: an instance has one TOPdesk mapping, used for every municipality it imports. + +### D6. Seeding, and following the release only while unedited + +A stored pack carries `x-stackiq: {shippedVersion, shippedHash}`: the version of the shipped pack it was seeded from and the sha256 of that pack's canonical JSON (keys of every object sorted recursively, list order kept, because the order of `fieldMappings` decides which mapping wins a target). OpenRegister's validator ignores keys it does not know, so the marker travels with the definition. A stored definition that, without the marker, still hashes to `shippedHash` is unedited. + +`CmdbImportPackStore::resolve()` is the one place that writes: it creates a missing pack as built-in with the marker (never through OpenRegister's import, which upserts and would overwrite an edit), replaces an unedited pack whose marker hash differs from the current shipped pack, and leaves an edited pack alone, reporting `newerShipped`. A pack OpenRegister reports no last-saved time for is left alone too: the update's guard against an edit saved in between needs that time. `find()`, which the mapping view uses and which writes nothing, answers an unedited outdated pack as the next import will run it: the shipped pack and version with `updatePending: true`. A pack without a marker (created by hand under the same slug) counts as edited with `edited: null`, and is never replaced. The repair step `SeedCmdbImportPacks` runs it on install and upgrade, after `InitializeSettings`; the import's `CmdbImportProfile::load()` runs it too, so a pack deleted in OpenRegister is seeded again on the next import, and an instance whose OpenRegister gained the store after stackiq's upgrade is seeded by its next import. Viewing the mapping uses `loadForView()`, which calls `CmdbImportPackStore::find()`: it only reads, and a pack the store does not hold yet is shown from its shipped file. The update of an unedited pack passes the read pack's `updatedAt`, so OpenRegister refuses it (`PackChangedException`) when an administrator saved the pack in between; the store then keeps that edit. `CmdbImportPackStoreProbe` decides whether the store may be used at all: the slug-lock class exists and no write method of OpenRegister's pack controller carries an attribute or annotation that skips the CSRF check or admits non-admins. + +Version numbers alone cannot tell an edit from a release: OpenRegister's editor bumps the version on save, independently of stackiq's releases. The hash can. + +- **Alternative: seed only when missing, never update.** Rejected: an unedited pack would never get a fix that a release ships. +- **Alternative: always overwrite on upgrade.** Rejected: it destroys the administrator's edits. + +### D7. Fail closed once the packs were stored + +The store counts as available only on an OpenRegister whose pack writes require a CSRF token and lock a built-in pack's slug, recognised by the class `OCA\OpenRegister\Exception\BuiltinPackSlugLockedException` that ships with them. Released OpenRegister versions have `MigrationPackService` but write packs without a CSRF check; since a pack drives writes with RBAC off, stackiq does not run packs stored behind those routes and treats such a store as not available. + +The store keeps the row id it resolved per slug in stackiq's app config (`cmdb_import_pack_ids`). Without OpenRegister's store and with no recorded ids, the import uses the shipped files and adds one import warning saying so. With recorded ids, a missing store is 503 `MAPPING_UNAVAILABLE` naming the packs: falling back would silently drop an edit. A slug lookup that misses while the recorded row still exists under another slug is a rename, and is 503 naming the row and both slugs, not a second seeded pack the import would read while the administrator edits the renamed one. A recorded row that was deleted is seeded again. Any other failure of the store is 503 naming the pack and the exception class, never its message. + +### D8. The import's rules on every pack + +OpenRegister's validator checks structure only, and the import writes with OpenRegister's RBAC and multitenancy off. `CmdbImportPackRules` therefore checks every pack, stored or shipped: + +- required mappings with `required: true`: module `name` and `externalNumber` (from the profile's key column), manufacturer, municipality and business-owner `name`; +- the writable fields of a target are the properties of its schema in the register stackiq ships (fragments included, ADR-037), read from that file, so a property added to the schema can be mapped without a code change; the business owner may map `name` and `role` only, because it is resolved in Nextcloud Contacts and has no schema; +- refused whatever the schema says: `@self`, `id`, the match keys and the relations the import sets (`externalKey`, `provider`, `consumer`, `module`, `businessOwner`, the organisation `type`), the profile's `neverWritten`, every property whose definition or items carry a `$ref`, an `inversedBy`, a `writeBack`, `format: uuid` or an object configuration that relates or names a schema, every property of `type: file`, `publicationDate` and `depublicationDate` on every target, and the admin fields `registeredBy`, `registrationStatus`, `mergedInto`, `contactsUid`, `pki`, `xml`, the organisation `status` and the module `type`; +- the same rules for `defaults`, and the organisation defaults pinned as shipped: `type` (`Supplier`, `Municipality`), because the import finds organisations by name and type, and `status` `Active` and the manufacturer's `registeredBy` `Supplier`, the only way a pack sets those admin fields. + +A broken rule is 503 `MAPPING_UNAVAILABLE` naming the pack, its id and every rule it breaks. + +### D9. What a pack controls besides its mappings + +Only the profile's date columns used to be converted from Excel serial numbers, so a date transform on a new column would have received `45111`. The date columns are now the profile's plus every column a pack maps with a `date` transform. The cleanup of empty parts in the usage note splits on the separator of the concat mapping that writes `interneAnnotation`, not on a constant. `idColumns`, `emptyValues` and the sheet constants (`Beheer`) stay profile semantics. + +### D10. The editor link is built by Nextcloud + +`editUrl` is `IURLGenerator::linkToRouteAbsolute('openregister.dashboard.catchAll', ['path' => 'migration-packs/'])`, so an instance that needs `/index.php` gets it. Nextcloud's router answers an unknown route with an empty path; a link that does not end in the pack path is answered as null rather than as the instance's front page. + +## Declarative-vs-imperative decision (ADR-031) + +- **The mapping stays declarative:** OpenRegister migration packs, executed by `MappingEngine`; an edit changes the import without PHP. +- **Imperative, because they guard the import:** the pack resolution, the seed and update policy and the import's rules. They are configuration management and security checks on writes with RBAC off, not object lifecycle, aggregation, notification or relation logic, and no `x-openregister-*` vocabulary covers them. + +## Seed Data + +No schema changes and no register fragment. The repair step stores four migration packs in OpenRegister (`stackiq-topdesk-module`, `stackiq-topdesk-manufacturer`, `stackiq-topdesk-usage`, `stackiq-topdesk-business-owner`) from the shipped files, each with the `x-stackiq` marker. + +## Nextcloud Integration + +- Controller: `SettingsController::getCmdbImportMapping()`; route `settings#getCmdbImportMapping`, `GET /api/settings/cmdb-import/mapping`. +- Services: `CmdbImportProfile`, `CmdbImportPackStore`, `CmdbImportPackMarker`, `CmdbImportPackRules`. +- Repair step: `SeedCmdbImportPacks`, in `` and ``. +- OCP: `OCP\IL10N`, `OCP\IURLGenerator`, `OCP\IAppConfig`, `OCP\Migration\IRepairStep`, `OCP\AppFramework\Db\DoesNotExistException`. +- OpenRegister: `Service\MigrationPackService`, `Service\MigrationPack\PackDefinitionValidator`, `Service\MigrationPack\MappingEngine`, resolved defensively; the page route `dashboard#catchAll`. + +## Security Considerations + +- Admin-only with CSRF (D2). OpenRegister's pack writes are admin-only with CSRF too; stackiq uses only a store that has those guards (D7). +- The import's rules (D8) let an edited pack write only plain properties of its target schema: never object metadata, match keys, relations, publication dates or admin fields. +- An edit can add a column to what the import reads: the read allowlist is every column the profile or a pack names. Only Nextcloud admins can edit packs and run the import. +- Fail closed (D7): no silent fallback that would drop an administrator's edit. +- Messages name packs, rules and configuration values, never a workbook cell or a person; a store failure is named by its exception class. + +## NL Design System + +Nextcloud and `@conduction/nextcloud-vue` components only (ADR-012), as in the first version of the block. + +## File Structure + +``` +appinfo/info.xml (+ SeedCmdbImportPacks in install and post-migration) +lib/Repair/SeedCmdbImportPacks.php (new) +lib/Service/Cmdb/CmdbImportPackStore.php (new) +lib/Service/Cmdb/CmdbImportPackMarker.php (new) +lib/Service/Cmdb/CmdbImportPackRules.php (new) +lib/Service/Cmdb/CmdbImportProfile.php (resolution, sources, dateColumns, concatSeparator, overview) +lib/Service/CmdbExportImportService.php (fallback warning, separator) +lib/Controller/SettingsController.php (editUrl, details) +lib/Controller/CmdbImportController.php (MAPPING_UNAVAILABLE names the pack) +src/… (the section's mapping block) +tests/Unit/Service/Cmdb/CmdbImportPackStoreTest.php, CmdbImportPackRulesTest.php, CmdbImportProfileTest.php +tests/Unit/Repair/SeedCmdbImportPacksTest.php +tests/Unit/Support/FakeMigrationPackService.php +tests/Unit/Controller/SettingsControllerCmdbImportMappingTest.php, CmdbImportControllerTest.php +tests/Unit/Service/CmdbExportImportServiceTest.php +tests/e2e/spec-coverage/cmdb-import-packs.spec.ts (new) +docs/features/cmdb-import.md +l10n/en.json, en.js, nl.json, nl.js +``` + +## Testing + +- PHPUnit against an in-memory `MigrationPackService`: seeding with the marker, an unedited pack following a newer release, an edited pack kept with `newerShipped`, an unedited pack with no `updatedAt` kept, the view answering the shipped pack with `updatePending`, a pack without marker never replaced, a renamed pack and a failing store failing closed, a deleted pack seeded again, a seed that loses a race to another request, an OpenRegister without the hardened store, the canonical hash. +- PHPUnit on the rules: the shipped packs pass, any plain schema field can be mapped, files are refused, relations, fields the register hides or calculates, publication dates and admin fields are refused as mappings and as defaults, a plain field the register turns into a relation is refused. +- PHPUnit on the loader: a stored pack is what runs, an invalid stored pack and thirteen broken rules are 503 naming the pack and id, no store before a seed uses the files, no store after a seed fails closed, a stored date column is converted, the concat separator is the pack's, also with a later plain mapping of the note. +- PHPUnit on the import: an edit in OpenRegister changes the mapped usage, the separator and a new date column; without a store the report carries the fallback warning. +- PHPUnit on the endpoint and the repair step: the extended answer, `editUrl` from the page route and null when it cannot be built, 503 naming the pack with the link to its editor; seeding four packs, updating and keeping, no store, a failing store, the registration order. +- Playwright, through the API (`cmdb-import-packs.spec.ts`): the four packs stored as built-in packs with the marker, the mapping with source, `packId` and `editUrl`, a broken stored pack refused by the mapping and by the import, a module pack without its required name refused, an edit in OpenRegister run by the import, a deleted pack seeded again, the 403 for a non-admin. Each test that edits a pack puts back the definition it read. +- Playwright, on the settings page (Task 7, with the section in Task 4, both in #1289): the section shows the source and the editor link per pack. +- Install, upgrade and a missing or older store are not driven in e2e: they need another OpenRegister or a reinstall. The requirements state them, and the PHPUnit tests above prove them. diff --git a/openspec/changes/cmdb-import-mapping-view/proposal.md b/openspec/changes/cmdb-import-mapping-view/proposal.md new file mode 100644 index 000000000..ff4576dc9 --- /dev/null +++ b/openspec/changes/cmdb-import-mapping-view/proposal.md @@ -0,0 +1,92 @@ +--- +kind: code +depends_on: [] +--- + +# Proposal: cmdb-import-mapping-view + +## Summary + +A Nextcloud administrator can view and edit the column mapping of the CMDB import in OpenRegister. The four sheet packs of the import (module, manufacturer, usage and business owner) move into OpenRegister's existing migration-pack store, where OpenRegister's pack editor shows and changes them. The import reads each pack from that store first and runs exactly what the administrator saved. The packs that ship under `lib/Settings/cmdb-import/` become the seed and the fallback: a repair step stores them in OpenRegister as built-in packs, and replaces a stored pack nobody edited when a later release ships a newer one. An edited pack is never overwritten. A stored pack that is invalid, or that breaks a rule of the import, stops the import with 503 `MAPPING_UNAVAILABLE` naming the pack; it never falls back to the files silently. `GET /api/settings/cmdb-import/mapping` says per pack where it comes from, which versions are stored and shipped, whether it was edited, and links to its editor in OpenRegister. Showing that per pack in the "CMDB import" section of stackiq's admin settings is the frontend part (#1289). + +## Motivation + +The municipality's application manager (Jira WOO-588, sub-task of WOO-586) must be able to see and change which TOPdesk column lands in which stackiq field, and which export values the import recognises, without editing JSON on the server. The first version of this change (2026-10-09) only showed the mapping read-only and left editing in the files, which an app update overwrites. On 2026-10-12 it was decided that mapping lives in OpenRegister: the packs are already OpenRegister migration packs, executed by OpenRegister's `MappingEngine` and validated by its `PackDefinitionValidator`, and OpenRegister already stores and serves such packs (`/api/migration-packs`). Storing the import's packs there makes the edited object exactly the object the import runs, and gives the administrator one place for mappings. Integriq is not changed; its mapping screens are the pattern for OpenRegister's editor. + +## Capabilities + +### New Capabilities + +None. + +### Modified Capabilities + +- `cmdb-export-import`: ADDED REQ-CMDB-020 (the mapping endpoint, now with source, versions and the editor link; the section that shows it is #1289), REQ-CMDB-021 (the import takes the sheet packs from OpenRegister's store, with the import's rules and fail-closed answers) and REQ-CMDB-022 (seeding and updating the packs in OpenRegister); MODIFIED REQ-CMDB-005 (where the packs come from, the date columns a pack adds, the pack's own concat separator). + +## Affected Projects + +- [ ] Project: `stackiq`: the pack resolution and rules in `lib/Service/Cmdb/`, a repair step, the extended endpoint, the slimmed mapping block in the "CMDB import" section (#1289), documentation, translations, tests. +- [ ] Project: `openregister` (separate change and PR): the migration-pack list and editor pages that the `editUrl` opens, the envelope body on `PUT /api/migration-packs/{id}`, and a builtin pack keeping its slug. + +## Scope + +### In Scope + +- Reading the module, manufacturer, usage and business-owner packs from OpenRegister's migration-pack store by slug, with the shipped file as the seed and, while nothing was ever stored, as the fallback with one import warning. +- The import's own rules on every pack, stored or shipped: the required mappings, and the fields a pack may write: every plain property of its target schema, read from the register stackiq ships. +- Failing closed with 503 `MAPPING_UNAVAILABLE` when a stored pack is invalid or breaks a rule, when it was renamed, or when the store is gone after the packs were stored there. +- The repair step `SeedCmdbImportPacks` on install and upgrade: seeds missing packs as built-in, replaces unedited packs with the shipped pack of the release, keeps edited ones and reports them; the row ids are kept in stackiq's app config. +- The `x-stackiq` marker in a stored definition: the shipped version and the hash of the shipped pack it was seeded from. +- Excel date conversion for every column a pack maps with a date transform; the note cleanup on the pack's own concat separator. +- `GET /api/settings/cmdb-import/mapping` extended per pack with `source`, `packId`, `storedVersion`, `shippedVersion`, `edited`, `newerShipped`, `updatePending`, `editable` and `editUrl`, and `openRegisterPacks` at the top level. +- The section's mapping block (#1289): per pack its source, version, a hint when a newer shipped pack was not applied, and a link to its editor in OpenRegister (Task 4); the sheet names in the help text come from the endpoint. +- `docs/features/cmdb-import.md`: viewing and editing the mapping in OpenRegister. + +### Out of Scope + +- The editor itself: OpenRegister's change for its migration-pack pages. +- The municipality pack: it maps the import options, not a sheet, and stays a shipped file that is not editable. +- The import profile (`topdesk-profile.json`): sheets, key and required columns, limits and write rules stay a shipped file, shown read-only. +- More than one mapping per instance: OpenRegister's pack store has no organisation scope, so an instance has one TOPdesk mapping for every municipality it imports. +- Promoting `MappingEngine`, `PackDefinitionValidator` or `MigrationPackService` to an OpenRegister contract. + +## Approach + +`CmdbImportProfile::load()` reads each shipped pack, validates it, and for the four sheet targets asks `CmdbImportPackStore` for the stored pack. The store resolves OpenRegister's `MigrationPackService` defensively from the container, finds the pack by slug, seeds it when it is missing, and replaces it when its `x-stackiq` marker shows it was not edited and the shipped pack has changed. `CmdbImportPackRules` checks every pack against the import's rules; `CmdbImportPackMarker` computes the canonical hash. The repair step calls the same store. `SettingsController` adds `editUrl` from OpenRegister's page route through `IURLGenerator`. + +## New Dependencies + +None. + +## Impact + +- **Backend**: `lib/Service/Cmdb/CmdbImportProfile.php` (resolution, sources, date columns, concat separator), new `CmdbImportPackStore.php`, `CmdbImportPackMarker.php`, `CmdbImportPackRules.php`, new `lib/Repair/SeedCmdbImportPacks.php` and its registration in `appinfo/info.xml`, `lib/Controller/SettingsController.php` (`editUrl`, details), `lib/Controller/CmdbImportController.php` (the message names the pack), `lib/Service/CmdbExportImportService.php` (fallback warning, separator). +- **Frontend** (#1289): the mapping block in the "CMDB import" section. +- **Data**: four rows in OpenRegister's `openregister_migration_packs`, created by the repair step or the first import; one app config key, `cmdb_import_pack_ids`. + +## Cross-Project Dependencies + +- **openregister** (consumed): `Service\MigrationPackService` (`findByPackSlug`, `find`, `create`, `update`), `Db\MigrationPack::getDefinitionArray()`, `Service\MigrationPack\PackDefinitionValidator`, `Service\MigrationPack\MappingEngine`, and the page route `dashboard#catchAll` for `/migration-packs/{id}`. +- **openregister** (required before the store is used): OpenRegister's change for WOO-588 (`feat/woo588-migration-pack-editor`): the pack writes require a CSRF token and are admin-only (no `#[NoAdminRequired]`, `#[PublicPage]`, `#[AuthorizedAdminSetting]` or `#[NoCSRFRequired]` on a write method: stackiq refuses a store that has one), a built-in pack's slug is locked (`Exception\BuiltinPackSlugLockedException`), and it adds the migration-pack pages and the envelope body. Released OpenRegister versions write packs without a CSRF check, and the packs drive writes with RBAC off, so stackiq uses the store only when `BuiltinPackSlugLockedException` exists; on an older OpenRegister the import keeps the shipped files with a warning. Do not promote this change to beta before that OpenRegister change is released. + +## Risks + +### Risk 1: An edit in OpenRegister writes fields the import must not write +**Severity:** High — **Mitigation:** the import writes with OpenRegister's RBAC and multitenancy off, so every pack must follow the import's rules (REQ-CMDB-021): only plain properties of the target schema, never object metadata, match keys, relations, publication dates or admin fields, and the required mappings kept. A pack that breaks a rule stops the import with 503 naming the pack. + +### Risk 2: An administrator's edit is lost or silently ignored +**Severity:** High — **Mitigation:** the repair step never overwrites an edited pack; a renamed pack, or a store that is gone after the packs were stored, fails closed instead of falling back to the files. + +### Risk 3: An edit widens what the import reads +**Severity:** Medium — **Mitigation:** the read allowlist is every column the profile or a pack names, so an administrator who maps a new column makes the import read it. Only Nextcloud admins can edit packs and run the import; the documentation says that a mapped column is read. + +### Risk 4: OpenRegister's internal classes change +**Severity:** Medium — **Mitigation:** resolved defensively and checked for the methods called and for the hardened store's `BuiltinPackSlugLockedException`; a missing or older store before any seed falls back to the files with a warning, afterwards fails closed. + +## Rollback Strategy + +Revert the PR. The import then reads the shipped files again; the four rows in OpenRegister's pack store stay and are ignored, and can be deleted there. The app config key `cmdb_import_pack_ids` can be deleted with `occ config:app:delete stackiq cmdb_import_pack_ids`. + +## Open Questions + +- Does any instance import for more than one municipality? The store holds one mapping per instance; per-municipality packs would need a slug per municipality or a pack chosen in the import options. diff --git a/openspec/changes/cmdb-import-mapping-view/specs/cmdb-export-import/spec.md b/openspec/changes/cmdb-import-mapping-view/specs/cmdb-export-import/spec.md new file mode 100644 index 000000000..2d8414c5c --- /dev/null +++ b/openspec/changes/cmdb-import-mapping-view/specs/cmdb-export-import/spec.md @@ -0,0 +1,236 @@ +# cmdb-export-import Specification (delta: cmdb-import-mapping-view) + +**Status**: in-progress +**Scope**: stackiq +**OpenSpec changes**: +- [cmdb-export-import](../../../archive/2026-10-05-cmdb-export-import/) _(archived 2026-10-05)_ +- [cmdb-import-mapping-view](../../) + +## Purpose + +The CMDB import maps the columns of a TOPdesk export to stackiq fields through an import profile and five migration packs that OpenRegister's mapping engine executes (REQ-CMDB-005). Until now the packs were JSON files under `lib/Settings/cmdb-import/`, which an administrator could only read on the server and an app update overwrote. This delta moves the four sheet packs into OpenRegister's migration-pack store, where an administrator views and edits them, and makes the import run what is stored there; the mapping endpoint says where each pack comes from with a link to its editor, and the settings section that shows it follows in #1289 (Jira WOO-588, sub-task of WOO-586; decision 2026-10-12: mapping lives in OpenRegister). + +Nextcloud OCP interfaces used: `OCP\IL10N` (messages), `OCP\IURLGenerator` (the editor link), `OCP\IAppConfig` (the stored pack ids), `OCP\Migration\IRepairStep` (seeding). OpenRegister: `Service\MigrationPackService`, `Service\MigrationPack\PackDefinitionValidator` and `Service\MigrationPack\MappingEngine`, resolved defensively. + +## ADDED Requirements + +### Requirement: The admin settings SHALL show the mapping the import uses (REQ-CMDB-020) + +`GET /api/settings/cmdb-import/mapping` SHALL be reachable only by Nextcloud admins and SHALL require Nextcloud's CSRF token; like the import routes (REQ-CMDB-001) it SHALL NOT carry `#[AuthorizedAdminSetting]`, `#[NoAdminRequired]` or `#[NoCSRFRequired]`. It SHALL load the import profile and every pack through the same loader, store and validator the import uses (REQ-CMDB-021), and SHALL answer 200 with a flat envelope of three keys: + +- `profile`: the profile's `id`, `name`, `version`, `sheets` with each sheet's `name`, `constants` and `absentColumns`, `archiveSheet` (the sheet of which the import reads only the APPID column, REQ-CMDB-015, or null when the profile names none or names one of its source sheets), `sheetPrecedence`, `keyColumn`, `nameColumn`, `requiredColumns`, `dateColumns` (the columns the import converts from Excel dates, REQ-CMDB-005), `idColumns`, `emptyValues`, `externalKeyPrefix`, `missingRecords` and `profileFile`; +- `packs`: one entry per target in the order module, manufacturer, municipality, usage, businessOwner, each with `target`, `file`, `id`, `name`, `version`, `description`, `fieldMappings`, the write rules `defaults`, `createOnlyDefaults`, `createOnlyFields` and `neverWritten`, and where the pack comes from: `source` (`openregister` or `file`), `packId` (the OpenRegister row id, or null), `storedVersion` (or null), `shippedVersion`, `edited` (whether the stored pack differs from what stackiq seeded; null when unknown or for a file), `newerShipped` (an edited pack kept a newer shipped pack out), `editable` (false for the municipality pack), `updatePending` (an unedited stored pack that the next import run replaces with the shipped one; then `version`, `fieldMappings`, `defaults` and the other pack fields show the shipped pack and `storedVersion` what OpenRegister holds) and `editUrl` (the absolute link to the pack's editor in OpenRegister, built by Nextcloud's URL generator so an instance that needs `/index.php` gets it, or null when the pack is not stored there or the link cannot be built); +- `openRegisterPacks`: whether OpenRegister's migration-pack store is available. + +Each field mapping SHALL carry `source`, `target`, `required` (a boolean) and `transform` as the pack stores it. `createOnlyDefaults` holds values the import sets on create only, `createOnlyFields` the mapped fields written on create or, on an existing object, only when the stored value is empty (a key of `createOnlyDefaults` only when it is also a mapped field), and `neverWritten` the fields the import never writes on an existing object. When the validator is missing, a pack is unreadable, invalid or breaks a rule of the import, or the store that holds the packs is gone, the endpoint SHALL answer 503 `MAPPING_UNAVAILABLE` in the import's error envelope (`success`, `error`, `message`, `details`) with the loader's reason in `details.reason` (its first line, at most 500 characters), and for a pack stored in OpenRegister its slug in `details.pack`, its row id in `details.packId` and the link to its editor in `details.editUrl` (null when the link cannot be built). Reading the mapping SHALL change nothing: it SHALL NOT seed, update or delete a pack in OpenRegister and SHALL NOT write stackiq's app config; a pack the store does not hold yet SHALL be answered from its shipped file (`source` `file`), and an unedited stored pack that a newer shipped pack would replace SHALL be answered as the import will run it, that is as the shipped pack with `updatePending` `true`, without writing anything; a stored pack of which OpenRegister reports no last-saved time is kept by the import and answered as stored. The "CMDB import" section SHALL show, per pack, its source, its version, a hint when a newer shipped pack was not applied, a hint when an update is pending (`updatePending`: the shipped version replaces the stored one at the next import), and a link "Edit in OpenRegister" when the pack has an `editUrl`; when the endpoint answers 503 for a stored pack, the error SHALL carry the same link from `details.editUrl`. Per sheet pack it SHALL also show, as text in accessible tables, the field mappings (`source`, `target`, `required`, the transform's type) and the write rules that have values (`defaults`, `createOnlyDefaults`, `createOnlyFields`, `neverWritten`). It SHALL offer no editing itself. + +#### Scenario: An admin reads the mapping the import uses +@e2e tests/e2e/spec-coverage/cmdb-import-packs.spec.ts + +- **GIVEN** a Nextcloud admin, with OpenRegister's migration-pack store holding the seeded packs +- **WHEN** they request `GET /api/settings/cmdb-import/mapping` +- **THEN** the endpoint SHALL answer 200 with `profile.sheets` naming "Onbeh Applicaties CMDB" and "Beheerde Applicaties CMDB", `profile.keyColumn` `APPID` and `openRegisterPacks` `true` +- **AND** `packs` SHALL hold five entries with targets module, manufacturer, municipality, usage and businessOwner +- **AND** the module, manufacturer, usage and businessOwner packs SHALL have `source` `openregister`, a `packId` and an `editUrl` ending in `/apps/openregister/migration-packs/` +- **AND** the municipality pack SHALL have `source` `file`, `editable` `false` and `editUrl` `null` +- **AND** the usage pack SHALL list a mapping from "Applicatie Status" to `status` with a `lookup` transform whose `map` sends "In productie" to "In production" + +#### Scenario: A broken stored pack is reported with its name +@e2e tests/e2e/spec-coverage/cmdb-import-packs.spec.ts + +- **GIVEN** the usage pack in OpenRegister maps a column to `provider` +- **WHEN** a Nextcloud admin requests the mapping +- **THEN** the endpoint SHALL answer 503 with error `MAPPING_UNAVAILABLE` +- **AND** `details.pack` SHALL be `stackiq-topdesk-usage`, `details.packId` its row id, `details.editUrl` the link to its editor ending in `/apps/openregister/migration-packs/`, and `details.reason` SHALL name the pack, its id and the broken rule on one line of at most 500 characters + +#### Scenario: A user who is not a Nextcloud admin cannot read the mapping +@e2e tests/e2e/spec-coverage/cmdb-import-packs.spec.ts + +- **GIVEN** a signed-in user who is not a Nextcloud admin +- **WHEN** they request `GET /api/settings/cmdb-import/mapping` +- **THEN** Nextcloud SHALL answer 403 + +### Requirement: The import SHALL run the mapping packs stored in OpenRegister (REQ-CMDB-021) + +For the module, manufacturer, usage and business-owner targets the import SHALL use the pack stored in OpenRegister's migration-pack store under the shipped pack's slug (`stackiq-topdesk-module`, `stackiq-topdesk-manufacturer`, `stackiq-topdesk-usage`, `stackiq-topdesk-business-owner`), without the `x-stackiq` marker (REQ-CMDB-022). When the store is available and such a pack is missing, the import SHALL first seed it from the shipped file. The municipality pack maps the import options, not a sheet; it SHALL always come from its shipped file. An instance SHALL have one mapping, used for every municipality it imports. + +Every pack, stored or shipped, SHALL pass OpenRegister's `PackDefinitionValidator` and the import's own rules, or the import SHALL stop with 503 `MAPPING_UNAVAILABLE` before any row is read, naming the pack (its file, or its OpenRegister slug and row id) and every rule it breaks; it SHALL NOT fall back to the shipped file. The rules are: + +- the module pack SHALL map `name`, and SHALL map the profile's key column (`APPID`) to `externalNumber`, both with `required: true`; the manufacturer, municipality and business-owner packs SHALL map `name` with `required: true`; +- a pack SHALL map, and set as a default, only properties of its target schema in the register stackiq ships, fragments included (module; organisation for manufacturer and municipality; usage); every such property is allowed unless a rule below refuses it, so no list of fields is kept in code; the business-owner pack, which writes into no schema, only `name` and `role`; +- no pack SHALL map or default `@self`, `id`, `externalKey`, `provider`, `consumer`, `module`, `businessOwner`, a field the profile lists as never written, a relation or a file (a property whose definition or items carry a `$ref`, an `inversedBy`, a `writeBack`, `format: uuid`, `type: file` or a related object), a property the register hides from forms (`hideOnForm: true`, in the base register or a fragment) or calculates (an `x-openregister-calculations` entry), which other subsystems own (the service desk exchange's `serviceDeskSystem`, `serviceDeskRecordId`, `serviceDeskUrl` and `serviceDeskSyncedAt`, the calculated `suggestedTimeClassification`), a usage's `installedVersion`, `publicationDate`, `depublicationDate`, `registeredBy`, `registrationStatus`, `mergedInto`, `contactsUid`, `pki`, `xml`, an organisation's `status` or a module's `type`; +- the manufacturer and municipality packs SHALL NOT map `type` and SHALL keep the defaults as shipped: `type` `Supplier` and `Municipality`, `status` `Active`, and the manufacturer's `registeredBy` `Supplier`. + +OpenRegister's store SHALL count as available only when its pack writes require a CSRF token and lock a built-in pack's slug (the class `OCA\OpenRegister\Exception\BuiltinPackSlugLockedException` exists), and none of the pack controller's write methods (create, update, destroy, import, preview) is opened to non-admins or exempted from the CSRF check (`#[NoAdminRequired]`, `#[PublicPage]`, `#[AuthorizedAdminSetting]` or `#[NoCSRFRequired]`). When OpenRegister's store is not available and no pack was ever stored there, the import SHALL use the shipped files and SHALL add one warning to the report saying so. Once the packs were stored there, a store that is not available SHALL stop the import with 503 `MAPPING_UNAVAILABLE` naming the stored packs. A pack whose stored row now carries another slug SHALL stop the import with 503 naming the row and both slugs; a pack whose row was deleted SHALL be seeded again. The import's 503 message SHALL name the OpenRegister pack and its id when one is at fault. + +#### Scenario: An edit in OpenRegister is what the import runs +@e2e tests/e2e/spec-coverage/cmdb-import-packs.spec.ts + +- **GIVEN** the usage pack in OpenRegister maps "In productie" to `Planned` +- **WHEN** a row with "Applicatie Status" `In productie` is imported +- **THEN** the usage SHALL have `status` `Planned` +- **AND** the report SHALL carry no warning about the mapping + +#### Scenario: A stored pack that writes a field the import manages is refused +@e2e tests/e2e/spec-coverage/cmdb-import-packs.spec.ts + +- **GIVEN** the usage pack in OpenRegister maps "Applicatie Status" to `provider` +- **WHEN** an import starts +- **THEN** the import SHALL answer 503 `MAPPING_UNAVAILABLE` before any row is read, with `details.pack` `stackiq-topdesk-usage` and `details.packId` its row id, and SHALL write nothing +- **AND** the mapping endpoint's reason SHALL name `stackiq-topdesk-usage`, its row id and `"provider" is set by the import and cannot be mapped` + +#### Scenario: A stored module pack without the required name mapping is refused +@e2e tests/e2e/spec-coverage/cmdb-import-packs.spec.ts + +- **GIVEN** the module pack in OpenRegister maps "Applicatie Naam" to `name` without `required: true` +- **WHEN** an import starts +- **THEN** the import SHALL answer 503 `MAPPING_UNAVAILABLE` with `details.pack` `stackiq-topdesk-module` +- **AND** the mapping endpoint's reason SHALL name the pack and `"name" must be mapped as required` + +#### Scenario: A deleted pack is seeded again +@e2e tests/e2e/spec-coverage/cmdb-import-packs.spec.ts + +- **GIVEN** an administrator deleted the business-owner pack in OpenRegister +- **WHEN** a Nextcloud admin requests the mapping +- **THEN** the business-owner pack SHALL have `source` `openregister`, a new `packId` and `edited` `false` +- **AND** OpenRegister SHALL hold `stackiq-topdesk-business-owner` again as a built-in pack + +### Requirement: Stackiq SHALL seed its mapping packs into OpenRegister and keep unedited ones current (REQ-CMDB-022) + +On install and on every upgrade, after its register is initialised, stackiq SHALL create each of the four sheet packs that is missing from OpenRegister's migration-pack store as a built-in pack, from the shipped file, never through OpenRegister's import (which overwrites). Each stored definition SHALL carry `x-stackiq` with `shippedVersion` and `shippedHash`: the version of the shipped pack and the sha256 of its canonical JSON (every object's keys sorted, recursively; list order kept). A stored pack whose definition without `x-stackiq` still hashes to its `shippedHash` is unedited: when the shipped pack of the release differs, stackiq SHALL replace it with the shipped pack and a new marker. An edited pack, or one without marker, SHALL NOT be changed; for an edited pack whose marker differs from the shipped pack, the upgrade SHALL warn that the shipped version was not applied, and the mapping endpoint SHALL answer `newerShipped` `true`. Stackiq SHALL record the row id of every pack it stored or found in its app config. Running the step again on an unchanged store SHALL write nothing. Seeding SHALL never throw: without OpenRegister's store, or when the store fails, it SHALL report and leave the instance as it was. + +#### Scenario: The four sheet packs are stored in OpenRegister +@e2e tests/e2e/spec-coverage/cmdb-import-packs.spec.ts + +- **GIVEN** stackiq is installed next to an OpenRegister with the hardened migration-pack store +- **WHEN** a Nextcloud admin lists OpenRegister's migration packs +- **THEN** the store SHALL hold `stackiq-topdesk-module`, `stackiq-topdesk-manufacturer`, `stackiq-topdesk-usage` and `stackiq-topdesk-business-owner` as built-in packs with the `x-stackiq` marker +- **AND** no municipality pack SHALL be stored + +## MODIFIED Requirements + +### Requirement: Field mapping SHALL be declarative and executed by OpenRegister's mapping engine (REQ-CMDB-005) + +The service SHALL map each normalised row with OpenRegister's `MigrationPack\MappingEngine::mapRow()`, once per target pack: module, manufacturer, municipality, usage, business owner. The packs and the import profile SHALL ship as JSON under `lib/Settings/cmdb-import/`; the module, manufacturer, usage and business-owner packs SHALL be taken from OpenRegister's migration-pack store when it holds them (REQ-CMDB-021), the shipped files being their seed. Each pack SHALL pass OpenRegister's `PackDefinitionValidator` and the import's rules when the import starts; an invalid pack, or a missing `MappingEngine`, SHALL stop the import with 503 `MAPPING_UNAVAILABLE` before any row is read. Before mapping, the service SHALL convert the cells of the date columns from Excel serial numbers to `Y-m-d`: the profile's date columns and every column a pack maps with a `date` transform. It SHALL turn numeric id cells into strings without a decimal part, SHALL read a value the profile lists as empty for its column (`NB` in "BNN Classificatie"; dates, "End-of-Life Functioneel" included, are kept as the file has them) as empty, and SHALL add the constants of the row's sheet (`Beheer` = `Beheer geregeld: nee` or `ja`). A mapping error on a mapping marked `required` in the module pack SHALL skip the row. In the manufacturer and owner packs it SHALL mean the row has no manufacturer or no such owner, without a warning. A mapping error on any other mapping SHALL drop only that field and add a row warning naming the column and the value. The empty parts of the usage's internal note SHALL be dropped on the separator of the concat mapping that writes it. The reader SHALL keep only the columns that the profile or a pack references, and SHALL discard every other cell when it reads the row. + +(Previously: the packs were read from the shipped files only, only the profile's date columns were converted, and the note was split on a fixed ` / `.) + +#### Scenario: Excel serial dates are converted before mapping +@e2e exclude Pure transformation; tests/Unit/Service/Cmdb/CmdbRowNormaliserTest.php asserts the conversions below. + +- **GIVEN** the "Onbeh" row of the anonymised export with "Datum" = `45111.380322627316` and "Referentie datum wijziging" = `46232.552113113423`, and the "Beheerde" row with "End-of-Life Functioneel" = `53359` +- **WHEN** the rows are normalised +- **THEN** "Datum" SHALL be `2023-07-04`, "Referentie datum wijziging" SHALL be `2026-07-29`, and "End-of-Life Functioneel" SHALL be `2046-02-01` +- **AND** "APPID" `1234` SHALL be the string `"1234"` +- **AND** "BNN Classificatie" `NB` SHALL be empty +- **AND** "End-of-Life Functioneel" `49675` SHALL be `2036-01-01` + +#### Scenario: Changing a pack changes the mapping without code +@e2e exclude Configuration behaviour; tests/Unit/Service/CmdbExportImportServiceTest.php imports against an alternate module pack and against an edited stored usage pack. + +- **GIVEN** the usage pack in OpenRegister is edited to add a mapping from "In productie sinds" to `startDateInProduction` with a `date` transform, and its note separator is changed to ` | ` +- **WHEN** an export is imported whose row has "In productie sinds" = `45111` and "Cluster" = `B10` +- **THEN** the usage SHALL have `startDateInProduction` = `2023-07-04` +- **AND** its `interneAnnotation` SHALL be `Beheer geregeld: ja | B10` +- **AND** no PHP code SHALL have changed + +#### Scenario: An unknown status value drops only that field +@e2e exclude Mapping behaviour; tests/Unit/Service/CmdbExportImportServiceTest.php asserts the row outcome and warning. + +- **GIVEN** a row whose "Applicatie Status" is `Onbekende status`, which the usage pack's lookup does not contain +- **WHEN** the row is imported +- **THEN** the module and the usage SHALL be saved without a status from the export +- **AND** the row's report entry SHALL carry a warning naming column "Applicatie Status" and value `Onbekende status` + +#### Scenario: The classifications map to the stackiq fields +@e2e exclude Mapping behaviour; tests/Unit/Service/CmdbExportImportServiceTest.php imports the fixture and asserts the fields. + +- **GIVEN** the "Beheerde" row of the anonymised export with "Applicatiesoort" `Saas`, "BNN Classificatie" `BBN2`, "Classificatie" `Tolereren` and "End-of-Life Functioneel" `53359` +- **WHEN** it is imported +- **THEN** the module SHALL have `applicationType` = `Saas`, `cloudDienstverleningsmodel` = `["SaaS"]` and `bbnLevel` = `BBN2` +- **AND** the usage SHALL have `timeClassification` = `Tolerate` and `startDateOutPhased` = `2046-02-01` +- **AND** the "Onbeh" row's "Applicatiesoort" `Webapplicatie`, which is not a hosting model, SHALL be stored as `applicationType` and SHALL leave `cloudDienstverleningsmodel` empty without a warning +- **AND** "BNN Classificatie" `1`, `2`, `2+` SHALL be `BBN1`, `BBN2`, `BBN2+` + +### Requirement: The admin settings SHALL offer a CMDB import section (REQ-CMDB-014) + +Stackiq's admin settings page SHALL show a section "CMDB import", rendered by the settings page and not registered as an in-app route. The section SHALL let the admin choose an existing municipality or type the name of a new one, choose an `.xlsx` file, choose what happens to applications missing from the export (archive, the default, or keep) with a one-sentence help text that says what each does and the details in the section's information panel, and start the import. While the import runs it SHALL show a progress bar and a Cancel button. Afterwards it SHALL show the summary, including the archived, unarchived, deleted and restored counts when they are not zero, and a report table that can be filtered by outcome, including those four; a reconciliation row SHALL show no row number. The section SHALL also show the mapping the import uses (REQ-CMDB-020), as tables: the export's sheets and columns, and per sheet pack its source, its version, a hint when a newer shipped pack was not applied, and a link "Edit in OpenRegister" when the pack has an `editUrl`; the municipality pack, which maps the import options and no column, SHALL NOT be listed. When the endpoint answers 503 for a stored pack, the error SHALL carry the same link from `details.editUrl`. The section SHALL offer no editing of the mapping itself. The sheet names in its help text SHALL come from that mapping, every sheet it names and in its order, whatever their number, and so SHALL the archive sheet its texts name, with no archive sheet when the profile names none; the shipped names are the fallback until the mapping has loaded or when it cannot be loaded. Every control SHALL have a visible label, and every string SHALL be translatable. + +(Previously: the section had no mapping block, and the sheet names in its help text were a constant in the page, which could drift from the profile on the server. This block also carries the missing-applications choice, the four counts and the reconciliation rows of cmdb-import-archive-reconciliation, which modifies REQ-CMDB-014 too (before it, the request always sent `keep`); both changes carry this same block, so archiving them in either order leaves the whole requirement.) + +#### Scenario: The admin runs an import from the settings page +@e2e tests/e2e/spec-coverage/cmdb-import.spec.ts + +- **GIVEN** a Nextcloud admin on stackiq's admin settings page +- **WHEN** they choose "Gemeente Voorbeeldstad", choose the anonymised export and press "Import" +- **THEN** a progress bar SHALL appear while the import runs +- **AND** afterwards the summary and the report table SHALL be shown +- **AND** filtering the table on `created` SHALL show the two imported rows + +#### Scenario: The admin chooses to keep missing applications +@e2e tests/e2e/spec-coverage/cmdb-import.spec.ts + +- **GIVEN** the section +- **WHEN** the admin selects "Keep them as they are" and starts the import +- **THEN** the request SHALL carry `missingRecords=keep` +- **AND** without a choice it SHALL carry `missingRecords=archive` + +#### Scenario: The sheet names in the help come from the server +@e2e tests/e2e/spec-coverage/cmdb-import-mapping.spec.ts + +- **GIVEN** a Nextcloud admin on stackiq's admin settings page +- **WHEN** the mapping endpoint has answered +- **THEN** the help text under the file control SHALL name the sheets the endpoint returned +- **AND** a profile with one, two or three sheets SHALL give a help text and an info text that name exactly those sheets, with no sheet the profile does not name and no description tied to a sheet's position +- **AND** when the endpoint fails, it SHALL name the shipped sheets and the mapping block SHALL show the error + +#### Scenario: The archive sheet in the help comes from the server +@e2e exclude Not driven in e2e yet: the texts are derived in the page from the endpoint's answer, and src/views/settings/sections/CmdbImport.spec.js emits mappings with the archive sheet "Archief" and with none and asserts the info text, the missing-applications paragraph and the too-large hint; the route intercept in tests/e2e/spec-coverage/cmdb-import-mapping.spec.ts could drive it as well. + +- **GIVEN** the mapping endpoint answers `profile.archiveSheet` `Archief` +- **WHEN** the section renders its information panel and a too-large error +- **THEN** the info text, the paragraph on applications missing from the export and the hint SHALL name the sheet `Archief` +- **AND** when it answers `null`, none of them SHALL name an archive sheet, and the paragraph SHALL say that the import only archives + +#### Scenario: The section lists the mapping and links each pack to its editor +@e2e tests/e2e/spec-coverage/cmdb-import-mapping.spec.ts + +- **GIVEN** a Nextcloud admin on stackiq's admin settings page +- **WHEN** the mapping block of the "CMDB import" section has loaded +- **THEN** a table of the export SHALL list the sheets read and the match, name, required and date columns, and a table of the packs SHALL show each of the four sheet packs with its source and version and a link "Edit in OpenRegister" to its `editUrl` +- **AND** the municipality pack, which maps the import options and no column, SHALL NOT be listed +- **AND** when the endpoint answers 503 for a stored pack, the error SHALL show a link "Edit in OpenRegister" to its `details.editUrl` +- **AND** the block SHALL hold no input field + +#### Scenario: An edited pack whose newer shipped version was not applied says so +@e2e exclude Needs a stackiq release that ships a newer pack than the one installed; tests/vitest/cmdbImportMapping.spec.js mounts the block with an edited usage pack whose `newerShipped` is true and asserts the hint, and its absence for the unedited module pack. + +- **GIVEN** the mapping endpoint answers an edited usage pack with `newerShipped` `true` and `shippedVersion` `1.1.0` +- **WHEN** the mapping block renders +- **THEN** the usage row SHALL say that stackiq ships version `1.1.0`, that it was not applied because the pack was edited, and how to use the shipped version +- **AND** a row whose `newerShipped` is `false` SHALL show no such hint + +## Non-Functional Requirements + +- **Performance:** loading the mapping reads seven small JSON files and the register definition, and makes at most one OpenRegister lookup per sheet pack; it SHALL answer within the time an admin settings page loads. Writes happen only to seed or update a pack. +- **Security:** admin-only with CSRF, as the import routes; OpenRegister's pack writes are admin-only with CSRF, and stackiq uses no store without those guards. The import writes with OpenRegister's RBAC and multitenancy off, so every pack SHALL follow the import's rules (REQ-CMDB-021). An edit that maps a new column makes the import read that column. The answer and the reasons hold column names, field names, lookup tables, pack names and ids; no object data and no person data. A store failure is named by its exception class, never its message. +- **Reliability:** an edit is never overwritten by an upgrade and never silently replaced by the shipped files (REQ-CMDB-021, REQ-CMDB-022). +- **Accessibility:** Target WCAG 2.2 AA. The mapping block's link has a visible, descriptive label (SC 2.4.4, 4.1.2; gate `link-name`); a status hint is text, not colour alone (SC 1.4.1). New in 2.2: 2.4.11 Focus Not Obscured applies (the block is in the page flow); 2.5.7 Dragging Movements does not apply; 2.5.8 Target Size applies to the link (Nextcloud default); 3.2.6 Consistent Help does not apply; 3.3.7 Redundant Entry does not apply (nothing is entered); 3.3.8 Accessible Authentication does not apply. +- **Internationalization:** Dutch and English MUST be supported (ADR-005) for the block, the messages and the import warning. + +## Acceptance Criteria + +- [ ] After install, OpenRegister lists the four `stackiq-topdesk-*` packs as built-in packs. +- [ ] A Nextcloud admin edits a lookup value of the usage pack in OpenRegister, and the next CMDB import uses it. +- [ ] A pack edited to map a field the import manages makes the import answer 503 naming the pack; the mapping endpoint answers the same 503. +- [ ] Deleting the stored pack in OpenRegister makes the next import seed the shipped pack again. +- [ ] The "CMDB import" section shows per pack its source and an "Edit in OpenRegister" link that opens the pack's editor. +- [ ] A signed-in user who is not a Nextcloud admin gets 403 from the endpoint. + +## Notes + +- Decision 2026-10-12: the mapping lives in OpenRegister. The packs use OpenRegister's existing migration-pack store, not its Twig mapping entity: the packs are already migration packs, executed by `MappingEngine` with structural validation and row and column errors. +- One mapping per instance: OpenRegister's pack store has no organisation scope. An instance that imports for more than one municipality shares the mapping between them. +- `MigrationPackService`, `PackDefinitionValidator` and `MappingEngine` are not part of OpenRegister's `Contract` namespace; stackiq resolves them defensively. +- Deleting a stored pack means "back to the shipped pack": the next import or upgrade seeds it again. +- REQ-CMDB-014 is modified by this change and by cmdb-import-archive-reconciliation; both carry the same block, which holds what each adds, so archiving them in either order leaves the whole requirement. A change to that block goes into both. diff --git a/openspec/changes/cmdb-import-mapping-view/tasks.md b/openspec/changes/cmdb-import-mapping-view/tasks.md new file mode 100644 index 000000000..f0988cb0a --- /dev/null +++ b/openspec/changes/cmdb-import-mapping-view/tasks.md @@ -0,0 +1,93 @@ +# Tasks: cmdb-import-mapping-view + +Spec: `openspec/changes/cmdb-import-mapping-view/specs/cmdb-export-import/spec.md` (`SPEC` below). + +## Implementation Tasks + +### Task 1: The import reads the sheet packs from OpenRegister's migration-pack store +- **spec_ref**: `SPEC#requirement-the-import-shall-run-the-mapping-packs-stored-in-openregister-req-cmdb-021` (cmdb-export-import#REQ-CMDB-021) and `SPEC#requirement-field-mapping-shall-be-declarative-and-executed-by-openregisters-mapping-engine-req-cmdb-005` (cmdb-export-import#REQ-CMDB-005) +- **files**: `lib/Service/Cmdb/CmdbImportProfile.php`, `lib/Service/Cmdb/CmdbImportPackStore.php`, `lib/Service/Cmdb/CmdbImportPackMarker.php`, `lib/Service/Cmdb/CmdbImportPackRules.php`, `lib/Service/CmdbExportImportService.php`, `lib/Controller/CmdbImportController.php`, `tests/Unit/Service/Cmdb/CmdbImportPackStoreTest.php`, `tests/Unit/Service/Cmdb/CmdbImportPackRulesTest.php`, `tests/Unit/Service/Cmdb/CmdbImportProfileTest.php`, `tests/Unit/Service/CmdbExportImportServiceTest.php`, `tests/Unit/Controller/CmdbImportControllerTest.php`, `tests/Unit/Support/FakeMigrationPackService.php` +- **acceptance_criteria**: + - GIVEN OpenRegister's store holds an edited module pack WHEN the profile loads THEN the module pack is the stored one without its marker, and the missing sheet packs are seeded; the municipality pack is the shipped file + - GIVEN an unedited stored pack seeded from an older release WHEN the profile loads THEN it is replaced by the shipped pack; GIVEN an edited one THEN it is kept and reported `newerShipped` + - GIVEN a stored pack the validator refuses, or that breaks a rule of the import WHEN the profile loads THEN 503 `MAPPING_UNAVAILABLE` names the pack and its id in the message and the details + - GIVEN no store and no recorded pack ids THEN the shipped files are used and the import report carries one warning; GIVEN no store and recorded ids THEN 503 naming the packs + - GIVEN a renamed stored pack THEN 503 naming the row and both slugs; GIVEN a deleted one THEN it is seeded again + - GIVEN a stored pack that maps a new column with a date transform WHEN a row is imported THEN that column is converted from an Excel date; the note cleanup uses the pack's concat separator +- [x] Implement +- [x] Test + +### Task 2: Seed and update the packs in OpenRegister on install and upgrade +- **spec_ref**: `SPEC#requirement-stackiq-shall-seed-its-mapping-packs-into-openregister-and-keep-unedited-ones-current-req-cmdb-022` (cmdb-export-import#REQ-CMDB-022) +- **files**: `lib/Repair/SeedCmdbImportPacks.php`, `appinfo/info.xml`, `tests/Unit/Repair/SeedCmdbImportPacksTest.php` +- **acceptance_criteria**: + - GIVEN an empty store WHEN the step runs THEN the four sheet packs are created as built-in packs with the `x-stackiq` marker and their ids are recorded; a second run writes nothing + - GIVEN an unedited pack from an older release THEN it is updated; GIVEN an edited one THEN it is kept and the step warns that the shipped version was not applied + - GIVEN no store, or a failing store THEN the step reports and never throws + - GIVEN `appinfo/info.xml` THEN the step runs after `InitializeSettings` in `` and `` +- [x] Implement +- [x] Test + +### Task 3: The mapping endpoint says where each pack comes from and links to its editor +- **spec_ref**: `SPEC#requirement-the-admin-settings-shall-show-the-mapping-the-import-uses-req-cmdb-020` (cmdb-export-import#REQ-CMDB-020) +- **files**: `lib/Service/Cmdb/CmdbImportProfile.php`, `lib/Controller/SettingsController.php`, `appinfo/routes.php`, `tests/Unit/Controller/SettingsControllerCmdbImportMappingTest.php`, `tests/Unit/Service/Cmdb/CmdbImportProfileTest.php` +- **acceptance_criteria**: + - GIVEN the route WHEN its method is reflected THEN it carries no attribute, declares `@auth admin-only` with a reason and no exemption annotation + - GIVEN the shipped files and no store THEN 200 with `{profile, packs, openRegisterPacks: false}`, every pack `source: file`, `editUrl: null` + - GIVEN the store THEN the four sheet packs answer `source: openregister`, `packId`, `storedVersion`, `shippedVersion`, `edited`, `newerShipped`, `updatePending`, `editable: true` and `editUrl` built from OpenRegister's page route; the municipality pack answers `editable: false` + - GIVEN a broken stored pack THEN 503 with `details.reason`, `details.pack` and `details.packId` +- [x] Implement +- [x] Test + +### Task 4 (#1289): The section's mapping block shows the source and the editor link per pack +- **spec_ref**: `SPEC#requirement-the-admin-settings-shall-offer-a-cmdb-import-section-req-cmdb-014` (cmdb-export-import#REQ-CMDB-014) and `SPEC#requirement-the-admin-settings-shall-show-the-mapping-the-import-uses-req-cmdb-020` (cmdb-export-import#REQ-CMDB-020) +- **files**: `src/views/settings/sections/CmdbImportMapping.vue`, `src/views/settings/sections/CmdbImport.vue`, `src/utils/cmdbImport.js`, `tests/vitest/cmdbImportMapping.spec.js`, `src/views/settings/sections/CmdbImport.spec.js`, `src/utils/cmdbImport.spec.js` +- **acceptance_criteria**: + - GIVEN the endpoint's answer WHEN the block renders THEN each pack shows its source, its version, a hint when `newerShipped`, and an "Edit in OpenRegister" link to `editUrl` when there is one + - GIVEN a pack with `updatePending` THEN the block says the shipped version replaces the stored one at the next import + - GIVEN a sheet pack THEN a collapsible block lists its field mappings (column, field, required, transform) and the write rules that have values, as text in tables with captions and `th` scopes + - GIVEN the block is collapsed while the answer loads THEN the loading announcement is in a live region outside the hidden block + - GIVEN a 503 THEN the block shows the error, the code and the reason, and for a stored pack an "Edit in OpenRegister" link to `details.editUrl` + - GIVEN the answer THEN the help text names the endpoint's sheets; before and on failure `PROFILE_DEFAULTS.sheets` + - GIVEN a profile with one, two or three sheets WHEN the section renders its help text and its info text THEN both name exactly those sheets in the profile's order + - GIVEN the answer names an archive sheet, or none THEN the info text, the missing-applications paragraph and the too-large hint name that sheet, or no archive sheet +- [x] Implement +- [x] Test + +### Task 5: Translations and documentation +- **spec_ref**: `SPEC#requirement-the-admin-settings-shall-show-the-mapping-the-import-uses-req-cmdb-020` (cmdb-export-import#REQ-CMDB-020) +- **files**: `l10n/en.json`, `l10n/nl.json`, `l10n/en.js`, `l10n/nl.js`, `docs/features/cmdb-import.md` +- **acceptance_criteria**: + - GIVEN the new strings WHEN `npm run test:l10n` and `npm run check:l10n-js` run THEN both pass, with Dutch for every string + - GIVEN the docs WHEN an administrator reads "Viewing and editing the mapping" THEN they know where to edit a pack, what the import refuses, what happens on an app update and how to go back to the shipped pack +- [x] Implement (backend strings, the section's strings and documentation) +- [x] Test + +### Task 6: End-to-end coverage of the endpoint, the import and the seed +- **spec_ref**: `SPEC#requirement-the-admin-settings-shall-show-the-mapping-the-import-uses-req-cmdb-020` (cmdb-export-import#REQ-CMDB-020), `SPEC#requirement-the-import-shall-run-the-mapping-packs-stored-in-openregister-req-cmdb-021` (cmdb-export-import#REQ-CMDB-021) and `SPEC#requirement-stackiq-shall-seed-its-mapping-packs-into-openregister-and-keep-unedited-ones-current-req-cmdb-022` (cmdb-export-import#REQ-CMDB-022) +- **files**: `tests/e2e/spec-coverage/cmdb-import-packs.spec.ts` +- **acceptance_criteria**: + - GIVEN the rig with the hardened OpenRegister WHEN an admin lists OpenRegister's packs THEN the four sheet packs are built-in packs with the marker, and no municipality pack is stored + - GIVEN an admin WHEN they read the mapping THEN every sheet pack answers `source: openregister`, its `packId` and an `editUrl` to its editor; the municipality pack `source: file` and no link + - GIVEN the usage pack edited to map a column to `provider` THEN the mapping and the import answer 503 naming the pack, and nothing is written; GIVEN the module pack's name no longer required THEN the same with the rule named + - GIVEN an edited lookup in the usage pack WHEN the export is imported THEN the usages carry the edited value + - GIVEN the business-owner pack deleted in OpenRegister WHEN the mapping is read THEN it is shown from the shipped file and not stored; WHEN the next import runs THEN it is seeded again + - GIVEN a signed-in non-admin WHEN they call the endpoint THEN 403 +- [x] Implement +- [x] Test + +### Task 7 (#1289): End-to-end coverage of the section +- **spec_ref**: `SPEC#requirement-the-admin-settings-shall-show-the-mapping-the-import-uses-req-cmdb-020` (cmdb-export-import#REQ-CMDB-020); the section itself is specified in #1289 +- **files**: `tests/e2e/spec-coverage/cmdb-import-mapping.spec.ts` +- **acceptance_criteria**: + - GIVEN an admin on the settings page WHEN the mapping has loaded THEN every sheet pack shows its source and an "Edit in OpenRegister" link, and the error of a broken stored pack links to its editor +- [x] Implement +- [x] Test + +### Task 8: Archive +- **spec_ref**: `SPEC#requirement-the-import-shall-run-the-mapping-packs-stored-in-openregister-req-cmdb-021` (cmdb-export-import#REQ-CMDB-021) +- **files**: `openspec/specs/cmdb-export-import/spec.md` +- **acceptance_criteria**: + - GIVEN the change is archived WHEN this was the last open change of `cmdb-export-import` THEN the canonical spec's front matter `status:` and its `**Status**` line read `done` again, and the change's entry links the archive +- [ ] Implement +- [ ] Test diff --git a/openspec/specs/cmdb-export-import/spec.md b/openspec/specs/cmdb-export-import/spec.md index d2f7fd4b5..55747f9fb 100644 --- a/openspec/specs/cmdb-export-import/spec.md +++ b/openspec/specs/cmdb-export-import/spec.md @@ -1,15 +1,17 @@ --- capability: cmdb-export-import -status: done +status: in-progress built_by: openspec/changes/archive/2026-10-05-cmdb-export-import --- # cmdb-export-import Specification -**Status**: done +**Status**: in-progress **Scope**: stackiq **OpenSpec changes**: - [cmdb-export-import](../../changes/archive/2026-10-05-cmdb-export-import/) _(archived 2026-10-05)_ — admin uploads a TOPdesk CMDB export (xlsx); stackiq upserts modules, vendor organisations, usages and owner contact persons for one municipality from the two CMDB sheets, matched on APPID, mapped by OpenRegister migration packs (kind: code) +- [cmdb-import-mapping-view](../../changes/cmdb-import-mapping-view/) — the four sheet packs are seeded into OpenRegister's migration-pack store, where an administrator edits them, and the import runs what is stored there (shipped files as seed and fallback, fail-closed on an invalid pack); `GET /api/settings/cmdb-import/mapping` answers, without writing, per pack its source and a link to its editor (kind: code) +- [cmdb-import-archive-reconciliation](../../changes/cmdb-import-archive-reconciliation/) — a re-import archives the applications that moved to the sheet "Gearchiveerde Applicaties" and soft-deletes the ones on no sheet, revives the ones that return, with `missingRecords: keep | archive` (default archive) and an "Archived" quick filter (kind: code) ## Purpose @@ -294,7 +296,7 @@ For each row the service SHALL compute `externalKey` = `topdesk:} sheetNames The sheets the import reads, for the hint + * @param {string|null} archiveSheet The archive sheet, of which the import reads the APPID column; null when the profile names none * @return {{title: string, hint: string}} The words * @spec openspec/changes/cmdb-export-import/specs/cmdb-export-import/spec.md#requirement-the-workbook-shall-be-read-as-stored-data-without-evaluating-formulas-or-following-links-req-cmdb-002 */ -function workbookTooLarge(details) { +function workbookTooLarge(details, sheetNames, archiveSheet) { const compressed = t( 'stackiq', 'An .xlsx file is compressed, so a file of a few MB can be much larger once unpacked. Nothing was imported.', @@ -503,7 +539,7 @@ function workbookTooLarge(details) { + ' ' + t( 'stackiq', - 'Split the rows over two copies of the export and import them one after the other.', + 'Split the rows over two copies of the export and import both with "Keep them as they are": an import that archives treats the applications of the other copy as missing.', ) if (Number(details.maxPartBytes) > 0) { const sizes = { @@ -530,15 +566,19 @@ function workbookTooLarge(details) { const unread = compressed + ' ' - + t( - 'stackiq', - 'Delete the sheets the import does not read from a copy of the export (it reads only "{first}" and "{second}"), and import that copy.', - { - first: PROFILE_DEFAULTS.sheets[0], - second: PROFILE_DEFAULTS.sheets[1], - }, - AS_TEXT, - ) + + (archiveSheet + ? t( + 'stackiq', + 'Delete the sheets the import does not read from a copy of the export (it reads {sheets}, and the APPID column of "{archive}"), and import that copy.', + { sheets: quotedSheetList(sheetNames), archive: archiveSheet }, + AS_TEXT, + ) + : t( + 'stackiq', + 'Delete the sheets the import does not read from a copy of the export (it reads only {sheets}), and import that copy.', + { sheets: quotedSheetList(sheetNames) }, + AS_TEXT, + )) if (Number(details.maxSharedStrings) > 0) { return { title: t( @@ -584,10 +624,16 @@ function workbookTooLarge(details) { * when the server's message is not. * * @param {{error: string, message?: string, details?: object}} error The error in the server's shape + * @param {Array} [sheetNames] The sheets the import reads, from mappingSheetNames(); the shipped names when left out. Hints name all of them, whatever their number + * @param {string|null} [archiveSheet] The archive sheet, from mappingArchiveSheet(); the shipped name when left out, null when the profile names none * @return {{title: string, hint: string}} The words * @spec openspec/changes/cmdb-export-import/specs/cmdb-export-import/spec.md#requirement-columns-shall-be-resolved-by-header-name-and-a-missing-required-column-shall-stop-the-import-with-422-req-cmdb-003 */ -export function errorText(error) { +export function errorText( + error, + sheetNames = PROFILE_DEFAULTS.sheets, + archiveSheet = mappingArchiveSheet(null), +) { const details = error?.details || {} switch (error?.error) { case 'NO_FILE_UPLOADED': @@ -619,14 +665,14 @@ export function errorText(error) { ), hint: t( 'stackiq', - 'Remove sheets the import does not read, or split the export, and try again.', + 'Remove sheets the import does not read and try again. Or split the export and import every part with "Keep them as they are".', ), } case 'MISSING_RECORDS_UNSUPPORTED': return { title: t( 'stackiq', - 'Records missing from the export can only be kept.', + 'Applications missing from the export can only be archived or kept.', ), hint: '', } @@ -682,22 +728,28 @@ export function errorText(error) { case 'NO_SOURCE_SHEET': { const expected = Array.isArray(details.expected) && details.expected.length > 0 - ? details.expected - : PROFILE_DEFAULTS.sheets + ? details.expected.map((name) => String(name)) + : sheetNames + const values = { sheets: quotedSheetList(expected) } return { title: t( 'stackiq', 'The workbook has none of the sheets the import reads.', ), - hint: t( - 'stackiq', - 'Expected a sheet named "{first}" or "{second}". Sheet names must match exactly.', - { - first: String(expected[0] ?? PROFILE_DEFAULTS.sheets[0]), - second: String(expected[1] ?? PROFILE_DEFAULTS.sheets[1]), - }, - AS_TEXT, - ), + hint: + expected.length === 1 + ? t( + 'stackiq', + 'Expected the sheet {sheets}. Sheet names must match exactly.', + values, + AS_TEXT, + ) + : t( + 'stackiq', + 'Expected one of the sheets {sheets}. Sheet names must match exactly.', + values, + AS_TEXT, + ), } } case 'MISSING_COLUMN': @@ -733,13 +785,13 @@ export function errorText(error) { Number(details.limit) > 0 ? t( 'stackiq', - 'A source sheet may hold at most {limit} rows. Split the export and import the parts one after the other.', + 'A source sheet may hold at most {limit} rows. Split the export and import the parts one after the other with "Keep them as they are".', { limit: Number(details.limit).toLocaleString() }, AS_TEXT, ) : t( 'stackiq', - 'Split the export and import the parts one after the other.', + 'Split the export and import the parts one after the other with "Keep them as they are".', ), } case 'MAPPING_UNAVAILABLE': @@ -747,7 +799,7 @@ export function errorText(error) { title: t('stackiq', 'The import mapping cannot run.'), hint: t( 'stackiq', - "OpenRegister's mapping engine is missing or a mapping file is invalid. Update OpenRegister and check the Nextcloud log.", + "OpenRegister's mapping engine is missing, or a mapping pack is invalid or breaks a rule of the import. The reason below names the pack: correct it in OpenRegister, or check the Nextcloud log.", ), } case 'READER_UNAVAILABLE': @@ -767,7 +819,7 @@ export function errorText(error) { ), } case 'WORKBOOK_TOO_LARGE': - return workbookTooLarge(details) + return workbookTooLarge(details, sheetNames, archiveSheet) case 'SCHEMA_OUTDATED': return { title: details.schema @@ -807,6 +859,17 @@ export function errorText(error) { 'Choose the municipality from the list instead of typing its name. Nothing was imported.', ), } + case 'ARCHIVE_UNAVAILABLE': + return { + title: t( + 'stackiq', + 'Applications missing from the export cannot be archived.', + ), + hint: t( + 'stackiq', + 'OpenRegister is missing or too old to archive objects. Choose "Keep them as they are" and import again, or update OpenRegister. Nothing was imported.', + ), + } case 'OPERATION_NOT_FOUND': return { title: t('stackiq', 'This import is no longer running.'), @@ -886,9 +949,17 @@ export function cancelFailureText(error) { * server has set them, because the tracker's own percentage is weighted by * the phases of the ArchiMate import. * + * In the phase `reconciling` the server's counts add the applications of the + * municipality to the rows, and those applications include ones that are on + * the sheets and need no change. They are neither rows nor applications + * missing from the export, so the view shows no "N of M" for this phase and + * keeps the bar where the rows left it (full) instead of letting it fall + * back when the total grows. + * * @param {object|null} progress The snapshot from `GET /api/progress/{operationId}` * @return {{percentage: number, detail: string}|null} The view, or null before any progress * @spec openspec/changes/cmdb-export-import/specs/cmdb-export-import/spec.md#requirement-a-running-import-shall-report-its-progress-and-shall-stop-when-cancelled-req-cmdb-013 + * @spec openspec/changes/cmdb-import-archive-reconciliation/specs/cmdb-export-import/spec.md#requirement-an-application-missing-from-the-cmdb-sheets-shall-be-archived-when-the-archive-sheet-lists-it-and-soft-deleted-when-no-sheet-does-req-cmdb-015 */ export function cmdbProgressView(progress) { if (!progress) { @@ -900,6 +971,17 @@ export function cmdbProgressView(progress) { total > 0 ? Math.min(100, Math.round((processed / total) * 100)) : Number(progress.percentage) || 0 + if (progress.phase === 'reconciling') { + return { + percentage: 100, + detail: t( + 'stackiq', + 'Checking the applications of this municipality against the export', + {}, + AS_TEXT, + ), + } + } return { percentage, detail: @@ -960,9 +1042,13 @@ export function sortReportRows(rows, key, order) { /** * The rows of the report as the table shows them. * + * An application the import archived or deleted after its rows has row 0 + * in the report and no row number in the table. + * * @param {Array} rows The report's `rows` * @return {Array} The table rows * @spec openspec/changes/cmdb-export-import/specs/cmdb-export-import/spec.md#requirement-each-row-shall-be-processed-in-isolation-and-reported-with-its-outcome-req-cmdb-011 + * @spec openspec/changes/cmdb-import-archive-reconciliation/specs/cmdb-export-import/spec.md#requirement-the-admin-settings-shall-offer-a-cmdb-import-section-req-cmdb-014 */ export function reportRows(rows) { if (!Array.isArray(rows)) { @@ -971,7 +1057,7 @@ export function reportRows(rows) { return rows.map((row, index) => ({ key: `${row.sheet ?? ''}:${row.row ?? index}:${index}`, sheet: String(row.sheet ?? ''), - row: row.row ?? '', + row: Number(row.row) > 0 ? row.row : '', appId: String(row.appId ?? ''), name: String(row.name ?? ''), outcome: String(row.outcome ?? ''), @@ -984,3 +1070,360 @@ export function reportRows(rows) { moduleUuid: row.moduleUuid ? String(row.moduleUuid) : '', })) } + +/** + * The URL of the mapping overview endpoint. + * + * @return {string} The URL + * @spec openspec/changes/cmdb-import-mapping-view/specs/cmdb-export-import/spec.md#requirement-the-admin-settings-shall-show-the-mapping-the-import-uses-req-cmdb-020 + */ +export function mappingUrl() { + return generateUrl('/apps/stackiq/api/settings/cmdb-import/mapping') +} + +/** + * Read the mapping the import uses: the profile and one entry per pack. + * + * @param {object} options The options + * @param {object} options.http An axios-like client with get + * @return {Promise<{profile: object, packs: Array}>} The server's answer + * @spec openspec/changes/cmdb-import-mapping-view/specs/cmdb-export-import/spec.md#requirement-the-admin-settings-shall-show-the-mapping-the-import-uses-req-cmdb-020 + */ +export async function loadCmdbMapping({ http }) { + const response = await http.get(mappingUrl()) + return response.data +} + +/** + * The names of the source sheets: the profile's when the mapping has loaded + * and names at least one sheet, the shipped defaults until then or when it + * could not be loaded. Every sheet the profile names is returned, in the + * profile's order, so the help texts and the block show the same list. + * + * @param {object|null} mapping The mapping endpoint's answer, or null + * @return {Array} The sheet names, never empty + * @spec openspec/changes/cmdb-import-mapping-view/specs/cmdb-export-import/spec.md#requirement-the-admin-settings-shall-offer-a-cmdb-import-section-req-cmdb-014 + */ +export function mappingSheetNames(mapping) { + const sheets = mapping?.profile?.sheets + const names = (Array.isArray(sheets) ? sheets : []) + .map((sheet) => + typeof sheet === 'string' ? sheet : String(sheet?.name ?? ''), + ) + .filter((name) => name !== '') + return names.length >= 1 ? names : [...PROFILE_DEFAULTS.sheets] +} + +/** + * The name of the archive sheet: the profile's once the mapping has loaded, + * null when that profile names none (or names one of its source sheets), and + * the shipped name until then or when the mapping could not be loaded. + * + * @param {object|null} mapping The mapping endpoint's answer, or null + * @return {string|null} The sheet name, or null + * @spec openspec/changes/cmdb-import-mapping-view/specs/cmdb-export-import/spec.md#requirement-the-admin-settings-shall-offer-a-cmdb-import-section-req-cmdb-014 + */ +export function mappingArchiveSheet(mapping) { + const profile = mapping?.profile + if (!profile || typeof profile !== 'object' || !('archiveSheet' in profile)) { + return PROFILE_DEFAULTS.archiveSheet + } + return typeof profile.archiveSheet === 'string' && profile.archiveSheet !== '' + ? profile.archiveSheet + : null +} + +/** + * The sheet names as one quoted list: "A", "B", "C". + * + * @param {Array} names The sheet names + * @return {string} The list + * @spec openspec/changes/cmdb-import-mapping-view/specs/cmdb-export-import/spec.md#requirement-the-admin-settings-shall-offer-a-cmdb-import-section-req-cmdb-014 + */ +export function quotedSheetList(names) { + return names.map((name) => `"${name}"`).join(', ') +} + +/** + * The help text under the file chooser: which sheets the workbook needs and + * the default size limit. It names every sheet the profile reads, whatever + * their number, and does not depend on their order. + * + * @param {Array} names The sheet names, from mappingSheetNames() + * @param {number} maxFileBytes The default size limit in bytes + * @return {string} The text + * @spec openspec/changes/cmdb-import-mapping-view/specs/cmdb-export-import/spec.md#requirement-the-admin-settings-shall-offer-a-cmdb-import-section-req-cmdb-014 + */ +export function fileHelpText(names, maxFileBytes) { + const values = { + sheets: quotedSheetList(names), + size: formatMegabytes(maxFileBytes), + } + if (names.length === 1) { + return t( + 'stackiq', + 'Excel workbook (.xlsx) with the sheet {sheets}. By default the file may be at most {size}.', + values, + AS_TEXT, + ) + } + return t( + 'stackiq', + 'Excel workbook (.xlsx) with one of the sheets {sheets}. By default the file may be at most {size}.', + values, + AS_TEXT, + ) +} + +/** + * The sentence of the info panel that says which sheets are read: the source + * sheets, and of the archive sheet only its APPID column. + * + * @param {Array} names The sheet names, from mappingSheetNames() + * @param {string|null} [archive] The archive sheet, from mappingArchiveSheet(); the shipped name when left out, null when the profile names none + * @return {string} The text + * @spec openspec/changes/cmdb-import-mapping-view/specs/cmdb-export-import/spec.md#requirement-the-admin-settings-shall-offer-a-cmdb-import-section-req-cmdb-014 + * @spec openspec/changes/cmdb-import-archive-reconciliation/specs/cmdb-export-import/spec.md#requirement-the-admin-settings-shall-offer-a-cmdb-import-section-req-cmdb-014 + */ +export function sheetsReadText(names, archive = mappingArchiveSheet(null)) { + const values = { sheets: quotedSheetList(names), archive } + if (!archive) { + return names.length === 1 + ? t( + 'stackiq', + 'The sheet {sheets} is read; other sheets, including the "Invoer" sheets, are ignored.', + values, + AS_TEXT, + ) + : t( + 'stackiq', + 'The sheets {sheets} are read; other sheets, including the "Invoer" sheets, are ignored.', + values, + AS_TEXT, + ) + } + if (names.length === 1) { + return t( + 'stackiq', + 'The sheet {sheets} is read, and of the sheet "{archive}" only the APPID column; other sheets, including the "Invoer" sheets, are ignored.', + values, + AS_TEXT, + ) + } + return t( + 'stackiq', + 'The sheets {sheets} are read, and of the sheet "{archive}" only the APPID column; other sheets, including the "Invoer" sheets, are ignored.', + values, + AS_TEXT, + ) +} + +/** + * The info-panel paragraph on applications missing from the export: what an + * import that archives does with them, naming the archive sheet. + * + * Without an archive sheet the import only archives: it moves nothing to the + * trash, because the workbook cannot say which applications were archived on + * purpose. + * + * @param {string|null} [archive] The archive sheet, from mappingArchiveSheet(); the shipped name when left out, null when the profile names none + * @return {string} The text + * @spec openspec/changes/cmdb-import-archive-reconciliation/specs/cmdb-export-import/spec.md#requirement-an-application-missing-from-the-cmdb-sheets-shall-be-archived-when-the-archive-sheet-lists-it-and-soft-deleted-when-no-sheet-does-req-cmdb-015 + */ +export function missingApplicationsText(archive = mappingArchiveSheet(null)) { + if (!archive) { + return t( + 'stackiq', + 'An application of this municipality that is on no CMDB sheet any more is archived. It disappears from the lists, from OpenCatalogi and from Portaliq; one that returns in a later export is brought back. Choose Keep to leave such applications as they are.', + ) + } + return t( + 'stackiq', + 'An application of this municipality that is on no CMDB sheet any more is archived when the sheet "{archive}" lists it, and moved to the trash when no sheet does. Both disappear from the lists, from OpenCatalogi and from Portaliq; one that returns in a later export is brought back. When that sheet is missing, has no APPID column, or has an APPID without a cached value, applications are only archived and the result says so. Choose Keep to leave them as they are.', + { archive }, + AS_TEXT, + ) +} + +/** + * The words for a pack's target: what the pack's rows become. + * + * @param {string} target The target as the profile names it (module, manufacturer, …) + * @return {string} The translated name, or the target itself when it is unknown + * @spec openspec/changes/cmdb-import-mapping-view/specs/cmdb-export-import/spec.md#requirement-the-admin-settings-shall-show-the-mapping-the-import-uses-req-cmdb-020 + */ +export function packTargetLabel(target) { + switch (target) { + case 'module': + return t('stackiq', 'Application (module)') + case 'manufacturer': + return t('stackiq', 'Supplier organisation (Vendor)') + case 'usage': + return t('stackiq', 'Usage') + case 'businessOwner': + return t('stackiq', 'Business owner (contact person)') + default: + return String(target ?? '') + } +} + +/** + * The field mappings of a pack as rows of text: the column of the export, the + * field it goes to, whether a failing row is skipped without it, and what the + * pack does with the value (the transform's type; a lookup also its size). + * + * @param {object} pack One entry of the endpoint's `packs` + * @return {Array<{source: string, target: string, required: boolean, transform: string}>} One row per mapping, in the pack's order + * @spec openspec/changes/cmdb-import-mapping-view/specs/cmdb-export-import/spec.md#requirement-the-admin-settings-shall-show-the-mapping-the-import-uses-req-cmdb-020 + */ +export function packFieldRows(pack) { + const mappings = Array.isArray(pack?.fieldMappings) ? pack.fieldMappings : [] + return mappings.map((mapping) => { + const transform = mapping?.transform + let text = '' + if (typeof transform === 'string') { + text = transform + } else if (transform && typeof transform === 'object') { + text = String(transform.type ?? '') + if ( + text === 'lookup' + && transform.map + && typeof transform.map === 'object' + ) { + text += ' (' + Object.keys(transform.map).length + ')' + } + } + return { + source: String(mapping?.source ?? ''), + target: String(mapping?.target ?? ''), + required: mapping?.required === true, + transform: text, + } + }) +} + +/** + * The write rules of a pack as rows of text: the values it sets, and the + * fields written only on create or never on an existing record. A rule the + * pack does not have gives no row. + * + * @param {object} pack One entry of the endpoint's `packs` + * @return {Array<{key: string, label: string, values: Array}>} One row per rule that has values + * @spec openspec/changes/cmdb-import-mapping-view/specs/cmdb-export-import/spec.md#requirement-the-admin-settings-shall-show-the-mapping-the-import-uses-req-cmdb-020 + */ +export function packWriteRules(pack) { + const pairs = (value) => + value && typeof value === 'object' && !Array.isArray(value) + ? Object.entries(value).map( + ([key, val]) => + key + + ': ' + + (typeof val === 'string' ? val : JSON.stringify(val)), + ) + : [] + const list = (value) => (Array.isArray(value) ? value.map(String) : []) + return [ + { + key: 'defaults', + label: t('stackiq', 'Set on every record'), + values: pairs(pack?.defaults), + }, + { + key: 'createOnlyDefaults', + label: t('stackiq', 'Set on a new record only'), + values: pairs(pack?.createOnlyDefaults), + }, + { + key: 'createOnlyFields', + label: t( + 'stackiq', + 'Written on a new record, or on an existing one only when empty', + ), + values: list(pack?.createOnlyFields), + }, + { + key: 'neverWritten', + label: t('stackiq', 'Never written on an existing record'), + values: list(pack?.neverWritten), + }, + ].filter((rule) => rule.values.length > 0) +} + +/** + * The words for where the import takes a pack from: OpenRegister's pack + * store, or the file shipped with stackiq. + * + * @param {string} source The pack's `source` from the endpoint (`openregister` or `file`) + * @return {string} The translated name, or the source itself when it is unknown + * @spec openspec/changes/cmdb-import-mapping-view/specs/cmdb-export-import/spec.md#requirement-the-admin-settings-shall-show-the-mapping-the-import-uses-req-cmdb-020 + */ +export function packSourceLabel(source) { + switch (source) { + case 'openregister': + return t('stackiq', 'OpenRegister') + case 'file': + return t('stackiq', 'Shipped file') + default: + return String(source ?? '') + } +} + +/** + * The version of a pack as the import runs it: the stored version for a + * pack from OpenRegister, with the shipped version next to it when the two + * differ, and the shipped version for a pack read from the file. + * + * @param {object} pack One entry of the endpoint's `packs` + * @return {string} The text, empty when the pack names no version + * @spec openspec/changes/cmdb-import-mapping-view/specs/cmdb-export-import/spec.md#requirement-the-admin-settings-shall-show-the-mapping-the-import-uses-req-cmdb-020 + */ +export function packVersionText(pack) { + const shipped = String(pack?.shippedVersion ?? pack?.version ?? '') + const stored = String(pack?.storedVersion ?? '') + if (pack?.source === 'openregister' && stored !== '') { + if (shipped !== '' && shipped !== stored) { + return t( + 'stackiq', + 'Version {version} (shipped: {shipped})', + { version: stored, shipped }, + AS_TEXT, + ) + } + return t('stackiq', 'Version {version}', { version: stored }, AS_TEXT) + } + if (shipped === '') { + return '' + } + return t('stackiq', 'Version {version}', { version: shipped }, AS_TEXT) +} + +/** + * An editor address from the server, when the page may link to it: an + * http(s) or server-relative address. Anything else (a `javascript:` + * address, a protocol-relative one, no address at all) gives no link. + * + * @param {unknown} url The address the server gave + * @return {string|null} The address, or null for no link + * @spec openspec/changes/cmdb-import-mapping-view/specs/cmdb-export-import/spec.md#requirement-the-admin-settings-shall-show-the-mapping-the-import-uses-req-cmdb-020 + */ +export function editorUrl(url) { + if (typeof url !== 'string') { + return null + } + return /^(https?:\/\/|\/(?!\/))/i.test(url) ? url : null +} + +/** + * The address of OpenRegister's editor for a pack, when the page may link + * to it: the pack is editable and its address passes editorUrl(). + * + * @param {object} pack One entry of the endpoint's `packs` + * @return {string|null} The address, or null for no link + * @spec openspec/changes/cmdb-import-mapping-view/specs/cmdb-export-import/spec.md#requirement-the-admin-settings-shall-show-the-mapping-the-import-uses-req-cmdb-020 + */ +export function packEditUrl(pack) { + if (pack?.editable !== true) { + return null + } + return editorUrl(pack.editUrl) +} diff --git a/src/utils/cmdbImport.spec.js b/src/utils/cmdbImport.spec.js index 8f566d6cb..52f0a32a6 100644 --- a/src/utils/cmdbImport.spec.js +++ b/src/utils/cmdbImport.spec.js @@ -22,12 +22,16 @@ import { interruptedImportError, isKnownError, makeCmdbOperationId, + mappingArchiveSheet, + MISSING_RECORDS_MODES, + missingApplicationsText, municipalityOptions, normaliseError, outcomeLabel, OUTCOMES, PROFILE_DEFAULTS, reportRows, + sheetsReadText, sortReportRows, typedMunicipalityOption, } from './cmdbImport.js' @@ -58,6 +62,7 @@ const SERVER_CODES = [ 'SCHEMA_OUTDATED', 'IMPORT_IN_PROGRESS', 'MUNICIPALITY_AMBIGUOUS', + 'ARCHIVE_UNAVAILABLE', 'OPERATION_NOT_FOUND', 'IMPORT_INTERRUPTED', 'NOT_SIGNED_IN', @@ -198,10 +203,26 @@ describe('buildImportForm', () => { expect(form.get('municipalityUuid')).toBe('uuid-1') expect(form.has('municipalityName')).toBe(false) expect(form.get('updateExisting')).toBe('true') - expect(form.get('missingRecords')).toBe('keep') + expect(form.get('missingRecords')).toBe('archive') expect(form.get('operationId')).toBe('cmdb-abcdefgh') }) + it('sends the choice for applications missing from the export, archive by default', () => { + const options = { + file, + municipality: { uuid: 'uuid-1', name: 'Tilburg' }, + updateExisting: true, + operationId: 'cmdb-abcdefgh', + } + expect(MISSING_RECORDS_MODES).toEqual(['archive', 'keep']) + expect(buildImportForm(options).get('missingRecords')).toBe('archive') + expect( + buildImportForm({ ...options, missingRecords: 'keep' }).get( + 'missingRecords', + ), + ).toBe('keep') + }) + it('sends a typed new municipality by name, and updateExisting as an explicit false', () => { const form = buildImportForm({ file, @@ -363,12 +384,51 @@ describe('errorText', () => { error: 'NO_SOURCE_SHEET', details: { expected: ['Blad A', 'Blad B'] }, }).hint, - ).toContain('"Blad A" or "Blad B"') + ).toContain('one of the sheets "Blad A", "Blad B"') expect(errorText({ error: 'NO_SOURCE_SHEET', details: {} }).hint).toContain( - PROFILE_DEFAULTS.sheets[1], + '"' + PROFILE_DEFAULTS.sheets.join('", "') + '"', ) }) + it.each([ + [1, ['Blad A'], 'Expected the sheet "Blad A".'], + [ + 3, + ['Blad A', 'Blad B', 'Blad C'], + 'one of the sheets "Blad A", "Blad B", "Blad C".', + ], + ])( + 'names all %i sheets of the profile in the missing-sheet and too-large hints', + (count, names, expected) => { + const quoted = names.map((name) => '"' + name + '"').join(', ') + + const missing = errorText( + { error: 'NO_SOURCE_SHEET', details: {} }, + names, + ) + expect(missing.hint).toContain(expected) + for (const shipped of PROFILE_DEFAULTS.sheets) { + expect(missing.hint).not.toContain(shipped) + } + + const tooLarge = errorText( + { + error: 'WORKBOOK_TOO_LARGE', + details: { maxSharedStrings: 200000 }, + }, + names, + ) + expect(tooLarge.hint).toContain( + '(it reads ' + + quoted + + ', and the APPID column of "Gearchiveerde Applicaties")', + ) + for (const shipped of PROFILE_DEFAULTS.sheets) { + expect(tooLarge.hint).not.toContain(shipped) + } + }, + ) + it('names the unpacked size limit the server applied', () => { expect( errorText({ @@ -395,7 +455,7 @@ describe('errorText', () => { 'The sheet "Beheerde Applicaties CMDB" is too large to import: unpacked it is 14.3 MB, and the import reads at most 10 MB of one sheet.', ) expect(words.hint).toBe( - 'An .xlsx file is compressed, so a file of a few MB can be much larger once unpacked. Nothing was imported. Split the rows over two copies of the export and import them one after the other.', + 'An .xlsx file is compressed, so a file of a few MB can be much larger once unpacked. Nothing was imported. Split the rows over two copies of the export and import both with "Keep them as they are": an import that archives treats the applications of the other copy as missing.', ) }) @@ -408,11 +468,29 @@ describe('errorText', () => { expect( errorText({ error: 'WORKBOOK_TOO_LARGE', details }).hint, ).toContain( - '(it reads only "Onbeh Applicaties CMDB" and "Beheerde Applicaties CMDB")', + '(it reads "Onbeh Applicaties CMDB", "Beheerde Applicaties CMDB", and the APPID column of "Gearchiveerde Applicaties")', ) } }) + it('names the archive sheet the profile names in the too-large hint, and none when it names none', () => { + const details = { maxUncompressedBytes: 50 * 1024 * 1024 } + expect( + errorText( + { error: 'WORKBOOK_TOO_LARGE', details }, + ['Blad A'], + 'Archief', + ).hint, + ).toContain('(it reads "Blad A", and the APPID column of "Archief")') + const without = errorText( + { error: 'WORKBOOK_TOO_LARGE', details }, + ['Blad A'], + null, + ).hint + expect(without).toContain('(it reads only "Blad A")') + expect(without).not.toContain('APPID') + }) + it('names the part limit and the part, the shared-strings limit or the referenced-text limit the server applied', () => { expect( errorText({ @@ -485,6 +563,53 @@ describe('errorText', () => { }) }) +/** + * @spec openspec/changes/cmdb-import-mapping-view/specs/cmdb-export-import/spec.md#requirement-the-admin-settings-shall-offer-a-cmdb-import-section-req-cmdb-014 + */ +describe('the archive sheet in the help texts', () => { + it("takes the profile's archive sheet once the mapping has loaded, and the shipped one until then", () => { + expect(mappingArchiveSheet(null)).toBe(PROFILE_DEFAULTS.archiveSheet) + expect(mappingArchiveSheet({ profile: { sheets: [] } })).toBe( + PROFILE_DEFAULTS.archiveSheet, + ) + expect(mappingArchiveSheet({ profile: { archiveSheet: 'Archief' } })).toBe( + 'Archief', + ) + expect(mappingArchiveSheet({ profile: { archiveSheet: null } })).toBeNull() + expect(mappingArchiveSheet({ profile: { archiveSheet: '' } })).toBeNull() + }) + + it('says only the APPID column of the archive sheet is read, and leaves it out when the profile names none', () => { + expect(sheetsReadText(['Blad A', 'Blad B'], 'Archief')).toBe( + 'The sheets "Blad A", "Blad B" are read, and of the sheet "Archief" only the APPID column; other sheets, including the "Invoer" sheets, are ignored.', + ) + expect(sheetsReadText(['Blad A'], 'Archief')).toContain( + 'The sheet "Blad A" is read, and of the sheet "Archief" only the APPID column', + ) + const without = sheetsReadText(['Blad A', 'Blad B'], null) + expect(without).toBe( + 'The sheets "Blad A", "Blad B" are read; other sheets, including the "Invoer" sheets, are ignored.', + ) + expect(sheetsReadText(['Blad A'], null)).not.toContain('APPID') + expect(sheetsReadText(['Blad A'])).toContain( + `"${PROFILE_DEFAULTS.archiveSheet}" only the APPID column`, + ) + }) + + it('names the archive sheet in the missing-applications paragraph, and says the import only archives without one', () => { + const withArchive = missingApplicationsText('Archief') + expect(withArchive).toContain('archived when the sheet "Archief" lists it') + expect(withArchive).toContain('moved to the trash') + const without = missingApplicationsText(null) + expect(without).not.toContain('trash') + expect(without).not.toContain('sheet "') + expect(without).toContain('is archived.') + expect(missingApplicationsText()).toContain( + `the sheet "${PROFILE_DEFAULTS.archiveSheet}" lists it`, + ) + }) +}) + describe('formatMegabytes', () => { it('shows whole and fractional megabytes', () => { expect(formatMegabytes(10 * 1024 * 1024)).toBe('10 MB') @@ -642,6 +767,44 @@ describe('cmdbProgressView', () => { ).toEqual({ percentage: 25, detail: '1 of 4 rows processed' }) }) + it('says the import checks the applications, without counting them as rows', () => { + // The service reports rows + the municipality's applications as the total. + const view = cmdbProgressView({ + phase: 'reconciling', + processed_items: 400, + total_items: 810, + }) + expect(view.detail).toBe( + 'Checking the applications of this municipality against the export', + ) + expect(view.detail).not.toMatch(/\d/) + }) + + it('does not let the bar fall when the phase changes from the rows to the comparison', () => { + const lastOfTheRows = cmdbProgressView({ + phase: 'importing', + processed_items: 400, + total_items: 400, + }) + const firstOfTheComparison = cmdbProgressView({ + phase: 'reconciling', + processed_items: 400, + total_items: 810, + }) + const midComparison = cmdbProgressView({ + phase: 'reconciling', + processed_items: 600, + total_items: 810, + }) + expect(lastOfTheRows.percentage).toBe(100) + expect(firstOfTheComparison.percentage).toBeGreaterThanOrEqual( + lastOfTheRows.percentage, + ) + expect(midComparison.percentage).toBeGreaterThanOrEqual( + lastOfTheRows.percentage, + ) + }) + it('shows nothing before any progress', () => { expect(cmdbProgressView(null)).toBeNull() }) @@ -683,6 +846,31 @@ describe('the report table', () => { expect(reportRows(null)).toEqual([]) }) + it('shows no row number for an application archived or deleted after the rows', () => { + const [row] = reportRows([ + { + sheet: 'Gearchiveerde Applicaties', + row: 0, + appId: '7', + name: 'Zeven', + outcome: 'archived', + reasons: [], + warnings: [], + moduleUuid: 'm-7', + }, + ]) + expect(row.row).toBe('') + expect(outcomeLabel('archived')).toBe('Archived') + expect(OUTCOMES).toEqual( + expect.arrayContaining([ + 'archived', + 'unarchived', + 'deleted', + 'restored', + ]), + ) + }) + it('sorts numbers by value and keeps the report order for ties', () => { const rows = [ { key: 'a', row: 10, sheet: 'B' }, diff --git a/src/views/FacetedCatalogIndexView.vue b/src/views/FacetedCatalogIndexView.vue index 40c15b9e0..31f1bd587 100644 --- a/src/views/FacetedCatalogIndexView.vue +++ b/src/views/FacetedCatalogIndexView.vue @@ -81,6 +81,18 @@ generic route-query-to-filter passthrough never sees it (see the +

+ {{ + t( + 'stackiq', + 'This tab lists the whole archive. It ignores the GEMMA filters.', + ) + }} +

+
+ @view="openDetail" + @quickFilterChange="onQuickFilterChange" />
@@ -142,6 +155,21 @@ const DIMENSION_LABELS = { domain: () => t('stackiq', 'Domain'), } +/** + * The tab CnIndexPage starts on: the first quick filter marked `default`, + * else the first one (the library's own rule in `useSelfFetchList.js`). + * + * @param {Array|null} quickFilters The quick filters + * @return {number|null} The index, or null without quick filters + */ +function initialQuickFilterIndex(quickFilters) { + if (!Array.isArray(quickFilters) || quickFilters.length === 0) { + return null + } + const index = quickFilters.findIndex((tab) => tab && tab.default === true) + return index >= 0 ? index : 0 +} + /** Debounce delay (ms) between search keystrokes and the facets refetch. */ const SEARCH_DEBOUNCE_MS = 400 @@ -223,7 +251,21 @@ export default { * filter's keys (`bbnLevel`, `dpiaStatus`, …) never collide with * `_ids`, so the merge is additive — both the facet-matched id set AND * the active quick filter's field constraints apply together - * (logical AND), never clobbering one another. + * (logical AND), never clobbering one another. The one exception is + * the Archived tab of the Applications page, below. + * + * The exception is the Archived tab of the Applications page + * (cmdb-import-archive-reconciliation): the facet id set is built from + * the working set, which OpenRegister's default lens limits to objects + * that are not archived, so ANDing `_ids` with `_archived=true` could + * never match an archived application. That tab's filter therefore + * carries an empty-string `_ids` (not an empty array, which the filter + * resolver drops before the merge), which wins over this view's `_ids` + * and which the request leaves out: the tab lists the whole archive + * and ignores the GEMMA selection. The search term still applies, + * because the list sends it as `_search`, outside the filter. The tab's + * filter, not this view, owns that, so it holds however the page's + * tab state is restored. */ quickFilters: { type: Array, @@ -270,6 +312,7 @@ export default { showSaveViewModal: false, savingView: false, searchDebounceTimer: null, + activeQuickFilterIndex: initialQuickFilterIndex(this.quickFilters), listRemount: 0, } }, @@ -319,6 +362,21 @@ export default { ) }, + /** + * Whether the active quick-filter tab drops the facet id set: a tab + * whose filter carries the empty-string `_ids` override (the Archived + * tab, see the `quickFilters` prop). The facet sidebar stays on + * screen, so the page says so. The search term still applies: the + * list sends it as `_search`, outside the filter. + * + * @return {boolean} True while such a tab is active. + * @spec openspec/changes/cmdb-import-archive-reconciliation/specs/cmdb-export-import/spec.md#requirement-archived-applications-and-usages-shall-be-listable-in-stackiq-and-shall-stay-out-of-opencatalogi-and-portaliq-by-default-req-cmdb-017 + */ + archivedTabIgnoresFilters() { + const tab = (this.quickFilters ?? [])[this.activeQuickFilterIndex] + return tab?.filter?._ids === '' + }, + /** * Remount key for `CnIndexPage`. A change of the `filter` prop needs * no remount: the self-fetch list watches it and refetches (2.65.0 and @@ -335,6 +393,19 @@ export default { }, }, + watch: { + /** + * CnIndexPage is remounted when the key changes and starts on its + * default tab again, so the tab this view remembers goes back to it. + * + * @return {void} + * @spec openspec/changes/cmdb-import-archive-reconciliation/specs/cmdb-export-import/spec.md#requirement-archived-applications-and-usages-shall-be-listable-in-stackiq-and-shall-stay-out-of-opencatalogi-and-portaliq-by-default-req-cmdb-017 + */ + indexPageKey() { + this.activeQuickFilterIndex = initialQuickFilterIndex(this.quickFilters) + }, + }, + /** * Restore the facet selection and the search term from the route. * @@ -383,6 +454,19 @@ export default { }, methods: { + /** + * Remember which quick-filter tab is active (single-select mode emits the + * tab index; multi-select emits an array, which never selects the + * Archived tab here). + * + * @param {number|number[]} index The tab index, or the selected indices + * @return {void} + * @spec openspec/changes/cmdb-import-archive-reconciliation/specs/cmdb-export-import/spec.md#requirement-archived-applications-and-usages-shall-be-listable-in-stackiq-and-shall-stay-out-of-opencatalogi-and-portaliq-by-default-req-cmdb-017 + */ + onQuickFilterChange(index) { + this.activeQuickFilterIndex = Number.isInteger(index) ? index : null + }, + /** * Open the detail page of a clicked row, or of the row whose View action was used. * @@ -557,6 +641,13 @@ export default { padding: calc(var(--default-grid-baseline, 8px) * 2); } +.faceted-catalog-index__archive-note { + color: var(--color-text-maxcontrast); + margin: 0; + padding: 0 calc(var(--default-grid-baseline, 8px) * 2) + calc(var(--default-grid-baseline, 8px) * 2); +} + .faceted-catalog-index__body { display: flex; align-items: flex-start; diff --git a/src/views/settings/sections/CmdbImport.spec.js b/src/views/settings/sections/CmdbImport.spec.js index 931f7edbc..a7a64a7c7 100644 --- a/src/views/settings/sections/CmdbImport.spec.js +++ b/src/views/settings/sections/CmdbImport.spec.js @@ -9,8 +9,10 @@ */ import axios from '@nextcloud/axios' -import { flushPromises, shallowMount } from '@vue/test-utils' +import { flushPromises, mount, shallowMount } from '@vue/test-utils' +import { h } from 'vue' import CmdbImport from './CmdbImport.vue' +import CmdbImportMapping from './CmdbImportMapping.vue' // Virtual: the package's `exports` field declares only the `import` condition, which jest does not resolve. jest.mock( @@ -26,25 +28,90 @@ jest.mock('@nextcloud/router', () => ({ url.replace(/{(\w+)}/g, (match, key) => String(params[key] ?? match)), generateOcsUrl: (url) => url, })) -// The component libraries are stubbed by shallowMount; virtual for the same `exports` reason. +// The component libraries are stubbed; virtual for the same `exports` reason. +// shallowMount replaces them with empty stubs. The ones below also render what +// the tests that mount the section for real (`mountFull`) need to see: the +// slots, the radio's value and the table's cell slots. jest.mock( '@nextcloud/vue', - () => ({ - NcButton: { render: () => null }, - NcCheckboxRadioSwitch: { render: () => null }, - NcLoadingIcon: { render: () => null }, - NcNoteCard: { render: () => null }, - NcProgressBar: { render: () => null }, - NcSelect: { render: () => null }, - }), + () => { + const { h } = require('vue') + const withSlot = { + render() { + return h('div', this.$slots.default?.()) + }, + } + return { + NcButton: { + render() { + return h('button', this.$slots.default?.()) + }, + }, + NcCheckboxRadioSwitch: { + props: { + modelValue: { default: null }, + value: { default: null }, + name: { default: '' }, + type: { default: 'checkbox' }, + disabled: { default: false }, + }, + emits: ['update:modelValue'], + render() { + const radio = this.type === 'radio' + return h('label', [ + h('input', { + type: radio ? 'radio' : 'checkbox', + name: this.name, + value: this.value, + disabled: this.disabled, + checked: radio + ? this.modelValue === this.value + : Boolean(this.modelValue), + onChange: (event) => + this.$emit( + 'update:modelValue', + radio ? this.value : event.target.checked, + ), + }), + this.$slots.default?.(), + ]) + }, + }, + NcLoadingIcon: { render: () => null }, + NcNoteCard: withSlot, + NcProgressBar: { render: () => null }, + NcSelect: { render: () => null }, + } + }, { virtual: true }, ) jest.mock( '@conduction/nextcloud-vue', - () => ({ - CnDataTable: { render: () => null }, - CnStatusBadge: { render: () => null }, - }), + () => { + const { h } = require('vue') + return { + // One element per row, with the cell slots the section fills. + CnDataTable: { + props: { rows: { default: () => [] } }, + render() { + return h( + 'div', + this.rows.map((row) => + h('div', { 'data-testid': 'table-row' }, [ + h( + 'span', + { 'data-testid': 'table-row-number' }, + this.$slots['column-row']?.({ row }), + ), + h('span', this.$slots['column-name']?.({ row })), + ]), + ), + ) + }, + }, + CnStatusBadge: { render: () => null }, + } + }, { virtual: true }, ) // The icon SFCs live in node_modules, which jest does not transform. @@ -55,9 +122,23 @@ jest.mock('vue-material-design-icons/DatabaseImport.vue', () => ({ jest.mock('vue-material-design-icons/TrayArrowUp.vue', () => ({ render: () => null, })) -jest.mock('../../../components/AlwaysVisibleSection.vue', () => ({ +jest.mock('vue-material-design-icons/ChevronDown.vue', () => ({ + render: () => null, +})) +jest.mock('vue-material-design-icons/ChevronUp.vue', () => ({ render: () => null, })) +jest.mock('vue-material-design-icons/OpenInNew.vue', () => ({ + render: () => null, +})) +jest.mock('../../../components/AlwaysVisibleSection.vue', () => { + const { h } = require('vue') + return { + render() { + return h('div', this.$slots.default?.()) + }, + } +}) const ORGANISATIONS = [ { @@ -91,7 +172,7 @@ const ORGANISATIONS = [ * * @return {Promise} The wrapper, after the municipalities loaded */ -async function mountSection() { +async function mountSection(options = {}) { axios.get.mockImplementation((url) => Promise.resolve( url.includes('/voorzieningen/config') @@ -99,7 +180,25 @@ async function mountSection() { : { data: { results: ORGANISATIONS } }, ), ) - const wrapper = shallowMount(CmdbImport) + const wrapper = shallowMount(CmdbImport, options) + await flushPromises() + return wrapper +} + +/** + * Mount the section with its child components rendering what the tests read. + * + * @return {Promise} The wrapper, after the municipalities loaded + */ +async function mountFull() { + axios.get.mockImplementation((url) => + Promise.resolve( + url.includes('/voorzieningen/config') + ? { data: { config: { register: 7, organisatie_schema: 33 } } } + : { data: { results: ORGANISATIONS } }, + ), + ) + const wrapper = mount(CmdbImport) await flushPromises() return wrapper } @@ -147,3 +246,496 @@ describe('CmdbImport municipality chooser', () => { expect(wrapper.vm.report).toBe(null) }) }) + +// shallowMount stubs the section's wrapper without its slots; this one renders them, so the help text and the info panel are in the DOM. +const SLOT_RENDERING_SECTION = { + render() { + return h('div', [this.$slots.default?.(), this.$slots['info-content']?.()]) + }, +} + +/** + * Mount the section with the wrapper rendering its slots. + * + * @return {Promise} The wrapper + */ +function mountWithSlots() { + return mountSection({ + global: { stubs: { AlwaysVisibleSection: SLOT_RENDERING_SECTION } }, + }) +} + +describe('CmdbImport sheet names in the help texts', () => { + afterEach(() => { + jest.clearAllMocks() + }) + + const SHIPPED = ['Onbeh Applicaties CMDB', 'Beheerde Applicaties CMDB'] + + /** + * The mapping endpoint's answer for a profile with the given sheets. + * + * @param {Array} names The sheet names + * @return {object} The answer, reduced to what the section reads + */ + function mappingOf(names) { + return { + profile: { sheets: names.map((name) => ({ name })) }, + packs: [], + } + } + + /** + * The help text under the file chooser and the info panel's sheet sentence. + * + * @param {object} wrapper The mounted section + * @return {{help: string, info: string}} Both texts, as rendered + */ + function renderedTexts(wrapper) { + return { + help: wrapper.find('#cmdb-import-file-help').text(), + info: wrapper + .findAll('.cmdb-import-info li') + .map((li) => li.text()) + .find((text) => /sheets? .* (is|are) read/.test(text)), + } + } + + it('names the shipped sheets until the mapping block has loaded', async () => { + const wrapper = await mountWithSlots() + + const { help, info } = renderedTexts(wrapper) + expect(help).toContain('"' + SHIPPED[0] + '", "' + SHIPPED[1] + '"') + expect(info).toContain('"' + SHIPPED[0] + '", "' + SHIPPED[1] + '"') + }) + + it('names the sheets the mapping block emits, in the help text and the info panel', async () => { + const wrapper = await mountWithSlots() + + wrapper + .findComponent(CmdbImportMapping) + .vm.$emit('loaded', mappingOf(['Alpha', 'Beta', 'Gamma'])) + await flushPromises() + + const { help, info } = renderedTexts(wrapper) + expect(help).toContain('"Alpha", "Beta", "Gamma"') + expect(info).toContain('"Alpha", "Beta", "Gamma"') + for (const shipped of SHIPPED) { + expect(help).not.toContain(shipped) + expect(info).not.toContain(shipped) + } + }) + + it('names only the one sheet of a profile with one sheet', async () => { + const wrapper = await mountWithSlots() + + wrapper + .findComponent(CmdbImportMapping) + .vm.$emit('loaded', mappingOf(['Alpha'])) + await flushPromises() + + const { help, info } = renderedTexts(wrapper) + expect(help).toContain('with the sheet "Alpha".') + expect(info).toContain('The sheet "Alpha" is read') + for (const shipped of SHIPPED) { + expect(help).not.toContain(shipped) + } + }) + + it("names the profile's archive sheet in the info panel, and no archive sheet when the profile names none", async () => { + const wrapper = await mountWithSlots() + const mapping = (archiveSheet) => ({ + ...mappingOf(['Alpha', 'Beta']), + profile: { ...mappingOf(['Alpha', 'Beta']).profile, archiveSheet }, + }) + + expect(renderedTexts(wrapper).info).toContain( + 'of the sheet "Gearchiveerde Applicaties" only the APPID column', + ) + + wrapper + .findComponent(CmdbImportMapping) + .vm.$emit('loaded', mapping('Archief')) + await flushPromises() + expect(renderedTexts(wrapper).info).toContain( + 'The sheets "Alpha", "Beta" are read, and of the sheet "Archief" only the APPID column', + ) + expect(wrapper.find('.cmdb-import-info').text()).toContain( + 'archived when the sheet "Archief" lists it', + ) + const tooLarge = { + error: 'WORKBOOK_TOO_LARGE', + details: { maxUncompressedBytes: 50 * 1024 * 1024 }, + } + await wrapper.setData({ error: tooLarge }) + expect(wrapper.vm.errorView.hint).toContain( + '(it reads "Alpha", "Beta", and the APPID column of "Archief")', + ) + await wrapper.setData({ error: null }) + + wrapper.findComponent(CmdbImportMapping).vm.$emit('loaded', mapping(null)) + await flushPromises() + const info = renderedTexts(wrapper).info + expect(info).toContain('The sheets "Alpha", "Beta" are read;') + expect(info).not.toContain('APPID') + const panel = wrapper.find('.cmdb-import-info').text() + expect(panel).not.toContain('Gearchiveerde Applicaties') + expect(panel).not.toContain('moved to the trash') + await wrapper.setData({ error: tooLarge }) + expect(wrapper.vm.errorView.hint).toContain( + '(it reads only "Alpha", "Beta")', + ) + expect(wrapper.vm.errorView.hint).not.toContain('APPID') + }) + + it("names the profile's sheets in the section's missing-sheet and too-large errors", async () => { + const wrapper = await mountWithSlots() + wrapper + .findComponent(CmdbImportMapping) + .vm.$emit('loaded', mappingOf(['Alpha', 'Beta', 'Gamma'])) + await flushPromises() + + await wrapper.setData({ error: { error: 'NO_SOURCE_SHEET', details: {} } }) + expect(wrapper.vm.errorView.hint).toContain('"Alpha", "Beta", "Gamma"') + + await wrapper.setData({ + error: { + error: 'WORKBOOK_TOO_LARGE', + details: { maxUncompressedBytes: 50 * 1024 * 1024 }, + }, + }) + expect(wrapper.vm.errorView.hint).toContain( + '(it reads "Alpha", "Beta", "Gamma", and the APPID column of "Gearchiveerde Applicaties")', + ) + }) +}) + +/** + * @spec openspec/changes/cmdb-import-archive-reconciliation/specs/cmdb-export-import/spec.md#requirement-the-admin-settings-shall-offer-a-cmdb-import-section-req-cmdb-014 + */ +describe('CmdbImport applications missing from the export', () => { + afterEach(() => { + jest.clearAllMocks() + }) + + it('archives by default and posts the choice the admin made', async () => { + const wrapper = await mountSection() + axios.post.mockResolvedValue({ + data: { success: true, summary: {}, rows: [] }, + }) + wrapper.vm.municipality = wrapper.vm.municipalityOptions[0] + wrapper.vm.selectedFile = new File(['x'], 'export.xlsx') + + expect(wrapper.vm.missingRecords).toBe('archive') + await wrapper.vm.startImport() + wrapper.vm.missingRecords = 'keep' + await wrapper.vm.startImport() + + expect( + axios.post.mock.calls.map(([, form]) => form.get('missingRecords')), + ).toEqual(['archive', 'keep']) + }) + + it('shows the archived, unarchived, deleted and restored counts only when there are any', async () => { + const wrapper = await mountSection() + const tileKeys = () => wrapper.vm.summaryTiles.map((tile) => tile.key) + + wrapper.vm.report = { summary: { rowsRead: 2, created: 2 }, rows: [] } + expect(tileKeys()).not.toContain('archived') + + wrapper.vm.report = { + summary: { + rowsRead: 1, + archived: 1, + deleted: 1, + unarchived: 0, + restored: 2, + }, + rows: [], + } + expect(tileKeys()).toEqual( + expect.arrayContaining(['archived', 'deleted', 'restored']), + ) + expect(tileKeys()).not.toContain('unarchived') + expect(wrapper.vm.outcomeFilterOptions.map((option) => option.id)).toEqual( + expect.arrayContaining([ + 'archived', + 'unarchived', + 'deleted', + 'restored', + ]), + ) + }) +}) + +/** + * @spec openspec/changes/cmdb-export-import/specs/cmdb-export-import/spec.md#requirement-a-running-import-shall-report-its-progress-and-shall-stop-when-cancelled-req-cmdb-013 + */ +describe('CmdbImport cancelling', () => { + afterEach(() => { + jest.clearAllMocks() + }) + + it('says after Cancel that the comparison of the applications stops before the next application', async () => { + const wrapper = await mountFull() + axios.post.mockResolvedValue({ data: { success: true } }) + await wrapper.setData({ + importing: true, + operationId: 'cmdb-12345678', + progress: { + phase: 'reconciling', + processed_items: 400, + total_items: 810, + }, + }) + + await wrapper.vm.cancelImport() + await flushPromises() + + const status = wrapper + .find('[data-testid="cmdb-import-cancel-status"]') + .text() + expect(status).toContain('before the next row') + expect(status).toContain('before the next application') + }) + + it('says that the applications processed before the stop are kept, not only rows', async () => { + const wrapper = await mountFull() + + await wrapper.setData({ + report: { + cancelled: true, + summary: { rowsRead: 400, archived: 3 }, + rows: [], + }, + }) + + expect(wrapper.find('[data-testid="cmdb-import-cancelled"]').text()).toMatch( + /applications/, + ) + }) +}) + +/** + * @spec openspec/changes/cmdb-import-archive-reconciliation/specs/cmdb-export-import/spec.md#requirement-the-admin-settings-shall-offer-a-cmdb-import-section-req-cmdb-014 + */ +describe('CmdbImport finished announcement', () => { + afterEach(() => { + jest.clearAllMocks() + }) + + it('names the archived and deleted applications in the sentence the live region announces', async () => { + const wrapper = await mountFull() + + await wrapper.setData({ + report: { + municipality: { name: 'Gemeente Bergen' }, + summary: { rowsRead: 0, archived: 1, deleted: 1 }, + rows: [], + }, + }) + + const announced = wrapper.find('[data-testid="cmdb-import-finished"]').text() + expect(announced).toContain('0 rows read') + expect(announced).toContain('1 archived') + expect(announced).toContain('1 deleted') + expect(announced).not.toContain('unarchived') + expect(announced).not.toContain('restored') + }) + + it('names every kind of change after a cancel too, and adds nothing when no application was touched', async () => { + const wrapper = await mountFull() + + await wrapper.setData({ + report: { + cancelled: true, + municipality: { name: 'Gemeente Bergen' }, + summary: { + rowsRead: 5, + archived: 2, + unarchived: 3, + deleted: 4, + restored: 5, + }, + rows: [], + }, + }) + expect(wrapper.vm.finishedText).toBe( + 'Import for Gemeente Bergen cancelled after 5 rows. Applications: 2 archived, 3 unarchived, 4 deleted, 5 restored.', + ) + + // setData merges into the report; a new report replaces it. + wrapper.vm.report = { + municipality: { name: 'Gemeente Bergen' }, + summary: { rowsRead: 2, created: 2 }, + rows: [], + } + expect(wrapper.vm.finishedText).toBe( + 'Import for Gemeente Bergen finished. 2 rows read: 2 created, 0 updated, 0 unchanged.', + ) + }) +}) + +/** + * @spec openspec/changes/cmdb-import-archive-reconciliation/specs/cmdb-export-import/spec.md#requirement-the-admin-settings-shall-offer-a-cmdb-import-section-req-cmdb-014 + */ +describe('CmdbImport the choice for missing applications, as the admin makes it', () => { + afterEach(() => { + jest.clearAllMocks() + }) + + const radio = (wrapper, which) => + wrapper.find(`[data-testid="cmdb-import-missing-records-${which}"] input`) + + it('starts on "Archive or delete them" and the radios share one name', async () => { + const wrapper = await mountFull() + + expect(radio(wrapper, 'archive').element.checked).toBe(true) + expect(radio(wrapper, 'keep').element.checked).toBe(false) + expect(radio(wrapper, 'archive').attributes('name')).toBe( + radio(wrapper, 'keep').attributes('name'), + ) + expect(radio(wrapper, 'archive').attributes('value')).toBe('archive') + expect(radio(wrapper, 'keep').attributes('value')).toBe('keep') + }) + + it('posts missingRecords=keep after the admin clicks "Keep them as they are", and only that field changes', async () => { + const wrapper = await mountFull() + axios.post.mockResolvedValue({ + data: { success: true, summary: {}, rows: [] }, + }) + wrapper.vm.municipality = wrapper.vm.municipalityOptions[0] + wrapper.vm.selectedFile = new File(['x'], 'export.xlsx') + + await radio(wrapper, 'keep').setValue(true) + await flushPromises() + + expect(wrapper.vm.missingRecords).toBe('keep') + expect(radio(wrapper, 'keep').element.checked).toBe(true) + expect(radio(wrapper, 'archive').element.checked).toBe(false) + // The choice is not wired to another option: they keep their defaults. + expect(wrapper.vm.publish).toBe(true) + expect(wrapper.vm.updateExisting).toBe(true) + + await wrapper.vm.startImport() + const form = axios.post.mock.calls[0][1] + expect(form.get('missingRecords')).toBe('keep') + + await radio(wrapper, 'archive').setValue(true) + expect(wrapper.vm.missingRecords).toBe('archive') + }) + + it('says in short what happens, and in the info panel when applications are only archived', async () => { + const wrapper = await mountFull() + + const help = wrapper.get('#cmdb-import-missing-records-help').text() + expect(help).toContain('archived or moved to the trash') + + // The info panel is the section's `info-content` slot; render it. + const panel = mount(CmdbImport, { + global: { + stubs: { + AlwaysVisibleSection: { + render() { + return h('div', [this.$slots['info-content']?.()]) + }, + }, + }, + }, + }) + await flushPromises() + const text = panel.text() + expect(text).toContain('is missing') + expect(text).toContain('has no APPID column') + expect(text).toContain('an APPID without a cached value') + expect(text).toContain('only archived') + }) + + it('disables both radios while an import runs', async () => { + const wrapper = await mountFull() + + await wrapper.setData({ importing: true }) + + expect(radio(wrapper, 'archive').attributes('disabled')).toBeDefined() + expect(radio(wrapper, 'keep').attributes('disabled')).toBeDefined() + }) +}) + +/** + * @spec openspec/changes/cmdb-import-archive-reconciliation/specs/cmdb-export-import/spec.md#requirement-the-admin-settings-shall-offer-a-cmdb-import-section-req-cmdb-014 + */ +describe('CmdbImport report rows of archived and deleted applications', () => { + afterEach(() => { + jest.clearAllMocks() + }) + + const reconciliationRow = (outcome, extra = {}) => ({ + sheet: 'Gearchiveerde Applicaties', + row: 0, + appId: outcome === 'deleted' ? '2' : '1234', + name: outcome === 'deleted' ? 'Naamtest' : 'Mailen', + outcome, + moduleUuid: 'module-uuid-' + outcome, + ...extra, + }) + + it('links an archived application to its module, and a deleted one to nothing', async () => { + const wrapper = await mountFull() + + await wrapper.setData({ + report: { + summary: { rowsRead: 0, archived: 1, deleted: 1 }, + rows: [reconciliationRow('archived'), reconciliationRow('deleted')], + }, + }) + + const rows = wrapper.findAll('[data-testid="table-row"]') + expect(rows).toHaveLength(2) + const [archived, deleted] = rows + expect( + archived + .find('[data-testid="cmdb-import-module-link"]') + .attributes('href'), + ).toBe('/apps/stackiq/modules/module-uuid-archived') + expect( + deleted.find('[data-testid="cmdb-import-module-link"]').exists(), + ).toBe(false) + // The name of the deleted application is still shown, as text. + expect(deleted.text()).toContain('Naamtest') + }) + + it('shows no row number for a reconciliation row, and links one that failed', async () => { + const wrapper = await mountFull() + + await wrapper.setData({ + report: { + summary: { rowsRead: 1, failed: 1, archived: 1 }, + rows: [ + reconciliationRow('failed', { + reasons: ['archive: RuntimeException'], + }), + reconciliationRow('archived'), + { + sheet: 'Beheerde Applicaties CMDB', + row: 2, + appId: '5', + name: 'Gewoon', + outcome: 'created', + moduleUuid: 'module-uuid-created', + }, + ], + }, + }) + + const rows = wrapper.findAll('[data-testid="table-row"]') + expect( + rows.map((row) => row.get('[data-testid="table-row-number"]').text()), + ).toEqual(['', '', '2']) + expect( + rows[0].find('[data-testid="cmdb-import-module-link"]').exists(), + ).toBe(true) + expect( + rows[2].find('[data-testid="cmdb-import-module-link"]').exists(), + ).toBe(true) + }) +}) diff --git a/src/views/settings/sections/CmdbImport.vue b/src/views/settings/sections/CmdbImport.vue index f8bbc1e4b..b552150fd 100644 --- a/src/views/settings/sections/CmdbImport.vue +++ b/src/views/settings/sections/CmdbImport.vue @@ -47,7 +47,7 @@ {{ t( 'stackiq', - 'Pick an existing organisation of type Municipality, or type a new name and press Enter.', + 'Choose a municipality, or type a new name and press Enter.', ) }}

@@ -84,18 +84,7 @@ }}

- {{ - t( - 'stackiq', - 'Excel workbook (.xlsx) with the sheet "{first}" or "{second}". By default the file may be at most {size}.', - { - first: profileDefaults.sheets[0], - second: profileDefaults.sheets[1], - size: formatMegabytes(profileDefaults.maxFileBytes), - }, - asText, - ) - }} + {{ fileHelp }}

@@ -111,15 +100,7 @@ {{ t( 'stackiq', - 'When off, applications imported before are left as they are and reported as skipped.', - ) - }} -

-

- {{ - t( - 'stackiq', - "When on, a re-import overwrites the application's name, descriptions, application type, hosting model, BBN level, source fields and supplier, and the usage's status, phase-out date and business owner, with the values from the export. The usage's TIME classification and internal note are only set when the usage is created or the field is empty, so changes made in stackiq stay.", + 'Overwrites applications imported before with the values from the export. The (i) button above lists the fields.', ) }}

@@ -138,11 +119,45 @@ {{ t( 'stackiq', - 'A published application is visible to anyone, including anonymous visitors of OpenCatalogi. When off, the applications this import creates stay unpublished until you publish them by hand. Applications imported before keep their publication as it is.', + 'New applications become visible to everyone, also without logging in.', ) }}

+
+ + {{ t('stackiq', 'Applications missing from the export') }} + + + {{ t('stackiq', 'Archive or delete them') }} + + + {{ t('stackiq', 'Keep them as they are') }} + +

+ {{ + t( + 'stackiq', + 'Applications no longer in the export are archived or moved to the trash. The (i) button above explains when.', + ) + }} +

+
@@ -238,7 +253,7 @@ {{ t( 'stackiq', - 'The import was cancelled. The rows processed before it stopped are kept.', + 'The import was cancelled. The rows and applications processed before it stopped are kept.', ) }} @@ -304,7 +319,7 @@