Register Web Services

As an administrator, you can use web services to get a record or initiate an action.

You must register Web services to:

  • Retrieve item or product details from another application

  • Initiate ESS jobs to generate funds

To register Web services:

  1. Ensure that you're in an active sandbox.

  2. Navigate to the Application Composer.

  3. Select Web Services from the Common Setup list.

  4. Click Create Web Service Reference.

  5. On the Select Connection Type dialog box and select SOAP.

  6. On the Create Soap Web Service Connection page, provide the following information:

    • To retrieve item or product details from another application, provide the following information:

      Note: Before you register the web service to fetch item or product details, locate your WSDL URL. The WSDL URL is typically located at http://scmhost:port/egpItems/ItemServiceV2?wsdl format.

      Fields

      Values

      Name

      ItemWebService1

      WSDL URL

      Enter the URL and click Read WSDL.

      Security Scheme

      Initiate with separate user credentials and message protection

      Credential Key

      Select the administrator role.

      Disable Time Stamp

      Select the check box.

    • To initiate ESS jobs to generate funds:

      Note: Before you register the web service to initiate scheduler jobs to generate funds; locate your WSDL URL. The WSDL URL is typically located at http://scmhost:port/ess/esswebservice?WSDL.

      Fields

      Values

      Name

      ESSWebService

      WSDL URL

      Enter the WSDL URL and click Read WSDL. The warning message appears indicating that the preferred security options couldn't be determined. Contact web service provider or consult web service documentation to obtain correct security details. If error occurs during service invocation, contact system administrator with the web service and error details.

      The service is autopopulated to {http://xmlns.oracle.com/scheduler}ESSWebServiceCallback. You must change it to {http://xmlns.oracle.com/scheduler}ESSWebService

      Security Scheme

      Call with separate user credentials and message protection

      Credential Key

      Select the administrator role.

      Disable Time Stamp

      Select the check box.

  7. Click Save and Close.

  8. Publish the sandbox.

The web services have been registered.

Register Content and Experience Cloud

Oracle Content and Experience is a cloud-based content hub to drive omnichannel content management and accelerate experience delivery. You can use this powerful collaboration and workflow management tool to streamline the creation and delivery of content and improve customer engagement. In this product, you can use the content and experience cloud for uploading the photos and planograms for assortment plans and merchandising plans.

Note: To use content and experience cloud for managing attachments, you can configure this web service. For more information, see Content and Experience Cloud administration guide.

Content and Experience Cloud Prerequisites:

  • Ensure you read the prerequisites for registering web services in Content and Experience Cloud.

  • Ensure you have as an administrator.

  • Ensure you have permissions to the cloud URL. For example, https://example.oraclecloud.com.

  • Ensure you have permissions to create, delete, and search the folder.

As an administrator, perform the following steps:

Create a Folder

See the example

  1. Ensure that you're in an active sandbox.

  2. Navigate to the Application Composer.

  3. Select Web Services from the Common Setup list.

  4. Click Create Web Service Reference.

  5. In Web Services, click New.

  6. Select Connection Type: REST

  7. Name: ContentCloudCreateFolder

  8. URL: <<doc_cloud_hostname>>/documents/api/1.2/folders/##folderId##. For example, https://demo-gse00009991.documents.us2.oraclecloud.com/documents/api/1.2/folders/##folderId##

  9. Authentication Scheme: "Call with basic authentication"

  10. In the Credentials Key, click create and provide the Critical Success Factor (CSF) Key, user name, and password of cloud administrator.

  11. Method Name: POST and Format: JSON

  12. Request Payload (Code Sample)

    {"name":"FUSE300100115027107", "description":"rest folder"}
  13. Response Payload

    { "childItemsCount": "0", "createdBy":  { "displayName": "cecsadmina", "id": "U4D1C916DAC71D5D7A60EE35C2DB3E7D25FC", "loginName": "twebcli.cecsadmina", "type": "user" }, "createdTime": "2017-11-28T04:34:56Z", "errorCode": "0", "id": "F8BF28DEDB91462D7B3370A1C2DB3E7D25FCE4F631DA", "modifiedBy": { "displayName": "cecsadmina", "id": "U4D1C916DAC71D5D7A60EE35C2DB3E7D25FC", "loginName": "twebcli.cecsadmina", "type": "user" }, "modifiedTime": "2017-11-28T04:34:56Z", "name": "FUSE300100115027107", "ownedBy": { "displayName": "cecsadmina", "id": "U4D1C916DAC71D5D7A60EE35C2DB3E7D25FC", "loginName": "twebcli.cecsadmina", "type": "user" }, "parentID": "self", "type": "folder" }
  14. Click Save and Close.

Delete a Folder

See the example

  1. Ensure that you're in an active sandbox.

  2. Navigate to the Application Composer.

  3. Select Web Services from the Common Setup list.

  4. Click Create Web Service Reference.

  5. In Web Services, click New.

  6. Select Connection Type: REST

  7. Name: ContentCloudDeleteFolder

  8. URL: <<doc_cloud_hostname>>/documents/api/1.2/folders/##folderId##. For example, https://demo-gse00009991.documents.us2.oraclecloud.com/documents/api/1.2/folders/##folderId##

  9. Authentication Scheme: "Call with basic authentication"

  10. In Credentials Key, select the CSF Key that you have created.

  11. Method Name: DELETE and Format: JSON

  12. Request Payload: Schema URL

  13. Response Payload: Schema URL

  14. Click Save and Close.

Search for a Folder

See the example

  1. Ensure that you're in an active sandbox.

  2. Navigate to the Application Composer.

  3. Select Web Services from the Common Setup list.

  4. Click Create Web Service Reference.

  5. In Web Services, click New.

  6. Select Connection Type: REST

  7. Name: ContentCloudSearchFolder

  8. URL: <<doc_cloud_hostname>>/documents/api/1.2/folders/##ParentId##/items?filterName=##FolderName##orderby=name:asc/. For example, https://demo-gse00009991.documents.us2.oraclecloud.com/documents/api/1.2/folders/##folderId##

  9. Authentication Scheme: "Call with basic authentication"

  10. In Credentials Key, select the CSF Key that you have created.

  11. Method Name: GET and Format: JSON

  12. Request Payload: Schema URL

  13. Response Payload: Schema URL

    {    "count":"2",    "totalResults":"2",    "hasMore":"0",    "errorCode":"0",    "id":"FF4729683CD68C1AFB1AE87DT0000000000100000001",    "parentID":"self",    "name":"foldera",    "description":"rest folder",    "type":"folder",    "size":"39",    "childItemsCount":"2",    "createdTime":"2014-02-21T20:52:37Z",    "modifiedTime":"2014-02-21T20:52:37Z",    "createdBy":{        "displayName":"User AA",        "id":"U0EAA20910FAF3052ACB79E4T00000000001",        "loginName":"userAALoginName",        "type":"user"    },    "ownedBy":{        "displayName":"User AA",        "id":"U0EAA20910FAF3052ACB79E4T00000000001",        "loginName":"userAALoginName",        "type":"user"    },    "modifiedBy":{        "displayName":"User AA",        "id":"U0EAA20910FAF3052ACB79E4T00000000001",        "loginName":"userAALoginName",        "type":"user"    },    "items":[        {            "id":"FB4CD874EF94CD2CC1B60B72T0000000000100000001",            "parentID":"FF4729683CD68C1AFB1AE87DT0000000000100000001",            "name":"restFolder",            "type":"folder",            "size":"39",            "childItemsCount":"1",            "createdTime":"2014-02-21T20:54:50Z",            "modifiedTime":"2014-02-21T20:54:50Z",            "createdBy":{                "displayName":"User AA",                "id":"U0EAA20910FAF3052ACB79E4T00000000001",                "loginName":"userAALoginName",                "type":"user"            },            "ownedBy":{                "displayName":"User AA",                "id":"U0EAA20910FAF3052ACB79E4T00000000001",                "loginName":"userAALoginName",                "type":"user"            },            "modifiedBy":{                "displayName":"User AA",                "id":"U0EAA20910FAF3052ACB79E4T00000000001",                "loginName":"userAALoginName",                "type":"user"            }        },        {            "id":"DB1C5AF480FFE61C588027A8T0000000000100000001",            "parentID":"FF4729683CD68C1AFB1AE87DT0000000000100000001",            "name":"example.txt",            "type":"file",            "size":"13",            "version":"1",            "createdTime":"2014-02-21T21:32:37Z",            "modifiedTime":"2014-02-21T21:32:37Z",            "createdBy":{                "displayName":"User AA",                "id":"U0EAA20910FAF3052ACB79E4T00000000001",                "loginName":"userAALoginName",                "type":"user"            },            "ownedBy":{                "displayName":"User AA",                "id":"U0EAA20910FAF3052ACB79E4T00000000001",                "loginName":"userAALoginName",                "type":"user"            },            "modifiedBy":{                "displayName":"User AA",                "id":"U0EAA20910FAF3052ACB79E4T00000000001",                "loginName":"userAALoginName",                "type":"user"            }        }    ]}
  14. Click Save and Close.

Enable Display on Content and Experience Cloud

To display content from Oracle Content and Experience Cloud within other Sales Cloud domains, enable embedded content and add domains.

  1. Access the Cloud URL, open your user menu, and click Administration.

  2. On the Administration menu, click Security to go to Embedded Content, and select Enabled.

  3. In the Allowed Domains box, enter a list of permitted domains, separated by commas. Ensure that the domains are in an appropriate format, for example, www.example.com

  4. To restrict the domain to a particular port, include the port in the specification. For example, www.example.com:12345.

  5. To allow a domain that has multiple sub-domains, you can use the * wildcard character. For example, www.example.* includes the domains www.example.com, www.example.co.in, and so on.