Remote resource

Remote resources are similar to external file resources.

You can use a remote resource to connect to a resource of your choice from a web services source application. The resource can be of any file format, including .img, .xml, .doc, or .json.

If the connection is a machine-to-machine one and you don’t already have the bearer token for the connection, you must configure two remote resources and make two requests to build the connection: a dependent resource, to get a bearer token, and a main resource, to use the bearer token to establish the connection. Corporater BMP uses OAuth as authorization protocol for the connection.

To import data from a remote resource, configure a transformer project with a JSON source that uses it as resource.

To add a remote resource, right-click the resources category to include it and select Add > Resource > Remote resource.

To configure the resource, double-click it.

Corporater recommends you configure remote resources only together with an integration expert or a specialist from the vendor of the web services source application.

To test a configured remote resource, use the Preview panel.

Properties

General

Name – the name "Remote resource" is generated automatically but you can change it at any point.
Description – an optional text that describes the resource.

Configuration

Request method – the method for the request.
- GET
- POST
Url – if the remote resource is to connect to an open, public resource, the URL of the resource. The URL must observe the following format: https://<url>/<resource>/<request>.

If the remote resource is to connect to a resource via a machine-to-machine connection, the REST URL that includes the target information. The URL must include the application ID as the UUID.
Parameters – the data parameters for the request.

To include Reporter tags, click the Lookup button ( ) and create the tags.

Use a colon sign (:) to separate keys from values.
Headers – the HTTP headers for the request.

To include Reporter tags, click the Lookup button ( ) and create the tags.

Use a colon sign (:) to separate keys from values.
Body type – Available only if you select 'POST' for Request method. The body type of the request.
- Form data
- URL encoded
- Raw

Body – Available only if you select 'POST' for Request method. The body of the request.

To include Reporter tags, click the Lookup button ( ) and create the tags.
Body content type – Available only if you select 'POST' for Request method and 'Raw' as Body type. The content type of the body of the request.

Authentication

Authentication – the type of authentication for the connection.
- None – Select if the remote resource is to connect to an open, public resource, or to connect to a resource via a machine-to-machine connection.
- Basic – Select to use username and password details for authentication.
- Api key – Select if the remote resource is to connect to a Google Drive resource. Uses a Google Drive API key for authentication.
- Bearer token – Select if the remote resource is to connect to a resource via a machine-to-machine connection. Uses a bearer token for authentication.
- AWS Signature – Select if the remote resource is to connect to an Amazon web service. Uses an AWS signature for authentication.
Username – available only if you select 'Basic' for Authentication. The user’s username.
Password – available only if you select 'Basic' for Authentication. The user’s password.
Key name – available only if you select 'Api key' for Authentication. The name of the API key.
Key value – available only if you select 'Api key' for Authentication. The value of the API key.
Token – available only if you select 'Bearer token' for Authentication. The token for authentication.
Access key – available only if you select 'AWS Signature' for Authentication. The access key of the service to connect to.
Secret key – available only if you select 'AWS Signature' for Authentication. The secret key of the service to connect to.
AWS region – available only if you select 'AWS Signature' for Authentication. The AWS data center for the service to connect to.
Service name – available only if you select 'AWS Signature' for Authentication. The service name of the AWS service to connect to.

Token resolution

Dependent remote resources – Applies if the resource is to connect to another resource via a machine-to-machine connection and you don’t already have the bearer token for the connection. The dependent resource to get the bearer token for the connection.

Click the Remote resource button ( ) and select the resource.

Audit

Modified by - the name of the last user to make changes to the object.
Last modified - the date and time when the object was last changed.
Created by - the name of the user who created the object.
Created - the date and time when the object was created.

Advanced

ID - a unique ID for the object.

By default, Corporater BMP assigns consecutive numbers to new objects.

You can change the ID to a value of choice that can include either letters or letter and number combinations.

The ID mustn't contain only numbers, include special characters such as ) ( . * } { + < > [ ], or match the name of a default object type in Corporater BMP.

Access control

Read accessors - click the Edit button () and authorize one or more users and user groups to view the object on Web.
Add accessors - click the Edit button() and authorize one or more users and user groups to add new objects to the object on Web.
Write accessors - click the Edit button() and authorize one or more users and user groups to edit the object on Web.
Delete accessors - click the Edit button() and authorize one or more users and user groups to delete the object on Web.
Ownership - click the Edit button () and grant ownership of the object to one or more users and user groups.

Users and user groups who own the object have full access rights to it.
Override access profile - select for the object's access control setting to outrank the object's corresponding access settings in profiles.