Unified API Developer Manual / Version 2406.1

Table Of Contents

Unified API Developer Manual

Copyright CoreMedia GmbH © 2024

CoreMedia GmbH

Altes Klöpperhaus, 5. OG

Rödingsmarkt 9

20459 Hamburg

International

All rights reserved. No part of this manual or the corresponding program may be reproduced or copied in any form (print, photocopy or other process) without the written permission of CoreMedia GmbH.

Germany

Alle Rechte vorbehalten. CoreMedia und weitere im Text erwähnte CoreMedia Produkte sowie die entsprechenden Logos sind Marken oder eingetragene Marken der CoreMedia GmbH in Deutschland. Alle anderen Namen von Produkten sind Marken der jeweiligen Firmen.

Das Handbuch bzw. Teile hiervon sowie die dazugehörigen Programme dürfen in keiner Weise (Druck, Fotokopie oder sonstige Verfahren) ohne schriftliche Genehmigung der CoreMedia GmbH reproduziert oder vervielfältigt werden. Unberührt hiervon bleiben die gesetzlich erlaubten Nutzungsarten nach dem UrhG.

Licenses and Trademarks

All trademarks acknowledged.

December 12, 2024

1.1. Audience

1.2. Typographic Conventions

1.3. CoreMedia Services

1.3.1. Registration
1.3.2. CoreMedia Releases
1.3.3. Documentation
1.3.4. CoreMedia Training
1.3.5. CoreMedia Support

1.4. Changelog

2. Unified API Overview

2.1. Features and Design Goals
2.2. Use Cases

3. An Introductory Example

4. Common Concepts

4.1. Connection

4.1.1. Creating a Connection
4.1.2. Lifecycle and Caching
4.1.3. Connection Listener
4.1.4. Server Control

4.2. Repositories and Services

4.3. Objects

4.4. Values

4.4.1. XML Texts
4.4.2. Blobs
4.4.3. Lists
4.4.4. Structs

4.6. Identifiers and Equality

4.7. Listeners

4.8. Exceptions

4.9. Sessions

4.10. Caching

4.11. Serialization

4.12. Further Reading

5. The Content Repository

5.1. Objects
5.2. UUIDs
5.3. Types
5.4. Access Control
5.5. Publication Service
5.6. Observed Property Service
5.7. Query Service
5.8. Search Service of the Unified API
5.9. Workflow Content Service
5.10. Property Service
5.11. Listeners
5.12. Further Reading

6. The Workflow Repository

6.1. Objects

6.2. Workflow States

6.3. Differences to the Classic Workflow API

6.4. The Work List Service

6.5. Workflow Variables and Views

6.6. The Access Control Service

6.7. Managing Process Definitions

6.8. Events

6.9. Timers

6.10. Writing Own Plugins

6.10.1. Programming Restrictions
6.10.2. Serialization
6.10.3. Actions
6.10.4. Long Actions
6.10.5. Final Actions
6.10.6. Expressions
6.10.7. Performer Policies
6.10.8. Rights Policies
6.10.9. Remote Client Actions
6.10.10. Managers

6.11. Examples

6.11.1. Example Clients
6.11.2. Example Plugins
6.11.3. Example Code of the Mail Action

6.12. Guide to the API Documentation

7. The User Repository

7.1. Objects
7.2. UUIDs
7.3. Retrieving Objects
7.4. Listeners
7.5. Further Reading

List of Figures

4.1. Class Diagram: Repositories and Services
4.2. Class Diagram: Blobs
4.3. Class Diagram: Types
4.4. Class Diagram: Repositories and Identified Objects
4.5. Class Diagram: Listeners
5.1. Class Diagram: Content and Versions
5.2. Statechart: Checked In and Out
5.3. Statechart: Place Approvals
5.4. Statechart: Deleting
5.5. Statechart: Version
5.6. Statechart: Content Publication
6.1. Workflow Class Diagram
6.2. States of a process
6.3. States of an automated task
6.4. States of a Task
6.5. Workflow Object and View Definitions
6.6. Workflow views
7.1. Class Diagram: Users and Groups

List of Tables

1.1. Typographic conventions
1.2. Pictographs
1.3. CoreMedia manuals
1.4. Changes
4.1. Connection properties
4.2. Parameters of connection's management bean
4.3. ID formats for CapObject
4.4. ID formats for CapType
4.5. ID formats for other objects
5.1. Rights for the Unified API
5.2. Types in subexpressions
6.1. WfAPI signal names and UAPI event classes

List of Examples

3.1. Create a new folder
4.1. Open a session
4.2. Log in another session
4.3. Using a session pool
6.1. AbortAllProcesses
6.2. Suspend My Processes
6.3. Create Process Example
6.4. The SendMail action

Preface

Search Results

Table Of Contents