Using Desktop Integration

This chapter provides an overview of desktop integration and discusses how to:

Click to jump to parent topicUnderstanding Desktop Integration

Desktop Integration provides seamless integration between Microsoft Office and your PeopleSoft applications, enabling your organization to schedule and track appointments, meetings, tasks, and corresponding documentation. This is accomplished through a framework to the Microsoft Office suite that enables PeopleSoft applications to extend functionality into the office suite through layers. A two-way communication is established between the PeopleSoft application and Microsoft Outlook and Word, with Outlook receiving the information from and sending updates to the PeopleSoft application.

The framework consists of the following components:

Microsoft Outlook and Word Add-In

Add-ins are supplemental programs that extend the functionality of Office applications, adding custom commands and custom features that plug into the application through well-known entry points. The Microsoft Outlook and Word Add-ins contain all of the pieces necessary for sending information to and receiving information from the PeopleSoft applications. Microsoft Office Add-ins invoke functions in this layer for user authentication, launching web services to receive and send data from the PeopleSoft application. On the PeopleSoft side, services and application classes exist that accept the requests from Microsoft Outlook and Word and perform the necessary actions and data retrieval. The Microsoft Outlook and Word Add-ins use a Secure Socket Layer (SSL) to connect to the PeopleSoft applications for secure and synchronous messaging.

See Understanding the PeopleSoft and Outlook Integration.

Integration Broker/Web Services Layer

Oracle uses the Integration Broker to connect Microsoft Outlook and Word to the PeopleSoft applications. Oracle delivers predefined interfaces and security classes. Desktop Integration does not require a dedicated server nor any additional hardware. To connect Microsoft Outlook and Word to PeopleSoft applications and ensure security, SSL is required.

Desktop Integration Layer

The Desktop Integration application classes are responsible for receiving the messages sent through Integration Broker from the Microsoft Office applications. The Desktop Integration layer creates, updates, and moves the data in and out of the PeopleSoft system and is responsible for responding to all events. As events are processed, control is optionally passed on to the PeopleSoft Application Layer for handling.

PeopleSoft Application Layer—for the PeopleSoft Applications to Use

Any application-specific functions are contained within the PeopleSoft Application Layer. When you are creating new integrations or customizing existing ones, all application-specific code is contained within the application layer.

Click to jump to top of pageClick to jump to parent topicPrerequisites

These are the prerequisites for using Desktop Integration:

Click to jump to parent topicSetting Up Desktop Integration

This section discusses how to set up Desktop Integration. Specifically, it discusses how to:

Click to jump to top of pageClick to jump to parent topicPages Used to Set Up Desktop Integration

Page Name

Definition Name

Navigation

Usage

Service Operations - General page

IB_SERVICE

PeopleTools, Integration Broker, Integration Setup, Service Operations, General

Customize integration metadata to suit your particular business needs. However, note that integration metadata for this functionality (for example, service operations, routing definitions, service operations handlers, and so on) is delivered with your application; no additional configuration is required.

Web Service Access

WS_ACCESS_IB

Click the Service Operation Security link on the Service Operations - General page.

Define permissions and user access. Customize integration metadata to suit your particular business needs.

System Setup

EODI_SYSTEM_SETUP

Enterprise Components, Desktop Integration, System Setup

Configure Desktop Integration and the PeopleSoft system.

Click to jump to top of pageClick to jump to parent topicSetting Up the Integration Broker

Access the Service Operations - General page (PeopleTools, Integration Broker, Integration Setup, Service Operations, General).

To use Desktop Integration functionality, PeopleSoft Integration Broker must be set up and running.

Integration metadata for this functionality (for example, service operations, routing definitions, service operation handlers, and so on) is delivered with your application; no additional configuration is required. However, you can customize integration metadata to suit your particular business needs. All Desktop Integration service definitions have names that begin with EODI and are grouped by function. By default, the default local node receives all inbound integrations.

This PeopleBook contains all the information for configuring and setting up the Integration Broker.

See Enterprise PeopleTools PeopleBook: PeopleSoft Integration Broker Administration.

This PeopleBook describes how to create and modify integration metadata.

See Enterprise PeopleTools PeopleBook: PeopleSoft Integration Broker

Click to jump to top of pageClick to jump to parent topicSetting Up Pages and Web Service Security

Access the Web Service Access page (click the Service Operation Security link on the Service Operations - General page).

Oracle delivers these permission lists:

EODI1000

Administrator level service operations for the queue. Select the access that you want for the user group:

  • Full Access

  • Queue

  • App Class

EODI1000 is the permission list that contains all of the pages under the Desktop Integration menu. Administrators need access to this list.

EODI_Administrator has EODI1000 defined as a role.

EODI2000

Service level service operations for the application classes. Select the access that you want for the user group:

  • Full Access

  • Queue

  • App Class

EODI2000 is the permission list that contains all of the web services that Desktop Integration uses. Any user of the Microsoft Outlook and Word Add-Ins needs access to this list.

The permission list contains a list of all Integration Broker services that the add-ins use to communicate with PeopleSoft applications.

EODI_RemoteUser has EODI2000 defined as a role.

Click to jump to top of pageClick to jump to parent topicSetting Up the System

Access the System Setup page (Enterprise Components, Desktop Integration, System Setup).

System ID

Enter a unique system ID. This ID must be unique across your organization to allow use across multiple data bases.

After being set, this ID is used internally as a key on different pieces of information.

For example, if you plan to connect to more than one PeopleSoft database, each database must have a unique ID. So if you have an HR instance and an FSCM instance, each system should use a different system ID. When a transaction is passed to Microsoft Outlook, that transaction includes the system ID and the transaction ID from the database where it originated. Later, when the add-in needs to know the origin of that data, the information from the system ID and the transaction ID is used.

Release Version

The version of the system identified by the system ID. This number is predefined.

This number is used internally and is updated only when a new version of Desktop Integration is available.

Description

A description of the system that the system ID identifies. Enter a unique description.

The description can be a mixture of uppercase and lowercase with a maximum limit of 30 characters.

This description is visible within the Microsoft Office applications server configuration.

Logging Level

Specify the level of logging that you want. This controls the level of detail that is sent to the display log. Select a logging level from the drop-down list box. Values are:

  • 0: No logging

    This is the default. Due to minor performance impact, Oracle recommends that you select 0.

  • 1: Errors

  • 2: Warnings and above

  • 3: Information and above

See Using the Display Log.

Last Task Transaction ID

The transaction ID for the last task that keeps the tasks synchronous. This ID is auto incremented and should not normally be adjusted.

Last Appt. Transaction ID (last appointment transaction identifier)

The date of the last appointment transaction.

This is autogenerated, tracked, and used for synchronization.

Last Transaction ID

This is autogenerated, tracked, and used for synchronization.

File Chunk Size (Bytes)

The file size with which to move data to a temporary directory. This value is predefined. Administrators can set up chunking size for performance purposes.

Temporary Directory

The temporary directory where you want to reassemble the data.

Files are spooled to a temporary directory and reassembled there before completing. This directory must be available on all application servers that may process the incoming Desktop Integration Broker messages.

See Using the Display Log.

Click to jump to parent topicSetting Up Tasks

This section discusses how to:

Click to jump to top of pageClick to jump to parent topicPages Used to Set Up Tasks

Page Name

Definition Name

Navigation

Usage

Task Registration

EODI_TSK_REG

Enterprise Components, Desktop Integration, Task Registration

Select a task to be queued up and put into the user's tasks.

Task Queue - Task

EODI_TSK_QUEUE

Enterprise Components, Desktop Integration, Task Queue, Task

Define the things that you want as defaults in the user's tasks.

Task Queue - Message

EODI_TSK_MESSAGE

Enterprise Components, Desktop Integration, Task Queue, Message

Compose the message body of tasks.

Click to jump to top of pageClick to jump to parent topicSetting Up Task Registration

Access the Task Registration page (Enterprise Components, Desktop Integration, Task Registration).

In a generic, no customization implementation, use this page to define the Authorized Users section (source ID). All other fields are prepopulated and defined here for your reference only.

A task is a way for something to be queued up and put into the user’s tasks. Oracle delivers the tasks with the application. You can customize the tasks to suit your particular user groups and business needs.

The status of tasks is updated when you log into Microsoft Outlook.

Task Process ID

Displays the prepopulated ID, which is delivered with the application and is unique across your system.

You can create new IDs as a customization.

Description

Enter a text description of the task process.

Object Owner ID

Select the application that owns the object (for example, Enterprise Components). This drop-down list box that contains values for all of the available applications.

This is not a required field.

Source

Select the source of the task. Values are:

  • Queue

    All task data is retrieved directly from the queue table. The PeopleSoft Application Layer for the particular process writes data into the queue tables. The data must be in the queue tables at the time of the request.

  • Application Class

    Task data is retrieved from the PeopleSoft Application Layer for the specific process. The process can retrieve its data from any available source within the PeopleSoft application. The data can be generated and retrieved at the time of the request.

Package Name

The name of the package that defines the PeopleSoft Application Layer for this process.

This is unique for each process. The Application Class information and data here is where you point to the code that will be called for your specific PeopleSoft Application Layer functions. This is needed only if you are modifying or adding new integrations. Applications deliver these defined for their delivered integrations.

The package name, path and class ID are specific to the registration. For delivered registrations, the fields are populated with application specific data.

When creating new registrations, these classes are defined beforehand in PeopleSoft Application Designer. This applies to all registrations.

Path

The path to the PeopleSoft Application Layer code. Enter the path where samples can be found.

Class ID

The class ID for the PeopleSoft Application Layer code. Enter a unique ID for the class.

Dynamic Displays

ID

Things that are supplied by default to the task. Select the ID of the display that you want as the default.

Authorized Users

Source

The source of the authorized users. Select from the drop-down list box. Values are:

  • User ID

  • Role Name

  • SQL User List: An SQL user object that returns a list of operator IDs.

(the blank field to the right of the Source field)

Depending on the Source that you select in the Authorized User section (User ID, Role Name, SQL User List), a corresponding list of options becomes available for selection.

Assigned Users

User ID

This is generally assigned when the task is put into the queue. You can also assign by email selection.

You do not need to create a user ID for each; you can simply use the email address. The user ID does not need to match the email or PeopleSoft user ID. You can also create generic user IDs.

On the registration screens, these are the users that are assigned by default when something is added to the queue for this registration. For the actual processing, the assigned user on the actual queue item is used.

Email address

Alternatively, you can assign the Assigned User - User ID by email selection.

Click to jump to top of pageClick to jump to parent topicSetting Up the Task Queue

Access the Task Queue - Task page (Enterprise Components, Desktop Integration, Task Queue, Task).

Use this page to monitor task integrations or manually add or update tasks for users.

Generally, you do nothing in the queue. The queue is essentially a view into the tables as data is moved back and forth. You can use the queue to manually add tasks to a user's Microsoft Outlook task list; however, that would normally be handled by an application-specific feature (through the PeopleSoft Application Layer for a process).

Task Transaction ID

The ID is generated and supplied beforehand from the System Setup page. This is a unique ID for everything that is put in the Task Queue. Enter the transaction ID for the transaction that you want.

To autonumber, leave the transaction ID as zero, and it will be updated when you save.

See Setting Up the System.

Deleted?

Select to flag for deletion.

Task Process ID

Displays the ID of the Task Process.

This is a prompt from the process ID for the registration. Select a Task Registration that you previously set up. The process ID is a 15–character, uppercase-only value. Enter the ID of the task process that you want.

Subject

Enter the task subject name.

All of the following fields correspond to the Microsoft Outlook fields that are displayed in a task. This is the information that is passed back and forth (updates in these fields are passed back and forth).

Start Date

Enter the date that you started the task or test.

Due Date

Enter the date that the task or test is due.

Task Status

Select the status or state of the task. The status is updated only when you log back in to Microsoft Outlook again. Values are:

  • Completed

  • Deferred

  • In Progress

  • Not started

    This is the default value.

  • Waiting on someone else.

Task Priority

Select the priority that is defined for the task. Values are:

  • High

  • Low

  • Normal

    This is the default value.

Percent Complete

Enter the percentage of the task that has been completed.

Reminder

Enter any information or specifics that you want to recall, for example, the date and time to remind the user about this task.

This is the reminder that you can set within Microsoft Outlook.

For example, it might be an appointment reminder that pops up and sends you an email when a meeting is about to begin.

Total Work

Outlook task field.

This is a free form field that is available in Microsoft Outlook Task.

Actual Work

Outlook task field.

This is a free form field that is available in Microsoft Outlook Task.

Mileage

Outlook task field.

This is a free form field that is available in Microsoft Outlook Task.

Billing Info

Outlook task field.

This is a free form field that is available in Microsoft Outlook Task.

Company

Outlook task field.

This is a free form field that is available in Microsoft Outlook Task.

Updated

The date that this task information was last updated.

Deleted On

The date that this task was flagged for deletion. This field remains blank until or unless the task is flagged for deletion.

Dynamic Displays

ID

Select the ID of the dynamic display. Select any number of Dynamic Display IDs for the displays that you want to automatically show alongside a user’s tasks.

Description

Displays the description of the dynamic display ID, which is automatically supplied with the ID selection.

Simulate Events

Update

You can use the Simulate Events section to trigger PeopleCode without using Microsoft Outlook. Click the Update button to update and test your process, or select Delete? to flag this process for deletion. This feature enables development to test code without Microsoft Outlook. The PeopleSoft Application Layer application classes are called for the particular process.

Click to jump to top of pageClick to jump to parent topicComposing Task Contents

Access the Task Queue - Message page (Enterprise Components, Desktop Integration, Task Queue, Message).

Use this page to further define the body of the message. This is the message body of the task that is created in Microsoft Outlook and contains any changes that are made in Microsoft Outlook.

Click to jump to parent topicRegistering Address Books

This section provides an overview of address book registration and discusses how to register your address book.

Click to jump to top of pageClick to jump to parent topicUnderstanding Address Book Registration

Address books enable you to leverage PeopleSoft data to update Outlook users' local address lists or to control the email addresses that are available within the PeopleSoft Outlook Meeting Scheduler.

Several types of address books are available that you can define. The main difference between them is where the information originates. The type of address book determines which options are available in the registration page.

Click to jump to top of pageClick to jump to parent topicPage Used to Register Your Address Book

Page Name

Definition Name

Navigation

Usage

Address Book Registration

EODI_CON_REG

Enterprise Components, Desktop Integration, Address Book Registration

Register your address book.

Click to jump to top of pageClick to jump to parent topicRegistering Your Address Book

Access the Address Book Registration page (Enterprise Components, Desktop Integration, Address Book Registration).

Use this page to register and define your available address book options.

Process ID

This ID is defined for delivered integrations.

Deleted?

Select to flag this address for deletion.

Updated

This is automatically populated with the latest update saved to this address book.

Description

Description of the address book. Enter a unique description.

Object Owner ID

The application class that owns the object (for example, Enterprise Components).

Select a value from the drop-down list box that contains all of the available applications.

This is not a required field.

Use

Specifies where the address book is used:

  • Personal Address Book: Replicated to the users' Outlook Address Book list.

  • Meeting Invitees: Only available if added to a meeting in the queue.

    The Meeting Invitees option enables two additional fields: Join EMAILID (join email identification) and Join OPRID (join operator identification).

Source

The source of the address book or contact.

Values are:

  • Application Class

  • Record/View

  • Internal

See Understanding Address Book Registration.

Record

Enter the source record. This field appears if the selected source is Record/View.

Join EMAILID

Select for Desktop Integration to automatically join the EMAILID field to the current users email address. This field appears if the selected source is Record/View.

The EMAILID field must be present on the record selected.

Join OPRID

Select for Desktop Integration to automatically join the OPRID field to the current users operator ID. This field appears if the selected source is Record/View.

The OPRID field must be present on the record selected.

Application Class

Package Name

The name of the package that defines the PeopleSoft Application Layer for this process.

This is unique for each process. The Application Class information and data here is where you point to the code that will be called for your specific PeopleSoft Application Layer functions. This is needed only if you are modifying or adding new integrations. PeopleSoft Applications deliver these defined for their delivered integrations.

The package name, path and class ID are specific to the registration. For delivered registrations, the fields are populated with application specific data.

When creating new registrations, these classes are defined beforehand in PeopleSoft Application Designer. This applies to all registrations.

Path

(Samples) Select the path where Samples can be found.

Class ID

Select a unique ID for the Class.

Authorized Users

Source

The source of the authorized user. Select from the drop-down list box.

Values are:

  • User ID

  • Role Name

  • SQL User List

You do not need to create a user ID for each; you can simply use the email address. The user ID does not need to match the email or PeopleSoft user ID. You can also create generic user IDs.

The field to the right is automatically supplied based on the source that you specify.

(the field to the right of the Source field)

Depending on the Source that you select in the Authorized User section (User ID, Role Name, SQL User List), a corresponding list of options becomes available for selection.

Click to jump to parent topicRegistering Internal Address Books

This section discusses how to register and define your internal address book.

Click to jump to top of pageClick to jump to parent topicRegistering an Internal Address Book

Access the Internal Address Book page (Enterprise Components, Desktop Integration, Internal Address Book).

Use the Internal Address Book (EODI_CON) page to register and define your available internal address book options.

Internal address books are derived from the Internal Address book page as defined within Desktop Integration. The address can be entered manually through the Internal Address Book page, or the underlying record can be updated by some other process.

Address Book Process ID

The ID is supplied as defined on the Address Book Registration page.

Internal address books are derived from the Internal Address book page as defined within Desktop Integration.

The address can be entered manually through the Internal Address Book page, or the underlying record can be updated by some other process.

Email Address

The email address of the contact.

Deleted?

Select to flag this email address or contact information for deletion.

Full Name

The full name of the person or contact.

Title

The title of the person or contact.

First Name

The first name of the person or contact.

Middle Name

The middle name of the person or contact.

Last Name

The family or sir name of the person or contact.

Suffix

The suffix for this person or contact.

Alt. Email (alternate email)

An alternate email address to the primary listed email address.

Alt. Email (alternate email)

An alternate email address to the secondary listed email address.

Company

The company where this person or contact works.

Job Title

The title of the position that this person or contact holds at the company.

Work Phone

The work phone number of this person or contact.

Home Phone

The home phone number of this person or contact.

Mobile Phone

The mobile or cell phone number of this person or contact.

Updated

This date is automatically updated with each saved revision to this address in the address book. This same date appears at the top of the page as well.

Click to jump to parent topicSetting Up Appointments

This section discusses how to:

Click to jump to top of pageClick to jump to parent topicPages Used to Set Up Appointments

Page Name

Definition Name

Navigation

Usage

Appointment Registration

EODI_APT_REG

Enterprise Components, Desktop Integration, Appointment Registration

Set up appointment registration and to define he defaults for the user's appointments, invitations, and calendar.

Appointment/Meeting Group

EODI_APT_QUEUE

Enterprise Components, Desktop Integration, Appointment Queue, Appointment/Meeting Group

Review the appointment queue, monitor integration transactions, or manually add or update meetings and appointments.

Availability

EODI_APT_TIMES

Enterprise Components, Desktop Integration, Appointment Queue, Availability

Specify the system parameters for scheduling meetings.

Meeting

EODI_APT_MEETINGS

Enterprise Components, Desktop Integration, Appointment Queue, Meeting

Specify criteria for your meeting invitations and attendees.

Click to jump to top of pageClick to jump to parent topicSetting Up Appointment Registration

Access the Appointment Registration page (Enterprise Components, Desktop Integration, Appointment Registration).

This information is supplied by the applications for delivered integrations. You define the Authorized Users section here. As with tasks, if creating custom integrations, you create data here.

Process ID

The ID is supplied beforehand for delivered integrations.

Description

Description of the process. Enter a unique description.

Appointment Type

Type of appointment. Appointments are anything on a calendar. Values are:

  • Appointment: No invites, just an item on a calendar.

  • Meeting: Single, simple.

  • Meeting Group: Schedule multiple simultaneously.

    For example, when scheduling an interview candidate, you have visibility to the entire series of interviews.

Object Owner ID

The application class that owns the object (for example, Enterprise Components).

Select a value from the drop-down list box that contains all of the available applications.

Address Book

Optionally, select a Desktop Integration address book to be available in the Outlook PeopleSoft Scheduler.

Restrict To Address Book

Select to restrict the available email address options to the address Book entered.

Package Name

The name of the package that defines the PeopleSoft Application Layer for this process. This is unique for each process.

The Application Class information and data here is where you point to the code that will be called for your specific PeopleSoft Application Layer functions. This is needed only if you are modifying or adding new integrations. PeopleSoft Applications deliver these defined for their delivered integrations.

The package name, path and class ID are specific to the registration. For delivered registrations, the fields are populated with application specific data.

When creating new registrations, these classes are defined beforehand in PeopleSoft Application Designer. This applies to all registrations.

Path

(Samples) Enter the path where Samples can be found.

Class ID

(Address Samples) Enter a unique ID for the class.

Dynamic Displays

ID

Things that are supplied by default to the appointment. Select the ID of the display that you want as the default.

Authorized Users

Source

The source of the authorized user. Select from the drop-down list box. Values are:

  • User ID

  • Role Name

  • SQL User List

    Query from a list to obtain email addresses.

You do not need to create a user ID for each; you can simply use the email address. The user ID does not need to match the email or PeopleSoft user ID. You can also create generic user IDs.

(the blank field to the right of the Source field)

Depending on the Source that you select in the Authorized User section (User ID, Role Name, SQL User List), a corresponding list of options becomes available for selection.

Assigned Users

User ID

Generally assigned when the task is put into the queue. You can also assign by email selection.

Email Address

Alternatively, you can assign this field by email selection.

Click to jump to top of pageClick to jump to parent topicReviewing the Appointment Queue

Access the Appointment Queue - Appointment/Meeting Group page (Enterprise Components, Desktop Integration, Appointment Queue).

Appointment Process ID

The appointment process associated with this appointment or meeting.

Subject

  • Appointment: The subject for the appointment in Outlook.

  • Meeting: The description displayed in the Meeting Queue in the PeopleSoft Meeting Scheduler.

Appointment Type

  • Appointment: Standard appointment.

  • Meeting: Single meeting.

  • Meeting Group: Multiple meetings to be scheduled on a single screen.

Show Time As

Status for the appointment. Values are:

  • Busy

    This is the default value.

  • Free

  • Out Of Office

  • Tentative

Start Date/Time

Start date and time for the appointment.

This is not visible for meetings.

End Date/Time

End date and time for the appointment.

This is not visible for meetings.

Address Book

The address book for the default on new meetings.

This is not available for appointments.

Restrict To Address Book

Option supplied by default onto new meetings.

Message

  • Appointments: Body of appointment.

  • Meetings: Master meeting body.

Dynamic Displays

Dynamic Displays ID

The ID of the dynamic display.

Select the ID of the display that you want as the default in the user’s tasks.

Description

The description of the dynamic display that the ID identifies.

Assigned Users

User ID

This is generally assigned when the task is put into the queue.

You can also assign by email selection.

Click to jump to top of pageClick to jump to parent topicSetting Up Meeting Scheduling Criteria

Access the Appointment Queue - Availability page (Enterprise Components, Desktop Integration, Appointment Queue, Availability).

Use this page to specify the system parameters that guide or restrict when you can schedule a meeting. This page is enabled for meetings only. The system considers meetings as a special type of appointment.

Restrict Meeting Times

When this option is enabled, meetings can be scheduled only within the meeting windows that you define.

Restrict to Single Day

When this option is enabled, all meetings in a meeting group must occur on the same day.

Meeting Windows

The start date and time, end date and time, and time zone.

Click to jump to top of pageClick to jump to parent topicSetting Up Meeting Criteria

Access the Appointment Queue - Meeting page (Enterprise Components, Desktop Integration, Appointment Queue, Meeting).

This page is enabled for meetings only.

Update

In the Simulated Events section, click the Update button to test your integration process without using Microsoft Outlook.

This process updates all meeting groups.

Delete

In the Simulated Events section, click the Delete button to test your integration process without using Microsoft Outlook.

This process deletes the current meeting.

Status

Select a value from the drop-down list box. Values are:

  • Awaiting Responses.

  • Canceled.

  • Initial - Not Visible.

    This is the default value.

  • On Hold - Do Not Schedule.

  • Queued for Canceling.

  • Queued for Scheduling.

  • Scheduled.

When you install the Microsoft Outlook Add-In program, the Status field is visible in your PeopleSoft application.

Start Date/Time

Enter the first date that you want to consider within a particular time frame or known availability.

From the drop-down list box, select the time that you want the meeting to begin.

Time Zone

The attendee’s time zone.

When you select a time zone from the drop-down list box, you are ensuring that the time you enter on your calendar appears correctly on the attendee’s invitation and calendar for his or her time zone.

End Date/Time

Enter the last date that you want to consider within a particular time frame or known availability.

From the drop-down list box, select the time that you want the meeting to end. This field is automatically populated when you specify a value in the Duration field.

Duration (Minutes)

Duration of the meeting time in minutes. This field is automatically populated when you select the beginning and ending time.

Address Book

Select from your available Desktop Integration address books.

Selecting a Desktop Integration address book enables you to make available an email address book that is sourced from the PeopleSoft application.

Restrict To Address Book

When you select this option, you can choose addresses only from the selected address book.

Subject

Enter a subject line. This can be the topic of the meeting, the call-in number, or whatever information you want.

Require Unique Invitation

Select to require a unique or custom invitation to a particular invitee or group.

This option prevents the user from sending the Master Meeting invite information in the Outlook Scheduler.

Note. Within the PeopleSoft Outlook Meeting Scheduler, the user can define a single meeting invite message for multiple meetings, individual meeting invite messages, or a combination of the two. The Master Meeting is a shared meeting invite that can be used and it’s body is supplied by default from the Message as defined on the Appointment/Meeting Group page. Each individual meeting can also have a message body that is defined on the Meeting page. This text is used if the user chooses not to use the Master Meeting invite, or if it’s use is restricted.

Use Master Meeting

Select to use the content or text specified in the Master Meeting for everyone to whom you are sending an invitation.

Send as iCal Appointment (iCalendar appointment)

Select to send to an external invitee who is using another calendaring system or application.

Deleted?

Select to flag this meeting for deletion.

Message

Enter the body of the invitation content or text into this pane for global visibility, unless otherwise specified.

The system uses this message if the meeting is not using the Master Meeting (if you did not select the Master Meeting check box).

Updated

This field is automatically populated with the date of the latest update.

Email Address

In the Participants section, enter the email address or D-list of the people you want to invite.

Email Name

Alternatively, you can enter the invitee name or group name.

Select from the list of available types and participant types:

  • Required: User must be present at meeting.

  • Optional: User can optionally attend the meeting.

  • Resource: Used for room scheduling and resources.

Response

This is the current response received from the user. Values are:

  • Accepted

  • Declined

  • Deleted

  • No Response

    The invitation has been sent but no reply has been received.

  • Not Sent

  • Proposed New Time

  • Tentative

Simulate Events

Response

In the Simulate Events section, click the Response button to simulate the event and test your process without using Microsoft Outlook.

Click to jump to parent topicSetting Up File Transfers

This section discusses how to:

Click to jump to top of pageClick to jump to parent topicPages Used to Set Up File Transfers

Page Name

Definition Name

Navigation

Usage

File Transfer Registration

EODI_XFR_REG

Enterprise Components, Desktop Integration, File Transfer

Set up file transfer registration.

File Transfer Queue

EODI_XFR

Enterprise Components, Desktop Integration, File Transfer Queue

Review what you previously defined as defaults in your file transfers.

Click to jump to top of pageClick to jump to parent topicSetting Up File Transfer Registration

Access the File Transfer Registration page (Enterprise Components, Desktop Integration, File Transfer).

File Transfer Process ID

The ID is supplied beforehand.

Description

Description of the File Process. Enter a unique description.

Object Owner ID

The application class that owns the object (for example, Enterprise Components).

Select a value from the drop-down list box that contains all of the available applications.

Package Name

The name of the package that defines the PeopleSoft Application Layer for this process. This is unique for each process.

The Application Class information and data here is where you point to the code that will be called for your specific PeopleSoft Application Layer functions. This is needed only if you are modifying or adding new integrations. PeopleSoft Applications deliver these defined for their delivered integrations.

The package name, path and class ID are specific to the registration. For delivered registrations, the fields are populated with application specific data.

When creating new registrations, these classes are defined beforehand in PeopleSoft Application Designer. This applies to all registrations.

Path

(Samples) Enter the path where Samples can be found.

Class ID

(Task Samples) Enter a unique ID for the class.

Authorized Users

Source

The source of the authorized user. Select from the drop-down list box. Values are:

  • User ID

  • Role Name

  • SQL User List

You do not need to create a user ID for each; you can simply use the email address. The user ID does not need to match the email or PeopleSoft user ID. You can also create generic user IDs.

The field to the right is automatically populated based on the source that you specify.

(the blank field to the right of the Source field)

Depending on the Source that you select in the Authorized User section (User ID, Role Name, SQL User List), a corresponding list of options becomes available for selection.

Click to jump to top of pageClick to jump to parent topicReviewing the File Transfer Queue

Access the File Transfer Queue page (Enterprise Components, Desktop Integration, File Transfer Queue).

File Transfer Transaction ID

The numeric transaction ID that the PeopleSoft system assigns when you create the file transfer.

Unique System Filename

Upon processing of the file transfer, this field updates with the unique system file name assigned by the PeopleSoft system.

File Status

Displays the current status of this file transfer. Values are:

  • Receiving File

  • Assembling File

  • Processing Application Logic

  • Processing Complete

Updated

The date that this file transfer is updated with new or edited information.

Delete Attachment

Click to delete the attached file.

View Attachment

Click to view the attached file.

Detach Attachment

Click to detach the attached file.

Click to jump to parent topicDefining Dynamic Displays

This section provides an overview of dynamic displays and discusses how to:

Click to jump to top of pageClick to jump to parent topicUnderstanding Dynamic Displays

Dynamic Displays allow the display of information from your PeopleSoft system alongside items in Microsoft Office. You can use Dynamic Displays to show any information contained within the PeopleSoft system and those displays can optionally be shown automatically alongside the Microsoft Office items. The information contained within a Dynamic Display can also be driven contextually by the current item. For example, customer information from the PeopleSoft system can be displayed alongside an inbound customer email, or contact in an address book.

Click to jump to top of pageClick to jump to parent topicPages Used to Define Dynamic Displays

Page Name

Definition Name

Navigation

Usage

Display Definition

EODI_DYN

Enterprise Components, Desktop Integration, Dynamic Display Definition, Display Definition

Define general dynamic display options.

Fields and Layout

EODI_DYN_FIELDS

Enterprise Components, Desktop Integration, Dynamic Display Definition, Fields and Layout

Define field and layout options for dynamic displays.

Click to jump to top of pageClick to jump to parent topicDefining General Dynamic Display Options

Access the Display Definition page (Enterprise Components, Desktop Integration, Dynamic Display Definition).

Dynamic Displays dynamically set up the form and format with the required action fields, and then pass the information back to the form.

Dynamic Display ID

The ID of the dynamic display is supplied as defined earlier. This must be a unique ID across your organization.

Description

The name of the dynamic display. Enter a unique name for this display.

Display Action

Select the display action. Values are:

  • Automatic: The display is automatically shown if the transaction requests.

  • On Request: The user must use the Display ribbon action item to display.

    You must use the Display ribbon action or menu item to display.

Display Position

Select the initial position of the Dynamic Display. Values are:

  • Right

  • Left

  • Top

  • Bottom

  • Floating

Display Restriction

Used to restrict the position change of the Dynamic Display. This is useful if the display layout does not function well in a particular mode.

  • None

  • No Horizontal: Display restricted to Right, Left or Floating.

  • No Vertical: Display restricted to Top, Bottom or Floating.

  • Frozen: Display cannot be moved.

Display In

Select the Microsoft Office application areas where the Dynamic Display is available. Values are:

  • Microsoft Outlook Main Page: The main frame of Microsoft Outlook; not tied to any single Microsoft Outlook item.

  • Microsoft Outlook Contact

  • Microsoft Outlook Task

  • Microsoft Outlook Appointment: Includes any appointment, including meetings.

  • Microsoft Word

  • Scheduling Assistant: The PeopleSoft Scheduling Assistant, used for PeopleSoft Enterprise meetings.

  • Microsoft Outlook Email

    When you select Microsoft Outlook Email, Email Mode becomes available for optional selection.

  • Email Mode: Controls which email modes the Dynamic Display is available in.

    Values are:

    • Read and Compose

    • Read

    • Compose

Layout Type

Controls the layout method for the Dynamic Display. Values are:

  • Automatic: Display layout is computed automatically based on the Row and Column assigned to individual controls (recommended).

  • Custom: Display layout is precisely controlled by the X and Y layout positions.

Display Width

Width of the Dynamic Display. This will be ignored for Top or Bottom Display Positions.

If a display is a LEFT or RIGHT display position, then it will always go from top to bottom of the current page (but you can control the width).

Display Height

Height of the Dynamic Display. This will be ignored for Top or Bottom Display Positions.

If a display is a TOP or BOTTOM display position, it will always go the entire width of the current page (but you can control the height).

Columns

Number of columns for the display layout.

Column Width

Width of columns for the display layout.

Rows

Number of rows for the display layout.

Row Height

Height of rows for the display layout.

Package Name

The name of the package that defines the PeopleSoft Application Layer for this process. This is unique for each process.

The Application Class information and data here is where you point to the code that will be called for your specific PeopleSoft Application Layer functions. This is needed only if you are modifying or adding new integrations. PeopleSoft Applications deliver these defined for their delivered integrations.

The package name, path and class ID are specific to the registration. For delivered registrations, the fields are populated with application specific data.

When creating new registrations, these classes are defined beforehand in PeopleSoft Application Designer. This applies to all registrations.

Path

The path of the dynamic display sample. Select the path where the dynamic display samples can be found.

Class ID

Select a unique ID for the class.

Control Record Name

Optional record name. Fields from this record name can be defined as defaults in the Fields and Layout information to quickly build a Dynamic Display.

The properties of the record fields are also used.

Authorized Users

Source

The source of the authorized user. Select from the drop-down list box. Values are:

  • User ID

  • Role Name

  • SQL User List

You do not need to create a user ID for each; you can simply use the email address. The user ID does not need to match the email or PeopleSoft user ID. You can also create generic user IDs.

The field to the right is automatically populated based on the source that you specify.

(the blank field to the right of the Source field)

Depending on the Source that you select in the Authorized User section (User ID, Role Name, SQL User List), a corresponding list of options becomes available for selection.

Click to jump to top of pageClick to jump to parent topicDefining Field and Layout Options for Dynamic Displays

Access the Fields and Layout page (Enterprise Components, Desktop Integration, Dynamic Display Definition).

Default Position

Click this button to set the default positions for the Row and Column numbers of all fields on the page. The system uses the row height and column width from the main page to calculate the X and Y position of the fields. This button is only visible when you select the Custom layout type on the Display Definition page.

See Defining General Dynamic Display Options.

Sort Fields

Click to sort the fields within the scroll by Row and Column number.

Refresh Fields

Click tto refresh all fields within the scroll with the fields from the Control record defined on the Display Definition page.

Field Name

Enter or select a unique name (must be unique within this display). All code references to the field will use this name.

Field Type

Select a value from the drop-down list box: Values are:

  • Button

  • Chart

  • Date

  • Drop-down List Box

  • Grid

  • Hyperlink

  • Number

  • Text

  • Tree

Length

Enter the length of the input data. This field is valid for Text and Number field types only.

Prompt Table

Select a prompt table record name for the text field. Only valid for Text field types.

When you select a Prompt Table record name for Text field types, a Prompt Table edit check box becomes available. This option asks Should Prompt Table be used as an edit table?

This is only valid for Text field types where a Prompt Table has been defined.

Visible

Select to define the control as visible.

Display Only

Select to define the control as visible in the display only.

Trigger Event On Field Change

Select to trigger a field change event on the server if the current field is changed.

Decimal Positions

Enter the number of decimal positions in the number. This field is valid and enabled for Number field types only.

Button Action

Select the action to be performed when the button is clicked. This field is valid and enabled for Button field types only.

Values are:

  • Capture Document Contents

  • Capture Document Selection

  • File/Document Download

  • File/Document Upload

  • Insert Into Current Document

  • None

Layout

Row Number

Enter the number of rows for automatic layout.

Instead, you can click the Default Positions button to set the default positions for the Row and Column numbers of all fields on the page. The system uses the row height and column width from the main page to calculate the X and Y position of the fields. This button is only visible when you select the Custom layout type on the Display Definition page.

Column Number

Enter the number of columns for automatic layout.

Instead, you can click the Default Positions button to set the default positions for the Row and Column numbers of all fields on the page. The system uses the row height and column width from the main page to calculate the X and Y position of the fields. This button is only visible when you select the Custom layout type on the Display Definition page.

Height

Enter the height of the control. If you leave this value as 0, the system uses the current row height as the default.

Width

Enter the height of the control.

If this is a Display Only field and you leave the value as 0, the system will display the entire item.

If this is an Input field, you must specify the display Width of the input field.

X Position

Specify the absolute position for this control. This field is only visible when you select the Custom layout type on the Display Definition page.

Y Position

Specify the absolute position for this control. This field is only visible when you select the Custom layout type on the Display Definition page.

Label Type

None, Text, RTF Short or RTF Long

Select one of these radio buttons as the label type:

  • None

  • Text: Uses the hardcoded text that is supplied.

  • RTF Short: Looks up the internal short text for the field, based on the supplied Field Label.

  • RTF Long: Looks up the internal long text for the field, based on the supplied Field Label.

RTF Long and RTF Short are only valid options if the field name provided exists as a valid field without PeopleSoft Application Designer.

Field Label ID

When you select either RTF Short or RTF Long for the label type, specify the Field Label ID.

Field Label ID is only a valid option if the field name provided exists as a valid field without PeopleSoft Application Designer.

Label Width

Specify the width reserved for the label for this item. To line up all items on a single Dynamic Display, keep this number consistent across all fields.

Text

When you select Text for the Label Type, specify the label text.

Click to jump to parent topicUsing the Display Log

This section discusses how to use the display log.

Click to jump to top of pageClick to jump to parent topicPage Used to View the Display Log

Page Name

Definition Name

Navigation

Usage

Desktop Integration Log

EODI_LOG

Enterprise Components, Desktop Integration, Display Log

View dynamic display log messages.

Click to jump to top of pageClick to jump to parent topicViewing the Display Log

Access the Desktop Integration Log page (Enterprise Components, Desktop Integration, Display Log).

The Desktop Integration Log helps you understand and troubleshoot the Desktop Integration processes. The amount of detail shown in the log is determined by the log level set in the System Setup. As Desktop Integration processes run, information is written to the log at each step.

The Desktop Integration Log enables you to select what you want to view, and then displays the details of that selection for the messages that are passed. All specified information is optional and only filters the log that is retrieved when you click the Refresh button.

Date

Select the date for which you want to view the log entries and events.

Process ID

Select the ID of the process for which you want to view the log entries and events.

Transaction ID

Enter the ID of the transaction for which you want to view the log entries and events.

Refresh

Click to refresh the log entries and events that appear.

Clear Log

Click to clear the log entries and events that appear.

Log

Date/Time

The date and time of the log entry and event.

System

The system for which the log entry and event are associated.

Process ID

The unique ID of the process.

Transaction ID

The ID of the transaction of the log entry and event.

Message

The message in the log entry and event.

Explanation

The explanation of the log entry and event.

Click to jump to parent topicUsing the PeopleSoft Outlook Menu

This section provides an overview of the PeopleSoft and Outlook integration, and discusses how to:

Click to jump to top of pageClick to jump to parent topicUnderstanding the PeopleSoft and Outlook Integration

Within Microsoft Outlook, the following two components are installed that enable all of the communication and interaction between Microsoft Outlook and the PeopleSoft system:

Click to jump to top of pageClick to jump to parent topicDefining Settings and Options

When you select Settings & Options from the PeopleSoft menu in Microsoft Outlook, the following pages are available:

Note. After the Microsoft Outlook Add-In installation completes, you must go to the Settings and Options - Servers page (PeopleSoft Outlook menu, Settings & Options, Servers) and define the server URL and functions.

The server must show the Enable check box selected to attempt connectivity. If the server was determined to be online during the last connection attempt, the Online check box is selected.

Defining the Servers Page

Access the PeopleSoft Settings and Options - Servers page (PeopleSoft Outlook menu, Settings & Options, click the Servers page).

Use the PeopleSoft Settings and Options - Servers page to define the server URL that you want to connect to and the functions that you want to assign to the server.

Define the URL and functions to assign to the server:

Enable

The server must show this check box selected to attempt connectivity.

If the server was determined to be online during the last connection attempt, the Online check box is selected.

Server URL

Enter the URL of the server that you want to connect to. This is your Integration Broker URL.

User ID

Enter your User ID.

Save User ID

Select to save your User ID in the system and avoid the need for future entry.

Password

Enter your password.

Save Password

Select to save your password in the system and avoid the need for future entry.

Account

Select an account in the form of the email address of the user. You can select from a list of multiple accounts.

The selected account drives the information from the parameters that you defined in the Outlook setup.

Features

Select the features that you want to use. Values are:

  • Scheduling

  • Dynamic Displays

  • Tasks

  • Address Books

  • Appointments

Add

Click to add a new server option.

Note. This section of the PeopleSoft Settings & Options - Servers page shows the current version of the PeopleSoft Outlook Add-In and the server that you are using.

Delete

Click to delete an existing server option.

Alternatively, you can disable a server by clearing the Enable check box.

Defining the Options Page

Access the PeopleSoft Settings & Options - Options page (PeopleSoft Outlook menu, Settings & Options, click the Options page).

Use the PeopleSoft Settings & Options - Options page to review or select your display features and frequency of updates.

Auto open display in home page

Select to automatically open the display in your Microsoft Outlook home page.

Popup New Tasks

Select to be alerted by popup messages when a new task falls into your queue.

Connection Speed

Select to specify the connection speed. Values are:

  • Auto: This is the default value.

  • Fast

  • Average

  • Slow

You can adjust your connection speed which will adjust the chunk size when sending and receiving files.

In Desktop Integration's File Transfer page, an option exists to override your connection speed.

Check for new items every

Specify the frequency of system updates in minutes. This determines how often you want to replicate the PeopleSoft system information.

If set to 0, no replication will take place.

Display Working Days Only

Select to only display working days by default in the PeopleSoft Scheduling Assistant.

Display Working Hours Only

Select to only display working hours by default in the PeopleSoft Scheduling Assistant.

Ignore Missing Free/Busy Data

Select for the system to ignore missing free/busy data.

When you select this option you avoid unnecessary clutter from unavailable data.

Reviewing the Status Log Page

Access the PeopleSoft Settings & Options - Status Log page (PeopleSoft Outlook menu, Settings & Options, click the Status Log page).

Use the PeopleSoft Settings & Options - Status Log page to review the send and receive data and any errors in the log.

If you are experiencing any issues, you can access this page and clear the log or export and save the log information. This log is only available in the current session. If you exit Microsoft Outlook, and then log back in, the log information is erased and no longer visible. This page also displays the current version of the PeopleSoft Outlook Add-In that you are using.

Click to jump to top of pageClick to jump to parent topicUsing the PeopleSoft Scheduler and Scheduling Assistant

Access the PeopleSoft Scheduler page (PeopleSoft Outlook menu, Scheduling Assistant).

Use the PeopleSoft Scheduler page and Scheduling Assistant to expand the functionality of your appointments, meetings, address books, and messages.

The PeopleSoft Scheduling Assistant helps you manage and schedule all of your PeopleSoft Enterprise meetings.

The PeopleSoft Scheduler page and Scheduling Assistant provide the following features and functionality:

Meetings Group Actions

Send

Click to send the selected meeting or group of meetings.

Cancel

Click to cancel the selected meeting or group of meetings.

Save Group

Click to save the selected meeting or group of meetings.

Add Meeting

Click to add a meeting.

Refresh

Click to refresh. This action retrieves the data from the PeopleSoft system.

If you have unsaved data the system prompts you to save now, or your data will be lost.

Selected Meeting Actions

Send Invitations

Click to send the selected invitation or group of invitations.

Cancel Meeting

Click to cancel the selected meeting or group of meetings.

Save Meeting

Click to save the selected meeting or group of meetings.

Address Book

Click to add someone from your address book to the selected meeting or group of meetings.

Check Names

Click to initiate the system to verify that your selected participants have valid email addresses.

Delete

Click to delete the selected meeting or group of meetings.

Send as iCal

Click to send the selected meeting as an iCalendar attachment.

Custom Message

Click to send a custom message, and then select Message to choose which message you want to use.

Message

Click to choose the message you want to use.

Options

Message To All Attendees

Click to send the same message to multiple people.

Display

From the drop-down list, select the features that you want to display in your Outlook homepage. Values are:

  • Meeting Queue

  • Availability Window

  • Show Working Days Only

  • Show Working Hours Only

Meeting Queue

When you look in the Meeting Queue display, you see everything that is assigned to you to be scheduled. You can click a specific meeting (line item) to display the meeting details in your Outlook homepage.

These options enable you to filter what is visible in your Meeting Queue.

Filter

Select from the available options to display in your Outlook homepage:

  • Ready to Schedule: This is the first stage; in the Meeting Queue but nothing has been done.

  • In Progress: Select to display meetings that are in progress. Invitations may have been sent, but these meetings are incomplete.

  • Scheduled Meetings: Select to display meetings that have been scheduled.

  • Past Meetings: Select to display meetings that already occurred.

  • Cancelled Meetings: Select to display meetings that were cancelled.

  • On Hold Meetings: Select to display meetings that were in the Meeting Queue, then put on hold.

  • Set Date Range: Select to specify a date range for the options you want to display.

Save All

Click to save everything selected in your Meeting Queue.

Refresh

Click to refresh your Meeting Queue.

PeopleSoft

Display

Displays Dynamic Displays for the current document.

Click to jump to top of pageClick to jump to parent topicReplicating Appointments, Meetings, Tasks and Address Books

The replication options in the PeopleSoft Outlook menu have no dialog or visual component. These items are replicated to and from PeopleSoft only. Therefore, only appointments, meetings, tasks, and address books that are also PeopleSoft items can be replicated. The menu options enable you to perform the replications manually.

Alternatively, you can set up a schedule for replication in the PeopleSoft Settings & Options pages.

See Defining Settings and Options.

Replicating Appointments and Meetings

Use the PeopleSoft Replicate Appointments/Meetings option to manually start the replication process for those items.

Replicating Tasks

Use the PeopleSoft Replicate Tasks option to manually start the replication process for those items.

Replicating Address Books

Use the PeopleSoft Replicate Address Books option to manually start the replication process for those items.