diff --git a/docs/access-control-and-security/applications.md b/docs/access-control-and-security/applications.md
index f5d13f7d..dabd162d 100644
--- a/docs/access-control-and-security/applications.md
+++ b/docs/access-control-and-security/applications.md
@@ -59,12 +59,12 @@ Configure the application’s roles and permissions to control what your applica
3. Enter the application name.
4. Select **Save**.
The application has been created. You can proceed to add roles or permissions to the application.
-2. Generate access keys.
- 1. In the Access Keys section, select **+ Create access key** to generate a unique keyId and keySecret. The Key Secret is shown only once, so make sure to copy and store it securely.
-3. Add roles to the application.
+2. Add roles to the application.
1. In the Application Roles or Unrestricted Roles section, toggle the different application roles for your application.
+3. Generate access keys.
+ 1. In the Access Keys section, select **+ Create access key** to generate a unique keyId and keySecret. The Key Secret is shown only once, so make sure to copy and store it securely.
4. Add permissions to grant application-level access to resources.
- 1. In the Permissions section, select **+ Add Permission**.
+ 1. In the Permissions section, select **+ Add permission**.
2. Toggle between each resource type and select the resources to provide access to.
3. Toggle the access levels for your selected resource:
* **Read**—The application will be able to view the resource.
diff --git a/docs/access-control-and-security/rbac-overview.md b/docs/access-control-and-security/rbac-overview.md
index cb37e4ab..855112f3 100644
--- a/docs/access-control-and-security/rbac-overview.md
+++ b/docs/access-control-and-security/rbac-overview.md
@@ -79,6 +79,7 @@ If multiple roles are granted, they will have all granted role-level permissions
| Metadata Manager | Can create, update, delete, and grant permissions to any workflow or task definition in the cluster. This role can only be granted by an Admin. |
| Workflow Manager | Can start, pause, resume, rerun, and delete any workflow execution in the cluster. This role can only be granted by an Admin. |
| Application Manager | Can create, update, and delete any application in the cluster. This role can only be granted by an Admin. |
+| Admin | Can create, read, modify, delete, and execute this particular application. This role can only be granted by an Admin. |
@@ -91,10 +92,10 @@ Besides the role-based permissions, you can add granular permissions to **groups
* Tasks
* Secrets
* Environment variables
-* Integrations
-* Prompts
* Tags
* Domains
+* Integrations
+* Prompts
Unlike other permission targets, **tags** and **domains** provide bulk access to multiple resources. Tags can be used to grant resources across almost every resource type. When you grant access for a tag “x”, all resources with the tag “x” will be made available to the group or application.
diff --git a/docs/access-control-and-security/tags.md b/docs/access-control-and-security/tags.md
index 6c6ac959..d0cedc51 100644
--- a/docs/access-control-and-security/tags.md
+++ b/docs/access-control-and-security/tags.md
@@ -95,7 +95,7 @@ The application now has access to all resources under the tag. You can select th
-Watch how to use tags to manage permissions in Orkes Platform.
+Watch how to use tags to manage permissions in Orkes Conductor.
VIDEO
diff --git a/docs/developer-guides/orchestrating-human-tasks.md b/docs/developer-guides/orchestrating-human-tasks.md
index a7ee1886..88e266c0 100644
--- a/docs/developer-guides/orchestrating-human-tasks.md
+++ b/docs/developer-guides/orchestrating-human-tasks.md
@@ -17,7 +17,7 @@ A Human task can be used for a variety of human-involved tasks, such as manual a
During workflow creation, the Human task can be configured for:
* **Assignment policy**—Define who can fill out the form, how long the form is assigned to them, and what to do if the assignment times out.
-* **Trigger policy**—Trigger a workflow to start if the task state changes.
+* **Trigger policy**—Trigger a workflow to start if the human task state changes.
During development, you can test and execute Human tasks internally on Orkes Conductor before integrating it with an external UI.
@@ -49,16 +49,18 @@ It is best practice to create forms using Orkes’ User Form studio, even if the
-#### Supported form components
+#### Supported form layout and components
-These are the pre-built form components available on Orkes Conductor:
+Horizontal and vertical layouts are supported for user forms.
+
+Following are the pre-built form components available on Orkes Conductor:
* Boolean
* Multiple Choice
* Date
* Date + Time
* Description Text
* Image
-* Number
+* Number Field
* Text
* Time
* Video
@@ -84,7 +86,7 @@ You can toggle to the Code tab to create custom components for your form. Howeve
| Boolean default value | Boolean. | Sets whether the default value is true or false. |
| Items split by commas | Multiple Choice and Radio. | Contains the list of selection items split by a comma. |
| Alignment | Description Text. | Sets the alignment of the description text. Supported values: Left Center Right Justify inherit |
-| Allow-decimal | Number. | Sets whether to allow decimal values as input. |
+| Allow-decimal | Number Field. | Sets whether to allow decimal values as input. |
| Multiline | Text. | Sets whether the text input box is multiline. |
| Height | Image and Video. | Sets the height of the image or video. |
| Width | Image and Video. | Sets the width of the image or video. |
@@ -115,7 +117,7 @@ Add the Human task to your workflow and configure its assignment policy and trig
**To add a Human task:**
1. In your workflow, select the **(+)** icon and add a **Human** task.
-2. In Task Definition, select a Human task definition.
+2. In Task Definition, select the task definition created in the previous step.
3. Enter the **Task display name**, which will appear on the connected UI for the user. Use a unique human-friendly name, such as “Loan Approval” or “Booking Form”.
4. Select the **UI template** previously created in the User Form studio and its **Version**.
5. (Optional) Add an assignment policy to control who can fill out the form.
@@ -125,11 +127,11 @@ Add the Human task to your workflow and configure its assignment policy and trig
* **Conductor User** or **Group**—Select this if the assignees are Conductor users and will access Orkes Conductor to complete the task.
3. Enter the **SLA minutes** to specify the assignment duration before it times out. Use 0 minutes to set a non-expiring assignment.
- 4. In **After assignments**, select the strategy for when the assignment times out.
+ 4. If needed, add another assignment to create a multi-level assignment chain.
+
+ 5. In **After assignments**, select the strategy for when the assignment times out.
* **Leave open**—The Human task execution remains open to be picked up by anyone.
* **Terminate**—The Human task execution is terminated and marked as deleted, and the workflow fails with the error “Task terminated as no more assignments pending and completion strategy is TERMINATE”.
- 5. If needed, add another assignment to create a multi-level assignment chain.
-
6. (Optional) Add a trigger policy to start new workflows when the state of the Human task changes. The trigger policy works based on the human task state in the **Executions > Human Tasks** list.
@@ -171,12 +173,12 @@ When the Human task begins, the associated user form will be assigned to the use
Create an external UI to display the user form as desired. Some common display options include an action inbox that contains all pending approval items or a multi-page form, with each page corresponding to one Human task on the Conductor end.
-2. Add the Human task to an application account and grant permissions for execution.
+2. Add the Human task to an application and grant permissions for execution.
-To use a Human task with an external UI, you need to add the Human task to an application account and grant Execute permission to the application.
+To use a Human task with an external UI, you need to add the Human task to an application and grant Execute permission to the application.
-**To add the Human task to application account:**
-1. Go to the application account.
+**To add the Human task to application:**
+1. Go to the application.
1. In the left navigation menu, go to **Access Control** > **Applications**, on your Orkes Conductor cluster.
2. Select an application that you will be adding your worker to. Otherwise, create an application.
2. Grant Execute, Read, and Update permission to the application.
@@ -186,7 +188,7 @@ To use a Human task with an external UI, you need to add the Human task to an ap
4. (If Task-to-domain is used) In Domain, enter the domain name used in your workflow.
5. Select Add Permissions.
-The application account can now execute the Human task.
+The application can now execute the Human task.
3. Configure the Human task for external form assignment.
@@ -196,7 +198,7 @@ If the assignment policy in the Human task is not yet configured, go to the Huma
4. Integrate the UI with Conductor.
-Use the Human Tasks APIs to integrate your external UI with your Conductor cluster. Get the API authentication tokens (key and secret) from your application account in Conductor.
+Use the Human Tasks APIs to integrate your external UI with your Conductor cluster. Get the API authentication tokens ([key and secret](https://orkes.io/content/access-control-and-security/applications#configuring-applications)) from your application account in Conductor.
1. **Display all active Human task executions.**
Call `GET human/tasks/search` to list Human tasks with Assigned status and Assignee as External Group or External User.
@@ -272,8 +274,7 @@ In your selected Human task, select **Skip** to bypass it. Alternatively, select
* **External User** or **Group**—Select this if the assignees are managed and verified in an external system, and will access an external UI to complete the task.
* **Conductor User** or **Group**—Select this if the assignees are Conductor users and will access Orkes Conductor to complete the task.
3. Enter the **SLA minutes** to specify the assignment duration before it times out. Use 0 minutes to set a non-expiring assignment.
-4. In **After assignments**, select the strategy for when the assignment times out.
-5. If needed, add another assignment to create a multi-level assignment chain.
+4. If needed, add another assignment to create a multi-level assignment chain.
diff --git a/docs/developer-guides/scheduling-workflows.md b/docs/developer-guides/scheduling-workflows.md
index 591fff89..ac9da198 100644
--- a/docs/developer-guides/scheduling-workflows.md
+++ b/docs/developer-guides/scheduling-workflows.md
@@ -128,7 +128,7 @@ Once the schedulers are defined, you can view the executions from the **Executio
-The execution page lists the details of all the scheduler executions. It includes details such as scheduled time, execution time, execution ID, workflow ID, status, reason for failure, and error details. You can view the workflow execution by directly clicking on the workflow ID. You can also filter further information using the available options.
+The execution page lists the details of all the scheduler executions. It includes details such as scheduled time, execution time, execution ID, schedule name, workflow name, workflow ID, status, reason for failure, and error details. You can view the workflow execution by directly clicking on the workflow ID. You can also filter further information using the available options.
In addition, you can view the scheduler execution as code directly from the UI. To do this, click the arrow in the Search button and choose “Show as code”.
diff --git a/docs/developer-guides/task-to-domain.md b/docs/developer-guides/task-to-domain.md
index b34370aa..edaa7355 100644
--- a/docs/developer-guides/task-to-domain.md
+++ b/docs/developer-guides/task-to-domain.md
@@ -264,13 +264,13 @@ The application/group can now execute all tasks under the specified domain.
A fallback domain is a secondary or backup domain that the system will use if the primary domain fails or is unreachable. These domains can only be specified when triggering a workflow, as clients polling for tasks can use only one domain at a time.
-Conductor tracks each worker's last polling time. When assigning tasks, it first checks if any active workers are available for the primary domain. If no active workers are found, the Conductor tries the next domain in the fallback sequence.
+Conductor tracks the last polling time for each worker. When assigning tasks, it first checks if any active workers are available for the primary domain. If no active workers are found, the Conductor tries the next domain in the fallback sequence.
:::note Notes
-* A worker is considered active if the last time it has polled is within the active threshold, which defaults to 10 seconds
-* Workers do not poll when they are busy doing work and resume polling once they have completed their tasks
-* The active threshold can be adjusted using the configuration field `conductor.app.activeWorkerLastPollTimeout`. This applies to all worker tasks, so extending the duration slows down the fallback response bahaviour across all tasks.
-* The domain of a task is determined at the point in time when the task is scheduled, so a domain worker becoming free after a task gets scheduled will not change the domain of a task that has already been scheduled
+* A worker is considered active if the polled time is within the active threshold, which defaults to 10 seconds.
+* Workers do not poll when they are busy doing work and resume polling after completing their tasks.
+* The active threshold can be adjusted using the configuration field `conductor.app.activeWorkerLastPollTimeout`. This applies to all worker tasks, so extending the duration slows down the fallback response behavior across all tasks.
+* The domain of a task is determined at the time when the task is scheduled. Therefore, a domain worker becoming available after a task is scheduled will not change the domain of the already scheduled task.
:::
A fallback mapping for `task_x’ is as follows:
diff --git a/docs/developer-guides/using-llms-in-your-orkes-conductor-workflows.md b/docs/developer-guides/using-llms-in-your-orkes-conductor-workflows.md
index 3a8b74e8..2ae70fa9 100644
--- a/docs/developer-guides/using-llms-in-your-orkes-conductor-workflows.md
+++ b/docs/developer-guides/using-llms-in-your-orkes-conductor-workflows.md
@@ -46,7 +46,7 @@ The first step is integrating the required LLM model providers with your Orkes C
For example, if you are using Open AI as the model provider, it has different models: Ada, Babbage, Curic, Davinci etc. These models vary in capabilities, such as memory, trained data, and more. You can configure the required model to be used within your organization based on your requirements.
-### Steps to Integrate AI / LLM Models with Orkes Conductor
+### Steps to Integrate AI/LLM Models with Orkes Conductor
1. Navigate to **Integrations** from the left menu on your Orkes Conductor cluster.
2. Click **+New integration** button from the top-right of your window.
@@ -55,11 +55,11 @@ For example, if you are using Open AI as the model provider, it has different mo
4. Click +**Add** and provide the required parameters for the chosen provider.
-5. You can toggle-on the **Active** button to activate the integration instantly.
+5. Enable the **Active** option to activate the integration instantly.
6. Click **Save**.
:::note
-The integration parameters to be configured differ with these models. Refer to the [AI / LLM Integrations](/content/category/integrations/ai-llm) document for detailed steps to integrate each model.
+The integration parameters to be configured differ with these models. Refer to the [AI/LLM Integrations](/content/category/integrations/ai-llm) document for detailed steps to integrate each model.
:::
### Different Use Cases of Various Integration Models
@@ -135,7 +135,7 @@ Now, let’s test the prompt right away by filling in the following parameters:
| --------- | ----------- |
| Select model to test | From the chosen LLM models, you can choose any model for testing the prompt. This makes your AI prompt diverse to be used among any language models, provided they have been integrated with your cluster. |
| Temperature | Set the required temperature based on your requirements. Temperature is a parameter to indicate the randomness of the model’s output. Higher temperatures, such as 1.0, make the output more random and creative. It can be used for generating creative content like creating social media posts, drafting emails, etc. Whereas a lower value makes the output more stable and focused. It can be used in cases like text classification, where you provide a text and classify it into appropriate categories. |
-| Stop words | In LLM, stop words may be filtered out or given less importance during the text generation process to ensure that the generated text is coherent and contextually relevant. |
+| Stop words | In LLM, stop words may be filtered out or given less importance during the text generation process to ensure that the generated text is coherent and contextually relevant. The stop words are the words that are used in the sentences like “and”, “a”, and “the”, etc., but do not potentially provide any specific meaning but are required in completing the sentences. Provide the stop words to be filtered out. |
| TopP | Another parameter to control the randomness of the model’s output. This parameter defines a probability threshold and then chooses tokens whose cumulative probability exceeds this threshold. For example: Imagine you want to complete the sentence: “She walked into the room and saw a ______.” Now, the top 4 words the LLM model would consider based on the highest probabilities would be:Cat - 35% Dog - 25% Book - 15% Chair - 10% If you set the topP parameter to 0.70, the AI will consider tokens until their cumulative probability reaches or exceeds 70%. Here's how it works:Adding "Cat" (35%) to the cumulative probability. Adding "Dog" (25%) to the cumulative probability, totaling 60%. Adding "Book" (15%) to the cumulative probability, now at 75%. At this point, the cumulative probability is 75%, exceeding the set top-p value of 70%. Therefore, the AI will randomly select one of the tokens from the list of "Cat," "Dog," and "Book" to complete the sentence because these tokens collectively account for approximately 75% of the likelihood.|
Now, you can test it right there by clicking the **Test** button.
@@ -154,7 +154,7 @@ To provide permissions to Groups:
1. Navigate to **Access Control > Groups** from the left menu on your Orkes Conductor cluster.
2. Create a new group or choose an existing one with the members needing access to prompts.
-3. Under **Permissions** section, click +Add Permission.
+3. Under **Permissions** section, click **+Add Permission**.
4. Under the **Prompt** tab, choose the required prompts with the required permissions.
@@ -165,7 +165,7 @@ Similarly, you can also provide permissions to [applications](https://orkes.io/c
## Using AI Prompts in LLM Tasks in Orkes Conductor
-The AI Prompts and models integrated earlier are now ready to be used in your workflows in Orkes Conductor. To do that, you need to add a system task [LLM Text Complete](/content/reference-docs/ai-tasks/llm-search-index) while creating workflows in Orkes Conductor.
+The AI Prompts and models integrated earlier are now ready to be used in your workflows in Orkes Conductor. To do that, you need to add a system task like [LLM Text Complete](/content/reference-docs/ai-tasks/llm-search-index) while creating workflows in Orkes Conductor.
### Creating Workflow with LLM Text Complete Task
@@ -174,7 +174,7 @@ If you are creating the workflow via the UI method,
1. Navigate to **Definitions > Workflow** from the left menu on your Orkes Conductor cluster.
2. Click **Define Workflow** from the top-right corner.
3. Click **Start** on the diagram and add the **LLM Text Complete** task.
-4. Choose the required LLM provider and model.
+4. Choose the required LLM Provider and Model.
5. Choose the created AI prompt under the **Prompt Template** field as shown below:
@@ -224,7 +224,7 @@ Let’s assume that **Azure Open AI** with **text-davinci-003** model is to be i
1. Navigate to **Integrations** from the left menu on your Orkes Conductor cluster.
2. Click **+New integration** button from the top-right of your window.
-3. Under the **AI / LLM** section, choose **Azure + OpenAI**.
+3. Under the **AI/LLM** section, choose **Azure + OpenAI**.
4. Click **+Add** and provide a name, description, endpoint, and the Azure OpenAI API key.
@@ -270,14 +270,14 @@ Now, let's add the **text-davinci-003** model to the integration.
#### Step 4 - Create Workflow Definitions
1. Navigate to **Definitions > Workflow** from the left menu on your Orkes Conductor cluster.
-2. Click **Define Workflow** from the top-right corner.
+2. Click **+Define Workflow** from the top-right corner.
3. Click **Start** on the diagram and add the **LLM Text Complete** task.
4. Choose the **LLM provider** as __azure_openai__ and the **model** as __text-davinci-003__.
5. Choose the created AI prompt under the **Prompt Template** field as shown below:
-8. Let’s also wire the variable **input & language** to workflow inputs.
+8. Let’s also wire the variables **input** and **language** to workflow inputs.
You can get the complete workflow JSON here:
diff --git a/docs/developer-guides/using-vector-databases-in-your-orkes-conductor-workflows.md b/docs/developer-guides/using-vector-databases-in-your-orkes-conductor-workflows.md
index f4cd7be8..b9f35f39 100644
--- a/docs/developer-guides/using-vector-databases-in-your-orkes-conductor-workflows.md
+++ b/docs/developer-guides/using-vector-databases-in-your-orkes-conductor-workflows.md
@@ -48,7 +48,7 @@ The first step is integrating the required vector databases with your Orkes Cond
4. Click **+Add** and provide the required parameters for the chosen provider.
-5. You can toggle-on the **Active** button to activate the integration instantly.
+5. Enable the **Active** option to activate the integration instantly.
6. Click **Save**.
:::note
@@ -93,7 +93,7 @@ The following system tasks require a vector database to be configured:
If you are creating the workflow via the UI method,
1. Navigate to **Definitions > Workflow** from the left menu on your Orkes Conductor cluster.
-2. Click **Define Workflow** from the top-right corner.
+2. Click **+Define Workflow** from the top-right corner.
3. Click **Start** on the diagram and add the required system task based on your use case.
4. Choose the configured vector database and indexes.
diff --git a/docs/developer-guides/webhook-integration.md b/docs/developer-guides/webhook-integration.md
index 7631244f..62845670 100644
--- a/docs/developer-guides/webhook-integration.md
+++ b/docs/developer-guides/webhook-integration.md
@@ -59,7 +59,7 @@ Once the workflow is created, the next step is to create a webhook.
5. Copy the generated URL to the platform from which the webhook will be invoked. This step varies with the platform being integrated.
-6. Once the URLs are verified (using the respective verification method), the URL status will be marked as **Verified**.
+6. Once the URLs are verified (using the respective [verification method](/content/developer-guides/webhook-integration#supported-webhook-verification-methods)), the URL status will be marked as **Verified**.