Skip to content

PRDCT-583: redirect the migrated /extend/ pages to help (dev-side delete for #1046) #408

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Iamfle4ka wants to merge 1 commit into from
Closed

PRDCT-583: redirect the migrated /extend/ pages to help (dev-side delete for #1046) #408

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
121 changes: 0 additions & 121 deletions _data/navigation.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,70 +14,6 @@ items:
- url: /extend/
title: Extending Keboola
items:
- url: /extend/component/
title: Components
items:
- url: /extend/component/tutorial/
title: Tutorial
items:
- url: /extend/component/tutorial/input-mapping/
title: Input Mapping

- url: /extend/component/tutorial/output-mapping/
title: Output Mapping

- url: /extend/component/tutorial/configuration/
title: Configuration

- url: /extend/component/tutorial/processors/
title: Processors

- url: /extend/component/tutorial/debugging/
title: Debugging

- url: /extend/component/processors/
title: Processors

- url: /extend/component/code-patterns/
title: Code Patterns
items:
- url: /extend/component/code-patterns/interface/
title: Interface

- url: /extend/component/code-patterns/tutorial/
title: Tutorial

- url: /extend/component/implementation/
title: Implementation Notes
items:
- url: /extend/component/implementation/php/
title: PHP Implementation Notes

- url: /extend/component/implementation/python/
title: Python Implementation Notes

- url: /extend/component/implementation/r/
title: R Implementation Notes

- url: /extend/component/running/
title: Running Components

- url: /extend/component/ui-options/
title: UI Options
items:
- url: /extend/component/ui-options/configuration-schema/
title: Configuration Schema
items:
- url: /extend/component/ui-options/configuration-schema/examples
title: Examples
- url: /extend/component/ui-options/configuration-schema/sync-action-examples
title: Sync Action Examples
- url: /extend/component/ui-options/default-configuration/
title: Default Configuration

- url: /extend/component/deployment/
title: Deployment

- url: /extend/generic-extractor/
title: Generic Extractor
items:
Expand Down Expand Up @@ -201,63 +137,6 @@ items:
- url: /extend/generic-writer/configuration-examples/
title: Configuration Examples

- url: /extend/common-interface/
title: Common Interface
items:
- url: /extend/common-interface/folders/
title: Data Folders

- url: /extend/common-interface/config-file/
title: Configuration File

- url: /extend/common-interface/environment/
title: Environment

- url: /extend/common-interface/manifest-files/
title: Manifest Files
items:
- url: /extend/common-interface/manifest-files/in-tables-manifests/
title: IN tables

- url: /extend/common-interface/manifest-files/in-files-manifests/
title: IN files

- url: /extend/common-interface/manifest-files/in-files-s3-staging/
title: IN files S3 staging

- url: /extend/common-interface/manifest-files/in-files-abs-staging/
title: IN files ABS staging

- url: /extend/common-interface/manifest-files/out-tables-manifests/
title: OUT tables

- url: /extend/common-interface/manifest-files/out-tables-manifests-native-types/
title: OUT tables with Native Types

- url: /extend/common-interface/manifest-files/out-files-manifests/
title: OUT files

- url: /extend/common-interface/oauth/
title: OAuth2

- url: /extend/common-interface/actions/
title: Actions

- url: /extend/common-interface/logging/
title: Logging

- url: /extend/common-interface/development-branches/
title: Development branches

- url: /extend/job-queue/
title: Job Queue

- url: /extend/publish/
title: Publishing Component
items:
- url: /extend/publish/checklist/
title: Checklist

- url: /integrate/
title: Integration
items:
Expand Down
103 changes: 1 addition & 102 deletions extend/common-interface/actions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,106 +1,5 @@
---
title: Actions
permalink: /extend/common-interface/actions/
redirect_to: https://help.keboola.com/extend/common-interface/actions/
---

* TOC
{:toc}

Actions provide a way to execute very quick tasks in a single Component, using a single code base.
The default component's action (`run`) executes as a background, asynchronous job. It is queued, has plenty of
execution time, and there are cases when you might not want to wait for it. Apart from the default `run`, there
can be synchronous actions with limited execution time and you must wait for them. When we refer to
**actions**, we mean *synchronous actions*. Using actions is fully optional.

## Use Case
For example, in our database extractor, the main task (`run` action) is the data extraction itself. But we also want to be
able to test the database credentials and list tables available in the database.
These tasks would be very helpful in the UI. It is not possible to do these things directly in the browser. Setting up a
separate component would bring an overhead of maintaining both the extractor's Docker image and the new component.

## Solution
For each Component, you can specify other actions (apart from the default `run`). These
actions will be executed using the same Docker image, but [Job Queue](/extend/job-queue/) will wait for its execution and use
the returned value as the API response. So, these additional actions are executed *synchronously* and have a very
limited execution time (maximum 30 seconds). These actions also cannot access Storage.

The [configuration file](/extend/common-interface/config-file/#configuration-file-structure)
contains the `action` property with the name of the currently executed action. Just grab the value and act accordingly.
All actions must be explicitly specified in the component configuration in [Developer Portal](https://components.keboola.com/).

## Running Actions
Actions are available through the [API](https://api.keboola.com/?service=sync-actions#post-/actions).
They do not load the configuration from Storage, so you need to fully specify the whole configuration in the request body.
If any of your parameters are encrypted, they will be decrypted before they are passed to your component.

Do not specify the `action` attribute in the request body, it is already in the URI. Use any of `parameters` and `runtime` inside the `configData` root element as you would when creating an asynchronous job. Using `storage` configuration in actions makes no sense, because actions cannot read or write to Storage. For instance:

{% highlight json %}

{
"configData": {
"parameters": {
"key": "val"
}
}
}

{% endhighlight %}

### Return Values

As the component output is passed back through the API, all output from an action **MUST** be JSON (except for errors).

If your component outputs an invalid JSON on its STDOUT, an application error will be raised.

## Handling User and Application errors

Actions use the same [exit codes](/extend/common-interface/environment/#return-values) as the default `run` action.

If an user or application error is detected, STDERR/STDOUT is handled as the message string and is returned to the user. The message is wrapped into a standardized structure.

For example

{% highlight python %}
print('user error message')
sys.exit(1)
{% endhighlight %}

yields this message on the API (HTTP status code 400)

{% highlight json %}
{
"status": "error",
"error": "User error",
"code": 400,
"message": "user error message",
"exceptionId": "docker-7ed4c3b599776e8a2a84a7f185f5f7f2",
"runId": 0
}
{% endhighlight %}

and

{% highlight python %}
print('application error message')
sys.exit(2)
{% endhighlight %}

yields this message on the API (HTTP status code 500)

{% highlight json %}
{
"status": "error",
"error": "Application error",
"code": 500,
"message": "Contact support@keboola.com and attach this exception id.",
"exceptionId": "docker-2a51922e0753cf78297ad6d384200206",
"runId": 0
}
{% endhighlight %}

## Limits

**Sync actions may not read from or write data to the Storage.**
Otherwise actions share the same limits as the default `run` action, only the execution time is limited to 30 seconds.
This time does not include pulling the Docker image.
Loading
Loading