Optional and internally used web services

The following web services provide advanced features. These can require a special setup or may need to be licensed separately:

  • The ImaFulltextService is required for full-text support. It manages background jobs which create and maintain the full-text index in the underlying database in combination with the search provider Solr/Apache Lucene (see chapter Full-text search service).

  • The ImaTenancyService is necessary for multi-tenancy support (see chapter Multi-tenancy support). For each tenant a commercial license is required.

  • The ImaAuditService is necessary for audit trail support (see chapter ImageMaster Audit Trails), which requires its own commercial license.

  • The ImaRetentionService provides the means for retention management based on retention plans and events (also see chapter ImageMaster Retention Management). Retention management requires its own commercial license.

  • The ImaRecoveryService is necessary for Archive Recovery Management (ARM) to resynchronize storages after temporary outages (see chapter ImageMaster Archive Recovery Management). ARM requires its own commercial license.

The following web services are tailored to specialized scenarios and they are used by other ImageMaster services or by the web client:

  • The ImaMigrationService is used by the Upgrade Service (see chapter Upgrade service) to transform the database with its document model whenever an ImageMaster release requires this. This service also provides a foundation for customized migration projects.

  • The ImaSecurityService provides operations to manage the integrated password store (see chapter Authentication, authorization, and security). Passwords which are required for various system interconnections can be managed and protected by a master password with this standard feature of the AdminClient.

  • The ImaFolderService provides operations to organize documents in a folder structure. The WorkplaceClient (see chapter ImageMaster WorkplaceClient) supports static and dynamic dossier and browser views, which rely on this service.

  • The ImaSystemService provides methods to initialize the system and to retrieve system-wide properties. This service is used for internal purposes and several other ImageMaster services rely on this.