Oracle Sales and Service Application Integration konfigurieren

In diesem Abschnitt fügen Sie die allgemeine Funktionalität der Oracle Sales and Service-Anwendung hinzu, die für die Kommunikation mit OCM erforderlich ist. Dazu müssen neue Webservices für die Kommunikation mit den REST-APIs des OCM-Dokuments, globalen Funktionen der Oracle Sales- und Service-Anwendung für den Aufruf dieser neuen Webservices und ein Anwendungs-Mashup von Oracle Sales and Service erstellt werden, um diese Integration der eingebetteten OCM-UI verfügbar zu machen.

Eine Sandbox erstellen

So erstellen Sie eine Sandbox zur Implementierung der Änderungen der Oracle Sales and Service-Anwendung für diese Integration:

  1. Melden Sie sich als Oracle Sales- und Service-Administrator an.
  2. Klicken Sie in der oberen linken Ecke der Seite auf Hamburger-Symbol. Wählen Sie im Menü die Option Konfiguration und dann Sandboxes.

  3. Füllen Sie auf der Seite "Sandbox erstellen" die folgenden Felder aus:

    1. Klicken Sie auf der Seite "Sandboxes" auf Sandbox erstellen.
    2. Geben Sie auf der Seite "Sandbox erstellen" im Feld Name einen Namen für diese Sandbox an (z.B. Integration von OCI-Dokumentzusammenarbeit).
    3. Aktivieren Sie in der Liste Alle Tools das Kontrollkästchen Application Composer.
    4. Klicken Sie auf Erstellen und eingeben.
  4. Um den Application Composer einzugeben, in dem Sie die Änderungen an der OCM-Integration vornehmen möchten, klicken Sie in der oberen linken Ecke der Seite auf Extras, und wählen Sie in der Dropdown-Liste die Option Application Composer aus.

Webservices erstellen

Webservices werden für die Kommunikation mit OCM über die REST-APIs des OCM-Dokuments verwendet.

OCMCreateFolderService

So erstellen Sie den OCM-Webservice zum Erstellen von Ordnern:
  1. Wählen Sie im linken Navigationsmenü die Optionen Allgemeines Setup und dann Webservices.
  2. Klicken Sie auf der Seite "Webservices" auf das Symbol Neuen Webservice erstellen.
  3. Wählen Sie im Dialogfeld "Verbindungstyp auswählen" die Option REST aus, und klicken Sie auf OK.
  4. Füllen Sie auf der Seite "REST-Webservices-Verbindung erstellen" die folgenden Felder aus:

    1. Geben Sie im Feld Name den Namen des Ordners als OCMCreateFolderService an.
    2. Geben Sie im Feld URL die Webservice-URL als https://<OCMServerURL>/documents/api/1.2/folders/##OCMParentFolderId##?name=##OCMFolderName## ein, die zum Erstellen des OCM-Ordners erforderlich ist. Dabei ist <OCMServerURL> der Oracle Content Management-Server, der für diese Integration verwendet wird (z.B. https://mycloud.com/documents/api/1.2/folders/##OCMParentFolderId##?name=##OCMFolderName##).
    3. Wählen Sie im Abschnitt "Authentifizierungsschema" die Option Kein Wert aus, wie sie im nächsten Schritt konfiguriert wird.
    4. Aktivieren Sie im Abschnitt "Methoden für Ressource auswählen und konfigurieren" das Kontrollkästchen POST.
    5. Wählen Sie im Abschnitt "Antwort-Payload" die Option Codebeispiel aus, und fügen Sie {} zum mehrzeiligen Textfeld hinzu.
  5. Um das IDCS OAUTH-Authentifizierungsschema zu erstellen, das für die Webservices verwendet wird, füllen Sie auf der Seite "REST-Webservicesverbindung erstellen" die folgenden Felder aus:

    Hinweis:

    Diese Schritte sind nur erforderlich, wenn Sie einen Webservice für OCM zum ersten Mal erstellen.


    1. Wählen Sie im Abschnitt "Authentifizierungsschema" die Option Anruf mit IDCS OAUTH aus.
    2. Geben Sie im Feld Token-URI die IDCS-Server-URL https://<idcsServerURL>/oauth2/v1/token ein. Dabei ist <idcsServerURL> die URL für den IDCS-Server, der für diese Integration verwendet wird.
    3. Geben Sie im Feld Geltungsbereich den Geltungsbereich ein, der beim Erstellen des IDCS OAUTH-Authentifizierungsschemas oben kopiert wurde (z.B. https://BD2F184D9D2344CB8134FCD4CBFF7DF.mycloud.com:443/urn:opc:cec:all).
    4. Füllen Sie die folgenden Felder aus, um den Clientzugangsdatenschlüssel zu erstellen:
      1. Wählen Sie das Symbol Zugangsdatenschlüssel erstellen neben dem Feld Clientzugangsdatenschlüssel aus.
      2. Geben Sie im Feld CSF-Schlüssel den Schlüssel ein (z.B. Webservices).
      3. Geben Sie im Feld Benutzername die Client-ID ein, die beim Erstellen des IDCS OAUTH-Authentifizierungsschemas oben kopiert wurde (Beispiel: c585b2d3e97c40e491ca99112281e36).
      4. Geben Sie im Feld Kennwort das Client Secret ein, das beim Erstellen des IDCS OAUTH-Authentifizierungsschemas oben kopiert wurde (Beispiel: 768b9513-658e-4854-bac7-2fe72d19011).
      5. Klicken Sie auf OK.
    5. Füllen Sie die folgenden Felder aus, um den OCM-Zugangsdatenschlüssel für die Switch-Identität zu erstellen:
      1. Wählen Sie das Symbol Zugangsdatenschlüssel erstellen neben dem Feld Zugangsdatenschlüssel für Zugangsdatenschlüssel aus.
      2. Geben Sie im Feld CSF-Schlüssel den Schlüssel ein (Beispiel: OCM-Integrationsschlüssel).
      3. Geben Sie im Feld Benutzername den OCM-Integrationsbenutzer ein (den Benutzer, der zuvor zum Erstellen des OCM-Root-Ordners verwendet wurde), der für die Kommunikation mit OCM verwendet wird (dies muss ein Unternehmensbenutzer in OCM sein).
      4. Geben Sie im Feld Kennwort das OCM-Benutzerkennwort Integration ein.
      5. Klicken Sie auf OK.
    6. Klicken Sie auf Speichern und schließen.

OCMSearchUserService

Um den Webservice für OCM-Suchbenutzer zu erstellen, füllen Sie auf der Seite "REST-Webserviceverbindung erstellen" die folgenden Felder aus:
Beschreibung von searchuser.png folgt
Beschreibung der Abbildung searchuser.png

  1. Geben Sie im Feld Name den Namen des Suchbenutzers als OCMSearchUserService an.
  2. Geben Sie im Feld URL die URL des Suchbenutzers als https://<OCMServerURL>/documents/api/1.2/users/items?info=##userName## an. Dabei ist <OCMServerURL> der Oracle Content Management-Server, der für diese Integration verwendet wird.
  3. Wählen Sie im Abschnitt "Authentifizierungsschema" die Option Mit IDCS OAUTH aufrufen aus, und verwenden Sie dieselben Werte wie oben für die IDCS OAUTH-Parameter.
  4. Aktivieren Sie im Abschnitt "Methoden für Ressource auswählen und konfigurieren" das Kontrollkästchen GET.
  5. Wählen Sie im Abschnitt "Antwort-Payload" die Option Codebeispiel aus, und fügen Sie {} zum mehrzeiligen Textfeld hinzu.

OCMSharedFolderUsersService

Um den Webservice für den gemeinsam genutzten OCM-Ordnerbenutzer zu erstellen, füllen Sie auf der Seite "REST-Webserviceverbindung erstellen" die folgenden Felder aus:
Beschreibung von sharedfolder.png folgt
Beschreibung der Abbildung sharedfolder.png

  1. Geben Sie im Feld Name den Namen des freigegebenen Ordnerbenutzers als OCMSharedFolderUsersService an.
  2. Geben Sie im Feld URL die URL des freigegebenen Ordnerbenutzers als https://<OCMServerURL>/documents/api/1.2/shares/##folderId##/items an. Dabei ist <OCMServerURL> der Oracle Content Management-Server, der für diese Integration verwendet wird.
  3. Wählen Sie im Abschnitt "Authentifizierungsschema" die Option Mit IDCS OAUTH aufrufen aus, und verwenden Sie dieselben Werte wie oben für die IDCS OAUTH-Parameter.
  4. Aktivieren Sie im Abschnitt "Methoden für Ressource auswählen und konfigurieren" das Kontrollkästchen GET.
  5. Wählen Sie im Abschnitt "Antwort-Payload" die Option Codebeispiel aus, und fügen Sie {} zum mehrzeiligen Textfeld hinzu.

OCMShareFolderService

Um den Webservice für OCM-Freigabeordner zu erstellen, füllen Sie auf der Seite "REST-Webserviceverbindung erstellen" die folgenden Felder aus:
Beschreibung von share-folder.png folgt
Beschreibung der Abbildung share-folder.png

  1. Geben Sie im Feld Name den Namen des Benutzers für den Freigabeordner als OCMShareFolderService an.
  2. Geben Sie im Feld URL die URL des Share-Ordnerbenutzers als https://<OCMServerURL>/documents/api/1.2/shares/##folderId## an. Dabei ist <OCMServerURL> der Oracle Content Management-Server, der für diese Integration verwendet wird.
  3. Wählen Sie im Abschnitt "Authentifizierungsschema" die Option Mit IDCS OAUTH aufrufen aus, und verwenden Sie dieselben Werte wie oben für die IDCS OAUTH-Parameter.
  4. Aktivieren Sie im Abschnitt "Methoden für Ressource auswählen und konfigurieren" das Kontrollkästchen POST.
  5. Wählen Sie im Abschnitt "Anforderungs-Payload" die Option Codebeispiel aus, und fügen Sie {} zum mehrzeiligen Textfeld hinzu.
  6. Wählen Sie im Abschnitt "Antwort-Payload" die Option Codebeispiel aus, und fügen Sie {} zum mehrzeiligen Textfeld hinzu.

OCMDeleteFolderService

Um den Webservice für OCM-Ordner löschen zu erstellen, füllen Sie auf der Seite "REST-Webserviceverbindung erstellen" die folgenden Felder aus:
Beschreibung von deletefolder.png folgt
Beschreibung der Abbildung deletefolder.png

  1. Geben Sie im Feld Name den Namen des Ordners als OCMDeleteFolderService an, der gelöscht werden soll.
  2. Geben Sie im Feld URL die URL des Löschordners als https://<OCMServerURL>/documents/api/1.2/folders/##folderId## an. Dabei ist <OCMServerURL> der Oracle Content Management-Server, der für diese Integration verwendet wird.
  3. Wählen Sie im Abschnitt "Authentifizierungsschema" die Option Mit IDCS OAUTH aufrufen aus, und verwenden Sie dieselben Werte wie oben für die IDCS OAUTH-Parameter.
  4. Aktivieren Sie im Abschnitt "Methoden für Ressource auswählen und konfigurieren" das Kontrollkästchen DELETE.
  5. Wählen Sie im Abschnitt "Antwort-Payload" die Option Codebeispiel aus, und fügen Sie {} zum mehrzeiligen Textfeld hinzu.

Globale Funktionen erstellen

Globale Funktionen werden verwendet, um Geschäftslogik um die Webservices herum zu wrappen, damit sie einfach an anderen Orten verwendet werden können.

OCMCreateFolderFunction

So erstellen Sie die globale OCM-Funktion zum Erstellen von Ordnern, die den Webservice OCMCreateFolderService verwendet:

  1. Wählen Sie im linken Navigationsmenü die Optionen Allgemeines Setup und dann Globale Funktionen aus.
  2. Klicken Sie auf der Seite "Globale Funktionen" auf das Symbol Globale Funktion hinzufügen.
  3. Füllen Sie auf der Seite "Globale Funktion erstellen" die folgenden Felder aus:

    1. Geben Sie im Feld Funktionsname den Namen der Funktion als OCMCreateFolderFunction an.
    2. Wählen Sie im Dropdown-Menü Retouren die Option Zeichenfolge aus.
    3. Geben Sie im Feld Beschreibung den Text "Erstellt einen neuen OCMFolderName-Ordner in OCM unter der angegebenen OCMParentFolderId und gibt die neu erstellte Ordner-ID zurück."
    4. Klicken Sie im Abschnitt "Parameter" auf das Symbol Parameter hinzufügen.

      Geben Sie im Feld Name den Namen OCMParentFolderId an, und wählen Sie im Dropdown-Menü Typ die Option Zeichenfolge aus.

    5. Klicken Sie im Abschnitt "Parameter" auf das Symbol Parameter hinzufügen.

      Geben Sie im Feld Name den Namen OCMFolderName an, und wählen Sie im Dropdown-Menü Typ die Option Zeichenfolge aus.

    6. Fügen Sie im Feld Skript bearbeiten das folgende Skript ein:
      def OCMFolder = [:]
      try {
        OCMFolder = adf.webServices.OCMCreateFolderService.POST(OCMParentFolderId, OCMFolderName)
        println("OCM Folder Created: " + OCMFolder)
        return OCMFolder.id   
      } catch (Exception e) {
        println("Create OCM Folder Error: " + e)
      }
    7. Klicken Sie auf Speichern und schließen.

OCMSearchUserFunction

Um die globale OCM-Suchfunktion für Benutzer zu erstellen, füllen Sie auf einer neuen Seite "Globale Funktion erstellen", die für den Zugriff auf den Webservice OCMSearchUserService verwendet wird, die folgenden Felder aus:
Beschreibung von searchuserfunction.png folgt
Beschreibung der Abbildung searchuserfunction.png

  1. Geben Sie im Feld Funktionsname den Namen der Funktion als OCMSearchUserFunction an.
  2. Wählen Sie im Dropdown-Menü Retouren die Option Zeichenfolge aus.
  3. Geben Sie im Feld Beschreibung den Text "Suchen Sie nach einem Benutzer in OCM nach dem angegebenen userName, und geben Sie die Benutzer-ID zurück."
  4. Geben Sie im Abschnitt "Parameter" im Feld Name den Namen userName an, und wählen Sie im Dropdown-Menü Typ die Option Zeichenfolge aus.
  5. Fügen Sie im Feld Skript bearbeiten das folgende Skript ein:
    def response = [:]
    try {
      response = adf.webServices.OCMSearchUserService.GET(userName)
      def responseItems = [:]
      responseItems = response.items
      println("OCM Search User Result: " + responseItems.getAt(0))
      return responseItems.getAt(0).id
    } catch (Exception e) {
      println("Search OCM User Error: " + e)
    }
  6. Klicken Sie auf Speichern und schließen.

OCMIsFolderSharedFunction

Um die globale Funktion "OCM-Freigabeordner" auf einer neuen Seite "Globale Funktion erstellen" zu erstellen, die für den Zugriff auf den Webservice OCMSharedFolderUsersService verwendet wird, füllen Sie die folgenden Felder aus:
Beschreibung von ocmis.png folgt
Beschreibung der Abbildung ocmis.png

  1. Geben Sie im Feld Funktionsname den Namen der Funktion als OCMIsFolderSharedFunction an.
  2. Wählen Sie im Dropdown-Menü Retouren die Option Boolesch aus.
  3. Geben Sie im Feld Beschreibung den Text "Rückgibt True zurück, wenn die angegebene OCMUserId für die angegebene OCMFolderId freigegeben wurde." ein.
  4. Fügen Sie im Abschnitt "Parameter" die folgenden Werte hinzu:
    Name Type
    OCMFolderId Zeichenfolge
    OCMUserId Zeichenfolge
  5. Fügen Sie im Feld Skript bearbeiten das folgende Skript ein:
    def response = [:]
    try {
      response = adf.webServices.OCMSharedFolderUsersService.GET(OCMFolderId)
      def responseItems = [:]
      responseItems = response.items
      for (item in responseItems) {
        if (item['type'] == 'share') {
          if (item['user']['id'] == OCMUserId) {
            return true
          }
        }
      }
      return false
    } catch (Exception e) {
      println("OCM Folder Shared Error: " + e)
      return false
    }
  6. Klicken Sie auf Speichern und schließen.

OCMShareFolderFunction

Um die globale Funktion "OCM-Freigabeordner" auf einer neuen Seite "Globale Funktion erstellen" zu erstellen, die für den Zugriff auf den Webservice OCMShareFolderService verwendet wird, füllen Sie die folgenden Felder aus:
Beschreibung von sharefolderfunction.png folgt
Beschreibung der Abbildung sharefolderfunction.png

  1. Geben Sie im Feld Funktionsname den Namen der Funktion als OCMShareFolderFunction an.
  2. Wählen Sie im Dropdown-Menü Retouren die Option Boolesch aus.
  3. Geben Sie im Feld Beschreibung den Text "Freigeben Sie den angegebenen OCMFolderId in OCM mit den angegebenen Werten OCMUserId und OCMRole, die bei Erfolg "true" zurückgeben." ein.
  4. Fügen Sie im Abschnitt "Parameter" die folgenden Werte hinzu:
    Name Type
    OCMFolderId Zeichenfolge
    OCMUserId Zeichenfolge
    OCMRole Zeichenfolge
  5. Fügen Sie im Feld Skript bearbeiten das folgende Skript ein:
    def params = [:]
    params.userID = OCMUserId
    params.role = OCMRole
    def response = [:]
    try {
      response = adf.webServices.OCMShareFolderService.POST(OCMFolderId, params)
      if (response.errorCode == "0") {
        println("OCM Folder Shared: " + OCMFolderId + "(" + OCMUserId + ":" + OCMRole + ")")
        return true
      } else {
        println("Share OCM Folder Failed: " + OCMFolderId + "(" + OCMUserId + ":" + OCMRole + ")")
        return false
      }
    } catch (Exception e) {
      println("Share OCM Folder Error: " + e)
      return false 
    }
  6. Klicken Sie auf Speichern und schließen.

OCMDeleteFolderFunction

Um die globale Funktion "OCM-Freigabeordner" auf einer neuen Seite "Globale Funktion erstellen" zu erstellen, die für den Zugriff auf den Webservice OCMDeleteFolderService verwendet wird, füllen Sie die folgenden Felder aus:
Beschreibung von ocmdelete.png folgt
Beschreibung der Abbildung ocmdelete.png

  1. Geben Sie im Feld Funktionsname den Namen der Funktion als OCMDeleteFolderFunction an.
  2. Wählen Sie im Dropdown-Menü Retouren die Option Boolesch aus.
  3. Geben Sie im Feld Beschreibung den Text "Löscht den angegebenen OCMFolderId in OCM".
  4. Geben Sie im Abschnitt "Parameter" im Feld Name den Namen OCMFolderId an, und wählen Sie im Dropdown-Menü Typ die Option Zeichenfolge aus.
  5. Fügen Sie im Feld Skript bearbeiten das folgende Skript ein:
    def response = [:]
    try {
      adf.webServices.OCMDeleteFolderService.DELETE(OCMFolderId)
      println("OCM Folder Deleted: " + OCMFolderId)
      return true
    } catch (Exception e) {
      println("Delete OCM Folder Error: " + e)
      return false 
    }
  6. Klicken Sie auf Speichern und schließen.

Mashup erstellen

Ein Mashup ist ein Fenster in eine unabhängige externe Anwendung wie OCM.

So erstellen Sie ein Mashup zum Einbetten der eingebetteten OCM-UI, damit es in einem Oracle Sales and Service-Geschäftsobjekt angezeigt werden kann:

  1. Wählen Sie im linken Navigationsmenü die Optionen Allgemeines Setup und Mashup-Inhalt.
  2. Klicken Sie auf der Seite "Mashup-Inhalt: Webanwendungen" auf die Schaltfläche Webanwendung registrieren.
  3. Füllen Sie auf der Seite "Webanwendung registrieren" die folgenden Felder aus:

    1. Geben Sie im Feld Name den Namen der Anwendung als OCMEmbeddedFolderUIMashup an.
    2. Wählen Sie für das Feld Typ die Option Gruppenausdruck aus.
    3. Geben Sie im Feld URL-Definition die eingebettete OCM-UI-URL als https://<OCMServerURL>/documents/embed/v2/folder/ ein. Dabei ist <OCMServerURL> der Oracle Content Management-Server, der für die Integration verwendet wird.
    4. Klicken Sie auf Speichern und schließen.