Tudnivalók összetevők fejlesztéséről

Saját egyéni összetevő fejlesztése lehetővé teszi olyan összetett elemek kialakítását, amelyek tetszőleges oldalkialakítási megoldással beágyazhatók a webhely oldalán. Ez hatékonyan elősegíti az Oracle Content Management szolgáltatással biztosított összetevők listájának bővítését.

Az összes regisztrált összetevőhöz tartozó bejegyzéseket az összetevő-katalógusban tárolja a rendszer, amely az Oracle Content Management mappája.

A következő neveket ne használja sablonokhoz, témákhoz, összetevőkhöz, webhelyekhez vagy webhelyoldalakhoz: authsite, content, pages, scstemplate_*, _comps, _components, _compsdelivery, _idcservice , _sitescloud, _sitesclouddelivery, _themes, _themesdelivery. Bár használhatja a következő neveket weblapokhoz, ne használja ezeket sablonokhoz, témákhoz, összetevőkhöz vagy webhelyekhez: documents, sites.

Összetevőtípusok

Az összetevő-katalógus a következő típusokat támogatja:

Helyi összetevő
Beágyazott keretben megjelenített helyi összetevő
Távoli összetevő

Az összetevő típusát az összetevő mappájának xScsAppType kiterjesztési attribútumaként tárolja a rendszer. Az érvényes értékek a következők.

Típus	Leírás
Helyi összetevő	Az összes függőséget helyinek várja a rendszer.
Beágyazott keretben megjelenített helyi összetevő	Az összetevő kiszolgálása az Oracle Content Management szolgáltatással megegyező tartományról történik.
Távoli összetevő	Az összetevő kiszolgálása távoli helyről történik.

Összetevők fájlstruktúrája

Az összetevők egyes típusai – megvalósítási módjuk alapján – eltérő fájlkészlettel rendelkeznek az összetevő-katalógusban való létrehozáskor.

Helyi összetevő:

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

Beágyazott keretet használó helyi összetevő:

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

Távoli összetevő:

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

Mappa metaadatai

Az összetevő regisztrációs adatait a mappa metaadataiban tárolja a rendszer. Az összetevő és típusának egyedi azonosítására a következő tulajdonságok szolgálnak.

Tulajdonság	Leírás
alkalmazás neve	Annak a mappának a neve, amely az összetevő nevét jelöli.
alkalmazás leírása	A mappa leírása.
alkalmazás guid azonosítója	Minden összetevőhöz GUID azonosító tartozik, amelyet `xScsItemGUID` kiterjesztési attribútumként tárol a rendszer. A GUID azonosítót a kiszolgáló állítja elő az összetevő létrehozásakor.
alkalmazás típusa	Az összetevő típusát jelölő tulajdonság. Ezt `xScsApType` kiterjesztési attribútumként tárolja a rendszer.

Megjegyzés:

Az xScsAppIconUrl kiterjesztési attribútumként tárolt iconUrl tulajdonság elavult.

Az appinfo.json fájl

Az appinfo.json regisztrációs fájl az összetevők egyes típusainál csak olyan adatokat tartalmaz, amelyek nem érhetők el a mappa metaadataiban. A mappa metaadataiban definiált tulajdonságok nem ismétlődnek meg az appinfo.json fájlban.

Helyi összetevő:

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

Beágyazott keretben megjelenített helyi összetevő:

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

Távoli összetevő:

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

A helyi összetevőknél nincsenek regisztrált "url" értékek. Használnak olyan fájlokat, amelyek tartalma szerkeszthető, de a hely és a név nem módosítható.

A helyi összetevők az assets/render.js és az assets/settings.html fájlt használják.
A beágyazott keretben megjelenített helyi összetevők az assets/render.html és az assets/settings.html fájlt használják.
A távoli összetevők a megadott "url" értékeket használják.