Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 18 additions & 6 deletions src/pages/get_started/app_builder_get_started/app-builder-intro.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,24 @@
---
keywords:
- Adobe I/O
- Extensibility
- API Documentation
- Developer Tooling
title: How it Works
- Adobe I/O
- Extensibility
- API Documentation
- Developer Tooling
- App Builder
title: Get Started with App Builder
description: A comprehensive guide to building, deploying, testing, and publishing your first App Builder app with Adobe I/O Runtime and Developer Console.
faqs:
- question: What is App Builder used for?
answer: App Builder helps you create, deploy, and manage custom applications integrated with Adobe Experience Cloud using Adobe I/O Runtime and APIs.
- question: How do I start building an app with App Builder?
answer: Begin by creating a new project in the Developer Console, adding necessary API credentials, and setting up your local development environment.
- question: What are sandboxes in App Builder?
answer: Sandboxes are separate environments like development, staging, and production to safely build and test your app before publishing.
- question: How do I deploy and test my app?
answer: Use the CLI to deploy your app to a sandbox or integrate it with a GitHub CI/CD pipeline to run and simulate end-user interactions.
- question: How is my app published and made available to users?
answer: After deploying and testing, initiate the publish process in the Developer Console; after admin approval, your app will be accessible in Adobe Experience Cloud.
---

# Get Started with App Builder

This series of tutorials will show you how to:
Expand Down
24 changes: 18 additions & 6 deletions src/pages/get_started/app_builder_get_started/first-app.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,24 @@
---
keywords:
- App Builder
- Extensibility
- API Documentation
- Developer Tooling
title: Creating your First App Builder Application
- App Builder
- Extensibility
- API Documentation
- Developer Tooling
- Adobe Developer Console
title: Create your First App Builder Application
description: This guide walks you through the essential steps to set up and develop your first App Builder Application using Adobe Developer Console and CLI tools.
faqs:
- question: What is the Adobe Developer Console used for in App Builder?
answer: Adobe Developer Console is used to create projects, manage credentials, add APIs and events, and configure workspaces for developing App Builder applications.
- question: How do I start creating a new App Builder project?
answer: You start by logging into Adobe Developer Console, creating a project from the App Builder template, and then configuring your project and workspaces.
- question: What is the purpose of workspaces in an App Builder project?
answer: Workspaces provide isolated environments for development, staging, and production, each with independent credentials and connected services.
- question: How can I log in to Adobe from the CLI?
answer: Use the command `aio login` in your terminal to open a browser window for Adobe ID authentication, which stores your credentials for CLI use.
- question: Can I change the App Name after creating the project?
answer: No, the App Name is a unique identifier and cannot be changed once the project setup is complete.
---

# Create your First App Builder Application

This is a guide through the steps to set up and develop an App Builder Application. Please refer to the [Common issues](#8-common-issues) section at the end of this page to resolve any problems you encounter.
Expand Down
20 changes: 14 additions & 6 deletions src/pages/get_started/app_builder_get_started/index.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,20 @@
---
keywords:
- Adobe I/O
- Extensibility
- API Documentation
- Developer Tooling
title: App Builder and Adobe I/O Runtime
description: App Builder simplifies building cloud-native applications for Adobe I/O Runtime, enabling easy conversion and deployment of existing actions. Learn the main steps to migrate and manage your apps efficiently.
keywords:
- Adobe I/O
- Extensibility
- API Documentation
- Developer Tooling
- Cloud Native Applications
faqs:
- question: What is Adobe I/O Runtime used for in App Builder?
answer: Adobe I/O Runtime provides a serverless platform where App Builder applications can run, enabling scalable deployments and event-driven functions.
- question: How can I convert existing Adobe I/O Runtime actions to App Builder applications?
answer: You can create a new project with the App Builder template in the Developer Console, copy your existing actions into this project, and deploy them using the Adobe CLI.
- question: What are the prerequisites for setting up App Builder with Adobe I/O Runtime?
answer: You need to configure the Adobe CLI, create a project in the Developer Console, and initialize your application environment before deploying your actions.
---

# App Builder and Adobe I/O Runtime

App Builder greatly simplifies the process of building cloud native applications that run on Adobe I/O Runtime.
Expand Down
22 changes: 17 additions & 5 deletions src/pages/get_started/app_builder_get_started/publish-app.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,24 @@
---
keywords:
- Adobe I/O
- Extensibility
- API Documentation
- Developer Tooling
- Adobe I/O
- Extensibility
- API Documentation
- Developer Tooling
- App Builder Publishing
title: Publishing Your First App Builder Application
description: This guide walks you through the essential steps to publish your first App Builder Single-Page Application, from submission to approval and final deployment in Adobe Experience Cloud.
faqs:
- question: What are the initial steps to publish an App Builder application?
answer: To publish your app, submit it for approval via the Adobe Developer Console, have your organization administrator review it in My Exchange, and then verify the published app in Adobe Experience Cloud.
- question: Who approves an App Builder application before publishing?
answer: The enterprise organization administrator is responsible for reviewing and approving App Builder applications before they are published.
- question: How can I track the status of my app submission?
answer: After submission, you can track your app’s status in the Adobe Developer Console under the Approval screen, where it will show statuses like "In Review," "Approved," or "Rejected."
- question: What happens if my app submission is rejected?
answer: If rejected, the administrator provides notes explaining what needs to be fixed, allowing you to make corrections and resubmit for approval.
- question: Can headless App Builder apps be published the same way as SPAs?
answer: No, headless apps are handled differently; refer to the Code Lab "Headless Apps with App Builder" for the appropriate publishing process.
---

# Publishing Your First App Builder Application

This tutorial will guide you through the three steps needed to publish your first App Builder Single-Page Application (SPA):
Expand Down
23 changes: 17 additions & 6 deletions src/pages/get_started/app_builder_get_started/set-up.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,24 @@
---
keywords:
- Acquire Access
- Credentials
- Local Environment
- Set up
title: Set Up Access, Environment, and Tools
description: App Builder is a complete framework that enables enterprise developers to build and deploy custom web applications that extend Adobe Experience Cloud solutions and run on Adobe infrastructure.
keywords:
- Acquire Access
- Credentials
- Local Environment
- Set up
- Adobe I/O CLI
faqs:
- question: What roles are required to access the Adobe Experience Cloud IMS organization for App Builder?
answer: You need to be a member of the IMS organization with either a Developer or System Admin role to access App Builder.
- question: How can customers or partners request access to App Builder if they do not have it?
answer: Customers should request access from their account manager or company IT/Marketing admin, while partners should request it through their partner manager or the Adobe Solution Partner Portal.
- question: What NodeJS versions are recommended for setting up the local environment?
answer: NodeJS versions 18 or 20 are recommended; odd versions are not advised for the best compatibility.
- question: How do I ensure my Adobe I/O CLI is up to date?
answer: Check your CLI version with `aio -v` and compare it to the latest version on npm. Update using `npm install -g @adobe/aio-cli` and run `aio update` to update core plugins.
- question: Is Visual Studio Code required for local development with App Builder?
answer: Visual Studio Code is the supported IDE recommended for editing and debugging, but you can use other code editors for basic development without advanced debugging features.
---

# Set Up Access, Environment, and Tools

Here you'll learn what systems you need to access, how to access them, and how to configure your local environment.
Expand Down
24 changes: 18 additions & 6 deletions src/pages/get_started/app_builder_get_started/troubleshoot.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,24 @@
---
keywords:
- Adobe I/O
- Extensibility
- API Documentation
- Developer Tooling
title: Troubleshooting Common Issues
description: This guide provides solutions for common issues encountered when developing App Builder apps, including debugging tips and authentication error fixes.
keywords:
- Adobe I/O
- Extensibility
- API Documentation
- Developer Tooling
- App Builder Troubleshooting
faqs:
- question: How can I view the logs for debugging my App Builder actions?
answer: You can use the App Builder Logging SDK and run commands like `aio runtime activation list` to see activation summaries, or `aio runtime activation logs activationID` to view detailed logs of specific activations.
- question: What should I do if I encounter authorization errors with Adobe authentication?
answer: Verify that your SPA or headless app uses the correct user tokens or JWTs respectively, and ensure that the `web-src/` folder is properly configured or removed for headless apps to avoid token validation issues.
- question: Why might running actions locally with `aio app dev` not work with State or Files SDKs?
answer: Debugging locally with `aio app dev` won't work with State or Files SDKs because their security restricts access to cloud storage from outside Adobe Runtime; using your own cloud storage can resolve this.
- question: How do I handle NodeJS compatibility issues on Mac M1 chips?
answer: Since precompiled NodeJS binaries prior to version 15.x do not support the ARM64 architecture, switching your shell architecture from arm64 to x86 using nvm is recommended.
- question: How can I ensure that web actions record activation results and logs?
answer: Pass the header `x-ow-extra-logging: on` in your web action requests to enforce persistence of activation results and logs, especially useful during SPA development.
---

# Troubleshooting Common Issues

This is a guide for troubleshooting some of the most common issues you may encounter when developing App Builder apps.
Expand Down
17 changes: 17 additions & 0 deletions src/pages/get_started/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,20 @@
---
title: Getting Started with App Builder
description: Learn how to set up your development environment and create your first application with App Builder, including comprehensive guides for both App Builder and Adobe I/O Runtime users.
keywords:
- App Builder
- Adobe I/O Runtime
- Serverless development
- Application setup
- Troubleshooting
faqs:
- question: What is the first step to start using App Builder?
answer: Begin by setting up your development environment and following the App Builder Getting Started guide to create and publish your first application.
- question: How does Adobe I/O Runtime relate to App Builder?
answer: Adobe I/O Runtime provides serverless capabilities that complement App Builder, allowing you to create and deploy actions with ease.
- question: Where can I find more detailed information after the getting started guides?
answer: After completing the initial guides, you can explore the detailed Guides section for specific features and visit the Resources section for additional support.
---
# Getting Started with App Builder

Welcome to the Getting Started section of App Builder documentation. Here you'll find comprehensive guides to help you start working with App Builder and Adobe I/O Runtime.
Expand Down
21 changes: 21 additions & 0 deletions src/pages/get_started/runtime_getting_started/activations.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,24 @@
---
title: Retrieve Action Invocation Results
description: Learn how to retrieve and interpret action invocation results including activation IDs, logs, and responses using Adobe I/O Runtime CLI commands. Understand how to handle activation records and troubleshoot asynchronous actions.
keywords:
- Action invocation results
- Adobe I/O Runtime
- Activation ID
- Asynchronous actions
- Debugging activations
faqs:
- question: What information is contained in an action invocation activation record?
answer: An activation record includes the unique Activation ID, namespace and action name, logs generated, and a response object with status and result details.
- question: How can I list recent action activations?
answer: Use the command `aio rt:activation:list` to view activation IDs and the names of actions invoked in the last seven days.
- question: How do I retrieve the full activation record for a specific activation ID?
answer: Run `aio rt:activation:get <activation id>` to retrieve the entire activation record including logs, annotations, and response data.
- question: Why might I not see activation results for some synchronous actions?
answer: The system does not persist successful synchronous activation results to optimize performance; only asynchronous non-blocking invocations store their results regardless of success or failure.
- question: What should I do if I get an error retrieving results for a non-blocking asynchronous action?
answer: The activation may not be completed yet; querying results or logs too soon after invocation can cause "resource does not exist" errors.
---
# Retrieve Action Invocation Results

The activation record of an action invocation contains information to help you understand what happened. It contains the invocation's:
Expand Down
21 changes: 21 additions & 0 deletions src/pages/get_started/runtime_getting_started/entities.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,24 @@
---
title: Entities and Core Concepts
description: Learn about Adobe I/O Runtime's key entities including actions, namespaces, triggers, rules, packages, sequences, compositions, and feeds, and how they interact to form a serverless computing model.
keywords:
- Adobe I/O Runtime
- Actions
- Triggers and Rules
- Packages and Compositions
- Serverless Architecture
faqs:
- question: What are Actions in Adobe I/O Runtime?
answer: Actions are stateless functions that execute in response to events. They perform tasks such as processing images, responding to API calls, or posting tweets.
- question: How does a Namespace help organize Runtime entities?
answer: A namespace prefixes all entity names for an organization, helping to logically organize and separate entities within Adobe I/O Runtime.
- question: What is the difference between Triggers and Feeds?
answer: Triggers classify and activate events that initiate actions, while feeds manage the stream of events by creating, deleting, or pausing event flows to triggers.
- question: How do Rules function in Adobe I/O Runtime?
answer: Rules link triggers to actions so that when a trigger fires, the associated action is invoked with the trigger’s event data.
- question: What are Sequences and Compositions?
answer: Sequences chain multiple actions in order where output of one feeds the next, while compositions use complex logic flows to execute actions in variable orders using combinator methods.
---
# Entities and Core Concepts

Adobe I/O Runtime's computing model is composed of functional elements or entities, and the interactions among them. This glossary defines the most important entities, outlines their interactions, and links to relevant resources in the Guides and elsewhere in this documentation.
Expand Down
21 changes: 21 additions & 0 deletions src/pages/get_started/runtime_getting_started/how-runtime-works.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,24 @@
---
title: How Adobe I/O Runtime Works
description: Learn how Adobe I/O Runtime leverages the Apache OpenWhisk platform to provide scalable, event-driven function-as-a-service capabilities with serverless architecture. This guide explains the internal components and process flow behind action invocation and execution.
keywords:
- Adobe I/O Runtime
- Apache OpenWhisk
- serverless architecture
- function-as-a-service
- event-driven computing
faqs:
- question: What is Adobe I/O Runtime?
answer: Adobe I/O Runtime is a serverless platform based on Apache OpenWhisk that allows developers to run functions triggered by events without managing servers. It supports event-driven, scalable, and cost-efficient function execution.
- question: How does Adobe I/O Runtime handle action execution?
answer: When an event triggers an action, Adobe I/O Runtime queues the action for execution via Kafka, deploys it in isolated containers managed by the Invoker, runs the code, and returns the result before cleaning up resources.
- question: What role does Kafka play in Adobe I/O Runtime?
answer: Kafka manages event queues between the Controller and Invoker, enabling asynchronous, scalable, and reliable processing of action invocation requests with fault tolerance and monitoring.
- question: How does Adobe I/O Runtime ensure scalability and cost efficiency?
answer: By instantiating containers only when needed to execute actions and disposing them afterward, Adobe I/O Runtime scales automatically with trigger volume and avoids costs from idle resources.
- question: Can actions be chained or sequenced in Adobe I/O Runtime?
answer: Yes, developers can chain actions into sequences by piping outputs of one action to inputs of the next without writing additional code, enabling complex workflows within the Runtime platform.
---
```yaml
keywords:
- [need keywords]
Expand Down
17 changes: 17 additions & 0 deletions src/pages/get_started/runtime_getting_started/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,20 @@
---
title: Get Started with Adobe I/O Runtime
description: Learn how to use Adobe I/O Runtime, Adobe’s serverless computing platform, to deploy and execute custom code in the cloud without managing servers. Discover how to build scalable applications that integrate with Adobe services and workflows.
keywords:
- Adobe I/O Runtime
- serverless computing
- Apache OpenWhisk
- function-as-a-service
- cloud functions
faqs:
- question: What is Adobe I/O Runtime?
answer: Adobe I/O Runtime is a serverless platform based on Apache OpenWhisk that lets you deploy and run your own code in the cloud without managing servers. It enables building event-driven applications using functions called actions.
- question: How do I get started with Adobe I/O Runtime?
answer: You can start by setting up your environment, deploying your first action, and retrieving invocation results with the step-by-step tutorials provided in the documentation.
- question: What kind of applications can I build with Adobe I/O Runtime?
answer: You can create custom workflows, automate tasks, and build applications that respond to Adobe I/O Events, leveraging Adobe content and data through flexible, on-demand cloud functions.
---
# Get Started with Adobe I/O Runtime

Adobe I/O Runtime is Adobe’s serverless computing platform based on Apache OpenWhisk, an open-source project of the Apache Software Foundation. Runtime lets you deploy your own custom code to the cloud and call it as needed, so you can execute functions, also called "actions," from the cloud without deploying or configuring a server.
Expand Down
Loading