Test Automation In Action
Test Automation In Action
| Variable Name | Description | Mandatory | Applicable Values | Default Value |
|---|---|---|---|---|
| API | Set it to true to enable the API Service (UI Backend) | Yes | true, false | |
| SCHEDULER | Set it to true to enable the scheduler service | Yes | true, false | |
| WORKFLOW | Set it to true to enable the multi-node workflow service | Yes | true, false | |
| IO_ENV | development/test/production | Yes | development/test/production | development |
| JWT_SECRET | Used to encode/decode JWT tokens | Yes | secret | |
| ARGON_SECRET | Used for password hashing | Yes | secret | |
| ARGON_ITERATIONS | Used for a number of iterations to generate password hashing | No | ||
| ARGON_MEMORY_SIZE | Used for an amount of memory to generate password hashing | No | ||
| INSTANCE_ID | A unique name for this instance | Yes | cloudio_node1 | |
| HOST | An IP address and port combination on which the web server listens for incoming connections. You can run multiple instances on the same host with different ports and/or on multiple hosts depending on the load. A single instance can scale upto a million requests per 20 minutes. | Yes | 127.0.0.1:3090 | |
| API_RATELIMIT | Number of API calls allowed per IP address per hour | Yes | 1000 | |
| AUTH_RATELIMIT | Number of sign-in API calls allowed per IP address per hour | Yes | 12 | |
| STATUS_RATELIMIT | Number of stutus API calls allowed per IP address per hour | Yes | 60 | |
| TMP_DIR | Temp directory path | Yes | tmp | |
| ENCRYPTED_ARGS | Set it to N to encrypt few env variables(JWT_SECRET, ARGON_SECRET, DATABASE_URL, READONLY_DATABASE_URL REDIS_URL, SMTP_PASSWORD, SASL_PASSWORD, ADMIN_PASSWORD, DB_PKCS12_PASSWORD) | No | Y,N | N |
| ADMIN_EMAIL | For the first time installation, platform will create a admin user with this given email address | No | ||
| ADMIN_PASSWORD | For the first time installation, platform will create a admin user with this given password | No | ||
| JS_DIR | Directory for the js libraries | Yes | js | |
| THUMBNAILS_DIR | Directory for storing thumbnails | Yes | thumbnails | |
| MULTI_TENANT | To enable multi tenant setup | Yes | N | |
| X_FRAME_OPTION | Set a value for this to add a X_FRAME_OPTION header for server requests | DENY,SAMEORIGIN,_ | DENY | |
| MFA | Set it to EMAIL to enable MFA for sign-in (send a code to email while signing in) | Yes | EMAIL,OFF | OFF |
| MD_DB_TYPE | Metadata database type | Yes | mysql,postgres,oracle | mysql |
| LIVE_INTERVAL_SECONDS | Set a value in seconds to send live updates to clients | Yes | 15 | |
| SQL_TIMEOUT_SECONDS | Set a value in seconds to set the timeout for the SQL query | Yes | 120 | |
| MAX_CONCURRENT_REQUESTS | Set a value to allow maximum concurrent client requests on the server | Yes | 40 | |
| SCHEDULER_SLEEP_SECONDS | Set a value to set a sleep time before running schedulers | Yes | 60 | |
| PUBLIC_TINY_URL | Set it true to allow the public user to create a shared URL | Yes | ||
| AGENT | To enable Agent setup | No |
| Variable Name | Description | Mandatory | Applicable Values | Default Value |
|---|---|---|---|---|
| DATABASE_URL | Specify the Database Url to connect metadata. | Yes | ||
| READONLY_DATABASE_URL | Used for running ad hoc queries from SQL Worksheet | Yes | Same as DATABASE_URL with readonly database user | |
| ROOT_DATABASE_URL | Same as DATABASE_URL with root database user | No | Same as DATABASE_URL with root database user | |
| DB_ROOT_CERT_PATH | CA cert path | No | ||
| DB_PKCS12_PATH | Private key in PKCS12 format | No | ||
| DB_PKCS12_PASSWORD | Private key password if any | No | ||
| DB_ACCEPT_INVALID_CERTS | To accept invalid certs (self signed certs) | No | true,false | |
| DB_SKIP_DOMAIN_VALIDATION | To skip domain validation | No | true,false | |
| ALLOW_SQL_WORKSHEET_UPDATES | Whether or not to allow ad hoc updates via. SQL Worksheet. Set this to N in Production & UAT instance. | Yes | Y,N | N |
| Variable Name | Description | Mandatory | Applicable Values | Default Value |
|---|---|---|---|---|
| AZURE_CLIENT_SECRET | Azure key vault account client secret | No | ||
| AZURE_CLIENT_ID | Azure key vault account client id | No | ||
| AZURE_TENANT_ID | Azure key vault account tenant id | No | ||
| AZURE_KEY_VAULT_URL | Azure key vault url | No | ||
| AZURE_STORAGE_ACCOUNT | Azure storage account | No | ||
| AZURE_STORAGE_MASTER_KEY | Azure storage account master key | No |
| Variable Name | Description | Mandatory | Applicable Values | Default Value |
|---|---|---|---|---|
| REDIS_PREFIX | To assign a prefix value for keys stored in Redis | No | dev | dev |
| REDIS_URL | URL of the Redis server | No |
| Variable Name | Description | Mandatory | Sample Values | Default Value |
|---|---|---|---|---|
| KAFKA_PREFIX | To assign a prefix value for topic names before creating in Kafka | No | ||
| BOOTSTRAP_SERVERS | Kafka bootstrap server URL. If using a cloud instance from confluent then provide appropriate values for the additional variables SECURITY_PROTOCOL, SASL_MECHANISMS, SASL_USERNAME & SASL_PASSWORD provided by confluent cloud when creating a new Kafka cluster | No | #Local Kafka BOOTSTRAP_SERVERS=localhost:9092 #Kafka on Confluent Cloud BOOTSTRAP_SERVERS=p...5.us-west-2.aws.confluent.cloud:9092 SECURITY_PROTOCOL=SASL_SSL SASL_MECHANISMS=PLAIN SASL_USERNAME=SR4C...OP4DIA SASL_PASSWORD=j4StZg8Kg7m...B5Kgant9A | |
| SECURITY_PROTOCOL | No | |||
| SASL_MECHANISMS | No | |||
| SASL_USERNAME | No | |||
| SASL_PASSWORD | No |
| Variable Name | Description | Mandatory | Applicable Values | Default Value |
|---|---|---|---|---|
| LOG_OUTPUT | file or console | Yes | console, file | file |
| LOG_SQLS | Set it true to log the SQL queries and it's params | Yes | true,false | false |
| LOG_VIEWER_KEY | Key to access a logs without a session | Yes | viG_D6Zo6mtXDAt_3Z | |
| ENABLE_LOG_VIEWER_USING_KEY | Set it true to access the logs without a session using a unique key | Yes | true,false | true |
| Variable Name | Description | Mandatory | Applicable Values | Default Value |
|---|---|---|---|---|
| EMAIL_PROVIDER | Different email providers | Yes | GMAIL, SMTP | |
| SMTP_HOST | SMTP Host Name to be used for sending email alerts | Yes | ||
| SMTP_PORT | SMTP port number | No | ||
| SMTP_USE_TLS | To enable SMTPS | No | true,false | |
| SMTP_USERNAME | SMTP Username | if EMAIL Yes | ||
| SMTP_PASSWORD | SMTP Password | if EMAIL Yes | ||
| GMAIL_CREDENTIAL_FILE_PATH | GMAIL Service Account Credentials Path | if GMAIL Yes | ||
| SMTP_FROM | From email address to be used for the outbound emails | Yes |
Edit Storage Connection Panel
Edit Connection Panel
Application Header Toolbar
Edit Application Panel
Application Roles Panel
DataSource Creation Wizard
Add or Edit Field Panel
DataSource More Actions Menu
DataSource Access Settings
Create Page Wizard
More Actions Menu
Sample Page with Complex Layouts
Designer View
More Tabs
App Settings Panel
const records = await db.find("DataSourceName", {
filter: [
{ name: { sw: "Steve" } },
{ joinDate: { after: new Date().toISOString() } },
{ amount: { eq: 123 } },
],
limit: 20,
{appUid: 'my-other-app'}
});
const insertedRow = await db.insertOne(
"DataSourceName",
newRow,
{appUid: 'my-other-app'
);
`;
// send the notification
// to a user e.g. admin
await db.notifyUser('admin', subject, body);
// to a set of users e.g. admin, username2
await db.notifyUser(['admin', 'username2'], subject, body);
// to all users assigned to a role
await db.notifyRole('my-app', 'developer', subject, body);
// to all users assigned to a set of roles
await db.notifyRole('my-app', ['administrator', 'developer'], subject, body);
```
{% endcode %}
## Sending Email
{% code overflow="wrap" %}
```javascript
// Text Email
const email = {
to: 'example@domain.com',
subject: 'Hi there!',
text: 'email body',
};
await db.sendEmail(email);
// HTML Email
const htmlBody = await db.processMustacheTemplate(templateString, dataObject):
const email = {
to: 'example@domain.com',
subject: 'Hi there!',
text: 'HTML Only Email',
html: htmlBody
};
await db.sendEmail(email);
```
{% endcode %}
## Triggering Workflow
{% code overflow="wrap" %}
```javascript
const wfUid = "..."; // Workflow UID that can be optained from Edit Workflow Panel
const version = 1; // Workflow Version from Edit Workflow Panel
const state = {}; // Any JSON object to set the initial state of the Workflow
await db.startWorkflow(wfUid, version, "Some description", state);
```
{% endcode %}
## Process Mustache Template String
{% code overflow="wrap" %}
```javascript
const output = await db.processMustacheTemplate(templateString, dataObject):
```
{% endcode %}
## Format Date
{% code overflow="wrap" %}
```javascript
const { format } = await import('date-fns');
const formatedDateString = format(new Date(), 'MM/dd/yyyy');
```
{% endcode %}
# Module Imports
The following 3rd party modules are available for import within any of the backend script
### date-fns
### lodash
### crypto-js
{% hint style="info" %}
Let us know if you need any other 3rd party library/module that's not listed above.
{% endhint %}
# WHO Columns
Make sure the following WHO columns exists on all the tables that are updated via. the platform UI
```sql
`CREATION_DATE` datetime(6) NOT NULL,
`CREATED_BY` varchar(128) NOT NULL,
`LAST_UPDATE_DATE` datetime(6) NOT NULL,
`LAST_UPDATED_BY` varchar(128) NOT NULL,
```
{% hint style="warning" %}
Note: The date column LAST\_UPDATE\_DATE must be of type **datetime(6)**
{% endhint %}
# Authentication
## Authentication
`POST` `https://next.cloudio.io/v1/auth`
This endpoint allows you to authenticate a service account
#### Headers
| Name | Type | Description |
| -------------- | ------ | ---------------------------------------------------------------------------------- |
| Content-Type | string | application/json |
| Authentication | string | Authentication token
JS e.g. `Token ${btoa(`${username}:${password}`)}`
Authentication token
JS e.g. `Bearer ${authResponse.jwt}`
Authentication token
JS e.g. `Bearer ${authResponse.jwt}`
Test Automcation In Action
Test Scripts Sidebar Tab
On Premise Agent Architecture