Service Types

   Journey Manager (JM) Previously known as Transact Manager (TM). |   System Manager / DevOps |  v5.1 & Higher This feature is related to v5.1 and higher.

Manager uses service types to define services for various tasks, such as rendering forms or dynamic data calls.

A service type:

  • Acts as a template by providing the applicable set of parameters to define a service.
  • Determines how a service can be used.
  • Can have a default service (if one is selected as the default).

Each service type belongs to one or more categories and has a defined scope.

A service category can be one of the following:

A service scope can be:

  • Global - a service has a global access within Manager.
  • Organization - a service has access within a selected organization only.
  • Both - Global or Organization, as required.

Manager has the following predefined service types, by which services are grouped:

Service Type Category Scope Description

Data Retention Management

Core Global Service

Global

Performs data purging including PIIPersonally Identifiable Information (PII) is information about an individual that can be used to distinguish or trace an individual‘s identity, such as name, social security number, date and place of birth, mother‘s maiden name, or biometric records; and any other information that is linked to an individual. data.

Delivery Function

Transact Function Both

Performs the submission data delivery using Fluent functions.

Delivery Process

Form Service

 

Passes the submission data and attachments, as well a customizable Groovy delivery service across, to perform a delivery.

Dynamic Data

Form Service

 

Obtains data dynamically from external systems or services. Forms can use this service for data pre-fill, lookup or validation.

Email Queue

Core Global Service

 

Processes emails stored in the email queue.

Email Service

Core Global Service

Form Service

 

Provides a default SMTPSMTP (Simple Mail Transfer Protocol) is a TCP/IP protocol used in sending and receiving e-mail. However, since it is limited in its ability to queue messages at the receiving end, it is usually used with one of two other protocols, POP3 or IMAP, that let the user save messages in a server mailbox and download them periodically from the server. In other words, users typically use a program that uses SMTP for sending e-mail and either POP3 or IMAP for receiving e-mail. On Unix-based systems, sendmail is the most widely-used SMTP server for e-mail. A commercial package, Sendmail, includes a POP3 server. Microsoft Exchange includes an SMTP server and can also be set up to include POP3 support. email service.

You can also create a Groovy email service.

Find Delivery Process ID

Core Global Service

 

Updates the delivery process ID assigned by Adobe LiveCycleAdobe LiveCycle Enterprise Suite (ES4) is an service-oriented architecture Java EE server software product from Adobe Systems used to build applications that automate a broad range of business processes for enterprises and government agencies. LiveCycle ES4 is an enterprise document and form platform that allows capturing and processing information, delivering personalized communications, and protecting and tracking sensitive information. It is used for purposes such as account opening, services and benefits enrollment, correspondence management, request for proposal processes, and other manual based workflows. for submissions delivered to an Adobe LiveCycle process.

Fluent Function

Transact Function Both

Implements any service adhering to Transact Fluent API

Form Meta Data

Core Global Service

Global

Renders the metadataMetadata is data that describes other data. Meta is a prefix that in most information technology usages means "an underlying definition or description." Metadata summarizes basic information about data, which can make finding and working with particular instances of data easier. For example, author, date created and date modified and file size are examples of very basic document metadata. Having the abilty to filter through that metadata makes it much easier for someone to locate a specific document. related to the form as HTML

Form PDF Pre Render

Core Global Service

 

This service is called when a new Composer SmartForm with an XDP form template is created. It uses an Adobe LiveCycle orchestration to pre-render a PDF from the XDP template. This PDF is used for form rendering, which speeds up rendering and reduces the load on LiveCycle's processes.

Form Prefill

Form Service

 

Retrieve prefill XML data for a form. The service can be defined at a form version level, otherwise a global default service is used. The service is called at form render time.

Form Saved Processor

Form Service

 

This service is called when a form is saved to Manager, and the form version in question has been associated with a Form Saved Processor service. The default service allows you to specify custom logic in a Groovy script.

Form Security Filter

Form Service

 

Provides a security filter for a form.

Form Server Load Balancer

Core Global Service

 

This service is called by various operations involving LiveCycle -for example, rendering forms and receipts - and is used to ensure capacity to perform the operation is available. It also performs load balancing if more than one LiveCycle server is available.

Form Submission Access Controller

Core Global Service

 

Provides security features based around the completion of a form.

Form Version Selector

Core Global Service

Form Service

 

Selects the appropriate form version to render a form

Groovy Service

Form Service

Both

Provides GroovyGroovy is a powerful scripting language which runs on the Java Virtual Machine. Across theJourney platform, Groovy is used to create services in Manager. These services are primarily used to create plug-in style systems that interact with Manager. code that can be reused by other Groovy services in Manager.

Job Action

Job Service

 

Provides a Job Action service related to collaboration jobs. You can implement it using the GrooveyJobActionService or the FluentJobActionService. See com.avoka.fc.core.service.job.impl.JobActionService API.

Job Action Wait

Job Service

 

Provides a Job Action Wait service related to collaboration jobs. This service waits until all the steps of the previous Invoked actions have been completed. You can implement it using the GrooveyJobActionService or the FluentJobActionService. See com.avoka.fc.core.service.job.impl.JobActionWaitService API.

Job Controller

Job Service

Form Service

 

Creates a new collaboration job for a form submission and then processes it. This service needs to be associated with the form version.

Job Delivery

Job Service

 

Provides a Job Delivery service related to collaboration jobs. This service performs actual delivery within a collaboration job. This service is used in conjunction with the Job Delivery Wait service to kick off the standard Transact Delivery process. The delivery process is completed by the Transaction Processing Scheduled Job, not the job controller service. See com.avoka.fc.core.service.job.impl.JobDeliveryService API.

Job Delivery Wait

Job Service

 

Provides a Job Delivery Wait service related to collaboration jobs. This service waits for a delivery to be complete as a part of a collaboration job. The Job Delivery Wait service is an asynchronous mechanism. When the delivery is completed by the Transaction Processing job it calls a callback method that allows the Job Delivery Wait to complete. See com.avoka.fc.core.service.job.impl.JobDeliveryWaitService API.

Job Expiry

Job Service

 

Provides a Job Expiry service related to collaboration jobs. You can implement it using the GroovyJobActionService or the FluentJobActionService. .See com.avoka.fc.core.service.job.impl.JobExpiryService API.

Job Form Start

Job Service

 

Provides a Job Form Start service related to collaboration jobs. This service associates the initial form submission with the initial step. It can add a submission processing status message to the initial submission. These appear in the user's submission history. It can also send a status update via email. See com.avoka.fc.core.service.job.impl.JobFormStartService API.

Job Process Message

Job Service

 

Provides a Job Process Message service related to collaboration jobs. This service adds a submission processing status messages to the specified Submission. These appear in the user's submission history. This action service can be used anywhere in the job but is especially useful in endpoint steps. It can also send a status update via email. See com.avoka.fc.core.service.job.impl.JobProcessMessageService API.

Job Receipt Wait

Job Service

 

Provides a Job Receipt Wait service related to collaboration jobs. This action polls the submissions until the receipts have completed. The generation of the receipts is completed by a separate Transact Scheduled Job 'Transaction Processing' which by default runs every 5 minute. This action will complete when all receipts have been generated for this job's submissions. If any receipt has not completed the action returns a result of "In Progress". This will mean the Job Action / Job processing will stop and retry again in 1 minute. This is required as the existing Job Task Wait service does not wait for receipts to be created. See com.avoka.fc.core.service.job.impl.JobReceiptWaitService API.

Job Task Assign

Job Service

 

Provides a Job Task Assign service related to collaboration jobs. The Job Task Assign Service is used for creating and assigning tasks in Journey Manager. It has the configuration properties associated with:

  • Status Updates and Email: This service can add a submission processing status messages to the specified Submission. These appear in the user's submission history. It can also send a status update via email
  • Task Assignment: These properties are used in the creation and assignment of user and group tasks.

Tasks can be categorized as:

  • Standard Tasks - to an authenticated user or a group.
  • Review Tasks - these are the similar to the standard tasks but form xml and attachments are copied from a previous submission.
  • Anonymous Save - A submission record is saved but not assigned to a user in the database. They are usually assigned to a email address, the user is sent a notification email. They click on a link. The user has to enter a challenge response before they have access to the task form.

See com.avoka.fc.core.service.job.impl.JobTaskAssignService API.

Job Task Wait

Job Service

 

Provides a Job Task Wait service related to collaboration jobs. A Job Task Wait Service is paired in the 1 step with 1 or more Job Task Assign Action that creates a task. It provided an asynchronous wait mechanism described below in State Transition section. that allows the user time to complete the task via submission. When a submission comes in the Job Task Wait will execute. The code will check that JobTaskAssign actions have completed.

  • Not All Complete: it will go back and wait for more submissions.
  • All Complete: It will allow execution to the next step.

See com.avoka.fc.core.service.job.impl.JobTaskWaitService API.

Payment Gateway

Core Global Service Both

Processes payments by connecting to a payment gateway and making a payment transaction.

Payment Reminder

Core Global Service

 

Sends out reminder emails about submissions that have outstanding payments older than a certain age; that is, the Reminder Age Hours service parameter. Emails are sent to administrators belonging to the Receive Outstanding Payment Alerts group. This service is periodically called by the payment reminder job.

Receipt Number

Core Global Service

Form Service

 

Calculates receipt numbers for new submissions.

Render Composer HTML Form

Core Global Service

Global

Renders HTML forms created in Maestro or Composer.

Render Form

Core Global Service

Form Service

 

Uses an orchestration in LiveCycleAdobe LiveCycle Enterprise Suite (ES4) is an service-oriented architecture Java EE server software product from Adobe Systems used to build applications that automate a broad range of business processes for enterprises and government agencies. LiveCycle ES4 is an enterprise document and form platform that allows capturing and processing information, delivering personalized communications, and protecting and tracking sensitive information. It is used for purposes such as account opening, services and benefits enrollment, correspondence management, request for proposal processes, and other manual based workflows. to render a form when it is opened to be filled in.

Render Offline Submission Form

Core Global Service

 

Uses an orchestration in LiveCycle to render a form when it is submitted after being saved offline.

Render Receipt

Core Global Service

Form Service

 

Renders a form's receipt using one of the following orchestrations: LiveCycleAdobe LiveCycle Enterprise Suite (ES4) is an service-oriented architecture Java EE server software product from Adobe Systems used to build applications that automate a broad range of business processes for enterprises and government agencies. LiveCycle ES4 is an enterprise document and form platform that allows capturing and processing information, delivering personalized communications, and protecting and tracking sensitive information. It is used for purposes such as account opening, services and benefits enrollment, correspondence management, request for proposal processes, and other manual based workflows., PhantomJSPhantomJS is a scripted, headless browser used for automating web page interaction. PhantomJS provides a JavaScript API enabling automated navigation, screenshots, user behavior and assertions making it a common tool used to run browser-based unit tests in a headless system like a continuous integration environment. PhantomJS is based on WebKit making it a similar browsing environment to Safari and Google Chrome (before Chrome's fork of WebKit evolved into Blink). It is open-source software released under the BSD License., Static PDF, IText.

Repository Publish

Core Global Service

 

Publishes a single form to the LiveCycleAdobe LiveCycle Enterprise Suite (ES4) is an service-oriented architecture Java EE server software product from Adobe Systems used to build applications that automate a broad range of business processes for enterprises and government agencies. LiveCycle ES4 is an enterprise document and form platform that allows capturing and processing information, delivering personalized communications, and protecting and tracking sensitive information. It is used for purposes such as account opening, services and benefits enrollment, correspondence management, request for proposal processes, and other manual based workflows. repositories

Repository Synchronize

Core Global Service

 

Brings the LiveCycle repositories up to date after the set of form versions has changed.

Scheduled Service

Core Global Service

Form Service

 

Executes custom logic defined as a Groovy script.

Submission Completed Processor

Form Service

 

Processes completed submissions.

Submission Data Extraction

Core Global Service

 

Provides a service to extract the XML data document from a HTML form submission.

Submission Data Storage

Core Global Service

 

Stores and retrieves submission, receipt and attachment data.

Submission Data Validator

Form Service

 

Validates submitted data.

Submission Delivery Controller

Core Global Service

 

Performs submission delivery, marks submissions as undeliverable, and sends reminders.

Submission Email Verification

Core Global Service

 

Sends email verification requests to users who have submitted a form.

Submission Preprocessor

Form Service

 

Process submission data before it's submitted.

Submission Receipt

Core Global Service

 

Creates and stores receipts for new submissions, and re-attempts to render receipts for submissions where previous attempts failed.

Submission Service

Core Global Service

 

Performs submissions.

System Event Publisher

Core Global Service

 

Sends various server events to external systems.

Task Expiry Process

Core Global Service

Form Service

 

Invokes an external process to notify interested parties that the task has expired.

Test Suite

Form Service

 

Provides a test suite.

Tracking Number

Core Global Service

Form Service

 

Calculates tracking codes for new submissions.

Transaction Processor

Core Global Service

 

Performs processing of all submissions.

Two Factor Authentication

Core Global Service

 

Validates the second factor in two-factor authenticationTwo-factor authentication (2FA), sometimes referred to as two-step verification or dual factor authentication, is a security process in which the user provides two different authentication factors to verify themselves to better protect both the user's credentials and the resources the user can access. Two-factor authentication provides a higher level of assurance than authentication methods that depend on single-factor authentication (SFA), in which the user provides only one factor -- typically a password or passcode. Two-factor authentication methods rely on users providing a password as well as a second factor, usually either a security token or a biometric factor like a fingerprint or facial scan..

Virus Scan

Core Global Service

Form Service

 

Scan attachments stored in Manager for viruses.

You can create new services based on the existing types.

Next, learn how to view all services.