3 Discovering Business Object Services

This section describes how to use the Oracle Enterprise Repository, Developer Connect, and Service Catalog Service to discover and learn more about the business object services.

Topics:

Methods for Discovering Public External SOAP Services

There are three ways of discovering public external Simple Object Access Protocol (SOAP) services in Oracle Fusion Applications in Oracle Applications Cloud Services:

  • OER (Oracle Enterprise Repository)

  • Developer Connect

  • Service Catalog Service

The following table summarizes the key differences between OER, Developer Connect, and Service Catalog Service.

Feature Description OER Developer Connect Service Catalog Service
Location where hosted or deployed Hosted at http://fusionappsoer.oracle.com Provisioned on the cloud instance. Available only for Oracle Sales Cloud. Provisioned on the cloud instance
Contents Provides information for public external services, as well as public internal services (for on-premises use only), in Fusion Applications and for multiple base releases. Does not reflect assets delivered in patches. Provides public external service information for the specific cloud instance. Reflects new services introduced in patches and customizations. Provides public external service information for the specific cloud instance. Reflects new services introduced in patches and customizations.
Interface User interface only User interface only Web service only

Using the Oracle Enterprise Repository (OER)

Topics

The Oracle Enterprise Repository (OER) is a hosted repository of assets which describe artifacts in Oracle Fusion Applications for several base releases. In addition to the public external SOAP services that Oracle partners and customers can invoke for a particular release using Oracle Fusion Applications in Oracle Applications Cloud Services, OER includes assets that are applicable only to on-premises customers. It is important to be able to distinguish between those assets.

Searching for Public External Services

To identify the public external services that can be invoked by Oracle partners and customers:

  1. Navigate to https://fusionappsoer.oracle.com

    Description of oer_search.png follows
    Description of the illustration oer_search.png

  2. Click More Search Options.

    A secondary window with search criteria opens.

  3. For Type, specify ADF Service.

    This search criteria ensures that the search returns only business object services.

  4. Select Filter by Additional Criteria.

  5. In Select a Field choose Keywords, then choose Equals for the operator, then enter EXTERNAL and click Add.

    By specifying EXTERNAL as a keyword, this ensures that the public external services are returned and ignores ones which are relevant only for on-premises customers. For web services you need that are not available to you, submit a support request at My Oracle Support.

  6. In Select a Field choose Version, then choose Equals for the operator, then enter the appropriate Fusion Applications release and click Add. This criteria ensures the asset for the relevant release is returned.

    For instructions on determining the version of Oracle Fusion Applications on the cloud instance, see Appendix A.

  7. In Select a Field choose Product Families, then choose Equals for the operator, then choose the relevant family and click Add.

    For example, selecting Sales as the product family will return the services related to Customer Relationship Management (CRM). By not specifying this criteria, the search will return all public external services for Oracle Fusion Applications, some of which may not be provisioned on a cloud instance.

  8. Click Search.

    The search window remains open and the results are rendered in the main window.

    This graphic shows OER search results
  9. Navigate back to the main OER window which should show the results of the search criteria.

    The results should look like the following sample screen.

    Description of oer_search_results.png follows
    Description of the illustration oer_search_results.png

  10. Click the icon for any of the services that appear in the top right frame of the main OER window to view details of the service.

Note:

If using the main OER window to search by specifying EXTERNAL in the field instead of the More Search Options window, the search results will include assets with external in the asset description. To ensure that a particular service returned in the result is a public external service, navigate to the Taxonomy tab of the main OER window to confirm that EXTERNAL is specified as a keyword. For more information on the keyword field, see Taxonomy Tab.

Understanding the Business Object Service Metadata in OER

Topics

This section provides information about the business object service metadata in OER. It applies to the ADF Service and ADF Service Data Object assets in OER.

Business Object Service (ADF Service) Assets

The business object service corresponds to the ADF Service asset type. Information for the asset type is presented under several tabs in OER. This section describes the contents of each tab that appears at the top of the asset documentation and points out information relevant for Oracle Fusion Applications in Oracle Applications Cloud Services.

The following screen shows the Opportunity Service in OER:

This figure shows the Opportunity Service in OER window

Overview Tab

This tab describes service and information about the service life cycle and compatibility.

Field Description
Description Provides a general overview of the service and may contain details about service usage and related services.
Internal Name Unique identifier for the ADF service asset in OER.
Life Cycle Indicates whether the service is active or deprecated. Valid values are Active and Deprecated. The field will never contain the value Obsolete because obsolete services are no longer shipped or documented in OER. For more details on the service life cycle phases, see About Web Service Life Cycle.
Compatibility Contains two pieces of information: supportability and backward compatibility. All public external services are supported and are guaranteed to only contain backward compatible changes in upgrades and patches. For more information on supportability, see About SOAP Service Support. For more information on backward compatibility, see About Backward Compatibility.

Detail Tab

This tab contains information about the operations, tokenized service WSDL, and link to the service abstract WSDL:

Field Description
Operations Lists the names of the operations exposed in the service interface exposed on the business object. The following information is provided for each operation
  • Method Name: Name of the operation as it is defined in the WSDL.

  • Description: Provides a general overview of the operation.

  • Parameters: The following information is provided for each parameter in the request and response payload.

    • Parameter Name

    • Description

    • Is Return. If yes, then the parameter is in the response payload. Otherwise, it is in the request payload.

    • Is Mandatory. If yes, then the parameter in the request payload is mandatory. Otherwise, it is optional.

    • Type

  • Name of the corresponding asynchronous operation and callback. The business object services support both synchronous and asynchronous messages patterns for each operation. Other than the difference in the message pattern, the behavior and parameters of the synchronous and asynchronous versions are the same.

  • Life cycle. Contains values Active and Deprecated, similar to the life cycle of the business object service. If the value is blank, then the value is inherited from the life cycle of the business object service. For deprecated operations, refer to the operation descriptions for more information on replacement operations.

Service Path Contains the tokenized URL for the concrete service WSDL from an Oracle partner's or customer's cloud instance. For example:
https://<crm_server:PortNumber>/opptyMgmtOpportunities/OpportunityService?WSDL

The content of the concrete WSDL is described in Service WSDL. To derive the URL for the service end point and concrete WSDL on a particular cloud instance, follow the instructions in Deriving the Business Object Service Endpoint and WSDL.

Abstract WSDL URL The abstract WSDL is similar to the concrete WSDL but excludes the binding and service elements which contain specifics about the transport protocol and particular deployment of the service. The abstract service WSDL is hosted on OER and does not point to the abstract WSDL on a particular cloud instance.

Don't reference this WSDL in your client, instead reference the concrete WSDL in your cloud instance. This link is provided only as a quick reference.

Refer to the Service Path description in this table for information on deriving the concrete WSDL URL for a particular cloud instance.


Taxonomy Tab

This tab includes the Asset Type, Relationships, Keywords, Product Families, and Logical Business Objects metadata.

This graphic shows the Taxonomy tab metedata types
Field Description
Asset Type The Asset Type value is set to ADF Service. This indicates that it is a web service and is implemented using Application Developer Framework (ADF).
Relationships Describes the relationships between the business object service with other business object services and service data objects (ADF service data objects). Specifically the following lists relationship types, their relationship target object type, and a description:
  • Handles. A Service Data Object. The business object on which this service is defined is composed of a hierarchy of service data objects. For example, the Opportunity Service is defined on the opportunity business object which includes the Opportunity entity, the Opportunity Contact entity, and other entities.

    This is a flattened list of all service data objects being referenced by the service. To derive the hierarchy of service data objects, refer to the asset corresponding to the service data objects and traverse the Contains relationships defined on the entity. The Contains relationship is described in the section on Service Data Objects.

  • Next version is. A Business Object Service. This service is superseded by the service described in the relationship target. For example, the next version of the Marketing Budget Service is Marketing Budget Service Version 2.

  • Previous service is. A Business Object Service. This service supersedes another service. For example, the previous version of the Sales Lead Service Version 2 is Sales Lead Service.

Keywords The EXTERNAL keyword indicates that the service can be invoked by Oracle partners and customers. Conversely, the services without the EXTERNAL keyword cannot be invoked by Oracle partners and customers.
Product Families A high-level grouping of related Fusion Applications products. For the Oracle Sales Cloud, for example, the Sales product family and Incentive Compensation product family are the relevant values. Note that public external services owned by other product families may be provisioned on the Oracle Sales Cloud instance due to dependencies on the J2EE applications owned by other product families. To get a complete list of provisioned public external services on the cloud instance, use the Service Catalog Service.
Logical Business Area A hierarchical grouping of related assets by functional area. Because the grouping reflects a classification system that is not commonly used across the industry, it may not be relevant to the cloud partner and customer.
Logical Business Object The business object that this service defines. The service data object may define the business object itself or only a part of the business object. Examples include Opportunity, Partner, and Sales Revenue. Specify a logical business object as a search criteria in OER to find web services that operate on the logical business object.

The logical business objects are grouped into related objects which are in turn grouped into higher-level related objects. For example, the Opportunity Service logical business object contains the following value:

CRM : Opportunity Management : Opportunity

This example value means the service operates on the Opportunity object. The Opportunity object is grouped into a related set of objects called Opportunity Management, which in turn is grouped into a larger set of related objects called CRM (Customer Relationship Management). Other logical business objects included in the Opportunity Management grouping are Sales Method and Sales Revenue. Other logical business object groups in CRM are Lead Management and Partner Management.

Some assets may have a separate entry for the higher-level grouping. These can be ignored because they are redundant. For example, the Marketing Campaign Service lists the following values:

CRM
CRM:Marketing
CRM:Marketing:Marketing Campaign

Documentation Tab

This tab includes the Service Invocation and Reference XSD sections. The Service Invocation section contains a link to a document that consolidates the information about the specific ADF Service asset and includes service invocation information

The Reference XSD is a list of service XSD and the service data object XSDs with links to the XSD contents. For example, the links in the following Referenced XSD window view are provided for the Opportunity Service. When viewing the Reference XSD, click the File Name links to view the XML schema definition for the service operation payloads and service data object.

Window view of Reference XSD links

Privileges Tab

This tab contains information about the privileges, also known as entitlements, to invoke the service operations, and the duty roles which have the privilege granted to them.

This graphic shows the Privileges tab sections
Privileges Description
Privileges This table maps the service operation to the privilege that can execute the operation.

For example, in the Partner Program Service, the privilege with the name ZPM_MAINTAIN_PARTNER_PROGRAM_PRIV in the first column has execute privileges for all of the operations listed in the last column.

It is possible to have more than one privilege with execute privileges on a particular operation. In that scenario, the operation name is listed in the last column for more than one row.

Privilege to Duty Roles Mapping This table shows the duty roles that are granted the particular privileges listed in the Privileges table.

For example, for the Partner Program Service, the ZPM_MAINTAIN_PARTNER_PROGRAM_PRIV privilege is granted to the ZPM_PARTNER_PROGRAM_MAINTAIN_DUTY duty role. This means that a user who is assigned to a job role which is granted the duty role ZPM_PARTNER_PROGRAM_MAINTAIN_DUTY has execute privileges on the getPartnerProgram, findPartnerProgram, and updatePartnerProgram operations and the corresponding asynchronous operations.

Duty Roles to Duty/Job Roles Mapping If the duty role in the Privilege to Duty Roles Mapping table is granted to another duty role, then the Duty Roles to Duty/Job Roles Mapping table is included in this tab. Otherwise, the table is not rendered.

For example, for the Partner Program Service, the ZPM_PARTNER_PROGRAM_MAINTAIN_DUTY duty role is granted to three other duty roles. This means that a user who is assigned to a job role which is granted any of the three duty roles listed in the table below (OKC_MANAGE_PROGRAM_SETUP_DUTY_CRM, OKC_PARTNER_PROGRAM_CONTRACT_ASSOCIATION_DUTY_CRM, and OKC_PROGRAM_QUESTIONNAIRE_RESPONSE_DUTY_CRM) has execute privileges on the getPartnerProgram, findPartnerProgram, and updatePartnerProgram operations and the corresponding asynchronous operations.


Service Data Object (ADF Service Data Object) Assets

The service data object information is captured in ADF Service Data Object assets. The information is presented under several tabs in OER. Users typically navigate to the service data object asset through the Handles relationship in the Taxonomy tab of the ADF service asset. Alternately, users can specify the Service Data Object as the type, and the name of the service data object and the version of Oracle Fusion Applications as the search criteria in OER.

This section describes the contents of each tab that appears at the top of the asset and points out the information that is relevant for Oracle Fusion Applications in Oracle Applications Cloud Services.

Description of adf_sdo_tabs.png follows
Description of the illustration adf_sdo_tabs.png

Overview Tab

This tab includes the service data object Description field. The Internal Name and Files fields are not relevant to Oracle Fusion Applications in Oracle Applications Cloud Services.

Field Description
Description Provides an overview description of the services data object.

Detail Tab

This tab contains information about the service data object attributes.

Field Description
Attributes Lists the names of the attributes which define the service data object. The following information is provided for each attribute:
  • Name.

  • Description.

  • Type. This is the type of the attribute represented as a Java class. To learn more about the data types for a service data object attribute, see the Data Types section in Understanding a Business Object Service.

  • Is Key. If yes, then the attribute is a primary key. Otherwise, the attribute is not a primary key.


Taxonomy Tab

This tab includes the Asset Type, Relationships, Product Families, Logical Business Area and Logical Business Object.

Field Description
Asset Type The Asset Type value is set to ADF Service Data Object. This indicates that the service data object is implemented using the ADF framework, and is part of an ADF service interface definition.
Relationships Describes the relationship between the service data object with other service data objects and business object services. Specifically the following lists relationship types, their relationship target object type, and a description:
  • Contained by. A Service Data Object. This is the reverse relationship of Contains.

  • Contains. A Service Data Object. This service data object includes a direct reference to the service data object described in the relationship target. The entity has an attribute which has a type based on the service data object in the relationship target.

    Tor example, the entity Opportunity contains Opportunity Contact.

  • Extended by. A Service Data Object. This is the reverse relationship of Extends.

  • Extends. A Service Data Object. This service data object is a subclass of the entity defined in the relationship target.

    For example, Expertise extends Partner Generic List of Values by adding two additional attributes: Expertise Code and Expertise Name.

  • Handled by. A Business Object Service. This is the reverse relationship of Handles described in the Relationships section for Business Object Service assets.

Product Families A high-level grouping of related Fusion Applications products. For the Oracle Sales Cloud, for example, the Sales product family and Incentive Compensation product family are the relevant values. Note that public external services owned by other product families may be provisioned on the Oracle Sales Cloud instance due to dependencies on the J2EE applications owned by other product families. To get a complete list of provisioned public external services on the cloud instance, use the Service Catalog Service.
Logical Business Area A hierarchical grouping of related assets by functional area. Because the grouping reflects a classification system that is not commonly used across the industry, it may not be relevant to the cloud partner and customer.
Logical Business Object The business object that this service data object defines. The service data object may define the functional business object itself or only a part of the functional business object. Examples include Opportunity, Marketing Campaign, and Sales Forecast. Specify a logical business object as a search criteria in OER to find web services that operate on the logical business object.

The logical business objects are grouped into related objects which are in turn grouped into higher-level related objects. For example, the Opportunity Service logical business object contains the following value:

CRM : Opportunity Management : Opportunity

This example value means the service operates on the Opportunity object. The Opportunity object is grouped into a related set of objects called Opportunity Management, which in turn is grouped into a larger set of related objects called CRM (Customer Relationship Management). Other logical business objects included in the Opportunity Management grouping are Sales Method and Sales Revenue. Other logical business object groups in CRM are Lead Management and Partner Management.

Some assets may have a separate entry for the higher-level grouping. These can be ignored because they are redundant. For example, the Marketing Campaign Service lists the following values:

CRM
CRM:Marketing
CRM:Marketing:Marketing Campaign

Using Developer Connect

Topics:

You can use Developer Connect, a portal available in Oracle Sales Cloud, to discover business object services which can be invoked as part of your Oracle Sales Cloud integration, to look up service endpoints, and to view service data object metadata and customizations. Because the portal runs on your cloud instance, it contains information about the specific set of services deployed to your cloud instance and reflects the current service interface (including any patches and customizations). To browse through the list of services, or search for a specific service, you enter search criteria in the Find field and click the search icon.

The advantages of using Developer Connect over Oracle Enterprise Repository (OER) are:

  • The portal displays information about services deployed to your cloud instance, instead of a static list of services

  • The portal reflects service data object customizations, instead of static service metadata

  • The portal displays the service endpoints, instead of requiring the developer to manually derive the endpoints

  • The portal contains content for cloud customers, instead of displaying a mix of services for both cloud and on-premises customers

Developer Connect and the Service Catalog Service are intended for two different purposes. Developer Connect provides a user interface and is intended to be used by a developer for service discovery. The Service Catalog Service, on the other hand, provides an API for discovering services programmatically.

Graphic shows the Developer Connect portal

Prerequisites

To use Developer Connect:

  1. Grant one of the following roles to the users who want to access Developer Connect:

    • FND_INTEGRATION_SPECIALIST_JOB

    • FND_APPLICATION_DEVELOPER_JOB

    • ZCA_CUSTOMER_RELATIONSHIP_MANAGEMENT_APPLICATION_ADMINISTRATOR_JOB

    Alternately, grant the ATK_WEB_SERVICE_INFO_ACCESS_PRIV entitlement to your custom role, and grant the custom role to the users. For more information, see the Sales Cloud security guides at http://docs.oracle.com/cloud/latest/salescs_gs/salescs_secure.htm">>http://docs.oracle.com/cloud/latest/salescs_gs/salescs_secure.htm.

  2. Log in to your cloud instance, click Navigator, then click Tools, then click Developer Connect.

    If this is the first time Developer Connect is used on your cloud instance, you will not see any web service information in the portal, and the "Last Refreshed: No Date Yet" message appears under the Synchronize button.

  3. Click Synchronize to synchronize the service information in Developer Connect.

    Once the synchronization completes, you can see the list of web services deployed to your cloud instance.

Understanding the Business Object Service Metadata in Developer Connect

This section describes the business object service information displayed in Developer Connect. Information is displayed across five tabs:

Summary Tab

The summary tab contains high-level information about a service.

Graphic shows the Summary tab
Field Description
Name The service display name.
Business Object The business object that this service defines. Examples include Opportunity, Partner, and Sales Revenue.
Life Cycle Indicates whether the service is active or deprecated. Valid values are Active and Deprecated. For more details on the service life cycle phases, see About Web Service Life Cycle.

If the life cycle is deprecated, then the service that supersedes the deprecated service is displayed.

QName The fully qualified name of the service.
End Point URL The end point URL for the service deployed on your Oracle cloud instance.
WSDL File The concrete WSDL for the service deployed on your Oracle cloud instance.
Security Policy The Oracle Web Services Manager (OWSM) policy used on the server side (service).
Description A brief overview of the service.

Operations Tab

The operations tab lists the names of the operations defined in the service interface.

Graphic shows the Operations tab
Field Description
Name The operation name. Although business object services support both synchronous and asynchronous messages patterns for each operation, only the synchronous operation is displayed in this screen. Other than the difference in the message pattern, the behavior and parameters of the synchronous and asynchronous versions are the same.

Click the link to view the following information about the request and response payload elements:

  • Name: The payload element name.

  • Data Type: The payload data type. If the data type is a service data object, then click the link to see details on the service data object.

  • Description: The description of the payload element.

Life Cycle Contains the value Active or Deprecated, similar to the life cycle of the business object service.
Description Provides a general overview of the operation.

Service Data Object Tab

The service data object tab renders the service data object hierarchy in a tree structure, and displays information about each of the service data objects and their attributes.

Graphic shows the Service Data Objects tab
Field Description
Service Data Objects Display name of the service data object.
QName The fully qualified name of the service data object.
State Indicates whether the service data object is defined by Fusion Applications or a custom object defined by the customer. Valid values are Standard and New, respectively.
Description A brief overview of the services data object.
Attributes Lists the attributes that define the service data object. The following information is provided for each attribute:
  • Name: The attribute name.

  • Data Type: The attribute type. To learn more about the data types for a service data object attribute, see About Datatypes.

  • State: Indicates whether the attribute is defined by Fusion Applications or a custom attribute defined by the customer. Valid values are Standard and New, respectively.

  • Required: Indicates whether the attribute is required.

  • Description: Provides a brief overview of the attribute.


Security Tab

The security tab lists the service operations and the privileges, also known as entitlements, to invoke the corresponding service operations. To view the privilege defined for that operation, you enter the name of the operation in the field above the "Operation Name" label.

Graphic shows the Security tab
Field Description
Operation Name The operation name.
Privilege The name of the privilege with execute action on the operation
Name The display name of the privilege.
Description The description of the privilege.

Sample Payloads Tab

The Sample Payloads tab displays payloads seeded by Fusion Applications or by the customer. Payloads seeded by Fusion Applications cannot be modified or deleted, but payloads uploaded by users can be modified or deleted. Users can upload sample payloads to share with other developers working on the Oracle Sales Cloud integration.

Graphic shows the Sample Payloads tab
Field Description
Operation Name The operation name.
PayloadXML The link to download the sample payload in XML format.
Description A brief description of the sample payload.

Using the Service Catalog Service

Topics:

Getting Endpoint and Metadata

You can use the Service Catalog Service to get the endpoint and metadata for public external services on the cloud instance where the Service Catalog Service is provisioned. The information it returns is specific to the particular cloud instance and reflects new services which may have been introduced in patches applied to the instance. Oracle partners and customers can use this service to programmatically discover the SOAP services available on the cloud instance and retrieve the necessary metadata to invoke the SOAP services to manage business objects.

The following URL is the tokenized WSDL for the Service Catalog Service. For instructions on resolving the tokens atf_server and PortNumber, see Deriving the Business Object Service Endpoint and WSDL.

https://atf_server:PortNumber/fndAppCoreServices/ServiceCatalogService

The following sections provide information about the operations defined on the service and shows sample request and response payloads for the operations. For more information on the Service Catalog Service, review the documentation in OER by searching for Service Catalog Service.

The service is secured using the following security policy and can be invoked by any authenticated user: oracle/wss11_saml_or_username_token_with_message_protection_service_policy

The service exposes two synchronous operations: getAllServiceEndpoints Operation and getServiceEndpoint Operation.

getAllServiceEndpoints Operation

The Service Catalog Service returns information about all public external services except for the following exceptions:

  • Public external composite services

  • Public external Fusion Middleware services such as the Service Catalog Service itself

The following information is returned for each public external service:

  • QName. The QName uniquely identifies the service. The following is the QName for the Opportunity Service:

    {http://xmlns.oracle.com/apps/sales/opptyMgmt/opportunities/opportunityService/}OpportunityService
    
  • Logical business object. The business object which the service implements. If the service does not operate on a business object then this is null. The logical business object for the Opportunity Service is:

    CRM-CRM : MOO-Opportunity Management : MOO_OPPORTUNITY-Opportunity
    

    The value in this field represents a hierarchy of logical business objects where the most general object is to the left and the most specific is to the right. Each node in the hierarchy is separated by a colon. In the previous example, Opportunity is the most specific business object and is grouped in the Opportunity Management object, which in turn is grouped in the CRM business object.

    Each node in the hierarchy is represented by two strings separated by a dash character. The string to the left of the dash is an internal string and the string to the right of the dash is a user friendly string.

    If displaying this information in a user interface, then consider rendering the following as the business object:

    • The hierarchy of objects with just the user friendly strings. For example: CRM : Opportunity Management : Opportunity

    • The most specific object with just the user friendly strings. For example: Opportunity

  • Life cycle. See About Web Service Life Cycle.

  • Service WSDL URL. This is the concrete WSDL URL for the service, and is the equivalent to the service path field in OER with the tokens replaced with the external virtual host and port. The following is an example URL for the Opportunity Service:

    https://crm-your-cloud-hostname:port/opptyMgmtOpportunities/OpportunityService?WSDL
    
  • Service XSD URL. This is the URL to the XSD which contains the service operation payload types, also referred to as the service XSD, described in Service XSD. The following is an example URL for the Opportunity Service:

    https://crm-your-cloud-hostname:port/opptyMgmtOpportunities/OpportunityService?
    XSD=/oracle/apps/sales/opptyMgmt/opportunities/opportunityService/OpportunityService.xsd
    

    Note that the contents of concrete service WSDLs and XSDs returned by the ServiceCatalogService contain more information about the corresponding services. The information is captured in the <wsdl:documentation> tag at the top of each WSDL and XSD.

Operation Signature

The following is the getAllServiceEndPoints request payload.

<element name="getAllServiceEndPoints">
     <complexType>
         <sequence/>
     </complexType>
</element>

The following is the getAllServiceEndPoints response payload.

<element name="getAllServiceEndPointsResponse">
     <complexType>
         <sequence>
            <element name="result" type="ns1:CatalogService" minOccurs="0
            maxOccurs="unbounded" />
         </sequence>
    </complexType>
</element>

Example

The following sample request payload for the getAllServiceEndpoints operation is empty.

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
     <soap:Body>
         <ns1:getAllServiceEndPoints
         xmlns:ns1="http://xmlns.oracle.com/oracle/apps/fnd/applcore/
         webservices/types/">
         </ns1:getAllServiceEndPoints>
     </soap:Body>
</soap:Envelope>

The response payload contains the service information for all public external services on the cloud instance. Because this response is large, only the first two result elements are displayed here.

<env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
     <env:Header/>
     <env:Body>
         <ns0:getAllServiceEndPointsResponse 
         xmlns:ns0="http://xmlns.oracle.com/oracle/apps/fnd/applcore/webservices/types/">
              <ns0:result xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
              xsi:type="ns0:CatalogService">
                  <ns0:qName>{http://xmlns.oracle.com/apps/crmCommon/activities/}
                  activitiesService/ActivityTaskService</ns0:qName>
                 <ns0:lbo xsi:nil="true"/>
                 <ns0:lifecycle>Deprecated</ns0:lifecycle>
                 <ns0:xsdLocation>https://crm-your-cloud-hostname:port/appCmmnCompActivities/
                 ActivityTaskService?XSD=/oracle/apps/crmCommon/activities/
                 activitiesService/ActivityTaskService.xsd</ns0:xsdLocation>
                 <ns0:wsdlAddress>https://crm-your-cloud-hostname:port/appCmmnCompActivities/
                 ActivityTaskService?WSDL</ns0:wsdlAddress>
             </ns0:result>
             <ns0:result xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
             xsi:type="ns0:CatalogService">
                <ns0:qName>{http://xmlns.oracle.com/apps/crmCommon/
                bulkExport/bulkExportServiceV2/}BulkExportService</ns0:qName>
                <ns0:lbo xsi:nil="true"/>
                <ns0:lifecycle>Active</ns0:lifecycle>
                <ns0:xsdLocation>https://crm-your-cloud-hostname:port/crmCommonBulkExport/
                BulkExportService?XSD=/oracle/apps/crmCommon/bulkExport/
                bulkExportServiceV2/BulkExportService.xsd</ns0:xsdLocation>
                <ns0:wsdlAddress>https://crm-your-cloud-hostname:port/
                crmCommonBulkExport/BulkExportService?WSDL</ns0:wsdlAddress>
            </ns0:result>
            ...
        </ns0:getAllServiceEndPointsResponse>
    </env:Body>
</env:Envelope>

getServiceEndpoint Operation

The getServiceEndpoint operation returns the endpoint and metadata for a particular public external service.

Operation Signature

The following is the getServiceEndPoint request payload:

<element name="getServiceEndPoint">
     <complexType>
         <sequence>
             <element name="qname" type="string"/>
         </sequence>
     </complexType>
</element>

The following is the getServiceEndPoint response payload:

<element name="getServiceEndPointResponse">
     <complexType>
         <sequence>
             <element name="result" type="ns1:CatalogService"/>
         </sequence>
     </complexType>
</element>

Example

The following example request payload is requesting for the endpoint and metadata for the Opportunity Service which has a QName of {http://xmlns.oracle.com/apps/sales/opptyMgmt/opportunities/opportunityService/}OpportunityService.

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
     <soap:Body>
         <ns1:getServiceEndPoint 
         xmlns:ns1="http://xmlns.oracle.com/oracle/apps/fnd/applcore/
         webservices/types/">
         <ns1:qname>{http://xmlns.oracle.com/apps/sales/opptyMgmt/
         opportunities/opportunityService/}OpportunityService</ns1:qname>
         </ns1:getServiceEndPoint>
     </soap:Body>
</soap:Envelope>

The response contains the endpoint and metadata information for the Opportunity Service provisioned on the cloud instance where the ServiceCatalogService is running.

<env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
     <env:Header/>
     <env:Body>
         <ns0:getServiceEndPointResponse 
         xmlns:ns0="http://xmlns.oracle.com/oracle/apps/fnd/applcore/
         webservices/types/">
             <ns1:result
             xmlns:ns1="http://xmlns.oracle.com/oracle/apps/fnd/applcore/
             webservices/types/"
             xmlns:ns0="http://xmlns.oracle.com/oracle/apps/fnd/applcore/webservices/"
             xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
             xsi:type="ns0:CatalogService">
                <ns0:qName>{http://xmlns.oracle.com/apps/sales/opptyMgmt/opportunities/
                opportunityService/}OpportunityService</ns0:qName>
                <ns0:lbo>CRM-CRM : MOO-Opportunity Management : MOO_OPPORTUNITY-Opportunity
                </ns0:lbo>
                <ns0:lifecycle>Active</ns0:lifecycle>
                <ns0:xsdLocation>https://crm-your-cloud-hostname:port/opptyMgmtOpportunities/
                OpportunityService?XSD=/oracle/apps/sales/opptyMgmt/opportunities/
                opportunityService/OpportunityService.xsd</ns0:xsdLocation>
                <ns0:wsdlAddress>https://crm-your-cloud-hostname:port/
                opptyMgmtOpportunities/OpportunityService?WSDL</ns0:wsdlAddress>
            </ns1:result>
        </ns0:getServiceEndPointResponse>
    </env:Body>
</env:Envelope>

Deriving the Business Object Service Endpoint and WSDL

This section describes how to derive the external virtual host and port for a tokenized service WSDL.

Service path from OER:

https://domainName_server:PortNumber/contextRoot/serviceName?WSDL

Opportunity Service example:

https://crm_server:PortNumber/opptyMgmtOpportunities/OpportunityService?WSDL

The topology information in the Topology Registration setup task contains the external virtual host and port for the domains and applications. The following procedure goes through the steps to derive the values using the Service Catalog Service WSDL URL as an example:

https://atf_server:PortNumber/fndAppCoreServices/ServiceCatalogService

Prerequisites

To access the Review Topology page, the ASM_REVIEW_TOPOLOGY_HIERARCHY_PRIV entitlement must be granted to the user's job role. The entitlement is granted to the ASM_APPLICATION_DEPLOYER_DUTY duty role, which is inherited by the duty roles ASM_APPLICATION_DEVELOPER_DUTY and ASM_APPLICATION_ADMIN_DUTY.

If the menu items and Tasks described in the following procedure are not available in your cloud instance, then it means your user account is missing the required role. Please contact your Cloud Instance Security Administrator for assistance.

Procedure

  1. Log in to the cloud instance.

  2. Click the Navigator icon in the global area in the top part of the window, then chose Setup and Maintenance under the Tools heading.

  3. Choose Review Topology under the Topology Registration section in the Tasks regional area on the left side of the window.

  4. Click the Detailed tab in the local area in the middle of the window.

    The tab shows the list of domains configured in the cloud instance.

    Description of domain_config.png follows
    Description of the illustration domain_config.png

  5. Map the token name in the service path value to the domain name in Topology Manager using this table.

    Token in Service Path Domain Name
    atf_server CommonDomain
    crm_server CRMDomain
    fin_server FinancialDomain
    hcm_server HCMDomain
    ic_server ICDomain
    prc_server ProcurementDomain
    prj_server ProjectsDomain
    scm_server SCMDomain

  6. Expand the domain name and select any external virtual host and port for the J2EE applications that are deployed on the domain. In the sample window, the values for this particular instance are fs-your-cloud-hostname and 443, respectively.

    Description of domain_values2.png follows
    Description of the illustration domain_values2.png

  7. Replace the domainName_server:PortNumber with the external virtual host and port identified in the previous step. For example:

    https://fs-your-cloud-hostname:port/fndAppCoreServices/ServiceCatalogService?wsdl
    
  8. Remove ?wsdl from the URL in the previous step to derive the ServiceCatalogService end point URL. Note that the service tester page has been disabled for this service. Navigating to the end point URL in a browser will result in a blank page.