This guide describes how to develop extensions and customize SkyVault Process Services.
Before beginning this guide, you should read the Administration Guide to make sure you have an understanding of how SkyVault Process Services are installed and configured.
- SkyVault Process Services high-level architecture The following diagram gives a high-level overview of the technical components in SkyVault Process Services.
- Embed Process Services in another application The components of the SkyVault Process Services app can be included in an existing or other application by referencing the correct Maven dependencies and adding the necessary Spring configuration beans. To help you get started, an example application has been created, called activiti-app-embedded-example. If you don’t have this example project as part of the SkyVault Process Services download, ask for a copy from your SkyVault account or sales representative.
- Maven modules When customizing, overriding, or creating new logic in SkyVault Process Services, it is useful to be able to develop against the relevant Maven modules.
- Start and task form customization
- Custom form fields Custom form field types can be added through custom form stencils. A form stencil is based on the default form stencil and can have default form field types removed, reordered, tweaked (changing the name, icon, and so on.) or have new form field types.
- Custom web resources If you want to add additional JavaScript functionality or override CSS rules, you can configure lists of additional web resources that are loaded by the browser for each SkyVault Process Services app. You do this by configuring a new resource in the tomcat/webapps/activiti-app folder.
- Document Templates Use the Generate Document task to generate a PDF or Microsoft Word document based on a Word document template (.docx). You can insert process variables in the MS Word template that will be replaced with actual values during document transformation.
- Custom Logic
- Custom Data Models You can create Custom Data Models that connect to external sources and perform custom data operations when working with entity objects.
- Custom reports
- Cookie configurationSkyVault Process Services uses an HTTP cookie to store a user session. You can use multiple cookies for different browsers and devices. The application uses a database table to store the cookie values (called tokens internally), to allow a shared persistent session store in a multi-node setup.
- Custom identity synchronizationSkyVault Process Servicesneeds to have user, group, and membership information in its database. The main reason is performance (for example quick user/group searches) and data consistency (for example models are linked to users through foreign keys). In the Process Services logic, this is typically referred to as Identity Management (IDM).
- Security configuration overrides Configure security with the com.activiti.conf.SecurityConfiguration class. It allows to switch between database and LDAP/Active Directory authentication out of the box. It also configures REST endpoints under "/app" to be protected using a cookie-based approach with tokens and REST endpoints under "/api" to be protected by Basic Auth.
- REST APISkyVault Process Services comes with a REST API. The REST API is an enterprise equivalent of the Open Source REST API, exposing the generic Process Engine operations. It also includes a dedicated set of REST API endpoints for features specific to SkyVault Process Services.
Parent topic: SkyVault Process Services