{"id":356993,"date":"2022-07-13T12:44:01","date_gmt":"2022-07-13T10:44:01","guid":{"rendered":"https:\/\/www.planradar.com\/getting-started-with-planradar-connect\/"},"modified":"2022-11-29T11:20:30","modified_gmt":"2022-11-29T09:20:30","slug":"getting-started-with-planradar-connect","status":"publish","type":"page","link":"https:\/\/www.planradar.com\/sa-en\/getting-started-with-planradar-connect\/","title":{"rendered":"Getting started with PlanRadar connect"},"content":{"rendered":"\n
\n
\n
\n

Welcome to PlanRadar Connect !<\/h2>\n

\n

PlanRadar Connect allows you to automate business workflows across cloud and on-premises apps with your PlanRadar account.<\/p>\n

With our partner Workato, we combine an enterprise-grade workflow automation platform with the ease-of-use expected from consumer apps, enabling both business and IT users to quickly build workflow automations.<\/p>\n <\/p>\n <\/div>\n <\/div>\n<\/section>\n\n\n\n\n\n\n

\n
\n
\n

How to start<\/h2>\n

\n

Recipes<\/strong>\u00a0are automated workflows you build or customise that can span multiple apps with your PlanRadar account.<\/p>\n

Each recipe comprises of a\u00a0trigger\u00a0<\/strong>and one or more\u00a0actions\u00a0<\/strong>that are carried out when a trigger event is picked up.<\/p>\n

When recipes are started, they will run automatically in the background to look for trigger events and carry out recipe actions. When they are stopped, they will cease to look for trigger events. However, when a recipe is started again, it will pick up all the trigger events that occurred since the recipe was stopped. In other words, stop functions like pause.<\/p>\n

All recipes have a unique ID that identifies them and can be found in the recipe’s URL. As can be seen below, the recipe has the recipe ID\u00a047969.<\/p>\n\n

\"\"<\/p>\n

The recipe above has a trigger and an action. The trigger is\u00a0New or updated Ticket in your PlanRadar account<\/strong>\u00a0– this trigger will fire whenever a new ticket is created or updated. The action\u00a0Create issue in JIRA<\/strong>\u00a0will create an issue in JIRA each time the trigger event occurs.<\/p>\n <\/p>\n <\/div>\n <\/div>\n<\/section>\n\n\n

\n
\n
\n

Triggers<\/h2>\n

\n

Triggers determine what event to listen to execute the actions described in a recipe.<\/p>\n

Trigger events can be set off in apps (Salesforce or JIRA) when a certain event happens (new contact is created or existing ticket is updated), when a new line is added in a file, or according to a schedule (fires at a certain time or interval).<\/p>\n

Depending on the available API, PlanRadar Connect can receive trigger events in real-time, or check for the occurrence of an event periodically by polling the app.<\/p>\n

Find more information\u00a0here<\/a>.<\/p>\n <\/p>\n <\/div>\n <\/div>\n<\/section>\n\n\n

\n
\n
\n

Steps and actions<\/h2>\n

\n

Recipe steps are executed every time the trigger event occurs. Recipes are required to have at least one step. The most basic step for a recipe is an action, such as an action to create an issue in JIRA<\/p>\n

PlanRadar Connect steps can be actions, conditional actions, list actions, actions that call other recipes, try\/catch, etc.<\/p>\n

For more information about steps, click\u00a0here<\/a>.<\/p>\n <\/p>\n <\/div>\n <\/div>\n<\/section>\n\n\n

\n
\n
\n

Datatree and datapills<\/h2>\n

\n

Every step, including triggers, brings data into the recipe. For example a new ticket in a PlanRadar Connect trigger would bring in ticket data. This data is made available in the recipe via the\u00a0datatree<\/strong>.<\/p>\n

The individual data fields are called datapills. You can use the datapills in subsequent steps. You can read more about datapills\u00a0here<\/a>.<\/p>\n

The following is the output datatree for the trigger\u00a0PlanRadar ticket<\/strong>. This datatree contains all the variables known to us and available for use whenever a trigger event occurs.<\/p>\n\n

\"\"<\/p>\n\n

For example, as seen in the screenshot, whenever a new PlanRadar ticket is created, we’re able to get the following values:<\/p>\n

Event Name<\/p>\n

Ticket UUID<\/p>\n

Project ID<\/p>\n

Deedup Hash<\/p>\n <\/p>\n <\/div>\n <\/div>\n<\/section>\n\n\n

\n
\n
\n

Input fields and fields mapping<\/h2>\n

\n

Triggers and actions have input fields. Input fields are how triggers and actions are designed to carry out customized workflows, and they can take in variables (datapills) or constants.<\/p>\n

When we insert variables (datapills) or constants into input fields, that’s called fields mapping. You can read more about fields mapping\u00a0here<\/a>.<\/p>\n

The following is an expanded view of the\u00a0Create issue in JIRA action<\/strong>. In this view, we can see two input fields:\u00a0Summary\u00a0<\/strong>and\u00a0Description<\/strong>.<\/p>\n\n

\"\"<\/p>\n <\/p>\n <\/div>\n <\/div>\n<\/section>\n\n\n

\n
\n
\n

Mapping variables<\/h2>\n

\n

The variable\u00a0Subject\u00a0<\/strong>has been mapped to the\u00a0Summary\u00a0<\/strong>input field. This means that for every new issue in JIRA that is created, the\u00a0Summary\u00a0<\/strong>of this Jira issue will be the\u00a0Subject<\/strong>\u00a0of the PlanRadar ticket that will be created. For example, a new PlanRadar ticket with the\u00a0Subject\u00a0<\/strong>\u201cWindow defect\u201c will in turn create a Jira issue with the\u00a0Summary\u00a0<\/strong>\u201cWindow defect\u201c.<\/p>\n\n

\"\"<\/p>\n <\/p>\n <\/div>\n <\/div>\n<\/section>\n\n\n

\n
\n
\n

Mapping constants<\/h2>\n

\n

On the other hand, the input field\u00a0Description\u00a0<\/strong>has a constant mapped to it – the words “This JIRA issue was created from a PlanRadar ticket” This means that all newly created Jira issues created via PlanRadar Connect will always have the words “This JIRA issue was created from a PlanRadar ticket” in its\u00a0Description\u00a0<\/strong>field.<\/p>\n\n

\"\"<\/p>\n <\/p>\n <\/div>\n <\/div>\n<\/section>\n\n\n

\n
\n
\n

Connections<\/h2>\n

\n

For a recipe to communicate with apps via actions and triggers, it has to be authorized to interact with apps. This authorization is referred to as a\u00a0connection<\/strong>. Connections are not tied to a recipe – a single connection can be used by multiple recipes. You can read more about app connections\u00a0here<\/a>.<\/p>\n\n

\"\"<\/p>\n <\/p>\n <\/div>\n <\/div>\n<\/section>\n\n\n

\n
\n
\n

Jobs<\/h2>\n

\n

Each time there is a trigger event, the actions in the recipe are executed. The entire flow of each trigger event through the recipe is called a\u00a0job<\/strong>. Jobs can be successful (when actions are executed successfully), or have errors (when an action results in an error). When an error is encountered, subsequent actions are not executed. You can read more about jobs\u00a0here<\/a>.<\/p>\n <\/p>\n <\/div>\n <\/div>\n<\/section>\n\n\n

\n
\n
\n

Jobs report<\/h2>\n

\n

The job report gives a high-level summary of the all the trigger events processed by the recipe. The entire flow of each trigger event through the recipe is called a job.<\/p>\n

Information such as date, time processed and job IDs, can be found here. From this jobs history page, users can view more detailed information about a job by clicking on it.<\/p>\n

You can read more about job reports\u00a0here<\/a>.<\/p>\n\n

\"\"<\/p>\n <\/p>\n <\/div>\n <\/div>\n<\/section>\n\n\n

\n
\n
\n

Job details<\/h2>\n

\n

The job details page provides step-by-step input\/output details of a single trigger event as it is processed by the recipe. This page is useful for troubleshooting recipes as users are able to view the data passed into each step and the resultant output returned after each step was executed. You can read more about job details\u00a0here<\/a>.<\/p>\n\n

\"\"<\/p>\n <\/p>\n <\/div>\n <\/div>\n<\/section>","protected":false},"excerpt":{"rendered":"","protected":false},"author":2,"featured_media":0,"parent":0,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"","meta":{"_acf_changed":false,"footnotes":""},"class_list":["post-356993","page","type-page","status-publish","hentry"],"acf":[],"yoast_head":"\nGetting started with PlanRadar connect - PlanRadar<\/title>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/www.planradar.com\/sa-en\/getting-started-with-planradar-connect\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"Getting started with PlanRadar connect - PlanRadar\" \/>\n<meta property=\"og:url\" content=\"https:\/\/www.planradar.com\/sa-en\/getting-started-with-planradar-connect\/\" \/>\n<meta property=\"og:site_name\" content=\"PlanRadar\" \/>\n<meta property=\"article:modified_time\" content=\"2022-11-29T09:20:30+00:00\" \/>\n<meta property=\"og:image\" content=\"https:\/\/planradar-website.s3.amazonaws.com\/production\/uploads\/2024\/01\/CREAT-2249_SM_homepage_preview_1200x630_1023.jpg\" \/>\n\t<meta property=\"og:image:width\" content=\"2400\" \/>\n\t<meta property=\"og:image:height\" content=\"1260\" \/>\n\t<meta property=\"og:image:type\" content=\"image\/jpeg\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"WebPage\",\"@id\":\"https:\/\/www.planradar.com\/sa-en\/getting-started-with-planradar-connect\/\",\"url\":\"https:\/\/www.planradar.com\/sa-en\/getting-started-with-planradar-connect\/\",\"name\":\"Getting started with PlanRadar connect - PlanRadar\",\"isPartOf\":{\"@id\":\"https:\/\/www.planradar.com\/#website\"},\"datePublished\":\"2022-07-13T10:44:01+00:00\",\"dateModified\":\"2022-11-29T09:20:30+00:00\",\"breadcrumb\":{\"@id\":\"https:\/\/www.planradar.com\/sa-en\/getting-started-with-planradar-connect\/#breadcrumb\"},\"inLanguage\":\"en-SA\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/www.planradar.com\/sa-en\/getting-started-with-planradar-connect\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/www.planradar.com\/sa-en\/getting-started-with-planradar-connect\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/www.planradar.com\/sa-en\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Getting started with PlanRadar connect\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/www.planradar.com\/#website\",\"url\":\"https:\/\/www.planradar.com\/\",\"name\":\"PlanRadar\",\"description\":\"construction app and defect management software\",\"publisher\":{\"@id\":\"https:\/\/www.planradar.com\/#organization\"},\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/www.planradar.com\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-SA\"},{\"@type\":\"Organization\",\"@id\":\"https:\/\/www.planradar.com\/#organization\",\"name\":\"PlanRadar\",\"url\":\"https:\/\/www.planradar.com\/\",\"logo\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-SA\",\"@id\":\"https:\/\/www.planradar.com\/#\/schema\/logo\/image\/\",\"url\":\"https:\/\/planradar-website.s3.amazonaws.com\/production\/uploads\/2022\/03\/planradar_logo.svg\",\"contentUrl\":\"https:\/\/planradar-website.s3.amazonaws.com\/production\/uploads\/2022\/03\/planradar_logo.svg\",\"width\":1,\"height\":1,\"caption\":\"PlanRadar\"},\"image\":{\"@id\":\"https:\/\/www.planradar.com\/#\/schema\/logo\/image\/\"}}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"Getting started with PlanRadar connect - PlanRadar","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/www.planradar.com\/sa-en\/getting-started-with-planradar-connect\/","og_locale":"en_US","og_type":"article","og_title":"Getting started with PlanRadar connect - PlanRadar","og_url":"https:\/\/www.planradar.com\/sa-en\/getting-started-with-planradar-connect\/","og_site_name":"PlanRadar","article_modified_time":"2022-11-29T09:20:30+00:00","og_image":[{"width":2400,"height":1260,"url":"https:\/\/planradar-website.s3.amazonaws.com\/production\/uploads\/2024\/01\/CREAT-2249_SM_homepage_preview_1200x630_1023.jpg","type":"image\/jpeg"}],"twitter_card":"summary_large_image","schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/www.planradar.com\/sa-en\/getting-started-with-planradar-connect\/","url":"https:\/\/www.planradar.com\/sa-en\/getting-started-with-planradar-connect\/","name":"Getting started with PlanRadar connect - PlanRadar","isPartOf":{"@id":"https:\/\/www.planradar.com\/#website"},"datePublished":"2022-07-13T10:44:01+00:00","dateModified":"2022-11-29T09:20:30+00:00","breadcrumb":{"@id":"https:\/\/www.planradar.com\/sa-en\/getting-started-with-planradar-connect\/#breadcrumb"},"inLanguage":"en-SA","potentialAction":[{"@type":"ReadAction","target":["https:\/\/www.planradar.com\/sa-en\/getting-started-with-planradar-connect\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/www.planradar.com\/sa-en\/getting-started-with-planradar-connect\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/www.planradar.com\/sa-en\/"},{"@type":"ListItem","position":2,"name":"Getting started with PlanRadar connect"}]},{"@type":"WebSite","@id":"https:\/\/www.planradar.com\/#website","url":"https:\/\/www.planradar.com\/","name":"PlanRadar","description":"construction app and defect management software","publisher":{"@id":"https:\/\/www.planradar.com\/#organization"},"potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/www.planradar.com\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-SA"},{"@type":"Organization","@id":"https:\/\/www.planradar.com\/#organization","name":"PlanRadar","url":"https:\/\/www.planradar.com\/","logo":{"@type":"ImageObject","inLanguage":"en-SA","@id":"https:\/\/www.planradar.com\/#\/schema\/logo\/image\/","url":"https:\/\/planradar-website.s3.amazonaws.com\/production\/uploads\/2022\/03\/planradar_logo.svg","contentUrl":"https:\/\/planradar-website.s3.amazonaws.com\/production\/uploads\/2022\/03\/planradar_logo.svg","width":1,"height":1,"caption":"PlanRadar"},"image":{"@id":"https:\/\/www.planradar.com\/#\/schema\/logo\/image\/"}}]}},"_links":{"self":[{"href":"https:\/\/www.planradar.com\/sa-en\/wp-json\/wp\/v2\/pages\/356993"}],"collection":[{"href":"https:\/\/www.planradar.com\/sa-en\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/www.planradar.com\/sa-en\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/www.planradar.com\/sa-en\/wp-json\/wp\/v2\/users\/2"}],"replies":[{"embeddable":true,"href":"https:\/\/www.planradar.com\/sa-en\/wp-json\/wp\/v2\/comments?post=356993"}],"version-history":[{"count":1,"href":"https:\/\/www.planradar.com\/sa-en\/wp-json\/wp\/v2\/pages\/356993\/revisions"}],"predecessor-version":[{"id":357041,"href":"https:\/\/www.planradar.com\/sa-en\/wp-json\/wp\/v2\/pages\/356993\/revisions\/357041"}],"wp:attachment":[{"href":"https:\/\/www.planradar.com\/sa-en\/wp-json\/wp\/v2\/media?parent=356993"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}