Connecteur passerelle pour OpenADS
This repository has been archived on 2023-02-22. You can view files and clone it, but cannot push or open issues or pull requests.
Go to file
Thomas NOËL 7897daaf49 add Jenkinsfile 2019-07-15 16:49:19 +02:00
atreal_openads Added 'test_openads_connexion' endpoint and README completed 2019-07-11 18:57:07 +02:00
debian Added minimum required files for packaging 2019-07-10 18:30:18 +02:00
.gitignore Cleanup: removed useless endpoints and test cases 2019-07-11 17:41:38 +02:00
Jenkinsfile add Jenkinsfile 2019-07-15 16:49:19 +02:00
MANIFEST.in Added minimum required files for packaging 2019-07-10 18:30:18 +02:00
README Added 'test_openads_connexion' endpoint and README completed 2019-07-11 18:57:07 +02:00
setup.py Added minimum required files for packaging 2019-07-10 18:30:18 +02:00

README

Passerelle connector to openADS
===============================

Installation
------------

 - create a symbolik link from this module to the passerelle 'apps' directory

 - add to Passerelle installed apps settings:
   INSTALLED_APPS += ('passerelle.apps.atreal_openads',)


Usage
-----

 - create and configure new connector
   - Title/description: whatever you want
   - Collectivity: enter the technical ID from openADS
   - openADS API login : the login credential to connect to openADS.API
   - openADS API password : the password credential to connect to openADS.API
   - Extra debug: check if you want more debug logging

 - test service by clicking on the available links
   - the /test_openads_connexion/ endpoint try to establish a connection with openADS.API


Usage in w.c.s.
---------------

 - create dossier

   - a processing data to the workflow named 'Numéro dossier' with identifier 'numero_dossier'

   - wcs workflow action "call webservice"
     URL            : https://passerelle.dev.publik.love/atreal-openads/inst0/create_dossier/DIA/
     Method         : POST (JSON)
     Send form data : checked
     Response type  : JSON
     Identifier     : wsdia

   - wcs workflow action "processing data"
     Modify processing data:
        Field: Numéro dossier
        Value: wsdia_response_numero_dossier

   - wcs workflow action "message in history"
     Message        : "Récépissé reçu"
     Files attached : (Python expr) "utils.dict_from_prefix('wsdia_response_recepisse_', locals())"

 - get dossier

   - wcs workflow action "call webservice"
     URL            : https://passerelle.dev.publik.love/atreal-openads/inst0/get_dossier/DIA
     Data to send in parameter of the URL:
        Name : numero_dossier
        Value: (Python expr) "form_var_numero_dossier"
     Method         : GET
     Response type  : JSON
     Identifier     : wsetat

 - get courrier

   - wcs workflow action "call webservice"
     URL            : https://passerelle.dev.publik.love/atreal-openads/inst0/get_courrier/DIA
     Data to send in parameter of the URL:
        Name : numero_dossier
        Value: (Python expr) "form_var_numero_dossier"
     Method         : GET
     Response type  : JSON
     Identifier     : wscourrier