Utiliser les API pour accéder aux instances de lettre

Présentation

A l’aide de l’interface utilisateur de création de correspondance de Correspondence Management, vous pouvez enregistrer des brouillons d’instances de lettre en cours. Vous y trouverez également les instances de lettre envoyées.

Correspondence Management vous fournit des API grâce auxquelles vous pouvez créer l’interface d’énumération pour travailler sur des instances de lettre envoyées ou des brouillons. Les API liste et ouvrent les instances de lettre envoyée et de lettre brouillon d’un agent, de sorte que l’agent puisse continuer à travailler sur les instances de lettre brouillon ou envoyée.

Récupérer des instances de lettre

Correspondence Management expose les API pour récupérer des instances de lettre par le biais du service LetterInstanceService.

Utilisation de getAllLetterInstances

L’API suivante recherche les instances de lettre en fonction de l’objet de la requête (envoyée et brouillon). Si l’objet requête est nul, il renvoie toutes les instances de lettre. Cette API renvoie la liste des objets LetterInstanceVO qui peuvent être utilisés pour extraire des informations supplémentaires sur l’instance de lettre.

Syntaxe : List getAllLetterInstances(Query query) throws ICCException;

Exemple 1 : récupérer toutes les instances de lettre de type ENVOYEE

Le code suivant renvoie la liste des instances de lettre envoyées. Pour obtenir uniquement des brouillons, remplacez LetterInstanceType.COMPLETE.name() par LetterInstanceType.DRAFT.name()..

@Reference
LetterInstanceService letterInstanceService;
Query query = new Query();

List<LetterInstanceVO> submittedLetterInstances = new ArrayList<LetterInstanceVO>();

Statement statementForInstanceType = new Statement();
statementForInstanceType.setAttributeName("letterInstanceType");
statementForInstanceType.setOperator(Operator.EQUALS);
statementForInstanceType.setAttributeValue(LetterInstanceType.COMPLETE.name());
query.addStatement(statementForInstanceType);
submittedLetterInstances = letterInstanceService.getAllLetterInstances(query);

Exemple 2 : récupérer toutes les instances de lettre envoyées par un utilisateur, le type d’instance de lettre étant BROUILLON

Le code suivant comporte plusieurs instructions dans la même requête pour que les résultats soient filtrés en fonction de différents critères tels que l’instance de lettre envoyée (attribut submittedby) par un utilisateur et le type de letterInstanceType est BROUILLON.

@Reference
LetterInstanceService letterInstanceService;

String submittedBy = "tglodman";
Query query = new Query();

List<LetterInstanceVO> submittedLetterInstances = new ArrayList<LetterInstanceVO>();

Statement statementForInstanceType = new Statement();
statementForInstanceType.setAttributeName("letterInstanceType");
statementForInstanceType.setOperator(Operator.EQUALS);
statementForInstanceType.setAttributeValue(LetterInstanceType.COMPLETE.name());
query.addStatement(statementForInstanceType);

Statement statementForSubmittedBy = new Statement();
statementForSubmittedBy .setAttributeName("submittedby");
statementForSubmittedBy .setOperator(Operator.EQUALS);
statementForSubmittedBy .setAttributeValue(submittedBy);
query.addStatement(statementForSubmittedBy );
submittedLetterInstances = letterInstanceService.getAllLetterInstances(query);

Utilisation de getLetterInstance

Récupérez une instance de lettre identifiée par l’ID de l’instance de lettre en question. Elle renvoie "null si l’ID d’instance ne correspond pas.

Syntaxe : public LetterInstanceVO getLetterInstance(String letterInstanceId) throws ICCException;

@Reference
LetterInstanceService letterInstanceService;
String letterInstanceId = "/content/apps/cm/letterInstances/1001/sampleLetterInstance";
LetterInstanceVO letterInstance = letterInstanceService.getLetterInstance(letterInstanceId );

Vérification de l’existence de LetterInstance

Vérifier si une instance de lettre existe selon le nom donné

Syntaxe : public Boolean letterInstanceExists(String letterInstanceName) throws ICCException;

@Reference
LetterInstanceService letterInstanceService;
String letterInstanceName = "sampleLetterInstance";
Boolean result = letterInstanceService.letterInstanceExists(letterInstanceName );

Ouverture d’instances de lettre

L’instance de lettre peut être de type Envoyée ou Brouillon. L’ouverture des deux types d’instance de lettre présente deux cas de figure différents :

• Dans le cas d’une instance de lettre envoyée, un PDF représentant l’instance de lettre s’ouvre. L’instance de lettre envoyée conservée sur le serveur contient également les données XML et XDP traitées qui peuvent être utilisées à des fins d’exécution et de personnalisation selon les cas d’utilisation, comme la création d’un PDF/A.
• Dans le cas d’un brouillon d’instance de lettre, l’interface utilisateur de création de correspondance réapparaît exactement comme elle se présentait au moment où le brouillon a été créé

Ouverture d’un brouillon d’instance de lettre 

L’interface utilisateur CCR prend en charge le paramètre cmLetterInstanceId, qui peut être utilisé pour une lettre rechargée.

https://[hostName]:[portNo]/[contextPath]/aem/forms/createcorrespondence.html?random=[randomNo]&cmLetterInstanceId=[letterInstanceId]

Ouverture d’une instance de lettre envoyée

Le PDF envoyé peut être directement ouvert en utilisant l’ID de l’instance de lettre :

https://[hostName]:[portNo]/[contextPath]/[letterInstanceId]