2 Configuring PeopleSoft Components

2.1.1 User Interface Items

User interface items refer to AXF buttons, links, and menus you place on a PeopleSoft page. Five of each are provided (for example, AXF_BUTTON_1 through _5). For more information and configuration examples, see "PS_AXF_COMMANDS Table".

Important Points About User Interface Items

• You must specify a PeopleSoft role (in the PS_AXF_COMMANDS Table) to grant users permission to use a specified user interface item. If a user lacks the permissions, the item is not displayed.

• A user interface item becomes active when it is positioned on a page. If AXF_BUTTON_1 is placed on multiple pages in the same PeopleSoft component, it shares the same configuration across the pages. To configure different actions for each page, use a different user interface item (for example, AXF_BUTTON_2). Note that you can reuse user interface items on different PeopleSoft components without conflicts.

2.1.2 System Events

System event components refer to pre- and post-save items you place on a PeopleSoft page that trigger a pre- or post-save system event.

• The AXF_POSTSAVE_SBP item captures SAVE_POST_CHANGE system events, which execute a configured command after a PeopleSoft component is saved.

  For example, you might configure a SaveInvoice command to be invoked during the SAVE_POST_CHANGE event, so that whenever an action inserts a new PeopleSoft transaction record, the SaveInvoice command automatically performs a save.

• The AXF_PRE_SAVE_SBP item captures SAVE_PRE_CHANGE system events, which execute a configured command before a PeopleSoft component is saved.

Important Points About System Events

• You must specify a PeopleSoft role (in the PS_AXF_COMMANDS Table) to allow a specified system event to be triggered for a user.

• System events, like user interface items, are configured at the PeopleSoft component level. However, because they are not visible to the user, they are triggered as appropriate regardless of the page on which they are placed. For example, the AXF_POST_SAVE_SBP and the AXF_PRE_SAVE_SBP items are placed on specific pages; if a Save event occurs on a page in a PeopleSoft component that is being saved, the configured command executes.

2.2.1 Importing the PeopleSoft Project

Follow these steps to import the PeopleSoft project:

1. Start the PeopleSoft Application Designer in two-tier mode.

2. From the menu, select Tools, then Copy Project, then From File. The Copy From File screen is displayed.

3. Locate the following directory:

   MW_HOME/ECM_HOME/axf/adapters/psft/

4. Select psft, the parent directory of the AXF_PS_INTEGRATION directory. The AXF_PS_INTEGRATION directory contains the project XML files, but you must select its parent directory to access them from the PeopleSoft Application Designer. The project is displayed in the lower pane of the screen.

5. Click Select, select all definition types, and click Copy. The project files begin copying.

6. After all files have copied, select Build, then Project from the menu. The Build screen is displayed.

7. Select the Create Tables and Execute SQL Now options, and click Build. You can monitor the build status as the files are imported into PeopleSoft.

8. Once done, check the PSBUILD.LOG file to verify that the project imported successfully.

9. If the log file shows tablespace 'AXF' does not exist errors, manually create a tablespace called AXF in the same database you logged into when starting the PeopleSoft Application Designer, then return to step 6 to rebuild the project.

2.2.2 Configuring Integration Broker to Communicate with AXF

Importing the AXF_PS_INTEGRATION project to PeopleSoft also imports the Integration Broker connection information. These components contain information needed to connect from PeopleSoft to the AXF Server. The following section describes how to access this information in the PeopleSoft web client and edit it to point to the AXF Server.

For the appropriate AXF Server version, follow the steps listed to configure communication between the Integration Broker and AXF:

• "Configuring Communication With a 10g AXF Server"

• "Configuring Communication With an 11g AXF Server"

After configuring communication for the appropriate AXF Server version, complete these steps:

• "Setting Up the Service Operation Routings"

• "Validating Domain Status"

• "Securing Web Services"

2.2.3 Adding the AXF_ROLE to PeopleSoft

To ensure that appropriate PeopleSoft users have access to AXF functionality, follow these steps to add the AXF_ROLE and permissions to PeopleSoft.

1. In PeopleSoft Server, open PeopleTools, then Security, then Permissions & Roles. The Permissions & Roles menu expands to show available options.

2. Click Roles. The Roles page is displayed.

3. Click the Add New Value tab.

4. Enter AXF_ROLE in the Role Name field and click Add. The Role Name field is cleared and the AXF_ROLE is added.

5. Add a description in the Description field.

6. Click the Permission Lists tab, enter AXF_PERMS in the Permission List field, and click Save.

2.2.4 Assigning Users the AXF_ROLE

After creating the AXF_ROLE in PeopleSoft, follow these steps to assign the role to all users that require access to AXF functionality.

1. In PeopleSoft Server, open PeopleTools, then Security, then User Profiles. The User Profiles menu expands to show available options.

2. Click User Profiles. The User Profiles page is displayed.

3. In the search field, specify criteria to identify the user to find, and click Search. A listing of users is displayed.

4. Click the user to which to assign the role. A detailed page of user information is displayed.

5. Click the Roles tab. A listing of roles assigned to the user is displayed.

6. Click the + (plus) sign to add a blank field, and enter AXF_ROLE in the blank field. To search for the role, click the magnifying glass icon.

7. Click Save. The user can now access AXF functionality on PeopleSoft pages.

2.2.5 Setting User Locales

To prevent issues with different locales when invoking AXF, PeopleSoft users should set the same values for their user locale preference and their browser locale.

2.4.1 Configuring AXF Logging

Use the AXF logs to isolate issues in solution configuration. By default, some AXF logging automatically occurs as part of Application Server logging. Follow these steps to configure more detailed and separate AXF logging.

1. Add a log handler to the Application Server configuration. Add the handler inside the <log_handlers> tag in the logging.xml file, at the following location:

   DOMAIN/config/fmwconfig/servers/SERVER/logging.xml

   An example location follows:

   base_domain/config/fmwconfig/servers/IPM_Server1/logging.xml

   <log_handler name='axf-handler'class='oracle.core.ojdl.logging.ODLHandlerFactory' level='ALL'>
      <property name='path' value='${domain.home}/servers/${weblogic.Name}/logs/axf.log'/>
      <property name='maxFileSize' value='5485760'/>
      <property name='maxLogSize' value='54857600'/>
      <property name='encoding' value='UTF-8'/>
   </log_handler>
   

2. Add a logger to the logging.xml file and set the level from the Log Levels (ODL Message Types) listed in Table 2-1. You can set the logging level in the XML file or using Enterprise Manager.

   <logger name='oracle.imaging.axf' level='TRACE:32' useParentHandlers='false'>
        <handler name='axf-handler'/>
        <handler name='console-handler'/>
   </logger>
   

   Note:

   Remove the console-handler tag to omit logging on the console.

   Table 2-1 Available Logging Levels

   Log Type	Description	Log Level (ODL Message Type)
   NULL	The logger inherits the log level set for its parent.	n/a
   SEVERE	Log system errors requiring attention from the system administrator.	ERROR:1
   WARNING	Log actions or conditions discovered that should be reviewed and may require action before an error occurs.	WARNING:1
   INFO	Log normal actions or events. This could be a user operation, such as login completed, or an automatic operation, such as a log file rotation.	NOTIFICATION:1
   CONFIG	Log configuration-related messages or problems.	NOTIFICATION:16
   FINE	Log trace or debug messages used for debugging or performance monitoring. Typically contains detailed event data.	TRACE:1
   FINER	Log fairly detailed trace or debug messages.	TRACE:16
   FINEST	Log highly detailed trace or debug messages.	TRACE:32

   
   

3. Restart Administration Server if it is running. The logger is displayed in Enterprise Manager. You can change the logging level at run time.

2.4.2 Configuring PeopleSoft Logging

The AXF PeopleSoft adapter uses standard apache log4j logging. Logging can be activated and managed through the log4j.properties file. This file is located in the PeopleSoft Installation Directory/class directory. Set the following options:

# A1 is set to be a ConsoleAppender which outputs to System.out. 
log4j.appender.A1=org.apache.log4j.DailyRollingFileAppender
log4j.appender.A1.File=./LOGS/PS_AXF.log

# A1 uses PatternLayout.
log4j.appender.A1.layout=org.apache.log4j.PatternLayout
log4j.appender.A1.DatePattern=.yyyy-MM-dd
log4j.appender.A1.layout.ConversionPattern=%d{DATE} [%t] %-5p %c %x - %m%n

log4j.category.com.oracle.axf=DEBUG, A1

At a minimum, define an appender with a valid file location, and the level of messages to report (see above). Valid levels include the following in order of decreasing detail, where DEBUG displays all messages and detail:

• DEBUG

• INFO

• WARN

• ERROR

• FATAL