Oracle® Hyperion Financial Close
Management
Release 11.1.2.2.300
Integration Guide
Table of Contents
Introduction .................................................................................................................................................. 1
Overview ................................................................................................................................................... 1
Terminology .............................................................................................................................................. 1
Integration Concepts..................................................................................................................................... 2
Integration Types ...................................................................................................................................... 2
Integration Steps ....................................................................................................................................... 3
Applications............................................................................................................................................... 5
Integration Type Parameters .................................................................................................................... 5
Parameter Attributes ............................................................................................................................ 6
Parameter Types ................................................................................................................................... 7
Dynamic List Parameter Type ............................................................................................................... 7
Document Navigator Parameter Type .................................................................................................. 8
Output Parameter Attributes................................................................................................................ 9
Output Parameter Types....................................................................................................................... 9
Task Execution Detail .............................................................................................................................. 10
Task Execution Endpoints ................................................................................................................... 10
Web Services Supported by System Automated Task ........................................................................ 11
Task Security ....................................................................................................................................... 13
Task Response Handling ......................................................................................................................... 15
System Automated Task Response XSD .............................................................................................. 15
Dynamic List Parameter Type Response XSD...................................................................................... 17
Document Navigator Parameter Type Response XSD ........................................................................ 18
Event Monitoring XSD and XSL ............................................................................................................... 20
Event Monitoring Internal Event XSD ................................................................................................. 20
Event Monitoring XSL Transformation:............................................................................................... 23
Creating Integrations .................................................................................................................................. 26
Creating Integrations using the Integration XML Document .................................................................. 26
Integration Type XML Schema ............................................................................................................ 26
Integration XML Elements and Attributes .......................................................................................... 31
Loading the Integration Type XML ...................................................................................................... 36
Creating Integrations with the Financial Close Management User Interface......................................... 36
Sample Integration XML.............................................................................................................................. 37
Financial Close Management 11.1.2.2.300 Enhancements ........................................................................ 49
Support for Multiple Types of Web Services for System Automated Integration Type ..................... 49
Support for Multiple Steps in a single System Automated Integration Type ..................................... 49
Support for Output Parameters for System Automated Integration Type ......................................... 49
Generate XSD Button for System Automated Integration Type ......................................................... 49
Support for Complex Parameter Types for System Automated Integration Type ............................. 49
Introduction
Overview
Oracle® Hyperion Financial Close Management provides a flexible integration framework that allows an
end user to leverage services from external applications as part of the close calendar. The integration
framework is built around industry standards and supports Web-based interactive tasks; Web service
based automated tasks and monitor external system Events tasks.
The Financial Close Management integration framework supports the following:
Integration of third party end user tasks into the close calendar
Integration of third party system automated tasks into the close calendar
Monitoring of external systems events in the close calendar
Interactive task parameter gathering and usage for integrated tasks
Task parameter dependencies
Runtime retrieval and listing for task parameter values from third party systems
Asynchronous handling of system automated tasks
Standardized Web Services security (WS-Security)
Runtime creation and editing of task integrations
Terminology
Task
Integration Type
Task Type
The Task is the core unit in the close calendar. For example, a task
could be a data load, data entry, a meeting, or a simple notification.
An Integration Type is a reusable definition that describes an action
and set of parameters that will be used to call an external
application’s service or interface or monitor an event. The user can
create their own Integration Types that integrate with their own
proprietary systems.
Task Types are templates that the user will use to create tasks. Each
Task Type has a name, description and optionally, an Integration Type
associated with it. The user can specify instructions, questions,
attributes, and parameter values that will be defaulted to any task
created from this particular template. All tasks must be associated
with a Task Type.
1
Integration Concepts
To integrate an external application service or an event within the Financial Close Management
calendar, three basic steps are required:
1. Define the service or event to be integrated as an Integration Type in Financial Close
Management.
2. Create a Task Type that wraps the integration for usage in the close calendar.
3. Add a Task based on the Task Type to the close calendar.
External Web Service
or Web Application
or External System
Integration Type
Task Type
Created by Application Owner
Task
Created by Financial Close Administrator
The owner of the application being integrated creates the Integration Types for the Financial Close
Management integration. The Integration Type is the only place where knowledge of the external
application service is required.
The Task Type and Tasks are not directly related to the external application service definition. The Task
Type and Tasks are specific Financial Close Management concepts and those elements should be created
by the Financial Close administrator (or another Financial Close user with the required permissions).
Integration Types
There are three types of tasks that can be integrated within the close calendar:
End User Tasks–A task that requires the user to interact with a user interface to complete the
task. Examples of this type of a task would be data entry, and journals updates. To integrate an
end user task with Financial Close Management, the task must be exposed as a directly callable
Web application URL endpoint.
System Automated Tasks–A task that runs in the background without any user interaction
required.
Event Monitoring Tasks–A task that a user can use to monitor a particular event that happened
on an external system. To monitor events of external system, that system must support events
publishing to external world. A user can monitor the events of EBS system and any other system
which uses JMS mechanism to publish events.
For each end user, system automated or event monitoring task to be used in the Financial Close
calendar, an Integration Type must be created within Financial Close Management. An Integration Type
is the definition of the third party service or event and should include the following properties:
2
Execution Type–Defines the type of integration, end user, system automated or event
monitoring.
Application–Defines the application that the integration type belongs to. Applications are logical
groupings of integration types. For example, you will have an HFM (Hyperion Financial
Management) application defined for all the integration types that interface with the HFM
product.
Task Parameters–Defines the parameters needed to invoke the end user task or monitor an
external system event task. For example, if the integrated end user URL will run a report, the
user may need to specify which report to run. The values for these parameters may be defined
in an associated Task Type or may be collected at run time when a Task is added to the close
calendar.
Execution Detail–When a Task is actually run by the close calendar, Financial Close Management
uses the execution information to invoke the task. For end user tasks, the execution detail
includes the URL needed to invoke the third party Web module. For event monitoring task,
there is no invocation from Financial Close Management, only listens to the external events, the
execution details include the Event Name.
Integration Steps
Financial Close Management Release 11.1.2.2.300 introduces this new concept for a system automated
Integration Type. The system automated integration type consists of multiple web service calls of
different types to achieve the required business logic. Each such web service invocation will be defined
as a step.
3
Task Starts
Step 1: Invoke
Synchronous
webservice
Update results.
Store output
parameter values
Was process
successful?
No
Stop process,
mark task as Error
No
Mark task as Error
Yes
Step 2: Invoke
Asynchronous
webservice with
output parameter
value
Wait for
response
Reponse received
Update results
Was process
successful?
Mark task as
Success. Start
successor tasks
Yes
An Integration Step for a system automated integration type is the definition of the third party service
and should include the following properties:
System Automated Type–Defines the type of web service invocation viz. synchronous, polling or
asynchronous.
Task Parameters–Defines the parameters needed to invoke the system automated task. For
example, if the integrated service will run a report, the user may need to specify which report to
run. The values for these parameters may be defined in an associated Task Type or may be
collected at run time when a Task is added to the close calendar. Financial Close Management
Release 11.1.2.2.300 now supports Output Parameters for a system automated Integration Type
Execution Detail–When a Task is actually run by the close calendar, Financial Close Management
uses the execution information to invoke the task. For system automated tasks, the execution
detail includes the Web service endpoint needed to invoke the service.
4
Response Detail–When a system automated task is finished, the integrated service may respond
with information indicating success or failure and detail on the task execution. The Integration
Type should include the information needed to process the response.
Applications
An Application defines a set of integration types that are all related somehow. Most commonly, it will
denote integration types that all interface with the same application. For example, you will have an HFM
application for all HFM integration types, and an FR application for all Financial Reporting integration
types.
Additionally, you can specify certain properties in an application that will apply to all integration types of
that application:
Request Security Policy–The security policy that should be applied when making a Web service
request. Web service requests happen when Financial Close Management queries a Web service
belonging to a dynamic list parameter or a document navigator parameter, or when Financial
Close Management executes the Web service of a system automated task. If this field is
omitted, Financial Close Management uses the policy
‘oracle/wss11_saml_token_with_message_protection_client_policy’ by default
Response Security Policy–The security policy that should be used when a system automated
task’s Web service calls back to Financial Close Management when the task has completed
executing. If this field is omitted, Financial Close Management uses the policy
‘oracle/wss11_saml_or_username_token_with_message_protection_service_policy’ by default.
Keystore Recipient Alias–Some security setups require this value to be passed as well as part of
the security handshake.
Registry Web Application Entry–EPM applications store information about themselves in
Workspace’s HIT registry. This field states the name of the registry entry storing information
related to end user endpoints for the application’s integration types. The URL tokens
$PROTOCOL$, $SERVER$, $PORT$ and $CONTEXT$ will be pulled from the registry using this
registry key.
Registry Web Service Entry–This field stores the name of the registry entry storing information
related to Web service endpoints. The WSDL URL tokens $PROTOCOL$, $SERVER$, $PORT$ and
$CONTEXT$ will be pulled from the registry using this registry key.
Application Tokens–The application can contain tokens, which are name-value pairs. Anytime
Financial Close Management sees a $<NAME>$ token in any end user or WSDL URL, it will
substitute their value of the application token into the URL. The primary use of an application
token is to substitute common fields in URL’s and control them at the application level. For
instance, the server name which all of the application’s integration types points would be a
token in all the URLs, and can easily be controlled at the application level.
Integration Type Parameters
The parameters of an Integration Type represent the values that must be sent to the service provider
when Financial Close Management invokes the service or incase of event monitoring used to filter out
5
the tasks which are waiting for that particular event. For system automated tasks, the parameter values
will be sent as part of the SOAP message. For end user tasks, the parameter values will be sent as query
parameters on the URL used to display the third party Web module. For event monitoring tasks, the
parameter is used to filter out the tasks those are waiting for that particular event.
Financial Close Management Release 11.1.2.2.300 now supports output parameters for System
Automated integration type
Parameter Attributes
Each parameter defined for an Integration Type will have the following attributes:
Parameter Name–The display name of the parameter. The parameter name will be displayed
next to the parameter when the Integration Type is used to create a Task in Financial Close
Management. This value can be localized.
Parameter Code–The internal name used for the parameter. This value will be used to generate
the service request or URL when the task is processed. For example, the URL that is built for end
user tasks will include a code=value pair for each parameter. The value for a parameter code
must be alpha-numeric.
Required Flag–This flag indicates whether or not a parameter value is required to execute the
task.
Parameter Order–A numeric value indicating the order to display the parameters in the
Financial Close Management user interface.
Tooltip–Descriptive text about the parameter and its usage. This value will be displayed if the
user hovers over the parameter in the Financial Close Management user interface. This value
can be localized.
Dependencies–A list of parameters that this parameter is dependent on. If a parameter is
dependent on another parameter (its parent), the parameter will be disabled in the Financial
Close Management user interface until the parent parameter has a value. The order attribute on
a dependant parameter must be greater than the order of its parent. Only dynamic parameters
can contain dependencies.
Default Value–Text and numeric parameter types allow a default value. The default value will be
automatically set for a parameter when a task is created, but be editable if the user wishes to
change it. Changing the default value in the integration type will have no effect on the
parameter values of tasks that already have been created.
Hidden–Text, numeric and task information parameter types can be marked as hidden, meaning
they will not appear in the Parameters tab in the task, and the end user cannot set or modify the
value. In the case of text and numeric parameter types, the default value should be specified if
the parameter is marked as hidden.
Exclude from Webservice–Specifies that a parameter should not be passed to the execution end
point for system automated tasks only. This would be used if you had a setup where parameter
B is dependent on parameter A, but the execution endpoint only accepts parameter B’s value in
its Webservice.
6
Parameter Types
In addition to the above attributes, Financial Close Management needs to know the types of parameters
being used. The following parameter types are understood by Financial Close Management:
Text–This type is used for a free form text value. When creating a parameter of this type, the
maximum field length and maximum number of text rows can be specified.
Number / Integer–This type is used for a basic numeric value. When creating a parameter of
this type, the lower and upper bounds of the number can be specified.
Date–This type is used for a date value. When creating a parameter of this type, a date range
(lower and upper bounds) can be specified. In the Financial Close Management user interface,
the end user will have the ability to use a date picker control.
Checkbox–This type is used for a Boolean value. In the Financial Close Management user
interface, this will be displayed as a checkbox control.
Static List–This type is used for a pre-defined set of text values. The end user will be able to
choose from the set of values in the Financial Close Management user interface.
Dynamic List–This type is used for a dynamic set of text values. The list of valid values is
determined at runtime by Financial Close Management. See the Dynamic List Parameter Type
section for more information.
Options Group–This type is used for a pre-defined set of values. The end user will be able to
choose multiple values from the set in the Financial Close Management user interface.
Document Navigator–This type is used for a hierarchical set of values (i.e. folders and
documents). The hierarchy of valid values is determined at runtime by Financial Close
Management. See the Document Navigator Type section for more information.
Task Information–This type is used to store attributes of the task definition in a parameter.
Possible attributes include the task name, the task ID, the specified start and end dates, the
specified duration, the owner and assignee ID’s and the schedule name of the task.
Dynamic List Parameter Type
In Financial Close Management, a dynamic parameter type is a parameter whose valid values can be
determined at runtime. The Dynamic List Parameter type represents a flat set of values that has an
associated Web service on the integrated application to provide the valid list of values.
For example, suppose a task requires the name of a report and the list of valid reports can be retrieved
from the integrated application by calling a Web service. If the report name parameter is defined as a
Dynamic List, Financial Close Management uses the application’s Web service to retrieve the list of
values for the user to pick from. Instead of having to manually enter the name of a report, the end user
will have a valid list of reports to select from.
To provide this functionality, Financial Close Management needs to know how to call the appropriate
Web service. The following attributes are required for each Dynamic List Parameter Type:
7
WSDL Location–The URL for the Web service’s WSDL (i.e. http://rptsvr/ReportService?WSDL).
Namespace–The namespace of the Web service (i.e. http://reports.xyz.com).
Port–The Web service port type, as defined in the WSDL.
Name–The Web service name, as defined in the WSDL.
Root Element–The root element of the request, as defined in the WSDL.
SOAP Action–The SOAP action for the service.
Request Namespace–The namespace of the request, if different than the Webservice.
Request XSL Transformation–Since it may not be possible to have Financial Close Management
exactly generate the correct request to the Web service, this field allows the user to create an
XSLT transformation string to alter the request to fit the Web services signature.
Response Element–The name of the SOAP response XML element that contains the parameter
value.
Response Transformation–Since the response may be returned in a form that isn’t understood
by Financial Close Management, the parameter definition can include an XSLT string to
transform the response XML into a valid form. See the Task Response Handling section for more
detail.
Document Navigator Parameter Type
The Document Navigator parameter type is similar to the Dynamic List parameter type in that the valid
set of values can be retrieved from the integrated application at runtime. However, the Document
Navigator represents a hierarchical set of values instead of a flat list. This parameter type can be used to
represent documents and their folders.
The Document Navigator parameter type requires the same attributes as the Dynamic List to define the
associated Web service. In addition to those attributes there are some attributes specific to this type:
Parameter Path Code–Since the Document Navigator is used to list a hierarchical set of values,
the integrated application may need Financial Close Management to send the full path to an
item when setting the value of the parameter. For example, the integrated application may
need “/FolderABC/FileXYZ” or it may only need “FileXYZ” as the parameter value.
One Time Query Flag–If the Web service returns the entire hierarchy in a single call, set this flag
to “Y”. If the Web service returns the hierarchy one level at a time, set this flag to “N”. This
allows Financial Close Management to use Web services that support drilling into the hierarchy
one level at a time.
Parent Folder Parameter–If the Web service is not a “one time query” service (One Time Query
= Y), Financial Close Management will send the parent folder to the Web service to provide the
hierarchical context on each call. The Parent Folder parameter is the Web service parameter
where Financial Close Management should place the parent folder name.
Filter by Document Type Web Service–If the items returned by the associated Web service are
segregated into types, Financial Close Management will support an additional Web service call
to list out the valid item types. For example, suppose the associated Web service returns
8
multiple document types (HTML, text, XML). If the integration needs only text documents,
Financial Close Management can list the document types and allow the end user to filter the
displayed hierarchy. The Item Type Web service detail is the definition of the Web service that
will return the known item types (i.e. WSDL location, port type, etc).
Document Type Filter Parameter–If the item types can be filtered, the item type to filter on
filter needs to be sent to the Document Navigator parameter’s Web service. The Document
Type Filter parameter is the name of the parameter that Financial Close Management should
pass the document type filter value the user chose.
Document Type Filter List–If only a subset of all possible document types are applicable to this
particular Document Navigator, you can specify a comma separated list of document type ID’s
that Financial Close Management will limit the full list of document types to.
Output Parameter Attributes
Financial Close Management now allows a System Automated integration type to have output
parameters defined in the integration type’s Parameter tab, in addition to the existing Input parameters.
This is particularly useful in a multiple step integration type, where-in the results of one step can
manipulate the process of subsequent steps. To handle this, each web service call can designate output
parameters, and the values of these output parameters can be passed as input parameters to
subsequent steps in the integration type. The supported output parameters are of type Text, Integer
and Number. The values of the output parameters are depicted in Financial Close Management’s Task
Actions dialog.
Each output parameter defined for a System Automated Integration Type will have the following
attributes:
Parameter Name–The display name of the parameter. The parameter name will be displayed
next to the parameter when the Integration Type is used to create a Task in Financial Close
Management. This value can be localized.
Parameter Code–The internal name used for the parameter. This value will be used to generate
the service request or URL when the task is processed. For example, the URL that is built for end
user tasks will include a code=value pair for each parameter. The value for a parameter code
must be alpha-numeric.
Parameter Order–A numeric value indicating the order to display the parameters in the
Financial Close Management user interface.
Tooltip–Descriptive text about the parameter and its usage. This value will be displayed if the
user hovers over the parameter in the Financial Close Management user interface. This value
can be localized.
Output Parameter Types
In addition to the above attributes, Financial Close Management needs to know the types of output
parameters being used. The following parameter types are understood by Financial Close Management:
Text–This type is used for a free form text value.
9
Number / Integer–This type is used for a basic numeric value.
Task Execution Detail
Task Execution Endpoints
End User Task Execution
For end user tasks, Financial Close Management needs a directly callable Web application URL. The
specified URL must be able to display the user interface associated end user task. The format of the
URL should be:
{protocol}://{server}:{port}/{context}/{page}?{param1}=$PARAM1$&{param2}=$PARAM2$...
For example:
http://rptsvr:80/reportingapp/viewReport.jsp?reportName=$PARAM1$
The value for $PARAM1$, $PARAM$2, etc. will be filled in by Financial Close Management with the
parameter codes that match based on the Integration Type definition. In the above example, there
should be a “reportName” parameter code defined in the Integration Type. Financial Close
Management will use the value of the “reportName” parameter in place of $PARAM1$. Tokens
defined in the Integration Type’s Application of the Integration Type will also be filled in with the
value defined in the Application.
System Automated Task Execution
For system automated tasks, Financial Close Management needs the endpoint information for the
associated Web service. The endpoint should be specified in the Integration Type’s WSDL location
element. The format should be:
{protocol}://{server}:{port}/{context}/{service}?WSDL
For example:
http://rptsvr:80/reportingService/ReportService?WSDL
The WSDL location element can contain tokens such as $SERVER$. If any tokens in the Application
match a token found in the WSDL location, Financial Close Management will fill in the value as
defined in the Application.
Event Monitoring Task Execution
For event monitoring tasks, Financial Close Management supports two kinds of adapters to listen to
external events. One adapter is ‘OracleAppsAdapter’, is used to listen to the EBS events, here event
name is required to listen to the event, and other adapter is ‘JMSAdapter’ used to listen events from
system which uses JMS mechanism to publish events to outside world, here it needs message
selector.
10
Web Services Supported by System Automated Task
Starting Financial Close Management Release 11.1.2.2.300, all system automated tasks support
synchronous and polling invocation in addition to asynchronous invocation.
1.1.1.1 Asynchronous Web Services
To be usable by Financial Close Management, the Web service must have two port types. Each port type
performs a one-way operation. One port responds to the Web service request and the second calls back
into Financial Close Management with the response.
In addition to the two port WSDL, Financial Close Management requires that the Web service accept
WS-Addressing based reply information. The WS-Addressing headers should be used by the Web service
to direct responses to the correct callback service.
To learn more about the asynchronous Web services framework, see the Developing Asynchronous Web
Services section in the Oracle Fusion Middleware Concepts Guide on the Oracle Technology Network.
The following information is used by Financial Close Management to invoke the asynchronous Web
service:
Service Name–The name of the service being called. The service name is the name of the Web
service defined in the WSDL (i.e. <wsdl:definitions name=”Service Name”>).
Service Namespace–The namespace associated with the Web service. The namespace is defined
in the WSDL (i.e. <wsdl:definitions name=”Service Name” targetNamespace=”Service
Namespace”>).
Service Operation (or SOAP Action)–The service operation is the name of the method to call on
the Web service. The service operation is defined in the WSDL (i.e. <wsdl:operation
name=”Operation Name”>).
Service Port Type–The service port type is the port definition for the Web service. The port type
is defined in the WSDL (i.e. <wsdl:portType name=”Service Port Type”>).
Root Element– The root element of the request. This is not required for JRF-based Web service
calls.
Request Namespace–The namespace of the request schema, if different from the Service
Namespace.
Callback Operation–The service operation is the name of the method during callback from the
Web service.
Callback Port Type–The port type used during callback from the Web service.
Response Root Element–The root element of the response from the Web service. This is not
required for JRF-based Web service calls.
Response Namespace–The namespace of the response schema, if different from the Service
Namespace.
Response XSL Transformation–An optional XSL Transformation string that will transform the
response from the Web service to the format expected by Financial Close Management. See the
Task Response Handling section for more detail.
11
Request Template – An optional XSL transformation is required that would transform the
request XML into the request XML that the web service is expecting. This is required for web
services that expect complex parameter types.
1.1.1.2 Synchronous Web Services
To be usable by Financial Close Management, the Web service must have one port type.
The following information is used by Financial Close Management to invoke the synchronous Web
service:
Service Name–The name of the service being called. The service name is the name of the Web
service defined in the WSDL (i.e. <wsdl:definitions name=”Service Name”>).
Service Namespace–The namespace associated with the Web service. The namespace is defined
in the WSDL (i.e. <wsdl:definitions name=”Service Name” targetNamespace=”Service
Namespace”>).
Service Operation (or SOAP Action)–The service operation is the name of the method to call on
the Web service. The service operation is defined in the WSDL (i.e. <wsdl:operation
name=”Operation Name”>).
Service Port Type–The service port type is the port definition for the Web service. The port type
is defined in the WSDL (i.e. <wsdl:portType name=”Service Port Type”>).
Root Element– The root element of the request. This is not required for JRF-based Web service
calls.
Request Namespace–The namespace of the request schema, if different from the Service
Namespace.
Response Root Element–The root element of the response from the Web service. This is not
required for JRF-based Web service calls.
Response Namespace–The namespace of the response schema, if different from the Service
Namespace.
Response XSL Transformation–An optional XSL Transformation string that will transform the
response from the Web service to the format expected by Financial Close Management. See the
Task Response Handling section for more detail.
Request Template – An optional XSL transformation is required that would transform the
request XML into the request XML that the web service is expecting. This is required for web
services that expect complex parameter types.
1.1.1.3 Polling Web Services
To be usable by Financial Close Management, the Web service must have one port type.
The following information is used by Financial Close Management to invoke the polling Web service:
Service Name–The name of the service being called. The service name is the name of the Web
service defined in the WSDL (i.e. <wsdl:definitions name=”Service Name”>).
Service Namespace–The namespace associated with the Web service. The namespace is defined
in the WSDL (i.e. <wsdl:definitions name=”Service Name” targetNamespace=”Service
Namespace”>).
12
Service Operation (or SOAP Action)–The service operation is the name of the method to call on
the Web service. The service operation is defined in the WSDL (i.e. <wsdl:operation
name=”Operation Name”>).
Service Port Type–The service port type is the port definition for the Web service. The port type
is defined in the WSDL (i.e. <wsdl:portType name=”Service Port Type”>).
Root Element– The root element of the request. This is not required for JRF-based Web service
calls.
Request Namespace–The namespace of the request schema, if different from the Service
Namespace.
Polling Interval – An integer value specified for the web service to wait for a specified time in
minutes before being invoked again
Response Root Element–The root element of the response from the Web service. This is not
required for JRF-based Web service calls.
Response Namespace–The namespace of the response schema, if different from the Service
Namespace.
Response XSL Transformation–An optional XSL Transformation string that will transform the
response from the Web service to the format expected by Financial Close Management. See the
Task Response Handling section for more detail.
Request Template – An optional XSL transformation is required that would transform the
request XML into the request XML that the web service is expecting. This is required for web
services that expect complex parameter types.
Financial Close Management allows for four pieces of information to be returned from the asynchronous
Web service:
Result–The result of the Webservice call. If the value is Success, then the task will be marked as
completed successfully in Financial Close Management. Otherwise, it will be marked as
completed with an error.
Message–A message that further explains what happened during the Web service call
Log Location–The file location of any log that was generated during the execution of the Web
service. The location is assumed to be a file local to the Web service’s server and not accessible
by Financial Close Management.
Report Locations–A list of URL’s that are accessible via the Web that show reports or
information created by the Web service.
Only the Result field is required to be filled in. The other values can be blank or not supplied.
The Message, Log Location and Report Locations will be displayed in the Financial Close Management
user interface in the Task Actions dialog. The user will be able to click on the Report Locations to
navigate to the Web page specified.
Task Security
Web Service Security
13
Financial Close Management supports any Oracle WSM security policy based on Security Assertion
Markup Language (SAML) tokens. With SAML tokens, a trust relationship is established between the
Financial Close client and external service provider by means of exchanging certificates. This allows
Financial Close Management to invoke the system automated task using the task assignee’s
credentials.
The security policy to be used for any Web service call can be defined in the Application for the
Integration Type. The Request Security Policy is used for the dynamic list and document navigator
parameter’s Web services calls, as well as the request for the asynchronous task execution Web
service. The Response Security Policy is used only for the asynchronous task execution Web service’s
response call back to Financial Close Management.
By default, Financial Close Management uses the WSM policy
“oracle/wss11_saml_token_with_message_protection_client_policy” for the Request Security
Policy, and will use the WSM policy
“oracle/wss11_saml_or_username_token_with_message_protection_service_policy” for the
Response Security Policy.
This configuration requires that the Financial Close client’s public key has been imported into the
external service provider’s keystore and that the external service provider’s public key has been
imported into the Financial Close client’s keystore.
For information on configuring the OWSM keystore and credential store, see the Configuring the
Credential Store Using WLST in the Using Oracle Web Service Security Policies on the Oracle
Technology Network.
The Keystore Recipient Alias can also be set in the application, if the external Web services require
this value to be set.
End User Task Security
Financial Close Management supports single sign-on (SSO) with external Web applications if that
application is integrated with the Oracle EPM system’s CSS SSO framework. There are two methods
that the SSO token can be passed to the end user endpoint:
o The end user URL contains the token $SSO_TOKEN$. When invoking an end user task,
Financial Close Management will replace $SSO_TOKEN$ with the CSS SSO Token. The
external application can pick up the CSS SSO Token and use it to launch the end user task.
The drawback to this approach is that the SSO token will be passed using a GET operation,
meaning it is visible in the URL, and a possible security violation.
o The SSO Parameter is set in the Integration Type definition. Financial Close Management will
POST the SSO token to the end user endpoint using the SSO Parameter name in the
Integration Type. This prevents the SSO token from appearing in the URL, but the receiving
end point must support information passed via a POST.
14
If the external Web application does not support this integration, no user credentials will be
provided when invoking the end user task URL. It would be up to the external application to prompt
for credentials before displaying the end user task.
Event Monitoring Task Security
Security for event monitoring tasks is build at adapter level. Adapters are configured in Application
Server. To listen to EBS events ‘OracleAppsAdapter’ needs to be configured to connect to the EBS
Database instance. In case of ‘JMSAdapter’, to send message to JMS Queue of Application Server,
sender must use the Application Server credentials.
Task Response Handling
There are three types of Web services that Financial Close Management uses from an external
application:
1. The Web service that executes a System Automated Task
2. The Web service that provides a list of values for the Dynamic List parameter type
3. The Web service that provides a hierarchical list of values for the Document Navigator
parameter type
When invoked, each of the services responds with an XML based SOAP message. The data types
returned may be different based on the application being integrated. Financial Close Management
provides a mechanism to translate the response XML into something understandable by the system.
For the Web services defined in an Integration Type, an XSLT string can be specified to take the actual
Web service response and translate it into the response expected by Financial Close Management.
The following sections describe the response XML required for each of the Web service types.
System Automated Task Response XSD
<xs:schema targetNamespace="/oracle/apps/epm/fcc/model/view/common/"
xmlns="/oracle/apps/epm/fcc/model/view/common/"
xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified"
attributeFormDefault="unqualified">
<xs:element name="TaskResult" type="TaskResultType"/>
<xs:complexType name="MessagesType">
<xs:annotation>
<xs:documentation>A messages type has the message and its associated
locale</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="Message" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>Contains the message and its locale</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element name="Value" type="xs:string">
<xs:annotation>
<xs:documentation>The actual message</xs:documentation>
</xs:annotation>
15
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:complexType name="TaskResultType">
<xs:sequence>
<xs:element name="Result" type=" xs:string ">
<xs:annotation>
<xs:documentation>Specifies if the task succeeded (Success) or failed
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="LogLocation" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation>The log file location</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="Messages" type="MessagesType" minOccurs="0">
<xs:annotation>
<xs:documentation>An optional message that further qualifies success or
failure</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element maxOccurs="unbounded" minOccurs="0" name="ReportLocation"
type="xs:string">
<xs:annotation>
<xs:documentation>report location</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
$OUTPUT_PARAM_ELEMENTS$
</xs:complexType>
</xs:schema>
$OUTPUT_PARAM_ELEMENTS$ will be replaced by the actual output parameter sequence present in the
given integration type
For example:
<xs:element name="Status" type="xs:string">
<xs:annotation>
<xs:documentation>Output Parameter</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="JobID" type="xs:integer">
<xs:annotation>
<xs:documentation>Output Parameter</xs:documentation>
</xs:annotation>
</xs:element>
Example:
16
<TaskResult>
<Result>Success</Result>
<LogLocation>http://RptSvr1/ReportApp/ViewLog.jsp?LogID=1234</LogLocation>
<Messages>
<Message>The report ran successfully.</Message>
</Messages>
<Status>SUCCEEDED</Status>
<JobID>2334</JobID>
</TaskResult>
Note: This is a sample XSD. The response XSD changes based on the output parameters defined for a
particular step. The XSD can be generated using Financial Close Management using the Generate XSD
button. This XSD can then be used to generate the XSL transformation that is required for the particular
System Automated Step. So the sequence to generate and use the XSD is as below:
In the New Integration Type dialog
1. Enter the required attributes except the XSL transformation
2. Go to parameters tab and enter the input and output parameters
3. Come back to properties tab, and click on Generate XSD. This saves the XSD with output parameters
as elements
4. Use this XSD to construct the XSL transformation from the web service output message
5. If the output parameters get changed, then the XSD needs to be regenerated and then used to
construct the new XSL transformation
Dynamic List Parameter Type Response XSD
<xs:element name="selectItem" maxOccurs="unbounded">
<xs:complexType>
<xs:sequence>
<xs:element name="code" type="xs:string" minOccurs=”1” maxOccurs=”1”/>
<xs:element name="name" type="xs:string" minOccurs=”1” maxOccurs=”1”/>
</xs:sequence>
</xs:complexType>
</xs:element>
Example:
<selectItem>
<code>SEL1</code>
<name>Selection Item 1</name>
</selectItem>
<selectItem>
<code>SEL2</code>
<name>Selection Item 2</name>
</selectItem>
<selectItem>
<code>SEL3</code>
<name>Selection Item 3</name>
17
</selectItem>
Document Navigator Parameter Type Response XSD
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
elementFormDefault="qualified">
<xs:element name="listing">
<xs:complexType>
<xs:sequence>
<xs:element ref="folders"/>
<xs:element ref="documents"/>
</xs:sequence>
<xs:attribute name="folder" use="optional" type="xs:NCName"/>
</xs:complexType>
</xs:element>
<xs:element name="folders">
<xs:complexType>
<xs:sequence>
<xs:element ref="folder"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="folder">
<xs:complexType>
<xs:attribute name="description" use="optional"/>
<xs:attribute name="id" use="required" type="xs:NCName"/>
<xs:attribute name="name" use="required"/>
</xs:complexType>
</xs:element>
<xs:element name="documents">
<xs:complexType>
<xs:sequence>
<xs:element maxOccurs="unbounded" ref="document"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="document">
<xs:complexType>
<xs:attribute name="description" use="optional"/>
<xs:attribute name="id" use="required" type="xs:NCName"/>
<xs:attribute name="name" use="required"/>
<xs:attribute name="type" use="optional" type="xs:integer"/>
</xs:complexType>
</xs:element>
</xs:schema>
Example:
<listing>
<folders>
<folder id=”folder1” name=”Folder 1” description=”Folder 1 Description”/>
<folder id=”folder2” name=”Folder 2” description=”Folder 1 Description”/>
</folders>
18
</listing>
<listing folder=”folder1”>
<folders>
<folder id=”folder3” name=”Folder 3” description=”Folder 3 Description”/>
</folders>
<documents>
<document id=”doc1” type=”1” name=”Document 1” description=”Doc 1 description”/>
<document id=”doc2” type=”5” name=”Document 2”/>
<document id=”doc3” type=”5” name=”Document 3”/>
</documents>
</listing>
19
Event Monitoring XSD and XSL
Event Monitoring integration type requires:
1. Event XSD–This tag content needs to be the XML schema of External Event, in which format external
system is going to send events to external world.
2. Event Transform XSL–This tag contents are used to map the values of external event to internal
event.
Event Monitoring Internal Event XSD
<?xml version = '1.0' encoding = 'UTF-8'?>
<xs:schema targetNamespace="http://xmlns.oracle.com/pcbpel/adapter/db/top/FCCEventReceived"
xmlns="http://xmlns.oracle.com/pcbpel/adapter/db/top/FCCEventReceived"
elementFormDefault="qualified" attributeFormDefault="qualified"
xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="FccEventMonitorResultsCollection"
type="FccEventMonitorResults"/>
<xs:complexType name="FccEventMonitorResults">
<xs:sequence>
<xs:element name="FccEventMonitorTaskDetails" type="FccEventMonitorTaskDetails"
minOccurs="0" nillable="true"/>
<xs:element name="eventKey" minOccurs="0" nillable="true">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="255"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="eventName" minOccurs="0" nillable="true">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="255"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="sendDate" minOccurs="0" nillable="true">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="255"/>
</xs:restriction>
20
</xs:simpleType>
</xs:element>
<xs:element name="receiveDate" minOccurs="0" nillable="true">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="255"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="fromAgentName" minOccurs="0" nillable="true">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="255"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="fromAgentSystem" minOccurs="0" nillable="true">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="255"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="keyValue" minOccurs="0" nillable="true">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="255"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="attribute1" minOccurs="0" nillable="true">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="255"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="attribute2" minOccurs="0" nillable="true">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="255"/>
</xs:restriction>
21
</xs:simpleType>
</xs:element>
<xs:element name="attribute3" minOccurs="0" nillable="true">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="255"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="attribute4" minOccurs="0" nillable="true">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="255"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="fccEventMonitorResParamsCollection" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:element name="FccEventMonitorResParams"
type="FccEventMonitorResParams" minOccurs="0"
maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:complexType name="FccEventMonitorResParams">
<xs:sequence>
<xs:element name="paramName">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="255"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="paramValue" minOccurs="0" nillable="true">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="255"/>
</xs:restriction>
</xs:simpleType>
22
</xs:element>
<xs:element name="attribute1" minOccurs="0" nillable="true">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="255"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="attribute2" minOccurs="0" nillable="true">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="255"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:complexType name="FccEventMonitorTaskDetails">
<xs:sequence>
<xs:element name="TaskID">
<xs:simpleType>
<xs:restriction base="xs:long"/>
</xs:simpleType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:schema>
Event Monitoring XSL Transformation:
<ns1:eventKey>
<xsl:value-of select=" EVENT_KEY value of External Event Payload "/>
</ns1:eventKey>
<ns1:eventName>
<xsl:value-of select=" EVENT_NAME value of External Event Payload "/>
</ns1:eventName>
<ns1:sendDate>
<xsl:value-of select=" SEND_DATE value of External Event Payload "/>
</ns1:sendDate>
<ns1:receiveDate>
<xsl:value-of select=" RECEIVE_DATE value of External Event Payload "/>
</ns1:receiveDate>
23
<ns1:fromAgentName>
<xsl:value-of select=" NAME value of External Event Payload "/>
</ns1:fromAgentName>
<ns1:fromAgentSystem>
<xsl:value-of select=" SYSTEM value of External Event Payload "/>
</ns1:fromAgentSystem>
<ns1:keyValue>
<xsl:value-of select=" EVENT_DATA value of External Event Payload "/>
</ns1:keyValue>
<ns1:fccEventMonitorResParamsCollection>
<xsl:for-each select=" PARAMETER_LIST_ITEM value of External Event Payload ">
<ns1:FccEventMonitorResParams>
<ns1:paramName>
<xsl:value-of select="NAME value of External Event Payload "/>
</ns1:paramName>
<ns1:paramValue>
<xsl:value-of select="VALUE value of External Event Payload "/>
</ns1:paramValue>
</ns1:FccEventMonitorResParams>
</xsl:for-each>
</ns1:fccEventMonitorResParamsCollection>
Example:
<ns1:eventKey>
<xsl:value-of select="/imp1:WF_EVENT_T/EVENT_KEY"/>
</ns1:eventKey>
<ns1:eventName>
<xsl:value-of select="/imp1:WF_EVENT_T/EVENT_NAME"/>
</ns1:eventName>
<ns1:sendDate>
<xsl:value-of select="/imp1:WF_EVENT_T/SEND_DATE"/>
</ns1:sendDate>
<ns1:receiveDate>
<xsl:value-of select="/imp1:WF_EVENT_T/RECEIVE_DATE"/>
</ns1:receiveDate>
<ns1:fromAgentName>
<xsl:value-of select="/imp1:WF_EVENT_T/FROM_AGENT/NAME"/>
</ns1:fromAgentName>
<ns1:fromAgentSystem>
<xsl:value-of select="/imp1:WF_EVENT_T/FROM_AGENT/SYSTEM"/>
</ns1:fromAgentSystem>
24
<ns1:keyValue>
<xsl:value-of select="/imp1:WF_EVENT_T/EVENT_DATA"/>
</ns1:keyValue>
<ns1:fccEventMonitorResParamsCollection>
<xsl:for-each select="/imp1:WF_EVENT_T/PARAMETER_LIST/PARAMETER_LIST_ITEM">
<ns1:FccEventMonitorResParams>
<ns1:paramName>
<xsl:value-of select="NAME"/>
</ns1:paramName>
<ns1:paramValue>
<xsl:value-of select="VALUE"/>
</ns1:paramValue>
</ns1:FccEventMonitorResParams>
</xsl:for-each>
</ns1:fccEventMonitorResParamsCollection>
25
Creating Integrations
There are two methods for creating Integration Types within Financial Close Management:
If there are a small number of services to integrate into Financial Close Management, the user can
add and edit these integrations directly in the Financial Close user interface.
Financial Close Management also allows the end user to import the service definitions in the form of
an integration XML document.
Creating Integrations using the Integration XML Document
To integrate a large number of services or to define the integrations without using the Financial Close
Management user interface, the end user can create the Integration Type XML document. This
document should contain all of the Integration Types associated with the third party application being
integrated.
Integration Type XML Schema
The following XML schema represents the structure and content for the Integration Type XML
document:
<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
elementFormDefault="qualified"
xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
<xs:element name="integrationTypes">
<xs:complexType>
<xs:sequence>
<xs:element name="application" maxOccurs="1" minOccurs="0">
<xs:complexType>
<xs:attribute name="applicationName" use="required" type="xs:string"/>
<xs:attribute name="webAppName" type="xs:string"/>
<xs:attribute name="webServiceName" type="xs:string"/>
<xs:attribute name="securityPolicy " type="xs:string"/>
<xs:attribute name="responseSecurityPolicy " type="xs:string"/>
<xs:attribute name="keystoreRecipientAlias" type="xs:string"/>
</xs:complexType>
</xs:element>
<xs:element name="integrationType" maxOccurs="unbounded" minOccurs="1">
<xs:complexType>
<xs:sequence>
<xs:element name="name" maxOccurs="unbounded" minOccurs="1">
<xs:complexType mixed="true">
<xs:attribute name="language" use="required" type="xs:string"/>
</xs:complexType>
</xs:element>
<xs:element name="description" maxOccurs="unbounded" minOccurs="1">
26
<xs:complexType mixed="true">
<xs:attribute name="language" use="required" type="xs:string"/>
</xs:complexType>
</xs:element>
<xs:element name="integrationStep" maxOccurs="unbounded" minOccurs="1">
<xs:complexType>
<xs:sequence>
<xs:element name="responseXSLTemplate" type="xs:string" maxOccurs="1"
minOccurs="0"/>
<xs:element name="requestTemplate" type="xs:string" maxOccurs="1"
minOccurs="0"/>
<xs:attribute name="sysAutType" use="required">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value="A"/>
<xs:enumeration value="S"/>
<xs:enumeration value="P"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="serviceName" type="xs:string"/>
<xs:attribute name="serviceNamespace" type="xs:string"/>
<xs:attribute name="serviceWSDLLoc" type="xs:string"/>
<xs:attribute name="serviceOperation" type="xs:string"/>
<xs:attribute name="servicePortType" type="xs:string"/>
<xs:attribute name="rootElement" type="xs:string"/>
<xs:attribute name="requestNamespace" type="xs:string"/>
<xs:attribute name="callbackOperation" type="xs:string"/>
<xs:attribute name="callbackPortType" type="xs:string"/>
<xs:attribute name="responseRootElement" type="xs:string"/>
<xs:attribute name="responseNamespace" type="xs:string"/>
<xs:element name="parameter" maxOccurs="unbounded" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:element name="xsltTransformation" type="xs:string" maxOccurs="1"
minOccurs="0"/>
<xs:element name="dimSelectorSelection" maxOccurs="1" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:element name="Parameters">
<xs:complexType>
<xs:sequence>
<xs:element name="ParameterNames">
<xs:complexType>
<xs:sequence>
<xs:element name="ParameterName" maxOccurs="unbounded">
<xs:complexType>
<xs:sequence>
<xs:element name="Name" type="xs:string" maxOccurs="1"
27
minOccurs="1"/>
<xs:element name="Value" type="xs:string" maxOccurs="1"
minOccurs="1"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="dependency" maxOccurs="unbounded" minOccurs="0">
<xs:complexType>
<xs:attribute name="parameterCode" use="required" type="xs:string"/>
<xs:attribute name="parameterName" use="required" type="xs:string"/>
</xs:complexType>
</xs:element>
<xs:element name="name" maxOccurs="1" minOccurs="1">
<xs:complexType mixed="true">
<xs:attribute name="language" use="required" type="xs:string"/>
</xs:complexType>
</xs:element>
<xs:element name="selectItem" maxOccurs="unbounded" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:element name="name" maxOccurs="unbounded" minOccurs="1">
<xs:complexType mixed="true">
<xs:attribute name="language" use="required" type="xs:string"/>
</xs:complexType>
</xs:element>
</xs:sequence>
<xs:attribute name="order" use="required" type="xs:string"/>
<xs:attribute name="selectItemCode" use="required"
type="xs:string"/>
</xs:complexType>
</xs:element>
<xs:element name="docNavDocTypeXsltTransformation" type="xs:string"
maxOccurs="1" minOccurs="0"/>
</xs:sequence>
<xs:attribute name="dimSelectorURL" type="xs:anyURI"/>
<xs:attribute name="docNavDocTypeName" type="xs:string"/>
<xs:attribute name="docNavDocTypeParameter" type="xs:string"/>
<xs:attribute name="docNavDocTypePort" type="xs:string"/>
<xs:attribute name="docNavDocTypeRespElement" type="xs:NMTOKEN"/>
28
<xs:attribute name="docNavDocTypeSOAPAction" type="xs:string"/>
<xs:attribute name="docNavDocTypeURI" type="xs:string "/>
<xs:attribute name="docNavDocTypeWSDLLoc" type="xs:string"/>
<xs:attribute name="docNavFolderParameter" type="xs:string"/>
<xs:attribute name="docNavDocTypeFilter" type="xs:string"/>
<xs:attribute name="docNavOneTimeQuery" type="xs:string"/>
<xs:attribute name="parameterPathCode" type="xs:string"/>
<xs:attribute name="multiselect">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value="Y"/>
<xs:enumeration value="N"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="order" use="required" type="xs:integer"/>
<xs:attribute name="parameterCode" use="required" type="xs:string"/>
<xs:attribute name="parameterType" use="required">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value="TEXT"/>
<xs:enumeration value="INTEGER"/>
<xs:enumeration value="NUMBER"/>
<xs:enumeration value="DATE"/>
<xs:enumeration value="BOOLEAN"/>
<xs:enumeration value="LOV"/>
<xs:enumeration value="DYNLOV"/>
<xs:enumeration value="RADIO"/>
<xs:enumeration value="USER"/>
<xs:enumeration value="POV"/>
<xs:enumeration value="DOCNAV"/>
<xs:enumeration value="TASKINFO"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="required" use="required">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value="Y"/>
<xs:enumeration value="N"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="defaultValue" type="xs:string"/>
<xs:attribute name="hidden"
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value="Y"/>
29
<xs:enumeration value="N"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="excludeFromWebservice" type="xs:string">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value="Y"/>
<xs:enumeration value="N"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="taskFieldId" type="xs:string">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value="TaskId"/>
<xs:enumeration value="TaskName"/>
<xs:enumeration value="Duration"/>
<xs:enumeration value="StartDate"/>
<xs:enumeration value="EndDate"/>
<xs:enumeration value="Owner"/>
<xs:enumeration value="Assignee"/>
<xs:enumeration value="ScheduleName"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="dateFormat" type="xs:string"/>
<xs:attribute name="dateUpperBound" type="xs:string"/>
<xs:attribute name="dateLowerBound" type="xs:string"/>
<xs:attribute name="numUpperBound " type="xs:number"/>
<xs:attribute name="numLowerBound " type="xs:number "/>
<xs:attribute name="SOAPAction" type="xs:string"/>
<xs:attribute name="serviceName" type="xs:string"/>
<xs:attribute name="serviceNamespace" type="xs:anyURI"/>
<xs:attribute name="servicePort" type="xs:string"/>
<xs:attribute name="rootElement" type="xs:string"/>
<xs:attribute name="requestNamespace" type="xs:string"/>
<xs:attribute name="serviceResponseElement" type="xs:NMTOKEN"/>
<xs:attribute name="serviceWSDLLoc" type="xs:anyURI"/>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:sequence>
</xs:complexType>
<xs:attribute name="integrationTypeCode" use="required"
type="xs:string"/>
<xs:attribute name="applicationCode" use="required" type="xs:string"/>
<xs:attribute name="userCreated" use="required">
<xs:simpleType>
30
<xs:restriction base="xs:string">
<xs:enumeration value="Y"/>
<xs:enumeration value="N"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="executionType" use="required">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value="S"/>
<xs:enumeration value="U"/>
<xs:enumeration value="E"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="endUserURL" type="xs:anyURI"/>
<xs:attribute name="ssoParameter" type="xs:anyURI"/>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:schema>
Integration XML Elements and Attributes
integrationType Element–Describes one Integration Type in Financial Close Management.
o integrationTypeCode–A code to uniquely identify this Integration Type. This is used to
ensure that multiple uploads of the XML can determine if a new Integration Type should be
created or if an existing one is being updated. It is also passed as a parameter when the task
executes.
o applicationCode–The application code for this Integration Type. The application code is
used to segregate Integration Types within Financial Close Management.
o userCreated–A flag indicating whether an end user created this Integration Type or the
Integration Type was seeded by Financial Close Management. Integration Types that are not
user created are read-only within the Financial Close Management User Interface.
o executionType–A flag indicating if the task is a System Automated or End User task. Use “S”
for System Automated, “U” for End User and “E” for Event Monitoring task.
o endUserURL–The Web application URL that can be called to display the end user task
module. This attribute is only required for end user tasks.
o SsoParameter–The SSO Parameter to POST the SSO token to, for end user tasks.
o adapterName–The name of the adapter used for event monitoring “JMSAdapter”, to
monitor JMS Events or "OracleAppsAdapter", to monitor EBS Events.
o eventName–Event name is to specify which EBS Event is associated with integration type.
31
o
messageSelector–Needs to provide the message selector for JMS Event monitoring, like
"EVENT_NAME='<MessageSelector>'", here <MessageSelector> need to be same as External
Event Payload selector.
o eventXSDTemplate–An XSD is the Event Payload schema which is coming from external
system. Depending on the External system that Payload XML schema may change, so this
needs to be given accordingly.
o eventTransformXLSTemplate–An XSL transformation is required for event monitoring
feature, to map the external event payload tags to internal event payload tags. Here the
special tag is “<ns1:keyValue>”, this tag value will be used in side Financial Close
Management to identify which task is exactly waiting for this event with parameter, by
comparing the parameter value with this keyValue value.
integrationStep Element–Describes one Integration Step of a System Automated Integration Type in
Financial Close Management.
o integrationTypeCode–A code to uniquely identify this Integration Type Step. This is used to
ensure that in a multiple step System Automated integration type, each step is uniquely
identified for its attributes and parameters
o sysAutType –A flag indicating the different System Automated web service invocation types
being supported. Use “A” for asynchronous invocation, “S” for synchronous invocation and
“P” for polling invocation.
o pollingInterval- An integer value to specify the time in minutes for a Polling Web Service
invocation
o serviceWSDLLoc–The location of the Web service WSDL that describes the service used to
invoke the system automated task. This attribute is only required for system automated
tasks.
o serviceNamespace–The Web service namespace as defined in the service’s WSDL. This
attribute is only required for system automated tasks.
o servicePortType–The Web service port type as defined in the service’s WSDL. This attribute
is only required for system automated tasks.
o serviceName–The Web service name as defined in the service’s WSDL. This attribute is only
required for system automated tasks.
o serviceOperation–The name of the method to invoke on the defined Web service. This
attribute is only required for system automated tasks.
rootElement–The root element of the asynchronous Web service request call, if needed.
o requestNamespace–The request namespace of an asynchronous Web service call, if
different from the serviceNamespace.
o callbackPortType–The Web service port type for the asynchronous callback. This attribute is
only required for system automated tasks.
o callbackOperation–The name of the method that will be invoked on the callback Web
service. This attribute is only required for system automated tasks.
o responseRootElement–The root element of the asynchronous Web service response call, if
needed.
o responseNamespace–The response namespace of an asynchronous Web service call, if
different from the serviceNamespace.
o responseXSLTTemplate–An XSL transformation that will be applied to the task’s response to
transform it into a format recognized by Financial Close Management. Refer to the System
Automated Task Response XSD section for more detail.
32
o
requestTemplate - An XSL transformation is required that would transform the request XML
into the request XML that the web service is expecting.
name Element–The name element is used to store the translated name of each Integration Type.
There can be a localized name element for each language supported by Financial Close
Management.
o language–The language of this name’s translation. The languages currently supported by
Financial Close Management are:
Language Attribute Value
Description
En
English
Fr
French
De
German
Ja
Japanese
Es
Spanish
Ru
Russian
Ko
Korean
Zh_CN
Chinese (Simplified)
Zh_TW
Chinese (Traditional)
Sv
Swedish
Tr
Turkish
It
Lithuanian
Da
Danish
Pt_BR
Portuguese (Brazil)
Fi
Finnish
Nl
Dutch
Pl
Polish
description Element–The description element is used to store the translated description of each
Integration Type. There can be a localized description element for each language supported by
Financial Close Management.
o language–The language of this description’s translation.
o parameter Element–Describes one parameter for the Integration Type. The parameters are
sent to integrated application when the Web service or end user task URL is invoked. See
the Integration Type Parameters section for more detail.
o outputParameter - Element–Describes one output parameter for the Integration Type. The
parameters are sent to integrated application when the Web service or end user task URL is
invoked. See the Integration Type Parameters section for more detail.
o parameterCode–A unique name for the parameter. This attribute must contain only letters
and numbers, and must start with a letter.
o parameterType–The type of parameter. This value affects how the Financial Close user
interface handles the display and validation of the parameter. See the Integration Type
Parameters section for a description of the parameter types.
o required–A flag indicating whether the parameter is required or not.
33
o
o
o
o
o
o
o
o
o
o
o
o
o
o
o
o
o
o
o
hidden–Whether the parameter should be hidden from the end user in the UI. Only
applicable to parameters of type text, number or task information
defaultValue–The default value of the parameter. Only applicable to parameters of type
text or number.
order–A number representing the display order for the parameters in the Financial Close
Management user interface.
excludeFromWebservice–A flag to not pass the parameter to the asynchronous Web service
during task execution. Only valid for system automated integration types.
multiselect–A flag indicating that the user can select multiple values (default=”N”). This
attribute is only valid for parameter types LOV, DYNLOV, and RADIO. If the parameter type is
RADIO and the multiselect attribute = “Y”, Financial Close Management will display the
parameter as a checkbox group.
inputSize–The maximum length of the string allowed in input box. This attribute is only valid
for TEXT parameter types.
rows–The number of rows to display for the input box (default = 1). This attribute is only
valid for TEXT parameter types.
numLowerBound–The lowest number allowed. This attribute is only valid for NUMBER and
INTEGER parameter types.
numUpperBound–The highest number allowed. This attribute is only valid for NUMBER and
INTEGER parameter types.
dateLowerBound–The earliest date allowed. This attribute is only valid for DATE parameter
types.
dateUpperBound–The latest date allowed. This attribute is only valid for DATE parameter
types.
dimSelectorURL–Internal use only.
serviceWSDLLoc–The location of the Web service that will enumerate the values for the
dynamic parameter types. See the Parameter Type section for more detail. This attribute is
only valid for DYNLOV and DOCNAV parameter types.
serviceNamespace–The namespace for the Web service that will enumerate the values for
the dynamic parameter types. See the Parameter Type section for more detail. This
attribute is only valid for DYNLOV and DOCNAV parameter types.
servicePort–The port for the Web service that will enumerate the values for the dynamic
parameter types. See the Parameter Typesection for more detail. This attribute is only valid
for DYNLOV and DOCNAV parameter types.
serviceName–The service name for the Web service that will enumerate the values for the
dynamic parameter types. See the Dynamic List Parameter Type section for more detail. This
attribute is only valid for DYNLOV and DOCNAV parameter types.
SOAPAction–The name of the method to invoke on the Web service that will enumerate the
values for the dynamic parameter types. See the Parameter Type section for more detail.
This attribute is only valid for DYNLOV and DOCNAV parameter types.
serviceResponseElement–The name of the XML element within the Web service response
that contains the XML that Financial Close Management expects for the parameter.
xsltTransformation–The XSLT transformation string that will transform each of the children
of the serviceResponseElement to the format expected by Financial Close Management. This
attribute is only valid for the DYNLOV and DOCNAV parameter types. This attribute is not
needed if the Web service returns the format identical to what Financial Close Management
expects.
34
o
parameterPathCode–If the Integration Type requires that DOCNAV parameter types contain
the full document path, this attribute should contain the name of the enumeration service’s
response element that contains the path. This attribute is valid only for the DOCNAV
parameter type.
o docNavOneTimeQuery–A flag to indicate if the Web service for the document navigator
parameter type returns an iterative result. See the Document Navigator Parameter Type
section for more detail. This attribute is valid only for the DOCNAV parameter type.
o docNavFolderParameter–If the docNavOneTimeQuery flag is set to “Y”, this attribute
should contain the parameter that Financial Close Management needs to set the folder ID
being drilled on. This attribute is valid only for the DOCNAV parameter type.
o docNavFileTypeWSDLLoc–The WSDL location of the Web service that can enumerate the
file types available for the Document Navigator parameter type. See the Document
Navigator Parameter Type section for more detail. This attribute is valid only for the
DOCNAV parameter type.
o docNavFileTypeURI–The namespace for the Web service that will enumerate the file types
available for the Document Navigator parameter type. This attribute is valid only for the
DOCNAV parameter type.
o docNavFileTypePort–The port for the Web service that will enumerate the file types
available for the Document Navigator parameter type. This attribute is valid only for the
DOCNAV parameter type.
o docNavFileTypeName–The service name for the Web service that will enumerate the file
types available for the Document Navigator parameter type. This attribute is valid only for
the DOCNAV parameter type.
o docNavFileTypeSOAPAction–The name of the method to invoke on the Web service that
will enumerate the file types available for the Document Navigator parameter type. This
attribute is valid only for the DOCNAV parameter type.
o docNavFileTypeRespElement–The name of the XML element within the Web service
response that contains the XML that Financial Close Management expects for the
parameter. This attribute is valid only for the DOCNAV parameter type.
o docNavFileTypeXsltTransformation–The XSLT transformation to be applied to the
docNavFileTypeResponseElement to transform the response into the format expected by
Financial Close Management. This transformation is used against each child of the
docNavFileTypeRespElement. This attribute is valid only for the DOCNAV parameter type.
o docNavFileTypeParameter–The name of the parameter passed to the Document Navigator
Webservice to indicate which file type the user is filtering on. This attribute is valid only for
the DOCNAV parameter type.
o docNavDocTypeFilter–A comma-separated list of document type ID’s returned by the
document filter Webservice to restrict the filter to.
o taskFieldId–The task field that will be user to populate the value of this parameter. Only
applicable to parameters of type Task Information. Possible values are “TaskId”,
“TaskName”, “Duration”, “StartDate”, “EndDate”, “Owner”, “Assignee”, “ScheduleName”.
selectItem Element–One element in the selectable list for the LOV and RADIO type parameters.
o selectItemCode–The code that Financial Close Management will use as the value of the LOV
or RADIO parameter if this item is selected by the user. The attribute must contain only
letters and numbers and must start with a letter.
o order–An integer value indicating which order to display the item in the LOV or RADIO group
in the Financial Close Management user interface.
35
dependency Element–Indicates that one parameter is dependent on another parameter. The
parameters that are listed as dependencies are considered parents of the current parameter. In the
Financial Close Management user interface, the parent parameters will be processed before the
child parameters.
o parameterCode–The code of the parameter that this parameter is dependent on.
o parameterName–The name of the parameter used to pass this value to the parent
parameter’s service.
o docNavDocTypeFilter–A comma-separated list of document type ID’s returned by the
document filter Webservice to restrict the filter to.
application Element–Describes one application in Financial Close Management.
o applicationName–The name of the application.
o WebAppName–The name of the Registry logical Web application that this application
corresponds to. Only applicable for EPM applications.
o WebServiceName–The name of the Registry logical Web service application that this
application corresponds to. Only applicable for EPM applications.
o securityPolicy–The request security policy to be used in Web service calls of any integration
type of this Application.
o responseSecurityPolicy–The response security policy to be used in Web service calls of any
integration type of this Application.
o keystoreRecipientAlias–The keystore recipient alias, if the Webservices require this to be
set.
Loading the Integration Type XML
After the Integration Type XML has been created, the XML must be loaded into Financial Close
Management to create or update the integrations in the system. For the detailed procedure on loading
integrations into Financial Close Management, see the Oracle Hyperion Financial Close Management
Administrator’s Guide.
Creating Integrations with the Financial Close Management User
Interface
Integration Types can also be created by using the Financial Close Manage Integration Types module.
From within the Financial Close Management user interface, select Manage and then Manage
Integration Types. For details on creating and managing Integration Types, see the Oracle Hyperion
Financial Close Management Administrator’s Guide.
36
Sample Integration XML
The following integration XML will create two integrations types in Financial Close Management.
The first integration type, RUNREPORT, points to a Web service for running an automated report on the
http://rptsvr:80/reportingService/ReportingService Web service. The Web service method runReport
takes a single parameter reportName that identifies the report to run. The available reports will be listed
by the Close Calendar UI by calling the http://rptsvr:80/reportingService/ReportListingService Web
service method getReports as defined in the integration type.
The second integration type, VIEWREPORT, points to an end user UI module at the URL
http://rptsvr1:80/reportingApp/ViewReport .jsp. When called in a browser, the URL displays the report
for the end user. The ViewReport URL also takes a single parameter REPORTNAME on the URL. The
actual REPORTNAME value will be replaced when the URL is launched. The available reports will be
listed by the Close Calendar UI by calling the getReports Web service method as defined in the
integration type.
The results from the runReport and getReports methods are not in the format expected by Financial
Close Management so the associated XSL templates are included in the integration type definition.
<?xml version="1.0" encoding="UTF-8"?>
<integrationTypes xmlns:msxsl="urn:schemas-microsoft-com:xslt"
xmlns:fcmns1="http://reports.xyz.com">
<application applicationName="Sample"/>
<integrationType integrationTypeCode="RUNREPORT" applicationCode="Sample"
executionType="S" userCreated="N>
<integrationStep interationTypeCode=”SUBMITTASKSYNC” sysAutType=”S” "
serviceNamespace="http://reports.xyz.com"
serviceWSDLLoc="http://rptsvr:80/reportingService/ReportService?WSDL"
serviceName="ReportService" servicePortType="ReportService"
serviceOperation="runReport">
<name language="en" countryCode="US">Run Report</name>
<description language="en" countryCode="US">
Run Report Automated Task
</description>
<parameter parameterCode="reportName" required="Y"
parameterType="DYNLOV" order="1"
serviceWSDLLoc="http://rptsvr:80/reportingService/ReportListingService?WSDL"
serviceNamespace="http://reports.xyz.com" serviceName="ReportListingService"
servicePort="ReportListingServicePortType"
serviceResponseElement="ns0:getReportsResponse" SOAPAction="getReports">
<name language="en" countryCode="US">Report Name</name>
<xsltTransformation>
<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
37
xmlns:ns0="http://reports.xyz.com" version="1.0">
<xsl:template match="ns0:getReportsResponse">
<selectItems>
<xsl:for-each select="return">
<selectItem>
<code>
<xsl:value-of select="."/>
</code>
<name>
<xsl:value-of select="."/>
</name>
</selectItem>
</xsl:for-each>
</selectItems>
</xsl:template>
</xsl:stylesheet>
</xsltTransformation>
</parameter>
<outputParameter parameterCode="requestId" parameterType="INTEGER"
order="1">
<name language="en" countryCode="US">Request Id</name>
<description language="en" countryCode="US">Job Request
Identifier</description>
</outputParameter>
</integrationStep>
<integrationStep interationTypeCode=”JOBCOMPLETIONSTATUSASYNC” sysAutType=”A”
serviceNamespace="http://reports.xyz.com"
ServiceWSDLLoc="http://rptsvr:80/reportingService/ReportService?WSDL"
serviceName="ReportService" servicePortType="ReportService"
serviceOperation="getCompletionStatus"
callbackPortType="ReportServiceCallback" callbackOperation="onJobCompletion">
<responseXSLTemplate>
<![CDATA[
<xsl:template match="return">
<fcmns1:TaskResult>
<fcmns1:Result>
<xsl:choose>
<xsl:when test="resultCode = 'Success'">Success</xsl:when>
<xsl:otherwise>Failure</xsl:otherwise>
</xsl:choose>
</fcmns1:Result>
<fcmns1:LogLocation>
<xsl:value-of select="resultLogPath"/>
</fcmns1:LogLocation>
<fcmns1:Messages>
<fcmns1:Message>
<fcmns1:Value>
<xsl:value-of select="resultMessage"/>
38
</fcmns1:Value>
</fcmns1:Message>
</fcmns1:Messages>
</fcmns1:TaskResult>
</xsl:template>
]]>
</responseXSLTemplate>
<name language="en"" countryCode="US">Get Completion Status</name>
<description language="en"" countryCode="US">Get Web Service Completion
Status</description>
<parameter parameterCode=”JobId" parameterType="INTEGER" order="1"
required="Y" excludeFromWebservice="N" hidden="N" outputParameterStep="
SUBMITTASKSYNC" outputParameterCode="requestId">
<name language="en">Job request Id</name>
<description language="en" countryCode="US">Job Request
Identifier</description>
</parameter>
</integrationStep> </integrationType>
<integrationType integrationTypeCode="VIEWREPORT" applicationCode="Sample"
executionType="U" userCreated="N"
endUserURL="http://rptsvr:80/reportingApp/ViewReport.jsp?reportName=$REPORTNAME$">
<name language="en" countryCode="US">Manage Documents</name>
<description language="en" countryCode="US">View Report UI Task</description>
<parameter parameterCode="REPORTNAME" required="Y"
parameterType="DYNLOV" order="1"
serviceWSDLLoc="http://rptsvr:80/reportingService/ReportListingService?WSDL"
serviceNamespace="http://reports.xyz.com" serviceName="ReportListingService"
servicePort="ReportListingServiceReportType"
serviceResponseElement="ns0:getReportsResponse" SOAPAction="getReports">
<name language="en" countryCode="US">Report Name</name>
<xsltTransformation>
<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
xmlns:ns0="http://reports.xyz.com" version="1.0">
<xsl:template match="ns0:getReportsResponse">
<selectItems>
<xsl:for-each select="return">
<selectItem>
<code>
<xsl:value-of select="."/>
</code>
<name>
<xsl:value-of select="."/>
</name>
</selectItem>
</xsl:for-each>
</selectItems>
</xsl:template>
</xsl:stylesheet>
39
</xsltTransformation>
</parameter>
</integrationType>
<integrationType integrationTypeCode="ImportRates" applicationCode="Sample"
executionType="S" userCreated="Y">
<integrationStep integrationTypeCode="submitRequest" sysAutType="S"
serviceNamespace="http://reports.xyz.com" serviceWSDLLoc=
“http://rptsvr:80/reportingService/ScheduleService?WSDL” serviceName="
ScheduleService" servicePortType="ScheduleService" serviceOperation="submitRequest"
requestNamespace="http://reports.xyz.com">
<requestTemplate>
<![CDATA[<ns1:submitRequest xmlns:ns1="http://reports.xyz.com">
<ns1:description>Import and Calculate Daily Rates</ns1:description>
<ns1:jobDefinitionId>
<ns2:name
xmlns:ns2="http://reports.xyz.com/types">DailyRatesImport</ns2:name>
<ns3:type
xmlns:ns4="http://xmlns.oracle.com/scheduler/types">JOB_DEFINITION</ns3:type>
</ns1:jobDefinitionId>
<ns1:application>Financials</ns1:application>
<ns1:requestedStartTime></ns1:requestedStartTime>
<ns1:requestParameters>
<ns5:parameter xmlns:ns5="http://xmlns.oracle.com/scheduler/types">
<ns5:dataType>STRING</ns5:dataType>
<ns5:name>$REQUEST_PARAM_NAME$</ns5:name>
<ns5:scope/>
<ns5:value>$REQUEST_PARAM_VALUE$</ns5:value>
</ns5:parameter>
</ns1:requestParameters>
</ns1:submitRequest>]]>
</requestTemplate>
<responseXSLTemplate>
<![CDATA[<xsl:stylesheet version="1.0"
xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
xmlns:ns0="/oracle/apps/epm/fcc/model/view/common/"
xmlns:tns="http://xmlns.oracle.com/scheduler/types"
exclude-result-prefixes="xsi xsl soap12 ns1 soap mime tns xsd client
plnk wsdl ns0 xp20 bpws bpel bpm ora socket mhdr oraext dvm hwf med ids xdk xref
ldap">
<xsl:template match="/">
<ns0:TaskResult>
<ns0:Result>
<xsl:text disable-output-escaping="no">Success</xsl:text>
</ns0:Result>
<ns0:Messages>
<ns0:Message>
<ns0:Value>
<xsl:value-of select="/tns:submitRequestResponse/requestId"/>
40
</ns0:Value>
</ns0:Message>
</ns0:Messages>
</ns0:TaskResult>
</xsl:template>
</xsl:stylesheet>]]>
</responseXSLTemplate>
<name language="da">submitRequest</name>
<name language="de">submitRequest</name>
<name language="en">submitRequest</name>
<name language="es">submitRequest</name>
<name language="fi">submitRequest</name>
<name language="fr">submitRequest</name>
<name language="it">submitRequest</name>
<name language="ja">submitRequest</name>
<name language="ko">submitRequest</name>
<name language="nl">submitRequest</name>
<name language="pl">submitRequest</name>
<name language="pt">submitRequest</name>
<name language="ru">submitRequest</name>
<name language="sv">submitRequest</name>
<name language="tr">submitRequest</name>
<name language="zh" countryCode="CN">submitRequest</name>
<name language="zh" countryCode="TW">submitRequest</name>
<parameter parameterCode="REQUEST_PARAM_NAME" parameterType="TEXT" order="1"
required="Y" excludeFromWebservice="N" hidden="N">
<name language="da">REQUEST_PARAM_NAME</name>
<name language="de">REQUEST_PARAM_NAME</name>
<name language="en">REQUEST_PARAM_NAME</name>
<name language="es">REQUEST_PARAM_NAME</name>
<name language="fi">REQUEST_PARAM_NAME</name>
<name language="fr">REQUEST_PARAM_NAME</name>
<name language="it">REQUEST_PARAM_NAME</name>
<name language="ja">REQUEST_PARAM_NAME</name>
<name language="ko">REQUEST_PARAM_NAME</name>
<name language="nl">REQUEST_PARAM_NAME</name>
<name language="pl">REQUEST_PARAM_NAME</name>
<name language="pt">REQUEST_PARAM_NAME</name>
<name language="ru">REQUEST_PARAM_NAME</name>
<name language="sv">REQUEST_PARAM_NAME</name>
<name language="tr">REQUEST_PARAM_NAME</name>
<name language="zh" countryCode="CN">REQUEST_PARAM_NAME</name>
<name language="zh" countryCode="TW">REQUEST_PARAM_NAME</name>
</parameter>
<parameter parameterCode="REQUEST_PARAM_VALUE" parameterType="TEXT"
order="2" required="Y" excludeFromWebservice="N" hidden="N">
<name language="da">REQUEST_PARAM_VALUE</name>
<name language="de">REQUEST_PARAM_VALUE</name>
41
<name language="en">REQUEST_PARAM_VALUE</name>
<name language="es">REQUEST_PARAM_VALUE</name>
<name language="fi">REQUEST_PARAM_VALUE</name>
<name language="fr">REQUEST_PARAM_VALUE</name>
<name language="it">REQUEST_PARAM_VALUE</name>
<name language="ja">REQUEST_PARAM_VALUE</name>
<name language="ko">REQUEST_PARAM_VALUE</name>
<name language="nl">REQUEST_PARAM_VALUE</name>
<name language="pl">REQUEST_PARAM_VALUE</name>
<name language="pt">REQUEST_PARAM_VALUE</name>
<name language="ru">REQUEST_PARAM_VALUE</name>
<name language="sv">REQUEST_PARAM_VALUE</name>
<name language="tr">REQUEST_PARAM_VALUE</name>
<name language="zh" countryCode="CN">REQUEST_PARAM_VALUE</name>
<name language="zh" countryCode="TW">REQUEST_PARAM_VALUE</name>
</parameter>
</integrationStep>
<name language="da">Import and Calculate Daily Rates</name>
<name language="de">Import and Calculate Daily Rates</name>
<name language="en">Import and Calculate Daily Rates</name>
<name language="es">Import and Calculate Daily Rates</name>
<name language="fi">Import and Calculate Daily Rates</name>
<name language="fr">Import and Calculate Daily Rates</name>
<name language="it">Import and Calculate Daily Rates</name>
<name language="ja">Import and Calculate Daily Rates</name>
<name language="ko">Import and Calculate Daily Rates</name>
<name language="nl">Import and Calculate Daily Rates</name>
<name language="pl">Import and Calculate Daily Rates</name>
<name language="pt">Import and Calculate Daily Rates</name>
<name language="ru">Import and Calculate Daily Rates</name>
<name language="sv">Import and Calculate Daily Rates</name>
<name language="tr">Import and Calculate Daily Rates</name>
<name language="zh" countryCode="CN">Import and Calculate Daily Rates</name>
<name language="zh" countryCode="TW">Import and Calculate Daily Rates</name>
<description language="da">Import daily rates, validates and imports
rates from interface table and creates and deletes data in daily rates
table</description>
<description language="de">Import daily rates, validates and imports
rates from interface table and creates and deletes data in daily rates
table</description>
<description language="en">Import daily rates, validates and imports
rates from interface table and creates and deletes data in daily rates
table</description>
<description language="es">Import daily rates, validates and imports
rates from interface table and creates and deletes data in daily rates
table</description>
42
daily
daily
daily
daily
<description language="fi">Import daily rates, validates and imports daily
rates from interface table and creates and deletes data in daily rates
table</description>
<description language="fr">Import daily rates, validates and imports daily
rates from interface table and creates and deletes data in daily rates
table</description>
<description language="it">Import daily rates, validates and imports daily
rates from interface table and creates and deletes data in daily rates
table</description>
<description language="ja">Import daily rates, validates and imports daily
rates from interface table and creates and deletes data in daily rates
table</description>
<description language="ko">Import daily rates, validates and imports daily
rates from interface table and creates and deletes data in daily rates
table</description>
<description language="nl">Import daily rates, validates and imports daily
rates from interface table and creates and deletes data in daily rates
table</description>
<description language="pl">Import daily rates, validates and imports daily
rates from interface table and creates and deletes data in daily rates
table</description>
<description language="pt">Import daily rates, validates and imports daily
rates from interface table and creates and deletes data in daily rates
table</description>
<description language="ru">Import daily rates, validates and imports daily
rates from interface table and creates and deletes data in daily rates
table</description>
<description language="sv">Import daily rates, validates and imports daily
rates from interface table and creates and deletes data in daily rates
table</description>
<description language="tr">Import daily rates, validates and imports daily
rates from interface table and creates and deletes data in daily rates
table</description>
<description language="zh" countryCode="CN">Import daily rates, validates and
imports daily rates from interface table and creates and deletes data in daily rates
table</description>
<description language="zh" countryCode="TW">Import daily rates, validates and
imports daily rates from interface table and creates and deletes data in daily rates
table</description>
</integrationType>
</integrationTypes>
Event Monitoring JMS Sample Integration XML
<?xml version="1.0" encoding="utf-8"?>
<integrationTypes>
<application applicationName="JMSEventMonitoring">
<parameter name="CONNECTION_FACTORY_JMS"></parameter>
<parameter name="QUEUE_NAME"></parameter>
43
</application>
<integrationType integrationTypeCode="JMSSampleEventMonitor"
applicationCode="JMSEventMonitoring" executionType="E" userCreated="N"
adapterName="JMSAdapter"
messageSelector="EVENT_NAME='JMSEventSample'">
<eventXSDTemplate>
<![CDATA[
<schema targetNamespace="http://xmlns.oracle.com/xdb/APPS/EventReceive"
xmlns="http://www.w3.org/2001/XMLSchema"
xmlns:APPS="http://xmlns.oracle.com/xdb/APPS/EventReceive"
elementFormDefault="unqualified" attributeFormDefault="qualified">
<complexType name="WF_EVENT_T">
<sequence>
<element name="PRIORITY" type="double" nillable="true" minOccurs="0"/>
<element name="SEND_DATE" type="string" nillable="true" minOccurs="0"/>
<element name="RECEIVE_DATE" type="string" nillable="true" minOccurs="0"/>
<element name="CORRELATION_ID" nillable="true" minOccurs="0">
<simpleType>
<restriction base="string">
<maxLength value="240"/>
</restriction>
</simpleType>
</element>
<element name="PARAMETER_LIST"
type="APPS:WF_PARAMETER_LIST_T" nillable="true" minOccurs="0"/>
<element name="EVENT_NAME" nillable="true" minOccurs="0">
<simpleType>
<restriction base="string">
<maxLength value="240"/>
</restriction>
</simpleType>
</element>
<element name="EVENT_KEY" nillable="true" minOccurs="0">
<simpleType>
<restriction base="string">
<maxLength value="240"/>
</restriction>
</simpleType>
</element>
<element name="EVENT_DATA" type="string" nillable="true" minOccurs="0"/>
<element name="FROM_AGENT" type="APPS:WF_AGENT_T"
nillable="true" minOccurs="0"/>
<element name="TO_AGENT" type="APPS:WF_AGENT_T"
nillable="true" minOccurs="0"/>
<element name="ERROR_SUBSCRIPTION" type="base64Binary"
nillable="true" minOccurs="0"/>
<element name="ERROR_MESSAGE" nillable="true" minOccurs="0">
44
<simpleType>
<restriction base="string">
<maxLength value="4000"/>
</restriction>
</simpleType>
</element>
<element name="ERROR_STACK" nillable="true" minOccurs="0">
<simpleType>
<restriction base="string">
<maxLength value="4000"/>
</restriction>
</simpleType>
</element>
</sequence>
</complexType>
<complexType name="WF_AGENT_T">
<sequence>
<element name="NAME" nillable="true" minOccurs="0">
<simpleType>
<restriction base="string">
<maxLength value="30"/>
</restriction>
</simpleType>
</element>
<element name="SYSTEM" nillable="true" minOccurs="0">
<simpleType>
<restriction base="string">
<maxLength value="30"/>
</restriction>
</simpleType>
</element>
</sequence>
</complexType>
<complexType name="WF_PARAMETER_T">
<sequence>
<element name="NAME" nillable="true" minOccurs="0">
<simpleType>
<restriction base="string">
<maxLength value="30"/>
</restriction>
</simpleType>
</element>
<element name="VALUE" nillable="true" minOccurs="0">
<simpleType>
<restriction base="string">
<maxLength value="2000"/>
</restriction>
</simpleType>
45
</element>
</sequence>
</complexType>
<complexType name="WF_PARAMETER_LIST_T">
<sequence>
<element name="PARAMETER_LIST_ITEM"
type="APPS:WF_PARAMETER_T" minOccurs="0"
maxOccurs="unbounded" nillable="true"/>
</sequence>
</complexType>
<element name="WF_EVENT_T" type="APPS:WF_EVENT_T"/>
</schema>
]]>
</eventXSDTemplate>
<eventTransformXLSTemplate>
<![CDATA[
<ns1:eventKey>
<xsl:value-of select="/imp1:WF_EVENT_T/EVENT_KEY"/>
</ns1:eventKey>
<ns1:eventName>
<xsl:value-of select="/imp1:WF_EVENT_T/EVENT_NAME"/>
</ns1:eventName>
<ns1:sendDate>
<xsl:value-of select="/imp1:WF_EVENT_T/SEND_DATE"/>
</ns1:sendDate>
<ns1:receiveDate>
<xsl:value-of select="/imp1:WF_EVENT_T/RECEIVE_DATE"/>
</ns1:receiveDate>
<ns1:fromAgentName>
<xsl:value-of select="/imp1:WF_EVENT_T/FROM_AGENT/NAME"/>
</ns1:fromAgentName>
<ns1:fromAgentSystem>
<xsl:value-of select="/imp1:WF_EVENT_T/FROM_AGENT/SYSTEM"/>
</ns1:fromAgentSystem>
<ns1:keyValue>
<xsl:value-of select="/imp1:WF_EVENT_T/EVENT_DATA"/>
</ns1:keyValue>
<ns1:fccEventMonitorResParamsCollection>
<xsl:for-each select="/imp1:WF_EVENT_T/PARAMETER_LIST/PARAMETER_LIST_ITEM">
<ns1:FccEventMonitorResParams>
<ns1:paramName>
<xsl:value-of select="NAME"/>
</ns1:paramName>
<ns1:paramValue>
<xsl:value-of select="VALUE"/>
46
</ns1:paramValue>
</ns1:FccEventMonitorResParams>
</xsl:for-each>
</ns1:fccEventMonitorResParamsCollection>
]]>
</eventTransformXLSTemplate>
<name
<name
<name
<name
<name
<name
<name
<name
<name
<name
<name
<name
<name
<name
<name
<name
<name
language="en"
language="fr"
language="de"
language="ja"
language="es"
language="ru"
language="ko"
language="zh"
language="zh"
language="sv"
language="tr"
language="it"
language="da"
language="pt"
language="fi"
language="nl"
language="pl"
<description
<description
<description
<description
<description
<description
<description
<description
<description
<description
<description
<description
<description
<description
<description
<description
<description
countryCode="US">JMS
countryCode="FR">JMS
countryCode="DE">JMS
countryCode="JP">JMS
countryCode="ES">JMS
countryCode="RU">JMS
countryCode="KR">JMS
countryCode="CN">JMS
countryCode="TW">JMS
countryCode="SE">JMS
countryCode="TR">JMS
countryCode="IT">JMS
countryCode="DK">JMS
countryCode="BR">JMS
countryCode="FI">JMS
countryCode="NL">JMS
countryCode="PL">JMS
language="en"
language="fr"
language="de"
language="ja"
language="es"
language="ru"
language="ko"
language="zh"
language="zh"
language="sv"
language="tr"
language="it"
language="da"
language="pt"
language="fi"
language="nl"
language="pl"
Event</name>
Event</name>
Event</name>
Event</name>
Event</name>
Event</name>
Event</name>
Event</name>
Event</name>
Event</name>
Event</name>
Event</name>
Event</name>
Event</name>
Event</name>
Event</name>
Event</name>
countryCode="US">JMS
countryCode="FR">JMS
countryCode="DE">JMS
countryCode="JP">JMS
countryCode="ES">JMS
countryCode="RU">JMS
countryCode="KR">JMS
countryCode="CN">JMS
countryCode="TW">JMS
countryCode="SE">JMS
countryCode="TR">JMS
countryCode="IT">JMS
countryCode="DK">JMS
countryCode="BR">JMS
countryCode="FI">JMS
countryCode="NL">JMS
countryCode="PL">JMS
Event
Event
Event
Event
Event
Event
Event
Event
Event
Event
Event
Event
Event
Event
Event
Event
Event
Monitoring</description>
Monitoring</description>
Monitoring</description>
Monitoring</description>
Monitoring</description>
Monitoring</description>
Monitoring</description>
Monitoring</description>
Monitoring</description>
Monitoring</description>
Monitoring</description>
Monitoring</description>
Monitoring</description>
Monitoring</description>
Monitoring</description>
Monitoring</description>
Monitoring</description>
<parameter parameterCode="EVENT_DATA" parameterType="TEXT" required="Y" order="1"
hidden="N">
<name language="da" countryCode="DK">EVENT_DATA</name>
47
<description language="da" countryCode="DK">Unique EVENT_DATA</description>
<name language="de" countryCode="DE">EVENT_DATA</name>
<description language="de" countryCode="DE">Unique EVENT_DATA</description>
<name language="en" countryCode="US">EVENT_DATA</name>
<description language="en" countryCode="US">Unique EVENT_DATA</description>
<name language="es" countryCode="ES">EVENT_DATA</name>
<description language="es" countryCode="ES">Unique EVENT_DATA</description>
<name language="fi" countryCode="FI">EVENT_DATA</name>
<description language="fi" countryCode="FI">Unique EVENT_DATA</description>
<name language="fr" countryCode="FR">EVENT_DATA</name>
<description language="fr" countryCode="FR">Unique EVENT_DATA</description>
<name language="it" countryCode="IT">EVENT_DATA</name>
<description language="it" countryCode="IT">Unique EVENT_DATA</description>
<name language="ja" countryCode="JP">EVENT_DATA</name>
<description language="ja" countryCode="JP">Unique EVENT_DATA</description>
<name language="ko" countryCode="KR">EVENT_DATA</name>
<description language="ko" countryCode="KR">Unique EVENT_DATA</description>
<name language="nl" countryCode="NL">EVENT_DATA</name>
<description language="nl" countryCode="NL">Unique EVENT_DATA</description>
<name language="pl" countryCode="PL">EVENT_DATA</name>
<description language="pl" countryCode="PL">Unique EVENT_DATA</description>
<name language="pt" countryCode="BR">EVENT_DATA</name>
<description language="pt" countryCode="BR">Unique EVENT_DATA</description>
<name language="ru" countryCode="RU">EVENT_DATA</name>
<description language="ru" countryCode="RU">Unique EVENT_DATA</description>
<name language="sv" countryCode="SE">EVENT_DATA</name>
<description language="sv" countryCode="SE">Unique EVENT_DATA</description>
<name language="tr" countryCode="TR">EVENT_DATA</name>
<description language="tr" countryCode="TR">Unique EVENT_DATA</description>
<name language="zh" countryCode="CN">EVENT_DATA</name>
<description language="zh" countryCode="CN">Unique EVENT_DATA</description>
<name language="zh" countryCode="TW">EVENT_DATA</name>
<description language="zh" countryCode="TW">Unique EVENT_DATA</description>
</parameter>
</integrationType>
</integrationTypes>
48
Financial Close Management 11.1.2.2.300 Enhancements
Support for Multiple Types of Web Services for System Automated Integration Type
Financial Close Management Release 11.1.2.2.300 now supports synchronous and polling web services
in addition to asynchronous web service, when defining a System Automated integration type. Refer to
section Web Services Supported by System Automated task
Support for Multiple Steps in a single System Automated Integration Type
Starting with Financial Close Management Release 11.1.2.2.300, Financial Close Management now
allows a System Automated integration type to consist of multiple web service calls of different types.
Each web service is a step in the entire automated process. An example use case is provided in the next
section that talks about support for output parameters.
Support for Output Parameters for System Automated Integration Type
Financial Close Management Release 11.1.2.2.300 now allows a System Automated integration type to
have output parameters defined in the integration type’s Parameter tab, in addition to the existing Input
parameters. This is particularly useful in a multiple step integration type, where-in the results of one
step can manipulate the process of subsequent steps.
Consider an example use case, where the first step kicks off a job, returning a job ID, and then the
second step monitors the job using the job ID. To handle this, each web service call can designate
output parameters, and the values of these output parameters can be passed as input parameters to
subsequent steps in the integration type. The supported output parameters are of type Text, Integer
and Number. The values of the output parameters are depicted in Financial Close Management’s Task
Actions dialog.
For the above use case the integration type will be a System Automated integration type that consists of
two steps:
Step 1: The first step is called Submit Job, and it will invoke a synchronous web service that
accepts a few standard input parameters such as Job Name, Job Description, and Job Task. It
has one output parameter, Job ID that is an integer.
Step 2: The second step is Process Job, which will invoke an asynchronous web service that
accepts Job ID as its only parameter. The web service will return once the job identified by Job
ID completes, successfully or in error. It has no formal output parameters.
Generate XSD Button for System Automated Integration Type
To assist in creating a transformation to include the output parameters, there is a Generate XSD button
in the New Integration Type dialog that generates the XSD response that the XML needs to be
transformed to, for Financial Close Management to read.
Support for Complex Parameter Types for System Automated Integration Type
Prior to Financial Close Management Release 11.1.2.2.300, there was no support for complex parameter
types, and mainly supported parameter types given here.
49
Consider for example an external web service call that requires parameters of the form given below:
<ns1:submitRequest xmlns:ns1="http://xmlns.oracle.com/scheduler">
<ns1:description>Import and Calculate Daily Rates</ns1:description>
<ns1:jobDefinitionId>
<ns2:name
xmlns:ns2="http://xmlns.oracle.com/scheduler/types">DailyRatesImport</ns2:name>
<ns3:packageName
xmlns:ns3="http://xmlns.oracle.com/scheduler/types">oracle/apps/ess/financials/generalLedger/progr
ams/common</ns3:packageName>
<ns4:type xmlns:ns4="http://xmlns.oracle.com/scheduler/types">JOB_DEFINITION</ns4:type>
</ns1:jobDefinitionId>
<ns1:application>FinancialsEss</ns1:application>
<ns1:requestedStartTime></ns1:requestedStartTime>
<ns1:requestParameters>
<ns5:parameter xmlns:ns5="http://xmlns.oracle.com/scheduler/types">
<ns5:dataType>STRING</ns5:dataType>
<ns5:name>$REQUEST_PARAM_NAME$</ns5:name>
<ns5:scope/>
<ns5:value>$REQUEST_PARAM_VALUE$</ns5:value>
</ns5:parameter>
</ns1:requestParameters>
</ns1:submitRequest>
Here, submitRequest is a complexType that has its own namespace and child elements. In order to
transform such input from Financial Close Management, to that required for the web service call to
understand, the following approach is to be followed in New Integration type dialog
1. Enclose the parameters to the web service call between $ sign. For example in this case
REQUEST_PARAM_NAME and REQUEST_PARAM_VALUE
2. The Request Template attribute should be filled with above transform
50
3. Create corresponding two Financial Close Management Integration type parameters in the
Parameter tab of type Text since, dataType in above call is of type STRING
4. During runtime, the Financial Close Management takes this message and replaces the $
REQUEST_PARAM_NAME $ with the input parameter value for REQUEST_PARAM_NAME and so
on. And use the resulting message while invoking the external web service.
5. Care needs to be taken while defining the parameter tokens exactly as strings you used between
$ character.
Copyright © 2012, Oracle and / or its affiliates. All rights reserved.
http://www.oracle.com
51
