ImageMaster web services

Server-side functionality, as it is provided by the Integration Service by web services, is packaged and released in the shape of an EAR file which has to be deployed on an application server such as WildFly or JBoss. For details and prerequisites on installation and configuration see the installation manual [IM ImageMaster].

Beside the low-level configuration, which has to be done in the application server environment, all central system configuration aspects are handled by the AdminClient (see chapter ImageMaster AdminClient). Further specific customization capability is provided by the extension mechanism (see chapter Extensions). Extensions are integrated into a project-specific EAR file of an ImageMaster release and do not need be deployed in a stand-alone fashion.

The following sections present an overview of the web services which are likely to be deployed in any Integration Service environment.

The following web services are considered as System Management services:

• The ImaAuthorizationService provides methods for managing roles, i.e. listing existing roles, creating roles, deleting roles, renaming roles and updating roles.

• The ImaTypeService provides methods for managing document types such as listing existing types, creating new types, updating types, deleting types and creating database indexes for a type.

• The ImaUserlibService provides methods for managing users via web services, i.e. it offers methods to create, store, find or delete users, to attach existing roles to users, and to manage user groups.1 The usage of this service may not always be required. For example, it does not make sense to manage users, if this is handled by an upstream system that uses ImageMaster as its archive repository only. Access control in such a case can still be modeled by permissions based only on roles being handled solely by the authorization service.

• The ImaStatisticsService provides methods for managing, collecting, and retrieving statistics about system usage and activity. Historic data is covered and compacted, so trends can be observed over time.

• The ImaAdminService, which is documented in a dedicated reference manual [WS AdminClient], provides methods for configuring an ImageMaster environment. These services can be used for automating the set-up of an initial configuration as an alternative to manually setting up a configuration by the AdminClient (see chapter ImageMaster AdminClient).

Further optional and cross-functional services can also be considered to be of administrative nature (see Optional and internally used web services below).

The following web services are considered as Document Management Services:

• The ImaDocumentService provides methods for managing documents, revisions, and contents in terms of creating documents with revisions and content, and retrieving revisions with contents.

• The ImaVersioningService provides methods for modification in a controlled manner with respect to documents, revisions or contents, i.e. checking in and checking out revisions, creating or deleting contents, or updating attributes and further metadata of revisions or contents.

• The ImaSearchService provides a method for querying the repository based on RAQL.

• The ImaBatchService provides batch operations for FIS (see chapter ImageMaster File Interoperability Service (FIS)) for bulk import/export/update/deletion. FIS requires its own commercial license.