Introduction

Configuration

NotifyGru requires the library-notifygru to send the notification.

This library provides "Notifiers" that correspond to each type of notification (mail, sms, ...)

The "notifiers" should be injected as beans in the context of the module to be used, examples :

      <!--  NotificationStore Rest (with ApiManager access) : --> 
    <bean id="workflow-notifygru.lib-notifygru.apiManagerTransport"
        class="fr.paris.lutece.plugins.librarynotifygru.rs.service.NotificationTransportApiManagerRest">
        <property name="notificationEndPoint">
            <value>${library-notifygru.NotificationStoreNotifierService.notificationEndPoint}</value>
        </property>
        <property name="apiManagerEndPoint">
            <value>${library-notifygru.NotificationStoreNotifierService.apiManagerEndPoint}</value>
        </property>
        <property name="apiManagerCredentials">
            <value>${library-notifygru.NotificationStoreNotifierService.apiManagerCredentials}</value>
        </property>
    </bean>
    <bean id="workflow-notifygru.lib-notifygru.notificationStoreNotifierRestService"
        class="fr.paris.lutece.plugins.librarynotifygru.services.NotificationStoreNotifierRestService">
        <constructor-arg
            ref="workflow-notifygru.lib-notifygru.apiManagerTransport" />
    </bean>
	
	
	<!-- Email : -->
  	<bean id="workflow-notifygru.lib-notifygru.emailNotifierService"
        class="fr.paris.lutece.plugins.librarynotifygru.services.EmailNotifierService">
    </bean>
    

	<!-- BroadCast Email : -->
  	<bean id="workflow-notifygru.lib-notifygru.broadcastEmailNotifierService"
        class="fr.paris.lutece.plugins.librarynotifygru.services.BroadcastEmailNotifierService">
    </bean>
    
    
    <!-- Mock : -->
  	<bean id="workflow-notifygru.lib-notifygru.MockNotifierService"
        class="fr.paris.lutece.plugins.librarynotifygru.services.MockNotifierService">
    </bean>
                
                

See example in the workflow-notifygru_context.xml file, or the library-notifygru repository for more details about this configuration.

Notify Gru can use extra information providers to include in the content of the notification.

Those providers are provided by the different type of workflow resources that can use this notification task ( forms, appointment, ...)

There are two types of resource provider :

• The resource providers :
  A resource provider is the link between the NotifyGru task and a simple set of workflow resource infos.
• The resource providers managers:
  A resource provider manager is the link between the           notifygru task and multiple sets of resources infos (for example, in the plugin forms each form corresponds to a provider. )

Resources are treated as "demands", which contain information such as id, type, user reference, etc... and thus all notifications corresponding to the same resource will be attached to this "demand" entity.

Usage

NotifyGru configuration is done in two steps:

• A list to choose the provider of                       resource among different implementations of the available providers
• The status checkbox field : the demand will be considered as "closed" if checked.

Then NotifyGru configuration is done on multiple tabs. To set up a tab you must activate it via the select input "Add a notification ...". (Only the available notifications types are proposed, regarding the type of injected Notifiers) For each tab you can use bookmarks resource provider to enrich dynamically the message or the subject.

• Status (required) : new status of the demand
• Serder Name (required): the message sender
• Subject (required): subject of the notification (May use bookmarks)
• Message (required): Message of the notification (May use bookmarks)
• Number of steps (optional): total number of steps in demand
• Current Step (optional): current step when sending the notification

• Status in the 360° View (required) : status for the 360° view
• Event Description in the 360 ° View (required): message to the view 360. (May use bookmarks)

• Sender (required): sender email
• Subject (required) email subject. (May use bookmarks)
• Cc (optional): in copy
• Bcc (optional): blind carbon copy.
• Message (required): message of the email. (May use bookmarks)

• Message (required): the SMS. (May use bookmarks)

• mailing list (required): list of recipients, separated with ";"
• Sender (required): email of the sender
• Subject (required): subject (May use bookmarks)
• Cc (optional): in copy
• Bcc (optional): blind carbon copy.
• Message (required) : the main content (May use bookmarks)