Sivustojen muodostuksen API-liittymä

Oracle Content Management -palvelun (SCSRenderAPI) Sivustojen muodostuksen API-liittymä on window-global-objekti, joka on käytettävissä kaikilla Oracle Content Management -web-sivuilla. Sen pääasiallinen tehtävä on sivun paikkojen ja komponenttien muodostus. Se myös tarjoaa liittymän teeman asetteluihin sisältyvälle JavaScript-koodille. Jos käsittelet teemoja tai komponentteja kehittäjänä, nämä tapahtumat ja funktiot saattavat olla käytettävissä. Ajonaikainen SCSRenderAPI muodostaa näkymän ja esikatselun näyttötilat, kun taas suunnittelunaikainen SCSRenderAPI muodostaa navigoinnin, muokkauksen ja huomautuksien näyttötilat.

Ajon aikana Sivustojen muodostuksen API-liittymä -liittymällä on kolme yleistä käyttötarkoitusta:
  • Se täyttää sivun paikat komponenteilla ja sisällöllä.
  • Se vastaa sivun asetteluun sisältyvän JavaScript-koodin tekemiin tietopyyntöihin.
  • Se käynnistää tapahtumia sivun muodostusprosessin elinkaaren aikana.
Suunnittelun aikana Sivustojen muodostuksen API-liittymä -liittymällä on neljä yleistä käyttötarkoitusta:
  • Se täyttää sivun paikat komponenteilla ja sisällöllä.
  • Se vastaa sivun asetteluun sisältyvän JavaScript-koodin tekemiin tietopyyntöihin.
  • Se käynnistää tapahtumia sivun muodostus- ja muokkausprosessin elinkaaren aikana.
  • Se mahdollistaa sivun muokkauksen ja huomautusten lisäämisen yhdessä sivustonluontiohjelman kanssa.
Sivustojen muodostuksen API-liittymä latautuu Oracle Content Management -palvelun web-sivuilla, kun teeman asetteluihin lisätään seuraava komentosarjan tunniste: 
<script data-main="/_sitescloud/renderer/renderer.js" src="/_sitescloud/renderer/require.js"></script>

Yleensä tämä tunniste sijoitetaan asettelujen alaosaan. (Huomaa, että tunnisteessa olevat URL-osoitteet muutetaan automaattisesti asianmukaiselle ympäristölle eli suunnittelun- tai ajonaikaiselle ympäristölle sopiviksi.) SCSRenderAPI-objekti latautuu asynkronisesti. Räätälöity JavaScript-koodi voi kuunnella sivustojen muodostuksen API-liittymän käytettävyyttä käsittelemällä scsrenderstart-tapahtuman.