APIs zum Zugriff auf Briefinstanzen

Überblick

Durch Verwenden der Benutzeroberfläche „Korrespondenz erstellen“ von Correspondence Management können Sie Entwürfe von Briefinstanzen unter Fortschritt speichern und es gibt gesendete Briefinstanzen.

Correspondence Management bietet APIs, mit denen Sie die Listenschnittstelle erstellen können, um mit gesendeten Briefinstanzen oder Entwürfen zu arbeiten. Die APIs listen und öffnen gesendete und Entwurfsbriefinstanzen eines Agenten, damit der Agent weiterhin an den Entwurfs- oder gesendeten Briefinstanzen arbeiten kann.

Abrufen von Briefinstanzenf

Correspondence Management stellt APIs bereit, um Briefinstanzen mithilfe von LetterInstanceService abzurufen.

Verwendung von getAllLetterInstances

Die folgende API findet die Briefinstanzen basierend auf dem Abfrageobjekt (Gesendet und Entwurf). Wenn das Abfrageobjekt null ist, werden alle Briefinstanzen zurückgegeben. Diese API gibt eine Liste der LetterInstanceVO-Objekte zurück, die zum Extrahieren zusätzlicher Informationen der Briefinstanz verwendet werden können

Syntax: List getAllLetterInstances(Query query) throws ICCException;

Beispiel 1: Rufen Sie alle Briefinstanzen des Typs GESENDET ab

Der folgende Code gibt die Liste der gesendeten Briefinstanzen zurück. Um nur Entwürfe zu erhalten, ändern Sie LetterInstanceType.COMPLETE.name() in 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);

Beispiel 2: Rufen Sie alle Briefinstanzen, die von einem Benutzer gesendet wurden auf; der Briefinstanztyp ist ENTWURF

Der folgende Code enthält mehrere Anweisungen in derselben Abfrage, um die Ergebnisse anhand verschiedener Kriterien zu filtern, wie z. B. die von einem Benutzer gesendete Briefinstanz (Attribut gesendet von) und der Typ von letterInstanceType ist DRAFT.

@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);

Verwenden von getLetterInstance

Rufen Sie die Briefinstanz auf, die von der angegebenen Briefinstanz-ID identifiziert wird. Es wird "null"zurückgegeben, wenn die Instanz-ID nicht übereinstimmt.

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

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

Überprüfen, ob Briefinstanz vorhanden ist

Prüfen Sie anhand des angegebenen Namens, ob eine Briefinstanz vorhanden ist

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

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

Öffnen von Briefinstanzen

Briefinstanz kann vom Typ „Gesendet“ oder „Entwurf“ sein Wenn die beiden Briefinstanztypen geöffnet werden, werden unterschiedliche Verhalten gezeigt:

• Bei der Briefinstanz „Gesendet“ wird ein PDF-Dokument geöffnet, das die Briefinstanz darstellt. Briefinstanz „Gesendet“, die auf dem Server vorhanden ist, enthält auch die dataXML und verarbeitete XDP, die verwendet werden können, um Anwendungsfälle wie das Erstellen einer PDF/A weiter anzupassen.
• Im Fall der Briefinstanz "Entwurf"wird die Benutzeroberfläche "Korrespondenz erstellen"in den exakten vorherigen Status wie zum Zeitpunkt der Erstellung des Entwurfs neu geladen

Öffnen der Briefinstanz "Entwurf" 

Die CCR-Benutzeroberfläche unterstützt den Parameter cmLetterInstanceId , der zum Neuladen des Briefs verwendet werden kann.

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

Öffnen einer gesendeten Briefinstanz

Gesendetes PDF-Dokument kann mit der Briefinstanz-ID direkt geöffnet werden:

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