Designer Reference
Quick reference for the API Extension Designer interface elements and keyboard shortcuts.
Toolbar
| Button | Icon | Action | Visible when |
|---|---|---|---|
| New | | Create a new extension project | No project open |
| Open | | Open an existing .aep file | No project open |
| Close | | Close the current project | A project is open |
| Save | | Save the project (Ctrl+S) | A project is open |
| Save as... | | Save a copy under a new name | A project is open |
| Analyze | | Validate and generate types for the selected node | A project is open |
| Build | | Compile the extension into a .pkg | A project is open |
| Publish to Repository | | Upload the built .pkg to the repository | A project is open |
| Re-analyze | | Re-validate after changes (faster than full build) | A project is open |
| Add Application | | Add a new application node | A project is selected |
| Add Service | | Add a new service to the selected application | An application is selected |
| Delete | | Remove the selected application or service | An application or service is selected |
Project Tree
| Node | Icon | Children |
|---|---|---|
| Project |  | Applications |
| Application | Web application | Services |
| Service | Type-specific (SOAP, REST, Kafka, GraphQL, gRPC, WebSocket, etc.) | (leaf — operations appear in the Application/Service data grids after analysis) |
Selecting a node opens its detail panel in the right-hand area: the Project Panel, Application Panel, or Service Panel.
Context Menus
Right-click a tree node to open its context menu:
Project Node
- Add Application
- Analyze
- Reanalyze
- Build
- Save
- Save As
Application Node
- Add Service
- Design Service
- Analyze
- Reanalyze
- Delete Application
Service Node
- Analyze
- Reanalyze
- Delete Service
Keyboard Shortcuts
| Shortcut | Action |
|---|---|
Ctrl+S | Save project |
Ctrl+N | New project |
Ctrl+O | Open project |
Status Indicators
During analysis and build, the designer shows:
- Indeterminate progress bar — analysis is running.
- "completed / total" tag — how many services have finished (when analyzing more than one).
- Info bar — success, warning, or error messages (e.g. "The package has been generated", "Build the project first before publishing.").
Detail Panels
| Panel | Shows |
|---|---|
| Project Panel | Identity, Publishing, Version & Build, Export, Description, Changelog, and a Services data grid |
| Application Panel | Name, Description, and a Services data grid (name, type, Definition URI, status) |
| Service Panel | Name, Service Type, Definition URI (with Browse / Test Connection), Username, Password, Description, plus Service Description and Logs tabs |