Om utveckling av komponenter

Genom att utveckla egna anpassade komponenter kan du skapa sammansatta element som kan bäddas in på webbplatssidan, med valfri sidteknik. På så sätt får du möjlighet att utöka den lista över komponenter som tillhandahålls i Oracle Content Management.

Poster för alla registrerade komponenter lagras i komponentkatalogen, som är en mapp i Oracle Content Management som innehåller posterna för alla registrerade komponenter.

Använd inte följande namn för mallar, teman, komponenter, platser eller platssidor: authsite, content, pages, scstemplate_*, _comps, _components, _compsdelivery, _idcservice , _sitescloud, _sitesclouddelivery, _themes, _themesdelivery. Även om du kan använda följande namn för platssidor bör du inte använda den för mallar, teman, komponenter och platser: documents, sites.

Komponenttyper

Komponentkatalogen har stöd för följande typer av komponenter:

Lokal komponent
Lokal komponent återgiven i en iframe
Fjärrkomponent

Typen av komponent lagras i ett tilläggsattribut, "xScsAppType", för komponentmappen. Giltiga värden följer.

Typ	Beskrivning
Lokal komponent	Alla beroenden förväntas vara lokala.
Lokal komponent återgiven i en iframe	Komponenten hanteras från samma domän som Oracle Content Management.
Fjärrkomponent	Komponenten hanteras från en fjärransluten plats.

Filstruktur för komponenter

De olika typerna av komponenter har olika filuppsättningar när de skapas i komponentkatalogen, beroende på hur de implementeras.

Lokal komponent:

/Components/component-name
    appinfo.json
    _folder_icon.jpg
    assets
        settings.html
        render.js

Lokal komponent med iframe:

/Components/component-name
    appinfo.json
    _folder_icon.jpg
    assets
        settings.html
        render.js
        js
            sites.min.js
            knockout.min.js
            jquery.min.js

Fjärrkomponent:

/Components/component-name
    appinfo.json
    _folder_icon.jpg
    keys.json

Mappmetadata

Registreringsdata för komponenten lagras i mappmetadata. Följande egenskaper används för att unikt identifiera komponenten och dess typ.

Egenskap	Beskrivning
appnamn	Mappnamn som betecknar komponentens namn.
appbeskrivning	Beskrivning av mappen.
app-guid	Varje komponent är associerad med ett GUID och lagras som ett tilläggsattribut, `xScsItemGUID`. GUID genereras av servern när komponenten skapas.
apptyp	Egenskap som betecknar komponenttypen. Den lagras som ett tilläggsattribut, `xScsApType`.

Obs!:

Egenskapen iconUrl, som lagras som tilläggsattributet xScsAppIconUrl, har tagits ur bruk.

Filen appinfo.json

Registreringsfilen appinfo.json för varje typ av komponent innehåller endast data som inte är tillgängliga i mappmetadata. Komponentegenskaper som definieras i mappmetadata dupliceras inte till filen appinfo.json.

Lokal komponent:

{
        "settingsData":{
                "settingsHeight":80,
                "settingsRenderOption"; "dialog",
                "settingsWidth":300,
                "componentLayouts":[],
                "triggers":[],
                "actions":[]
        },
        "initialData":{
                "customSettingsData":[],
        }
}

Lokal komponent återgiven i en iframe:

{
        "endpoints": {
              "settings": {
                      "height": "300",
                      "width": "400"
              }
        }
        "initialData": {
                "customSettingsData": {}
        }
}

Fjärrkomponent:

{
        "endpoints": {
              "widget": {
                     "url": "http://www.externaldomain.com/app/render.html"
              }
              "settings": {
                      "url": "http://www.externaldomain.com/app/settings.html",
                      "height": "300",
                      "width": "400"
              }
        }
        "initialData": {
              "customSettingsData": {}
        }
}

Det finns inga registrerade "url"-värden för lokala komponenter. De använder vissa filer som kan redigeras med avseende på innehåll, men det går inte att ändra plats eller namn.

Lokala komponenter använder filerna assets/render.js och assets/settings.html.
Lokala komponenter som återges i en iframe använder filerna assets/render.html och assets/settings.html.
Fjärrkomponenter använder de "url"-värden som specificeras.