Tietoja komponenttien kehittämisestä

Kehittämällä omia räätälöityjä komponentteja voit luoda yhdistelmäelementtejä, jotka voit upottaa sivuston sivulle valitsemallasi sivutekniikalla. Näin voit laajentaa Oracle Content Management -palveluun sisältyvien komponenttien valikoimaa.

Kaikkien rekisteröityjen komponenttien merkinnät tallennetaan komponenttiluetteloon. Se on Oracle Content Management -palvelussa oleva kansio, joka sisältää kaikkien rekisteröityjen komponenttien merkinnät.

Älä anna seuraavia nimiä mallipohjille, teemoille, komponenteille, sivustoille tai sivuston sivuille: authsite, content, pages, scstemplate_*, _comps, _components, _compsdelivery, _idcservice, _sitescloud, _sitesclouddelivery, _themes, _themesdelivery. Seuraavia nimiä voi käyttää sivustojen sivujen nimissä, mutta älä käytä niitä mallipohjien, teemojen, komponenttien tai sivustojen nimissä: documents, sites.

Komponenttityypit

Komponenttiluettelo tukee seuraavanlaisia komponentteja:

Paikallinen komponentti
Sisäiseen kehykseen muodostettu paikallinen komponentti
Etäkomponentti

Komponentin tyyppi tallennetaan komponentin kansion "xScsAppType"-laajennusmääritteenä. Sallitut arvot ovat alla.

Tyyppi	Kuvaus
Paikallinen komponentti	Kaikkien riippuvuuksien odotetaan olevan paikallisia.
Sisäiseen kehykseen muodostettu paikallinen komponentti	Komponentti tarjotaan samasta toimialueesta kuin Oracle Content Management.
Etäkomponentti	Komponentti tarjotaan etäsijainnista.

Komponentin tiedostorakenne

Jokaisella komponenttityypillä on erilainen tiedostojoukko, kun ne luodaan komponenttiluetteloon. Tiedostojoukko vaihtelee toteutustavan mukaan.

Paikallinen komponentti:

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

Paikallinen komponentti, joka käyttää sisäistä kehystä:

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

Etäkomponentti:

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

Kansion metatiedot

Komponentin rekisteröintitiedot tallennetaan kansion metatietoihin. Seuraavat ominaisuudet yksilöivät komponentin ja sen tyypin.

Ominaisuus	Kuvaus
sovelluksen nimi	Kansion nimi, joka määrittää komponentin nimen.
sovelluksen kuvaus	Kansion kuvaus.
sovelluksen guid-tunnus	Jokaiseen komponenttiin liitetään GUID-tunnus, joka tallennetaan `xScsItemGUID`-laajennusmääritteenä. Palvelin luo GUID-tunnuksen, kun komponentti luodaan.
sovelluksen tyyppi	Ominaisuus määrittää komponentin tyypin. Se tallennetaan `xScsApType`-laajennusmääritteenä.

Huomautus::

Ominaisuus iconUrl, joka tallennetaan xScsAppIconUrl-laajennusmääritteenä, on vanhentunut.

appinfo.json-tiedosto

Kunkin komponenttityypin appinfo.json-rekisteröintitiedosto sisältää vain tiedot, jotka eivät sisälly kansion metatietoihin. Kansion metatiedoissa määritettyjä komponentin ominaisuuksia ei toisteta appinfo.json-tiedostossa.

Paikallinen komponentti:

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

Sisäiseen kehykseen muodostettu paikallinen komponentti:

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

Etäkomponentti:

{
        "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": {}
        }
}

Paikallisille komponenteille ei ole rekisteröityjä "url"-arvoja. Ne käyttävät tiettyjä tiedostoja, joiden sisältöä voi muokata, mutta sijaintia tai nimeä ei voi muuttaa.

Paikalliset komponentit käyttävät assets/render.js- ja assets/settings.html-tiedostoja.
Sisäiseen kehykseen muodostetut paikalliset komponentit käyttävät assets/render.html- ja assets/settings.html-tiedostoja.
Etäkomponentit käyttävät määritettyjä "url"-arvoja.