Installation du plugin WordPress

Dans l'interface BackOffice de WordPress:

- Afficher la liste des extensions, menu à 'Extensions'

- Cliquer sur [Ajouter]

- Cliquer sur 'Téléverser une extension'

- Cliquer sur [Choisir un fichier] et sélectionner le fichier 'simaxFormSubmiter.zip'

- [Installer] puis [Activer] l'extension.

Pour plus d'informations, se référer à la documentation WordPress en ligne.

Descriptions des différentes pages du plugin (BackOffice)

Suite à l'activation du plugin, une option du menu administration "simaxFormS" apparait contenant également le sous-menu "Réglage".

Page Réglage

Cette page permet de régler les options suivantes :

- Adresse du webservice NOUTOnline (au format 'protocole://adresse:port/SOAP/', en cas d'absence du 'port', le port par défaut '80' sera utilisé)

- Le login, et mot de passe de l'utilisateur SIMAX à utiliser pour la communication avec NOUTOnline

- L'identifiant de l'application à utiliser pour la communication avec NOUTOnline

- Le message d'erreur à afficher si l'enregistrement n'a pu être créé dans SIMAX.

- Le message de succès à afficher sur réussite de la création de l'enregistrement.

- Une adresse email de récupération qui, si elle est renseignée, permet de recevoir le contenu du formulaire si une erreur de création dans SIMAX survient.

Page simaxFormS

Cette page permet de créer de nouveaux formulaires, de supprimer des formulaires existants et d'accéder à la page d'édition des formulaires.

Page d'édition de formulaire

Elle permet de modifier les diverses options, et informations spécifiques à chaque formulaire.

Elle contient :

- Shortcode : Champs non modifiable contenant le Shortcode [sfs-…], permettant d'utiliser le formulaire courant (c-réf. : utilisation du plugin)

- Titre : Le titre du formulaire courant, ce champ n'est utilisé que pour permettre une identification simplifiée du formulaire.

- Identifiant du formulaire simax : Identifiant du formulaire SIMAX dans lequel on souhaitera créer un enregistrement à la validation du formulaire

- Description du formulaire : Texte au format 'html' décrivant les 'input' que l'on souhaite afficher afin de recueillir les informations à envoyer dans le formulaire SIMAX (c-réf. : utilisation du plugin pour plus d'informations)

- Message d'erreur : Champs permettant de surcharger le champ message d'erreur réglé dans les options générales du plugin afin d'être plus spécifique au formulaire courant.

- Message de succès : Champs permettant de surcharger le champ message de réussite réglé dans les options générales du plugin afin d'être plus spécifique au formulaire courant.

- Email de récupération : champs permettant de surcharger l'email de récupération réglé dans les options générales du plugin afin d'être plus spécifique au formulaire courant.

Utilisation du plugin

Une fois le plugin installé (BackOffice WordPress) :

1) Définir les options de connexion à menu : simaxFormS >> Réglage

2) Créer un nouveau formulaire, puis modifier ses informations à menu : simaxFormS >> simaxFormS ; [Nouveau]

- Titre, afin de pouvoir identifier facilement ce formulaire.

- Identifiant du formulaire SIMAX, afin de connaitre le formulaire pour lequel on souhaite créer l'enregistrement.

- Eventuellement les messages d'erreur, message de réussite, et email de récupération.

- Les champs de description de formulaire (c-réf. : description du formulaire).

3) Après avoir enregistrer le formulaire, copier le Shortcode généré et coller ce dernier dans une page/article de votre site à l'endroit désiré.

4) Passer en FrontOffice et visualiser votre page/article, le Shortcode a été remplacé par votre formulaire.

5) Il ne reste plus qu'à remplir ce dernier et le soumettre [Envoyer] pour que le contenu de chaque champ de saisie (input) soit renvoyé dans le formulaire SIMAX correspondant.

Description du formulaire

Dans le BackOffice, le champ description de formulaire (HTML) du plugin, permet de définir pour chaque formulaire, l'affichage de ce dernier :

Il doit contenir le code html de définition d'un formulaire (sans les balises <form></form>).

Il doit également contenir le bouton de validation du formulaire (input type="submit")

Chaque champ (input) doit avoir comme attribut name, l'identifiant de la colonne SIMAX à laquelle il correspond précédé de "id_". Ex. pour la colonne 'Nom' ayant comme identifiant 123456, l'input à créer sera à minima <input type="text" name="id_123456" />

Email de récupération

Il peut arriver pour diverses raisons que la création de l'enregistrement dans SIMAX échoue, dans ce cas précis, si un e-mail de récupération a été défini (paramètre du plugin ou du formulaire simaxFormSubmiter), le contenu du formulaire sera envoyé sur l'email indiqué (cela permet d'éviter toute perte d'information). Dans ce dernier cas, si l'envoie de l'email abouti, l'utilisateur ne verra aucune erreur.