Skip to content

Commit

Permalink
docs(enterprise): App-based Workflow Step (#200)
Browse files Browse the repository at this point in the history
  • Loading branch information
rohalskyy authored Feb 13, 2025
1 parent f070971 commit 59c1051
Show file tree
Hide file tree
Showing 4 changed files with 96 additions and 0 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
---
title: App-based Workflow Step
description: Configure new workflow steps unlocked by installing apps from the Crowdin Store
slug: enterprise/app-based-workflow-step
sidebar:
order: 5
---

import { Image } from 'astro:assets';
import { Aside, LinkCard, CardGrid } from '@astrojs/starlight/components';
import ReadMore from '~/components/ReadMore.astro';
import appBasedStepWorkflowEditor from '!/enterprise/organization-management/app_based_step_workflow_editor.png';
import workflowIssuesBanner from '!/enterprise/organization-management/workflow_issues_banner.png';

App-based workflow steps become available after you install specific apps from the [Crowdin Store](https://store.crowdin.com/) or add private apps to your Crowdin Enterprise organization. These steps can provide specialized functionality like AI-driven proofreading, delayed processing, etc., and are a powerful way to tailor workflows to your team's exact needs. By adding them to your workflow, you expand Crowdin Enterprise's default capabilities with unique conditions, automation, and integrations.

## Use Cases

Below are a few examples of how app-based steps can enhance your workflows. Some are drawn from existing Crowdin Store apps, while others illustrate broader possibilities:

* **Workflow Delay** – The [Workflow Delay](https://store.crowdin.com/workflow-step-delay) app adds checkpoint-style steps that pause segments until conditions are met or on a set schedule. This helps prevent incomplete or unverified segments from moving forward prematurely, improving overall translation consistency.

* **AI Proofreader** – The [AI Proofreader](https://store.crowdin.com/ai-proofread-agent) app introduces an **AI Proofreader** workflow step. It can automatically proofread content across multiple languages using custom AI prompts and perform various actions, reducing or even eliminating the need for manual proofreading.

* **AI Source Review** – Another possible scenario could be an app that automatically reviews and refines source text before translation, catching typos, style inconsistencies, or placeholders that might cause issues later. This approach helps ensure higher-quality translations by starting with well-polished source strings.

* **AI Labeling** – A step that could analyze your strings and automatically apply labels (e.g., “Marketing Content,” “Technical Doc,” “High Priority”), helping route content to the most appropriate translation or review paths.

<CardGrid>
<LinkCard
title="Workflow Overview"
href="/enterprise/workflows/"
/>
<LinkCard
title="Crowdin Store"
href="https://store.crowdin.com/"
/>
</CardGrid>

## Installing Apps from the Crowdin Store

Before you can add an app-based workflow step, you need to install the corresponding app. You can install apps from the Crowdin Store or, if you've developed your own, add it as a private app. Depending on the app, you may need specific permissions (e.g., Manager or Admin) to install it.

Once installed, the new step types appear in your workflow editor or workflow template editor.

<ReadMore>
Read more about [Installing Crowdin Apps](/developer/crowdin-apps-installation/#installation-in-crowdin-enterprise).
</ReadMore>

<Aside type="caution">
If you uninstall the app later, any workflow that uses the app-based step will show an error or be flagged as having issues.
</Aside>

## Adding App-based Workflow Steps to Your Workflow

You can add app-based workflow steps directly to a project's workflow in the workflow editor or include them in workflow templates via the workflow template editor.

<Image src={appBasedStepWorkflowEditor} alt="App-based Workflow Steps in the workflow editor" />

## Step Configuration

Depending on how the app is implemented, an app-based workflow step may offer various configuration options, or none at all. For example:

* **Configurable Steps** – Some steps allow you to adjust parameters in the workflow editor (e.g., specifying a delay for content processing). In these cases, you can modify the available options to suit your needs.

* **Pre-configured Steps** – Other steps have all their settings predefined by the app (e.g., delaying content until an entire file is fully translated), so no additional fields appear in the workflow editor.

If a step provides configuration fields, they typically appear in the step's settings panel once you drag it into the workflow.

These fields can include anything from AI prompts and allowed actions (e.g., approving or deleting translations, adding translation suggestions or comments, etc.) to API tokens, delay intervals, or match conditions — whatever the app developer has enabled. If there are no visible configuration options, the app likely manages all necessary setup internally.

<Aside type="tip">
We recommend to always explore the app's documentation for details on any available settings it may provide.
</Aside>

## Troubleshooting

When an app-based step is misconfigured, Crowdin Enterprise flags the workflow as having issues. You may notice:

* **Error Banners and Inactive Steps** – If the app is removed or becomes inactive, your project's Dashboard may display a banner informing about the workflow issues with instructions on how to resolve them.
<Image src={workflowIssuesBanner} alt="Workflow Issues Banner" />
In the workflow editor, you may see steps with failed validations (e.g., *The application required for this step type is uninstalled*). To fix this, reinstall the app and reconfigure its step, or remove the step if it's no longer needed.
* **Validation Warnings** – When saving changes to the workflow, a warning might appear if the app-based step is misconfigured or has unmet dependencies (e.g., *Workflow Delay Agent requires manager permissions*).
* **No Access to the App-based Step** – Occasionally, an app-based step may not appear in the workflow editor if the app was installed with limited project access or if you lack the required role (e.g., Manager). Check your project settings to confirm you have Manager or Admin rights and that the app is allowed in the intended project.
* **Connectivity or External Service Errors** – If an app-based step relies on a third-party service or API, timeouts or network failures may cause the step to fail or get stuck.
* **Check Service Status**: Verify that any external service used by the app is online and functioning properly.
* **Inspect Logs**: If the app provides logs or an admin panel, review any error messages it may have generated.
* **Network & Firewall Settings**: Verify that your firewall or VPN isn't blocking the app's requests.
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,14 @@ The Proofreading step involves reviewing and refining translations to ensure acc

The Proofreading by Vendor step allows you to outsource proofreading tasks to professional vendors. Choose a vendor, specify the target languages, and provide any necessary instructions in the comment section that will be sent along with the content. This step is ideal for ensuring high-quality translations and efficiently scaling your proofreading efforts.

### App-based Workflow Step

By installing apps from the [Crowdin Store](https://store.crowdin.com/), you can introduce custom steps into your workflow. Depending on the app, these steps might provide advanced QA checks, AI-driven proofreading, scheduling or delaying content processing, or other specialized functionalities. This gives you the flexibility to tailor workflows to your team’s exact needs.

<ReadMore>
Read more about [App-based Workflow Step](/enterprise/app-based-workflow-step/).
</ReadMore>

## Assigning Workflows to Projects

If you choose a project with a workflow during project creation, you’ll be asked to choose a workflow. To assign an existing workflow template, click on the preferred workflow, and then click **Create Project**.
Expand Down

0 comments on commit 59c1051

Please sign in to comment.