This appendix describes the AXF, Oracle E-Business Suite, Oracle PeopleSoft, and Content Server configuration tables used for the Managed Attachments solution. It describes the GrantAccess command and the Managed Attachments URL, and provides example implementations.
This appendix covers the following topics:
Section C.1, "AXF Tables For the Managed Attachments Solution"
Section C.2, "Oracle E-Business Suite Forms Tables For the Managed Attachments Solution"
Section C.3, "Oracle E-Business Suite OAF Tables For the Managed Attachments Solution"
Section C.4, "Oracle PeopleSoft Tables For the Managed Attachments Solution"
Section C.5, "Content Server Tables For the Managed Attachments Solution"
Many of the Managed Attachments tables are automatically populated during the business application plug-in configuration (see Chapter 2 or Chapter 3) and Managed Attachments configuration (see Chapter 7). This appendix describes how to configure additional pages for Managed Attachments or to make changes to the tables if needed.
Application Extension Framework (AXF) tables define the solution, its system parameters, and the GrantAccess command used.
Note:
If modifying AXF table values in a running system, either execute Clear DB Cache from the Driver page or restart the AXF application within the Application Server for the changes to take effect.
The diagram that follows displays the AXF configuration tables used for the Managed Attachments solution and their relationships.
AXF Table | Description |
---|---|
Defines AXF solutions and general parameters for infrastructure, services, and solutions. |
|
Defines AXF commands within solutions. |
|
Defines parameters for AXF commands. |
The AXF_SOLUTIONS table defines the solutions used by AXF. It links to the AXF_COMMANDS Table through the SOLUTION_NAMESPACE column.
This table defines general attributes for use by infrastructure, services, or solutions.
Table C-3 Column Description for AXF_SOLUTION_ATTRIBUTES Table
Column | Description |
---|---|
SOLUTION_NAMESPACE |
Specifies the solution namespace that uses this parameter. |
PARAMETER_KEY |
Name of the parameter. Used when retrieving the parameter value from the database. Applicable parameters include:
|
PARAMETER_VALUE |
Value of the parameter. |
This table defines AXF commands and their java classes for the solution. Each command's parameters are configured in the AXF_SOLUTION_PARAMETERS Table.
Table C-5 Column Description for AXF_COMMANDS Table
Column | Description |
---|---|
SOLUTION_NAMESPACE |
The name of the solution, as defined in the AXF_SOLUTIONS Table. |
COMMAND_NAMESPACE |
Defines the unique name of the command within the solution. |
COMMAND_CLASS |
The fully qualified class name in which the command is defined. This class is loaded and the execute() method representing the command is executed. |
This table defines command parameters for the solution and AXF command.
Table C-7 Column Description for AXF_SOLUTION_PARAMETERS Table
Column | Description |
---|---|
SOLUTION_NAMESPACE |
Identifies the solution namespace, as defined in the AXF_SOLUTIONS Table. |
COMMAND_NAMESPACE |
Specifies the command name, as defined in the AXF_COMMANDS Table. |
CONFIGURATION_NAMESPACE |
Used to implement the command. Specify the complete package name of the implementation class. This namespace path provides the physical Java class to instantiate. The namespace also differentiates commands within the same solution namespace. |
PARAMETER_KEY |
Specifies the parameter key to use in the AXF command. Parameters include:
|
PARAMETER_VALUE |
Specifies the value of the parameter key. |
These examples define the UCM_Managed_Attachments command for the UCM_Managed_Attachments solution. Table C-8 provides an Oracle E-Business Suite example and Table C-9 provides an Oracle PeopleSoft example. Notice that the CONFIGURATION_NAMESPACE value for the AXF for BPM example shown in Table C-10 and Table C-11 replaces imaging
with ecm
, which is required for the AXF for BPM infrastructure. These values were set in Section 7.2.1.
The first row specifies the RIDC connection string that executes the AF_GRANT_ACCESS Content Server service.
The second row specifies the Managed Attachments URL that invokes the Content Server attachments framework search.
The third row specifies the Content Server administrative user who runs the AF_GRANT_ACCESS service; this user name is dynamically retrieved.
The fourth row specifies the CSF key. The username stored in the CSF is compared with the username value in the incoming request from the business application.
Fields not shown: SOLUTION_NAMESPACE=UCM_Managed_Attachments
Table C-8 Example AXF_SOLUTION_PARAMETERS Table for Oracle E-Business Suite Managed Attachments Solution (AXF for BPEL)
COMMAND_NAMESPACE | CONFIGURATION_NAMESPACE | PARAMETER_KEY | PARAMETER_VALUE |
---|---|---|---|
UCM_Managed_Attachments |
oracle.imaging.axf.commands.ucm.AfGrantAccessCommand |
RIDC_CONNECTION_STR |
|
UCM_Managed_Attachments |
oracle.imaging.axf.commands.ucm.AfGrantAccessCommand |
UCM_CONNECTION_STR |
|
UCM_Managed_Attachments |
oracle.imaging.axf.commands.ucm.AfGrantAccessCommand |
UCM_ADMIN_USER |
|
UCM_Managed_Attachments |
oracle.imaging.axf.commands.ucm.AfGrantAccessCommand |
MA_CSF_KEY |
|
Table C-9 Example AXF_SOLUTION_PARAMETERS Table for Oracle PeopleSoft Managed Attachments Solution (AXF for BPEL)
COMMAND_NAMESPACE | CONFIGURATION_NAMESPACE | PARAMETER_KEY | PARAMETER_VALUE |
---|---|---|---|
UCM_Managed_Attachments |
oracle.imaging.axf.commands.ucm.AfGrantAccessCommand |
RIDC_CONNECTION_STR |
|
UCM_Managed_Attachments |
oracle.imaging.axf.commands.ucm.AfGrantAccessCommand |
UCM_CONNECTION_STR |
|
UCM_Managed_Attachments |
oracle.imaging.axf.commands.ucm.AfGrantAccessCommand |
UCM_ADMIN_USER |
|
UCM_Managed_Attachments |
oracle.imaging.axf.commands.ucm.AfGrantAccessCommand |
MA_CSF_KEY |
|
Table C-10 Example AXF_SOLUTION_PARAMETERS Table for Oracle E-Business Suite Managed Attachments Solution (AXF for BPM)
COMMAND_NAMESPACE | CONFIGURATION_NAMESPACE | PARAMETER_KEY | PARAMETER_VALUE |
---|---|---|---|
UCM_Managed_Attachments |
oracle.ecm.axf.commands.ucm.AfGrantAccessCommand |
RIDC_CONNECTION_STR |
|
UCM_Managed_Attachments |
oracle.ecm.axf.commands.ucm.AfGrantAccessCommand |
UCM_CONNECTION_STR |
|
UCM_Managed_Attachments |
oracle.ecm.axf.commands.ucm.AfGrantAccessCommand |
UCM_ADMIN_USER |
|
UCM_Managed_Attachments |
oracle.ecm.axf.commands.ucm.AfGrantAccessCommand |
MA_CSF_KEY |
|
Table C-11 Example AXF_SOLUTION_PARAMETERS Table for Oracle PeopleSoft Managed Attachments Solution (AXF for BPM)
COMMAND_NAMESPACE | CONFIGURATION_NAMESPACE | PARAMETER_KEY | PARAMETER_VALUE |
---|---|---|---|
UCM_Managed_Attachments |
oracle.ecm.axf.commands.ucm.AfGrantAccessCommand |
RIDC_CONNECTION_STR |
|
UCM_Managed_Attachments |
oracle.ecm.axf.commands.ucm.AfGrantAccessCommand |
UCM_CONNECTION_STR |
|
UCM_Managed_Attachments |
oracle.ecm.axf.commands.ucm.AfGrantAccessCommand |
UCM_ADMIN_USER |
|
UCM_Managed_Attachments |
oracle.ecm.axf.commands.ucm.AfGrantAccessCommand |
MA_CSF_KEY |
|
Oracle E-Business Suite Forms tables define how the Managed Attachments page is activated through the Zoom menu on selected Oracle E-Business Suite forms. Each Oracle E-Business Suite form enabled for the AF integration requires an AXF Oracle E-Business Suite configuration that defines a Zoom Menu item with the label Managed Attachments and a set of parameters that include the Oracle E-Business Suite instance name, business object type, business object key(s), and user friendly description of the business object instance.
The diagram that follows displays the Oracle E-Business Suite Forms configuration tables used for the Managed Attachments solution and their relationships.
Oracle E-Business Suite Forms Tables | Description |
---|---|
Enables the AXF solution on various Oracle E-Business Suite Forms. |
|
Defines properties for AXF integration for Oracle E-Business Suite. |
|
Defines Oracle E-Business Suite form values to pass to the AfGrantAccessCommand when a user activates the Managed Attachments functionality from an Oracle E-Business Suite form. |
|
Describes the actions to take based on user activity. |
|
AXF_COMMAND_PARAMETERS Table (Oracle E-Business Suite Forms) |
Defines the information sent for the AfGrantAccess command. |
Use the AXF_CONFIGS table to enable the AXF solution on various Oracle E-Business Suite Forms. This table provides a fine level of granularity when selecting which forms to AXF-enable.
When an action occurs, the customized code launches the specified solution and command configured for the event. When configured for the Oracle E-Business Suite adapter for Content Server, this table invokes the AfGrantAccess command.
Table C-12 Column Description for AXF_CONFIGS Table
Column Name | Description |
---|---|
FORMID |
Specifies the primary key of the table. |
FORMFUNCTION |
Distinguishes each Oracle E-Business Suite Form based on the form's functionality. |
SOLUTIONENDPOINT |
Specifies a URL to AXF, and defines if using the AXF for BPM or AXF for BPEL infrastructure. If specifying for AXF for BPM, enter a 2 at the end of this column, as shown in Table C-14 This value should start as |
ENTITYNAME |
Used by the attachment functionality as a unique name, which links attachments to the correct Forms. |
LOGENABLED |
Enables or disables the log for the specified form. See Section 2.5. Specify one of the following:
|
DATABLOCKNAME |
Specify the data block on the form to enable. Note that you can also specify A Form may be reused by Oracle E-Business Suite (for example, Invoice Entry and Invoice Query); the FORMFUNCTION and DATABLOCKNAME together uniquely identify each form. |
These examples define the AfGrantAccess command in the AXF_CONFIGS table for a form. Notice that the SolutionEndpoint value for the AXF for BPM example shown in Table C-14 contains a 2
after axf-ws
, which is required for the AXF for BPM infrastructure.
Fields not shown: ENTITYNAME=(null), LOGENABLED=YES, and DATABLOCKNAME=(null)
Use the AXF_PROPERTIES table to define properties for AXF integration for Oracle E-Business Suite. You can also use its AXF_PAPERCLIP property to enable or disable the paperclip (display attached document) feature, as described in Section 7.6.15.
Table C-15 Column Description for AXF_PROPERTIES Table (Oracle E-Business Suite)
Column | Description |
---|---|
PROPNAME |
Specifies properties to use. Properties include:
|
PROPVALUE |
Specifies the property's value. |
This table relates to an Oracle E-Business Suite form's values passed to the AfGrantAccessCommand when a user activates the Managed Attachments functionality from an Oracle E-Business Suite form. The adapter looks up values for the Oracle E-Business Suite form in this table and passes them to the AfGrantAccessCommand for executing the Content Server AF_GRANT_ACCESS service and attachments framework search.
Table C-17 Column Description for AXF_FND_MAP Table
Column | Description |
---|---|
FUNCTION_NAME |
Defines the Oracle E-Business Suite Form based on its functionality. |
FORM_NAME |
Defines the name of the Oracle E-Business Suite form to enable. |
BLOCK_NAME |
Defines the data block on the form to enable. |
ENTITY_NAME |
Used by the attachment functionality as a unique name, which links attachments to the correct forms. |
Use the AXF_COMMANDS table to describe the actions to take based on user activity. This table works with the AXF_CONFIGS Table (Oracle E-Business Suite Forms).
Table C-19 Column Description for AXF_COMMANDS Table
Column Name | Description | Nullable |
---|---|---|
FORMID |
Links to the AXF_CONFIGS Table (Oracle E-Business Suite Forms). |
No |
EVENTID |
Primary key of the table. |
Yes |
EVENTNAME |
Name of the Event command to invoke (ZOOM for this adapter). |
Yes |
DISPLAYMENU |
Displays text of the menu for the command. |
Yes |
COMMANDNAMESPACE |
Request command to pass to the back-end when a user selects the menu. |
Yes |
REQUIRESCONVERSATION |
Indicates if the command requires a valid conversation or not. For this adapter, this value must be NO. |
Yes |
SORTBY |
Order in which the menu is displayed. |
Yes |
SOLUTIONNAMESPACE |
Name of the solution. |
Yes |
MENUTYPE |
Specify the menu type to display to users in Oracle E-Business Suite. ZOOM displays a Zoom menu in the toolbar. |
Yes |
SPECIAL |
Create new menu entries by entering a unique number for the Special type menu. (Not applicable for this adapter.) |
Yes |
RESPONSIBILITY |
Use this column to filter the menu options based on user responsibility. Enter a value to display the menu only to end users with responsibilities associated with that value. (Not applicable for this adapter.) |
Yes |
Use the AXF_COMMAND_PARAMETERS table to define the information sent for each defined command. Each command may require or omit a different set of parameters.
Table C-21 Column Description for AXF_COMMAND_PARAMETERS Table
Column | Description |
---|---|
PARAMETERID |
Defines a unique ID for the parameter. |
EVENTID |
Defines a unique ID for the event. Comes from the AXF_COMMANDS Table (Oracle E-Business Suite Forms). |
PARAMETERNAME |
The name of the parameter to pass, where:
|
DATASOURCENAME |
Data Source for the parameter value. You can specify Data or Constant. |
DATABLOCKNAME |
Data Block of the Form from which the value is fetched |
FIELDNAME |
Field Name in the form from which the value is fetched. |
CONSTANTVALUE |
Must be set to a value that uniquely identifies the Oracle E-Business Suite instance. |
Oracle E-Business Suite OAF tables define how the Managed Attachments page is activated through a button added via personalization to selected OAF pages, which redirects to the Managed Attachments URL in Content Server.
The diagram that follows displays the Oracle E-Business Suite OAF configuration tables used for the Managed Attachments solution and their relationships.
Oracle E-Business Suite OAF Table | Description |
---|---|
Enables the AXF solution on various Oracle E-Business Suite OAF pages. |
|
Defines properties for AXF integration for Oracle E-Business Suite. |
|
Describes the actions to take based on user activity. |
|
Defines the information sent for the AfGrantAccess command. |
Use the OAF_AXF_CONFIGS table to store the AXF endpoints for a particular OAF page. You can define multiple endpoints for the same page.
When an action occurs, the customized code launches the specified solution and command configured for the event. When configured for the Oracle E-Business Suite adapter for Content Server, this table invokes the AfGrantAccess command.
Table C-23 Column Description for OAF_AXF_CONFIGS Table
Column Name | Description |
---|---|
AXF_CONFIG_ID |
Specifies the primary key of the table. |
AXF_OAF_PAGE |
Specifies the full path name of the Oracle E-Business Suite OAF page. See Section 7.2.3.2. |
AXF_END_POINT |
Specifies a URL to the AXF endpoint to which to connect. This value should start as |
AXF_VERSION |
Specifies the AXF version of the connection, where |
This example enables the AXF solution on the specified Oracle E-Business Suite OAF pages. Notice that the first two rows show two commands for the same page, each pointing to a different endpoint. These commands should be configured to perform different operations, such as a Managed Attachments button and an Invoice Processing button. (Note that it is recommended to place only one Managed Attachments button on an OAF page.)
Field not shown: AXF_VERSION=2
Table C-24 Example OAF_AXF_CONFIGS Table
AXF_CONFIG_ID | AXF_OAF_PAGE | AXF_END_POINT |
---|---|---|
1 |
/oracle/apps/icx/por/reqmgmt/webui/ReqDetailsPG |
http://ImagingServerHostname1:Port1/axf-ws/AxfSolutionMediatorService |
2 |
/oracle/apps/icx/por/reqmgmt/webui/ReqDetailsPG |
http://ImagingServerHostname2:Port2/axf-ws/AxfSolutionMediatorService |
3 |
/oracle/apps/po/document/order/webui/OrderPG |
http://ImagingServerHostname1:Port1/axf-ws/AxfSolutionMediatorService |
4 |
/oracle/apps/pos/changeorder/webui/PosViewPOPG |
http://ImagingServerHostname1:Port1/axf-ws/AxfSolutionMediatorService |
5 |
/oracle/apps/pos/supplier/webui/QuickUpdatePG |
http://ImagingServerHostname1:Port1/axf-ws/AxfSolutionMediatorService |
6 |
/oracle/apps/pon/negotiation/creation/webui/ponDefineHdrPG |
http://ImagingServerHostname1:Port1/axf-ws/AxfSolutionMediatorService |
7 |
/oracle/apps/pon/negotiation/creation/webui/ponItemHeaderPG |
http://ImagingServerHostname1:Port1/axf-ws/AxfSolutionMediatorService |
8 |
/oracle/apps/pa/project/webui/ProjAttachmentPG |
http://ImagingServerHostname1:Port1/axf-ws/AxfSolutionMediatorService |
Use the OAF_AXF_PROPERTIES table to define properties for AXF integration for Oracle E-Business Suite OAF applications.
Table C-25 Column Description for OAF_AXF_PROPERTIES Table (Oracle E-Business Suite)
Column | Description |
---|---|
PROPNAME |
Specifies properties to use. Properties include:
|
PROPVALUE |
Specifies the property's value. |
This example table shows the default properties values.
Table C-26 Example OAF_AXF_PROPERTIES Table
PROPNAME | PROPVALUE |
---|---|
SecureMode |
OFF |
AXFWalletPath |
file:walletpath |
AXFWalletKey |
AXFWalletKey |
AXF_SOAP_POLICY |
USER_NAME_TOKEN |
AXF_SOAP_SECURITY |
TRUE |
AXF_SOAP_USER |
weblogic |
AXF_OAF_REDIRECT_PAGE_URL |
http://EBS Host : EBS Port/OA_HTML/OA.jsp?page=/oracle/apps/ak/ucm/axf/webui/RedirectToAxfPG |
This table stores the different commands configured for a particular OAF page. Each command is associated with an EVENT_ID, which refers to the ID of the button/link embedded on an OAF page via personalization (configured in Section 2.3).
Table C-27 Column Description for OAF_AXF_COMMANDS Table
Column Name | Description |
---|---|
AXF_CMDS_ID |
Specifies the primary key of the table, used to identify the unique command. |
AXF_CONFIG_ID |
Specifies the foreign key to the OAF_AXF_CONFIGS Table (Oracle E-Business Suite OAF), which associates this unique command with a particular page and component on the page. |
AXF_EVENT_ID |
Specifies the event being executed in the user interface. The AXF_EVENT_ID corresponds to the ID for the button or link added via personalization to invoke AXF functionality. Available options include:
|
AXF_SOL_NAMESPC |
Identifies the solution namespace for the command to execute. |
AXF_CMD_NAMESPC |
Identifies the command namespace for the command to execute. |
AXF_REQ_CONV |
Specifies if a conversation is required for this command before execution. |
This example shows the UCM_Managed_Attachments command defined for multiple OAF pages. Each command is associated with an EVENT_ID, which refers to the ID of the button/link embedded on an OAF page via personalization. Notice that the second row configures an Imaging (IPM) button that links to the SupplierMaintenance command of the Imaging solution; this type of configuring is described in Section 2.3.3.
Field not shown: AXF_REQ_CONV=N
Table C-28 Example OAF_AXF_COMMANDS Table
AXF_CMDS_ID | AXF_CONFIG_ID | AXF_EVENT_ID | AXF_SOL_NAMESP | AXF_CMD_NAMESPC |
---|---|---|---|---|
1 |
1 |
MAButton |
UCM_Managed_Attachments |
UCM_Managed_Attachments |
2 |
2 |
IPM_BUTTON |
SupplierMaintenance |
StartSupplierMaintenance |
3 |
3 |
MAButton |
UCM_Managed_Attachments |
UCM_Managed_Attachments |
4 |
4 |
MAButton |
UCM_Managed_Attachments |
UCM_Managed_Attachments |
5 |
5 |
MAButton |
UCM_Managed_Attachments |
UCM_Managed_Attachments |
6 |
6 |
MAButton |
UCM_Managed_Attachments |
UCM_Managed_Attachments |
7 |
7 |
MAButton |
UCM_Managed_Attachments |
UCM_Managed_Attachments |
8 |
8 |
MAButton |
UCM_Managed_Attachments |
UCM_Managed_Attachments |
Each command is associated with different parameters that are required for the SOAP call. The parameters can be constant values or they can refer to the view attribute name. The attributes values can be obtained from the view object from the page context.
Table C-29 Column Description for OAF_AXF_CMD_PARAMS Table
Column | Description |
---|---|
AXF_CMD_PARAMS_ID |
Specifies the primary key of the table. |
AXF_CMDS_ID |
Specifies the foreign key to the OAF_AXF_COMMANDS Table (Oracle E-Business Suite OAF), which associates the unique parameter with a specific command. |
AXF_PARAM_NAME |
Defines the parameter name, where:
|
AXF_DATASOURCE |
Specifies where the parameter value is retrieved.
|
AXF_VIEW_OBJ_NAME |
Specifies the OAF ViewObject name, which is used to obtain the command parameter values at runtime. See Section 7.2.3.2. |
AXF_ATTRIBUTE_NAME |
Used when the AXF_DATASOURCE is set to DATA. This attribute name retrieves the actual runtime value from the view object in the controller class. |
AXF_CONSTANT_VALUE |
Used as the constant value when AXF_DATASOURCE is set to CONSTANT. |
The OAF_AXF_CMD_PARAMS example that follows displays fields configured for the AfGrantAccess command for multiple OAF pages whose key values you identified in Section 7.2.3.2.
Table C-30 Example OAF_AXF_CMD_PARAMS Table
AXF_CMD_PARAMS_ID | AXF_CMDS_ID | AXF_PARAM_NAME | AXF_DATASOURCE | AXF_VIEW_OBJ_NAME | AXF_ATTRIBUTE_NAME | AXF_CONSTANT_VALUE |
---|---|---|---|---|---|---|
1 |
1 |
application |
CONSTANT |
EBS_instanceA |
||
2 |
1 |
businessObjectType |
CONSTANT |
REQ_HEADERS |
||
3 |
1 |
businessObjectKey1 |
CONSTANT |
REQUISITION_HEADER_ID |
||
4 |
1 |
businessObjectValue1 |
DATA |
ReqHeaderVO |
RequisitionHeaderId |
|
5 |
1 |
labelValue1 |
DATA |
ReqHeaderVO |
PreparerName |
|
6 |
1 |
labelValue2 |
DATA |
ReqHeaderVO |
ReqNum |
|
7 |
1 |
businessObjectContext |
CONSTANT |
ScanContext |
||
8 |
3 |
application |
CONSTANT |
EBS_instanceA |
||
9 |
3 |
businessObjectType |
CONSTANT |
PO_HEADERS_MERGE_V |
||
10 |
3 |
businessObjectKey1 |
CONSTANT |
PO_HEADER_ID |
||
11 |
3 |
businessObjectValue1 |
DATA |
POHeaderMergeVO |
POHeaderId |
|
12 |
4 |
application |
CONSTANT |
EBS_instanceA |
||
13 |
4 |
businessObjectType |
CONSTANT |
PO_HEADERS |
||
14 |
4 |
businessObjectKey1 |
CONSTANT |
PO_HEADER_ID |
||
15 |
4 |
businessObjectValue1 |
DATA |
PosViewHeadersVO |
PO_HEADER_ID |
|
16 |
5 |
application |
CONSTANT |
EBS_instanceA |
||
17 |
5 |
businessObjectType |
CONSTANT |
PO_VENDORS |
||
18 |
5 |
businessObjectKey1 |
CONSTANT |
VENDOR_ID |
||
19 |
5 |
businessObjectValue1 |
DATA |
SupplierVO |
VendorID |
|
20 |
6 |
application |
CONSTANT |
EBS_instanceA |
||
21 |
6 |
businessObjectType |
CONSTANT |
PON_AUCTION_HEADERS_ALL |
||
22 |
6 |
businessObjectKey1 |
CONSTANT |
AUCTION_HEADER_ID |
||
23 |
6 |
businessObjectValue1 |
DATA |
AuctionHeadersAllVO |
AuctionHeaderId |
|
24 |
7 |
application |
CONSTANT |
EBS_instanceA |
||
25 |
7 |
businessObjectType |
CONSTANT |
PON_AUCTION_ITEM_PRICES_ALL |
||
26 |
7 |
businessObjectKey1 |
CONSTANT |
AUCTION_HEADER_ID |
||
27 |
7 |
businessObjectValue1 |
DATA |
ActionItemPricesAllVO |
AuctionHeaderId |
|
28 |
7 |
businessObjectKey2 |
CONSTANT |
LINE_NUMBER |
||
29 |
7 |
businessObjectValue2 |
DATA |
AuctionItemPricesAllVO |
LineNumbers |
|
30 |
8 |
application |
CONSTANT |
EBS_instanceA |
||
31 |
8 |
businessObjectType |
CONSTANT |
PA_PROJECTS |
||
32 |
8 |
businessObjectKey1 |
CONSTANT |
PROJECT_ID |
||
33 |
8 |
businessObjectValue1 |
DATA |
ProjAttachmentsVO |
PROJECT_ID |
Oracle PeopleSoft tables define how the Managed Attachments page is activated through a button, link, or menu on selected Oracle PeopleSoft pages.
Configuring AXF for Oracle PeopleSoft requires configuring these AXF-related tables in Oracle PeopleSoft:
The following diagram shows how the tables used by the Oracle PeopleSoft system in AXF solutions are related.
Note:
All AXF table fields require non-null values. You can include a space for fields that do not apply.
Use the PS_AXF_CONFIG table to enable the AXF solution on various Oracle PeopleSoft components. This table provides a fine level of granularity when selecting which pages and components to AXF-enable.
Events are automatically invoked when an action is performed on an Oracle PeopleSoft page. The AXF_PS_Integration project component catches PRE- and POST- save events and makes them available for customization. You can decide which events to use and how and when to use them.
Table C-31 Column Description for PS_AXF_CONFIG Table
Column | Description |
---|---|
AXF_CONFIG_ID |
Specifies the primary key of the table. |
AXF_COMPONENT_NAME |
Specifies the name of the Oracle PeopleSoft component being enabled. |
AXF_CONNECT_NAME |
Specifies the Oracle PeopleSoft Integration Broker Connection name (service operation to call), as defined in the Oracle PeopleSoft Integration Broker administration interface. The default service operation is AXF_EXECUTE. You can set up and use other connections. |
AXF_VERSION |
Specifies the AXF version of the connection. This value should be set to |
Use the PS_AXF_COMMANDS table to describe the actions to take based on user activity. This table works with the PS_AXF_CONFIG Table.
Table C-33 Column Description for PS_AXF_COMMANDS Table
Column | Description |
---|---|
AXF_CMDS_ID |
Specifies the primary key of the table, used to identify the unique command. |
AXF_CONFIG_ID |
Specifies the foreign key to the PS_AXF_CONFIG Table, which associates this unique command with a particular page and component. |
AXF_EVENT_NAME |
Specifies the event being executed. The AXF_EVENT_NAME corresponds to the subpage incorporated into an existing Oracle PeopleSoft page, such as a button, link, or menu added to an Oracle PeopleSoft page to invoke AXF functionality such as the Image Viewer or Task List. Available options include:
|
AXF_SELECT_LABEL |
Represents the label that for display if using a drop-down component (for example, AXF_COMBO_1). |
AXF_DISPLAY_NAME |
Defines the name of the button or link to display on the Oracle PeopleSoft page. |
AXF_SOL_NAMESPC |
Identifies the solution namespace for the command to execute. |
AXF_CMD_NAMESPC |
Identifies the command namespace for the command to execute. |
AXF_PSFT_ROLE |
Identifies the Oracle PeopleSoft roles with access to the command. Include roles in a comma-delimited list with each role enclosed in single quotes (for example, 'Role1','Role2','Role3') |
AXF_SORT_ORDER |
Specifies the order of items displayed in a selection field. Sort order applies to selection fields only. |
AXF_REQ_CONV |
Specifies if a conversation is required for this command before execution. For example, execution of the UpdateTask command requires a conversation be running in order for the user to select a current task. |
This example shows the UCM_Managed_Attachments command added as a link to an Oracle PeopleSoft page.
You must specify an Oracle PeopleSoft Role in the AXF_PSFT_ROLE field to give permissions to use the commands. If a person does not have proper permissions to use the commands, the commands do not display. If the commands display but do not function, this indicates that the commands are not configured properly.
Table C-34 Example PS_AXF_COMMANDS Table
AXF_CMDS_ID | AXF_CONFIG_ID | AXF_EVENT_NAME | AXF_SELECT_LABEL | AXF_DISPLAY_NAME | AXF_SOL_NAMESPC | AXF_CMD_NAMESPC | AXF_PSFT_ROLE | AXF_SORT_ORDER | AXF_REQ_CONV |
---|---|---|---|---|---|---|---|---|---|
101 |
101 |
AXF_LINK_1 |
(null) |
Managed Attachments |
UCM_Managed_Attachments |
UCM_Managed_Attachments |
'Employee' |
1 |
N |
102 |
102 |
AXF_LINK_1 |
(null) |
Managed Attachments |
UCM_Managed_Attachments |
UCM_Managed_Attachments |
'Employee' |
1 |
N |
103 |
103 |
AXF_LINK_1 |
(null) |
Managed Attachments |
UCM_Managed_Attachments |
UCM_Managed_Attachments |
'Employee' |
1 |
N |
Use the PS_AXF_COMMAND_PARAMS table to specify the information sent for each defined command. Each command may require or omit a different set of parameters.
Use the PS_AXF_CMD_PARAMS Table to configure a label for the list of attachments. You can use a combination of constant and data values to display key information. Similar to configuring labels, you can also add rows to pass in extra metadata values, as described in Section 7.6.16.
Table C-35 Column Description for PS_AXF_CMD_PARAMS Table
Column | Description |
---|---|
AXF_CMD_PARAM_ID |
Specifies the primary key of the table. |
AXF_CMD_ID |
Specifies the foreign key to the PS_AXF_COMMANDS Table, which associates the unique parameter with a specific command. |
AXF_PARAM_NAME |
Defines the parameter name, where:
|
AXF_DATASOURCE |
Specifies where the parameter value is retrieved.
|
AXF_RECORD_NAME |
Identifies the record of the field in the Oracle PeopleSoft page to use as the target value to retrieve when AXF_DATASOURCE is set to DATA. |
AXF_FIELD_NAME |
Used as the constant value when AXF_DATASOURCE is set to DATA. |
AXF_CONSTANT_VALUE |
Used as the constant value when AXF_DATASOURCE is set to CONSTANT. |
This example shows the information sent for the UCM_Managed_Attachments command, including its application and business object type.
The labelValue entries are configured to display key labels/values for the attachment. For example, the labelValues configuration in this table might display the following for work orders on the Managed Attachments page:
[Business Unit], [US001], [Work Order], [123456]
Table C-36 Example PS_AXF_CMD_PARAMS Table
AXF_CMD_PARAM_ID | AXF_CMD_ID | AXF_PARAM_NAME | AXF_DATASOURCE | AXF_RECORD_NAME | AXF_FIELD_NAME | AXF_CONSTANT_VALUE |
---|---|---|---|---|---|---|
101 |
101 |
application |
CONSTANT |
PSFT_INSTANCE_A |
||
102 |
101 |
businessObjectType |
CONSTANT |
WM_WO_HDR |
||
103 |
101 |
businessObjectKey1 |
CONSTANT |
BUSINESS_UNIT |
||
104 |
101 |
businessObjectValue1 |
DATA |
WM_WO_HDR |
BUSINESS_UNIT |
|
105 |
101 |
businessObjectKey2 |
CONSTANT |
WO_ID |
||
106 |
101 |
businessObjectValue2 |
DATA |
WM_WO_HDR |
WO_ID |
|
107 |
101 |
labelValue1 |
CONSTANT |
Business Unit |
||
108 |
101 |
labelValue2 |
DATA |
WM_WO_HDR |
BUSINESS_UNIT |
|
109 |
101 |
labelValue3 |
CONSTANT |
Work Order |
||
110 |
101 |
labelValue4 |
DATA |
WM_WO_HDR |
WO_ID |
|
111 |
101 |
businessObjectContext |
CONSTANT |
ScanContext |
||
112 |
102 |
application |
CONSTANT |
PSFT_INSTANCE_A |
||
113 |
102 |
businessObjectType |
CONSTANT |
CA_CONTR_HDR |
||
114 |
102 |
businessObjectKey1 |
CONSTANT |
BUSINESS_UNIT |
||
115 |
102 |
businessObjectValue1 |
DATA |
CA_CONTR_HDR |
BUSINESS_UNIT |
|
116 |
102 |
businessObjectKey2 |
CONSTANT |
CONTRACT_NUM |
||
117 |
102 |
businessObjectValue2 |
DATA |
CA_CONTR_HDR |
CONTRACT_NUM |
|
118 |
102 |
labelValue1 |
CONSTANT |
Business Unit |
||
119 |
102 |
labelValue2 |
DATA |
CA_CONTR_HDR |
BUSINESS_UNIT |
|
120 |
102 |
labelValue3 |
CONSTANT |
Contract Number |
||
121 |
102 |
labelValue4 |
DATA |
CA_CONTR_HDR |
CONTRACT_NUM |
|
122 |
103 |
application |
CONSTANT |
PSFT_INSTANCE_A |
||
123 |
103 |
businessObjectType |
CONSTANT |
REQ_HDR |
||
124 |
103 |
businessObjectKey1 |
CONSTANT |
BUSINESS_UNIT |
||
125 |
103 |
businessObjectValue1 |
DATA |
REQ_HDR |
BUSINESS_UNIT |
|
126 |
103 |
businessObjectKey2 |
CONSTANT |
REQ_ID |
||
127 |
103 |
businessObjectValue2 |
DATA |
REQ_HDR |
REQ_ID |
|
128 |
103 |
labelValue1 |
CONSTANT |
Business Unit |
||
129 |
103 |
labelValue2 |
DATA |
REQ_HDR |
BUSINESS_UNIT |
|
130 |
103 |
labelValue3 |
CONSTANT |
Requisition |
||
131 |
103 |
labelValue4 |
DATA |
REQ_HDR |
REQ_ID |
Use the PS_AXF_PROPERTIES table to define properties for AXF integration with Oracle PeopleSoft. See Section 7.6.17.
Table C-37 Column Description for PS_AXF_PROPERTIES Table
Column | Description |
---|---|
AXF_PROPNAME |
Specifies properties to use. Properties include:
|
AXF_PROPVALUE |
Specifies the property's value. |
Content Server tables define how Content Server documents are mapped to Oracle E-Business Suite or Oracle PeopleSoft business objects and how users are temporarily granted access to documents associated with a particular business object.
The adapter utilizes the following additional database tables:
These tables are automatically populated at run-time. AFGrants is initially populated when the user accesses Content Server from the business application and the AF_GRANT_ACCESS service is run. AFObjects is populated when the user checks in a document to Content Server from the Managed Attachments page.
This table stores the grants given to users, allowing them to temporarily access documents associated with a particular business object.
Table C-39 Column Description for AFGrants Table
Columns | Description |
---|---|
dUserName |
Stores the name of the user. |
dAFApplication |
Stores the business application's instance name (for example, PSFT_Instance1). |
dAFBusinessObject |
Stores the business application's object |
dAFBusinessObjectType |
Stores the business application's object type |
dPrivilege |
Stores the privilege to grant to the user: R (read), W (write), D (delete), or A (admin). This parameter is optional. If not specified, the access level specified for the AppAdapterGrantPrivilege configuration variable is used, as described in Section 7.5. |
dExpirationDate |
Stores the date and time at which to expire this grant. |
dMaxExpiration |
Stores the time at which the maximum access period (in hours) expires. |
This table maps Content Server documents to AF business objects, in an N-to-N relationship, which enables multiple content items to be associated with a single business object and multiple business objects to contain the same content item.
Each time a user attaches or detaches a document, a record is added or updated in this table.
Table C-40 Column Description for AFObjects Table
Column | Description |
---|---|
dAFID |
Stores the unique ID of each attachment. |
dAFApplication |
Stores the business application's instance name (for example, PSFT_Instance or EBS_Instance). |
dAFBusinessObjectType |
Stores the business application's object type (for example, CallRecords or HRMS). |
dAFBusinessObject |
Stores the business object's ID in the business application instance. |
dDocName |
Stores a content item's ID associated with the business object. |
DID |
Stores the ID of the document associated with the business entity. In revision-specific attachments mode, this ID is used in returning a specific version of the document. For more information, see Section 7.6.11. |
This table stores relationship attributes associated with an attachment. For more information, see Section 7.6.10. Depending on the configuration of relationship attributes, a document can have zero or more relationship attributes.
This table stores individual key values for later reference.
The business applications support up to five primary key/value combinations, which can be used instead of dAFBusinessObject to represent a business entity. In a Managed Attachments solution, these keys are mapped to dAFBusinessObject by concatenating the PK_Value fields separated by a | (pipe) character. The original PK_Key and PK_Values are logged to the AFKeys table before performing the mapping operation.
Table C-42 Column Description for AFKeys Table
Columns | Description |
---|---|
dAFApplication |
Stores the business application's instance name. |
dAFBusinessObjectType |
Stores the business application's object type. |
dAFBusinessObject |
Stores the business object's ID in the business application instance. |
PK1_Key ... PK5_Key |
Stores up to five key/value combinations. |
PK1_Value ... PK5_Value |
Stores up to five key/value combinations. |