Ardoq Help

https://help.ardoq.com
Admin
Ardoq Help provides advice, guidance, and documentation for users to effectively utilize the Ardoq...
Tokens:273,642
Snippets:4,927
Trust Score:9.9
Update:3 months ago
Show doc for...
Tokens:
Raw
### Ardoq Client Project Example

Source: https://help.ardoq.com/en/articles/44126-net-client-deprecated

A complete example demonstrating how to create workspaces, components, and references using the Ardoq client.

```csharp
using Ardoq;using Ardoq.Models;using System;using System.Collections.Generic;using System.Net.Http;using System.Threading.Tasks; namespace ConsoleApplication{    class Program    {        static void Main(string[] args)        {            var workspace = new Program().Run();            workspace.Wait();            Console.WriteLine(workspace.Result);            Console.ReadLine();        }         public async Task<Workspace> Run()        {            var client = new ArdoqClient(new HttpClient(), "https://app.ardoq.com", "insert-your-token-here", "your-organization-label");            var template = await client.ModelService.GetTemplateByName("Application Service");            var workspace = await                client.WorkspaceService.CreateWorkspace(new Workspace("demo-workspace", template.Id, "My demo workspace"));            var model = await client.ModelService.GetModelById(workspace.ComponentModel);            var webshop =                await                    client.ComponentService.CreateComponent(new Component("Webshop", workspace.Id, "This is the webshop", model.GetComponentTypeByName("Application")));            var webshopCreateOrder =                await                    client.ComponentService.CreateComponent(new Component("Create order", workspace.Id,                        "Creates an order based on the current shoppingcat", model.GetComponentTypeByName("Service"), webshop.Id));            var erp =                await                    client.ComponentService.CreateComponent(new Component("ERP", workspace.Id, "This is the ERP system", model.GetComponentTypeByName("Application")));            var erpCreateOrder =                await                    client.ComponentService.CreateComponent(new Component("Create order", workspace.Id,                        "Creates an order", model.GetComponentTypeByName("Service"), erp.Id));             var reference = await                    client.ReferenceService.CreateReference(new Reference(workspace.Id, "Order from cart", webshopCreateOrder.Id, erpCreateOrder.Id,                        model.GetReferenceTypeByName("Synchronous"))                    { ReturnValue = "Created order" });            await client.TagService.CreateTag(new Tag("Customer", workspace.Id, "",                new List<string>() { webshopCreateOrder.Id, erpCreateOrder.Id }, new List<string>() { reference.Id }));            return await client.WorkspaceService.GetWorkspaceById(workspace.Id);        }    }}
```

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

### Create project components and references

Source: https://help.ardoq.com/en/articles/44127-java-client-deprecated

Example of creating a workspace, components, and a synchronous reference between them.

```java
ArdoqClient client = new ArdoqClient(host, ardoqUsername, ardoqPassword);Model model = client.model().getModelByName("Application service");Workspace workspace = client.workspace().createWorkspace(new Workspace("demo-workspace", model.getId(), "Description"));ComponentService componentService = client.component(); Component webshop = componentService.createComponent(new Component("Webshop", workspace.getId(), "Webshop description"));Component webShopCreateOrder = componentService.createComponent(new Component("createOrder", workspace.getId(), "Order from cart", model.getComponentTypeByName("Service"), webshop.getId())); Component erp = componentService.createComponent(new Component("ERP", workspace.getId(), ""));Component erpCreateOrder = componentService.createComponent(new Component("createOrder", workspace.getId(), "", model.getComponentTypeByName("Service"), erp.getId()));//Create a Synchronous integration between the Webshop:createOrder and ERP:createOrder servicesReference createOrderRef = new Reference(workspace.getId(), "Order from cart", webShopCreateOrder.getId(), erpCreateOrder.getId(), model.getReferenceTypeByName("Synchronous"));createOrderRef.setReturnValue("Created order");Reference reference = client.reference().createReference(createOrderRef); List<String> componentIds = Arrays.asList(webShopCreateOrder.getId(), erpCreateOrder.getId());List<String> referenceIds = Arrays.asList(reference.getId());client.tag().createTag(new Tag("Customer", workspace.getId(), "", componentIds, referenceIds)); 
```

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

### Install Ardoq NuGet Package

Source: https://help.ardoq.com/en/articles/44126-net-client-deprecated

Command to install the Ardoq client library via NuGet Package Manager.

```powershell
PM> Install-Package Ardoq
```

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

### Application Description Example

Source: https://help.ardoq.com/en/articles/127002-ai-based-reference-creation-in-ardoq-with-simple-retrieval-augmented-generation

A sample description string for an application used in the context of capability mapping.

```text
“Genesys PureConnect is a customer interaction center (CIC) for both on-premise & cloud (CaaS)”
```

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

### Well-known configuration URL format

Source: https://help.ardoq.com/en/articles/43998-setting-up-single-sign-on-using-openid-connect-or-oauth2

Example of the well-known configuration URL structure for an Okta instance.

```text
https://<your-okta-instance>.okta.com/.well-known/openid-configuration
```

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

### Deploy the Helm chart

Source: https://help.ardoq.com/en/articles/43942-k8s-ardoq-bridge-kubernetes-to-ardoq-bridge

Command to install the bridge using required configuration parameters.

```bash
helm upgrade --install k8s-ardoq-bridge k8s-ardoq-bridge/k8s-ardoq-bridge --set "ardoq.baseUri='https://{your_custom_domain_here}/api/',ardoq.org='{your_org_label_here}',ardoq.workspaceId='{your_workspace_id_here}',ardoq.apiKey={your_api_key_here},ardoq.cluster='{your_cluster_name_here}'"
```

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

### Using join-function in Gremlin

Source: https://help.ardoq.com/en/articles/43991-gremlin-troubleshooting

Example of listing components and their children using the join-function within a project step.

```gremlin
g.V().has('name').project('name', 'children').  
by('name').  
by(coalesce(__.in('ardoq_parent').values('name').fold().map{it.get().join(', ')}, constant('')))
```

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

### Verify Node.js Installation

Source: https://help.ardoq.com/en/articles/330756-connect-claude-desktop-to-the-ardoq-mcp-server

Run this command in your terminal to confirm that Node.js v18 or higher is installed.

```bash
node --version
```

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

### Request Payload Example from Endpoint

Source: https://help.ardoq.com/en/articles/374798-import-api

Sends a configuration identifier to the Payload Example endpoint to generate a template.

```json
{
  "config": {  
    "name": "Test Configuration"  
  }  
}
```

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

### Create a table using select() and by() steps

Source: https://help.ardoq.com/en/articles/44194-gremlin-training-18-presenting-data-in-tables-select

This query traverses from Person to Application to Business Capability, labeling each step and selecting them for table output with specific property formatting.

```gremlin
g.V().  hasLabel('Person').as('Person').  out('Is Expert In').  hasLabel('Application').as('Application').  in('Is Realized By').  hasLabel('Business Capability').as('Business Capability').  select('Person', 'Application', 'Business Capability').    by('name').    by('name').    by('name')
```

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

### Initialize ArdoqClient

Source: https://help.ardoq.com/en/articles/44127-java-client-deprecated

Demonstrates authentication using basic credentials, tokens, or custom proxy settings.

```java
//Basic authArdoqClient client = new ArdoqClient("hostname", "username", "password");//TokenArdoqClient client = new ArdoqClient("hostname", "token"); //Custom proxy settingsRequestConfig config = RequestConfig.custom().setProxy(new HttpHost("127.0.0.1", 9090)).build();ArdoqClient client = new ArdoqClient("hostname", "token", config);
```

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

### Example Component Creation Response

Source: https://help.ardoq.com/en/articles/44146-rest-api-tutorial

A sample JSON response returned after creating a component, highlighting the _id field.

```json
{
  "description": "",
  "_order": 500.2,
  "last-updated": "2016-04-05T11:29:08.381Z",
  "_id": "5703a1849f2a264e83a8b0b9",
  "type": "Business process",
  "typeId": "p1448628262462",
 ...other fields...
}
```

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

### Calculate Start Date via Gremlin

Source: https://help.ardoq.com/en/articles/43910-calculated-date-ranges

Retrieves the minimum start date value from referenced components connected via the 'Realizes' edge.

```gremlin
//Example: get referenced component date fields   
//this gets the min value of the start dates   
  
g.V(ids).where(__.in('Realizes').has('active_period_start_date')). project('id', 'name', 'value').  
by(id).  
by('name').  
by(__.in('Realizes').has('active_period_start_date').order(). by('active_period_start_date', desc).limit(1).  
values('active_period_start_date'))
```

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

### Example JSON Response

Source: https://help.ardoq.com/en/articles/127002-ai-based-reference-creation-in-ardoq-with-simple-retrieval-augmented-generation

The expected structure of the JSON returned by the LLM.

```json
{
  "capabilities": [
    {
      "_id": "edb3faa34652f7a5c06283f2",
      "name": "Risk Policies and Framework"
    }
  ]
}
```

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

### Basic Filtering Example

Source: https://help.ardoq.com/en/articles/43988-gremlin-tricks-filtering-with-the-where-step

Demonstrates combining multiple standard filter steps like hasLabel, has, hasNot, and filter to narrow down components.

```Gremlin
g.V().  hasLabel('Application').  has('lifecycle_phase', 'Live').  hasNot('criticality').  filter(__.in('Owns')).  filter(both().count().is(gt(2))).  not(__.in('Is Realized By').hasLabel('Business Capability'))
```

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

### Initialize Ardoq Client

Source: https://help.ardoq.com/en/articles/44126-net-client-deprecated

Basic instantiation of the ArdoqClient. The client defaults to the Sandbox organization unless specified otherwise.

```csharp
var client = new ArdoqClient(new HttpClient(), "https://app.ardoq.com", "api-token", "ardoq");
```

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

### API response structure

Source: https://help.ardoq.com/en/articles/44146-rest-api-tutorial

Example JSON responses returned after successfully creating a component.

```json
{  
  "_id": "5703c80f72fa6d547578f042",  
  "name": "User googles a term in the campaign",  
  ...other fields...  
}  
   
{  
  "_id": "5703c83372fa6d547578f044",  
  "name": "User clicks the Pied Piper advertisement",  
  ...other fields...  
}  
   
{  
  "_id": "5703c8379f2a264e83a8b2cb",  
  "name": "User is re-directed to one of five landing pages."  
  ...other fields...  
}
```
Tokens:
Raw