Frends

https://docs.frends.com
Admin
Frends is a hybrid integration platform that enables centralized management of integrations, APIs,...
Tokens:327,890
Snippets:2,001
Trust Score:8.7
Update:8 months ago
Show doc for...
Tokens:
Raw
### Deploy Local Agent Database Example

Source: https://docs.frends.com/guides/setup-and-installation/installing-frends-agent

Example command for deploying a local agent database using Frends.DatabaseInitializer. This command specifies the connection string and migration namespace for the agent store.

```bash
Frends.DatabaseInitializer --connectionstring "Data Source=(local);Initial Catalog=FRENDS;Integrated Security=True"
--migrationNamespace Frends.DatabaseInitializer.AgentStore --sqlUserName HFWS460\FrendsUser
```

--------------------------------

### Enable Frends Agent to Start on Boot

Source: https://docs.frends.com/guides/setup-and-installation/installing-frends-agent

Command to configure the Frends Agent service to automatically start when the system boots up. This is typically handled by the installer but can be manually set using this command. It requires superuser privileges.

```bash
sudo systemctl enable frendsagent
```

--------------------------------

### Frends Database Initializer Tool Help and Usage Examples (Command Line)

Source: https://docs.frends.com/guides/setup-and-installation/how-to-set-up-high-availability-configuration

Displays help information and usage examples for the Frends.DatabaseInitializer.exe tool. Shows how to deploy a local agent database, upgrade a configuration store to Azure, and details various command-line parameters.

```bash
> Frends.DatabaseInitializer.exe --help

Frends.DatabaseInitializer 2.0.0.0
Copyright c 2022. All rights reserved.
USAGE:
Deploy local agent database for a user:
Frends.DatabaseInitializer --connectionstring "Data Source=(local);Initial Catalog=FRENDS;Integrated Security=True"
--migrationNamespace Frends.DatabaseInitializer.AgentStore --sqlUserName HFWS460\FrendsUser

Upgrade an existing Configuration store database to Azure:
Frends.DatabaseInitializer --assemblyFile .\Frends.DatabaseMigrations.dll --connectionstring
"Server=tcp:[serverName].database.windows.net;Database=myDataBase;User
ID=[LoginForDb]@[serverName];Password=myPassword;Trusted_Connection=False;Encrypt=True;" --doNotCreate
--migrationNamespace Frends.DatabaseMigrations.ConfigurationStore

  -c, --connectionstring                 Required. Connection string to the FRENDS database, e.g. 'Data
                                         Source=(local);Initial Catalog=FRENDS;Integrated Security=True'

  -l, --logConnectionstring              When migrating configuration store to 5.4, some data is migrated from the
                                         logStore to the configuration store. In that case this parameter is needed.

  -u, --sqlUserName                      Username of the SQL user, e.g. 'DOMAIN\FrendsUser'

  -p, --sqlUserPassword                  Password of the SQL user when using SQL logins

  -m, --giveUserTableManagementRights    (Default: false) Should the SQL user be allowed to manage the tables, used
                                         e.g. for reorganizing indexes

  -a, --assemblyFile                     The assembly with the fluent migrations to run. If not given, the internal
                                         agent database migrations will be run.

  -n, --migrationNamespace               (Default: Frends.DatabaseInitializer.AgentStore) The namespace from which to
                                         run the migrations. If not given, the Agent store migrations will be run.

  --scriptMigrationNamespace             The namespace from which to run embedded Entity framework SQL migration
                                         scripts. If not given, no SQL script migrations will be run.

  --doNotCreate                          (Default: false) Switch for disabling the creation of the database and user

```

--------------------------------

### Upgrade Configuration Store to Azure Example

Source: https://docs.frends.com/guides/setup-and-installation/installing-frends-agent

Example command for upgrading an existing configuration store database to Azure. This involves specifying an assembly file for migrations, a connection string for Azure SQL Database, and disabling database creation.

```bash
Frends.DatabaseInitializer --assemblyFile .\Frends.DatabaseMigrations.dll --connectionstring "Server=tcp:[serverName].database.windows.net;Database=myDataBase;User ID=[LoginForDb]@[serverName];Password=myPassword;Trusted_Connection=False;Encrypt=True;"
--doNotCreate
--migrationNamespace Frends.DatabaseMigrations.ConfigurationStore
```

--------------------------------

### Example Custom Options for GPT-4 Models (JSON)

Source: https://docs.frends.com/reference/shapes/activity-shapes/ai-connector

Provides an example of custom parameters for GPT-4 models, including response format, temperature, top_p, frequency_penalty, presence_penalty, max_tokens, and seed. These options allow fine-tuning the AI's output behavior and generation process.

```json
{
  "response_format": {
    "type": "json_object"
  },
  "temperature": 0.3,
  "top_p": 0.9,
  "frequency_penalty": 0.2,
  "presence_penalty": 0.1,
  "max_tokens": 512,
  "seed": 42
}
```

--------------------------------

### Complete OpenTelemetry Collector Configuration Example

Source: https://docs.frends.com/guides/integration-management/how-to-visualize-frends-telemetry-with-opentelemetry

A comprehensive example of an OpenTelemetry Collector configuration file, including OTLP receivers, Datadog and logging exporters, a batch processor, and service pipelines for traces and metrics.

```yaml
receivers:
  otlp:
    protocols:
      grpc:
        endpoint: 0.0.0.0:4317
      http:
        endpoint: 0.0.0.0:4318

exporters:
  datadog:
    api:
      key: ${DATADOG_API_KEY}
    metrics:
      summaries:
        mode: "distribution"
  
  logging:
    loglevel: detailed

processors:
  batch:

service:
  pipelines:
    traces:
      receivers: [otlp]
      processors: [batch]
      exporters: [logging, datadog]
    metrics:
      receivers: [otlp]
      processors: [batch]
      exporters: [logging, datadog]
```

--------------------------------

### Export Process by GUID and Version to File (JSON)

Source: https://docs.frends.com/reference/frends-platform-api/platform-api-reference/processes

Exports a specific version of a process to a file. This operation retrieves process variables from the Development Agent Group. It requires the process GUID and version as path parameters.

```json
{"openapi":"3.0.1","info":{"title":"Frends API","version":"1.0"},"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"apiKey","description":"Enter your bearer token in the format **Bearer <token>**","name":"Authorization","in":"header"}},"schemas":{"ProblemDetails":{"type":"object","properties":{"type":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"status":{"type":"integer","format":"int32","nullable":true},"detail":{"type":"string","nullable":true},"instance":{"type":"string","nullable":true}},"additionalProperties":{}}}},"paths":{"/api/v1/processes/{processGuid}/versions/{processVersion}/export":{"get":{"tags":["Processes"],"summary":"Export Process to file","description":"Same as ExportWithId. Process Variables values are taken the Development Agent Group.","parameters":[{"name":"processGuid","in":"path","description":"Process unique identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"processVersion","in":"path","description":"Process version","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string","format":"binary"}}}},"404":{"description":"Process not found","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}}}}
```

--------------------------------

### GET /api/v1/instances/{agentGroupId}

Source: https://docs.frends.com/reference/frends-platform-api/platform-api-reference/processinstances

Retrieves a list of process instances associated with a specific agent group. Supports filtering by process GUIDs, start and end times, and execution state.

```APIDOC
## GET /api/v1/instances/{agentGroupId}

### Description
Retrieves a list of process instances for a given agent group. This endpoint allows filtering by specific process GUIDs, time ranges, and execution states.

### Method
GET

### Endpoint
`/api/v1/instances/{agentGroupId}`

### Parameters
#### Path Parameters
- **agentGroupId** (integer) - Required - The ID of the agent group to fetch process instances from.

#### Query Parameters
- **processGuids** (array of string) - Optional - Filters the results to include only processes with the specified GUIDs.
- **startTime** (string, date-time) - Optional - Filters the results to include processes that started at or after this time.
- **endTime** (string, date-time) - Optional - Filters the results to include processes that ended at or before this time.
- **stateFilter** (ProcessInstanceFilter) - Optional - Filters the results based on the execution state. Possible values: `ShowAll`, `ShowRunning`, `ShowFinished`, `ShowSuccessful`, `ShowFailed`, `ShowFailedNotAcknowledged`.
- **isChildProcess** (boolean) - Optional - Filters to include or exclude child processes.

### Request Example
```json
{
  "example": "GET /api/v1/instances/123?processGuids=[\"guid1\", \"guid2\"]&stateFilter=ShowRunning"
}
```

### Response
#### Success Response (200)
- **data** (array of ProcessInstanceViewModel) - The list of process instances.
- **nextContinuationToken** (string, nullable) - A token for fetching the next page of results. Use with caution if filters are changed.
- **nextLink** (LinkModel) - Information about the next link.

#### Response Example
```json
{
  "example": "{\n  \"data\": [\n    {\n      \"id\": 12345,\n      \"parentId\": null,\n      \"processId\": 101,\n      \"rootProcessId\": null,\n      \"processVersion\": 1,\n      \"state\": \"Started\",\n      \"startTimeUtc\": \"2023-10-27T10:00:00Z\",\n      \"endTimeUtc\": null,\n      \"utcDate\": \"2023-10-27T10:00:00Z\",\n      \"utcHour\": 10,\n      \"executionId\": \"a1b2c3d4-e5f6-7890-1234-567890abcdef\",\n      \"triggerId\": 50,\n      \"agentId\": 1,\n      \"environmentId\": 1,\n      \"agentGroupId\": 123,\n      \"exception\": null,\n      \"userName\": \"testuser\",\n      \"stepsLoggedToBlobs\": false,\n      \"hasLoggedSteps\": true,\n      \"acknowledgedUtc\": null,\n      \"commentJson\": null,\n      \"comment\": \"\",\n      \"promotedData\": [],\n      \"triggerName\": \"Manual Trigger\",\n      \"environmentName\": \"Development\",\n      \"agentName\": \"Agent 1\",\n      \"processGuid\": \"a1b2c3d4-e5f6-7890-1234-567890abcdee\",\n      \"parentName\": null,\n      \"triggerRequest\": null,\n      \"triggerResponses\": null,\n      \"promotedColumns\": null\n    }\n  ]\n}"
}
```
```

--------------------------------

### Run Frends Database Initializer Tool (Command Line)

Source: https://docs.frends.com/guides/setup-and-installation/how-to-set-up-high-availability-configuration

Command-line execution of the Frends.DatabaseInitializer.exe tool to set up the database for Frends Agents. Requires specifying the SQL Server connection string, agent database username, and password. The `--doNotCreateBackupJobs` flag can be used to skip backup job creation.

```bash
Frends.DatabaseInitializer.exe -c [SqlServerConnectionString] -n Frends.Agent.Data.Initialization.Migrations.SqlServerAgentStore -u [FRENDSAgentDatabaseUsername] -p [FRENDSAgentDatabasePassword] --doNotCreateBackupJobs
```

--------------------------------

### Get an individual Process Template

Source: https://docs.frends.com/reference/frends-platform-api/platform-api-reference/processtemplates

Retrieves a detailed view of a specific Process Template based on its GUID and version.

```APIDOC
## GET /api/v1/process-templates/{processTemplateGuid}/versions/{processTemplateVersion}

### Description
Returns a detailed view of a Process Template.

### Method
GET

### Endpoint
/api/v1/process-templates/{processTemplateGuid}/versions/{processTemplateVersion}

### Parameters
#### Path Parameters
- **processTemplateGuid** (string (uuid)) - Required - Process Template unique identifier
- **processTemplateVersion** (integer (int32)) - Required - Process Template version

### Request Example
```json
{
  "example": "request body"
}
```

### Response
#### Success Response (200)
- **data** (object) - Contains the Process Template details.
  - **id** (integer (int64)) - The unique identifier of the process template.
  - **name** (string) - The name of the process template. Minimum length is 1.
  - **modifier** (string) - The user who modified the template.
  - **modified** (string (date-time)) - The date and time the template was last modified.
  - **majorVersion** (integer (int32)) - The major version number of the template.
  - **minorVersion** (integer (int32)) - The minor version number of the template.
  - **targetFramework** (string) - The target framework for the template.
  - **frendsVersion** (string) - The Frends version compatibility.
  - **isSubprocess** (boolean) - Indicates if this template is a subprocess.
  - **staticRequiredEnvironmentVariablesJson** (string) - JSON string defining static required environment variables.
  - **isForMonitoringRule** (boolean) - Indicates if the template is for a monitoring rule.
  - **cancellationDisabled** (boolean) - Indicates if cancellation is disabled for this template.
  - **description** (string) - A description of the process template.
  - **changeDescription** (string) - Description of the changes made in this version.
  - **bpmn** (string) - The BPMN XML content of the process template. Minimum length is 1.
  - **elementParameters** (string) - JSON string for element parameters.
  - **promotedResultVariablesJson** (string) - JSON string for promoted result variables.
  - **usedSubprocessesJson** (string) - JSON string listing used subprocesses.
  - **usedTasksJson** (string) - JSON string listing used tasks.
  - **triggersJson** (string) - JSON string defining triggers.
  - **manualTriggerJson** (string) - JSON string for manual triggers.
  - **uniqueIdentifier** (string (uuid)) - A unique identifier for the template.
  - **isListed** (boolean) - Indicates if the template is listed.
  - **version** (integer (int32)) - The version number of the template.
  - **isDeleted** (boolean) - Indicates if the template is deleted.
  - **processVariablesJson** (string) - JSON string defining process variables.
  - **processTags** (string) - String containing process tags.
  - **templateTags** (array) - Array of strings representing template tags.
    - **items** (string)
  - **getVersion** (string) - Read-only field indicating the version.

#### Response Example
```json
{
  "data": {
    "id": 123,
    "name": "Example Process",
    "modified": "2023-10-27T10:00:00Z",
    "majorVersion": 1,
    "minorVersion": 0,
    "targetFramework": ".NET6",
    "frendsVersion": "2023.1",
    "isSubprocess": false,
    "staticRequiredEnvironmentVariablesJson": "{}",
    "isForMonitoringRule": false,
    "cancellationDisabled": false,
    "description": "An example process template.",
    "changeDescription": "Initial version.",
    "bpmn": "<bpmn:definitions ...>...</bpmn:definitions>",
    "elementParameters": "{}",
    "promotedResultVariablesJson": "{}",
    "usedSubprocessesJson": "[]",
    "usedTasksJson": "[]",
    "triggersJson": "[]",
    "manualTriggerJson": "null",
    "uniqueIdentifier": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
    "isListed": true,
    "version": 1,
    "isDeleted": false,
    "processVariablesJson": "{}",
    "processTags": "",
    "templateTags": [
      "example",
      "test"
    ],
    "getVersion": "1.0.0"
  }
}
```

#### Error Response (404)
- **type** (string) - URI reference that identifies the problem type.
- **title** (string) - A short, human-readable summary of the problem.
- **status** (integer (int32)) - The HTTP status code generated by the origin server.
- **detail** (string) - An application-specific explanation of the problem.
- **instance** (string) - URI that identifies this specific occurrence of the problem.

#### Response Example
```json
{
  "type": "https://tools.ietf.org/html/rfc7231#section-6.5.4",
  "title": "Not Found",
  "status": 404,
  "detail": "Process template with GUID 'a1b2c3d4-e5f6-7890-1234-567890abcdef' and version 1 not found.",
  "instance": "/api/v1/process-templates/a1b2c3d4-e5f6-7890-1234-567890abcdef/versions/1"
}
```
```

--------------------------------

### GET /api/v1/processes/{processGuid}/versions/{processVersion}

Source: https://docs.frends.com/reference/frends-platform-api/platform-api-reference/processes

Retrieves a specific version of a process identified by its GUID and version number. This endpoint provides detailed information about the process, including its configuration and metadata.

```APIDOC
## GET /api/v1/processes/{processGuid}/versions/{processVersion}

### Description
Retrieves a specific version of a process identified by its GUID and version number. This endpoint provides detailed information about the process, including its configuration and metadata.

### Method
GET

### Endpoint
/api/v1/processes/{processGuid}/versions/{processVersion}

### Parameters
#### Path Parameters
- **processGuid** (string) - Required - Process unique identifier (UUID)
- **processVersion** (integer) - Required - Process version number

### Response
#### Success Response (200)
- **deployments** (LinkModel) - Link to deployment information
- **delete** (LinkModel) - Link to delete the process version

#### Response Example
{
  "deployments": {
    "uri": "/api/v1/processes/{processGuid}/versions/{processVersion}/deployments",
    "method": "GET"
  },
  "delete": {
    "uri": "/api/v1/processes/{processGuid}/versions/{processVersion}",
    "method": "DELETE"
  }
}

#### Error Response (404)
- **type** (string, nullable) - Type of the error
- **title** (string, nullable) - Title of the error
- **status** (integer, nullable) - HTTP status code
- **detail** (string, nullable) - Detailed error message
- **instance** (string, nullable) - Instance of the error
```

--------------------------------

### Standard JObject Initialization in C#

Source: https://docs.frends.com/reference/process-development/json-in-frends

Provides an example of initializing a JObject in C# using standard square bracket notation. This method is performant but can be more verbose for complex objects.

```csharp
{
    JObject obj = new JObject {
        ["Name"] = "Test Person",
        ["Age"] = 35,
        ["ID"] = System.Guid.NewGuid()
    };
}
```

--------------------------------

### Start Frends Agent Service

Source: https://docs.frends.com/guides/setup-and-installation/installing-frends-agent

Command to start the Frends Agent service. This command assumes the agent service is named 'frendsagent'. It is a system-level command executed with superuser privileges.

```bash
sudo systemctl start frendsagent
```

--------------------------------

### Instantiate JArray Directly (C#)

Source: https://docs.frends.com/reference/process-development/c-in-frends

Demonstrates initializing a JArray without specifying the fully qualified domain name (FQDN). This is possible because Newtonsoft.Json is included by default in Frends. It shows a common use case for object storage.

```csharp
var jsonArray = new JArray();
```

--------------------------------

### Tokenized JSON Customer Record Example

Source: https://docs.frends.com/guides/ai-features/how-to-tokenize-data-for-ai

The result of applying field-based tokenization to the example customer record. Sensitive data fields identified by their names have been replaced with unique tokens, enhancing data privacy.

```json
{
		"customerId": "12345",
		"firstName": "{{TOKEN_001}}",
		"lastName": "{{TOKEN_002}}",
		"email": "{{TOKEN_003}}",
		"phone": "{{TOKEN_004}}",
		"accountStatus": "active",
		"address": {
			"street": "{{TOKEN_005}}",
			"city": "Springfield",
			"zipCode": "{{TOKEN_006}}"
		},
		"contactPreferences": {
			"preferredEmail": "{{TOKEN_007}}",
			"marketingOptIn": true
		}
}
```

--------------------------------

### Initialize Collections (List, JArray) in C#

Source: https://docs.frends.com/reference/process-development/json-in-frends

Shows how to initialize collections like List<string> and JArray using collection initializers. It also covers converting a List<string> to a JArray using JArray.FromObject.

```csharp
{
    List<string> list = new List<string> { "Bananas", "Apples", "Kiwis" };
    
    JArray arr = new JArray { "Bananas", "Apples", "Kiwis" };
    
    // Converting from a list is also possible
    JArray arr2 = JArray.FromObject(list);
}
```

--------------------------------

### Define ExecutionState Enum (JSON)

Source: https://docs.frends.com/reference/frends-platform-api/platform-api-reference/models

Defines the ExecutionState object as an enumeration of possible states for a process execution. This includes states like Ok, Waiting, Launched, Starting, Started, Canceled, Failed, and more.

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "Frends API",
    "version": "1.0"
  },
  "components": {
    "schemas": {
      "ExecutionState": {
        "enum": [
          "Ok",
          "Waiting",
          "Launched",
          "Starting",
          "Started",
          "Canceled",
          "CanceledByTerminate",
          "FinishedAsZombie",
          "TerminatedByUser",
          "ActionSkipped",
          "Failed",
          "Exception",
          "Finished"
        ],
        "type": "string"
      }
    }
  }
}
```

--------------------------------

### Handle Binary Data Encoding with FQDN (C#)

Source: https://docs.frends.com/reference/process-development/c-in-frends

Shows how to use the Fully Qualified Domain Name (FQDN) to access classes for handling binary data encoding. This example specifically demonstrates converting a byte array to a UTF-8 encoded string using System.Text.Encoding.

```csharp
var utf8String = System.Text.Encoding.UTF8.GetString(#var.binaryDataBytes);
```

--------------------------------

### JSON Customer Record Example

Source: https://docs.frends.com/guides/ai-features/how-to-tokenize-data-for-ai

An example of a JSON customer record containing various fields, some of which may hold Personally Identifiable Information (PII). This structure illustrates nested objects and potential duplicate sensitive data.

```json
{
  "customerId": "12345",
  "firstName": "John",
  "lastName": "Smith",
  "email": "john.smith@example.com",
  "phone": "+1-555-1234",
  "accountStatus": "active",
  "address": {
    "street": "123 Main St",
    "city": "Springfield",
    "zipCode": "12345"
  },
  "contactPreferences": {
    "preferredEmail": "john.smith@example.com",
    "marketingOptIn": true
  }
}
```

--------------------------------

### Initialize JObject and Dictionary with Collection Initializers in C#

Source: https://docs.frends.com/reference/process-development/json-in-frends

Illustrates initializing JObjects and Dictionaries using collection initializers, leveraging the fact that JObjects implement the same interface as dictionaries. It also shows converting a Dictionary to a JObject.

```csharp
{
    JObject obj = new JObject {
        { "Name", "Test Person" },
        { "Age", 35 },
        { "ID", System.Guid.NewGuid() }
    };
    
    Dictionary<string, object> dict = new Dictionary<string, object> {
        { "Name", "Test Person" },
        { "Age", 35 },
        { "ID", System.Guid.NewGuid() }
    };
    
    // Converting from a dictionary is also possible
    JObject obj2 = JObject.FromObject(dict);
}
```

--------------------------------

### Customize Task Discovery with FrendsTaskMetadata.json (JSON)

Source: https://docs.frends.com/guides/development/creating-custom-tasks

Shows how to configure task discovery by creating a FrendsTaskMetadata.json file. This JSON file allows you to specify which methods should be exposed as Tasks, preventing unwanted static methods from being discovered.

```json
{
    "Tasks": [
        {
            "TaskMethod": "Frends.TaskLibrary.FileActions.DoFileAction"
        }
    ]
}

```
Tokens:
Raw