Skip to content

ObeoNetwork/Tax

Repository files navigation

Tax Studio

This repository contains the sources of the Tax Studio for Sirius Web 2024.1.2.
This studio allows the calculation of the price of the customer’s cart with the applied VAT (Value-Added Tax) according to the jurisdiction of the customer. The studio offers two activities for the end user:

  • modeling of the different jurisdictions and VATs within them, as well as the customers residing in those and the products subject to the VATs;

  • defining the content of a customer’s cart, with computation of the price based on the customer’s jurisdiction.

Each activity has its own representation: a diagram representation for the modeling of the jurisdiction and a form representation for defining a customer’s cart.
Figure 1 illustrates the first activity.

In this example, there are two customers: Alice and Bob, respectively living in France and in Germany. In France there are two tax categories: the alcohol tax with a VAT of 20\% and the food tax with a VAT of 6\%. The Germany has only one tax category: the food tax with a VAT of 7\%. To finish, there are two products: apples (1kg) for 3€, belong to the two food taxes; wine for 12€, belong to the alcohol tax.
Figure 1. A Tax model made with the tax studio, viewed according to the first activity

How to install Sirius Web?

To use the Tax Studio, Sirius Web is required.
You can follow the installation process outlined in the original repository to install it.

How to install the Tax Studio and its example?

  1. Download the tax_studio.zip and tax_example.zip files, and the four SVG images from the repository.

  2. Import them into Sirius Web using the "Upload project" tile shown in Figure 2.

  3. Currently, Sirius Web does not export the images used in the concrete syntax when exporting a studio. Figure 3 illustrates how to import them manually:

    1. Open the Tax Studio project and go to the settings (❶) to upload the different images. Give them the name of the image as a label. To return to the project, you can use your browser’s "go back" feature or click the Sirius Web icon to go to the home page.

    2. Click on the first image style in the Tax View model (❷) and change the shape to select jurisdiction (❸).

    3. Repeat the same step for the other image styles (❹-❻). The image style ❺ must have as shape the alcohol image. It is a conditional style that is applied only when a tax category of a product contains the word "alcohol".

  4. Now, you can switch between the two projects to see how the studio is defined (Tax Studio) and an example of use (Tax Example).

  5. You can create a new representation by following the steps as shown in Figure 4.

Sirius Web homepage with the
Figure 2. The homepage of Sirius Web. Boxed in blue, the tile to upload a new project
Design view when none representation is open, a list of all representations of the project is displayed. The list contains the representations
Figure 3. The Tax Studio project opened. The numbers in blue represent the ordered steps to import the images and use them to represent the different concepts.
The modal to create a new representation. Can be accessed by going into the parameters of the root model element and clicking into
Figure 4. The steps to create a new representation.

About

Tax Studio, example based on Sirius Web

Resources

License

Stars

Watchers

Forks