Formaty danych i eksport

Jak pobrać dane

Właściciel i administrator pracowni pobiera pełną paczkę w Ustawienia → Eksport pracowni. Po usunięciu pracowni jej właściciel może pobrać paczkę jeszcze w okresie przechowywania opisanym w polityce prywatności.

Członek zespołu pobiera węższą paczkę z własną częścią pracy (jej zakres opisujemy niżej).

Paczka to kilka plików ZIP, a każdą część pobierasz osobno. Przygotowaną paczkę przechowujemy na naszych serwerach przez ograniczony czas; datę widzisz w Ustawienia → Eksport pracowni.

Dane swojego konta (logowanie, sesje, wiadomości wysłane na Twój adres) pobierasz osobno w Konto → Dane i prywatność.

Z czego składa się paczka

Część pierwsza: dokument eksport-pracowni.json z całością danych, arkusze CSV w katalogu csv/ oraz plik CZYTAJ-MNIE.txt z objaśnieniem paczki.

Każda następna część to pliki jednego projektu, w katalogu media/. Projekt, którego pliki są bardzo duże, jest podzielony na kilka części. Żaden plik nie jest pomijany z powodu rozmiaru.

Nazwa każdej części zawiera jej numer i liczbę wszystkich części, a spis w dokumencie wymienia wszystkie części paczki.

Plik, którego nie dało się odczytać z magazynu w chwili przygotowania paczki, jest wymieniony w dokumencie jako niedostępny.

Gdy dane pracowni przekraczają granicę, do której potrafimy przygotować paczkę automatycznie, nie dostajesz niepełnej kopii: przygotowanie kończy się komunikatem, a dane przygotowujemy ręcznie na Twoją prośbę.

Kategorie danych

Dokument eksport-pracowni.json ma po jednej sekcji dla każdej z poniższych kategorii.

• studio: Pracownia: nazwa, data założenia i zaproszenia wysłane do zespołu.
• team: Zespół: kto należy do pracowni, z jaką rolą, uprawnieniami i od kiedy, wraz z imieniem, nazwiskiem i adresem e-mail każdej osoby.
• clients: Klienci pracowni: nazwa, dane kontaktowe, firma, NIP i notatki. Tylko w pełnej paczce pracowni.
• projects: Projekty: nazwa, klient, adres, status, etapy, zadania, pomieszczenia, przypisania osób i włączone narzędzia, a także szablony projektów pracowni.
• brief: Ankieta każdego projektu: odpowiedzi klienta w czytelnej formie razem z surowym zapisem, inspiracje i lista wyposażenia, a także historia wysyłek, czyli każda wersja ankiety tak, jak wtedy wyglądała. Zdjęcia są w katalogu „media”.
• publications: Materiały dla klienta (układ funkcjonalny, projekt koncepcyjny i dokumentacja wykonawcza): rundy, pliki w nich, daty udostępnienia, opinie klienta, komentarze, akceptacje (z wybranym wariantem) i to, kiedy klient otwierał materiały.
• consultations: Konsultacje i kalendarz: ustawienia dostępności pracowni, umówione spotkania, także odwołane (z powodem pokazanym klientowi) i przeniesione, oraz wpisy kalendarza pracowni i projektów.
• survey: Inwentaryzacja: paczki pomiarowe, karty pomieszczeń, punkty do sprawdzenia, źródła dokumentacji, stan zastany i historia zmian.
• files: Pliki projektowe: nazwa, rodzaj, rozmiar, wersje i daty. Same pliki (każda wersja osobno) są w katalogu „media” tego archiwum.
• shoppingList: Listy zakupów: produkty, ceny, ilości, statusy i linki do sklepów. Zdjęcia produktów są w katalogu „media”.

Paczka członka zespołu

Ta paczka zawiera Twoją część pracy w tej pracowni. Jest węższa niż eksport, który pobiera właściciel. Poniżej wyjaśniamy, czym dokładnie się różni.

• Są w niej tylko projekty przypisane do Ciebie. Projektów pracowni, w których nie bierzesz udziału, nie ma tu wcale: nie wspomina o nich żadne pole.
• Nie ma sekcji „clients”. Dane kontaktowe klientów pracowni (adres, telefon, firma, NIP, notatki) należą do pracowni i w niej zostają. Przy projekcie zostaje sama nazwa klienta, tak jak widzisz ją w aplikacji.
• Nie ma zaproszeń wysłanych przez pracownię: to jej rejestr, a nie Twój.
• Umówione konsultacje dotyczą wyłącznie Twoich projektów.
• Pliki w katalogu „media” to pliki tych samych projektów. Nie ma tam nic z projektów, których nie widzisz w aplikacji.

Formaty

Dokument JSON

Całość danych jest w jednym dokumencie JSON ze spisem (manifest) na początku: wersja schematu (5), lista sekcji ze źródłami, lista wykluczeń z powodami i lista części paczki.

Arkusze CSV

Kodowanie

UTF-8 ze znacznikiem BOM

Separator

średnik (;)

Znak dziesiętny

przecinek (1234,56)

• Pliki CSV to wygoda, a nie druga kopia danych. Pełną zawartość paczki ma dokument eksport-pracowni.json. W arkuszach są tylko te części, które naprawdę są tabelą.
• Ankiety, koncepcji i inwentaryzacji nie ma w arkuszach: to struktury zagnieżdżone, a rozpisane na wiersze byłyby gorszą kopią samych siebie niż ta, którą masz w dokumencie.
• Kodowanie i separator dobraliśmy tak, żeby plik otwierał się poprawnie w Excelu z polskimi ustawieniami: polskie znaki są czytelne, kolumny rozdzielone, a liczby mają przecinek.
• Komórki zaczynające się od =, +, - lub @ poprzedzamy apostrofem, żeby arkusz potraktował je jako tekst. Liczb to nie dotyczy: cena -12,50 pozostaje liczbą.

Pliki

Ścieżka pliku w paczce: {część projektu}/media/{rodzaj}/{numer}-{nazwa}

• Pliki projektowe: każda wersja osobno, w postaci, w jakiej zostały dodane.
• Zdjęcia inspiracji i wyposażenia z ankiety, dodane przez Ciebie i przez klienta.
• Zdjęcia produktów z list zakupów.

• Zdjęcia inspiracji, wyposażenia i produktów przechowujemy przekonwertowane do formatu WebP (inspiracje i wyposażenie: maks. 1920 px). Oryginałów nie przechowujemy, więc w paczce jest dokładnie to, co mamy.
• Pliki projektowe są w paczce bajt w bajt takie, jak je dodano.
• Nazwy katalogów i plików w archiwum są uproszczone do znaków ASCII, żeby otwierały się poprawnie w każdym systemie. Pierwotną nazwę każdego pliku znajdziesz w sekcji „media”.
• Paczka jest podzielona na części: część 1 to dokumenty i arkusze, każda kolejna to pliki jednego projektu. Pole „part” przy każdym pliku mówi, w której części on jest.
• Żaden plik nie jest pomijany z powodu rozmiaru. Jeśli pliku nie udało się odczytać, nie ma go w archiwum, a sekcja „media” wymienia go na liście „omitted” z nazwą, rozmiarem i powodem.

Czego świadomie nie ma w eksporcie

Każde wykluczenie ma powód zapisany w kodzie i w spisie każdej paczki.

• Hasła i dane logowania. Hasła, tokeny sesji i klucze szyfrujące to klucze do kont, a nie dane pracowni. Ich kopia w pliku na dysku byłaby działającym wejściem do aplikacji.
• Aktywne linki dla klientów. Linki wysyłane klientom (ankieta, portal klienta, zaproszenie) działają bez logowania. Paczka nigdy ich nie zawiera, bo inaczej byłaby kluczem do danych Twoich klientów. Zamiast tokenu zapisujemy samą informację, czy link istnieje.
• Prywatne dane osób z zespołu. Dane konta osoby z zespołu: sposoby logowania, hasło, sesje i wiadomości wysłane na jej adres. Należą do tej osoby, nie do pracowni, i każdy pobiera je sam w Konto → Dane i prywatność.
• Mechanizmy wewnętrzne aplikacji. Zapis techniczny działania aplikacji (kolejki, ponowienia, sprzątanie plików). Nie mówi nic o pracowni poza tym, co jest już w pozostałych sekcjach.
• Pola techniczne. Pole techniczne: znacznik współbieżności, klucz idempotencji albo powtórzenie danych z innej sekcji.
• Dane wtórne. Powiadomienia w aplikacji są tworzone na podstawie zdarzeń, które i tak są w paczce, i nie mają osobnego stanu „przeczytane” dla każdej osoby. Nic nie tracisz.
• Miniatury i kopie robocze. Miniatury i pomniejszone kopie obrazów. To robocze pliki aplikacji, a nie coś, co ktoś dodał. W katalogu „media” jest każdy obraz w największym rozmiarze, jaki mamy.
• Miniatury i wersje pomniejszone. To robocze kopie aplikacji, a nie plik, który ktoś dodał. Każdy obraz jest w paczce w największym rozmiarze, jaki przechowujemy.
• Obrazy z rozmów z pomocą Projektado. Należą do osoby, która je wysłała, a nie do pracowni. Znajdzie je w swoim eksporcie konta i w panelu Pomoc.

Warto wiedzieć

• Ta paczka zawiera dane pracowni: projekty, ankiety, koncepcje, inwentaryzację, listy zakupów, klientów i zespół. Dane Twojego konta pobierzesz osobno w Konto → Dane i prywatność.
• Nie ma w niej żadnego działającego linku dla klienta. Tam, gdzie link istnieje, zapisujemy tylko informację, czy jest aktywny, a nigdy samego adresu ani tokenu.
• Pliki i zdjęcia dodane przez pracownię są w katalogu „media”, a sekcja „media” tego dokumentu mówi, który plik należy do którego wpisu.
• Dane klientów i osób, które przekazały dokumentację, to dane osobowe osób trzecich. Administratorem tych danych jest Twoja pracownia. Przechowuj tę paczkę odpowiedzialnie.

Paczka odpowiada stanowi danych z chwili rozpoczęcia przygotowania (pole snapshotAt) i może nie zawierać zmian wprowadzonych w trakcie. Każdy moduł czytaliśmy w jednej transakcji, więc w obrębie sekcji dane są spójne.