Skip to content

Commit

Permalink
added doc folder for documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
StefanKert committed Sep 21, 2018
1 parent 4a29b7e commit 20ecf55
Show file tree
Hide file tree
Showing 44 changed files with 1,329 additions and 150 deletions.
7 changes: 7 additions & 0 deletions DemoApplications.sln
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "csConsoleApplicationREST_FR
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "csConsoleApplicationSOAP_FR", "src\fr\csConsoleApplicationSOAP_FR\csConsoleApplicationSOAP_FR.csproj", "{8FCD235F-601C-4153-95A2-8F412D20E61B}"
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "csConsoleApplicationSCU_AT", "src\at\csConsoleApplicationSCU_AT\csConsoleApplicationSCU_AT.csproj", "{1651AEAC-E4B3-4B59-8A63-9B1398D018A2}"
EndProject
Global
GlobalSection(SolutionConfigurationPlatforms) = preSolution
Debug|Any CPU = Debug|Any CPU
Expand Down Expand Up @@ -55,6 +57,10 @@ Global
{8FCD235F-601C-4153-95A2-8F412D20E61B}.Debug|Any CPU.Build.0 = Debug|Any CPU
{8FCD235F-601C-4153-95A2-8F412D20E61B}.Release|Any CPU.ActiveCfg = Release|Any CPU
{8FCD235F-601C-4153-95A2-8F412D20E61B}.Release|Any CPU.Build.0 = Release|Any CPU
{1651AEAC-E4B3-4B59-8A63-9B1398D018A2}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{1651AEAC-E4B3-4B59-8A63-9B1398D018A2}.Debug|Any CPU.Build.0 = Debug|Any CPU
{1651AEAC-E4B3-4B59-8A63-9B1398D018A2}.Release|Any CPU.ActiveCfg = Release|Any CPU
{1651AEAC-E4B3-4B59-8A63-9B1398D018A2}.Release|Any CPU.Build.0 = Release|Any CPU
EndGlobalSection
GlobalSection(SolutionProperties) = preSolution
HideSolutionNode = FALSE
Expand All @@ -69,6 +75,7 @@ Global
{35DBA281-0AEF-4F8C-8901-DA22FD5309CD} = {EC572081-D920-4B98-8303-DE9A1504540B}
{2F50D61B-9BEE-46BA-B9BE-BFEBF55D13F5} = {BA979D2A-62BA-401A-9FBF-91BB23B6C7E0}
{8FCD235F-601C-4153-95A2-8F412D20E61B} = {BA979D2A-62BA-401A-9FBF-91BB23B6C7E0}
{1651AEAC-E4B3-4B59-8A63-9B1398D018A2} = {3EBCE2FA-839D-4DEB-83A1-1DFAF93C9360}
EndGlobalSection
GlobalSection(ExtensibilityGlobals) = postSolution
SolutionGuid = {6C837641-9F2F-41CF-AF16-8143715FA4FE}
Expand Down
52 changes: 26 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,14 @@ fiskaltrust offers a legal compliant cash register security mechanism.
Per now we published our release candidate interface, version 1.0.nnn. This interface is included in the Nuget Package fiskaltrust.interface and fiskaltrust.interface.utlities version 1.0.16298.1022-rc. The WSDL description file here at Github in the tools directory changed as well.

## Documentation
The detailed documentation for Austria is available from fiskaltrust-portal [https://portal.fiskaltrust.at] and for France is available from fiskaltrust-portal [https://portal.fiskaltrust.fr] when after you activate the role possystem-creator (Registrierkassenhersteller).
The detailed documentation for Austria is available from [fiskaltrust-portal](https://portal.fiskaltrust.at) and for France is available from [fiskaltrust-portal](https://portal.fiskaltrust.fr) when after you activate the role possystem-creator (Registrierkassenhersteller).

To speed up development we also deliver a nuget-package [https://nuget.org] with the packageId fiskaltrust.interface.
To speed up development we also deliver a [nuget-package](https://nuget.org) with the packageId fiskaltrust.interface.

## Connecting to fiskaltrust.securitymechanism
As a base technology in communication WCF is used. For local internal communication between queues, signature creation units and custom modules the net.pipe protocoll is the best choice. For multi platform communication the basic http protocol may be the best choice.
### SOAP
SOAP comes with the http protocol from WCF communication. To get the WSDL file you can use these debug-build and goto the http-address configured, here [http://localhost:1200/0b09d163-82a1-4349-83ed-7081398df504] is used. Another option is to use the file from the folder tools/wsdl.
SOAP comes with the http protocol from WCF communication. To get the WSDL file you can use these debug-build and goto the http-address configured, here "http://localhost:1200/0b09d163-82a1-4349-83ed-7081398df504" is used. Another option is to use the file from the folder tools/wsdl.
### REST
REST is available in both, in XML and JSON. There are helpers which can be loaded to keep the base service lightweight.
### Native TCP-IP and serial interface RS232/485/422
Expand Down Expand Up @@ -71,19 +71,19 @@ The fiskaltrust service is under permanent development, so feel free to discuss

## Existing modules
For further documentation on existing modules, follow these hyperlinks:<br>
[Testing receipts and SCU for Austria](src/at/README.md)<br>
[Journals and exports for all markets](src/common/README.md)<br>
[Testing receipts for France](src/fr/README.md)
[Testing receipts and SCU for Austria](doc/at/README.md)<br>
[Journals and exports for all markets](doc/common/README.md)<br>
[Testing receipts for France](doc/fr/README.md)

## fiskaltrust consulting gmbh
Lemböckgasse 49/1B/6.OG, 1230 Wien
[info@fiskaltrust.at]
<info@fiskaltrust.at>
[www.fiskaltrust.at](https://www.fiskaltrust.at)

---

# fiskaltrust.Interface AT
[see english readme](#fiskaltrust-interface-EN)
[see english readme](#fiskaltrust-interface-en)

Beispiel, wie man das fiskaltrust.Interface nutzt.

Expand All @@ -93,14 +93,14 @@ fiskaltrust bietet eine gesetzeskonforme Sicherheitseinrichtung für Registrierk
Ab sofort gibt es ein neues Interface (unseren Release Candidate), Version 1.0.nnn. Dieses Interface ist im Nuget Package fiskaltrust.interface und fiskaltrust.interface.utlities Version 1.0.16298.1022-rc enthalten. Ebenfalls geändert hat sich dadurch die WSDL Datei hier in den Tools.

## Dokumentation
Die detaillierte Dokumentation ist für Österreich auf dem fiskaltrust.Portal [https://portal.fiskaltrust.at] und für Frankreich auf [https://portal.fiskaltrust.fr] nach der Registrierung und Aktivierung der Rolle als Registrierkassenhersteller (in der Übersicht) verfügbar.
Die detaillierte Dokumentation ist für Österreich auf dem [fiskaltrust.Portal](https://portal.fiskaltrust.at) und für Frankreich auf dem [fiskaltrust.Portal](https://portal.fiskaltrust.fr) nach der Registrierung und Aktivierung der Rolle als Registrierkassenhersteller (in der Übersicht) verfügbar.

Um Ihnen die Entwicklung zu erleichtern, stellen wir auch ein nuget-package [https://nuget.org] mit der packageId fiskaltrust.interface zur Verfügung.
Um Ihnen die Entwicklung zu erleichtern, stellen wir auch ein [nuget-package](https://nuget.org) mit der packageId fiskaltrust.interface zur Verfügung.

## Verbindung mit der fiskaltrust.securitymechanism (Sicherheitseinrichtung)
Als Basis-Technologie zur Kommunikation wird WCF verwendet. Zur lokalen, internen Kommunikation zwischen queues, signature creation units (Signaturerstellungseinheiten) und benutzerspezifischen Modulen (Sonstigen Modulen) wird am besten das net.pipe Protokoll verwendet. Zur Kommunikation zwischen verschiedenen Plattformen wird am besten das Protokoll basic http verwendet.
### SOAP
SOAP wird mit dem http-Protokoll der WCF-Kommunikation ausgeliefert. Um die WSDL-Datei zu erhalten, kann man diesen Debug-Build verwenden und auf die konfigurierte http-Adresse gehen. Hierbei wird [http://localhost:1200/0b09d163-82a1-4349-83ed-7081398df504] verwendet. Als weitere Option kann die Datei aus dem Ordner tools/wsdl verwendet werden.
SOAP wird mit dem http-Protokoll der WCF-Kommunikation ausgeliefert. Um die WSDL-Datei zu erhalten, kann man diesen Debug-Build verwenden und auf die konfigurierte http-Adresse gehen. Hierbei wird "http://localhost:1200/0b09d163-82a1-4349-83ed-7081398df504" verwendet. Als weitere Option kann die Datei aus dem Ordner tools/wsdl verwendet werden.

### REST
REST steht sowohl in XML als auch in JSON zur Verfügung. Es stehen benutzerspezifische Module zur Verfügung, die zusätzlich geladen werden können. Damit werden die Basis-Services möglichest schlank gehalten.
Expand Down Expand Up @@ -156,19 +156,19 @@ Der fiskaltrust Service wird ständig weiterentwickelt. Nutzen Sie bitte die Mö

## Vorhandene Module
Für die Dokumentation der vorhandenen Module, folgen Sie diesen Links:<br>
[Belegtests und SCU-Test für Österreich](src/at/README.md)<br>
[Journale und Exports für alle Märkte](src/common/README.md)<br>
[Belegtests für Frankreich](src/fr/README.md)
[Belegtests und SCU-Test für Österreich](doc/at/README.md)<br>
[Journale und Exports für alle Märkte](doc/common/README.md)<br>
[Belegtests für Frankreich](doc/fr/README.md)

## Fiscaltrust consulting gmbh
## fiskaltrust consulting gmbh
Lemböckgasse 49/1B/6.OG, 1230 Wien
[info@fiskaltrust.at]
<info@fiskaltrust.at>
[www.fiskaltrust.at](https://www.fiskaltrust.at)

---

# fiskaltrust.Interface FR
[see english readme](#fiskaltrust-interface-EN)
[see english readme](#fiskaltrust-interface-en)

Exemple d'utilisation de la fiskaltrust.Interface.

Expand All @@ -178,16 +178,16 @@ fiskaltrust offre un dispositif de sécurité conforme aux lois et certifier pou
Dé maintenant, il y a une nouvelle interface (notre Release Candidate), version 1.0.nnn. Cette interface est incluse dans le Nuget Package fiskaltrust.interface et fiskaltrust.interface.utlities version 1.0.16298.1022-rc. En outre, cela a changé le fichier WSDL ici dans les outils.

## Documentation
La documentation détaillée est pour l'Autriche sur le fiskaltrust.Portal [https://portal.fiskaltrust.at] et pour la France sur [https://portal.fiskaltrust.fr] après l'enregistrement et l'activation du rôle de fabricant de caisse enregistreuse (dans la vue d'ensemble) disponible.
La documentation détaillée est pour l'Autriche sur le [fiskaltrust.Portal](https://portal.fiskaltrust.at) et pour la France sur [fiskaltrust.Portal](https://portal.fiskaltrust.fr) après l'enregistrement et l'activation du rôle de fabricant de caisse enregistreuse (dans la vue d'ensemble) disponible.

Pour faciliter le développement, nous fournissons également un nuget-package [https://nuget.org] avec le packageId fiskaltrust.interface.
Pour faciliter le développement, nous fournissons également un [nuget-package](https://nuget.org) avec le packageId fiskaltrust.interface.

## Connexion avec le mécanisme de sécurité fiskaltrust.securitymechanism (dispositif de sécurité)
WCF est la technologie de communication de base. Pour la communication interne locale entre les files d'attente, les unités de création de signature et les modules spécifiques à l'utilisateur (autres modules), le protocole net.pipe est le mieux utilisé.
La meilleure façon de communiquer entre différentes plates-formes est d'utiliser le protocole basic http.

### SOAP
SOAP est livré avec le protocole http de la communication WCF. Pour obtenir le fichier WSDL, vous pouvez utiliser cette version de débogage et accéder à l'adresse http configurée. Cela utilisera [http: // localhost: 1200 / 0b09d163-82a1-4349-83ed-7081398df504].
SOAP est livré avec le protocole http de la communication WCF. Pour obtenir le fichier WSDL, vous pouvez utiliser cette version de débogage et accéder à l'adresse http configurée. Cela utilisera "http://localhost:1200/0b09d163-82a1-4349-83ed-7081398df504".
Une autre option consiste à utiliser le fichier du dossier tools/wsdl.

### REST
Expand Down Expand Up @@ -244,11 +244,11 @@ Le service fiskaltrust est en constante évolution. S'il vous plaît profiter de

## Modules existants
Pour la documentation des modules existants, suivez ces liens:<br>
[Test pour les justificatives et SCU en Autriche](src/at/README.md)<br>
[Journaux et exports pour tous les marchés](src/common/README.md)<br>
[Test des justificcatives pour la France](src/fr/README.md)
[Test pour les justificatives et SCU en Autriche](doc/at/README.md)<br>
[Journaux et exports pour tous les marchés](doc/common/README.md)<br>
[Test des justificcatives pour la France](doc/fr/README.md)

## Fiscaltrust consulting gmbh
Lemböckgasse 49/1B/6.OG, 1230 Wien
[info@fiskaltrust.at]
## fiskaltrust consulting gmbh
102 Avenue des Champs-Élysées, 75008 Paris
<info@fiskaltrust.at>
[www.fiskaltrust.at](https://www.fiskaltrust.at)
30 changes: 30 additions & 0 deletions csConsoleApplicationSCU_AT.sln
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@

Microsoft Visual Studio Solution File, Format Version 12.00
# Visual Studio 15
VisualStudioVersion = 15.0.27428.2037
MinimumVisualStudioVersion = 10.0.40219.1
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "src", "src", "{9E70EE61-08C0-43C3-83E4-AFAB7C32801E}"
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "csConsoleApplicationSCU_AT", "src\at\csConsoleApplicationSCU_AT\csConsoleApplicationSCU_AT.csproj", "{1651AEAC-E4B3-4B59-8A63-9B1398D018A2}"
EndProject
Global
GlobalSection(SolutionConfigurationPlatforms) = preSolution
Debug|Any CPU = Debug|Any CPU
Release|Any CPU = Release|Any CPU
EndGlobalSection
GlobalSection(ProjectConfigurationPlatforms) = postSolution
{1651AEAC-E4B3-4B59-8A63-9B1398D018A2}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{1651AEAC-E4B3-4B59-8A63-9B1398D018A2}.Debug|Any CPU.Build.0 = Debug|Any CPU
{1651AEAC-E4B3-4B59-8A63-9B1398D018A2}.Release|Any CPU.ActiveCfg = Release|Any CPU
{1651AEAC-E4B3-4B59-8A63-9B1398D018A2}.Release|Any CPU.Build.0 = Release|Any CPU
EndGlobalSection
GlobalSection(SolutionProperties) = preSolution
HideSolutionNode = FALSE
EndGlobalSection
GlobalSection(NestedProjects) = preSolution
{1651AEAC-E4B3-4B59-8A63-9B1398D018A2} = {9E70EE61-08C0-43C3-83E4-AFAB7C32801E}
EndGlobalSection
GlobalSection(ExtensibilityGlobals) = postSolution
SolutionGuid = {95074C61-CC97-4E47-9D25-BE06B1E0D253}
EndGlobalSection
EndGlobal
43 changes: 42 additions & 1 deletion doc/README.md
Original file line number Diff line number Diff line change
@@ -1 +1,42 @@
doc folder
# Demo
Essential demo projects prepared for a better understanding of the interface fiskaltrust.IPOS .

## AT folder
Contains the Austrian localized demos. General information to the Console Application for Austria can be found [here](at/readme.md).

### [csConsoleApplicationREST_AT](at/csConsoleApplicationREST_AT.md)
Connects to a running fiskaltrust.service using REST communication and lets the user create all the types of receipt valid for the Austrian market.

### [csConsoleApplicationSCU_AT](at/csConsoleApplicationSCU_AT.md)
Connects to a running fiskaltrust.signing service for proofing its correct operativity.

### [csConsoleApplicationSOAP_AT](at/csConsoleApplicationSOAP_AT.md)
Connects to a running fiskaltrust.service using SOAP communication and lets the user create all the types of receipt valid for the Austrian market.

## Common folder
Contains demos that can be used regardless the country where the fiskaltrust.service is configured on. General information to the Console Application for common use can be found [here](common/readme.md).

### [csConsoleApplicationJournalREST](common/csConsoleApplicationJournalREST.md)
Connects to a running fiskaltrust.service using REST communication and lets the user export all the types of journals, regardless the market.

### [csConsoleApplicationJournalSOAP](common/csConsoleApplicationJournalSOAP.md)
Connects to a running fiskaltrust.service using SOAP communication and lets the user export all the types of journals, regardless the market.

### [ExecuteConfigurationTemplate](common/ExecuteConfigurationTemplate.md)
Executes a template to create a cashbox (and its content) logging into the provided url using the provided credentials for the API access.

## FR folder
Contains the French localized demos. General information to the Console Application for French can be found [here](fr/readme.md).

### [csConsoleApplicationREST_FR](fr/csConsoleApplicationREST_FR.md)
Connects to a running fiskaltrust.service using REST communication and lets the user create all the types of receipt valid for the French market.

### [csConsoleApplicationSOAP_FR](fr/csConsoleApplicationSOAP_FR.md)
Connects to a running fiskaltrust.service using SOAP communication and lets the user create all the types of receipt valid for the French market.



## fiskaltrust consulting gmbh
Lemböckgasse 49/1B/6.OG, 1230 Wien
<info@fiskaltrust.at>
[www.fiskaltrust.at](https://www.fiskaltrust.at)
72 changes: 72 additions & 0 deletions doc/at/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
# Console Application for Austria
The existing projects relate exclusively to the Austrian market and legislation.
You need a configured and active queue for the applications, which is creatable in the [portal](https://portal.fiskaltrust.at).

For all available executable applications you need the CashBoxId and the AccessToken.
Both values can be found in the [portal](https://portal.fiskaltrust.at).

## [REST](csConsoleApplicationREST_AT.md)
You can create the receipts for cash revenue, zero receipts, start/stop receipt, and the receipts for year/month.
In addition, you can start an RKSV-DEP export (all existing data).
To test the queue up to 999 cash sales documents can be generated in a glance.

All possible operations are performed based on the REST protocol.

## [SOAP](csConsoleApplicationSOAP_AT.md)
You can create the receipts for cash revenue, zero receipts, start/stop receipt, and the receipts for year/month.
In addition, you can start an RKSV-DEP export (all existing data).
To test the queue up to 999 cash sales documents can be generated in a glance.

All possible operations are performed based on the SOAP protocol.

## [SCU - Security Creation Unit](csConsoleApplicationSCU_AT.md)
With this application you can test an existing SCU for its correct function.

# Console Application für Österreich
Die vorhandenen Projekte beziehen sich ausschließlich auf den österreichischen Markt und Gesetzgebung.
Sie benötigen für die Applikationen eine konfigurierte und aktive Queue, welche Sie im [Portal](https://portal.fiskaltrust.at) erstellen können.

Für alle zur Verfügung gestellten und ausführbaren Applikationen benötigen Sie die CashBoxId und den AccessToken.
Beide Werte finden Sie im [Portal](https://portal.fiskaltrust.at).

## [REST](csConsoleApplicationREST_AT.md)
Sie können die Belege Barumsatz, Null-Belege, Kassen Inbetrieb-/Außerbetriebnahme und den Jahres-/Monats-Beleg erzeugen.
Zusätzlich können Sie einen RKSV-DEP Export (alle vorhandenen Daten) starten.
Um die Queue zu testen können bis zu 999 Barumsatzbelege in einem Durchgang erzeugt werden.

Alle möglichen Vorgänge werden auf Basis des REST-Protokolls durchgeführt.

## [SOAP](csConsoleApplicationSOAP_AT.md)
Sie können die Belege Barumsatz, Null-Belege, Kassen Inbetrieb-/Außerbetriebname und den Jahres-/Monats-Beleg erzeugen.
Zusätzlich können Sie einen RKSV-DEP Export (alle vorhandenen Daten) starten.
Um die Queue zu testen können bis zu 999 Barumsatzbelege in einem Durchgang erzeugt werden.

Alle möglichen Vorgänge werden auf Basis des SOAP-Protokolls durchgeführt.

## [SCU - Security Creation Unit](csConsoleApplicationSCU_AT.md)
Mit dieser Applikation können Sie eine vorhandene SCU auf Ihre korrekte Funktion testen.

# Console Application pour l'Autriche
Les projets existants concernent exclusivement le marché et la législation autrichiens.
Vous avez besoin d'une file d'attente configurée et active pour les applications,
que vous pouvez créer dans [portail](https://portal.fiskaltrust.at).

Pour toutes les applications fournies et exécutables, vous avez besoin du CashBoxId et du AccessToken.
Les deux valeurs peuvent être trouvées dans le [portail](https://portal.fiskaltrust.at).

## [REST](csConsoleApplicationREST_AT.md)
Vous pouvez générer les justificatif pour les revenus en espèces, justificatif à zero, justificatif pour demarrage et arrête et les justificatifs mensuell/annuell.
Vous pouvez démarrer une exportation RKSV-DEP (toutes les données existantes).
Pour tester la file d'attente jusqu'à 999 documents de vente au comptant peuvent être générés en une seule fois.

Toutes les opérations possibles sont effectuées sur la base du protocole REST.

## [SOAP](csConsoleApplicationSOAP_AT.md)
Vous pouvez générer les justificatif pour les revenus en espèces, justificatif à zero, justificatif pour demarrage et arrête et les justificatifs mensuell/annuell.
Vous pouvez démarrer une exportation RKSV-DEP (toutes les données existantes).
Pour tester la file d'attente jusqu'à 999 documents de vente au comptant peuvent être générés en une seule fois.

Toutes les opérations possibles sont effectuées sur la base du protocole SOAP.

## [SCU - Security Creation Unit](csConsoleApplicationSCU_AT.md)
Avec cette application, vous pouvez tester une SCU existante pour sa fonction correcte.

0 comments on commit 20ecf55

Please sign in to comment.