🟠 TTK Plugin

Estensione realizzata per la sincronizzazione dei sorgenti ColOr con un progetto locale.

❗ATTENZIONE: completare la lettura della guida prima di effettuare qualsiasi operazione❗

⌨️ Comandi

I comandi disponibili per effettuare la lettura e la scrittura dei sorgenti sono i seguenti:

Per ogni comando ci sono già delle shortcut stabilite, per modificarle basta recarsi su Code > Preferences > Keyboard Shortcuts se si è su Mac, altrimenti su File > Preferences > Keyboard Shortcuts se si è su Windows. Se si preferisce eseguirli come comandi normali, basta aprire la barra dei comandi con ctrl+shift+P su Windows o cmd+shift+P su MacOS, basterà cominciare a scrivere il testo del comando come da tabella e vi suggerirà il tutto.

🗂️ Struttura del progetto

La directory di progetto è composta solamente da 4 cartelle (applications, pages, views e spreadsheets) e da due file di servizio utili al plugin che non devono essere modificati:

• 📂 application
• 📂 pages
• 📂 views
• 📂 spreadsheets
• 📂 SQL (generata da SQL Explorer)
• 📄 colorconfig.json
• 📄 .colorMetadata

Come si può immaginare, le 4 directory contengono tutti i sorgenti.

❗Sono sconsigliate le operazioni di cancellazione o modifica dei sorgenti nella loro struttura, perché si avrebbe un disallineamento con i metadati che utilizza il plugin. Per aggiornare lo stato dell'intero progetto, di un'application, di una page o di qualsiasi altro elemento, utilizzare i comandi presenti nella precedente tabella.

❗ È assolutamente vietato applicare modifiche al file .colorMetadata, perché all'interno di questo file è presente la correlazione tra la struttura dei sorgenti del DB con quella dei file locali. Ne consegue che se dovesse cambiare anche una singola virgola, non è garantita la corretta sincronizzazione con le risorse del database.

❗ È assolutamente vietato applicare modifiche al file colorconfig.json, perché all'interno di questo file è presente una prima configurazione di accesso al database per il caricamento delle risorse.

🔐 Sessione e Autenticazione

Per motivi di sicurezza, è stata implementata una sessione interna per poter effettuare le operazioni sul database. La sessione viene ripristinata inserendo le credenziali di accesso al database. In caso di errore di autenticazione o sessione scaduta, è possibile usare il comando Imposta Credenziali DB per reinserire username e password.

💾 SQL Explorer

La funzionalità SQL Explorer permette di esplorare e modificare oggetti SQL direttamente da VS Code.

Funzionalità:

• Caricamento: Scarica le definizioni di Tabelle (solo nomi), Stored Procedures, Functions e Views.
• Supporto Multi-DB: PADM, POEO, POES, POEA, PDTS, POEU.
• Salvataggio:
  • Salvare un file .sql nella cartella SQL/ esegue lo script sul database corrispondente.
  • ATTENZIONE: I file vengono scaricati con CREATE. Per modificare un oggetto esistente, cambiare manualmente in ALTER prima di salvare.
  • Viene sempre richiesta conferma prima dell'esecuzione.

🆕 Creazione di nuovi sorgenti

Per la creazione di un nuovo progetto che non parte da una configurazione ben precisa, basta creare una directory con un solo file al suo interno, il colorconfig.json :

{
  "database": "PCOL",
  "server": "indirizzoServer",
  "port": 1433,
  "options": {
      "trustServerCertificate": true
  }
}

Dove bisogna inserire le corrette informazioni del database.

Dopodiché è già tutto pronto per il recupero dei sorgenti, basterà inserire le credenziali, eseguire i comandi offerti dal plugin e tutti i sorgenti con i corrispettivi metadati verranno importati in automatico.

Author: Christian Canciglia & Antonio Raia