1. Parametry uruchomienia programu
1.1 ID formularza
Formularz którego ID zostanie przekazane jako parametr aplikacji będzie otwarty po starcie programu Fillup.
1.2 Uruchamianie bazy sieciowej (dla wersji Duże Biuro)
Podanie ścieżki do pliku bazy danych spowoduje otwarcie danej bazy danych
C:\Program Files (x86)\fillUp\fillUp.exe D:\forms\database.sqlite
1.3 Konfiguracja startowa XML
Program fillup umożliwia przekazanie rozbudowanej konfiguracji startowej w postaci pliku xml. Jesli jeden z parametrów zawierać będzie ścieżkę do pliku XML, inne przekazane parametry nie będą brane pod uwagę. Struktura pliku jest opisana poniżej.
C:\Program Files (x86)\fillUp\fillUp.exe D:\config\testConfig.xml
2. Struktura XML konfiguracji startowej
Przykładowa, kompletna konfiguracja startowa:
formsToOpen - to kolekcja składająca się z dwóch elementów, formularzy o id 2764914 oraz 2461496. Zostaną one otwarte podczas uruchomienia aplikacji.
xmlDataToImport - kolekcja zawiera informacje na temat położenia plików "fillupXML" oraz instrukcje które będą wykonane po zakończeniu importu danych z plików ".fillupXML". Formularz zapisany w pierwszym pliku "PIT-11(1).fillupXML" zostanie zaimportowany bez wyświetlenia okna importu. Program wygeneruje PDF który doda jako załącznik do wiadomości e-mail adresowanej do "test@e-file.pl" w domyślnym kliencie poczty e-mail. Formularz zostanie wysłany w postaci e-deklaracji z użyciem certyfikatu o nazwie "NazwaCertyfikatu"
<?xml version="1.0" encoding="UTF-8" ?> <data type="com.efile.core.StartAppConfigData"> <formsToOpen type="Array"> <item type="com.efile.core.ConfigItem"> <formId>2764914</formId> </item> <item type="com.efile.core.ConfigItem"> <formId>2461496</formId> </item> </formsToOpen> <silentImport type="Boolean">1</silentImport> <xmlDataToImport type="Array"> <item type="com.efile.core.ConfigItem"> <filePath>D:\fillUp\PIT-11(1).fillupXML</filePath> <mailTo type="String">test@e-file.pl</mailTo> <certName type="String">NazwaCertyfikatu</certName> <esend type="Boolean">1</esend> </item> <item type="com.efile.core.ConfigItem"> <filePath>D:\fillUp\PIT-11(1).fillupXML</filePath> <mailTo type="String">test@e-file.pl</mailTo> </item> </xmlDataToImport> </data>
Podstawowa definicja pliku. Korzeń drzewa xml:
<?xml version="1.0" encoding="UTF-8" ?> <data type="com.efile.core.StartAppConfigData"> </data>
Lista formularzy do otwarcia:
<formsToOpentype="Array"> <item type="com.efile.core.ConfigItem"> <formId>[id formularza]</formId> </item> <item type="com.efile.core.ConfigItem"> <formId>[id formularza]</formId> </item> </formsToOpen>
Trb importu formularzy. 1 - import w trybie cichym bez akcji użytkownika, 0 - import wyświetli okno importu w programie.
<silentImport>[0|1]</silentImport>
Lista formularzy do zaimportowania
<xmlDataToImport type="Array"> <item type="com.efile.core.ConfigItem"> <filePath>[id formularza]</filePath> </item> <item type="com.efile.core.ConfigItem"> <filePath>[id formularza]</filePath> </item> </xmlDataToImport>
Lista ustawień do zaimportowania:
<settings type="Array"> <item type="com.efile.core.ConfigItem"> <settingName>show_zeros_in_decarations</settingName> <settingValue>true</settingValue> </item> <item type="com.efile.core.ConfigItem"> <settingName>footer_text</settingName> <settingValue>test footer text</settingValue> </item> </settings>
Pełna struktura obiektu typu com.efile.core.ConfigItem
<item type="com.efile.core.ConfigItem"> <formId type="String">[id formularza]</formId> <certName type="String">[nazwa certyfikatu]</certName> <mailTo type="String">[adres e-mail]</mailTo> <filePath type="String">[ścieżka do pliku]</filePath> <settingName type="String">[nazwa ustawienia]</settingName> <settingValue type="String">[wartość ustawienia]</settingValue> <esend type="Boolean">[czy wysłać w postaci e-deklaracji]</esend> <exportXML type="Boolean">[czy eksportować do pliku XML]</exportXML> <exportPDF type="Boolean">[czy eksportować do pliku PDF]</exportPDF> <openForms type="Boolean">[czy otworzyć formularze]</openForms> <print type="Boolean">[czy wydrukować]</print> </item>
ID formularza w aktualnej bazie danych
formId:String
nazwa certyfikatu jaki ma być uzyty przy wysyłce e-deklaracji
certName:String
adres e-mail na jaki ma zostać wysłany formularz
mailTo:String
ścieżka do pliku
filePath:String
klucz pod jakim zapisujemy ustawienie
settingName:String
wartość ustawienia
settingValue:String
czy formularze po zaimportowaniu mają zostać wydrukowane
Drukowanie importowanych formularzy: Plik .fillupXML może zawierać wiele formularzy. Jeśli w obiekcie <item type="com.efile.core.ConfigItem"> ustawiony zostanie parametr print, wszystkie formularze będą po imporcie przekazane do drukarki w postaci jednego dokumentu. Systemowe okno potwierdzenia drukowania pojawi sie tylko raz. Jeśli <xmlDataToImport type="Array"> zawierać będzie kilka plików .fillupXML, i wszystkie będą oznaczone do wydruku, to okno systemowe pojawi się oddzielnie dla każdego pliku .fillupXML
print:Boolean
czy zaimportowane formularze mają zostać wysłane w postaci e-deklaracji
esend:Boolean
czy zaimportowane formularze mają zostać eksportowane do PDF
exportPDF:Boolean
czy po zaimportowaniu otworzyć formularze?
openForms:Boolean
3. Globalne ustawienia aplikacji
Program daje możliwość generowania globalnych ustawień dla wszystkich użytkowników.
Na jednym z komputerów należy ustawić wszystko według potrzeb, następnie wyeksportować ustawienia do pliku: w zakładce Narzędzia->Ustawienia->Ustawienia aplikacji na dole znajdują się opcje administracyjne. Aby wyeksportować ustawienia należy kliknąć przycisk "Eksportuj ustawienia". Opcjonalnie można zaznaczyć że użytkownicy nie będą mogli zmieniać zaimportowanych ustawień.
Wyeksportowany plik "app_settings.xml" jest w formacie konfiguracji startowej zgodnie z powyższą dokumentacją
Aby użytkownicy zawsze używali globalnych ustawień, należy utworzyć skrót do programu na pulpicie, w parametrach uruchomienia programu podać ścieżkę do pliku “app_settings.xml”. Plik powinien znajdować się w lokalizacji dostępnej z każdego komputera na ktorym uruchamiany jest program. Każda zmiana w pliku app_settings będzie skutkować zmianą ustawień przy ponownym uruchomieniu programu przez użytkowników.