Informace o vývoji komponent

Vývoj vlastní komponenty vám umožňuje vyvinout složené prvky, které lze vložit na stránku webu, pomocí zvolené technologie stránky. To vám umožní efektivně rozšířit seznam komponent poskytovaných se službou Oracle Content Management.

Položky pro všechny registrované komponenty jsou uloženy v katalogu komponent, což je složka ve službě Oracle Content Management , která obsahuje položky pro všechny registrované komponenty.

Pro šablony, témata, komponenty, weby a stránky webů nepoužívejte následující názvy: authsite, content, pages, scstemplate_*, _comps, _components, _compsdelivery, _idcservice , _sitescloud, _sitesclouddelivery, _themes, _themesdelivery. Ačkoli můžete použít následující názvy pro stránky webů, nepoužívejte je pro šablony, témata, komponenty nebo weby: documents, sites.

Typy komponent

Mezi typy komponent podporované katalogem komponent patří:

Místní komponenta
Místní komponenta generovaná ve vloženém rámci
Vzdálená komponenta

Typ komponenty je uložen jako atribut rozšíření "xScsAppType" složky komponenty. Následují platné hodnoty.

Typ	Popis
Místní komponenta	Předpokládá se, že všechny závislosti jsou místní.
Místní komponenta generovaná ve vloženém rámci	Komponenta je obsluhována ze stejné domény jako služba Oracle Content Management.
Vzdálená komponenta	Komponenta je obsluhována ze vzdáleného umístění.

Struktura souborů komponent

Jednotlivé typy komponent mají při vytvoření v katalogu komponent odlišné sady souborů na základě způsobu, jakým jsou implementovány.

Místní komponenta:

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

Místní komponenta používající vložený rámec:

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

Vzdálená komponenta:

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

Metadata složky

Registrační data komponenty jsou uložena v metadatech složky. Následující vlastnosti se používají k jedinečné identifikaci komponenty a jejího typu.

Vlastnost	Popis
název aplikace	Název složky, který určuje název komponenty.
popis aplikace	Popis složky.
guid aplikace	Každá komponenta má přiřazen identifikátor GUID, který je uložen jako atribut rozšíření `xScsItemGUID`. Identifikátor GUID je generován serverem při vytváření komponenty.
typ aplikace	Vlastnost určuje typ komponenty. Je uložena jako atribut rozšíření `xScsApType`.

Poznámka:

Vlastnost iconUrl, která je uložena jako atribut rozšíření xScsAppIconUrl, je zastaralá.

Soubor appinfo.json

Registrační soubor appinfo.json pro každý typ komponenty obsahuje pouze data, která nejsou dostupná v metadatech složky. Vlastnosti komponenty, které jsou definovány v metadatech složky, nejsou v souboru appinfo.json znovu uvedeny.

Místní komponenta:

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

Místní komponenta generovaná ve vloženém rámci:

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

Vzdálená komponenta:

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

Pro místní komponenty nejsou registrovány žádné hodnoty "url". Používají určité soubory, které lze upravovat, pokud jde o obsah, ale nemůžete změnit umístění ani název.

Místní komponenty používají soubory assets/render.js a assets/settings.html.
Místní komponenty generované ve vloženém rámci používají soubory assets/render.html a assets/settings.html.
Vzdálené komponenty používají jakékoli zadané hodnoty "url".