Controllo e revisioni
Richieste di modifica
Proporre modifiche a elementi approvati o in baseline come richiesta di modifica, farle rivedere e approvare, quindi applicarle in un solo passaggio con una registrazione completa.
In questa pagina
Una richiesta di modifica propone un insieme di modifiche al modello, ne spiega il motivo e attende l'approvazione prima che cambi qualsiasi cosa. Usare le richieste di modifica per il controllo della configurazione: una volta approvati i requisiti o fissata una baseline, le modifiche passano attraverso una richiesta che gli approvatori del progetto revisionano. Le richieste di modifica si trovano in Controllo e revisioni → Richieste di modifica.
Come usarlo
Creare una richiesta di modifica
- Aprire Controllo e revisioni → Richieste di modifica e fare clic su + Nuova richiesta di modifica nell'intestazione della pagina, oppure fare clic su Proponi modifica… nell'intestazione della Vista elemento di un elemento sotto controllo della configurazione (apre la richiesta di modifica aperta dell'elemento, se ce n'è una).
- Assegnarle un Titolo e un Motivo: perché la modifica è necessaria e cosa deve ottenere.
- Fare clic su Crea, poi aggiungere gli Elementi interessati con Aggiungi elemento…. Holarch elenca gli elementi tracciati a essi (requisiti, test, interfacce e altri elementi correlati); fare clic su + su quelli che cambiano anch'essi.
Preparare le modifiche
- Fare clic su Aggiungi modifica ▾ e scegliere cosa proporre: Modifica un elemento… (numero, nome, descrizione nell'editor di testo formattato, così la formattazione viene mantenuta, o un attributo), Nuovo elemento…, Elimina un elemento…, Aggiungi una relazione…, Rimuovi una relazione…, Aggiungi un collegamento a un altro progetto… o Rimuovi un collegamento a un altro progetto…. In un progetto SysML v2, Modifica testo SysML… propone una modifica al testo di un package.
- Fare clic su Prepara modifica. Ogni modifica preparata viene elencata in Modifiche proposte, con un confronto parola per parola per le modifiche di descrizione e di testo e il suo elenco Impatto (vedere Impatto). Nel modello non cambia ancora nulla.
- Rimuovere una modifica preparata con Rimuovi.
Inviare, revisionare e approvare
- Fare clic su Invia in revisione. Sul servizio ospitato gli approvatori ricevono un avviso e una voce in Il mio lavoro → Da decidere, dove Approva… e Rifiuta… aprono la richiesta con la sua finestra di voto.
- Un approvatore apre la richiesta, controlla le modifiche proposte e i loro elenchi Impatto, e fa clic su Approva… o Rifiuta… (un rifiuto richiede un motivo). Quando un requisito modificato è in una baseline, la finestra Approva… elenca anche gli elementi di verifica e i documenti che richiedono una nuova revisione.
- La scheda di revisione mostra Approvazioni: N di M. Una richiesta i cui cambi di stato hanno approvatori propri elenca anche ogni regola con il suo conteggio, per esempio ○ Ogni approvatore nominato (3): 1 di 3. Quando la richiesta ha le approvazioni necessarie, il suo stato diventa Approvata. Un solo rifiuto la rifiuta; l'autore può allora modificare le modifiche e inviarla di nuovo.
Ritira chiude una richiesta non ancora applicata senza modificare il modello; il suo registro resta nel log.
Applicare le modifiche
- Un editor o un proprietario apre la richiesta approvata e fa clic su Applica modifiche, poi conferma con Applica modifiche.
- Tutte le modifiche preparate vengono applicate insieme, e un solo annullamento revoca tutto. La cronologia di ogni elemento modificato registra la modifica “tramite CR-12”.
- Le modifiche i cui elementi sono stati eliminati nel frattempo vengono saltate ed elencate con il risultato. Un rilascio di configurazione preparato (Aggiungi modifica ▾ → Rilascia una configurazione…) viene registrato con gli approvatori della richiesta, o elencato con il motivo per cui non è stato rilasciato; vedere Rilasciare tramite una richiesta di modifica.
- La richiesta conserva l'elenco Impatto di ogni modifica com'era appena prima dell'applicazione delle modifiche, come registro di ciò che è stato considerato. La sua Cronologia mostra “impatto registrato” con i conteggi, per esempio “4 interessati, 9 da controllare”. L'applicazione non attende mai l'elenco dell'impatto: se dopo alcuni secondi gli elementi in altri progetti sono ancora in lettura, la richiesta viene applicata subito e conserva l'elenco calcolato fino a quel momento, contrassegnato “Impatto non completato al momento dell'applicazione” sulla richiesta, nella sua Cronologia e nelle esportazioni.
Lavorare in una richiesta di modifica
Invece di preparare ogni modifica in una finestra di dialogo, è possibile lavorare in una richiesta di modifica in bozza: modificare il modello come di consueto in qualsiasi pagina, e le modifiche vanno nella richiesta invece che nel modello live. Il modello live cambia solo quando la richiesta viene approvata e applicata.
Attivarlo
Il lavoro nelle richieste di modifica è disattivato per ogni progetto finché un proprietario del progetto non lo attiva: aprire Impostazioni nella pagina Richieste di modifica e spuntare Lavorare in richieste di modifica: modificare in una bozza e applicare dopo l'approvazione. La disattivazione viene rifiutata finché una bozza contiene ancora modifiche fatte in essa; applicare o ritirare prima quelle richieste. Sul servizio ospitato, il lavoro nelle richieste di modifica è incluso nel piano Team del proprietario del progetto, come le regole di approvazione (vedere la nota in Controllo della configurazione): lo includono anche un indirizzo email accademico verificato o l'appartenenza a un'organizzazione di tipo classe attiva, e i progetti che usavano le regole di approvazione prima della versione 2.29.0 lo mantengono. Negli altri piani l'impostazione appare disattivata. L'app desktop non ha piani.
Entrare e uscire
Iniziare a lavorare in una richiesta in bozza da uno di questi punti:
- Lavora ora in essa nella finestra Nuova richiesta di modifica (spuntato per impostazione predefinita).
- Lavora in questa richiesta di modifica nella pagina di una richiesta in bozza.
- Proponi modifica ▾ → Lavora in una richiesta di modifica… nella Vista elemento di un elemento. L'elenco mostra le bozze che nominano l'elemento, più Nuova richiesta di modifica….
- Lavora in una richiesta di modifica nel messaggio mostrato quando si modifica un elemento sotto controllo della configurazione.
- ⌘K / Ctrl+K → Lavora in una richiesta di modifica….
- Continua in Il mio lavoro → Richieste di modifica su cui sto lavorando.
Mentre si lavora in una richiesta:
- Un banner sotto la barra superiore indica, per esempio, Lavoro in CR-12 Range upgrade. Le modifiche vanno in questa richiesta di modifica, non nel modello live. 3 modifiche. con Rivedi modifiche ed Esci.
- Lo stato di salvataggio indica, per esempio, Salvato 14:02 in CR-12.
- Gli elementi modificati dalla richiesta riportano un indicatore RdM nelle tabelle e sui diagrammi.
Per provarlo, aprire il progetto demo CubeSat EO-1: CR-1 Shorten the planning cycle è una bozza con modifiche fatte in essa. Aprirla in Richieste di modifica e fare clic su Lavora in questa richiesta di modifica. Nella demo Hybrid Car, CR-2 Clarify the charge time contiene una modifica alla documentazione di un requisito.
Fare clic su Esci nel banner (o ⌘K / Ctrl+K → Esci dalla richiesta di modifica) per tornare al modello live. La modalità appartiene alla scheda del browser: un'altra scheda può mostrare il modello live nello stesso momento, e un ricaricamento mantiene la scheda nella richiesta.
Cosa funziona diversamente
- Annulla si ferma al punto in cui si è entrati nella richiesta.
- Modifiche dello schema, baseline, condivisione, Richiedi approvazione e Ripristina una versione precedente vengono rifiutati finché non si esce dalla richiesta.
- Gli elementi sotto controllo della configurazione possono essere modificati nella richiesta; è proprio a questo che serve.
- Invia in revisione sospende le modifiche finché la richiesta non viene decisa o ritirata. Una richiesta rifiutata torna bozza quando la si modifica.
- Ritira sposta le modifiche della richiesta nel Cestino come un'unica voce, per esempio Modifiche di CR-12; Ripristina le riporta nella richiesta.
Revisionare le modifiche
Una richiesta con modifiche fatte in essa ha due schede nella sua pagina: Dettagli (la richiesta, le modifiche preparate, la revisione, i commenti e la cronologia) e Modifiche, che confronta il modello prima della richiesta con il modello come lo renderebbe la richiesta. Rivedi modifiche nel banner la apre.
- I riquadri dei conteggi mostrano gli elementi aggiunti, rimossi e modificati e le modifiche delle relazioni; sotto di essi ogni modifica ha la propria riga, con il testo modificato mostrato parola per parola.
- I risultati di qualità, i segni di collegamento sospetto e gli altri registri di revisione sono nascosti; fare clic su Mostra dati di revisione per elencare anche quelli.
- Documenti elenca ogni documento che contiene un elemento modificato. Confronta versioni… mostra il documento prima della richiesta e con essa, ogni campo affiancato con le parole modificate evidenziate; una frase spostata all'interno di un campo è mostrata in viola in entrambe le posizioni, con un collegamento tra di esse.
- Diagrammi elenca ogni diagramma modificato con ciò che è cambiato, per esempio Asset Diagram 0 Drone Delivery System: 1 forma aggiunta (Charger), 1 spostata. Mostra prima e dopo disegna entrambe le versioni affiancate.
Anteprima nel modello nella pagina della richiesta apre il modello come sarebbe dopo l'applicazione della richiesta, in sola lettura. Il banner indica, per esempio, Anteprima di CR-12 (sola lettura). Ogni pagina mostra la modifica sul posto, così è possibile controllare una specifica generata, la RVTM o una matrice. Le modifiche vengono rifiutate finché non si fa clic su Esci. Anche revisori e lettori possono vedere l'anteprima.
I voti coprono le modifiche fatte nella richiesta così come le sue modifiche preparate: una modifica fatta dopo un voto annulla quel voto, e gli approvatori decidono di nuovo.
Applicare una richiesta in cui si è lavorato
Applica modifiche su una richiesta approvata confronta prima le sue modifiche con il modello live così com'è ora, perché altri potrebbero aver modificato gli stessi elementi nel frattempo.
- Nessun conflitto: la conferma indica, per esempio, Applicare 14 modifiche al modello live? Un solo Annulla riporta tutto indietro. Dopo Applica modifiche il messaggio indica CR-12 applicata: 14 modifiche. I nuovi elementi mantengono i loro id, e la cronologia di ogni elemento modificato indica “tramite CR-12” e nomina gli autori della richiesta.
- Modifiche a campi diversi dello stesso elemento si uniscono senza chiedere: se la richiesta ha rinominato un elemento e qualcun altro ne ha cambiato il numero nel modello live, entrambe le modifiche vengono mantenute.
- Conflitti: lo stesso campo modificato su entrambi i lati, un elemento eliminato su un lato e modificato sull'altro, o un collegamento dalla richiesta a un elemento eliminato nel modello live. La pagina della richiesta li conta, per esempio CR-12 ha 2 conflitti con il modello live., e Applica modifiche apre prima Risolvi conflitti — CR-12.
In Risolvi conflitti, ogni elemento in conflitto ha una scheda con la versione del Modello live (sul servizio ospitato con chi l'ha modificata) e la versione della Richiesta di modifica; Mostra originale aggiunge la versione precedente a entrambe le modifiche. I diagrammi vengono disegnati affiancati. Scegliere una delle opzioni:
- Mantieni aggiornato: l'elemento resta come lo ha il modello live. Per un collegamento a un elemento eliminato, il collegamento viene tralasciato.
- Usa richiesta di modifica: il valore della richiesta per ogni campo che ha modificato; i campi modificati solo dal modello live mantengono il valore live. Per un'eliminazione, l'esito della richiesta: l'elemento viene eliminato, o ripristinato con le modifiche della richiesta. Per un collegamento a un elemento eliminato, l'elemento viene ripristinato dal cestino con il collegamento.
- Combina: una riga per campo modificato con In tempo reale e Richiesta di modifica. I campi modificati da un solo lato partono da quel lato; i campi modificati da entrambi partono da Richiesta di modifica.
Applica modifiche resta disattivato finché ogni conflitto non ha una scelta (“Scegliere una versione per ciascuno dei 3 conflitti.”). Solo un approvatore della richiesta che può modificare risolve i conflitti; gli altri vedono, per esempio, CR-12 ha 3 conflitti con il modello live. Un approvatore li risolve all'applicazione. La Cronologia della richiesta registra ogni scelta (“Mantenuta la versione live di R.4.2”, “Sostituita una modifica live di Ann a R.4.3”), e sul servizio ospitato la persona la cui modifica live è stata sostituita riceve una notifica.
Un solo Annulla revoca l'intera applicazione: ripristina il modello live e riporta la richiesta ad Approvata con le sue modifiche, pronta per essere applicata di nuovo. Dopo l'applicazione, la scheda Modifiche della richiesta conserva l'elenco di ciò che è stato applicato. Una richiesta modificata dopo la sua approvazione non può essere applicata finché non viene inviata e approvata di nuovo. Chiunque stia lavorando nella richiesta o ne stia vedendo l'anteprima quando viene applicata torna al modello live. In un progetto SysML v2, la conferma elenca gli eventuali errori che la richiesta aggiungerebbe al modello, e Applica modifiche resta disattivato finché non si sceglie un'altra versione o la richiesta non viene rifiutata.
Impatto
Ogni modifica preparata ha un elenco Impatto: gli elementi tracciati a essa, trovati prima che qualcuno approvi o applichi la modifica. La sua intestazione mostra i conteggi, per esempio Impatto 3 interessati · 7 da controllare. Fare clic sull'intestazione per mostrare o nascondere l'elenco. Una richiesta con più di tre modifiche parte con gli elenchi chiusi.
L'elenco è raggruppato in Requisiti, Test e verifica, Interfacce, Documenti, Diagrammi, Elementi in altri progetti e Altri elementi. Ogni riga è contrassegnata:
| Contrassegno | Significato |
|---|---|
| Interessati | La modifica lo tocca: un elemento a una relazione di distanza dall'elemento modificato, un documento o un diagramma che mostra l'elemento modificato, le due estremità di una relazione aggiunta o rimossa, e gli elementi in altri progetti collegati all'elemento modificato. |
| Controllo | Un passo più in là: gli elementi tracciati a un elemento interessato, i documenti e i diagrammi che mostrano quelli, e gli elementi in altri progetti a due collegamenti di distanza. |
Ogni riga indica la sua classe e come viene raggiunta, per esempio “verified by 1.1 Pump pressure”. Un collegamento a un altro progetto il cui elemento è cambiato dall'ultima revisione del collegamento mostra Modificato. Fare clic su una riga per aprire l'elemento, il documento o il diagramma. Gli elementi in altri progetti provengono dalla Traccia elemento, con il proprio accesso: i collegamenti verso progetti che non si possono aprire vengono solo contati.
Un elenco mostra al massimo 300 righe e indica quante altre ce ne sono. I collegamenti ad altri progetti vengono letti per i primi 12 elementi modificati.
Sotto l'intestazione, una nota indica su cosa si basa l'elenco: “L'impatto si basa sulle relazioni modellate; le dipendenze non collegate o più distanti potrebbero non comparire. Calcolato rispetto alla revisione 1,204 alle 14:02.” La revisione è quella del progetto quando l'elenco è stato calcolato (sul servizio ospitato, lo stesso numero per ogni editor). Se il modello cambia durante la lettura, l'elenco resta come calcolato; riaprire la richiesta per ricalcolarlo. Un elenco salvato mantiene la revisione rispetto a cui è stato calcolato.
Quando la richiesta viene applicata, gli elenchi vengono salvati con essa e mostrati com'erano, così il registro indica ancora cosa è stato considerato dopo che gli elementi vengono rinominati o eliminati. Esporta ▾ → Word (.docx) li include, e il log Excel ha una colonna Impatto con i conteggi.
Lo stesso elenco compare in altri punti in cui una modifica attende una decisione:
- Anteprime dell'IA e proposte dei client IA: vedere IA.
- Nuovo rilascio… di una libreria: i progetti e gli elementi che usano gli elementi di libreria modificati dall'ultimo rilascio; vedere Librerie.
- Approvazione di un requisito in baseline: gli elementi di verifica e i documenti che richiederebbero una nuova revisione; vedere Requisiti.
Stato
| Stato | Significato |
|---|---|
| Bozza | In stesura; l'autore prepara le modifiche. |
| Inviata | In attesa degli approvatori. |
| In revisione | Almeno un approvatore ha votato. |
| Approvata | Approvazioni sufficienti; pronta per l'applicazione. |
| Rifiutata | Un approvatore l'ha rifiutata; l'autore può rivederla e inviarla di nuovo. |
| Ritirata | Chiusa senza modificare il modello. |
| Implementata | Le modifiche sono state applicate. |
Controllo della configurazione
Nota: sul servizio ospitato decide il piano del proprietario del progetto. Il controllo della configurazione (la prima impostazione) è incluso nei piani Individual e Team; le regole di approvazione qui sotto (approvazioni richieste, chi approva, un comitato delle modifiche, autoapprovazione) sono incluse nel piano Team. Un indirizzo email accademico verificato o l'appartenenza a un'organizzazione di tipo classe attiva mantengono entrambi. I progetti e le organizzazioni che li usavano prima della versione 2.29.0 li mantengono. Senza le regole di approvazione, le richieste di modifica funzionano con una sola regola: decide l'approvazione di un proprietario del progetto, e l'autore può approvare la propria richiesta, così è possibile approvare e applicare le proprie modifiche quando si lavora da soli. Le impostazioni salvate in precedenza vengono mantenute ma non applicate, e Impostazioni lo indica; gli elementi approvati e in baseline possono allora essere modificati direttamente. Registri di approvazione, voti e stati vengono mantenuti. L'app desktop non ha piani.
Impostazioni nell'intestazione della pagina Richieste di modifica apre Impostazioni delle richieste di modifica. Raggruppa le impostazioni in Controllo della configurazione (cosa richiede una richiesta di modifica, e se gli editor lavorano in bozze) e Approvazione (quante approvazioni, chi approva, autoapprovazione); ogni impostazione si applica appena la si modifica, e Fine chiude la finestra. La riga sopra l'elenco indica cosa fanno ora le impostazioni, per esempio “Gli elementi approvati e in baseline possono essere modificati direttamente; 1 approvazione da parte dei proprietari del progetto.”, con un collegamento Modifica in Impostazioni.
In Impostazioni, un proprietario del progetto può attivare Le modifiche agli elementi approvati e in baseline richiedono una richiesta di modifica. Allora:
- I requisiti approvati (Status Approved) e gli elementi nell'ultima baseline del progetto non possono più essere modificati, eliminati o collegati direttamente. Holarch spiega il motivo e rimanda alle richieste di modifica.
- Anche il loro Applies To, la loro Applicabilità e l'appartenenza alle configurazioni (linee di prodotti) ne fanno parte: cambiare a quali configurazioni o unità si applica un elemento richiede una richiesta di modifica.
- Commenti, revisioni, approvazioni dei requisiti, risultati di qualità e segni di revisione dei collegamenti restano aperti.
- Le richieste di modifica approvate applicano le loro modifiche a questi elementi.
- L'API REST e MCP seguono la stessa regola: la modifica diretta di uno script a questi elementi viene rifiutata (
409 change-control), e la proposta di un client IA non può includerli. Proporre invece la modifica in una richiesta di modifica. - Sul servizio ospitato, il server controlla ogni modifica che lo raggiunge, anche quelle fatte offline. Una modifica a un elemento approvato o in baseline fatta prima che l'elemento passasse sotto controllo (offline, o mentre qualcun altro lo approvava) non viene salvata: Holarch indica di quale elemento si tratta, ricarica il progetto e mantiene le altre modifiche. Proporre invece quella modifica in una richiesta di modifica.
Nota: sul servizio ospitato, il controllo della configurazione è imposto dal server per ogni modalità di modifica (l'app, l'API REST e MCP); un editor non può aggirarlo con un altro client. Solo l'applicazione di una richiesta di modifica approvata modifica questi elementi. Nell'app desktop e nei progetti del browser lo impone l'app, come fa con i blocchi degli elementi.
Approvazioni e approvatori
- Approvazioni richieste: 1, 2 o 3.
- Chi approva: Proprietari del progetto, Proprietari ed editor, o Un comitato delle modifiche di membri del progetto nominati (servizio ospitato; sul desktop si approvano le proprie richieste). Un comitato delle modifiche può nominare dei revisori: approvano, rifiutano e commentano la richiesta senza poter modificare il modello. Ogni membro del progetto che può commentare (revisore o superiore) può commentare una richiesta di modifica.
- Gli autori possono approvare le proprie richieste di modifica: disattivato per impostazione predefinita.
Solo i proprietari del progetto modificano queste impostazioni.
Le stesse impostazioni si applicano alle richieste create da un flusso di lavoro: un cambio di stato contrassegnato Approvazione in Schema → Flusso di lavoro apre Richiedi approvazione, che crea e invia una richiesta di modifica con quell'unica modifica.
Una transizione del flusso di lavoro può invece nominare i propri approvatori, per esempio ogni membro di un comitato di revisione, o 2 di 4 ingegneri nominati (Scegliere gli approvatori di una transizione). Una richiesta necessita allora delle approvazioni di ogni regola a cui sono soggetti i suoi cambi di stato; le modifiche non coperte da alcuna transizione usano queste impostazioni. Nell'app desktop, gli approvatori sono nomi: si approva con il nome indicato in Preferenze → Il proprio nome. Una richiesta che contiene solo cambi di stato viene applicata con la sua ultima approvazione quando quell'approvatore può modificare.
Sul servizio ospitato, Holarch usa solo le impostazioni salvate da un proprietario del progetto; le impostazioni modificate da chiunque altro vengono ignorate e si applicano i valori predefiniti (approvano i proprietari, un'approvazione, non le proprie richieste).
Quando Holarch non ha traccia di chi ha inviato una richiesta di modifica, per esempio in un progetto caricato o importato con le sue richieste, solo un proprietario del progetto può approvarla. Le impostazioni senza traccia di chi le ha salvate si applicano con i proprietari come approvatori e senza autoapprovazione finché un proprietario non le salva di nuovo.
Registri di approvazione
Sul servizio ospitato, approvare o rifiutare chiede la password (una volta ogni 10 minuti) e registra chi ha deciso, quando, la nota e le esatte modifiche preparate a cui si applica il voto. Se le modifiche preparate vengono modificate dopo un voto, quel voto non conta più e agli approvatori viene chiesto di nuovo. Prima che le modifiche vengano applicate, il server controlla che la richiesta sia approvata con le sue modifiche attuali. Ogni voto viene scritto anche nel log di audit (richiesta, decisione e lunghezza della nota; non la nota stessa).
Nota: un registro di approvazione mostra chi ha approvato cosa e quando. Non è una firma elettronica regolamentata per legge (come quella prevista da 21 CFR Part 11).
Commenti, avvisi e log
- I Commenti su una richiesta di modifica funzionano come i commenti sugli elementi.
- Sul servizio ospitato, gli avvisi vanno agli approvatori quando una richiesta viene inviata, all'autore quando viene approvata o rifiutata, e all'autore e ai votanti quando viene applicata o ritirata.
- Ogni richiesta conserva una Cronologia di cosa è successo, chi l'ha fatto e quando.
- Esporta ▾ nella pagina Richieste di modifica (mostrato quando esiste una richiesta di modifica) salva il log delle richieste di modifica come Excel (.xlsx) o Word (.docx), con le modifiche e la cronologia di ogni richiesta.