Deploy and configure Journey Workspaces

This guide explains how to set up the new Journey Workspaces module in Journey Manager and the steps required to configure collaboration jobs to work with Workspaces.

note

In order to perform the following Workspaces deployment and configuration procedures, you must be logged in to your Journey Manager (JM) environment using an account with sufficient administrative privileges (for example, the System Manager role).

Deploy Workspaces in Transact Manager

Journey Workspaces is delivered as a WAR file. Follow these steps to deploy the Journey Workspaces WAR file in Transact Manager.

1. In Transact Manager, select Forms > Form Spaces.
2. Click Import WAR.
3. Click Choose File to locate the Workspaces WAR file, then select the WAR File and close the file browser dialog.
4. Click Import to complete the WAR file deployment.

Upon successful deployment, a new form space called Work Spaces appears on the Form Spaces page in Journey Manager. If you don’t see the Work Spaces form space after a few minutes, the deployment may have failed and you may need to request assistance to resolve this.

tip

You can request assistance from your Temenos customer service representative or by raising a support request (login required). To aid in troubleshooting your deployment issue, locate the {warfilename}.war.FAILED file in your JM environment's deployment folder and attach it to your support request.

Prepare Workspaces for first use

Once Workspaces has been successfully deployed, a number of configuration steps are required to prepare Workspaces for use by end users.

• Configure your new Workspaces space
• Configure the appearance and behavior of your new Workspaces space
• Link an organization to your new Workspaces space
• Grant users access to your new Workspaces space

Configure the Workspaces space

You can edit the Workspaces space to configure attributes such as the context path and other access related settings. For more information about configuring a form space, see Configure a Form Space.

1. In Transact Manager, select Forms > Form Spaces.
2. In the list of form spaces, locate the Workspaces space and click the Edit icon for that space. Alternatively, you can click the Workspaces Name.
3. Select the Space tab.
4. Update the domain part of the Context Path URL to be the same as Transact Manager’s domain.
5. From the Security Manager dropdown, select a security manager to be used for Workspaces.
6. Select an option from the Authentication Mode dropdown to define the level of authentication required to access Workspaces.
7. If you need to be able to modify the Workspaces space at runtime, select the Content Editable checkbox.
8. Select Default Forms Space to route all job step actions to the new Workspaces space by default.

info

If you want to use a Context Path domain different to the Journey Manager domain then you may need to configure a reverse proxy for redirection.

Configure Workspaces appearance and behavior

Journey Workspaces requires a space property called space to be defined. This property drives the configurable part of the Workspaces user interface and behavior.

1. In Transact Manager, select Forms > Form Spaces.
2. In the list of form spaces, locate the Workspaces space and click the Edit icon for that space. Alternatively, you can click the Workspaces Name.
3. Select the Properties tab and look for a property called space in the property list.
4. If you don't see a space property in the property list, click New to create it. Enter "space" in the Name box, and select JSON from the Type dropdown. A Value box appears when you select a Type.
5. In the Value box, enter a space configuration. For details of the space configuration format, see Space.
6. Click Save.

note

To learn how to configure the space configuration file, see Space where you'll also find a sample of the property.

Link an organization

Journey Workspaces needs to be linked to a Journey Manager organization so that forms and transactions generated from the collaboration job can be accessed by Journey Workspaces. Follow these steps to ensure Journey Workspaces is linked to your organization.

1. In Transact Manager, select Forms > Organization.
2. Select the Spaces tab.
3. If the Journey Workspaces space is in the Available Spaces list, select it and click > to move it to the Assigned Spaces list.
4. Click Save.

Grant user access

Journey Workspaces users must be assigned to the Workspaces space before they can login and access Workspaces features. Follow these steps to grant users access to Workspaces.

1. In Transact Manager, select Security > User Accounts.
2. In the list of user accounts, locate the user to be configured and click the Edit icon for that user. Alternatively, you can click the user's Login Name.
3. Select the Spaces tab.
4. If Workspaces is in the Available list, select it and click > to move it to the Assigned list.
5. Click Save.
6. Select the Roles tab.
7. Ensure the roles required to use Workspaces (Work Spaces Staff) are assigned to the user account.
8. Click Save.

info

The Early Access release of Journey Workspaces supports the processing staff role only. More roles will be supported in future releases.

Accessing the portal

To access Journey Workspaces, open your preferred supported browser and enter the Context Path URL for your Workspaces space. For example: https://{yourdomain}/workspaces/secure/login.html.

Configuring the collaboration job

This section explains how to configure a collaboration job to route the review tasks to Journey Workspaces, and the steps required to copy the data extracts and submission properties from an applicant’s original submission transaction to the review task.

Journey Workspaces offers great flexibility in filtering and sorting transactions, which helps processing staff to find the tasks they need to review. In order to support these features, the application requires all the necessary data from the applicant’s original submission transaction that's captured as the form data extracts or the submission properties.

Setting up each collaboration job to capture this data is a complex task. Template Groovy scripts that can assist with the collaboration job setup are provided with Journey Workspaces.

Copy the form data extracts and submission properties

A Groovy script for a service called “Replicate properties” is supplied with Journey Workspaces. The "Replicate properties" service copies the contents of form data extracts and submission properties from the original submission to the submission properties of the review task that will be accessed from Journey Workspaces. Follow these steps to add the "Replicate properties" service to Transact Manager.

1. In Transact Manager, select Services > All Services.
2. Click Import.
3. Click Browse then locate the "Replicate properties" file, select the file, and close the file browser dialog.
4. Click Upload to upload the selected file to Transact Manager.

Once the "Replicate properties" service has been added to JM, modify the collaboration job to use this service.

1. In Transact Manager, select Services > Job Services.
2. In the list of services, locate the collaboration job that manages the workflow of the application that will be reviewed in Workspaces, and click the Edit icon for that service. Alternatively, you can click the service's name in the Service column.
3. In the Job Definition, add a "Replicate properties" action after each review task. This will cause the contents of the original submission to be copied automatically to the review task.

{
    "name": "Manual Review",
     ...
    "actions": [
        {
            "name": "Create Task",
            "type": "Job Task Assign",
            "properties": [
            ...
            ]
        },
        {
            "name": "Replicate properties",
            "type": "Job Action"
        },
        ...
    ]

Finally, to route the review tasks to Workspaces, check the collaboration job definition and ensure the review task steps are assigned to Workspaces as shown below.

{
    "name": "Manual Review",
    ...
    "actions": [
    {
        "name": "Create Task",
        "type": "Job Task Assign",
        "properties": [
            ...
            { "name": "Task Assign Portal",  "value": "Work Spaces" },
            ...
        ]
    },

Setup the template review form

Currently, Journey Workspaces doesn’t support performing decisions from the portal. However, this can be achieved by using the template decision form for managing the decision-making process that is supplied with Journey Workspaces.

The template decision form, developed using Transact Maestro, has the following sections which can be extended to include additional business logic you need.

• A section for uploading documents from the review process.
• A section for making the decision and adding justifications about the decision made.

The template form also has a callback mechanism on submit which passes the supporting information captured in the form to Workspaces, where it is displayed in the application timeline.

Set up the review form in JM

This section explains how to add the template review form to Transact Manager, and configure it to be associated with the review task.

Add the review form to JM

Follow these steps to add the template review form to JM and, if required, rename the form.

1. In Transact Manager, select Forms > Forms.
2. Click Import Form.
3. Click Browse then locate the template review form supplied with Journey Workspaces, select the form file, and close the file browser dialog.
4. Click Upload.
5. Once the review form is imported, add Journey Workspaces as the associated form space. On the form's dashboard, select the Spaces tab, then click New, select Workspaces from the dropdown and click Save.

If you need to rename the review form or change its form code, follow these steps.

1. Navigate to the form's dashboard.
2. In the Form Details section, click the Form Display name.
3. On the Details tab, update the Form Display Name and Form Code as required.
4. Click Save.

Configure the collaboration job

To associate review tasks from the collaboration job with the template review form (added in the previous step), follow these steps.

1. In Transact Manager, select Services > Job Services.
2. In the list of services, locate the collaboration job that manages the workflow of the application that will be reviewed in Workspaces, and click the Edit icon for that service. Alternatively, you can click the service's name in the Service column.
3. Select the Job Definition tab.
4. Update the job definition, as required, to ensure review tasks are associated with the template review form as shown below.

{
    "name": "Manual Review",
    ...
    "actions": [
        {
            "name": "Create Task",
            "type": "Job Task Assign",
            "properties": [
                { "name": "Task Form Code",  "value": "reviewtemplate" },
                ...
                ]
        },

That completes setup of your Journey Workspaces portal.