cs-icon.svg

Automate App

The Automate App provides functionalities to integrate Automate into your stack. With the Automate App, you can bring all the capabilities of Automate to your entry editor in the CMS.

Let’s see how you can use and install the Automate app via the Marketplace to get started.

Prerequisites

  1. Contentstack Account
  2. Access to the Contentstack Organization/Stack as the Owner/Admin

Steps for Execution

  1. Install Automate App
  2. Create an Automation
  3. Execute the Automation via Automate App

Install Automate App

Follow the steps to install the Automate App in Contentstack.

  1. Log in to your Contentstack account.
  2. From the left-hand side primary navigation, click the Marketplace icon to go to the Marketplace.
    Marketplace_Icon.png
  3. Click Apps from the left panel.
  4. Within the Marketplace, you can see all the available apps. Hover over the Automate app and click Install.
    Install_App_From_Marketplace.png
  5. In the pop-up window, select the stack where you want to install the Automate app, accept the terms and conditions, and click the Install button.
    Install_App.png
  6. On the configuration screen, you will see the Entry Sidebar Rail UI location and the Asset Sidebar Rail UI location enabled for the Automate app. Click the Open Stack button, which will redirect you to your stack.

    Note: The Entry Sidebar Rail and the Asset Sidebar UI locations are enabled only for the Automate app.

    UI_Locations_Configuration.png

You can view the Automate App on the Entry and Asset editor page in the Entry Sidebar and the Asset Sidebar Rail UI Locations.

Entry Editor Page

To view the Automate App in the Entry Editor page, follow the steps below:

  1. Go to your stack, click the Content Models icon in the left navigation panel, and click the + New Content Type button. In the drop-down, select Create New or Use Prebuilt options.
  2. Create a content type by adding relevant details and click the Save and proceed button.
  3. From the left navigation panel, navigate to the Entries page, click + New Entry to create a new entry for the above content type, and then click Proceed.
  4. In the right navigation panel, you will see the Automate App icon. Click to view the Automate App.
    Automate_App_Asset_Sidebar.png
  5. You will see two icons: View Recipes and Manage Automations. Click Manage Automations to create a new automation.

    On clicking the View Recipes icon, you can see the recipes list.

    Note: View Recipes and Manage Automations icons are only visible to an organization’s Admin(s)/Owner(s). Standard users can only execute the automation that is visible via the Automate App in the Entry Sidebar location.

Create an Automation

To start executing the automation via the Automate App, you first need to create an automation. To do so, follow the steps below:

  1. From the left navigation panel, click Automate.
  2. On the Automations project page, click the On-demand Automation project.
  3. On the Automations page, click + New Automation.
  4. Provide an Automation Name and an optional Description. Click Create.
  5. After entering the basic details of the automation in the above step, the next set of actions can be broadly classified into the following two main steps:
    1. Configure Trigger
    2. Configure Action Step
      Configure_Action_Trigger.png

  6. Let’s look at the above steps ‌in the next section.

Configure Trigger

Configuring a trigger can be broken into the following steps:

  1. From the left navigation panel, click Configure Trigger.
  2. Within the Configure Trigger step, click the On-Demand Automation trigger.
  3. Under the Choose Trigger section, select the Entry Sidebar trigger.
    Select_Actions.png
  4. On the Entry Sidebar Configure Trigger page, enter the details given below:
    1. Select a Stack and Branch from the Lookup list.

      Note: You cannot configure a Response connector with the On-Demand Automate trigger.

    2. Optionally, enable the Show Optional Fields toggle button to display the Select Content Type and Input Options fields.
      1. Click the + Input Options button to view an Additional Information modal in the Entry Sidebar.
      2. In the Input Label field, enter the content to display as a label in the Additional Information modal.
      3. From the Input Type drop-down, select the type of input you want to provide in the Additional Information modal.
      4. In the Input Description field, enter a suitable instruction text for the input type field.
        Show_Optional_Fields.png
  5. Click the Proceed button.
  6. Click the Test Trigger button to test the configured trigger.
    Test_Trigger.png
  7. Click the Save and Exit button.
    Save_And_Exit_Button.png

Note: After successfully configuring a trigger, if you re-configure any other trigger, you will be prompted to revert to the previously configured trigger. You can revert back to the last trigger configurations by clicking the Revert Changes button.

This completes the configuration of your On-Demand Automate trigger.

Configure Action Step

You can configure any action connector based on your configuration. For this guide, we are selecting Email by Automate connector.

To configure an action step follow the steps below:

  1. Click Configure Action Step from the left navigation panel.
  2. Click Action Step to configure third-party services.
  3. Within the Configure Action Step, click the Email by Automate connector.
    Select_Email_by_Automate_Connector.png
  4. Under Choose an Action tab, select the Email by Automate action.
    Email_By_Automate.png
  5. On the Configure Action page, enter the To email address, the Subject line, the Body Type, and the Body of the email. The Show Optional Fields toggle button allows you to enter the “CC” and “BCC” email addresses.
    Select_Email_Fields.png
  6. Click Proceed after entering the details.
  7. Click Test Action to test if the email sending was a success or not.
    Test_Action.png
  8. The email is queued and sent to the receiver’s email address. Click Save and Exit.
    Save_Exit_Actin.png

Activate the automation by clicking the Activate Automation toggle button.

Execute the Automation via Automate App

Once the automation is activated, you can check all the active automations in the Automate App. To do so, follow the steps below:

  1. Navigate to the Automate App in the entries page.
  2. You will see a list of all the active automations. Click the “Execute icon” to execute the automation.
    Automation_Visible_in_Asset_Sidebar.png
  3. Once the automation is executed successfully, you can check the receiver’s email address for the email sent via Automate.
    Email.png

Use Case Additional Information Modal

Let’s see a use case to understand how the users can view and interact with the Additional Information modal.

In this use case, we will cover a scenario where, if a user adds the Input Options in the Entry Sidebar, the ChatGPT Connector processes the request and provides a prompt. The On-Demand Automate Connector displays the response in the Results modal.

Let's break this scenario to see what must be the trigger event and the consequent action required to execute the Automation:

  1. Set up the On-Demand Automate “Entry Sidebar” Trigger Event: This trigger event is activated whenever a user runs the automation via the Automate App in the Entry Sidebar.
  2. Set up the ChatGPT “Chat” Action: Once the above event triggers the automation, the Chat action will provide a response based on the request.
  3. Set up the On-Demand Automate “Summary Overlay” Action: Once the above action is executed, the Summary Overlay action displays the response in the Results modal in the Entry Sidebar.

The steps to set up the Automation are as follows:

  1. Set up the On-Demand Automate Trigger
  2. Set up the ChatGPT Connector
  3. Set up the On-Demand Automate Connector
  4. Execute the Automation via Automate App

Let’s look at the setup in detail.

Set up the On-Demand Automate Trigger

  1. From the left navigation panel, click Configure Trigger.
  2. Within the Configure Trigger step, click the On-Demand Automate trigger.
    On-Demand_Trigger.png
  3. Under the Choose Trigger section, select the Entry Sidebar trigger.
    Select_Actions.png
  4. On the Entry Sidebar Configure Trigger page, enter the details given below:
    1. Select a Stack and Branch from the Lookup list.

      Note: You cannot configure a Response connector with the On-Demand Automate trigger.

      Select_Trigger_Fields.png
    2. Optionally, enable the Show Optional Fields toggle button to display the Select Content Type and Input Options fields.
      1. Click the + Input Options button to view an Additional Information modal in the Entry Sidebar.
      2. In the Input Label field, enter the content to display as a label in the Additional Information modal. For example, enter Ask Something!.
      3. From the Input Type drop-down, select the type of input you want to provide. For example, select String.
      4. In the Input Description field, enter a suitable instruction text for the input type field. For example, Enter the content to generate the response.
        Show_Optional_Fields.png
  5. Click the Proceed button.
  6. Click the Test Trigger button to test the configured trigger.
    Test_Trigger.png
  7. Click the Save and Exit button.

    Save_And_Exit_Button.png

Set up the ChatGPT Connector

  1. From the left navigation panel, click Configure Action Step.
  2. Within the Configure Action Step, click the ChatGPT Connector.
  3. Under the Choose an Action tab, select the Chat action.
  4. On the Chat Configure Action page, enter the details given below:
    1. Click + Add New Account button to connect your ChatGPT account as shown in the Connect your ChatGPT Account to Automate step.
    2. Select the API Model from the dropdown list to generate content for the chat responses.

      Note: Different models are available to different users based on the account the user holds such as paid accounts. You must check the account access before selecting the model.

    3. Provide the Prompt Text to generate response(s). Click + Add Prompt Text to enter multiple prompts.
    4. Select the Role from the dropdown options to send to the API model request. By default, the role is set to the user.

      Additional Resource: There are three different types of roles provided by the OpenAI platform. The system role sets the response context, the assistant role provides the response content, and the user role asks the prompt.

    5. Enter the value in the Input Query field. For example, Give me description for the {{1.body.entry.title}}. Provide output in HTML format. This provides a description about the entry in the Results modal.
      Chat_Fields.png
    6. Click the Show Optional Fields toggle button to use the optional fields.

      Additional Resource: Refer to the ChatGPT Connector.

  5. Click the Proceed button.
  6. Click the Test Action button to test the configured action.
    Test_Action.png
  7. Click the Save and Exit button.
    Save_Exit_Chat.png

Set up the On-Demand Automate Connector

  1. From the left navigation panel, click Configure Action Step.
  2. Within the Configure Action Step, click the On-Demand Automate Connector.
  3. Under the Choose an Action tab, select the Summary Overlay action.
    Response_Action.png
  4. In the Response Body field, enter the content to be displayed in the Results modal. Fetch the response from the Chat action, i.e., 2.message.0.message.content as shown below:
    Response_Fields.png
  5. Click the Proceed button.
  6. Click the Test Action button to test the configured action.
    Test_Action.png
  7. Click the Save and Exit button.
    Save_Exit_Response.png

Execute the Automation via Automate App

Once the automation is activated, you can check all the active automations in the Automate App. To do so, follow the steps below:

  1. Navigate to the Automate App in the entries page.
  2. You will see a list of all the active automations. Click the “Execute icon (|>)” to execute the automation.
    Execut_Icon.png
  3. A pop-up window will appear. Enter a prompt in the input field as shown below:
    Additional_Information.png
  4. You will get the response on the Results modal as shown below:

Asset Editor Page

To view the Automate App in the Asset Editor page, follow the steps below:

  1. Go to your stack, in the left navigation panel click the Assets icon, and then click the + New Asset button.
  2. In the Upload Asset(s) modal, click the + New Folder field, enter the Folder Name, and click the Mark icon to save the folder.
  3. Click the Choose files button to start adding assets in the folder created in the previous step.
  4. Once done, select the folder and the asset. Click the asset to navigate to the Asset Editor page.
  5. In the right navigation panel, you will see the Automate App icon. Click to view the Automate App.
    Automate_App_Asset_Sidebar.png
  6. You will see two icons: View Recipes and Manage Automations. Click Manage Automations to create a new automation.

    On clicking the View Recipes icon, you can see the Recipes list.

    Note: View Recipes and Manage Automations icons are only visible to an organization’s Admin(s)/Owner(s). Standard users can only execute the automation that is visible via the Automate App in the Asset Sidebar location.

Create an Automation

To start executing the automation via the Automate App, you first need to create an automation. To do so, follow the steps below:

  1. From the left navigation panel, click Automate.
  2. On the Automations project page, click the On-demand Automation project.
  3. On the Automations page, click + New Automation.
  4. Provide an Automation Name and an optional Description. Click Create.
  5. After entering the basic details of the automation in the above step, the next set of actions can be broadly classified into the following two main steps:
    1. Configure Trigger
    2. Configure Action Step
      Configure_Action_Trigger.png

  6. Let’s look at the above steps ‌in the next section.

Configure Trigger

Configuring a trigger can be broken into the following steps:

  1. From the left navigation panel, click Configure Trigger.
  2. Within the Configure Trigger step, click the On-Demand Automate trigger.
  3. Under the Choose Trigger section, select the Asset Sidebar trigger.
    Asset_Sidebar_Action.png
  4. On the Asset Sidebar Configure Trigger page, enter the details given below:
    1. Select a Stack and Branch from the Lookup list.

      Note: You cannot configure a Response connector with the On-Demand Automate trigger.

      Select_Fields_Asset_Trigger.png
    2. Optionally, enable the Show Optional Fields toggle button to display the Select Asset Type field.

      You can select the type of asset (Image, Video, Audio, PDF, Plain Text, Document, Presentation, Spreadsheet) on which the Automate App will appear.

      Select_Asset_Type_Fields.png
  5. Click the Proceed button.
  6. Click the Test Trigger button to test the configured trigger.
    Test_Trigger.png
  7. Click the Save and Exit button.
    Save_Exit_Asset_Sidebar.png

Note: After successfully configuring a trigger, if you re-configure any other trigger, you will be prompted to revert to the previously configured trigger. You can revert back to the last trigger configurations by clicking the Revert Changes button.

This completes the configuration of your Asset Sidebar trigger.

Configure Action Step

You can configure any action connector based on your configuration. For this guide, we are selecting AWS S3 connector to create an object in the AWS bucket, when an automation is executed in the Asset Sidebar via the Automate App.

To configure an action step follow the steps below:

  1. Click Configure Action Step from the left navigation panel.
  2. Click Action Step to configure third-party services.
  3. Within the Configure Action Step, click the AWS S3 connector.
    Select_Connector.png
  4. Under Choose an Action tab, select the Create a New Object action.
    Select_Create_an_Object_Action.png
  5. Click the + Add New Account button to add your AWS account. Refer to the AWS S3 documentation to add a new account.
  6. On the Create a New Object Configure Action page, you need to enter the following details:
    1. Select the AWS Bucket Name from the Lookup list that appears when you click the textbox. The lookup drop-down loads the buckets already defined and present in your AWS account.
    2. Enter the File Name (for example, File01) or/and any value from the values list. For this example, select the asset name fetched from the Asset Sidebar trigger.
      File_Name.png
    3. In the Source dropdown, select the Source of the upload (Content or File URL) and the Input Value for each source.

      For this example, select the Source as File URL and select the file URL fetched from the Asset Sidebar trigger in the Input URL field.

      File_URL.png
    4. Click the Show Optional Fields toggle button to enter the text for the Tags and Metadata optional fields.
      Show_Optional_Fields_Create.png
  7. Click Proceed after entering the details.
  8. Click Test Action to test if the email sending was a success or not.
    Test_Action.png
  9. The email is queued and sent to the receiver’s email address. Click Save and Exit.
    Save_Exit_Create.png

Activate the automation by clicking the Activate Automation toggle button.

Execute the Automation via Automate App

Once the automation is activated, you can check all the active automations in the Automate App. To do so, follow the steps below:

  1. Navigate to the Automate App in the Assets page.
  2. You will see a list of all the active automations. Click the “Execute icon” to execute the automation.
    Automation_Visible_in_Asset_Sidebar.png
  3. Log into your AWS S3 account and see the list of files in the bucket. In the AWS account’s bucket, you can see the created file.
    AWS-Image.png
Was this article helpful?

More articles in "Quickstart"

Get Started with Automate

Learn more

Executing an Automation

Learn more
^