Return to Navigation

Understanding Interface Setup Best Practices

This section discusses how to:

There are several areas where you can review your settings and make the necessary corrections to avoid errors after setting up your Contributor Relations system to integrate with Financials 8.4 or 8.8.

The following reminders apply to general integration setup:

  • You must set up Batch Publish Rules for the STUDENT_ADV_ACCTG_LINE message.

  • You must set up Full Table Publish Rules for the BUS_UNIT_AV_FULLSYNC message.

  • You must set the Financials Release to 8.4 or 8.8 on the CR Installation page.

Verify your channel settings in Application Designer. This will help you avoid situations in which a published message remains in New status and does not complete its path and change the status to Done, or in which the message does not appear in the Service Operation Monitor after the process to generate it is complete.

Note: HR_SETUP channel is for the business unit messages and STUDENT_ADMIN_ACCOUNTING channel is for the Accounting line message.

The following best practices apply to the channels HR_SETUP and STUDENT_ADMIN_ACCOUNTING:

  • Open the Queue, go to Queue Properties, and make sure the Queue Status is set to Run for both of these channels.

  • The HR_SETUP channel routing direction should be set to Publish to, and a valid Message Node Name should be specified.

  • The BUS_UNIT_AV_FULLSYNC, and BUS_UNIT_AV_SYNC messages should appear under the Messages tab for the HR_SETUP channel.

  • The STUDENT_ADMIN_ACCOUNTING channel routing direction should be set to Both (Publish and Subscribe), and a valid Message Node Name should be specified.

  • The STUDENT_ADV_ACCTG_LINE message should appear under the Messages tab for the STUDENT_ADMIN_ACCOUNTING channel.

  • For each Queue, confirm that the Routing Rules are set up correctly. Confirm the correct Message Node Name for each channel.

Review your security settings. This will help you avoid situations in which a published message remains in New status rather than completing its path and changing status to Done, or in which the message does not appear in the Service Operation Monitor after the process to generate it is complete.

To check security settings:

  1. Navigate to select PeopleTools, then select Security, then select Permissions & Roles, then select Permission Lists.

  2. Enter a Permission List value.

  3. Select the Service Operations Monitor tab.

  4. Determine whether the channel(s) appear there.

  5. If the channels do not appear, enter HR_SETUP and STUDENT_ADMIN_ACCOUNTING in the Channel Name fields.

  6. Based on your security business rules, select Full or Read Only access for each channel.

  7. Save the changes.

    You can now return to the Service Operation Monitor and search for a particular message/channel.

Verify your channel settings in Application Designer. Verify these items in both the Contributor Relations and Financials databases. The following tips apply to the messages BUS_UNIT_AV_FULLSYNC, BUS_UNIT_AV_SYNC, and STUDENT_ADV_ACCTG_LINE:

  • Open the Message Definition, go to Message Properties, make sure that the Active Status check box is selected.

  • Make sure that the correct Queue is specified for the Message Definition (that is, HR_SETUP channel is for the business unit messages and STUDENT_ADMIN_ACCOUNTING channel is for the accounting line message).

  • In Service Operation Monitor, check the Channel Status tab. The channel status must be Running.

  • Message Nodes are set up correctly, including the correct Location/URL.

Verify your message definition settings in Application Designer. Verify statuses for the Contributor Relations message subscription STUDENT_ADV_ACCTG_LINE and the Financials 8.4 or 8.8 message subscriptions BusUnitAVFullSync, BusUnitAVSync, and StudentAdvancementAcctgLine.

To verify status:

  1. Open the Message Definition, then the Message.

  2. Right-click the Message Subscription.

  3. Make sure the Active Status check box is selected.

Ping the publishing and subscribing database nodes.

To ping a database node:

  1. Sign on to the Contributor Relations database.

  2. Navigate to select PeopleTools, then select Integration Broker, then select Service Operations Monitor, then select Administration, then select Node Status.

  3. Enter the Message Node Name.

  4. Click the Ping Node button.

  5. If the node does not ping successfully, the gateway is bad; check the Node and Node URL.

  6. If the node pings successfully, sign on to the Financials database and ping the Contributor Relations database node using Integration Broker.

    See PeopleTools: Integration Broker.

If changes are made to Queues and/or Message Nodes, it is a good idea to stop and then start the Application Server. You can also delete the Application Server cache.