PerceptiveVoucherBuildConnectorfor PeopleSoft - Kofax · PDF...

Perceptive Voucher Build Connector forPeopleSoft

Installation GuideVersion: 2.0.xWritten by: Product Knowledge, R&DDate: Wednesday, September 02, 2015

© 2014-2015 Lexmark International Technology, S.A. All rights reserved.Lexmark is a trademark of Lexmark International Technology, S.A., or its subsidiaries, registered in the U.S. and/orother countries. All other trademarks are the property of their respective owners. No part of this publication may bereproduced, stored, or transmitted in any form without the prior written permission of Lexmark.

Perceptive Voucher Build Connector for PeopleSoft Installation Guide

3

Table of Contents

Perceptive Voucher Build Connector for PeopleSoft 5

Overview 5

About the Voucher Build Connector process 5

Technical Specifications 6

Internet Browser 6

Operating Systems 6

Software 6

Licenses 7

Prepare for the installation 7

Determine required document types 7

Analyze existing workflows 8

Validate voucher build web service 8

Validate connectivity 8

Install the Voucher Build Connector 8

Download the file 8

Install the connector 8

Create the PeopleSoft Response Channel 9

Create the response channel 9

Action configuration 10

Output configuration 15

PeopleSoft Voucher Build configuration 16

Overview 16

Publish the Voucher Build web service 16

Verify the service operation settings 17

Verify queue settings 17

Configure the EIP responsemessage 18

Enable EIP messages 19

Configure the Voucher Build Connector 19


4

Configure Perceptive Content Workflow 20

Overview 20

SampleWorkflow 20

Workflow Queue Details 21

Design Considerations 22

Multiple Integration Queues 22

Staging Timeout 22

Create the Store Invoice Channel mapping 22

Overview 22

Create a channel 23

Map a channel 23

eForm Field 24

Literal Value 24

Document Field or Custom Property 24

Repeating Elements Using Rowsets 25

Nested repeating elements using rowsets 25


5

Perceptive Voucher Build Connector for PeopleSoftOverview

The Perceptive Voucher Build Connector for PeopleSoft is an extension to Perceptive Content, also calledImageNow. It allows Perceptive Content to export accounts payable (AP) invoices entered in a PerceptiveContent eForm, such as the AP Invoice eForm, to PeopleSoft.

This solution streamlines the AP invoicing process. You can expect the following benefits when using theVoucher Build Connector for PeopleSoft.

l Streamline the collection of complete invoices.

l Reduce themanual effort of updating invoices in PeopleSoft.

l Allow staff to complete their review and evaluation processes more quickly.

l Make faster andmore informed decisions, improving invoice processing quality.

About the Voucher Build Connector processWhen a document enters the configured workflow in Perceptive Content, a web services notifies PeopleSoftAP Voucher Build. PeopleSoft receives the data, creates a voucher, and after running the voucher buildprocess, notifies Perceptive Content workflow. Finally, Content routes the document a workflow queue thatindicates the final state.

The Voucher Build Connector runs on Perceptive Connect Runtime. The runtime service provides anindependent messaging and data exchange between Perceptive Content and PeopleSoft.


6

Technical Specifications

Internet Browserl Google Chrome

l Internet Explorer, version 10

l Mozilla Firefox

Operating Systemsl Runs on all operating systems that Perceptive Connect Runtime supports.

Softwarel ImageNow Client and Server, version 6.7 or Perceptive Content Client and Server, version 7.0

l Perceptive AP Invoice eForm or a custom eForm compatible with your version of ImageNow orPerceptive Connect

l Perceptive Connect Runtime, version 1.0 or higher

l Perceptive Content Connector, version 1.0 or higher

l PeopleTools, version 8.49.18 or higher

l PeopleSoft Financials, version 8.8 or higher


7

LicensesThe Voucher Build Connector for PeopleSoft requires the following licenses.

l ImageNow AP Connector for PeopleSoft

Prepare for the installationThe connector requires close interaction with your accounts payable process in both Perceptive Content andPeopleSoft. Perform the following tasks before proceeding with installation and configuration.

l Determine the required Perceptive Content document types

l Analyze your existing AP workflows in Perceptive Connect

l Validate PeopleSoft Voucher BuildWeb-Service

l Validate connectivity between Perceptive Connect and PeopleSoft

Determine required document typesThe process to export data to PeopleSoft will generally differ between types of invoices. For example,PeopleSoft has different required fields for PO and non-PO inovices. Each invoice type requires a dedicatedIntegration queue (ASQ) in the Content workflow.

To keep your overall process simple, share all of the invoice processing steps upstream and downstreamfrom the export to PeopleSoft stage. In this case, a possible solution is to use document types, such as POInvoice and Non-PO Invoice, and to create a routing rule in the queue before the export to step. The diagrambelow illustrates this.


8

Analyze existing workflowsThe Voucher Build Connector leverages ASQs to trigger the export process in Perceptive Connect. It will benecessary to determine the correct point in the workflow to trigger the export and handle the response.

Note that the Voucher Build in PeopleSoft runs as a batch process. The export step in workflow will thereforerequire a queue to hold documents, staged in PeopleSoft, waiting for the batch process to execute. Theresponse from the the Voucher Build will sent periodically as configured in PeopleSoft.

Validate voucher build web serviceThe Voucher Build Connector uses the built-in PeopleSoft Voucher Build web service to upload invoices. Youmust ensure that the web service is installed, available, and has the proper permissions to populate theVoucher Build staging tables. A SOAP tool like Soap UI is a great way to validate the web service isfunctioning correctly.

Validate connectivityThe Voucher Build Connector, running in Perceptive Connect, will require connectivity to the targetPeopleSoft environment. Ensure that firewalls and network permissions allow themachine runningPerceptive Connect to communicate with PeopleSoft. The connector uses the URL and ports outlined in yourPeopleSoft instanceâ€™s Voucher BuildWSDL.

Install the Voucher Build ConnectorDownload the file

1. Go to www.perceptivesoftware.com and log in to the Customer Portal.

2. In the Product Downloads page, search for thePerceptive Voucher Build Connector for PeopleSoftfile.

3. Download the file to a temporary directory on your computer.

Install the connectorTo install the Voucher Build Connector, complete the following steps.

1. In a browser, type theWebConsole address in the format http://[Perceptive Connect Runtimemachinename]:[port]/connect.

l Note Perceptive Connect Runtime runs on port 80 by default.

2. In the browser dialog box, type the runtime user name and password.

3. In thePerceptive Connect Runtime Web Console, underPerceptive Connect, click View Bundles.

4. In theBundles page, click Install/Update and complete the following steps.


9

1. In theUpload/Install Bundles dialog box, click Choose File, navigate to theps.voucher.response-1.0.0.jar file, and click Open.

2. Select theStart Bundle check box, set theStart Level to 4 and click Install or Update.

5. In theBundles page, click Install/Update and complete the following steps.

1. In theUpload/Install Bundles dialog box, click Choose File, navigate to the ps.voucher.store-1.0.0.jar file, and click Open.

2. Select theStart Bundle check box, set theStart Level to 4 and click Install or Update.

Create the PeopleSoft Response ChannelThe PeopleSoft Voucher Build executes as a scheduled batch. The PeopleSoftVoucherStoreAction simplypopulates staging tables in the PeopleSoft database. The data is not processed until the batch processexecutes. At that time, PeopleSoft sends a response with an invoice status of success, failure or recycle.

The Voucher Build Connector handles this response by creating a channel in Perceptive Connect Runtime.You can customize the channel for each solution, but you will likely use the following components.

l Trigger: TheWebXmlTrigger exposes an http endpoint that can receive the XMLmessage (text/plain)response from PeopleSoft.

l Action: TheRoute By Status Action routes the invoice document to the correct destination queuebased upon the status communicated in the XMLmessage.

l DocumentSearchReader: TheDocument Search Reader takes the invoice values from thePeopleSoft response XML and performs a search inPerceptive Content to locate thematching invoice.

Create the response channelThe response channel defines themapping between the XML response from PeopleSoft and resulting actionswithin Perceptive Content.To create and define the response channel, complete the following steps.

1. In thePerceptive Connect Runtime Web Console, underPerceptive Connect, click Create aChannel.

2. InSelect a trigger, select theWebXmlTrigger.

3. InUnique Instance Name, type a short name to uniquely describe the channel.

l NOTE: The instance name needs to be RFC 1738 URL compliant. For example,PeopleSoftInvoiceResponse or Invoice-Response-Endpoint.

4. InSelect an action, select theRoute By Status Action.


10

5. InConfigure Input Mapping, complete the steps defined in the following â€œAction Configurationâ€ section to complete themapping. Click Next.

6. InConfigure output mapping, complete the steps defined in the following â€œOutput Configurationâ€ section to complete themapping.

7. Click Save Channel > OK.

This creates a listener at the following URL. You will use this URL in the â€œPeopleSoft Configurationâ€ section when configuring the EIP ResponseMessage.

http://[Perceptive Connect Server]:[port]/rs/webXml/[Unique Instance Name]

Action configurationThe action configuration can be customized for solutionâ€™s needs. Generally, the process will involve fourmain components:

1. Read required values from the PeopleSoft response XML.

2. Search for thematching document inPerceptive Content.

3. Set the desired document keys and custom properties for thematching document.

4. Route thematching document to the proper status queue (Success, Failure, Recycle).

Selecting theRoute By Status Action yields the following default action configuration that youmustcustomize. Refer to the steps following this example for detailed information on configuring the action. Youcan also find a sample customized action in the following â€œAction configuration exampleâ€ section.

<c:parameter><c:name>statusValue</c:name><c:none/>

</c:parameter>

<c:parameter><c:name>documentId</c:name>

</c:parameter>

<c:parameter><c:name>fallbackQueueName</c:name><c:none/>

</c:parameter>

<c:parameter><c:name>originQueueName</c:name><c:none/>

</c:parameter>

<c:parameter>


11

<c:name>destQueueName0</c:name><c:none/>

</c:parameter><c:parameter>

<c:name>compareValue0</c:name><c:none/>

</c:parameter>

<c:parameter><c:name>destQueueName1</c:name><c:none/>



</c:parameter>




</c:parameter>




</c:parameter>




</c:parameter>

1. Add a parameter to reference the PeopleSoft XML response provided by theWebXmlTrigger. Thisallows you to access the XML data using the WebXMLData parameter.


12

<c:parameter><c:name>WebXMLData</c:name><c:trigger>XML Document</c:trigger>

</c:parameter>

1. Populate the originQueueName parameter to indicate the Content staging queue where the documentis located when the connector receives the PeopleSoft response. Refer to the â€œWorklfowconfigurationâ€ section for more about the staging queue.

<c:parameter><c:name>originQueueName</c:name><c:literal>AP Invoice Export Stage</c:literal>

</c:parameter>

1. Populate the statusValue parameter with the PeopleSoft status XML value you want to use toconditionally route the document to the proper status queue. In the example below, the status value willbe pulled from the //*/MsgData/Transaction/VCHR_EIP_OUT/ENTRY_STATUS element of theXML.

<c:parameter><c:name>statusValue</c:name><c:xmlSource>

<c:reference>WebXMLData</c:reference><c:xpath>//*/MsgData/Transaction/VCHR_EIP_OUT/ENTRY_STATUS</c:xpath>

</c:xmlSource></c:parameter>

NOTE: This parameter uses theXML Reader provided with thePerceptive Connect Runtime (PCR). Formore information on using this reader, refer to the the Perceptive Connect Runtime Installation Guide.

1. Configure the compareValue parameters with PeopleSoft status codes and the destination queues youwant the connector to use for each status code. The connector matches the compareValue[index]values against the statusValue from above. When it finds amatch, it routes the document to thematching workflow queue indicated by the destQueueName[index] parameter.

PeopleSoft provides the following status codes.* â€˜Fâ€™ - Failure* â€˜Râ€™ - Recycle* â€˜Sâ€™ - Success

<c:parameter><c:name>compareValue1</c:name><c:literal>F</c:literal>


<c:name>destQueueName1</c:name>


13

<c:literal>AP Invoice Export Fail</c:literal></c:parameter>

NOTE:You can only configure five conditional sets.

1. Configure the fallbackQueueName parameter. If statusValue is not found in the compareValue[index] parameters, the action routes the document to the queue defined in this parameter. If you donot define a fallback, the connector cannot route the document and it stays in the staging queue.

<c:parameter><c:name>fallbackQueueName</c:name><c:literal>AP Invoice Export Fail</c:literal>

</c:parameter>

1. Use theObject Search Reader to discover the documentId parameter of the action. PeopleSoft hasno concept of thePerceptive Content document ID. A search is therefore required to discover thedocument ID using the XML data provided by the PeopleSoft response.

<c:parameter><c:name>SearchField1</c:name><c:xmlSource>

<c:reference>WebXMLData</c:reference><c:xpath>//*/MsgData/Transaction/VCHR_EIP_OUT/BUSINESS_UNIT</c:xpath>

</c:xmlSource></c:parameter><c:parameter>

<c:name>SearchField2</c:name><c:xmlSource>

<c:reference>WebXMLData</c:reference><c:xpath>//*/MsgData/Transaction/VCHR_EIP_OUT/VENDOR_ID</c:xpath>


<c:parameter><c:name>documentIdList</c:name><in:objectSearch>

<in:viewType>DOCUMENT</in:viewType><in:viewName>pre-defined-doc-view</in:viewName><in:viewColumnID>8</in:viewColumnID><in:maxWaitTime>0</in:maxWaitTime><in:searchTerm>

<in:joinOperation>AND</in:joinOperation><in:operatorType>EQUALS</in:operatorType><in:parameterType>FIELD1</in:parameterType><in:propertyName/><in:searchValueRef>SearchField1</in:searchValueRef>

</in:searchTerm><in:searchTerm>


14

<in:joinOperation>AND</in:joinOperation><in:operatorType>EQUALS</in:operatorType><in:parameterType>Custom_property</in:parameterType><in:propertyName>Vendor ID</in:propertyName>/><in:searchValueRef>SearchField2</in:searchValueRef>

</in:searchTerm></in:objectSearch>


<c:name>documentId</c:name><c:listItem>

<c:listRef>documentIdList</c:listRef><c:index>0</c:index>

</c:listItem></c:parameter>

1. TheObject Search Reader returns its results as a list. The first and only list itemmust be retrievedusing the List Item Reader. TheObject Search Reader can alsomatch parameters such as documentkeys and custom properties from a literal (constant) parameter using the following example.

<c:parameter><c:name>VendorId</c:name><c:literal>abc123</c:literal>

</c:parameter>

<c:parameter><c:name>documentId</c:name><in:searchTerm>

<in:joinOperation>AND</in:joinOperation><in:operatorType>EQUALS</in:operatorType><in:parameterType>FIELD1</in:parameterType><in:propertyName/><in:searchValueRef>VendorId</in:searchValueRef>

</in:searchTerm></c:parameter>

This is also a convenient place to add parameters that will be used in the â€œoutput configurationâ€ later. Allparameters declared in the action configuration will also be available in the output configuration.

<c:parameter><c:name>VoucherId</c:name><c:xmlSource>

<c:reference>WebXMLData</c:reference><c:xpath>//*/MsgData/Transaction/VCHR_EIP_OUT/VOUCHER_ID</c:xpath>


<c:name>enteredDate</c:name><c:xmlSource>


15

<c:reference>WebXMLData</c:reference><c:xpath>//*/MsgData/Transaction/VCHR_EIP_OUT/ENTERED_DT</c:xpath>


Output configurationThe example below illustrates the default output configuration for the Route By Status Action. TheresultStatus parameter indicates the status that was matched by the status action. It is blank if there isnomatch. The wasRouted parameter indicates if the document was routed using a boolean value.

To use the output parameters, replace <c:noTarget/> with aPerceptive Connectwriter appropriate foryour need. For a list of available writers, refer to the Perceptive Content Runtime Installation Guide and thePerceptive Content Connector Installation Guide, available on the Customer Portal.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><c:outputsxmlns:c="http://www.perceptivesoftware.com/pif/mapping"xmlns:ns2="http://www.perceptivesoftware.com/pie/mapping/sample"xmlns:in="http://www.perceptivesoftware.com/pif/imagenow">

<c:parameter><c:name>resultStatus</c:name><c:noTarget/>


<c:name>wasRouted</c:name><c:noTarget/>

</c:parameter></c:outputs>

These values are provided for convenience, but in most cases, they are not be required. The recommendedworkflow outlined in the â€œWorkflow configurationâ€ section uses a timeout on the staging queue to handlecases where the channel does not receive a PeopleSoft response. If the action fails to match the status, thetimeout rule will move the document to timeout queue.Note:You are required to delete the two auto-generated parameters if not used by your implementation. Anerror will occur if the parameters remain unconfigured.

You can use the output configuration to set the values of any Perceptive Content document keys or customproperties your implementation requires. In the â€œAction configurationâ€ section, you could add parametersto read values from the PeopleSoft response XML. Those parameters are now available to you in the outputconfiguration.

<c:parameter><c:name>VoucherId</c:name><in:objectPropertyWriter>

<in:name>Voucher ID</in:name><in:objectId>documentId</in:objectId>


16

<in:objectType>document</in:objectType><in:propertyType>CUSTOMPROPERTY</in:propertyType>

</in:objectPropertyWriter></c:parameter><c:parameter>

<c:name>enteredDate</c:name><in:objectPropertyWriter>

<in:name>EnteredDate</in:name><in:objectId>documentId</in:objectId><in:objectType>document</in:objectType><in:propertyType>CUSTOMPROPERTY</in:propertyType>

</in:objectPropertyWriter></c:parameter>

Notes:* The configuration above uses theObject Property Writer provided with thePerceptive ContentConnector. Refer to the Perceptive Content Connector Installation Guide for more information.

l Date values from PeopleSoft (YYYY-MM-DD) are not compatible with dates stored inPerceptiveContent as a date type custom property (MM/DD/YYYY). TheDate Format Reader delivered withPerceptive Connect can be used to reformat dates. Refer to the Perceptive Connect RuntimeInstallation Guide.

PeopleSoft Voucher Build configurationOverview

To configure PeopleSoft Voucher Build for the connector, complete the following tasks, in order.

l Publish the Voucher Build web service

l Verify the service operation settings

l Verify queue settings

l Configure the EIP responsemessage

l Enable EIP Messages

l Configure the Voucher Build Connector

Publish the Voucher Build web serviceIn the PeopleSoft EnterpriseWeb Application, you need to publish a web service that the Voucher Buildconnector uses to communicate with PeopleSoft. Complete the following steps to publish a web service.

1. In PeopleSoft, in the left pane, underMenu, click PeopleTools > Integration Broker.

2. In the right pane, underWeb Services, click Provide Web Service.

3. In theProvide Web Service Wizard, on theSelect Services page, perform the following substeps.


17

1. UnderSearch Criteria, in theService Name box, typeAP_VOUCHER_BUILD and click Search.

2. UnderSearch Results, select AP_VOUCHER_BUILD and click Next.

4. On theSelect Services Operations page, perform the following substeps.

1. Verify that Use Service Alias in WSDL is not selected.

2. Click Next.

5. On theView WSDL page, verify theService is AP_VOUCHER_BUILD, and click Next.

6. On theSpecify Publishing Options page, verifyWSDL Repository is selected, and click Finish.

7. Note the generatedWSDL URL for use during the Voucher Build Connector Configuration.

Verify the service operation settingsTo verify service operations are correctly configured and active, complete the following steps.

1. In the left pane, underMenu, click PeopleTools and then click Integration Broker > Integration Setup> Service Operations.

2. On theService Operations page, perform the following substeps:

1. UnderSearch Criteria, in theService Operation box, typeAP_VOUCHER_BUILD_ADD, andthen click Search.

2. UnderSearch Results, click AP_VOUCHER_BUILD_ADD.

3. On theGeneral tab, perform the following substeps:

1. UnderDefault Service Operation Version, verify Active is selected.

2. UnderRouting Status, verify Any-to-Local is set toExists.

4. On theHandlers tab, underHandlers, verify theRQSTHNDLR handler is set toActive.

5. On theRouting tab, perform the following substeps:

1. Verify Sender Node is set to \Any\.

6. Verify Direction is set to Inbound.

7. Verify Status is set toActive.

Click Save if youmade any changes.

Verify queue settingsPerform the following steps to verify queue settings:

1. In the left pane, underMenu, click PeopleTools and then click Integration Broker > Integration Setup


18

> Queues.

2. On theQueues page, perform the following substeps:

1. UnderSearch Criteria, in theQueue Name begins with box, typeVOUCHER, and then clickSearch.

2. UnderSearch Results, click VOUCHER.

3. On theQueue Definitions page, verify theQueue Status is set toRun.

4. Click Save if youmade any changes.

Configure the EIP responsemessageThe Voucher Build Response EIP message is amessage sent from PeopleSoft, after the voucher buildprocess, that informs Voucher Build connector that PeopleSoft has successfully processed the invoicedocument. The Voucher Build connector will use this information to update invoice documents in ImageNowwith PeopleSoft statuses and the voucher ID. Perform the following steps to configure this message.

1. In the left pane, underMenu, click PeopleTools and then click I**ntegration **Broker> **IntegrationSetup > Service Operations.

2. On theService Operations page, perform the following substeps:

1. UnderSearch Criteria, in theService Operation box, typeAP_VCHR_MESSAGE_OUT, andthen click Search.

2. UnderSearch Results, click AP_VCHR_MESSAGE_OUT.

3. On theGeneral tab, underDefault Service Operation Version, verify Active is selected.

4. On theRouting tab, verify Status is set toActive, and then, underName, click AP_VCHR_MESSAGE_OUT.

5. On theConnector Properties tab, perform the following substeps;

1. In theGateway ID box, configure the appropriate gateway ID.

2. In theConnector ID box, typeHTTPTARGET.

3. Configure thePRIMARYURL value to point to theVoucher Build Connector response channelendpoint.NoteRefer to the â€œResponse channel configurationâ€ section to determine the URL for yourconfiguration. For example, http://[Perceptive Connect Server]:[port]/rs/webXml/[Unique Instance Name]

6. Click Save.

7. In the left pane, underMenu, click PeopleTools > Integration Broker > Integration Setup > Queues.

8. On theQueue page, complete the following substeps.


19

1. UnderSearch Criteria, in theQueue Name begins with box, typeAP_VCHR_OUT, and thenclick Search.

2. UnderSearch Results, click AP_VCHR_OUT.

3. On theQueue Definitions page, verify Queue Status is set toRun.


Enable EIPmessagesEIP messages for the Voucher Build process allows PeopleSoft to sendmessages about processed Voucherinformation to subscribed applications such as theVoucher Build Connector. To enable EIP messages,complete the following steps.

1. In the left pane, underMenu, click Accounts Payable > Batch Processes > Vouchers > VouchersBuild.

2. On theVoucher Build Request page, locate an appropriateRun Control or create a new one.

3. On theVoucher Build tab, under Interfaces, in theVoucher Build Interface list, select XML Invoiceand verify Publish Voucher Messages is selected.


5. If necessary, set up a run schedule. For more information, refer to your PeopleSoft documentation.

Configure the Voucher Build ConnectorTo configure theVoucher Build Connector, complete the following steps.

1. In thePerceptive Connect Runtime Web Console, underPerceptive Connect, click ViewConfiguration.

2. UnderPeopleSoft Voucher Build, click the edit button for thePeopleSoft Voucher StoreConfiguration.

3. In thePeopleSoft Voucher WSDL URL, enter the location of the PeopleSoft voucherWSDL as a URL.For example: http://[server-name]/PSIGW/PeopleSoftServiceListeningConnector/AP_VOUCHER_BUILD.1.wsdl

4. Click Save.


20

Configure Perceptive Content WorkflowOverview

The Perceptive Voucher Build Connector uses workflow Integration queues (ASQs) to trigger the export ofdata from Content to PeopleSoft. Using your plan from the â€œPrepare for the installationâ€ section, reviewthe following topics tomake the required changes to your existing workflow process.

SampleWorkflow


21

WorkflowQueue DetailsQueue nameAP Invoice Export - FilterQueue typeSystemPurposeRoutes documents to appropriate Integration queue.NotesA routing rule should route documents to eitherPO Invoice Export orNon-PO Invoice Export basedupon document type.

Queue namePO Invoice ExportQueue type IntegrationPurposeExecutes channel in Perceptive Connect for uploading PO Invoices data to PeopleSoft.

Queue nameNon-PO Invoice ExportQueue type IntegrationPurposeExecutes channel in Perceptive Connect for uploading Non-PO Invoices data to PeopleSoft.

Queue name Invoice Export - StageQueue typeSystemPurposeHolding queue for documents staged in PeopleSoft waiting for Voucher Build batch to execute.NotesDocuments will automatically move from this queue when batch executes in PeopleSoft. A timeoutshould be configured as a fail-safemoving documents to Invoice Export - Timeout.

Queue name Invoice Export - RecycleQueue typeSystemPurpose Terminal queue for documents that were successfully processed, but require additional processingin PeopleSoft to resolve issues.Notes The connector will route recycled documents to this queue from Invoice Export - Stage.

Queue name Invoice Export - SuccessQueue typeSystemPurpose Terminal queue for documents that PeopleSoft Voucher Build has successfully processed fromstaging tables.Notes The connector will route successful documents to this queue from Invoice Export - Stage.

Queue name Invoice Export - FailureQueue typeSystemPurpose Terminal queue for documents that failed to export.


22

Queue name Invoice Export - TimeoutQueue typeSystemPurpose Terminal queue for documents that timeout while in staging.NotesPeopleSoft can, in certain cases, fail to stage or process stages invoices without notifying theconnector.

Design Considerations

Multiple Integration QueuesThe Voucher Build Connector requires a different ASQ for each invoice/export type. Common types ofinvoices include PO Invoices, Non-PO Invoices, and Credit Memos. Each of these invoice types will require adistinct ASQ to handle the unique parameters sent to the PeopleSoft web service.

It is advisable to create a routing schemewhere the ASQs sit behind a system queue configured with arouting rule. Routing based upon document type would be a common rule to employ.

Staging TimeoutThe PeopleSoft Voucher Build is a batch system. The Voucher Build Connector attempts to stage data inPeopleSoft. If staging fails, PeopleSoft does not always inform the connector. It is advisable to create aqueue timeout to move documents to an appropriate failed state when PeopleSoft does not respond with astatus.

Create the Store Invoice Channel mappingOverview

After installing the Voucher Build Connector, youmust create channels the Perceptive Connect Runtime totrigger the export of invoices into PeopleSoft.

A channel consists of a trigger, an action, and a configuration binding the two together. The Voucher BuildConnector provides the PeopleSoftVoucherStoreAction to complete the export to PeopleSoft.

In general, Voucher Build channels will consist of the following components.* Trigger: Integration ASQ Trigger* Action: PeopleSoftVoucherStoreAction* Configuration: Mapping between Invoice eForm XML and PeopleSoft web service parameters.

If you are exportingmultiple invoice types, such as PO and non-PO for example, you will need to have achannel for each invoice type. Each channel will correspond to an Integration queue in your Perceptivecontent workflow. To create the Store Invoice Channel mapping, complete or review the following sections, inorder.


23

l Create a channel

l Create the channel mapping

l Sample channel mapping configuration

l Related Information

Create a channelA channel defines themapping between the invoice eForm data stored in Perceptive Content and the invoiceweb service into PeopleSoft. To define this mapping, complete the following steps.

1. In thePerceptive Connect Runtime Web Console, underPerceptive Connect, click Create aChannel.

2. InSelect a trigger, select the Integration ASQ Trigger.

3. InWorkflow Queue ID, type the queue ID of the Integration Queue (ASQ)where invoice documentswill be routed. For example: 321YY9C_0000RCLP800001W.

l NOTE: To find the queue ID, open theWorkflow Designer, right-click the desired queue, clickProperties. The ID is listed underDetails.

4. InSelect an action, select thePeopleSoftVoucherStoreAction.

5. InConfigure Input Mapping, complete the steps defined in the â€œMapData from an eFormâ€ sectionto compolete themapping.

6. Click Next.

7. UnderConfigure output mapping, accept the default value.

8. Click Save Channel > OK.

Map a channelThe Voucher Build Connector maps data from a Perceptive Content eForm, such as the ImageNow APInvoice eForm, into the Voucher Build web service in PeopleSoft. Tomaximize configuration options, you canmap any eForm field into any web service parameter. With this ability, custom eForms can use the VoucherBuild Connector to export to PeopleSoft. The following general steps describe how tomap a channel.

l Refer to the data definition file for the eForm on your Perceptive Content server. The eForm datadefinitions can be found in the server installation directory at [drive:]/inserver6/form/data_definition.

l The Voucher Build Connector uses XPath to extract values from an eForm to populate the web servicerequest. You need to be familiar with this language before proceeding.

l Refer to the Perceptive Connect Runtime Installation and SetupGuide and the Perceptive ContentConnector Installation Guide for additional information on XML parameter mapping.


24

l Refer to the PeopleSoft Web Service Supplemental Guide for information about parameters available inthe PeopleSoft web service.

The following topics outline commonways tomap data from an invoice eForm to Voucher Build web serviceparameters.

l eForm Field

l Literal Value

l Document Field or Custom Property

l Repeating Elements Using Rowsets

l Nested Repeating Elements Using Rowsets

eForm Field<c:parameter>

<c:name>INVOICE_DT</c:name><c:xmlSource>

<c:reference>InvoiceXmlDoc</c:reference><c:xpath>/Invoice/InvoiceDate</c:xpath>


NoteInvoiceXmlDoc is defined outside the scope of this example.

Literal Value<c:parameter>

<c:name>VOUCHER_ID</c:name><c:literal>NEXT</c:literal>

</c:parameter>

Document Field or Custom Property<c:parameter>

<c:name>INVOICE_DT</c:name><in:objectPropertyReader>

<in:name>DRAWER</in:name><in:objectIdRef>DocId</in:objectIdRef><in:objectType>document</in:objectType><in:propertyType>key</in:propertyType>

</in:objectPropertyReader></c:parameter>

NoteDocId is defined outside the scope of this example.


25

Repeating Elements Using RowsetsThe <c:rowset> items for thePeopleSoftVoucherBuildStoreAction represent a collection of repeatingparameters required by the Voucher Build web service. For example, an invoice can havemultiple line items.Generally, an <c:xmlRowSource> will be used as illustrated in the following example.

<c:rowset><c:name>LINE</c:name><c:xmlRowSource>

<c:reference>InvoiceXmlDoc</c:reference><c:id>GLLineItem</c:id><c:xpath>/Invoice/GLLineItems/GLLineItem</c:xpath>

</c:xmlRowSource><c:mapping>

<c:parameter><c:name>MERCHANDISE_AMT</c:name><c:xmlSource>

<c:context>GLLineItem</c:context><c:xpath>GLExtAmount</c:xpath>


<c:name>BUSINESS_UNIT</c:name><c:xmlSource>

<c:reference>InvoiceXmlDoc</c:reference><c:xpath>GLUnit</c:xpath>

</c:xmlSource></c:parameter>...

</c:mapping></c:rowset>

NOTE:* The parameters contained by the <c:rowset> can reference the <c:xmlRowSource> using the<c:context> tag as illustrated above in theMERCHANDISE_AMT parameter.* The parameter contained by the <c:rowset> can reference the source XML document as InvoiceXmlDocusing the <c:reference> tag as illustrated above in theBUSINESS_UNIT parameter.

Nested repeating elements using rowsetsA <c:rowset> can also be nested within other <c:rowset> items. For example, the PeopleSoft VoucherBuild web service allows multiple distributions (DIST) for multiple line items (LINE) in a given invoice. Nestedrowsets can be configured using themethods outlined in following example.

26

<c:rowset>

<c:name>LINE</c:name><c:xmlRowSource>

<c:reference>InvoiceXmlDoc</c:reference><c:id>GLLineItem</c:id><c:xpath>/Invoice/GLLineItems/GLLineItem</c:xpath>


...<c:rowset>

<c:name>DIST</c:name><c:xmlRowSource>

<c:reference>GLLineItem</c:reference><c:id>SubItem</c:id><c:xpath>.</c:xpath>


<c:parameter>

<c:name>BUSINESS_UNIT_CHILD</c:name><c:xmlSource>

<c:context>SubItem</c:context><c:xpath>GLUnit</c:xpath>


<c:parameter>

<c:name>BUSINESS_UNIT_GRANDCHILD</c:name><c:xmlSource>

<c:context>GLLineItem</c:context><c:xpath>BusinessUnit</c:xpath>


<c:parameter>

<c:name>BUSINESS_UNIT_HEADER</c:name><c:xmlSource>

<c:reference>InvoiceXmlDoc</c:reference><c:xpath>BusinessUnit</c:xpath>

</c:xmlSource></c:parameter>...

</c:mapping></c:rowset>


27

...</c:mapping>

</c:rowset>

NOTES:

l The nested <c:rowset> item forDIST references the parent rowset using the <c:reference> tag.

l Nested parameters can reference the parent <c:rowset> using the <c:context> tag as illustrated bythe BUSINESS_UNIT_CHILD parameter.

l Nested parameters can reference the grandparent <c:rowset> using the <c:context> tag asillustrated by the BUSINESS_UNIT_GRANDCHILD parameter.

l Nested parameters can reference the source XML document (InvoiceXmlDoc) using the<c:reference> tag as illustrated by the BUSINESS_UNIT_HEADER parameter.

PerceptiveVoucherBuildConnectorfor PeopleSoft - Kofax · PDF...

Documents

Transcript of PerceptiveVoucherBuildConnectorfor PeopleSoft - Kofax · PDF...