aikau

/aikau — Share Aikau Generator

Share JAR only — deploys into the Share web tier, not into the ACS repository tier.

Generate Aikau-era Share page and dashlet artefacts from requirements.

Input

Read REQUIREMENTS.md and identify Share-tier UI requirements that call for Aikau pages, widget models, dashlets, or Aikau-backed Surf pages.

Resolve:

• the Share JAR project's Root path from Section 2 (Project Architecture)
• the Platform JAR project's Root path, if one exists, so widgets can reference existing repository-side APIs or model terms

If Section 2 contains no Share JAR project, stop and explain that /aikau only applies to Share-tier addon projects.

If the request is really for modern ACA/ADF/custom frontend work instead of Aikau-based Share customization, stop and explain that /aikau is the wrong generator.

Output Files

1. Aikau page web script descriptor

{share-project-root}/src/main/resources/alfresco/site-webscripts/{path}/{page-id}.get.desc.xml

<webscript>
    <shortname>{Page Title}</shortname>
    <description>{Page purpose}</description>
    <url>/page/{page-id}</url>
    <family>Share</family>
    <authentication>user</authentication>
    <transaction>none</transaction>
</webscript>

2. Aikau page model JavaScript

{share-project-root}/src/main/resources/alfresco/site-webscripts/{path}/{page-id}.get.js

Use an AMD-style page model script that constructs widgets explicitly:

model.jsonModel = {
    services: [
        "alfresco/services/NavigationService",
        "alfresco/services/DocumentService"
    ],
    widgets: [
        {
            id: "{prefix}-{page-id}",
            name: "alfresco/layout/VerticalWidgets",
            config: {
                widgets: [
                    {
                        id: "{prefix}-{widget-id}",
                        name: "{widgetModule}",
                        config: {
                            title: msg.get("{message.key}")
                        }
                    }
                ]
            }
        }
    ]
};