• Documentation
  • Workato Blog
  • Product Blog
  • Return to Workato
  • Login
  • Automation Institute
  • Documentation
  • Community Forums
New Topic
Discussions Recipe Building Recipe Building Questions
T

The Australia Cambodia Foundation Inc

started a topic over 6 years ago
Answered

How to set configuration parameters in recipes?

I have noticed that some of the recipes available have some configuration parameters available at the bottom of the recipes. How do you set these up?

 


Best Answer
A
Adam Goh said over 6 years ago

Configuration parameters are useful when you run complicated recipes that you do not wish others to touch the logic on. It's like having switches on a complicated curcuit. Allowing choices to be made without messing around with the recipe.


Setting Configurations parameters up are fairly simple, and be summarized as follows :


When you are on the recipe page, press on the shortcut on your keyboard: CTRL + SHIFT + P

The parameter window will now show up at the bottom of your page.

config.png


In the box, you may fillup the parameter set up. Feel free to click on show example for some of the types of parameters you can create. From text fields to dates and even lists, these examples should guide you ample to go through your customization.


Structure wise, there are a few requirements for the config parameters to be set correctly. In general, it should follows this sample



[ 
 {
    "label": "Status",
    "name": "status",
    "type": "string",
    "control_type": "text",
    "hint": "new/completed etc"
  }
]

The whole schema starts with an opening square bracket as well as a close one, and each field is enclosed in curly brackets.


Once you have created a config parameter in your field, you can easily find those data pills in the Properties section in the App Data

config3.png


Answer

Adam Goh

said over 6 years ago

Configuration parameters are useful when you run complicated recipes that you do not wish others to touch the logic on. It's like having switches on a complicated curcuit. Allowing choices to be made without messing around with the recipe.


Setting Configurations parameters up are fairly simple, and be summarized as follows :


When you are on the recipe page, press on the shortcut on your keyboard: CTRL + SHIFT + P

The parameter window will now show up at the bottom of your page.

config.png


In the box, you may fillup the parameter set up. Feel free to click on show example for some of the types of parameters you can create. From text fields to dates and even lists, these examples should guide you ample to go through your customization.


Structure wise, there are a few requirements for the config parameters to be set correctly. In general, it should follows this sample



[ 
 {
    "label": "Status",
    "name": "status",
    "type": "string",
    "control_type": "text",
    "hint": "new/completed etc"
  }
]

The whole schema starts with an opening square bracket as well as a close one, and each field is enclosed in curly brackets.


Once you have created a config parameter in your field, you can easily find those data pills in the Properties section in the App Data

config3.png



1 person likes this
T

The Australia Cambodia Foundation Inc

said over 6 years ago
Thanks Adam. Is that documented anywhere? I couldn't find any reference to it. What other goodies are there hidden away?

 

Adam Goh

said over 6 years ago

We currently do not document this, as it is still in an early test stages. Requiring users to "code" in order to have parameters is still not be the best user experience, so we're still working on it.

Most of the Workato-only Good stuffs are either application specifics, or under the "Utilities" action. Another that you may want to check out is our HTTP action, which allows you to connect to any REST-based API that your company uses!


Do chat us up on our live chat, or post more any interesting ideas you have for your company, and we are more than happy to divulge more "secrets" to automation success with you :)

M

Mark

said over 5 years ago

Can we create a drop down list in the config schema? If so how do we do this?

Amanda Wong

said over 5 years ago

Hi Mark, I believe we have responded to you regarding your question but I'll share the response here for the others to benefit :)


You can create a picklist field type in the Configuration schema. 

  • In a recipe, use keyboard shortcuts Ctrl+Shift+P to reveal the configuration parameter setup
  • The schema should be entered in JSON format. Examples are provided to guide you on how to do this

Example: Simple pick list with 2 values


image


Schema entry:


  

[
{
    "label": "Gender",
    "name": "gender",
    "type": "string",
    "control_type": "select",
    "optional": true,
    "pick_list": [
      ["Male", "M"],
      ["Female", "F"]
    ]
  }
] 

  




3 people like this
Login to post a comment

Still can't find your solution?

Send us a ticket, we will try our best to assist you with your problem

Documentation
Developer's Library
Tutorials
eBooks
Product Hour
Product Blog
Workato Blog
Product updates
Customer Stories
© Workato 2022   Privacy   Terms   +1 (844) 469-6752
  • Documentation
  • Workato Blog
  • Product Blog
  • Solutions
  • Forums
  • Tickets
  • Log in
  • Return to Workato
Topic views count