perceptive checklist connector for peoplesoft … connector for microsoft dynamics ax installation...

Perceptive Checklist Connector for PeopleSoft Campus Solutions Installation and Setup Guide

Version 1.0.x Compatible with ImageNow version: 6.7.x

Written by: Product Documentation, R&D Date: August 2016

© 2014 Perceptive Software. All rights reserved.

Perceptive Software is a trademark of Lexmark International Technology S.A., registered in the U.S. and other countries. All other brands and product names mentioned in this document are trademarks or registered trademarks of their respective owners. No part of this publication may be reproduced, stored in a retrieval system, or transmitted in any form or by any means, electronic, mechanical, photocopying, recording, or any other media embodiments now known or hereafter to become known without the prior written permission of Lexmark.

Percept i ve Connec to r fo r Mic rosof t Dynam ics AX Ins ta l la t ion and Setup Guide

of 28

Table of Contents Perceptive Checklist Connector for PeopleSoft Campus Solutions ..................................................... 5

Prerequisites .............................................................................................................................................. 5

Overview of the setup process .................................................................................................................. 5 Prepare for the setup .................................................................................................................................. 6

Create a PeopleSoft user for the connector .............................................................................................. 6

Find the PeopleSoft variable data, connector operation parameters, and checklist items ....................... 6

Verify or create ImageNow document properties and types ..................................................................... 7

Create an ImageNow user for the connector ............................................................................................ 8 Install and configure the Checklist Connector ........................................................................................ 9

Download the files ..................................................................................................................................... 9

Obtain and install the product licenses ...................................................................................................... 9

Install the Checklist Connector ................................................................................................................ 10

Configure the configurationtemplate.xml file ........................................................................................... 11 Configure the PeopleSoft and Integration Server information ............................................................. 11 Configure the PeopleSoft and Message Agent information................................................................. 11

Configure the parameters for each of your PeopleSoft checklists ...................................................... 12

Configure the parameters for a transcript checklist item ..................................................................... 14

Sample configuration.xml file for Message Agent ................................................................................... 15

Sample configuration.xml file for Integration Server ............................................................................... 16 Install and configure the PeopleSoft Update Checklist project ........................................................... 17

Install the PeopleSoft Update Checklist project ...................................................................................... 17

Configure the Web Application privileges ................................................................................................ 17

Test the created PeopleSoft Campus Solutions definition ...................................................................... 18 Configure the ImageNow Envoy service ................................................................................................ 18

Configure the ImageNow connection with the Checklist Connector .................................................. 19

Create a workflow process ...................................................................................................................... 20 About checklists and processes with transcripts ..................................................................................... 20

Configure a process to include transcripts .............................................................................................. 20 Create the queues ............................................................................................................................... 20

Apply routing rules to the incoming documents queue ........................................................................ 21

Configure the transcripts and other docs automated system queues ................................................. 23 Example: A workflow process with transcripts ..................................................................................... 23

Configure a process that does not include transcripts ............................................................................ 24


of 28

Create the queues ............................................................................................................................... 24

Configure the incoming documents automated system queue ........................................................... 25

Example: A workflow process without transcripts ................................................................................ 26 Appendix A: PeopleSoft security ............................................................................................................ 27

Index ........................................................................................................................................................... 28


of 28

Perceptive Checklist Connector for PeopleSoft Campus Solutions Perceptive Checklist Connector for PeopleSoft Campus Solutions is an extension that links data from student documents stored in ImageNow with your PeopleSoft Campus Solutions software. The connection between ImageNow and PeopleSoft streamlines the PeopleSoft checklist process as you capture and manage student documents in ImageNow workflow.

You can expect the following efficiencies when using this PeopleSoft checklist update solution.

• Streamline the collection of complete documentation, such as admissions, financial aid, or athletics compliance packets.

• Reduce the time spent manually updating records in PeopleSoft Campus Solutions as ImageNow processes student documents.

• Allow staff to complete the review and evaluation processes faster.

• Make informed decisions in a more efficient manner.

• Improve student service.

Prerequisites You must install and have access to the following programs before you install the Checklist Connector.

• ImageNow Server and Client, version 6.7.x

Note To use the Checklist Connector with ImageNow Server and Client 6.6.x, refer to the Perceptive Checklist Connector for PeopleSoft Campus Solutions Installation and Setup Guide 6.6.x.

• One of the following programs:

• Perceptive Integration Server, version 6.7.x

• ImageNow Message Agent, version 6.7.x

• PeopleTools, version 8.50.x,8.52.x, or 8.53.x

Note You must have access to the PeopleSoft Enterprise Application Designer and the PeopleSoft Enterprise Web Application.

• Campus Solutions, version 9.0

• Apache Tomcat, version 7.0 or higher

• One of the following Java versions:

• For PeopleTools, version 8.50-8.52: Java, version 1.6 or higher (32-bit or 64-bit)

• For PeopleTools, version 8.53: Java, version 1.7 (32-bit or 64-bit)

Overview of the setup process To install and configure Perceptive Checklist Connector for PeopleSoft Campus Solutions, complete the following procedures in order.

Note This document includes instructions to install and configure the Checklist Connector using either Integration Server or Message Agent.

1. Prepare for the setup.

2. Install and configure the Checklist Connector.


of 28

3. Install and configure the PeopleSoft Update Checklist project.

4. Configure the ImageNow Envoy service.

5. Configure the ImageNow connection with the Checklist Connector.

Prepare for the setup Before you proceed with installing and configuring the Checklist Connector, review the following tasks and complete any as necessary.

• Create a PeopleSoft user for the connector.

• Find the PeopleSoft variable data, connector operation parameters, and checklist items.

• Verify or create ImageNow document properties and types.

• Create an ImageNow user for the connector.

Create a PeopleSoft user for the connector The Checklist Connector requires a PeopleSoft user to access and automatically update your PeopleSoft checklists. You must create a new PeopleSoft user with permissions for 3C Security Group, Components, and Component Interfaces. You need this user information to Configure the configurationtemplate.xml file.

For more information on creating PeopleSoft users, refer to your PeopleSoft documentation.

Find the PeopleSoft variable data, connector operation parameters, and checklist items

Every PeopleSoft checklist has a unique set of variable data, such as Student Career Nbr and Academic Career. The variable data corresponds to a Checklist Connector operation parameter. The Checklist Connector uses these operation parameters to identify the target checklist.

Each checklist also contains a set of checklist items, such as ESSAY and TOEFL.

For each PeopleSoft checklist, collect and record the following information.

• Variable data

• Corresponding Checklist Connector operation parameters

• Checklist items

To collect the information, complete the following steps.

1. Log in to PeopleSoft with an administrator account.

2. To identify the applicable checklist codes, complete the following substeps.

1. Under Menu, click Campus Community > Checklists > Person Checklists > Checklist Management - Person.

2. In the ID field, type the first digit or letter of a student ID and click Search.

3. Optional. To sort the list of checklists alphabetically, under Search Results, click Checklist Code.

4. Click the relevant checklist code. For example, ADMP.


of 28

3. On the Checklist Management 1 tab, click the Variable Data button.

4. To create a list of the Connector operation parameters, complete the following substeps.

1. Match each variable data with its corresponding Connector operation parameters using the table below.

2. Create a list of the Connector operation parameters for the checklist and click OK.

Variable Data Connector Operation Parameter

Academic Career ACADEMIC_CAREER

Academic Program ACADEMIC_PROGRAM

Account Term ACCOUNT_TERM

Aid Year AID_YEAR

Application Center APPLICATION_CENTER

Application Nbr APPLICATION_NUM

Application Program Nbr APPLICATION_PROGRAM_NUM

Appl Seq LOAN_APP_SEQ_NUM

Audience Type AUDIENC_TYPE

Audience Code AV_AUDIENC_TYPE

Event Meeting Nbr EVENT_MGMT_NUM

Initiative Code INIATIVE_CODE

Loan Application Number LOAN_APP_NUM

Loan Type Code LOAN_TYPE

Student Career Nbr STUDENT_CAREER_NUM

Term TERM

5. To create a list of the checklist item codes, on the Checklist Management 2 tab, under Item for each row, record the checklist item code. For example, ESSAY and TOEFL. You use the Connector operation parameters and the checklist item codes in Configure the configurationtemplate.xml file.

Verify or create ImageNow document properties and types To use the Checklist Connector, your ImageNow document key structure must include the following items.

• Document key or custom property for Student ID

• Document key or custom property for AppNumber, if your solution includes admissions checklists


of 28

• Document key or custom property for OrgID, if your solution includes transcripts

• Unique document type for each checklist item, such as Transcript, Essay, or 1040

Review your existing ImageNow document types and properties to verify that the document types necessary for your solution exist. For information on creating custom properties and document types, refer to Create a custom property and Add a document type in Management Console Help.

The decision to assign the other required or optional values as document keys or custom properties depends on your processes. The following table offers sample values of a document property structure.

Document Property Sample Value

drawer Admissions

field1 Student ID

field2 Last Name

field3 First Name

field4 Academic Term

field5 Program

document type Essay

A custom property

For example, assigned to the Essay document type

AppNumber

A custom property

For example, assigned to the Transcript document type

OrgID

Create an ImageNow user for the connector The Checklist Connector requires a unique user account on ImageNow Server. This manager account is only for the Checklist Connector. You do not use the Checklist Connector user as a log-in account. You need this user information to configure Message Agent or Integration Server.

To create an ImageNow user for the Checklist Connector, complete the following steps.

1. On your operating system or LDAP server, create a unique user account for the Checklist Connector, such as Checklist User.

2. As the ImageNow owner or administrator, start ImageNow Client and open Management Console.

3. In the left pane, click Users.

4. In the right pane, on the User Profiles tab, click New and type a username, such as Checklist User.

5. To promote the user to Manager, on the Security tab, click the Checklist Connector user and click Promote.

6. In the confirmation dialog box, click Yes.

https://docs.perceptivesoftware.com/robohelp/robo/server/6.7/PDM/en_US/help.htm#Subsystems/admin/custom_props/create_a_custom_property.htm%3FTocPath%3DAdministrator%20Topics%7CManaging%20ImageNow%7CManagement%20Console%7CCustom%20Properties%7C_____3

https://docs.perceptivesoftware.com/robohelp/robo/server/6.7/PDM/en_US/help.htm#Subsystems/admin/doc_types/add_a_document_type.htm%3FTocPath%3DAdministrator%20Topics%7CManaging%20ImageNow%7CManagement%20Console%7CDocument%20Types%7C_____4


of 28

Install and configure the Checklist Connector In this section, you install and configure the Checklist Connector to communicate with PeopleSoft.

Download the files Download a ZIP file that contains the necessary files to integrate the Checklist Connector, ImageNow, and your PeopleSoft application.

The ZIP file also contains a sample mapping XML file template.

To download the ZIP folder and extract the files, complete the following steps.

1. Go to the Perceptive Software website at www.perceptivesoftware.com and log in to the Customer Portal.

2. In the Product Downloads page, search for the file that matches your ImageNow environment.

• For Integration Server: Perceptive Checklist Connector for PeopleSoft IS67 <version>.zip

• For Message Agent: Perceptive Checklist Connector for PeopleSoft MA67 <version>.zip

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

Obtain and install the product licenses Perceptive Checklist Connector for PeopleSoft Campus Solutions requires the following licenses.

• Integration Framework

• ImageNow Checklist Connector for PeopleSoft

You must have Administrator privileges to install ImageNow licenses. The ImageNow Client must be available on a Windows computer to install the ImageNow product licenses. To obtain the hardware information for the ImageNow Server, you must be the administrator on Windows.

To obtain and install the product licenses, complete the following steps.

1. To generate a system fingerprint, complete the following substeps.

1. Click Start, click All Programs, click ImageNow 6, and then click ImageNow Management Console.

2. In the Login page, click License Manager.

3. In the License Management dialog box, select Save system fingerprint and click OK.

4. In the Save As dialog box, type a name for the file and navigate to the location where you want to save the fingerprint file. Click Save. The system fingerprint file has a SYSFP extension.

2. Contact your Perceptive Software representative for instructions on where to send the system fingerprint file to obtain your licenses.

3. When you receive the license files, store the license files in a temporary directory on the ImageNow Server computer.

4. To upload licenses, complete the following substeps.

1. Click Start, click All Programs and click ImageNow 6.

2. On the login page, click License Manager.

3. In the License Management dialog box, click Upload Licenses and click OK.

http://www.perceptivesoftware.com/


of 28

4. Navigate to the directory where you stored the ImageNow license files, select the LIC files to upload, and then click Open.

5. Type the User Name, Password, Server name or IP address, and Port number. Click OK.

6. Optional. The License Upload dialog box lets you view the license name, actual license code, and status of each license upload. To display detailed information for a specific license, click the appropriate row.

5. Click OK.

Install the Checklist Connector To install the Checklist Connector, complete the following steps.

1. In Windows Services, stop Apache Tomcat.

2. Navigate to your temporary directory and copy the Engine.war file to [drive:]\Program Files\Apache Software Foundation\Tomcat <version>\webapps.

3. Optional. The Checklist Connector creates a directory in the default location C:\IntegrationEngine. To specify an alternate location, complete the following substeps.

1. Start Apache Tomcat.

2. Navigate to [drive:]\Program Files\Apache Software Foundation\Tomcat <version>\webapps\Engine\WEB-INF and complete the following substeps.

1. Open web.xml with a text editor.

2. Configure <param-value> to the drive where you want the \IntegrationEngine\ directory installed.

3. Save and close web.xml.

4. Open log4j.ini with a text editor.

5. Search for all instances of C:\IntegrationEngine, and update each to the drive where you want the \IntegrationEngine\ directory installed.

6. Save and close log4j.ini.

3. Restart Apache Tomcat. The Checklist Connector deploys and creates the new \IntegrationEngine\ directory in the location you specified.

4. Optional. Delete the previously created C:\IntegrationEngine default directory.

5. Stop Apache Tomcat.

4. From the temporary directory, copy the PeopleSoft <version>\IntegrationEngine directory to the C drive, or to the drive you specified in the web.xml configuration file in the previous step.

Note If prompted to merge the directory with an existing directory, click Yes.

5. From the temporary directory, copy the IMAGENOW_WORK directory to [drive:]\[PeopleSoft directory]\projects.

6. Navigate to <PeopleSoft Application Server>\PS_HOME\web\psjoa and copy psjoa.jar to [drive:]\IntegrationEngine\lib\.

7. If using Integration Server, from the temporary directory, copy all files from the iScript directory to [drive:]\inserver6\script.


of 28

Configure the configurationtemplate.xml file The Checklist Connector associates ImageNow document types with checklist items in specific PeopleSoft checklists. For example, you may set the document type "Transcript" to update the status of the checklist item "TRANS" to read "received" or "complete." To specify which document types should associate with specific checklist items and lists, you configure the configurationtemplate.xml file.

For a sample of a completed file, refer to either Sample configuration.xml file for Message Agent or Sample configuration.xml file for Integration Server.

To configure the Checklist Connector, complete one of the following procedures.

• Configure the PeopleSoft and Integration Server information.

• Configure the PeopleSoft and Message Agent information.

Then, complete the following procedures.

• Configure the parameters for each of your PeopleSoft checklists.

• Configure the parameters for a transcript checklist item.

Configure the PeopleSoft and Integration Server information To configure the PeopleSoft user and Integration Server user information, complete the following steps.

1. Navigate to [drive:]\IntegrationEngine\etc and open configurationtemplate.xml with a text editor.

2. Under <section name="connectors">, configure the following parameters.

• In PEOPLESOFT_USERNAME, update the value with the Checklist Connecter user name you created.

Tip You created a PeopleSoft user with the necessary privileges in Prepare for the setup.

• In PEOPLESOFT_PASSWORD, update the value with the PeopleSoft password.

• In PEOPLESOFT_SERVER, update the value with the IP address or name of the application server computer running the PeopleSoft Jolt service.

• In PEOPLESOFT_PORT, update the value with the port number of the application server computer running the PeopleSoft Jolt service.

3. Under <section name="IntegrationServer">, configure the following parameters.

• In IntegrationServerURL, update the value with the URL for IntegrationServer. For example http://localhost:8080/integrationserver/.

• In Username, update the value with the Integration Server user name.

Tip You created an ImageNow user with the necessary privileges in Prepare for the setup.

• In Password, update the value with the Integration Server password.

4. Leave the text editor open and complete the Configure the parameters for each of your PeopleSoft checklists procedure.

Configure the PeopleSoft and Message Agent information To configure the PeopleSoft user and Message Agent user information, complete the following steps.

1. Navigate to [drive:]\IntegrationEngine\etc and open configurationtemplate.xml with a text editor.

of 28

2. Under <section name="connectors">, configure the following parameters.

• In PEOPLESOFT_USERNAME, update the value with the Checklist Connector user name you created.


• In PEOPLESOFT_PASSWORD, update the value with the PeopleSoft password.

• In PEOPLESOFT_SERVER, update the value with the IP address or name of the application server computer running the PeopleSoft Jolt service.

• In PEOPLESOFT_PORT, update the value with the port number of the application server computer running the PeopleSoft Jolt service.

3. Under <section name="MessageAgent">, configure the following parameters.

• In Username, update the value with the Message Agent user name.

Tip You created an ImageNow user with the necessary privileges in Prepare for the setup.

• In Password, update the value with the Message Agent password.

• In ServerName, update the value with the IP address or name of the computer running Message Agent.

• In ServerPort, update the value with the port number of the computer on which Message Agent is listening.

Configure the parameters for each of your PeopleSoft checklists To configure the parameters for each of your PeopleSoft checklists, create a block of configurable parameters.

Important The transcript checklist item (TRANS) requires its own configured section. If your checklist includes TRANS, refer to Configure the parameters for a transcript checklist item after completing this procedure.

Before beginning this procedure, you need the Checklist Connector operation parameters and checklist items you collected in Prepare for the setup.

Complete the following steps.

1. For each PeopleSoft checklist, create a copy of the code between  and .

2. Configure a block of parameters by adding the PeopleSoft Administrative Function name, in the following format. <section name="UpdateStudent<Administrative Function>Checklists">

For example, <section name="UpdateStudentADMPChecklists">

Note Referring to the Administrative Function is a way of organizing your checklist data within the XML configuration for your own reference. The XML configuration does not rely on this section name to identify the checklist.

3. Configure the Connector operation parameters for the checklist in the following format. The Checklist Connector requires the IN_DOC_TYPE_NAME and STUDENT_ID parameters for all checklists. <parameter name="<Connector operation parameter>" source="handler" value=""/>


of 28

For example, for the ADMP checklist, <parameter name="IN_DOC_TYPE_NAME" source="handler" value=""/> <parameter name="STUDENT_ID" source="handler" value=""/> <parameter name="STUDENT_CAREER_NUM" source="handler" value=""/> <parameter name="ACADEMIC_CAREER" source="handler" value=""/> <parameter name="APPLICATION_PROGRAM_NBR" source="handler" value=""/>

Important The Checklist Connector relies on the operation parameters to identify and update the correct checklist. If you do not provide sufficient information in this configuration file, the Checklist Connector may identify and attempt to update the wrong checklist.

Example

University B's administrator wants to configure a connector operation "Essay" on an ADMP checklist for essays received. The administrator creates the following configuration entry in configuration.xml. <section name="UpdateStudentEssayADMP"> <section name="inputs" value=""> <parameter name="IN_DOC_TYPE_NAME" source="handler" value="" /> <parameter name="STUDENT_ID" source="handler" value="" /> <parameter name="Essay" source="literal" value="CHKLST_ITEMS:Essay>c" /> </section> </section>

Unfortunately, the university has a scholarship department checklist SMP that also has an "Essay" checklist item. As a result, the Checklist Connector may accidentally update the SMP checklist instead of the ADMP checklist.

To avoid this issue, include additional connector operation parameters. In this situation, adding APPLICATION_NUMBER to the ADMP checklist configuration helps guarantee uniqueness and avoida conflicting updates. <section name="UpdateStudentEssayADMP"> <section name="inputs" value=""> <parameter name="IN_DOC_TYPE_NAME" source="handler" value="" /> <parameter name="STUDENT_ID" source="handler" value="" /> <parameter name="APPLICATION_NUMBER" source="handler" value="" /> <parameter name="Essay" source="literal" value="CHKLST_ITEMS:Essay>c" /> </section> </section>

4. Add the document type parameters and the corresponding checklist items you want to update in the following format. <parameter name="<ImageNow DocType>]" source="literal" value="CHKLST_ITEMS:<checklist item code>><checklist item status>"/>

The checklist item status controls the Status field for each PeopleSoft checklist item.

• c for complete

• r for received

For example, <parameter name="ACT" source="literal" value"CHKLST_ITEMS:ACTSAT>r"/> <parameter name="App Fee" source="literal" value"CHKLST_ITEMS:APPFEE>c"/> <parameter name="Essay" source="literal" value="CHKLST_ITEMS:ESSAY>c"/> <parameter name="Pers Status" source="literal" value="CHKLST_ITEMS:PERSTA>c"/>

Note Do not add Transcript as a parameter.

5. Repeat the previous steps for each checklist.

of 28

6. After you configure each checklist section using the template code, delete the original template code between  and .

7. If none of your checklists include transcripts, complete the following substeps to save and implement the configuration file. Otherwise, to configure lists for transcripts, continue to the Configure the parameters for a transcript checklist item procedure.

1. Save configurationtemplate.xml.

2. Click Save As and name the new copy configuration.xml.

Important Keep the original configurationtemplate.xml file you configured as a backup. In the event of an XML error, you may lose your changes in the configuration.xml file.

3. Restart Apache Tomcat.

Configure the parameters for a transcript checklist item In the previous procedure, you configured each checklist to include an Administrative Function name, Connector operation parameters, and document type parameters for non-transcript documents.

To use transcripts as the document type that triggers the TRANS checklist item, you configure an additional transcript-specific section for each checklist.

For each checklist that includes transcripts, complete the following steps.

1. Create a copy of the checklist’s section names and Connector operation parameters you just configured. For example, <section name="UpdateStudentADMPChecklists"> <section name="inputs" value=""> <parameter name="IN_DOC_TYPE_NAME" source="handler" value=""/> <parameter name="STUDENT_ID" source="handler" value=""/> <parameter name="STUDENT_CAREER_NUM" source="handler" value=""/> <parameter name="ACADEMIC_CAREER" source="handler" value=""/> <parameter name="APPLICATION_PROGRAM_NUM" source="handler" value=""/> <parameter name="APPLICATION_NUM" source="handler" value=""/>

2. Rename the section. For example, if you need to add transcripts to your ADMP checklist, you may name the new section UpdateStudentADMPTranscript.

3. Add TRANSCRIPT_ORGID as a Connector operation parameter. For example, <parameter name="TRANSCRIPT_ORGID" source="handler" value=""/>

4. To map your PeopleSoft transcript checklist item, add TRANSCRIPT_CHECKITEM and update value= to your transcript checklist item. For example, <parameter name="TRANSCRIPT_CHECKITEM" source="literal" value="TRANS"/>

5. Add Transcript as a checklist item. For example, <parameter name="Transcript” source=”literal” value="CHKLST_ITEMS:TRANS>c"/>

6. Close the section with </section> </section>.

For example, <section name="UpdateStudentADMPTranscript"> <section name="inputs" value=""> <parameter name="IN_DOC_TYPE_NAME" source="handler" value=""/> <parameter name="STUDENT_ID" source="handler" value=""/>


of 28

<parameter name="STUDENT_CAREER_NUM" source="handler" value=""/> <parameter name="ACADEMIC_CAREER" source="handler" value=""/> <parameter name="APPLICATION_PROGRAM_NUM" source="handler" value=""/> <parameter name="APPLICATION_NUM" source="handler" value=""/> <parameter name="TRANSCRIPT_ORGID" source="handler" value=""/> <parameter name="TRANSCRIPT_CHECKITEM" source="literal" value="TRANS"/> <parameter name="Transcript” source=”literal” value="CHKLST_ITEMS:TRANS>c"/> </section> </section>

7. Repeat the previous steps for each PeopleSoft checklist that requires transcripts as a checklist item.

8. To save and implement the configuration file, complete the following substeps.

1. Save configurationtemplate.xml.

2. Click Save As and name the new copy configuration.xml.

Important Keep the original configurationtemplate.xml file you configured as a backup. In the event of an XML error, you may lose your configured changes in the configuration.xml file.

3. Restart Apache Tomcat.

Sample configuration.xml file for Message Agent This sample shows a complete configuration.xml file with connections for the ADMP checklist, the ADMP transcript checklist item, and the Financial Aid (FINA) checklist. <?xml version="1.0" encoding="ISO-8859-1" standalone="no"?> <configuration> <section name="connectors"> <section name="PeoplesoftChecklistConnector"> <parameter name="PEOPLESOFT_USERNAME" value="PSuser"/> <parameter name="PEOPLESOFT_PASSWORD" value="PSpassword"/> <parameter name="PEOPLESOFT_SERVER" value="localhost"/> <parameter name="PEOPLESOFT_PORT" value="9000"/> </section> </section> <section name="MessageAgent"> <parameter name="Username" value="MAuser"/> <parameter name="Password" value="MApassword"/> <parameter name="ServerName" value="localhost"/> <parameter name="ServerPort" value="6070"/> </section> <section name="operations"> <section name="UpdateStudentChecklists"> <section name="UpdateStudentADMPChecklists"> <section name="inputs" value=""> <parameter name="IN_DOC_TYPE_NAME" source="handler" value=""/> <parameter name="STUDENT_ID" source="handler" value=""/> <parameter name="STUDENT_CAREER_NUM" source="handler" value=""/> <parameter name="ACADEMIC_CAREER" source="handler" value=""/> <parameter name="APPLICATION_PROGRAM_NUM" source="handler" value=""/> <parameter name="APPLICATION_NUM" source="handler" value=""/> <parameter name="ACT" source="literal" value="CHKLST_ITEMS:ACTSAT>r"/> <parameter name="App Fee" source="literal" value="CHKLST_ITEMS:APFEE>c"/> <parameter name="Essay" source="literal" value="CHKLST_ITEMS:ESSAY>c"/> <parameter name="Pers Status" source="literal" value="CHKLST_ITEMS:PERSTA>c"/> </section> </section> <section name="UpdateStudentADMPTranscript">


of 28

<section name="inputs" value=""> <parameter name="IN_DOC_TYPE_NAME" source="handler" value=""/> <parameter name="STUDENT_ID" source="handler" value=""/> <parameter name="STUDENT_CAREER_NUM" source="handler" value=""/> <parameter name="ACADEMIC_CAREER" source="handler" value=""/> <parameter name="APPLICATION_PROGRAM_NUM" source="handler" value=""/> <parameter name="APPLICATION_NUM" source="handler" value=""/> <parameter name="TRANSCRIPT_ORGID" source="handler" value=""/> <parameter name="TRANSCRIPT_CHECKITEM" source="literal" value="TRANS"/> <parameter name="Transcript" source="literal" value="CHKLST_ITEMS:TRANS>c"/> </section> </section> <section name="UpdateStudentFINAChecklists"> <section name="inputs" value=""> <parameter name="IN_DOC_TYPE_NAME" source="handler" value=""/> <parameter name="STUDENT_ID" source="handler" value=""/> <parameter name="AID_YEAR" source="handler" value=""/> <parameter name="FINAID" source="literal" value="CHKLST_ITEMS:FAN>c"/> <parameter name="FAT" source="literal" value="CHKLST_ITEMS:FAT>c"/> <parameter name="VER" source="literal" value="CHKLST_ITEMS:VERWKS>c"/> <parameter name="1040S" source="literal" value="CHKLST_ITEMS:1040S>c"/> <parameter name="001001" source="literal" value="CHKLST_ITEMS:001001>c"/> </section> </section> </section> </section> </configuration>

Sample configuration.xml file for Integration Server This sample shows a complete configuration.xml file with connections for the ADMP checklist, the ADMP transcript checklist item, and the Financial Aid (FINA) checklist. <?xml version="1.0" encoding="ISO-8859-1" standalone="no"?> <configuration> <section name="connectors"> <section name="PeoplesoftChecklistConnector"> <parameter name="PEOPLESOFT_USERNAME" value="PSuser"/> <parameter name="PEOPLESOFT_PASSWORD" value="PSpassword"/> <parameter name="PEOPLESOFT_SERVER" value="localhost"/> <parameter name="PEOPLESOFT_PORT" value="9000"/> </section> </section> <section name="IntegrationServer"> <parameter name="IntegrationServerURL" value=" http://localhost:8080/integrationserver/" /> <parameter name="Username" value="ISUser" /> <parameter name="Password" value="ISPassword" /> </section> <section name="operations"> <section name="UpdateStudentChecklists"> <section name="UpdateStudentADMPChecklists"> <section name="inputs" value=""> <parameter name="IN_DOC_TYPE_NAME" source="handler" value=""/> <parameter name="STUDENT_ID" source="handler" value=""/> <parameter name="STUDENT_CAREER_NUM" source="handler" value=""/> <parameter name="ACADEMIC_CAREER" source="handler" value=""/> <parameter name="APPLICATION_PROGRAM_NUM" source="handler" value=""/> <parameter name="APPLICATION_NUM" source="handler" value=""/>


of 28

<parameter name="ACT" source="literal" value="CHKLST_ITEMS:ACTSAT>r"/> <parameter name="App Fee" source="literal" value="CHKLST_ITEMS:APFEE>c"/> <parameter name="Essay" source="literal" value="CHKLST_ITEMS:ESSAY>c"/> <parameter name="Pers Status" source="literal" value="CHKLST_ITEMS:PERSTA>c"/> </section> </section> <section name="UpdateStudentADMPTranscript"> <section name="inputs" value=""> <parameter name="IN_DOC_TYPE_NAME" source="handler" value=""/> <parameter name="STUDENT_ID" source="handler" value=""/> <parameter name="STUDENT_CAREER_NUM" source="handler" value=""/> <parameter name="ACADEMIC_CAREER" source="handler" value=""/> <parameter name="APPLICATION_PROGRAM_NUM" source="handler" value=""/> <parameter name="APPLICATION_NUM" source="handler" value=""/> <parameter name="TRANSCRIPT_ORGID" source="handler" value=""/> <parameter name="TRANSCRIPT_CHECKITEM" source="literal" value="TRANS"/> <parameter name="Transcript" source="literal" value="CHKLST_ITEMS:TRANS>c"/> </section> </section> <section name="UpdateStudentFINAChecklists"> <section name="inputs" value=""> <parameter name="IN_DOC_TYPE_NAME" source="handler" value=""/> <parameter name="STUDENT_ID" source="handler" value=""/> <parameter name="AID_YEAR" source="handler" value=""/> <parameter name="FINAID" source="literal" value="CHKLST_ITEMS:FAN>c"/> <parameter name="FAT" source="literal" value="CHKLST_ITEMS:FAT>c"/> <parameter name="VER" source="literal" value="CHKLST_ITEMS:VERWKS>c"/> <parameter name="1040S" source="literal" value="CHKLST_ITEMS:1040S>c"/> <parameter name="001001" source="literal" value="CHKLST_ITEMS:001001>c"/> </section> </section> </section> </section> </configuration>

Install and configure the PeopleSoft Update Checklist project Use PeopleSoft Enterprise Application Designer to install and configure the PeopleSoft Update Checklist project.

Install the PeopleSoft Update Checklist project To install the PeopleSoft Update Checklist project, complete the following steps.

1. In PeopleSoft Application Designer, on the Tools menu bar, click Copy Project and click From File.

2. In the Copy From File: Select Project dialog box, under Select Project from the List Below, select IMAGENOW_WORK and click Select.

Configure the Web Application privileges To configure the Web Application privileges, complete the following steps.

Prerequisite To complete the following steps, you must have permissions to 3C Security Group, Components, and Component Interfaces.

1. Optional. Create a new user with 3C permissions.


of 28

Note You may use an existing user with the correct permissions or create a new one. For more information on creating a PeopleSoft user for the Checklist Connector and configuring 3C permissions, refer to Appendix A: PeopleSoft security.

2. In PeopleTools, click Security and then click User Profiles.

3. On the Find an Existing Value tab, complete the following substeps.

1. In the Search by list, click User ID.

2. In the begins with box, type the user name you created for the Checklist Connector.


3. Click Search.

4. On the Roles tab, click View Definition for AppServer Administration.

5. On the Permissions List tab, click an appropriate Permission List. For example, EOCO9000.

6. Click Save and then click View Definition for that permission list.

7. On the Component Interfaces tab, click the plus button, type IM_CHECKLIST_MGMT_CI, and then click Edit.

8. On the Components Interface Permissions page, click the Full Access (All) button and click OK.

Test the created PeopleSoft Campus Solutions definition To test the definition you created in Configure the Web Application privileges, complete the following steps.

1. In PeopleSoft Application Designer, click Open. In the Open Definition dialog box, complete the following substeps.

1. In the Definition list, click Component Interface.

2. Under Selection Criteria, in the Name field, type IM_CHECKLIST_MGMT_CI.

3. Click Open.

2. In the IM_CHECKLIST_MGMT_CI window, in the right pane, right-click IM_CHECKLIST_MGMT_CI and click Test Component Interface.

3. In the Component Interface Tester dialog box, under ‘Find’ keys for Component Interface, click the cell next to Common_ID and type a student ID.

4. Verify that it returns student record results.

Configure the ImageNow Envoy service In this section, you configure the ImageNow Envoy service.

ImageNow Envoy provides the ability to send unsolicited, Web service-based requests. Envoy sends messages to the Checklist Connector, which routes the messages to PeopleSoft Campus Solutions.

To add the remote service to ImageNow Envoy, complete the following steps.

1. In Management Console, in the left pane, click Envoy Services.

2. On the Envoy tab, in the right pane, click New.


of 28

3. In the Definition page, complete the following substeps.

• In the Name box, type UpdateStudentChecklists to identify the remote service throughout ImageNow.

• Optional. In the Description box, type a description. For example, Update student checklists in PeopleSoft.

• In the URI box, type the URI for the Checklist Connector in the format http://<ConnectorMachineName>:<port>/Engine/ASQEndpoint. For example, http://localhost:8080/Engine/ASQEndpoint.

Note A Uniform Resource Identifier (URI) consists of a string of characters used to identify or name a resource on the Internet. You may classify a URI as a Uniform Resource Locator (URL), a Uniform Resource Name (URN), or both.

• In the Authentication list, click None.

• Optional. If you want to enable interceptor logging for the remote service, select the Enable interceptor logging check box.

Note You use the Interceptor logging files for troubleshooting issues with SOAP requests and responses.

4. Click Next.

5. In the Operations page, select the check box for each remote service operation for UpdateStudentChecklists and click Finish.

Note Depending on the size of the remote service, the Operations page may take a few minutes to load.

Configure the ImageNow connection with the Checklist Connector In this section, you configure the ImageNow connection with the Checklist Connector by creating a workflow process that includes Automated System Queues (ASQs). When specified student documents move through your workflow process, Envoy communicates with the Checklist Connector. Then the Checklist Connector updates the indicated PeopleSoft checklist items. Workflow routes a document to the success queue if the updates succeeds. A document that does not update its PeopleSoft checklist item routes to the fail queue for further action or evaluation. For example, incomplete or incorrect custom properties may cause a document to fail.

The workflow layout provided here is one way to configure ImageNow. The following procedures guide you through creating a single workflow process per PeopleSoft checklist. Depending on the existing structure of your ImageNow workflows, you may combine multiple workflows into a single process. You may also use the queues described here to integrate with a pre-existing workflow process.

To configure the ImageNow to communicate with the Checklist Connector, complete the following procedures as applicable to your particular needs.

• Create a workflow process.

• Configure a process to include transcripts.

• Configure a process that does not include transcripts.


of 28

Create a workflow process To create a new workflow process for each of your PeopleSoft checklists, complete the following steps.

1. In Management Console, in the left pane, click Workflow.

2. In the right pane, on the Workflow tab, click New.

3. In the Add Process dialog box, in the Name box, type a name specific to the checklist. For example, ADMP Checklist.

4. Optional. In the Description box, type a description of the process or checklist.

5. Repeat the previous steps to create a new workflow for each PeopleSoft checklist.

About checklists and processes with transcripts The presence of transcripts as a checklist item in your PeopleSoft checklist dictates the procedure you use next. The Checklist Connector includes special transcript document type processing. A checklist process that includes transcripts requires an additional level in the workflow to separate transcripts from all other document types. From there, both transcripts and other document types trigger their respective PeopleSoft checklist items. Then, they route into either the success queue or the fail queue that you create.

For any PeopleSoft checklist that includes transcripts, follow the procedures under Configure a process to include transcripts to create the workflow.

For any PeopleSoft checklist that does not include transcripts, follow the procedures under Configure a process that does not include transcripts.

Configure a process to include transcripts To create a workflow process for a checklist that includes transcripts, complete the following procedures in order.

1. Create the queues.

2. Apply routing rules to the incoming documents queue.

3. Configure the transcripts and other docs automated system queues.

Create the queues Add the following queues to each workflow process that includes transcripts.

• A Work queue for incoming student documents

• Two ASQs to separate document types, such as Transcripts and Other Docs

• A success and a fail Work queue

To modify a workflow process, complete the following steps.

1. In Management Console, in the left pane, click Workflow and double-click one of the workflow processes you created in the previous procedure to modify it.

2. To create the Work queues, complete the following substeps.

1. In the Workflow Designer window, in the left pane, under Queues, drag a Work queue to your process diagram.


of 28

2. To modify the queue properties, double-click the queue.

3. In the Queue Properties dialog box, in the left pane, click Properties. Then, in the right pane, under General, in the Name box, type a name for the incoming documents queue. For example, ADMP_Student_Docs.

4. In the left pane, click Users. Then, in the right pane, click Add and complete the following substeps.

1. In the Select Users and Groups dialog box, on the Users tab, under Search for users, search for the user you want to grant access to the queue.

2. Under Search results, click the user who should have access to the queue, click Add, and then click OK.

5. In the Queue Properties dialog box, in the right pane, click the row of the user you just added.

6. In the Add and Process columns, click in each column until the Grant icon appears and click OK.

7. Repeat the previous steps to create and name the pass and fail queues, and grant user access. For example, ADMP_Success and ADMP_Fail.

3. To create the ASQs queues, complete the following substeps.

1. In the Workflow Designer window, in the left pane, under Queues, drag an Integration queue to your process diagram.

2. To modify the queue properties, double-click the queue.

3. In the Queue Properties dialog box, in the Name box, type a name for the transcript document type queue. For example, ADMP_Transcripts. Click OK.

4. Repeat the previous steps to create and name a queue for other document types. For example, ADMP_OtherDocs. Click OK.

5. Click the Routes button and define the following routes.

• From the fail queue to the transcript ASQ, such as ADMP_Transcripts

• From the fail queue to the other documents ASQ, such as ADMP_OtherDocs

Tip For a visual example, refer to the diagram in Example: A workflow process with transcripts.

4. Repeat the previous steps for any additional workflows involving transcripts.

Apply routing rules to the incoming documents queue To automatically route documents from the incoming documents queue to the ASQ for student transcripts or the ASQ for all other student documents, complete the procedures below in order.

Create the transcript rule To create the transcript rule, complete the following steps.

1. In the Workflow Designer window, double-click the incoming documents queue to modify its properties. For example, the ADMP_Student_Docs queue.

2. In the Queue Properties window, in the left pane, click Actions. In the right pane, on the Within Queue tab, in the Action list, click Edit Actions.


of 28

3. In the Action Settings window, click New. In the Rules Editor window, name the rule Transcript Rule.

4. In the Rule type list, click Routing rule.

Create the "Is Transcript" statement To create the "Is Transcript" statement, complete the following steps.

1. Under Statements, click New. In the Statement Editor window, complete the following substeps.

1. Name the statement Is Transcript.

2. Under Conditions, click the Add button. In the Add Condition window, complete the following substeps and click OK.

1. Set Constrain by to Content Property.

2. Set Type to Normal.

3. Set Field to Document Type.

4. Set Operator to is equal to.

5. Set Value to Transcript.

3. Under Actions, click Add and click Route to. In the Queues window, complete the following substeps and click OK.

1. Under Business Process, click the name of the current workflow process. For example, ADMP Checklist.

2. Under Available Queues, click the transcript queue, such as ADMP_Transcripts, click Add, and then click OK.

2. In the Statement Editor, click OK.

Create the "Is not Transcript" statement To create the "Is not Transcript" statement, complete the following steps.

1. Under Statements, click New. In the Statement Editor window, complete the following substeps.

1. Name the statement Is not Transcript.

2. Under Conditions, click the Add button. In the Add Condition window, complete the following substeps and click OK.

1. Set Constrain by to Content Property.

2. Set Type to Normal.

3. Set Field to Document Type.

4. Set Operator to is not equal to.

5. Set Value to Transcript.

3. Under Actions, click Add and click Route to. In the Queues window, complete the following substeps and click OK.

1. Under Business Process, click the name of the current workflow process. For example, ADMP Checklist.


of 28

2. Under Available Queues, click the queue doc types other than transcripts, such as ADMP_OtherDocs, click Add, and then click OK until you return to the Queue Properties window.

2. On the Within Queue tab, in the Action list, click Transcript Rule and click OK.

Configure the transcripts and other docs automated system queues To trigger the PeopleSoft checklist items and automatically route documents to the pass and fail queues, configure the Transcripts and OtherDocs ASQs. You configure the ASQs by mapping the connector operation parameters you configured in configuration.xml to the corresponding ImageNow document property, custom property, or document type field.


Tip Open configuration.xml in a text editor for quick reference as you configure the Connector operation parameters in the Parameter Maps in this procedure.

1. In the Workflow Designer window, double-click the transcripts ASQ to modify its properties. For example, ADMP_Transcripts.

2. In the Queue Properties window, under Success Action, in the Process list, click the name of the current workflow process. In the Queue list, click the name of the success queue. For example, ADMP_Success.

3. Under Failure Action, in the Process list, click the name of the current workflow process. In the Queue list, click the name of the fail queue. For example, ADMP_Fail.

4. Under Envoy Service in the Service Operation Name list, click the name of the checklist that corresponds to the current workflow process. For example, UpdateStudentADMPChecklists.

5. Under the new Parameter Map, complete the following substeps.

• In Endpoint Parameter Name, type STUDENT_ID.

• In Outgoing Parameter Variable, in the list, click the document key, or click custom properties to find the custom property for student ID. For example, Field1.

• In Parameter Map, click the empty box and click + to add a new Parameter Map.

6. Continue mapping by configuring each Connector operation parameter for the current checklist as Endpoint Parameter Names, and the corresponding document property or custom property for the Outgoing Parameter Variable. After you finish mapping, click OK.

7. Repeat the previous steps to configure the Other Docs ASQ.

Example: A workflow process with transcripts Here is an example of a workflow process that includes transcripts. You may adjust the layout and the queue names as necessary to fit your process needs.


of 28

Configure a process that does not include transcripts To create a workflow process for a checklist without transcripts, complete the following procedures in order.

1. Create the queues.

2. Configure the incoming documents automated system queue.

Create the queues For each workflow process that does not include transcripts, add the following queues.

• An ASQ for incoming student documents

• A success and a fail Work queue


of 28

To modify a workflow process, complete the following steps.

1. In Management Console, in the left pane, click Workflow and double-click one of the workflow processes you created previously to modify it.

2. To create an ASQ, complete the following substeps.

1. In the Workflow Designer window, in the left pane, under Queues, drag an Integration queue to your process diagram.

2. Double-click the queue to modify its properties.

3. In the Queue Properties dialog box, in the Name box, type a name for the incoming documents queue. For example, FINA_Docs. Click OK.

3. To create the success queue, complete the following substeps.

1. In the Workflow Designer window, in the left pane, under Queues, drag a Work queue to your process diagram.

2. Double-click the queue to modify its properties.

3. In the Queue Properties dialog box, in the left pane, click Properties. Then, in the right pane, under General, in the Name box, type a name for the success queue. For example, FINA_Pass.

4. In the left pane, click Users. Then, in the right pane, click Add and complete the following substeps.

1. In the Select Users and Groups dialog box, on the Users tab, under Search for users, search for the user you want to grant access to the queue.

2. Under Search results, click the user who should have access to the queue, click Add and then click OK.

3. In the Queue Properties dialog box, in the right pane, click the row of the user you just added.

4. In the Add and Process columns, click in each column until the Grant icon appears and click OK.

4. Repeat the previous step to create, the fail queue. For example FINA_ Fail.

5. Click the Routes button and draw a sequential route from the fail queue to the incoming document queue.

Tip For a visual example, refer to the diagram in Example: A workflow process without transcripts.

Configure the incoming documents automated system queue To trigger the PeopleSoft checklist items and automatically route documents to the pass and fail queues, configure the incoming documents ASQ. You configure the ASQ by mapping the Connector operation parameters you configured in configuration.xml to the corresponding ImageNow document property, custom property, or document type field.


Tip Open configuration.xml in a text editor for quick reference as you configure the Connector operation parameters in the Parameter Maps in this procedure.

1. In the Workflow Designer window, double-click the incoming documents ASQ to modify its properties. For example, FINA_Docs.


of 28

2. In the Queue Properties window, under Success Action, in the Process list, click the name of the current workflow process and in the Queue list click the name of the success queue. For example, FINA_Success.

3. Under Failure Action, in the Process list, click the name of the current workflow process. In the Queue list, click the name of the fail queue. For example, FINA_Fail.

4. Under Envoy Service in the Service Operation Name list, click the name of the checklist that corresponds to the current workflow process. For example, UpdateStudentFINAChecklists.

5. Under Envoy Service Parameters, under Parameter Map, click Add and complete the following substeps.

• In Endpoint Parameter Name, type IN_DOC_TYPE_NAME.

• In Outgoing Parameter Variable, in the list, click Type.

• In Parameter Map, click the empty box, and click + to add a new Parameter Map.

6. Under the new Parameter Map, complete the following substeps.

• In Endpoint Parameter Name, type STUDENT_ID.

• In Outgoing Parameter Variable, in the list, click the document key, or click custom properties to find the custom property, for student ID. For example, Field1.

• In Parameter Map, click the empty box, and click + to add a new Parameter Map.

7. Continue mapping by configuring each Connector operation parameter for the current checklist as Endpoint Parameter Names, and the corresponding document property or custom property for the Outgoing Parameter Variable. After you finish mapping, click OK.

Example: A workflow process without transcripts Here is an example of a workflow process that does not include transcripts. You may adjust the layout and the queue names as necessary to fit your process needs.


of 28

Appendix A: PeopleSoft security To create a new user in PeopleSoft and configure 3C security for that user, complete the following steps.

Note For detailed procedure steps, refer to your PeopleSoft documentation.

1. Create a permission list and complete the following substeps.

• Grant access to all pages, in the CHKLST_MANAGEMENT component, in the MANAGE_CHECKLISTS menu bar.

• Grant Full Access (All) to all methods in the IM_CHECKLIST_MGMT_CI component interface delivered with the Checklist Connector.

2. Create a new role and grant access to the previously created permission list.

3. Create a new user and complete the following substeps.

• Set the Symbolic ID. For example, psaccess.

• Set the Password.

• Set HCPPALL as the Primary under Permission Lists.

• Assign the previously created role.

4. Create a new 3C Update/Inquiry Group and add all checklist items you want the Checklist Connector to update.

5. Associate the new user with the new 3C group and complete the following substeps.

• Under 3C Group Security, update the User ID.

• Select the Inquiry Indicator and Update Indicator check boxes.


of 28

Index about checklists and processes with transcripts,

20

configuring

configurationtemplate.xml file, 15, 16 Integration Server configuration.xml, 16 Message Agent configuration.xml, 15 sample file, 15, 16

configuring a process to include transcripts, 20

applying routing rules to the incoming documents queue, 21

configuring the transcripts and other documents automated system queues, 23

creating the queues, 20 example workflow process with transcripts, 23

configuring a process to that does not include transcripts, 24

example workflow process without transcripts, 26

configuring the incoming documents automated system queue, 25

creating the queues, 24

configuring ImageNow Envoy, 18

configuring the Checklist Connector, 9

configuring the configurationtemplate.xml file, 11

configuring the parameters for a transcript checklist item, 14

configuring the parameters for each of your PeopleSoft checklists, 12

configuring the PeopleSoft and Integration Server information, 11

configuring the PeopleSoft and Message Agent information, 11

configuring the ImageNow connection, 19

creating a workflow process, 20

downloading the files, 9

installing the Checklist Connector, 9, 10

installing the product licenses, 9

obtaining the product licenses, 9

overview, 5

PeopleSoft security, 27

PeopleSoft Update Checklist project, 17

configuring Web Application privileges, 17 installing the project, 17 testing the definition, 18

prerequisites, 5

setup

creating a PeopleSoft user, 6 creating an ImageNow user, 8 finding the connector operation parameters, 6 finding the PeopleSoft checklist items, 6 finding the PeopleSoft variable data, 6 overview, 5 preparation, 6 verifying the ImageNow document properties

and types, 7

perceptive checklist connector for peoplesoft … connector for microsoft dynamics ax installation...

Documents