Perceptive Media Connector

Transcription

1 Perceptive Media Connector Installation and Setup Guide Version: 1.0.x Compatible with ImageNow, version 6.7.x Written by: Product Documentation, R&D Date: August 2016

2 2015 Perceptive Software. All rights reserved. Lexmark and Perceptive Software are trademarks of Lexmark International, Inc., or its subsidiaries, registered in the U.S. and/or other countries. All other trademarks are the property of their respective owners. No part of this publication may be reproduced, stored, or transmitted in any form without the prior written permission of Perceptive Software.

3 Table of Contents Overview... 4 Prerequisites... 4 Licenses... 4 Overview of the set up process... 5 Install the Perceptive Media Connector... 5 Download the files... 5 Install the connector... 5 Configure ImageNow to use the connector... 6 Configure ImageNow Envoy... 6 Configure ImageNow Workflow... 6 Create a workflow process... 7 Create the queues... 7 Configure Perceptive Media Connector... 8 Prepare to map data between ImageNow and Perceptive Media... 8 Set the connector configuration settings... 8 Create and configure a channel... 9 Create a channel Replace an enabled channel Appendix: Configuration mappings Perceptive Media Connector Installation and Setup Guide Page 3 of 16

4 Overview Perceptive Media Connector provides cloud-based capture, storage, and management of video content within Perceptive Content. The connector creates a data channel between ImageNow and the Perceptive Media Platform, and it performs the following actions. Uploads values from ImageNow video content and document properties, and sends them to the Perceptive Media Platform. Paired with the previous upload, video metadata downloads to ImageNow adding pages to original documents based on those values. Captures values from externally uploaded content, creates ImageNow documents with those values and exposes user-generated content to ImageNow workflow processing. The connector takes advantage of an automated system queue (ASQ) in your ImageNow workflow process to transfer metadata seamlessly. This guide outlines the installation and configuration procedures for Perceptive Media Connector. It also includes how to access Perceptive Connect. Perceptive Connect allows you to configure, create, and enable channels between ImageNow and Perceptive Media. For information on installing Perceptive Connect, refer to the Perceptive Connect Installation and Setup Guide. Prerequisites Before you install Perceptive Media Connector, you must have access to a working installation of the following programs on your network. ImageNow Client and Server, version 6.7.x Perceptive Integration Server, version 6.7.x Perceptive Connect, version 0.12.x Apache Tomcat, version 7.0 or higher Java, version 1.7 (32-bit or 64-bit) Perceptive Media Note Access to Perceptive Media Manager requires a Perceptive ID. To obtain access to Perceptive Media, contact your Perceptive Software representative. Licenses The Perceptive Media Connector requires a license. To obtain a Perceptive Media Connector license, contact your Perceptive Software representative. Perceptive Media Connector Installation and Setup Guide Page 4 of 16

5 Overview of the set up process To set up the Perceptive Media Connector, complete the following procedures. Install the Perceptive Media Connector Configure ImageNow to use the connector Configure Perceptive Media Connector Install the Perceptive Media Connector In this section, you install the Perceptive Media Connector using the Perceptive Connect Web Console, which is available as a web service. Download the files To download the ZIP file and extract the installation files, complete the following steps. 1. Go to the Perceptive Software website at and log in to the Customer Portal. 2. In the Downloads page, search for the Perceptive Media Connector.zip file. 3. Save and extract the file to a temporary directory on your computer. Install the connector You use the Perceptive Connect Web Console to install the connector. To access the console and install the connector, complete the following steps. 1. In a browser, type the address for the Perceptive Connect Web Console. For example, Connect machine name>:<port>/connect Note The Perceptive Connect service runs on port 80, by default. 2. In the browser dialog box, enter your user name and password, and then log in. 3. In the Perceptive Connect Web Console, on the OSGi tab, click Bundles, and then click Install/Update. 4. In the Upload/Install Bundles menu, complete the following substeps. 1. Select the Start Bundle check box. 2. Clear the Refresh Packages check box. 3. The Start Level remains at the default level. 4. Click the Choose File button and navigate to your temporary directory. Find the PerceptiveMediaConnectorConsolidatedJars xxx.jar file, where xxx represents the latest version of the file, and click Open. 5. Repeat the previous step to select the PerceptiveMediaConnectorComponents xxx.jar file, and the PerceptiveMediaClientLibraryCollection xxx.jar file, where xxx represents the latest version of the files, and then click Install or Update. 5. In the Perceptive Connect Web Console, select Reload to refresh the page. Perceptive Media Connector Installation and Setup Guide Page 5 of 16

6 6. After the bundle installs, verify each bundle is active. To check the connector status, complete the following substeps. 1. On the Bundles tab, in the Name column, find the connector name. 2. In the Status column, verify the connector status is Active. If the status is not Active, in the Actions column, select the Action icon, and click the Start icon to change the state to Active. 3. Repeat the previous step for each component in the bundle. Configure ImageNow to use the connector ImageNow Workflow with Envoy Services allows back-end integration of ImageNow with the Perceptive Media Connector. An action defined for the Envoy service and an automated system queue (ASQ) you implement in your workflow process facilitate the transfer of metadata. The following procedures guide you through configuring the ImageNow Envoy service and the steps necessary to configure ImageNow Workflow. Configure ImageNow Envoy To configure an ImageNow Envoy service for the action associated with the connector, complete the following steps. 1. In Management Console, in the left pane, click Envoy Services and then click New. 2. In the Envoy Services dialog box, in the Definition page, set the following attributes. In the Name box, type a name to identify the remote service. For example, Perceptive Connect Optional. In the Description box, type a description. In the URI box, type the URI for the remote service. For example, In the Authentication list, select None. Optional. If you want to enable interceptor logging for the remote service, select the Enable interceptor logging check box. The logging files produced by the Interceptor are useful for troubleshooting issues with REST requests and responses. 3. Click Next. 4. In the Operations page, in the WorkflowTriggerService action, select the check box for InvokeTrigger and click Finish. Configure ImageNow Workflow To configure ImageNow workflow to use the connector, complete the following sections. Create a workflow process Create the queues Perceptive Media Connector Installation and Setup Guide Page 6 of 16

7 Create a workflow process To create a workflow process for the connector, complete the following steps. 1. In Management Console, in the left pane, click Workflow and then click New. 2. In the Add Process dialog box, in the Name box, type a name, for example, Connect Workflow. 3. Optional. In the Description box, type a description of the process. 4. Click OK. Create the queues To trigger the connector process, you create four queues in the workflow process, including a Work queue for successful processing, a Work queue for failures, a Work queue for download and capture, and an ASQ for uploading files to Perceptive Media. Open the Connect Workflow process and complete the following steps. 1. In the Workflow Designer window, in the left pane, under Queues, select the Integration icon and drag it to your process diagram. You name this queue Upload in a later step. 2. Under Queues, select the Work icon and drag it to your process diagram. Repeat this step to create three work queues. 3. To name the work queues, complete the following substeps. 1. Double-click the first work queue and, in the Queue Properties dialog box, in the Name box, type Download_Capture, and click OK. 2. Repeat the above action twice to name a queue Complete and Failure. 4. To name the integration queue, complete the following substeps. 1. Double-click the integration queue and in the Queue Properties dialog box, in the Name box, type Upload. 2. In Automated Action box, set the following attributes. 5. Click OK. To designate the process and queue for items successfully processed in this queue, under Success Action, in the Process box, verify or set Connect Workflow for the process name and under Queue, select Download_Capture for the queue name. To designate the process and queue for items not successfully processed in this queue, under Failure Action, in the Process box, verify or set Connect Workflow for the process name and under Queue, select Failure for the queue name. To set the number of days that items remain in the Failure queue after the business application receives a successful call for those items, in the Route After (Days) box, type a number. The maximum number of days is 365. By default, ImageNow routes items to the failure queue after one day. To designate the endpoint that receives web service notifications from this queue, under Envoy Service, in the Service Operation Name box, verify or set Perceptive Connect::InvokeTrigger for the action name. The Envoy Service Parameters section is not in use. Perceptive Media Connector Installation and Setup Guide Page 7 of 16

8 6. To create a route for documents that successfully complete in the process, complete the following substeps. 1. Double-click the Complete queue and select Routes. 2. In the Routes In tab, click Add. 3. In the Add Route In dialog box, in the Origin tab, in the Business Process list, select Connect Workflow. 4. In the Available queues box, select Download_Capture, and click Add >> to move it to the right into the Selected queues box. 7. Click OK twice. Configure Perceptive Media Connector In this section, you configure connector and handler settings for Perceptive Media Connector, such as the license key and service URL to enable the exchange of metadata. You then create, configure, and enable a data channel between ImageNow and Perceptive Media. Prepare to map data between ImageNow and Perceptive Media Consider the actions to perform, and the metadata you want to transfer to and from Perceptive Media and ImageNow when defining the connector configuration settings. Refer to Appendix: Configuration mappings for the Perceptive Media Connector parameters. Set the connector configuration settings To configure the connector, complete the following steps. 1. In the Perceptive Connect Web Console, on the Configuration tab, in the Name column, find Perceptive Media Connector Configuration, and in the Actions column, click the Edit 2. In the Perceptive Media Connector Configuration menu, input the values for the following connector parameters: Contributor. Type the contributor name associated with the Perceptive Media service. License key. Type the Perceptive Media license key you obtain from your Perceptive Software representative. Service URL. Type the service URL in the following format. Upload library. Type the name of the library the connector uses when uploading content to Perceptive Media. Upload mappings. Type the value for the upload settings that map ImageNow to Perceptive Media. To add additional settings, in the Upload Mappings box, click the plus button. Refer to the Upload section in Appendix: Configuration mappings for available settings. 3. Click Save. icon. Perceptive Media Connector Installation and Setup Guide Page 8 of 16

9 4. In the Name column, find Perceptive Media Handler Configuration, and in the Actions column, click the Edit icon. 5. In the Perceptive Media Handler Configuration menu, input the values for the following handler parameters. License key. Type the Perceptive Media license key you obtain from your Perceptive Software representative. Service URL. Type the service URL in the following format. Content Bridge URL. Type the Content Bridge service URL for your Perceptive Media account. Process name. Type the name of the workflow process that pulls content from Perceptive Media. For example, Connect Workflow is the process name of the workflow process example in the Create a workflow process section. Destination queue. Type the name of the destination workflow queue that routes content received from Perceptive Media. For example, Complete is the name of the destination queue in the workflow process example in the Create the queues section. Upload queue. Type the name of the workflow queue that imports captured content from Perceptive Media. For example, Download_Capture is the name of the upload queue in the workflow process example in the Create the queues section. Download mappings. Type the value for the content downloaded from Perceptive Media. To add additional settings, in the Download mappings box, click the plus button. Refer to the Download section in Appendix: Configuration mappings for available settings. Capture mappings. Type the value for the content captured from Perceptive Media. To add additional settings, in the Capture mappings box, click the plus button. Refer to the Capture section in Appendix: Configuration mappings for available settings. 6. Click Save. 7. After the configuration completes, restart the connector. To restart the connector, complete the following substeps. 1. On the Bundles tab, in the Name column, find Perceptive Media Components Collection. 2. In the Actions column, select the Action icon, and click the Start icon to change the state to Active. Create and configure a channel To enable the connector to communicate with your defined workflow process you create and configure a channel which is the combination of a trigger, an action, a result. A trigger is an event that happens in a queue, such as a document entering the queue. A trigger kicks off an action. An action is a specific task, such as retrieving an ImageNow property. The result of an action is the availability of data, such as a property value or a status code, which the connector routes. Perceptive Media Connector Installation and Setup Guide Page 9 of 16

10 For example, a document enters a queue, triggering the connector to retrieve the value of a document key, which it then routes to Perceptive Media. Create a channel You create, configure, and enable channels with the Perceptive Connect queue wizard. When you create a channel, you start by specifying a workflow queue, identified by the queue ID. Then, you select the connector action, and name it. To create and configure a channel, complete the following tasks. 1. In a browser, type the Perceptive Connect landing page address. For example, Connect machine>:<port>/asq. 2. In the Enter queue ID box, enter the ID value of your integration queue and click Next. Note To locate a queue ID, from Connect Workflow process, double-click the Upload queue to open the Queue Properties dialog box. For example, 321YX5N_00004JFZG0000E6 3. To associate an action with the trigger, in the Select an action list, click an action. 4. In the Name the channel box, enter a name for the channel and click Next. 5. In the Configure the channel box, set the <enabled> attribute to true. 6. Click Save. Warning After you enable and save a channel map, you cannot continue to modify it. For more information, refer to Replace an enabled channel. Replace an enabled channel After you enable a channel map by setting <enabled> to true and saving the channel, you cannot modify the channel map. If you need to configure an enabled channel, you must create a new channel and delete the original. To replace an enabled channel with a new ASQ, complete the following steps. 1. In Management Console, open the workflow process you want to modify. 2. Create a new channel queue. For more information on creating the queue, refer to Create the queues. 3. Modify queue routes within the workflow to integrate the new queue and isolate the old trigger queue. 4. Repeat the steps in the Create a channel section with your new channel mapping. Perceptive Media Connector Installation and Setup Guide Page 10 of 16

11 Appendix: Configuration mappings The following table provides definitions and sample data for the settings you use to configure Perceptive Media Connector. The three sections of settings are Upload, Download, and Capture. Each section contains settings expressed in the form of key=value pairs. The key describes each setting, and the value describes the data mapped to the setting the connector uses. Values are either variables or literals. Variables are surrounded by percent sign delimiters (%), while literals do not contain a delimiter. Use this table as a guide when configuring the connector. Section Setting Options Description Upload This section defines the setting you use to map an ImageNow document. All settings in this section are optional and there are no default values for these settings unless specified. Unspecified settings are not processed. If a setting has an empty value, the system sets it to an empty string value. The system ignores empty string values. Settings in this section allow you to map settings using the following format, media.[*]=%imagenow.customproperties[custompropertyname]% where * is any of the settings in this section, and CustomPropertyName is the custom property name you assigned. media.title media.description media.tags imagenow.docid imagenow.name imagenow.version imagenow.locationid imagenow.drawer imagenow.doctype imagenow.field1 imagenow.field2 imagenow.field3 imagenow.field4 imagenow.field5 The name of an ImageNow document key mapped to Perceptive Media. Example: media.title=%imagenow.name% where imagenow.name is any one of the available options. Note The title of the content is set to the ImageNow page file name by default if an alternative mapping is not supplied. A description of the ImageNow document mapped to Perceptive Media. An identifier you assign to the document for searching purposes. Example: media.tags=%imagenow.customproperties[v ideo_tags]% where video_tags is the name of the custom property assigned to your document. Download This section defines the settings you use to map metadata to ImageNow. All settings in this section are optional and there are no default values for these settings unless specified. Unspecified settings are not processed. If a setting has an empty value, the system sets it to an empty string value. The system ignores empty string values. Literal values are either mappings or references to metadata properties. Perceptive Media Connector Installation and Setup Guide Page 11 of 16

12 Section Setting Options Description imagenow.doctype The doctype assigned to the ImageNow document. imagenow.drawer media.artist media.contributor media.createdate media.custom_fields[*] where * indicates the field name. media.description media.documentid media.duration The name of any valid drawer used to store ImageNow documents. Example: imagenow.drawer=%media.publishername % where media.publishername is any one of the available options. Tip Although you can use any drawer name for this setting, use a drawer value that is consistent with the best practice in your business process. media.libraryname media.mainassetid media.mainasseturl media.publishername media.sourceasseturl media.title media.totalsize media.videoid Download imagenow.field1 media.artist A user defined value from the option list. (continued) media.contributor media.createdate media.custom_fields[*] where * indicates the field name. Example: imagenow.field1=%media.documentid% where media.documentid is any one of the available options. media.description media.documentid media.duration media.libraryname media.mainassetid media.mainasseturl media.publishername media.sourceasseturl media.title media.totalsize media.videoid Perceptive Media Connector Installation and Setup Guide Page 12 of 16

13 Section Setting Options Description imagenow.field2 An optional user defined value. imagenow.field3 An optional user defined value. imagenow.field4 An optional user defined value. imagenow.field5 An optional user defined value. Download imagenow.name media.artist A user defined value from the option list. (continued) media.contributor media.createdate media.custom_fields[*] where * indicates the field name. Example: imagenow.name=%media.title% where media.title is any one of the available options. media.description media.documentid media.duration media.libraryname media.mainassetid media.mainasseturl media.publishername media.sourceasseturl media.title media.totalsize media.videoid Capture This section defines the settings you use to map values of externally generated documents (not previously defined in ImageNow) retrieved from Perceptive Media. This section requires you to map values for imagenow.doctype and imagenow.drawer, as well as one of the following document keys: imagenow.field1, imagenow.field2, imagenow.field3, imagenow.field4, or imagenow.field5. Other mappings are optional and there are no default values for these settings unless specified. imagenow.customproperti es[videoartist] imagenow.doctype The name of the video artist assigned to the ImageNow custom property. Example: imagenow.customproperties[videoartist]=% media.artist% where media.artist is the name of an artist. The doctype assigned to the ImageNow document. Perceptive Media Connector Installation and Setup Guide Page 13 of 16

14 Section Setting Options Description imagenow.drawer imagenow.field1 media.artist media.contributor media.createdate media.custom_fields[*] where * indicates the field name. media.description media.documentid media.duration media.libraryname media.mainassetid media.mainasseturl media.publishername media.sourceasseturl media.title media.totalsize media.videoid media.artist media.contributor media.createdate media.custom_fields[*] where * indicates the field name. media.description media.documentid media.duration media.libraryname media.mainassetid media.mainasseturl media.publishername media.sourceasseturl media.title media.totalsize media.videoid The name of any valid drawer used to store externally generated documents. Example: imagenow.drawer=%media.publishername % where media.publishername is any one of the available options. Tip Although you can use any drawer name for this setting, use a drawer value that is consistent with the best practice in your business process. A user defined value from the option list. Example: imagenow.field1=%media.documentid% where documentid is any of the available options. Perceptive Media Connector Installation and Setup Guide Page 14 of 16

15 Section Setting Options Description imagenow.field2 imagenow.field3 imagenow.field4 imagenow.field5 media.artist media.contributor media.createdate media.custom_fields[*] where * indicates the field name. media.description media.documentid media.duration media.libraryname media.mainassetid media.mainasseturl media.publishername media.sourceasseturl media.title media.totalsize media.videoid A user defined value from the option list. Example: imagenow.field2=uploaded by %media.contributor% where media.contributor is any of the available options. Note This setting demonstrates how you can combine both literals and variables. An optional user defined value. An optional user defined value. An optional user defined value. Perceptive Media Connector Installation and Setup Guide Page 15 of 16

16 Section Setting Options Description imagenow.name media.artist media.contributor media.createdate media.custom_fields[*] where * indicates the field name. media.description media.documentid media.duration media.libraryname media.mainassetid media.mainasseturl media.publishername media.sourceasseturl media.title media.totalsize media.videoid A user defined value from the option list. Example: imagenow.name=%media.title% where media.title is any one of the available options. Perceptive Media Connector Installation and Setup Guide Page 16 of 16