View source for Resco Cloud connector

{{Integration TOC}}
The Microsoft-certified '''Resco Cloud connector''' for '''[[Power Automate]]''' exposes a couple of operations that allow you to seamlessly create, read, update, and delete records. It is compatible with Microsoft Power Automate, Microsoft Power Apps, and Azure Logic Apps.

{{YT|ze-ZjnFRhDM}}

== Benefits ==

* Connecting backends is often a complex and time-consuming endeavor. Use Microsoft-standardized integration to save time and money.
* Automating the communication can extend Resco Cloud benefits to the users of other backends, for example, offline mobility or some field service functions.

[[File:Using Power Automate to connect Resco Cloud to other systems.png|alt=Resco Cloud connector: Using Power Automate to connect Resco Cloud to other systems|thumb|left|600px|One of the possible usage scenarios]]
<br clear=all>

=== Prerequisites ===

To use this connector, you need:
* An organization at [[Resco Cloud]] or any affiliate product from [https://www.resco.net/ Resco website].
** You can sign up for a [https://www.resco.net/request-a-trial/ free trial].
* An user account with schema access privilege or system administrator privilege.

=== Authentication === 

This connector uses Basic authentication. When creating a new connector (in Microsoft Power Apps / Azure Logic Apps), you must provide login credentials. You must also select a server to use with this connector and the organization name you specified during sign-up.

[[File:Resco-cloud-connector-authenticating-to-resco-cloud.png|400px|alt=Resco Cloud connector: authenticating to your Resco Cloud organization]]

=== Actions ===

Simply add any Resco Cloud connector step to your flow and start accessing/changing data in your Resco Cloud organization. This connector allows you to perform basic data operations:
* Create a new record: Create a new record.
* Delete record: Delete record with a specific ID.
* Generate report (*): Generate a [[mobile report]], just like in the app
* Get current user: Get the current user record associated with login credentials.
* Get questionnaire (*): Get all answers of an answered questionnaire
* Get record: Get a record with a specific ID.
* List questionnaires (*): Get a list of questionnaires.
* List records: Get a list of records.
* Update record: Update record with a specific ID.

Entries marked with an asterisk require an updated version of the connector released with [[Releases/Winter_2021|release 14.3]].

[[File:Resco Cloud connector.png|400px|alt=Resco Cloud connector actions]]

=== List records ===

Use the '''List records''' action to retrieve records from Resco Cloud. You can filter and order the records as needed. See also [[#FAQ|FAQ]] below.

[[File:Resco-cloud-connector-how-to-list-records-filters.png|400px|alt=How to get a list of records from Resco Cloud using Resco Cloud connector]]

Since [[Releases/Winter_2024|release 17.0]], you can use the related table added via '''Expand query''' directly in your '''Filter query'''.

[[File:Resco-cloud-connector-filter-with-expand-query.png|400px|alt=Resco Cloud connector - filter with expand query]]

=== Triggers ===

Since [[Releases/Winter_2021|release 14.3]], Resco Cloud connector supports triggers for create, update, and delete operations.

[[File:Trigger in action.png|400px|alt=Resco Cloud connector: Trigger in action]]

=== Known issues ===

==== Paging ====

The ''List records'' action returns a maximum of 1000 records. If you would like to get more records, you have to use the ''Skip token'' input parameter. The ''Skip token'' is not returned directly, but instead ''Next Link'' is returned which contains ''Skip token'' also.

To resolve ''Skip token'' for the next ''List records'' action call, you can use the expression in the ''Set variable'' step like:

<syntaxhighlight lang="json">
{
    "inputs": {
        "name": "skipToken",
        "value": "@{if(empty(outputs('List_records')?['body/@odata.nextLink']),null,decodeUriComponent(substring(outputs('List_records')?['body/@odata.nextLink'],add(indexOf(outputs('List_records')?['body/@odata.nextLink'], '$skipToken='),11))))}"
    }
}
</syntaxhighlight>

=== Common errors and remedies ===

* For cloud servers, make sure that you have specified the proper server under the Connection dialog. If not, you may get an Unauthorized error.
* For custom or on-premise servers, enter the URL including protocol and port (if applicable), e.g., <code><nowiki>https://mycompany.com[:8080]</nowiki></code>.

=== FAQ ===

; How to use ''List records'' input parameters?
: These are standard OData query parameters. The syntax for each input parameter is defined by OData specification.  The only thing to think of is using logical names instead of display names. (e.g. Account -> account, Name -> name, etc.). Logical names can be found under Entities in the Admin Console.

; How do I get a picklist label?
: Each picklist field returns 2 values:
:* '''Field''' - This is the picklist value
:* '''Field (Label)''' - This is the label for the picklist value.

; How do I get a lookup label?
: Each lookup field returns 3 values:
:* '''Field''' - This is the ID (GUID) of the reference 
:* '''Field (Label)''' - This is the label (primary name) of the reference.
:* '''Field (Type)''' - This is the target entity of the reference.

; How do I set a lookup field?
: When setting lookup fields, you have to construct a reference consisting of record type and record id.
:* From existing record in your flow, you can use '''OData Id'''
:* By creating '''logicalName:id''' expression
:* By creating '''logicalName('id')''' expression

; How does the connector work?
: Internally, the connector uses Resco API services [[OData service]] and [[Questionnaire OData service]]. All limitations that apply to those APIs also apply to Resco Cloud connector.

<!-- == Creating a sample flow using the connector == 

In the following example, we are creating an instant flow that retrieves some records from Resco Cloud and saves them to Common Data Service.

# Select '''Create''' from the menu, then select '''Instant cloud flow'''.
# Enter a flow name and choose how the flow should be triggered.<br>[[File:Create sample flow.png|600px]]
# Click '''New step'''.<br>[[File:Manually trigger a flow.png|600px]]
# Search for 'resco' and select '''Resco Cloud''' connector.<br>[[File:Select resco cloud connector.png]]
# Select an action for the connector, for example, '''Get record'''.
# Connect to your Resco Cloud, Resco Inspections, or Resco Routes organization.<br>[[File:Connect to resco cloud.png]]
# TBD.
-->
<!-- == Building custom connectors ==

Resco has prepared OpenAPI definition files that can be used by Power Automate to create a custom connector for interfacing with Resco Cloud. Both YAML and JSON formats are available. When using an OpenAPI definition to describe a custom connector in Power Automate, [https://docs.microsoft.com/en-us/connectors/custom-connectors/faq#limits the file must be less than 1 MB]. Therefore, the API definition only includes selected entities by default. Contact [https://www.resco.net/contact-support/ Resco support] for more information.

{{Note|The API definition files can be also utilized by other tools and services compatible with the OpenAPI standard, not only Power Automate.|Tip}}

'''(Coming soon)''': You can also generate your own OpenAPI file with entities necessary for your particular use case. In the [[Admin Console]], select TBD from the menu; then select the entities (fields?) that you need.

-->

== Advanced triggers ==

Before [[Releases/Winter_2021|release 14.3]], Resco Cloud connector did not support triggers as an out-of-the-box feature. However, there was a workaround available using the server process event and invoking an HTTP request provided by "When an HTTP request is received" (described below). This workaround is still an option for custom triggers.

Create a new automated cloud flow, name it, and click skip to create an empty flow. Search for "Request" connector and add the "When an HTTP request is received" trigger. Set "Request Body JSON Schema" to accept the ''id'' parameter:

<syntaxhighlight lang="json">
{
    "type": "object",
    "properties": {
        "id": {
            "type": "string"
        }
    }
}
</syntaxhighlight>

Under '''Show Advanced Options''' set method to '''POST'''. Save the flow to generate "HTTP POST URL".

[[File:Pa-flow.png|alt=Resco Cloud connector: Advanced trigger (Power automate flow)|400px]]

Now you have to create a process to invoke trigger in your flow.
# Log into your [[Resco Cloud]] server, start the [[Admin Console]], and select '''Processes''' from the menu.
# Click '''New''', enter a name for the new process, select the desired entity (e.g., Account), and the desired event (e.g., Record is created). 
# Add StringList variable '''headers''' and add item <code>Content-Type: application/json;charset=utf-8</code> to it.
# Add string variable '''body''' as "Format Text" with: <code>\{ "id": "{Entity.id}" \}</code>.
# Then, add the function step `Server.InvokeWebRequest` with `POST` method. URL copied from "When an HTTP request is received" trigger and body variable.

[[File:Resco-process.png|alt=Resco Cloud connector: Advanced trigger (resco process)|400px]]

Now, when you create a record of the specified entity type, the trigger activates.

== See also ==

* [https://www.resco.net/news/resco-launches-integration-with-microsoft-dynamics-365-business-central/ Resco launches integration with Microsoft Dynamics 365 Business Central]
* [https://www.resco.net/blog/faq-integrating-resco-with-dynamics-business-central-power-automate/ FAQ: Integrating Resco with Dynamics 365 Business Central via Power Automate] {{Badge|Blog}}
* [https://docs.microsoft.com/en-us/connectors/rescocloud/ Resco Cloud connector documentation at docs.microsoft.com]




{{Feedback}}
[[Category:Resco Cloud]]