### Linux Startup Output Example

Source: https://docs.jitterbit.com/design-studio/design-studio-reference/connectors/sap-connector/sap-event-listener/sap-event-listener-installation

Example output displayed when the Jitterbit SAP Event Listener service starts successfully on Linux, indicating the Tomcat server has been initiated.

```shell
Using CATALINA_BASE:   /opt/jitterbitsap

Using CATALINA_HOME:   /opt/jitterbitsap

Using CATALINA_TMPDIR: /opt/jitterbitsap/temp

Using JB_JRE_HOME:        ..//jre

Using CLASSPATH:       /opt/jitterbitsap/bin/bootstrap.jar:/opt/jitterbitsap/bin/tomcat-juli.jar

Tomcat started.
```

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

### Start Jitterbit Agent Services

Source: https://docs.jitterbit.com/agent/windows

Starts the Jitterbit private agent services on a Windows host. This command is executed from a command prompt.

```batch
"C:\Program Files\Jitterbit Agent\StartServices.bat"
```

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

### Run Jitterbit Agent with Docker Quick Start

Source: https://docs.jitterbit.com/agent/docker

This snippet demonstrates the quick start method for running a Jitterbit agent using Docker. It interactively prompts for registration information, starts the agent, and tails the log file.

```bash
docker run -it jitterbit/agent sh -c "jitterbit-config; jitterbit start; tail -F log/jitterbit-agent.log"
```

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

### Jitterbit Documentation Navigation

Source: https://docs.jitterbit.com/pt/design-studio/design-studio-basics/user-interface-main-toolbar

Links to navigate through different sections of the Jitterbit documentation, including getting started guides, release notes, and specific product areas like iPaaS and API Manager.

```APIDOC
Documentation Navigation:
  - Jitterbit Documentation: ../../..
  - Get started: ../../getting-started/
  - Release notes: ../../release-notes/harmony-release-notes/
  - iPaaS: ../../integration-studio/
  - API Manager: ../../api-manager/
  - App Builder: ../../app-builder/
  - EDI: ../../edi/
  - Marketplace: ../../marketplace/
  - Management Console: ../../management-console/
```

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

### Install SAP Event Listener on Linux

Source: https://docs.jitterbit.com/design-studio/design-studio-reference/connectors/sap-connector/sap-event-listener/sap-event-listener-installation

Steps to install the SAP Event Listener on Linux using the command line. This involves extracting a tar file, navigating to the bin directory, and running a configuration script.

```bash
# tar -xvf JitterbitSAPEventListener-8.29.2.4.tar -C /opt/jitterbitsap
```

```bash
# cd /opt/jitterbitsap/bin
```

```bash
# ./runconfig.sh
```

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

### Example Jitterbit Agent Registration (register.json)

Source: https://docs.jitterbit.com/agent/docker

An example of a `register.json` file with sample values for configuring a Jitterbit private agent, including specific region, group ID, and encrypted credentials.

```json
{
    "cloudUrl": "https://na-east.jitterbit.com",
    "agentGroupId": 12345,
    "username": "$00HD1uP3SoM3odoS5NklwBp3VBeg1O4COW31ohIMqBBfWOcUrlzADwMawtI8lAcg6C",
    "password": "$003k9pLM1SJvrnh4CeMzw6jBdzsr0TY6s92wNuMiBuIVs=",
    "agentNamePrefix": "test",
    "deregisterAgentOnDrainstop": false,
    "retryCount": 10,
    "retryIntervalSeconds": 5
}
```

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

### Example Jitterbit Agent Environment Configuration

Source: https://docs.jitterbit.com/agent/docker

An example of the environment configuration file with specific values for Harmony origin, agent group ID, and encrypted credentials.

```env
HARMONY_ORIGIN=https://na-east.jitterbit.com
AUTO_REGISTER=true
AUTO_REGISTER_AGENT_GROUP_ID=12345
AUTO_REGISTER_AGENT_NAME_PREFIX=auto
AUTO_REGISTER_DEREGISTER_ON_DRAINSTOP=false
AUTO_REGISTER_ENCRYPTED_USERNAME=$00HD1uP3SoM3odoS5NklwBp3VBeg1O4COW31ohIMqBBfWOcUrlzADwMawtI8lAcg6C
AUTO_REGISTER_ENCRYPTED_PASSWORD=$003k9pLM1SJvrnh4CeMzw6jBdzsr0TY6s92wNuMiBuIVs=
```

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

### Jitterbit API Gateway Startup Log Example

Source: https://docs.jitterbit.com/pt/api-gateways/private-api-gateway/install-a-private-gateway

An example of the standard output logs displayed when the Jitterbit API Gateway starts up. It includes version information, build date, configuration loading status, service URLs, and confirmation of successful startup.

```log
. . .
nginx:`[alerta] `[lua] startup.lua:0: (): 
       ___ ___  ___  __   __    ___ 
   | |  |   |  |__  |__) |__) |  |`FIM DA MESA`
\__/ |  |   |  |___ |  \ |__) |  |`FIM DA MESA` 
           API gateway 

Version: x.x.x.x
Build Date: 20XX/XX/XX 00:00

Loading Libraries...
Libraries loaded successfully!

Loading configuration...
Configuration file:  /usr/local/openresty/nginx/conf/onpremise/gatewayconfig.yaml
Configuration file successfully loaded, parsing values...

************************************************************

InfluxDB output not configured.
Loggly output not configured.
ELK output not configured.

Configuration parsing successful!

Doing startup checks...

Checks completed, no errors.

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

Jitterbit Services URL: https://services.jitterbit.net/apis
Gateway will login as: gatewayuser
Organization ID set to: 123456

Current Time: 20XX-XX-XX 00:00:00
Gateway Startup Successful!

Gateway server started

   
```

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

### Run Jitterbit Agent Installer Script

Source: https://docs.jitterbit.com/es/agent/linux

Executes the Jitterbit agent's installation script, typically located in a 'scripts' directory within the agent's installation path. This script performs the final setup steps.

```sh
$HOME/scripts/install.sh
```

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

### Configuration Value Examples

Source: https://docs.jitterbit.com/app-builder/documentation/installation-guide/configuration

Demonstrates equivalent configuration values for App Builder using environment variables, appsettings.json, and connection.xml.

```shell
ConnectionInfo__DatabaseType=SQLServer
ConnectionInfo__HostName=localhost
ConnectionInfo__DatabaseName=App Builder
ConnectionInfo__UserName=vinyl
ConnectionInfo__Password=P@5$w0rD
```

```json
{
  "ConnectionInfo": {
    "DatabaseType": "SQLServer",
    "HostName": "localhost",
    "DatabaseName": "App Builder",
    "UserName": "vinyl",
    "Password": "P@5$w0rD"
  }
}
```

```xml
<ConnectionInfo DatabaseType="MySQL" HostName="localhost" DatabaseName="App Builder" UserName="vinyl" Password="P@5$w0rD"/>
```

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

### Site Configuration Example

Source: https://docs.jitterbit.com/de/app-builder/documentation/installation-guide/configuration

Illustrates the JSON structure for configuring site properties, including URL, aliases, and redirection settings.

```JSON
{
  "Site": {
    "Url": "https://example.com/App Builder",
    "Default": true,
    "Redirect": true,
    "RedirectIfHeaderExists": "X-Forwarded-For",
    "Aliases": [
      {
        "Url": "https://vinyl.example.com"
      }
    ]
  }
}
```

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

### Packaging Configuration Examples

Source: https://docs.jitterbit.com/app-builder/documentation/installation-guide/configuration

Demonstrates JSON configurations for the Packaging section, specifying storage types like Database, FileSystem, and S3, along with their respective parameters.

```json
{
  "Packaging": {
    "PackageStore": "Database"
  }
}
```

```json
{
  "Packaging": {
    "PackageStore": "FileSystem",
    "Directory": "C:\\Packages"
  }
}
```

```json
{
  "Packaging": {
    "PackageStore": "S3",
    "S3BucketEndpoint": "https://my-aws-domain.s3.us-east-1.amazonaws.com",
    "S3KeyPrefix": "vinyl/"
  }
}
```

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

### Start Jitterbit Services on Windows

Source: https://docs.jitterbit.com/data-loader/agent-not-running-or-is-stopped-or-unreachable

This script is used to start the Jitterbit services on a Windows operating system. It is typically located within the Jitterbit installation directory.

```batch
StartServices.bat
```

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

### Get Operation GUID for Scripting

Source: https://docs.jitterbit.com/es/integration-studio/design/operations/deployment-and-execution

Demonstrates how to obtain the GUID of an operation, typically used for referencing operations in other projects or from different environments. The output format is shown as an example.

```Jitterbit Script
<trans>"<TAG>operation:Example Operation</TAG>";</trans>
```

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

### Configuration Source Precedence Example

Source: https://docs.jitterbit.com/pt/app-builder/documentation/installation-guide/configuration

Demonstrates equivalent configuration values for ConnectionInfo using environment variables, appsettings.json, and connection.xml, illustrating the precedence order.

```Environment Variables
ConnectionInfo__DatabaseType=SQLServer
ConnectionInfo__HostName=localhost
ConnectionInfo__DatabaseName=App Builder
ConnectionInfo__UserName=vinyl
ConnectionInfo__Password=P@5$w0rD
```

```appsettings.json
{
  "ConnectionInfo": {
    "DatabaseType": "SQLServer",
    "HostName": "localhost",
    "DatabaseName": "App Builder",
    "UserName": "vinyl",
    "Password": "P@5$w0rD"
  }
}
```

```connection.xml
<ConnectionInfo DatabaseType="MySQL" HostName="localhost" DatabaseName="App Builder" UserName="vinyl" Password="P@5$w0rD"/>
```

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

### Install Node.js and npm

Source: https://docs.jitterbit.com/design-studio/design-studio-reference/sources-and-targets/local-file/use-netsuite-tba-with-a-local-file-source

Installs Node.js and npm on a Linux system (Ubuntu 18.04 example) if they are not already present. These are required for running the Node.js script that calls the NetSuite RESTlet.

```shell
$ sudo apt install nodejs
$ sudo apt install npm
```

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

### Start App Builder with Docker Compose

Source: https://docs.jitterbit.com/app-builder/documentation/docker-installation

This example demonstrates how to start Jitterbit App Builder and its database using Docker Compose. It assumes a standard setup where the database is run in a separate service within the same compose file. This method simplifies the initial setup by managing both the App Builder and its database dependencies.

```yaml
version: '3.8'
services:
  app-builder:
    image: jitterbit/app-builder
    container_name: app-builder
    ports:
      - "8080:80"
    environment:
      # Example environment variables for database connection
      # DB_HOST: db
      # DB_PORT: 5432
      # DB_NAME: appbuilderdb
      # DB_USER: appbuilderuser
      # DB_PASSWORD: yourpassword
    depends_on:
      - db

  db:
    image: postgres:14
    container_name: appbuilder_db
    environment:
      POSTGRES_DB: appbuilderdb
      POSTGRES_USER: appbuilderuser
      POSTGRES_PASSWORD: yourpassword
    volumes:
      - postgres_data:/var/lib/postgresql/data

volumes:
  postgres_data:
```

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

### Windows SAP Event Listener Service Control

Source: https://docs.jitterbit.com/design-studio/design-studio-reference/connectors/sap-connector/sap-event-listener/sap-event-listener-installation

Instructions for managing the Jitterbit SAP Event Listener service on Windows. Users can stop and start the service via the Windows start menu.

```windows
Start Menu -> Jitterbit SAP Event Listener -> Stop Jitterbit SAP Listener
Start Menu -> Jitterbit SAP Event Listener -> Start Jitterbit SAP Listener
```

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

### Example Encrypt Jitterbit Credentials

Source: https://docs.jitterbit.com/agent/docker

Demonstrates the `jitterbit-utils` command with sample Harmony credentials.

```shell
docker run jitterbit/agent jitterbit-utils -e example@jbexample.com P@55w0rd
```

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

### Quickbase API Reference

Source: https://docs.jitterbit.com/integration-studio/design/connectors/quickbase/create-activity

References to the Quickbase API for understanding schema nodes, fields, and general API usage. This includes links to official documentation for detailed information.

```APIDOC
Quickbase JSON RESTful API:
  - Provides access to Quickbase data and functionality.
  - Documentation available at: https://developer.quickbase.com

Quickbase API Guide:
  - Detailed information on schema nodes and fields.
  - Documentation available at: https://helpv2.quickbase.com/hc/en-us/articles/4418310927892-Welcome-to-the-Quickbase-API-Guide

Related Concepts:
  - Connection: Ensure a successful connection to Quickbase is established before proceeding.
  - Operations Log: Errors encountered during activity execution are logged here.
```

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

### Linux SAP Event Listener Restart Commands

Source: https://docs.jitterbit.com/design-studio/design-studio-reference/connectors/sap-connector/sap-event-listener/sap-event-listener-installation

Commands to stop and start the Jitterbit SAP Event Listener service on a Linux system. This is part of the service management process after installation or upgrade.

```shell
# ./shutdown.sh
```

```shell
# ./startup.sh
```

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

### Query Account Insights from Start Date with Daily Period

Source: https://docs.jitterbit.com/pt/integration-studio/design/connectors/instagram/connection-details

Fetches all metrics from AccountInsights starting from '2018/01/01' with a daily aggregation period. This is useful for retrieving data over a specific duration, like the last 7 days.

```SQL
SELECT * FROM AccountInsights WHERE FromDateTime = '2018/01/01' AND period = 'day'
```

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

### ConnectionInfo Configuration JSON Example

Source: https://docs.jitterbit.com/app-builder/documentation/installation-guide/configuration

A JSON example illustrating the structure and values for the ConnectionInfo configuration.

```JSON
{
  "ConnectionInfo": {
    "DatabaseType": "SQLServer",
    "HostName": "localhost",
    "DatabaseName": "App Builder",
    "UserName": "App Builder",
    "Password": "password",
    "Advanced": "MultiSubnetFailover=true;TrustServerCertificate=true;"
  }
}
```

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

### Retrieve Columns for 'Users' Table

Source: https://docs.jitterbit.com/pt/integration-studio/design/connectors/instagram/connection-details

SQL query to get the column names and data types for a specific table, 'Users'.

```SQL
SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Users'
```

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

### Jitterbit Private API Gateway Startup Log

Source: https://docs.jitterbit.com/api-gateways/private-api-gateway/install-a-private-gateway

An example of a successful startup log for the Jitterbit private API gateway. It shows the initialization process, configuration loading, service URLs, and confirmation of successful gateway startup.

```Shell
. . .
nginx: [alert] [lua] startup.lua:0: ():
       ___ ___  ___  __   __    ___
   | |  |   |  |__  |__) |__) |  |
\__/ |  |   |  |___ |  \ |__) |  |
           API gateway

Version: x.x.x.x
Build Date: 20XX/XX/XX 00:00

Loading Libraries...
Libraries loaded successfully!

Loading configuration...
Configuration file:  /usr/local/openresty/nginx/conf/onpremise/gatewayconfig.yaml
Configuration file successfully loaded, parsing values...

************************************************************

InfluxDB output not configured.
Loggly output not configured.
ELK output not configured.

Configuration parsing successful!

Doing startup checks...

Checks completed, no errors.

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

Jitterbit Services URL: https://services.jitterbit.net/apis
Gateway will login as: gatewayuser
Organization ID set to: 123456

Current Time: 20XX-XX-XX 00:00:00
Gateway Startup Successful!

Gateway server started
```

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

### Scripting Plugin Examples Overview

Source: https://docs.jitterbit.com/index

An overview of scripting examples available for the Vinyl.Sdk plugins, demonstrating various functionalities.

```documentation
app-builder/documentation/plugins/scripting/examples/
```

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

### Get Instagram Post Album Insights

Source: https://docs.jitterbit.com/pt/integration-studio/design/connectors/instagram/connection-details

Retrieve insights for carousel album posts on Instagram. Requires instagram_basic and instagram_manage_insights scopes. Supports filtering by MediaId server-side.

```SQL
SELECT * FROM MediaInsightsPostAlbum WHERE MediaId = 17945732813652602
```

```SQL
SELECT TotalInteractions FROM MediaInsightsPostAlbum WHERE MediaId = 17945732813652602
```

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

### InstagramPages - Get Business Account ID

Source: https://docs.jitterbit.com/pt/integration-studio/design/connectors/instagram/connection-details

Queries the Pages table to retrieve the Name and InstagramBusinessAccountId for connected Instagram pages. This is useful for obtaining the BusinessAccountId connection property.

```SQL
SELECT Name, InstagramBusinessAccountId FROM Pages
```

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

### Scripting Plugin Examples Overview

Source: https://docs.jitterbit.com/es

An overview of scripting examples available for the Vinyl.Sdk plugins, demonstrating various functionalities.

```documentation
app-builder/documentation/plugins/scripting/examples/
```

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

### Query sys_tablecolumns for Table Columns

Source: https://docs.jitterbit.com/integration-studio/design/connectors/bullhorn-crm/connection-details

Retrieves column names and data types for a specific table from the sys_tablecolumns system view. This example shows how to get details for the 'Candidate' table.

```sql
SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Candidate'
```

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

### Scripting Plugin Examples Overview

Source: https://docs.jitterbit.com/pt

An overview of scripting examples available for the Vinyl.Sdk plugins, demonstrating various functionalities.

```documentation
app-builder/documentation/plugins/scripting/examples/
```

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

### Jitterbit sys_keycolumns Table Schema

Source: https://docs.jitterbit.com/pt/integration-studio/design/connectors/instagram/connection-details

Details the columns of the sys_keycolumns table, which describes primary and foreign keys. An example query is provided to retrieve the primary key information for a specific table.

```APIDOC
sys_keycolumns:
  Description: Describes the primary and foreign keys.
  Columns:
    CatalogName (String): The name of the database containing the table or view.
    SchemaName (String): The schema containing the table or view.
    TableName (String): The name of the table or view containing the column.
    ColumnName (String): The column name.
    IsKey (String): Indicates whether a field returned from sys_tablecolumns is the primary key of the table ('True' or 'False').
```

```SQL
SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Users'
```

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

### Quickbase API Reference

Source: https://docs.jitterbit.com/integration-studio/design/connectors/quickbase/execute-activity

Provides information on accessing and interacting with the Quickbase platform via its RESTful API. This includes details on schemas, objects, and data operations.

```APIDOC
Quickbase JSON RESTful API:
  - Reference for interacting with Quickbase.
  - Provides information on schema nodes and fields.
  - Link: https://developer.quickbase.com

Quickbase API Guide:
  - Comprehensive guide for Quickbase API usage.
  - Link: https://helpv2.quickbase.com/hc/en-us/articles/4418310927892-Welcome-to-the-Quickbase-API-Guide
```

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

### Get Instagram Post Insights

Source: https://docs.jitterbit.com/pt/integration-studio/design/connectors/instagram/connection-details

Retrieve insights for individual image and video posts on Instagram. Requires instagram_basic and instagram_manage_insights scopes. Supports filtering by MediaId server-side and other metrics client-side.

```SQL
SELECT * FROM MediaInsightsPost WHERE MediaId = 17945732813652602
```

```SQL
SELECT Comments, Follows, Likes, ProfileActivity, ProfileVisits, Shares, TotalInteractions FROM MediaInsightsPost WHERE MediaId = 17945732813652602
```

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

### Configurar Token de Usuário Quickbase

Source: https://docs.jitterbit.com/pt/app-builder/documentation/quickbase-connection-guide

Instruções para gerar um token de usuário no Quickbase, necessário para autenticar a conexão com o Jitterbit App Builder. O token concede acesso a aplicativos específicos.

```APIDOC
Quickbase User Token Configuration:

1. Navigate to Quickbase Console (e.g., `https://example.quickbase.com`).
2. Click the user dropdown in the Global bar and select 'My Preferences'.
3. Under 'My User Information', select the 'Manage User tokens' link.
4. Click the '+ New User token' button.
5. Assign a 'Name' for the token.
6. Under 'Assign token to applications', select the application(s) to grant access.
   - Note: It is recommended to create one token per application if you have multiple.
7. Click the 'Save' button.
8. Copy the generated 'Token' from Quickbase.

Parameters:
- User Token Name: A descriptive name for the token.
- Application Access: Selection of specific Quickbase applications the token will access.

Output:
A generated API token string.
```

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

### Query sys_information for System Details

Source: https://docs.jitterbit.com/pt/integration-studio/design/connectors/instagram/connection-details

Retrieves comprehensive details about the product, its version, datasource, installation node, help URL, license, location, and environment. This query targets the sys_information system table.

```SQL
SELECT * FROM sys_information
```

```APIDOC
Table: sys_information

Columns:
  - Product (String): The name of the product.
  - Version (String): The version number of the product.
  - Datasource (String): The name of the datasource the product connects to.
  - NodeId (String): The unique identifier of the machine where the product is installed.
  - HelpURL (String): The URL to the product's help documentation.
  - License (String): The license information for the product. (May be left blank or marked as 'N/A'.)
  - Location (String): The file path location where the product's library is stored.
  - Environment (String): The version of the environment or runtime the product is currently running under.
  - DataSyncVersion (String): The tier of Sync required to use this connector.
  - DataSyncCategory (String): The category of Sync functionality (e.g., Source, Destination).

Description: Describes the available system information, providing metadata about the product's deployment and configuration.
```

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

### Install SAP Components on Windows

Source: https://docs.jitterbit.com/design-studio/design-studio-reference/connectors/sap-connector/sap-event-listener/sap-event-listener-installation

Steps to set up the necessary directories and copy the SAP Java IDoc Library components (DLL and JAR files) for the Jitterbit SAP Event Listener on a Windows machine.

```windows-command
C:\Program Files\Jitterbit SAP Event Listener
```

```windows-command
C:\Program Files\Jitterbit SAP Event Listener\bin
```

```windows-command
C:\Program Files\Jitterbit SAP Event Listener\ui
```

```windows-command
C:\Program Files\Jitterbit SAP Event Listener\bin\sapjco3.dll
```

```windows-command
C:\Program Files\Jitterbit SAP Event Listener\ui\sapidoc3.jar
```

```windows-command
C:\Program Files\Jitterbit SAP Event Listener\ui\sapjco3.jar
```

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

### Adicionar Servidor Quickbase ao App Builder

Source: https://docs.jitterbit.com/pt/app-builder/documentation/quickbase-connection-guide

Procedimento para adicionar uma nova fonte de dados Quickbase no Jitterbit App Builder. Configura os detalhes de conexão, incluindo nome do servidor, chave API (token) e domínio.

```APIDOC
Add Quickbase Server Connection:

1. Navigate to the App Workbench for your App Builder application.
2. Select the 'Data Sources' tab.
3. Click the '+ Source' button.
4. Select 'New Connection' to add a source to your application.
5. Click 'Next'.
6. Search for 'Quickbase' in the 'Cloud' category.
7. Select the radio button for 'Quickbase'.
8. Click 'Next'.
9. In Server Settings, assign a 'Name' for the Server Name.
10. In Security Settings, assign the 'API Key' by pasting the Quickbase User Token.
11. In Security Settings, assign the 'Domain Name' with the Quickbase URL (e.g., `https://example.quickbase.com`).
12. Click 'Next'.
13. Click 'Done'.
14. Confirm the new Quickbase source is created in Data Sources.

Parameters:
- Server Name: A user-defined name for the Quickbase connection.
- API Key: The Quickbase User Token generated previously.
- Domain Name: The base URL of the Quickbase instance (e.g., `https://yourdomain.quickbase.com`).
```

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

### Jitterbit sys_procedureparameters Table Schema

Source: https://docs.jitterbit.com/pt/integration-studio/design/connectors/instagram/connection-details

Describes the columns of the sys_procedureparameters table, which provides information about stored procedure parameters. An example query is included to fetch input and input/output parameters for a specific procedure.

```APIDOC
sys_procedureparameters:
  Description: Describes stored procedure parameters.
  Columns:
    CatalogName (String): The name of the database containing the stored procedure.
    SchemaName (String): The name of the schema containing the stored procedure.
    ProcedureName (String): The name of the stored procedure containing the parameter.
    ColumnName (String): The name of the stored procedure parameter.
    Direction (Int32): An integer corresponding to the type of the parameter: input (1), input/output (2), or output(4).
    DataTypeName (String): The name of the data type.
    DataType (Int32): An integer indicating the data type, determined at run time.
    Length (Int32): The number of characters or digits allowed for the data.
    NumericPrecision (Int32): The maximum precision for numeric data or length for character/date-time data.
    NumericScale (Int32): The number of digits to the right of the decimal point for numeric data.
    IsNullable (Boolean): Whether the parameter can contain null.
    IsRequired (Boolean): Whether the parameter is required for execution.
    IsArray (Boolean): Whether the parameter is an array.
    Description (String): The description of the parameter.
    Ordinal (Int32): The index of the parameter.
```

```SQL
SELECT * FROM sys_procedureparameters WHERE ProcedureName='Merge' AND Direction=1 OR Direction=2
```

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

### Jitterbit sys_procedures Table Schema

Source: https://docs.jitterbit.com/pt/integration-studio/design/connectors/instagram/connection-details

Details the columns available in the sys_procedures table, which lists all stored procedures within the Jitterbit environment. Includes an example SQL query to retrieve all available procedures.

```APIDOC
sys_procedures:
  Description: Lists the available stored procedures.
  Columns:
    CatalogName (String): The database containing the stored procedure.
    SchemaName (String): The schema containing the stored procedure.
    ProcedureName (String): The name of the stored procedure.
    Description (String): A description of the stored procedure.
    ProcedureType (String): The type of the procedure, such as PROCEDURE or FUNCTION.
```

```SQL
SELECT * FROM sys_procedures
```

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

### Security Configuration Example

Source: https://docs.jitterbit.com/de/app-builder/documentation/installation-guide/configuration

Provides an example of the JSON structure for configuring security settings, including administrator passwords and authentication providers.

```JSON
{
  "Security": {
    "Administrator": {
      "Password": "s3cr3t",
      "ChangePasswordOnLogin": false
    },
    "LocalAuthentication": {
      "ShowOnLoginForm": false
    },
    "Provider": "Tm90aGluZyBjYW4gY29tZSBvZiBub3RoaW5nLCBzcGVhayBhZ2Fpbi4="
  }
}
```

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

### Get Instagram Story Insights

Source: https://docs.jitterbit.com/pt/integration-studio/design/connectors/instagram/connection-details

Retrieve insights for Instagram Stories. Requires instagram_basic and instagram_manage_insights scopes. Insights expire after 24 hours. Supports filtering by MediaId server-side and other metrics client-side.

```SQL
SELECT * FROM MediaInsightsStory WHERE MediaId = 17945732813652602
```

```SQL
SELECT Comments, Follows, Likes, ProfileActivity, ProfileVisits, Shares, TotalInteractions FROM MediaInsightsStory WHERE MediaId = 17945732813652602
```

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

### Redis Sample Data Setup

Source: https://docs.jitterbit.com/pt/integration-studio/design/connectors/redis/connection-details

Demonstrates how to populate Redis with sample hash data using redis-cli commands for users and customers. This data is used to illustrate table modeling.

```redis-cli
> hmset user:1000 name "John Smith" email "john.smith@example.com" password "s3cret"
OK
> hmset user:1001 name "Mary Jones" email "mjones@example.com" password "hidden"
OK
> hmset user:1002 name "Sally Brown" email "sally.b@example.com" password "p4ssw0rd"
OK
> hmset customer:200 name "John Smith" account "123456" balance "543.21"
OK
> hmset customer:201 name "Mary Jones" account "123457" balance "654.32"
OK
> hmset customer:202 name "Sally Brown" account "123458" balance "765.43"
OK
```

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

### Konfigurationsmethoden Vergleich

Source: https://docs.jitterbit.com/de/app-builder/documentation/installation-guide/configuration

Veranschaulicht die äquivalenten Konfigurationswerte für ConnectionInfo über Umgebungsvariablen, appsettings.json und connection.xml, um die Flexibilität bei der Einrichtung zu zeigen.

```env
ConnectionInfo__DatabaseType=SQLServer
ConnectionInfo__HostName=localhost
ConnectionInfo__DatabaseName=App Builder
ConnectionInfo__UserName=vinyl
ConnectionInfo__Password=P@5$w0rD
```

```json
{
  "ConnectionInfo": {
    "DatabaseType": "SQLServer",
    "HostName": "localhost",
    "DatabaseName": "App Builder",
    "UserName": "vinyl",
    "Password": "P@5$w0rD"
  }
}
```

```xml
<ConnectionInfo DatabaseType="MySQL" HostName="localhost" DatabaseName="App Builder" UserName="vinyl" Password="P@5$w0rD"/>
```

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

### Jira GET Issue Response Example

Source: https://docs.jitterbit.com/pt/design-studio/design-studio-reference/sources-and-targets/http/rest-api-tutorial/validate-a-rest-api

An example of the JSON response structure received when performing a GET request to retrieve a Jira issue.

```JSON
{
    "expand": "renderedFields,names,schema,operations,editmeta,changelog,versionedRepresentations",
    "id": "10572",
    "self": "https://my-domain.atlassian.net/rest/api/2/issue/10572",
    "key": "TEST-10",
    "fields": {
        "issuetype": {
            "self": "https://my-domain.atlassian.net/rest/api/2/issuetype/10003",
            "id": "10003",
            "description": "A task that needs to be done.",
            "name": "Task",
            "subtask": false
        },
        "project": {
            "id": "10200",
            "key": "TEST"
        },
        "priority": {
            "self": "https://my-domain.atlassian.net/rest/api/2/priority/3",
            "iconUrl": "https://my-domain.atlassian.net/images/icons/priorities/medium.svg",
            "name": "Medium",
            "id": "3"
        },
        "labels": [],
        "versions": [],
        "status": {
            "name": "To Do"
        },
        "description": "This task is for manually updating JIRA because there is no integration in place.",
        "security": null,
        "summary": "Manual Updates",
        "comment": {
            "comments": [],
            "maxResults": 0,
            "total": 0,
            "startAt": 0
        }
    }
}
```

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

### Site Configuration API

Source: https://docs.jitterbit.com/de/app-builder/documentation/installation-guide/configuration

API documentation for the Site section, configuring the canonical website URL, aliases, and redirection behavior.

```APIDOC
Site:
  Url: string
    - The canonical website URL.
  Default: boolean
    - Treat this as the default website.
  Redirect: boolean
    - Redirect clients to the Site URL.
  RedirectIfHeaderExists: string
    - An HTTP header that, if present, triggers a redirect to the Site URL.
  AllowCrossOrigin: boolean
    - Allow Cross-Origin requests.
  Aliases: array of objects
    - An array of site aliases.
    - Each alias object should contain a 'Url' property (string).
```

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

### Initiating Four51 Update Wizard in Jitterbit

Source: https://docs.jitterbit.com/design-studio/design-studio-reference/connectors/four51-connector/four51-connector-update

Provides multiple methods to start the Four51 Update Wizard in Jitterbit Studio. These methods guide the user through the initial setup for creating or replacing data in Four51.

```Jitterbit
Method 1: Go to File > New > Connectors > New Four51 Update.
Method 2: In the tree on the left under Connectors, right-click on the Four51 category, then select New Four51 Update.
Method 3: In the tree on the left under Connectors, double-click on the Four51 category, then right-click on Four51 Update Activities and select New Four51 Update.
Method 4: Click the connector icon (orange jigsaw piece) in the top toolbar, select Four51, then select Four51 Update.
```

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

### Enable Jitterbit Systemd User Service

Source: https://docs.jitterbit.com/es/agent/linux

Reloads the systemd daemon for user services, enables the Jitterbit service to start on login, and allows user services to run even when the user is not logged in. Performed by the 'jitterbit' user.

```sh
systemctl --user daemon-reload
systemctl --user enable jitterbit.service
loginctl enable-linger
```

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

### TLS Configuration Example

Source: https://docs.jitterbit.com/de/app-builder/documentation/installation-guide/configuration

Shows an example JSON configuration for TLS settings, specifying supported security protocols.

```JSON
{
  "Tls": {
    "SecurityProtocol": "Tls,Tls11,Tls12"
  }
}
```

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

### Add DocuSign GET Document Status API Endpoint

Source: https://docs.jitterbit.com/app-builder/documentation/docusign-connection

Details how to add an API endpoint in App Builder to retrieve the status of a DocuSign envelope. This requires specifying the endpoint path, HTTP method, and necessary parameters.

```APIDOC
Add DocuSign GET Document Status API Endpoint:

1. From the Endpoints panel, click 'Create'.
2. Configure Endpoint Details:
   - Name: [Name your endpoint]
   - Endpoint: /v2/accounts/<AccountID>/envelopes/<EnvelopeID>
   - Method: GET
3. Add Endpoint Parameters:
   - Parameter 1:
     + Name: AccountID
     + Data Type: String
     + Test Value: API Account ID from DocuSign Sandbox
     + Type: Query
     + Direction: Input
   - Parameter 2:
     + Name: Authorization
     + Data Type: String
     + Test Value: Bearer <Returned Access Token from the Token API>
     + Type: Header
     + Direction: Input
   - Parameter 3:
     + Name: EnvelopeID
     + Data Type: String
     + Test Value: Envelope ID returned from the previous endpoint
     + Type: Query
     + Direction: Input
4. Click 'Test Connection' to verify parameters.
```

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

### Jitterbit Agent Synchronization Completion Log Message

Source: https://docs.jitterbit.com/agent/windows

Example log message indicating successful agent synchronization with the environment and agent group. This message is used to confirm readiness before restarting an agent in a rolling upgrade scenario.

```Log
Agent synchronization for environment <123456> and agent group ID <987654> completed at ...
```

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

### ReverseProxy Configuration Examples

Source: https://docs.jitterbit.com/app-builder/documentation/installation-guide/configuration

Illustrates JSON configurations for the ReverseProxy section, specifying headers used to forward client IP, scheme, host, and port information.

```json
{
  "ReverseProxy": {
    "ForwardedClientIpHeader": "X-Forwarded-For",
    "ForwardedSchemeHeader": "X-Forwarded-Proto",
    "ForwardedHostHeader": "X-Forwarded-Host"
  }
}
```

```json
{
  "ReverseProxy": {
    "ForwardedClientIpHeader": "X-Forwarded-For",
    "ForwardedSchemeHeader": "X-Forwarded-Proto",
    "ForwardedPortHeader": "X-Forwarded-Port"
  }
}
```

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

### Retrieve Specific File Columns by Name Pattern

Source: https://docs.jitterbit.com/integration-studio/design/connectors/microsoft-office-365/connection-details

Retrieves specific columns (Name, LastModifiedDateTime) for files whose names match a given pattern. This example uses the LIKE operator to filter by names starting with 'test'.

```SQL
SELECT Name, LastModifiedDateTime FROM Files WHERE Name LIKE 'test%'
```

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

### Shared State Configuration Example

Source: https://docs.jitterbit.com/de/app-builder/documentation/installation-guide/configuration

Demonstrates the JSON configuration for the Shared State service, specifying the provider (e.g., Redis) and connection details.

```JSON
{
  "SharedState": {
    "Provider": "Redis",
    "RedisConnectionString": "localhost:6379"
  }
}
```

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

### AiServices OpenAI Konfiguration

Source: https://docs.jitterbit.com/de/app-builder/documentation/installation-guide/configuration

Definiert die Konfigurationseinstellungen für die OpenAI-Integration im App Builder, einschließlich API-Schlüssel und HTTP-Timeout.

```json
{
  "AiServices": {
    "OpenAi": {
      "ApiKey": "[OpenAiKey]",
      "Timeout": 300
    }
  }
}
```

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

### Jitterbit Installer Mode Configuration

Source: https://docs.jitterbit.com/agent/windows

Configuration setting for the Jitterbit installer to define the installation mode. This parameter, `KO_INSTALL_MODE`, determines whether a PostgreSQL database server is installed alongside the agent.

```APIDOC
Installer Mode Configuration (`silent_install64.ps1`):

Parameter:
  $JitterbitArgList

Setting:
  KO_INSTALL_MODE="1": Install a private agent and a PostgreSQL database server.
  KO_INSTALL_MODE="2": (Default) Install a private agent only. Requires an existing PostgreSQL database server.
```

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

### Install SAP Components on Linux

Source: https://docs.jitterbit.com/design-studio/design-studio-reference/connectors/sap-connector/sap-event-listener/sap-event-listener-installation

Steps to create directories and copy the SAP Java IDoc Library components (SO and JAR files) for the Jitterbit SAP Event Listener on a Linux machine.

```shell
# mkdir /opt/jitterbitsap
```

```shell
# mkdir /opt/jitterbitsap/bin
```

```shell
# mkdir /opt/jitterbitsap/ui
```

```shell
# cp /home/<USERNAME>/Downloads/libsapjco3.so /opt/jitterbitsap/bin
```

```shell
# cp /home/<USERNAME>/Downloads/sapidoc3.jar /opt/jitterbitsap/ui/sapidoc3.jar
```

```shell
# cp /home/<USERNAME>/Downloads/sapjco3.jar /opt/jitterbitsap/ui/sapjco3.jar
```

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

### Jitterbit Agent Quiet Installer Configuration

Source: https://docs.jitterbit.com/agent/windows

Parameter for the Jitterbit agent's quiet installer script to specify the installation mode. Setting KO_INSTALL_MODE to 0 indicates a standard installation process.

```PowerShell
KO_INSTALL_MODE=0
```

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

### ServiceNow User Authentication and Permissions Setup

Source: https://docs.jitterbit.com/pt/integration-studio/design/connectors/servicenow/prerequisites

Guide for setting up an authentication user in ServiceNow, including elevating roles, creating custom roles, and assigning necessary permissions for connector activities.

```APIDOC
ServiceNow User Authentication and Permissions:

1. Elevate Role:
   - Click user icon (top right) > 'Elevate Role'.
   - Select 'security_admin' and click 'Update'.
   - Note: Elevated role is session-based.

2. Create Custom Role:
   - Navigate to: User Administration > Roles.
   - Click 'New'.
   - Fill form:
     - Name: Unique role name (e.g., 'jitterbit_harmony_agent'). Cannot be changed after creation.
     - Application: Defaults to 'Global'.
     - Requires subscription: Defaults to 'Unspecified'.
     - Elevated privilege: Defaults to unchecked.
     - Description: Appropriate description (e.g., 'Used by the authenticating user on behalf of the Harmony agent.').
   - Click 'Submit' to create the role.

3. Create Authenticating User:
   - Navigate to: User Administration > Users.
   - Click 'New'.
   - Fill user details (e.g., username, password, first name, last name).
   - Assign the custom role created in step 2.
   - Assign any other required system roles (e.g., 'itil', 'rest_api_explorer').
   - Click 'Submit'.

4. Create Access Control Lists (ACLs):
   - For each Jitterbit ServiceNow activity, create two separate ACL records.
   - Configure ACLs to grant necessary read/write permissions based on the custom role.

5. Assign Roles to Authenticating User (Final Step):
   - Reopen the created user record.
   - Ensure the custom role and any other required system roles are assigned.
```

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

### Verificar e Instalar Módulo de Inicialização de Aplicativos no IIS

Source: https://docs.jitterbit.com/pt/app-builder/documentation/installation-guide/auto-start-iis-75

Passos para verificar se o módulo de inicialização de aplicativos está instalado no IIS Manager e instruções para instalá-lo caso não esteja presente. Inclui links para download do pacote de instalação da Microsoft.

```APIDOC
1. Abra o IIS Manager.
2. Clique em Server.
3. No painel principal, clique em Configuration Editor.
4. Expanda o nó system.webServer.
5. Verifique a existência do elemento ApplicationInitialization.
6. Se não estiver instalado, baixe e execute o pacote de instalação da Microsoft:
   - Link de download direto: http://download.microsoft.com/download/0/A/6/0A6790C9-C209-40A9-B4AB-94693A3CD075/appwarmup_x64.msi
7. Após a instalação, reinicie o servidor para que as alterações tenham efeito.
```

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

### Scripting Configuration Example

Source: https://docs.jitterbit.com/de/app-builder/documentation/installation-guide/configuration

An example JSON configuration for enabling or disabling C# scripting within the App Builder.

```JSON
{
  "Scripting": {
    "Enabled": false
  }
}
```

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

### Check Node.js and npm Installation

Source: https://docs.jitterbit.com/design-studio/design-studio-reference/sources-and-targets/local-file/use-netsuite-tba-with-a-local-file-source

Verifies if Node.js and npm are installed on the Jitterbit private agent by checking their version numbers. If either is not installed, the subsequent installation commands should be used.

```shell
$ node -v
$ npm -v
```

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

### Run Jitterbit Installer Script

Source: https://docs.jitterbit.com/agent/linux

Executes the Jitterbit installation script located in the user's home directory to complete the agent setup.

```shell
$HOME/scripts/install.sh
```

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

### AiServices OpenAI Example

Source: https://docs.jitterbit.com/app-builder/documentation/installation-guide/configuration

Provides a JSON example for configuring OpenAI settings within AiServices.

```json
{
  "AiServices": {
    "OpenAi": {
      "ApiKey": "[OpenAiKey]",
      "Timeout": 300
    }
  }
}
```

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

### Jitterbit Quiet Installer Script Execution

Source: https://docs.jitterbit.com/agent/windows

Commands to execute the Jitterbit private agent quiet installer using PowerShell. This involves setting the execution policy and running the silent installation script.

```APIDOC
Running the Quiet Installer:

1. Allow PowerShell script execution:
   Set-ExecutionPolicy Unrestricted

2. Run the quiet installer script:
   silent_install64.ps1

   Note: Ensure `config64.ps1` is correctly configured before running the installer.
```

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

### Run Jitterbit API Gateway Configuration

Source: https://docs.jitterbit.com/es/api-gateways/private-api-gateway/install-a-private-gateway

Executes the Jitterbit API Gateway configuration utility. This command prompts you for necessary details like Harmony credentials, region, and proxy settings to set up the gateway. Use '--help' for detailed command options.

```shell
jitterbit-api-gateway-config
```

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

### Redis Hash Setup Example

Source: https://docs.jitterbit.com/es/integration-studio/design/connectors/redis/connection-details

Demonstrates setting up sample hash data in Redis using hmset commands, which can then be modeled as tables by the Jitterbit connector.

```redis-cli
> hmset user:1000 name "John Smith" email "john.smith@example.com" password "s3cret"
OK
> hmset user:1001 name "Mary Jones" email "mjones@example.com" password "hidden"
OK
> hmset user:1002 name "Sally Brown" email "sally.b@example.com" password "p4ssw0rd"
OK
> hmset customer:200 name "John Smith" account "123456" balance "543.21"
OK
> hmset customer:201 name "Mary Jones" account "123457" balance "654.32"
OK
> hmset customer:202 name "Sally Brown" account "123458" balance "765.43"
OK
```

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

### Configure Jitterbit Agent Installation Mode

Source: https://docs.jitterbit.com/es/agent/private-agents/private-agent-installation/windows-agent-installation/install-a-windows-quiet-agent

Sets the installation mode for the Jitterbit private agent. Choose between advanced mode (using an existing PostgreSQL) or quick mode (installing all components including PostgreSQL).

```PowerShell
KO_INSTALL_MODE="0" # Advanced: Use existing PostgreSQL
KO_INSTALL_MODE="1" # Quick: Install PostgreSQL and agent
```

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

### Kestrel Configuration Options

Source: https://docs.jitterbit.com/app-builder/documentation/installation-guide/configuration

Details configuration options for the Kestrel web server, referencing external documentation for a comprehensive list.

```APIDOC
Kestrel:
  Limits: MaxRequestBodySize
    See the [Kestrel documentation](https://learn.microsoft.com/en-us/aspnet/core/fundamentals/servers/kestrel/options) for a list of supported options.
```

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

### Install Jitterbit Agent on Debian

Source: https://docs.jitterbit.com/es/agent/linux

Installs the Jitterbit agent package on Debian-based Linux systems using apt-get. This command requires root privileges and the path to the .deb package.

```bash
apt-get install <PATH>/jitterbit-agent_<VERSION>_amd64.deb
update-alternatives --install /usr/bin/python python /usr/bin/python2 1
```

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

### Install Jitterbit Agent Silently

Source: https://docs.jitterbit.com/es/agent/private-agents/private-agent-installation/windows-agent-installation/install-a-windows-quiet-agent

Executes the silent installation script for the Jitterbit private agent. This script requires administrative privileges and should be run from the agent's directory.

```PowerShell
./silent_install64.ps1
```