Attacher un document à une tâche via une recherche

01/03/2018

Introduction

Cet article décrit comment attacher un document à une tâche au travers d’une action ouvrant un formulaire de recherche. En effet, par défaut, les documents pouvant être attachés à une tâche ne peuvent provenir que du poste local.

Prérequis :

  • Notion de JavaScript
  • Formulaire de recherche
  • Tâche existante dont l’une des pièces jointes peut être modifiée

Place au script !

Commençons par ouvrir la console JavaScript de Google Chrome.

Ensuite copier/coller le script ci-dessous dans votre console et ouvrez une tâche.

var cardAPI = JSAPI.get().getCardAPI();
cardAPI.registerForAttachment(function(card, task, definition, component){
	addCustomActionOnCard(card, definition);
});

var searchDocumentLabel = JSAPI.get().getLabelsAPI().getLabel("searchDocument");
function addCustomActionOnCard(card, definition){
	var formAPI = JSAPI.get().getLastComponentFormAPI()
  	var actionAPI = JSAPI.get().getActionFactoryAPI();
  	var action = actionAPI.buildIcon("searchDocument",searchDocumentLabel, "fa fa-search", function(actionPresenter){
		openSearchTemplate(formAPI, card, definition.getId());
    });   
    card.getActions().add(action);
}

function openSearchTemplate(formAPI, card, attachmentId){
	var popup = JSAPI.get().getPopupAPI().buildSearch("DOCUMENT", "DefaultSearch" , function(component){
			attachToTask(formAPI, attachmentId, component);
		} 
	);
	popup.setTitle(searchDocumentLabel);
	popup.show();
}

function attachToTask(formAPI, attachmentId, component){
	var addEvent = new AddTaskAttachmentEvent(attachmentId, component);
	var loadEvent = new AttachmentsLoadedEvent(formAPI.getComponent())
	formAPI.fireEvent(addEvent);
	formAPI.fireEvent(loadEvent);   
}

Nous pouvons constater, qu’au niveau de la pièce jointe, une icône de recherche est apparue. Cliquez dessus et le formulaire de recherche spécifié (ici DefaultSearch) s’ouvre dans une popup. Effectuez votre recherche et sélectionnez un document.

Pour aller plus loin…

Ce type d’action, permettant l’ajout d’un composant existant en tant que pièce jointe d’une tâche, peut nécessiter une gestion plus fine des actions natives ajoutées par FlowerDocs.

  • Commmençons par ajouter la fonction suivante nous permettant d’activer ou de désactiver les actions en fonction du composant attaché :

    function updateActionsForAttachment(actions, attachment){
    	var attachmentIsValid = attachment != undefined;
    	actions.get("searchDocument").setEnabled(!attachmentIsValid);
    	actions.get("create-attached").setEnabled(!attachmentIsValid);
    	actions.get("delete-attached").setEnabled(attachmentIsValid);
    }
    
  • Modifions la fonction openSearchTemplate afin de mettre à jour les actions après la sélection d’un résultat de recherche en ajoutant l’appel suivant :

    updateActionsForAttachment(card.getActions(), component);
    
  • Modifions l’abonnement à l’ajout de la carte pour réagir aux modifications effectuées au travers des actions natives en appelant la fonction suivante :

    function bindOnAttachmentChange(card){
    	card.registerForChange(function(attachment){
    		updateActionsForAttachment(card.getActions(), attachment);		
    	});
    }
    


Consultez la documentation pour plus de précisions :