*Petals View : User Guide*
\\
\\
Petals View 's main menu (leftpanel) is composed of three main sections:
* Flow Supervision: allows monitoring of ongoing or finished flows, either on a global view of all flows, or a more detailed view of one flow type (pre-requires referential import).
* Referential: this section's menus are used to define the flows in their different levels: steps, parameters, success/error messages, referential import/export.
* Administration: allows to define application's users and roles.

h1. !worddav2e2c00d8bf869b4284b3ec2830f85838.png|height=325,width=603!


h1. Administration

h2. Roles management

Here you have to !worddav3020b72cbdb8b7152ffa2381a4420970.png|height=296,width=584! :
Type in your new role's name
Choose its access rights:
Managing flow supervision: with this checked, the role can access all of the Flow Supervision menu.
Managing Referential: with this checked, the role can access all of the Referential menu: view, create, modify, import and export referentials.
Managing Users: with this checked, role can consult, create and modify Petals View's roles and users.
\\
Clicking on the "Submit" button will save the new role and automatically get you to its view/modification screen (you can also access this screen by clicking on the referential name when viewing list of roles !worddav50ac638e9d300d3c3ce8d710f368dadc.png|height=301,width=567! ).
!worddavd8cb463bdd7b2b6c946f8f7e3dbb191b.png|height=292,width=570!\\
Role viewing/edition screen is composed of two tabs:
Identity card: here you'll find all information provided during role creation. You can change its by clicking on "Modify".
Users list: you can define here which users will be associated with this role. To add a user, click on "Add". To delete one, click on "Delete".

h2. Manage users

This user's viewing/edition screen is composed of two tabs:
Identity card: here are listed all informations provided during user's creation. To modify its, just click on "Change password" (to change login password) or "Modify" (to change other information).
List of roles: you can define here what are the roles associated with that user. To add a role, click on "Add", to delete one, click on "Delete".

h1. Referential management

The Referential section is the place to define the flow types: steps, parameters, error/success messages... And to import/export referentials.
For this part, we'll suppose you already have generated a flow, that was saved in the database, by following the tutorial example.

h2. Creation of a new flow type

h2. Viewing/Edition of a flow type

This screen can also be accessed by clicking on the flow type name in flow types list.
On this screen you can see: !worddav0a8514fd13c372e3192b3389d65b9cca.png|height=406,width=604!
- Its General informations, namely its "Type" (non-editable) and name (editable, as long as it is an unique one).

* The "Functional name" is mandatory, it's the human-readable name that you want yo give to your step. !worddav0bf5702dab5462bfcbc0cdd65ad70a10.png|height=303,width=597!
* The "Interface name" field is mandatory, it has to be filled in with the name of the JBI interface name of your step. Here, it's been automatically filled in since informations were saved in the database. If you want to add a step from scratch, you'll have to fill it in.
* The "Service Name" is also mandatory, and has to be filled in with your step's JBI Service Name. Here, it has also been automatically filled in, except if you created a new step from scratch.
* The "Start flow?" and "End flow" boxes let you define whether this step is the first one and/or the last one of a processus.
* What message will be displayed when step is successfully finished
* What message will be displayed if step failed and returned an error. Default message will be used if the returned error code isn't referenced.

Another field is the "Global" checkbox. If you check it, this parameter will be viewable in step view as well as in general view of a flow type's instance.
\\
You can also modify a functional field's name by clicking on it, or suppress some by ticking their checkboxes then click on "Delete".

\\
On this page, you can delete identified (configured) flow types by checking the corresponding boxes in the table then clicking on "Delete" button.

h2. Export a Referential

This feature allows you to export a referential an then import it in any Petals View instance. This is mainly useful to quickly set up a production environment by reusing configurations made on development instance.
To export a referential, just check the boxes of the one(s) you want to export then click on "Export" button.
\\

h2. !worddavca91dbc456f2e1138116d66c65c9574f.png|height=318,width=604! Import a Referential

This feature allows you to import a referential that you previously exported. This screen is composed of two tabs:
Import data by URL: provide an absolute url.
Import data by file: browse your computer to select the adequate .xml file.
\\

h1. Flow Supervision !worddav7921ffce3c379157e7d97bd7e4b3c092.png|height=319,width=604!

You can also filter the view by flow status or flow type, thanks to the dropdown menus located in table header.

A new screen arrives, displaying, in addition to general information of the flow, the different steps and their status. This allows easy diagnosis of the causes of a processus failure. Global functional fields and their values are also displayed.
"Refresh" button updates this screen with latest infos.