diff --git a/Test-Management/admin.md b/Test-Management/admin.md index 789c451b535d81b3562e184bcaaf79c2be0456ce..d3aa74804d6a7c1c5eae63c011d6d0c74776292e 100755 --- a/Test-Management/admin.md +++ b/Test-Management/admin.md @@ -19,13 +19,34 @@ This document is applicable from version 5.0.0 of Gazelle Test Management. # Home page -The home page of Gazelle Test Management can be customized for your needs. This page is made of two main frames, one is first populated with informations coming from the database and you can edit the rest, the other one, can be displayed only if you need it, above or below the first one; and you are totally free to define its content. +The home page of Gazelle Test Management can be customized for your needs. This page is made of three sections: +Announcement section: by default with a white background, +Documentation section: by default with a light-grey background, +Tool index: by default with a blue background. -From the home page, "Edit" button are available in the panel headers to edit the title. The ones available at the bottom of the panels are for editing the content. The "Move panel to the bottom/top" button can be used to change the location of this panel. +All the three sections are fully editable using HTML. From version 6.4.0, the contents shall be editable directly in the database. Our plan is to add an editor in a future release (short-term). The HTML code you insert can reuse Gazelle CSS classes (most of them are derivative of Bootstrap), and Font Awesome icons. -When you edit a title or a panel content, do not forget to hit the "Save" button. +From version 6.4.0, when the user is logged in with role vendor or vendor_admin, the announcement section is replaced by the "Test session process" section. Other roles still see the announcement until we have implemented more content. This section is not configurable. Content is hard coded. + +## Configuring the home page + +Updating the Documentation section: ```update tm_section set content = 'YOUR HTML CODE' where name='Documentation';``` + +Updating the Announcement section: ```update tm_section set content = 'YOUR HTML CODE' where name='Announcement';``` + +Updating the Tool index section: ```update tm_section set content = 'YOUR HTML CODE' where name='ToolIndex';``` + + + +Sample content is available below: +* [Announcement](./media/announcement-eucat.html): Two columns (text + image) +* [Documentation](./media/doc-notloggedin.html): Two rows of three columns. Each cell has a title with a icon. +* [Tool index](./media/toolIndex.html): Tools are organised into three categories. + +## Test session process section + +See details in the (User manual)[./user.html#test-session-process-section] - # Configuration of the application preferences @@ -709,9 +730,12 @@ Gazelle Test Management can generate the contract and the invoice, if this testi Note that the rule for computing fees currently applies in Gazelle Test Management is the following: -The amount is relative to the number of systems the company has registered, and marked "completed". You can state that the price for the first system is different from the one for the following. Regarding the fees for additional participants, it is the amount due per participant when the number of participants is strictly higher than 2 times the number of systems. +For systems: the amount is relative to the number of systems the company has registered, and marked "completed". You can state that the price for the first system is different from the one for the followings. +For attendees: you can define that the price for each system includes X attendees, and what is the price for each additional attendees. -Currency code is used to express the currency to be used. Then you can custom the VAT and give the list of country VAT it the VAT of the country applies instead the global one (that's the case in Europe). +Currency code is used to express the currency to be used (ex: EUR). + +You can define the amount of VAT (between 0 and 1, 20% would then be 0.20). The list of "VAT countries" is used to apply the VAT to organisation who are registered in a country from that list. Finally, the contract and the invoice are generated based on a Jasper report, you need to provide the location of those \*.jrxml files. @@ -723,6 +747,18 @@ From this point, you can randomly generate test instances for testing the tool.  +# Administrative and financial page + +__button "generate invoice"__: generate a pdf invoice of the selected invoice and save it on the /opt/gazelle/data/CAT<%session_year%>-<%invoiceNumber%>.pdf. If the vendor has already download a contract, we verify if the new generated invoice concord to the latest update contract by the vendor, if there are difference, a warning will appear in financial summary. + +__button "Reload Invoice"__: If the current invoice was sent to institution, attributes of this fees are not updated if vendors add/remove participants or systems. So what we see does not correspond to what the vendor shall pay but it correspond to what the vendor will pay for the invoice sent by the administrator of gazelle. To update the invoice you have to click on the button "Reload Invoice". nb : the invoice pdf is not regenerated after clicking on the button "reload invoice". If after reloading, the last contract generated by the vendor is out of date, a warning will appear on the financial summary. + +__button "Recalculate fees"__: If the number of systems, or the number of participants was modified manually by administrator, to update fees you have to click on the button recalculate fees. This button is here to add the possibility to the administrator to fix manually what the vendor shall pay. So here, the feesAmount is calculated from the number of system and the number of participant that the administrator was specified on the edition of the invoice. nb : the invoice pdf is not regenerated after clicking on the button "Recalculate fees". If after reloading, the last contract generated by the vendor is out of date, a warning will appear on the financial summary of the vendor. + +__button "Update"__: this button save the modification done by the administrator, if the contract received date is not null, we suppose that the vendor has received the contract. If after the modification of the invoice and the update, the oldest contract downloaded by vendor is out of date, a warning will appear to the vendor, that he shall reload its contract. + +__The icon "update Invoice number" (refresh icon)__: this icon assert to the invoice a new number, and regenerate the invoice pdf on the /opt/gazelle/data/ with the new number. For each session, for each invoice, we have an unique number. + # Systems Configurations Administration The system configuration administration is divided into 3 parts, reachable from the Administration → Manage → Configurations menu