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 répertorient et ouvrent les brouillons et les instances de lettre envoyées d’un agent, de sorte que l’agent puisse continuer de travailler sur les brouillons ou les instances de lettre envoyées.

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.

Méthode Description
getAllLetterInstances Récupère des instances de lettre en fonction du paramètre de requête d’entrée. Pour récupérer toutes les instances de lettre, transmettez le paramètre de requête comme nul.
getLetterInstance Récupère l’instance de lettre spécifiée en fonction de l’ID de l’instance de lettre.
letterInstanceExists Vérifie l’existence d’une instance de lettre selon le nom spécifié.
REMARQUE

LetterInstanceService est un service OSGi et son instance peut être récupérée à l’aide de @Reference dans Java
ou sling.getService (LetterInstanceService. ) dans JSP.

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 de la requête est nul, il renvoie toutes les instances de lettre. Cette API renvoie une liste d’objets LetterInstanceVO qui peuvent être utilisés pour extraire des informations supplémentaires relatives à l’instance de lettre.

Syntaxe : List getAllLetterInstances(Query query) throws ICCException;

Paramètre Description
query Le paramètre de requête est utilisé pour trouver/filtrer l’instance de lettre. Ici, la requête prend en charge uniquement des attributs/propriétés supérieurs de l’objet. La requête se compose d’instructions et l’« attributeName » utilisé dans l’objet d’instruction doit être le nom de la propriété dans l’objet d’instance de lettre.

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 afficher uniquement les brouillons, modifiez 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 possède plusieurs instructions dans la même requête pour obtenir les résultats filtrés en fonction de différents critères tels que l’instance de lettre envoyée (attribut submittedby) par un utilisateur, le type de letterInstanceType étant 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. Il renvoie « null » si l’ID de l’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érifiez si une instance de lettre existe selon le nom spécifié.

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

Paramètre Description
letterInstanceName Il s’agit du nom de l’instance de lettre dont vous souhaitez vérifier l’existence. 
@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]

REMARQUE

Il n’est pas nécessaire de préciser les valeurs cmLetterId ou cmLetterName/State/Version lorsque vous rechargez une correspondance, car les données envoyées contiennent déjà tous les détails sur la correspondance rechargée. RandomNo est employé pour éviter des problèmes de mémoire cache du navigateur. Vous pouvez utiliser l’horodatage comme un nombre aléatoire.

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]

Sur cette page