NICE CXone Desktop Studio

https://help.nicecxone.com/pt-br/content/
Admin
Desktop Studio is a legacy scripting application for creating, managing, and testing customer...
Tokens:2,929,810
Snippets:55,172
Trust Score:6.2
Update:1 year ago
Show doc for...
Tokens:
Raw
### Example ScreenAgent Installation

Source: https://help.nicecxone.com/pt-br/content/recording/screenagent/screenagent

An example of a complete ScreenAgent installation command for a 64-bit MSI, specifying installation path, access keys, region, user login method, recording frame rate, resolution, certificate loading, statistics, and logging.

```cmd
msiexec /i ScreenAgent-64bit-3.0.37.msi INSTALL_PATH=d:\newdir ACCESS_KEY_ID=ABCDEF12345==== ACCESS_KEY_SECRET=12345ABCDEF REGION_TYPE=na1 RESOLVE_USER=oslogin FRAME_PER_SECOND=5 RESOLUTION_LEVEL=high  LOAD_CERTIFICATES=true STATISTICS=true /log install.log /quiet
```

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

### Install NiceXone MSI with Proxy (Example)

Source: https://help.nicecxone.com/pt-br/content/recording/screenagent/screenagent_tocpath=System+Management%7CAdmin%7CRecording%7C_____4

An example command for installing a NiceXone MSI package, specifying proxy parameters. This is useful for environments with web proxies.

```Batch
msiexec /i "<path_to_msi>" PROXY_HOST="<proxy_host>" PROXY_PORT="<proxy_port>"
```

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

### Android SDK Access and Examples

Source: https://help.nicecxone.com/pt-br/content/acd/digital/mobilesdk/cxonemobilesdk_tocpath=Digital+Experience%7CDigital+Experience+%7CDigital+Developer+Resources%7CMobile%C2%A0SDK%7C_____0

Access the Android SDK from its public GitHub repository. The repository includes a README for getting started and code examples within the /docs directory to inspire your chat application development. API references are also available online.

```text
https://github.com/nice-devone/nice-cxone-mobile-sdk-android
https://help.nice-incontact.com/mobilesdk/Android1.3/dist/index.html
https://github.com/nice-devone/nice-cxone-mobile-sample-android
```

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

### Execute SAP BI Setup with Response File (Windows Command)

Source: https://help.nicecxone.com/pt-br/content/integratedsolutions/engageqmintegrated/implementation/deploy_tocpath=Engage+QM%C2%A0Integrated+%7CEngage+QM%C2%A0Integrated%7CEngage+QM%C2%A0Integrated+Implementation+Process%7C_____2

This command executes the SAP Business Objects BI platform installer using the setup.exe. It specifies the path to a response.ini file for automated configuration and enables a silent installation mode by utilizing the -q flag for no user interface. The -r flag indicates the full path to the response file and generates a silent setup (ISS) file.

```windows-cmd
setup.exe -r "[caminho completo para response.ini]" -q
```

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

### Initialize Node.js Application using npm

Source: https://help.nicecxone.com/pt-br/content/aiassistantsandbots/customaiintegrations/vah/exampleintegration_tocpath=Advanced+Tools%7CVirtual+Agents%7CVirtual+Agent+Integrations%7CCustom+Virtual+Agent%C2%A0Integrations%7C_____2

This snippet outlines the steps to set up and run a Node.js application. It requires Node.js and npm to be installed. The process involves installing dependencies, starting the application using different commands for Linux and Windows, and noting the output port number.

```bash
cd ProxyTunnel/examples/Nodejs
npm install
```

```bash
export DEBUG='javascriptechoproxy:server'
npm run start
```

```bash
npm run devstart
```

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

### Start Node.js Application

Source: https://help.nicecxone.com/pt-br/content/aiassistantsandbots/customaiintegrations/vah/exampleintegration

These commands start a Node.js application. The first command sets a debug environment variable, and the second command initiates the application's start script as defined in the 'package.json' file. Variations exist for different operating systems.

```bash
export DEBUG='javascriptechoproxy:server'
npm run start
```

```powershell
npm run devstart
```

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

### Install Flask for Python

Source: https://help.nicecxone.com/pt-br/content/aiassistantsandbots/customaiintegrations/vah/exampleintegration

This command installs the Flask web framework for Python using pip, the Python package installer. Flask is required to run the Python echo proxy tunnel example. Ensure Python and pip are installed and configured correctly.

```bash
pip install flask
```

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

### Run PHP Development Server

Source: https://help.nicecxone.com/pt-br/content/aiassistantsandbots/customaiintegrations/vah/exampleintegration

This command starts a local PHP development server. It's used to run the PHP proxy tunnel example. The server will be accessible at `localhost` on the specified port (e.g., 8000). Ensure PHP is installed and accessible in your system's PATH.

```bash
php -S localhost:8000
```

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

### Initialize Node.js Application

Source: https://help.nicecxone.com/pt-br/content/aiassistantsandbots/customaiintegrations/vah/exampleintegration_tocpath=Advanced+Tools%7CAutomation+and+AI%7CVirtual+Agents%7CVirtual+Agent+Integrations%7CCustom+Virtual+Agent%C2%A0Integrations%7C_____2

This snippet details the steps to initialize a Node.js application. It requires Node.js and npm to be installed. The process involves installing dependencies and starting the application using different commands for Linux and Windows.

```bash
cd ProxyTunnel/examples/Nodejs
npm install
# For Linux:
export DEBUG='javascriptechoproxy:server'
npm run start
# For Windows using PowerShell:
npm run devstart
```

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

### Install Node.js Dependencies and Start Application

Source: https://help.nicecxone.com/pt-br/content/aiassistantsandbots/customaiintegrations/vah/exampleintegration_tocpath=Automation+and+AI%7CAutomation+and+AI%7CVirtual+Agents%7CVirtual+Agent+Integrations%7CCustom+Virtual+Agent%C2%A0Integrations%7C_____2

This snippet details the process of installing Node.js dependencies using npm and starting the application. It assumes Node.js and npm are installed. The commands vary slightly for Linux and Windows.

```bash
cd ProxyTunnel/examples/Nodejs
npm install
```

```bash
# Linux:
export DEBUG='javascriptechoproxy:server'
npm run start

# Windows using powershell:
npm run devstart
```

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

### Download RUNSUB Script Example

Source: https://help.nicecxone.com/pt-br/content/studio/actionscx/runsub/runsub_tocpath=Studio%7CStudio%7CActions+%28Studio%29%7C_____192

Provides a direct link to download an example script for the RUNSUB action. This script can be used as a template or for testing purposes. No specific dependencies or inputs are mentioned for the download itself.

```html
<p>Quer <a href="../../actions/runsub/runsubphonesubscriptexample.zip">baixar este script</a>?</p>
```

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

### Silent Installation Command for Report Viewer

Source: https://help.nicecxone.com/pt-br/content/integratedsolutions/engageqmintegrated/implementation/deploy

This example command shows how to silently install the Report Viewer software. Similar to other MSI installations, it uses the /qn flag for a quiet, unattended setup.

```batch
msiexec /i "ReportViewerSetup_[version].msi" /qn
```

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

### Exemplo de Script com Ramais

Source: https://help.nicecxone.com/pt-br/content/studio/gettingstarted/startusingstudio_tocpath=Studio%7CStudio%7CIniciar+usando+Desktop%C2%A0Studio%7C_____0

Demonstra a utilização de ramais para criar múltiplos caminhos em um script. Ramais são usados quando uma ação possui dois ou mais resultados possíveis, dividindo o script para seguir caminhos distintos. Este exemplo visualiza um script dividido em três ramais.

```N/A
<p>Os ramais são usados quando uma ação tem dois ou mais resultados possíveis. Eles dividem o script nos caminhos que o contato pode seguir e ajudam você a criar o fluxo de trabalho que sua organização exige.</p>
                                                        <div class="MCDropDown MCDropDown_Closed dropDown"><span class="MCDropDownHead dropDownHead"><a href="#" class="MCDropDownHotSpot dropDownHotspot MCDropDownHotSpot_ MCHotSpotImage" aria-expanded="false"><img class="MCDropDown_Image_Icon" src="../../../Skins/Default/Stylesheets/Images/transparent.gif" height="11" width="16" alt="Closed" data-mc-alt2="Open" />Ver a imagem de um script dividido em três ramais</a></span>
                                                            <div class="MCDropDownBody dropDownBody">
                                                                <img src="images/examplebranch.png" alt="Exemplo de imagem de conectores e ramais." />
                                                            </div>
                                                        </div>
```

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

### Initialize and Listen to Guide Events in JavaScript

Source: https://help.nicecxone.com/pt-br/content/acd/digital/guide/eventbroadcasting_tocpath=System+Management%7CDigital+Experience+%7CDigital+Developer+Resources%7C_____7

An example of initializing the NiceCXone Guide and setting up event listeners for various guide-related events. This snippet shows the full setup, including loader initialization and event handling for 'templateDisplayed'. It assumes you have a loader ID and tenant ID to substitute.

```javascript
<script>
(function(n,u){ &#160;&#160; 
&#160;window.CXoneDfo=n,&#160;&#160;&#160; 
&#160;window[n]=window[n]||function(){(window[n].q=window[n].q||[]).push(arguments)},window[n].u=u, e=document.createElement("script"),e.type="module",e.src=u+"?"+Math.round(Date.now()/1e3/3600), document.head.appendChild(e) 
})('cxone','<LOADER-ID>');

cxone('init', '<TENANT-ID>');
cxone('guide', 'init');

const guideEvents = ['templateDisplayed'
];
      
function handleEvent(event) {&#160;&#160; 
&#160;&#160;console.log('Entire event:', event); 
&#160;&#160;console.log('Event Detail property:', event.detail);
}
guideEvents.forEach(eventType => {
&#160;&#160;window.addEventListener(eventType, handleEvent);
});      
</script>
```

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

### Install ScreenAgent MSI with Basic Parameters

Source: https://help.nicecxone.com/pt-br/content/recording/screenagent/screenagent_tocpath=Admin%7CAdmin%7CRecording%7C_____4

This command installs the ScreenAgent MSI package. It allows specifying the installation path, access key credentials, region type, user resolution method, frame rate, resolution, certificate loading, and statistics logging. The installation is performed quietly with logging to 'install.log'.

```batch
msiexec /i ScreenAgent-<32|64>bit-<MSI version>.msi INSTALL_PATH=<opcional: caminho de instalação> ACCESS_KEY_ID=<access key ID> ACCESS_KEY_SECRET=<secret access key> REGION_TYPE=<subdomínio (primeiros 3 caracteres) do CXone Mpower URL> RESOLVE_USER=<opcional: auto|oslogin> FRAME_PER_SECOND=<opcional: 1, 2, 3, 4 ou 5> RESOLUTION_LEVEL=<opcional: null, low, medium ou high> LOAD_CERTIFICATES=<opcional: true|false> STATISTICS=<opcional: true|false> /log install.log /quiet
```

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

### Conectores em Scripts Studio

Source: https://help.nicecxone.com/pt-br/content/studio/gettingstarted/startusingstudio_tocpath=Studio%7CStudio%7CIniciar+usando+Desktop%C2%A0Studio%7C_____0

Explica o uso de conectores para vincular ações e definir o fluxo de um script na interface do Studio. Conectores são representados como linhas com setas e podem ser dobrados ou curvados para organizar o layout visual do script.

```N/A
<h3>Conectores</h3>
                                                        <p>Conectores são como você vincula ações e cria o fluxo de seu <a href="../fundamentals/fundamentals.htm" target="_blank">script</a>. Na tela, os conectores aparecem como linhas finas com setas que conectam duas ações. Você pode dobrar e curvar conectores para movê-los por outras ações na tela.</p>
                                                        <div class="MCDropDown MCDropDown_Closed dropDown"><span class="MCDropDownHead dropDownHead"><a href="#" class="MCDropDownHotSpot dropDownHotspot MCDropDownHotSpot_ MCHotSpotImage" aria-expanded="false"><img class="MCDropDown_Image_Icon" src="../../../Skins/Default/Stylesheets/Images/transparent.gif" height="11" width="16" alt="Closed" data-mc-alt2="Open" />Veja a imagem dos conectores no <span class="mc-variable DoNotTranslateProductNames.Studio variable">Studio</span></a></span>
                                                            <div class="MCDropDownBody dropDownBody">
                                                                <div>
                                                                    <img src="../images/studioui/s-connectorselectarrow.png" alt="Imagem mostrando o conector destacado em azul." />
                                                                    <img src="../images/studioui/s-connectorbendconnector.png" alt="Imagem mostrando um ponto de articulação e um conector dobrado." />
                                                                    <img src="../images/studioui/s-connectormultiplebendpoints.png" alt="Imagem mostrando dois pontos de articulação em um conector dobrado." />
                                                                </div>
                                                            </div>
                                                        </div>
```

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

### Exemplo de Ramificação de Script em NiceCXone Studio

Source: https://help.nicecxone.com/pt-br/content/studio/gettingstarted/startusingstudio_tocpath=Advanced+Tools%7CStudio%7CStart+Using++%28Desktop%C2%A0Studio%29%7C_____0

Representa um script dividido em três caminhos possíveis, permitindo diferentes fluxos de interação com o contato com base em ações predefinidas.

```N/A
Representação visual de um script com múltiplos ramais.
```

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

### Install ScreenAgent via Command Line

Source: https://help.nicecxone.com/pt-br/content/recording/screenagent/screenagent_tocpath=Admin%7CAdmin%7CRecording%7C_____4

This snippet demonstrates how to install the ScreenAgent using a command-line interface, requiring administrative privileges. It shows a basic installation command and highlights the need to navigate to the downloaded MSI file location. Dependencies include having the MSI installer downloaded and an active command prompt with administrator rights.

```bash
msiexec /i "ScreenAgent_Installer.msi" /qn INSTALLDIR="C:\\Program Files\\CustomPath\\ScreenAgent"
```

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

### Configurar Ação 'Play' para Mensagem de Agentes Indisponíveis

Source: https://help.nicecxone.com/pt-br/content/studio/gettingstarted/developbasicscriptcx_tocpath=Studio%7CStudio%7CStart+Using+Studio%7C_____1

Configura a ação 'Play' para reproduzir uma mensagem automatizada quando nenhum agente estiver disponível. Isso envolve a adição de uma legenda, a abertura do editor de sequência, a configuração de texto para fala e a inserção da mensagem de áudio desejada. Dependências: Sistema de texto para fala, editor de sequência. Entradas: Texto da legenda, mensagem de áudio. Saídas: Reprodução de mensagem de áudio para o chamador.

```N/A
Configure Play para reproduzir uma mensagem automatizada quando não houver agentes disponíveis:
1. Clique em Play para ver suas propriedades no lado direito da página.
2. Clique no campo da propriedade Add caption e insira Quando não houver agentes disponíveis. Isso altera o rótulo que aparece na tela do script.
3. Clique em Abrir editor nas propriedades da ação.
4. Clique em Texto a fala.
5. Na Sequência de ordem de reprodução, selecione o segmento texto a fala e clique em Editar.
6. No campo segmento, substitua o texto padrão, A pequena raposa marrom, pela mensagem que você deseja que os chamadores escutem quando nenhum agente estiver disponível. Por exemplo, você poderia usar esta mensagem: Estamos passando por dificuldades técnicas. Por favor, ligue mais tarde.
7. Copie a mensagem do campo de segmento e cole-a no campo Frase.
```

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

### GET SOURCES Action Script Example - Studio

Source: https://help.nicecxone.com/pt-br/content/studio/actionscx/getsources/getsources

This example demonstrates how to use the 'GET SOURCES' action within a NiceCxone Studio script. It's a partial example and may require additional scripting for a complete solution. The action retrieves business unit lists and is intended for Proactive XS.

```Studio Script
# GET SOURCES
# Retrieves a dynamic data object containing all lists for the business unit.
# Dependencies: Proactive XS only.
# Supported Script Types: Phone
# Output Properties: Sources
# Result Branch Conditions: Default
```

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

### SAP Business Objects BI Installer Command Syntax

Source: https://help.nicecxone.com/pt-br/content/integratedsolutions/engageqmintegrated/implementation/deploy_tocpath=Integrated+Solutions%7CEngage+QM%C2%A0Integrated%7CEngage+QM%C2%A0Integrated+Implementation+Process%7C_____2

Illustrates the basic command-line syntax for running the SAP Business Objects BI Platform installer. This command can be customized with various parameters to control the installation process, such as enabling silent installations or specifying response files.

```command-line
setup.exe -r "[caminho completo para response.ini]"
```

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

### Incorporar Guide em Site com JavaScript

Source: https://help.nicecxone.com/pt-br/content/acd/digital/guide/guideusecases_tocpath=Digital+Experience%7CDigital+Experience+%7CGuide%7C_____10

Incorpore o Guide em seu site copiando o código JavaScript fornecido e colando-o no cabeçalho da página de finalização de compra. Verifique se a oferta proativa aparece corretamente e se os botões de ação funcionam como esperado.

```javascript
// Exemplo de código JavaScript para incorporar o Guide
// Substitua com o código real fornecido pela plataforma Guide
console.log('Iniciando a incorporação do Guide...');
// Adicionar script de tag do Guide aqui
// Exemplo:
// var script = document.createElement('script');
// script.src = 'URL_DO_SEU_SCRIPT_GUIDE';
// document.head.appendChild(script);
console.log('Guide incorporado.');
```

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

### Exemplo de Script de Saída RTIG Studio

Source: https://help.nicecxone.com/pt-br/content/aiassistantsandbots/agentassisthub/rtig/setuprtig_tocpath=Automation+and+AI%7CAutomation+and+AI%7CAgent+Assist+Applications%7CAgent+Assist+Application%C2%A0Integrations%7CReal-Time+Interaction+Guidance%7C_____1

Descreve a configuração de um script de saída básico no Studio para acionar o Real-Time Interaction Guidance (RTIG). Explica que a ação 'Begin' se conecta à ação 'Agent Assist' para iniciar o RTIG quando um agente faz uma chamada de saída.

```text
Ação Begin conecta-se à ação Agent Assist.
```

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

### Run Python Echo Proxy Tunnel

Source: https://help.nicecxone.com/pt-br/content/aiassistantsandbots/customaiintegrations/vah/exampleintegration

This command executes the Python script for the echo proxy tunnel. It requires Flask to be installed. The script will start, and the output will indicate the port number it is running on, typically displayed in the terminal.

```bash
python echo-proxy-tunnel.py
```

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

### Instalar ScreenAgent com MSI

Source: https://help.nicecxone.com/pt-br/content/recording/screenagent/screenagent_tocpath=System+Management%7CAdmin%7CRecording%7C_____4

Comandos para instalar o ScreenAgent usando o pacote MSI, especificando a arquitetura do sistema (32 ou 64 bits) e a versão do arquivo MSI. É necessário ter o arquivo MSI baixado da página de Suporte e Downloads.

```Command Line
msiexec /i ScreenAgent-64bit-3.0.22.msi
```

```Command Line
msiexec /i ScreenAgent-32bit-3.0.22.msi
```

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

### Ações Readfile e Writefile no Studio

Source: https://help.nicecxone.com/pt-br/content/studio/gettingstarted/startusingstudio_tocpath=Advanced+Tools%7CStudio%7CStart+Using++%28Desktop%C2%A0Studio%29%7C_____0

As ações Readfile e Writefile no Studio permitem a leitura e escrita de dados em arquivos localizados no armazenamento de arquivos do CXone Mpower. É necessário ter as permissões adequadas para acessar e modificar esses arquivos.

```studioAction
Readfile
```

```studioAction
Writefile
```

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

### Get Source Map Action Example (Studio)

Source: https://help.nicecxone.com/pt-br/content/studio/actionscx/getsourcemap/getsourcemap

This snippet demonstrates how to use the 'Get Source Map' action within a Studio script. It retrieves an existing source map, which can then be modified or used to append new data definitions. This example is part of a larger script and may require additional scripting for a complete solution.

```Text
"Make Changes HERE GET SOURCE (Text View)"
```

```Text
"Make Changes HERE CREATE SOURCE (Text View | Copy Text)"
```

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

### Install PHP with Chocolatey

Source: https://help.nicecxone.com/pt-br/content/aiassistantsandbots/customaiintegrations/vah/exampleintegration

This command uses Chocolatey, a package manager for Windows, to install PHP. This is the recommended method for installing PHP on Windows. Ensure Chocolatey is installed and PowerShell is run as an administrator.

```powershell
choco install php
```

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

### Retrieve Custom Data Definitions (Script Example)

Source: https://help.nicecxone.com/pt-br/content/studio/actionscx/getuserfields/getuserfields

This script example demonstrates how to retrieve custom data definitions for your tenant using the 'GET USER FIELDS' action. It is intended as a foundational snippet, and additional scripting may be necessary for a complete solution.

```script
# GET USER FIELDS
# This script retrieves custom data definitions for your tenant.
# Additional scripting may be required for a complete solution.

# Example usage:
# Call the Get User Fields action to retrieve the fields.
# Handle the 'Fields' output property to process the data.
# Use 'Default' and 'Error' branches for outcome handling.
```

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

### Conectores e Pontos de Articulação em NiceCXone Studio

Source: https://help.nicecxone.com/pt-br/content/studio/gettingstarted/startusingstudio_tocpath=Advanced+Tools%7CStudio%7CStart+Using++%28Desktop%C2%A0Studio%29%7C_____0

Ilustra o uso de conectores para vincular ações em um script e a manipulação de conectores através de pontos de articulação para organizar o layout visual.

```N/A
Imagem mostrando o conector destacado em azul.
Imagem mostrando um ponto de articulação e um conector dobrado.
Imagem mostrando dois pontos de articulação em um conector dobrado.
```

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

### Create Source Map Example (Text View)

Source: https://help.nicecxone.com/pt-br/content/studio/actions/getsourcemap/getsourcemap

This snippet, likely related to the 'Get Source Map' action, shows an example of creating a source map. It is presented in a text view format and is part of a larger script context.

```text
Make Changes HERE CREATE SOURCE (Text View | Copy Text)
```

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

### Iniciar Script via API POST /scripts/start (Recomendado)

Source: https://help.nicecxone.com/pt-br/content/studio/fundamentals/spawnscriptcx_tocpath=Advanced+Tools%7CStudio%7CFundamentals+%28Studio%29%7C_____6

Utilize a API POST /scripts/start para iniciar um script a partir de qualquer processo externo. Esta é a solução recomendada para integração programática. É necessário fornecer os parâmetros do script, se houver, no corpo da requisição.

```json
{
  "scriptId": "seu-script-id",
  "parameters": {
    "p1": "valor1",
    "p2": "valor2"
  }
}
```

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

### Silent Installation Command for NiCE ScreenAgent

Source: https://help.nicecxone.com/pt-br/content/integratedsolutions/engageqmintegrated/implementation/deploy

This example command illustrates how to perform a silent installation of the NiCE ScreenAgent software. It utilizes standard Windows command-line arguments for unattended installations.

```batch
msiexec /i "ScreenAgentNICConfiguratorSetup_[version].msi" /qn
```

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

### Get Bot Transcript - Transcript Snippet Code (Example)

Source: https://help.nicecxone.com/pt-br/content/studio/actions/getbottranscript/getbottranscript

This code is required to use the 'Get Bot Transcript' action. It creates a dynamic object to store transcript data and then copies this data into a variable for use in agent applications or further processing. The specific implementation might vary based on the virtual agent provider and desired output format (HTML or JSON).

```javascript
// Conceptual JavaScript example for handling transcript data
function handleTranscript(transcriptData, outputVariable) {
  // Assuming transcriptData is an object containing transcript and/or intent
  // This is a placeholder, actual implementation depends on data structure
  const transcriptContent = JSON.stringify(transcriptData, null, 2); 
  // Store the content in the designated output variable
  // In a real scenario, this would interact with the scripting engine
  console.log(`Storing transcript in variable '${outputVariable}':`);
  console.log(transcriptContent);
  // Example: setVariable(outputVariable, transcriptContent);
}

// Example usage assuming 'transcriptObject' is the data returned by Get Bot Transcript
// and 'transcriptOut' is the output variable name.
// const transcriptObject = { transcript: '...', intent: '...' }; // Replace with actual data
// handleTranscript(transcriptObject, 'transcriptOut');
```

```python
# Conceptual Python example for handling transcript data
def handle_transcript(transcript_data, output_variable):
    # Assuming transcript_data is a dictionary containing transcript and/or intent
    # This is a placeholder, actual implementation depends on data structure
    transcript_content = json.dumps(transcript_data, indent=2)
    # Store the content in the designated output variable
    # In a real scenario, this would interact with the scripting engine
    print(f"Storing transcript in variable '{output_variable}':")
    print(transcript_content)
    # Example: set_variable(output_variable, transcript_content)

# Example usage assuming 'transcript_object' is the data returned by Get Bot Transcript
# and 'transcriptOut' is the output variable name.
# import json
# transcript_object = {'transcript': '...', 'intent': '...'}
# handle_transcript(transcript_object, 'transcriptOut')
```

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

### Android SDK Setup and Initialization (Markdown)

Source: https://help.nicecxone.com/pt-br/content/acd/digital/mobilesdk/testmobilesdk_tocpath=Digital+Experience%7CDigital+Experience+%7CDigital+Developer+Resources%7CMobile%C2%A0SDK%7C_____3

Instructions for setting up and initializing the Nice CXone mobile SDK for Android. This involves working with the platform's README file in the GitHub repository to configure dependencies and sync the SDK with the code editor. Advanced features like OAuth or push notifications can be skipped if not needed.

```markdown
Refer to the README file in the Android SDK repository for setup and initialization instructions:
https://github.com/nice-devone/nice-cxone-mobile-sdk-android
```

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

### Exemplo de Código JavaScript para Integração do Guide

Source: https://help.nicecxone.com/pt-br/content/acd/digital/guide/customizeguideusingapi_tocpath=Digital+Experience%7CDigital+Experience+%7CDigital+Developer+Resources%7CCustomize+Guide+Using+JavaScript%7C_____0

Este snippet de código demonstra a estrutura básica para integrar o Guide em um site usando JavaScript. Ele mostra onde adicionar chamadas JavaScript personalizadas para estender a funcionalidade do widget do Guide. O código deve ser colocado no cabeçalho de uma página do site.

```JavaScript
<!-- Começo do script do Guide -->
<script>
  // Adicione suas chamadas JavaScript personalizadas aqui
  // Exemplo: _guide.setVisitorId('visitor-123');
  // Exemplo: _guide.openChatWindow();
</script>
<!-- Fim do script do Guide -->
```

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

### Parse Action Example: Extracting Digits

Source: https://help.nicecxone.com/pt-br/content/studio/actions/parse/parse_tocpath=Studio%7CStudio%7CActions+%28Desktop+Studio%29%7CAll+Actions%7C_____160

Demonstrates how to use the 'Parse' action to extract a substring based on start and end positions. For instance, it shows how to get '801' from the string '8015553200' using 'Start=1' and 'End=3'. This action is typically used with variables containing the data to be analyzed.

```inlineCode
Start=1
End=3
```

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

### iOS SDK Setup and Initialization (Markdown)

Source: https://help.nicecxone.com/pt-br/content/acd/digital/mobilesdk/testmobilesdk_tocpath=Digital+Experience%7CDigital+Experience+%7CDigital+Developer+Resources%7CMobile%C2%A0SDK%7C_____3

Instructions for setting up and initializing the Nice CXone mobile SDK for iOS. This involves working with the platform's README file in the GitHub repository to configure dependencies and sync the SDK with the code editor. Advanced features like OAuth or push notifications can be skipped if not needed.

```markdown
Refer to the README file in the iOS SDK repository for setup and initialization instructions:
https://github.com/nice-devone/nice-cxone-mobile-sdk-ios
```

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

### Prompts de Áudio em Scripts

Source: https://help.nicecxone.com/pt-br/content/studio/gettingstarted/startusingstudio_tocpath=Studio%7CStudio%7CIniciar+usando+Desktop%C2%A0Studio%7C_____0

Descreve a função dos prompts de áudio em scripts, que são arquivos de áudio utilizados para interagir com os contatos. Podem ser usados para fornecer informações, solicitar escolhas ou entrada de dados via telefone. O documento aponta para recursos adicionais sobre conversão de texto em fala e gravação de áudio.

```N/A
<h3>Prompts de áudio</h3>
                                                        <p>Os prompts de áudio são um aspecto fundamental de muitos scripts. Eles são arquivos de áudio que o script reproduz para fornecer informações ao contato ou solicitar que o contato faça uma escolha ou insira informações usando o telefone. Você pode aprender <a href="../fundamentals/prompts.htm" target="_blank">mais sobre prompts</a> no <span class="mc-variable DoNotTranslateProductNames.Studio variable">Studio</span>, incluindo o uso de conversão de texto em fala ou a gravação de seus próprios prompts de áudio para usar em scripts.</p>
```

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

### Install Node.js Dependencies

Source: https://help.nicecxone.com/pt-br/content/aiassistantsandbots/customaiintegrations/vah/exampleintegration

This command installs the necessary dependencies for a Node.js project using npm (Node Package Manager). Ensure Node.js and npm are installed. This command should be run from the root directory of the Node.js project.

```bash
npm install
```

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

### Configuração de Ações do Tipo RunExe

Source: https://help.nicecxone.com/pt-br/content/studio/actions/runapp/runapp_tocpath=Advanced+Tools%7CStudio%7CActions+%28Desktop+Studio%29%7CAll+Actions%7C_____193

Detalha o tipo de ação RunExe, que não é suportado pelo CXone Mpower. Requer um executável local com caminho completo e barras duplas (\). Avisa que navegadores modernos geralmente não suportam a execução de programas executáveis.

```plaintext
ActionType: RunExe
Exemplo de ActionValue: C:\\Program Files\\CXone Mpower\\studio.exe
```

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

### Starting ScreenAgent Watchdog

Source: https://help.nicecxone.com/pt-br/content/recording/troubleshootrecordings_tocpath=System+Management%7CRecording%7C_____17

This snippet shows how to start the ScreenAgentWatchDog.exe process if it is not running. This is crucial for maintaining ScreenAgent functionality. The path provided is a typical installation location.

```batch
%%ProgramFiles%%\NICE-InContact\ScreenAgent\ScreenAgentWatchDog.exe
```

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

### SAP Business Objects BI Installer Quiet Installation (No UI)

Source: https://help.nicecxone.com/pt-br/content/integratedsolutions/engageqmintegrated/implementation/deploy_tocpath=Integrated+Solutions%7CEngage+QM%C2%A0Integrated%7CEngage+QM%C2%A0Integrated+Implementation+Process%7C_____2

Shows the command-line option '-q' for the SAP Business Objects BI Platform installer, which suppresses the graphical user interface during the installation process. This is essential for scripting and unattended installations.

```command-line
setup.exe -q
```

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

### Get Source Map Example (Text View)

Source: https://help.nicecxone.com/pt-br/content/studio/actions/getsourcemap/getsourcemap

This snippet demonstrates how to retrieve an existing source map using the 'Get Source Map' action in NiceCXone Desktop Studio. It is intended to be part of a larger script for modifying or appending to source maps.

```text
Make Changes HERE GET SOURCE (Text View)
```

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

### Gainsight and FullStory Analytics Initialization

Source: https://help.nicecxone.com/pt-br/content/studio/actions/studioactions_tocpath=Advanced+Tools%7CStudio%7CActions+%28Desktop+Studio%29%7CAll+Actions%7C_____0

This JavaScript snippet demonstrates how to initialize Help Analytics from storage using the cxoneHelpAnalytics connector. It ensures the analytics are set up after the DOM is fully loaded and includes basic error handling.

```JavaScript
<!-- Gainsight and FullStory Analytics Code -->
<script src="/cxoneHelpAnalyticsConnector.js">
</script>
<script>
    document.addEventListener("DOMContentLoaded", function(){
    try {
    cxoneHelpAnalytics.helpInitAnalyticsFromStorage();
    } catch (e) {}
    });                
</script>
```

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

### Download Sample Script for Routing Agents

Source: https://help.nicecxone.com/pt-br/content/studio/actionscx/reqagent/reqagent_tocpath=Studio%7CStudio%7CA%C3%A7%C3%B5es+%28Studio%29%7C_____185

This snippet provides a link to download a sample script that demonstrates the use of Begin, Menu, Reqagent, Music, and Wait actions. This example is intended to illustrate how these actions can be used together in a script, but it may require additional scripting for a complete solution.

```N/A
Download this script?
```

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

### FOR Loop Example: Ascending Range

Source: https://help.nicecxone.com/pt-br/content/studio/guide/statementsloops

Demonstrates a FOR loop that iterates from a start value to an end value, accumulating values into a string. This loop executes when the end value is greater than the start value.

```Studio Script
FOR i=1 TO 9
{
	ph = "{ph}{i}"
}

```

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

### Foundation JavaScript Initialization

Source: https://help.nicecxone.com/pt-br/content/agent/agentapplicationadministration/agentforsalesforce/omni-channel/setupexternalrouting_tocpath=System+Management%7CAgent+Application+Administration%7CSalesforce+Agent+%7COmni-Channel%7C_____1

Initializes the Foundation framework, a responsive front-end framework. This script is essential for UI components and layout.

```javascript
foundation.6.2.3_custom.js
```

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

### Ação BEGIN com Parâmetros de Script (Exemplo de Código)

Source: https://help.nicecxone.com/pt-br/content/studio/fundamentals/spawnscript_tocpath=Advanced+Tools%7CStudio%7CFundamentals+%28Desktop+Studio%29%7C_____6

A ação BEGIN em um script pode ser configurada com múltiplos valores de parâmetros. Estes parâmetros são então disponibilizados como variáveis para uso posterior no script.

```text
p1
p2
p3
p4
```

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

### FOR Loop Example: Descending Range

Source: https://help.nicecxone.com/pt-br/content/studio/guide/statementsloops

Illustrates a FOR loop that iterates from a start value down to an end value, accumulating values into a string. This loop executes even when the start value is greater than the end value.

```Studio Script
FOR i=9 TO 1
{
	ph = "{ph}{i}"
}

```

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

### Proxy Configuration Examples

Source: https://help.nicecxone.com/pt-br/content/recording/screenagent/screenagentformac_tocpath=Admin%7CAdmin%7CRecording%7C_____6

Examples of how to configure proxy settings, including protocols (http, https), authentication (username, password), server address, and port. These examples demonstrate different valid formats for proxy configuration strings.

```text
http://nome_do_servidor:senha_do_servidor@host:porta
https://server_username:server_password@host:port
https://host:porta
```

```text
WEB_PROXY = http://admin:pwd@168.63.76.32:3128
WEB_PROXY = https://proxyserver:8088
```

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

### Setup Opportunity Creation Workflow

Source: https://help.nicecxone.com/pt-br/content/agent/agentapplicationadministration/cxoneagentintegrated/crmintegration/workflowsnippetinformation/configuresalesforceworkflowsforcxai_tocpath=System+Management%7CAgent+Application+Administration%7CAgent+Integrated%7CIntegrate+Your+CRM%7CIntegrate+Salesforce%7C_____3

Instructions for configuring the 'Create Opportunity' workflow within the Studio application. This involves opening the relevant script and proceeding with the setup.

```Not Applicable
Open the script in Studio and configure the 'Create Opportunity' workflow.
```

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

### Title Bar and Navigation Initialization (JavaScript/HTML)

Source: https://help.nicecxone.com/pt-br/content/reporting/prebuiltreports/prebuiltreportsanalytics/categoriesstatisticsreport_tocpath=Reporting%7CReporting%7CPrebuilt+Reports%7CBI+Reports%7CInteraction+Analytics+Reports%7C_____3

Sets up the main title bar and navigation structure, including account dropdowns and a mobile menu toggle. It utilizes Foundation's grid and menu components.

```html
<nav class="title-bar tab-bar" aria-label="Main navigation and search" data-mc-ignore="true"><a class="skip-to-content fluid-skip showOnFocus" href="#">
                                Skip To Main Content
                            </a>
                            <div class="middle title-bar-section outer-row clearfix">
                                <div class="menu-icon-container relative clearfix">
                                    <div class="central-account-wrapper">
                                        <div class="central-dropdown"><a class="central-account-drop"><span class="central-account-image"></span><span class="central-account-text">Account</span></a>
                                            <div class="central-dropdown-content"><a class="MCCentralLink central-dropdown-content-settings">Settings</a>
                                                <hr class="central-separator" />
                                                <a class="MCCentralLink central-dropdown-content-logout">Logout</a>
                                            </div>
                                        </div>
                                    </div>
                                    <button class="menu-icon" aria-label="Show Navigation Panel" data-toggle="offCanvas"><span></span>
                                    </button>
                                </div>
                            </div>
                            <div class="title-bar-layout outer-row">
                                <div class="logo-wrapper"><a class="logo" href="../../../home.htm" alt="Logo">
                                    </a>
                                </div>
                                <div class="navigation-wrapper nocontent">
                                    <ul class="navigation clearfix" data-mc-css-tree-node-has-children="has-children" data-mc-css-sub-menu="sub-menu" data-mc-expand-event="mouseenter" data-mc-top-nav-menu="True" data-mc-max-depth="2" data-mc-include-icon="False" data-mc-include-indicator="False" data-mc-include-children="True" data-mc-include-siblings="True" data-mc-include-parent="True" data-mc-toc="True">
                                        <li class="placeholder" style="visibility:hidden">
                                            <a>placeholder
                                            </a>
                                        </li>
                                    </ul>
                                </div>
                                <div class="central-account-wrapper">
                                    <div class="central-dropdown"><a class="central-account-drop"><span class="central-account-image"></span><span class="central-account-text">Account</span></a>
                                        <div class="central-dropdown-content"><a class="MCCentralLink central-dropdown-content-settings">Settings</a>
                                            <hr class="central-separator" />
                                            <a class="MCCentralLink central-dropdown-content-logout">Logout</a>
                                        </div>
                                    </div>
                                </div>
                                <div class="nav-search-wrapper">

```

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

### Get Bot Transcript Action Configuration - Studio

Source: https://help.nicecxone.com/pt-br/content/studio/actionscx/getbottranscript/getbottranscript

This example demonstrates how to configure the Get Bot Transcript action in NiceCXone Studio. It shows setting the 'Format' property to 'HTML' and specifies the output variable 'transcriptOut' for storing the transcript. The action retrieves conversation transcripts from virtual agents.

```Studio
Action: Get Bot Transcript
  Properties:
    Format: HTML
  Output Properties:
    TranscriptVarName: transcriptOut
```

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

### Help Analytics Initialization (JavaScript)

Source: https://help.nicecxone.com/pt-br/content/cxoneopenthirdparty/prepareavayaenvironmentforcxoneacd_tocpath=Multi-ACD+%28Open%29+%7CReal-Time+Third+Party+Telepho_0b62fa_Prepare+Avaya+Environment+for+Real-Time+Third+Party+Telephony+Recording+%28Multi-ACD%29%7C_____0

This script initializes custom help analytics for NiceCxOne. It loads an external JavaScript file (`cxoneHelpAnalyticsConnector.js`) and then attempts to initialize the analytics from storage once the DOM is fully loaded. Includes basic error handling.

```javascript
/* <![CDATA[ */
				document.addEventListener("DOMContentLoaded", function(){
				try {
					cxoneHelpAnalytics.helpInitAnalyticsFromStorage();
				} catch (e) {}
				});
/* ]]> */
```

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

### Example Guide Event Payload - JavaScript

Source: https://help.nicecxone.com/pt-br/content/acd/digital/guide/eventbroadcasting_tocpath=Digital+Experience%7CDigital+Experience+%7CDigital+Developer+Resources%7C_____7

This code snippet demonstrates the structure of a typical Guide event payload, specifically showcasing the 'type' and 'detail' properties. It is intended for use within a JavaScript environment.

```javascript
{
  "type": "templateDisplayed",
  "detail": {
    "templateName": "MyTemplate",
    "channel": "SingleChannel",
    "data": {
      "field1": "value1",
      "field2": "value2"
    }
  }
}
```

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

### Configurar Instalação do ScreenAgent

Source: https://help.nicecxone.com/pt-br/content/recording/screenagent/screenagent_tocpath=System+Management%7CAdmin%7CRecording%7C_____4

Parâmetros opcionais para a instalação do ScreenAgent via linha de comando. KEEP_CURRENT_CONFIG controla se a configuração existente será mantida (padrão: true). INSTALL_PATH permite especificar um diretório de instalação personalizado.

```Command Line
KEEP_CURRENT_CONFIG=true
```

```Command Line
INSTALL_PATH=<caminho_de_instalacao>
```

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

### Initialize and Listen for Guide Events in JavaScript

Source: https://help.nicecxone.com/pt-br/content/acd/digital/guide/eventbroadcasting_tocpath=Digital+Experience%7CDigital+Experience+%7CDigital+Developer+Resources%7C_____7

This comprehensive JavaScript example demonstrates how to initialize the Guide SDK and subsequently listen for various Guide events, including `templateDisplayed`. It requires replacing placeholders like `<LOADER-ID>` and `<TENANT-ID>` with actual values. The code defines a handler function to process received events.

```javascript
<script>
(function(n,u){ 
 window.CXoneDfo=n, 
 window[n]=window[n]||function(){(window[n].q=window[n].q||[]).push(arguments)},window[n].u=u, e=document.createElement("script"),e.type="module",e.src=u+"?"+Math.round(Date.now()/1e3/3600), document.head.appendChild(e) 
})('cxone','<LOADER-ID>');

cxone('init', '<TENANT-ID>');
cxone('guide', 'init');

const guideEvents = ['templateDisplayed'
];
      
function handleEvent(event) {
 console.log('Entire event:', event); 
 console.log('Event Detail property:', event.detail);
}
guideEvents.forEach(eventType => {
 window.addEventListener(eventType, handleEvent);
});      
</script>
```

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

### Install ScreenAgent MSI with Proxy Authentication

Source: https://help.nicecxone.com/pt-br/content/recording/screenagent/screenagent_tocpath=Admin%7CAdmin%7CRecording%7C_____4

This command installs the ScreenAgent MSI package when proxy authentication is required and the proxy is not configured at the OS level. It includes all parameters from the basic installation plus the WEB_PROXY parameter for specifying the proxy server. The installation is performed quietly with logging to 'install.log'.

```batch
msiexec /i ScreenAgent-<32|64>bit-<MSI version>.msi INSTALL_PATH=<Opcional: Caminho de instalação> ACCESS_KEY_ID=<access key ID> ACCESS_KEY_SECRET=<the secret access key> REGION_TYPE=<Subdomínio (primeiros 3 caracteres) do CXone Mpower URL> WEB_PROXY=<Somente se estiver usando um servidor proxy para se conectar à Internet> RESOLVE_USER=<Opcional: Auto|osLogin> FRAME_PER_SECOND=<Opcional: 1, 2, 3, 4 ou 5> RESOLUTION_LEVEL=<Opcional: Nulo, Baixo, Médio ou Alto> LOAD_CERTIFICATES=<Opcional: True|False> STATISTICS=<Opcional: True|False> /log install.log /quiet
```

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

### Instalar ScreenAgent com Comandos de Linha de Comando

Source: https://help.nicecxone.com/pt-br/content/recording/screenagent/screenagent_tocpath=Admin%7CAdmin%7CRecording%7C_____4

Este comando de instalação é usado para instalar o ScreenAgent. Ele suporta a definição de caminhos de instalação, chaves de acesso, região, método de login do usuário, taxa de quadros e nível de resolução. Um arquivo de log também pode ser gerado. Este comando é para cenários sem proxy ou quando o proxy é definido no sistema operacional.

```kotlin
msiexec /i ScreenAgent-64bit-3.0.37.msi INSTALL_PATH=d:\newdir ACCESS_KEY_ID=ABCDEF12345==== ACCESS_KEY_SECRET=12345ABCDEF REGION_TYPE=na1 RESOLVE_USER=oslogin FRAME_PER_SECOND=5 RESOLUTION_LEVEL=high LOAD_CERTIFICATES=true STATISTICS=true /log install.log /quiet
```

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

### Example Script for Sending TORM Templates

Source: https://help.nicecxone.com/pt-br/content/studio/guide/digital/richmessaging_tocpath=Studio%7CStudio%7CTechnical+Reference+Guide%7CDigital+Scripts%7C_____1

This snippet refers to an example script available for download, which can be used when sending TORM templates via script. It is intended as a practical guide for implementing the rich message functionality.

```N/A
// Downloadable example script for sending TORM templates via script.
```

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

### Example JavaScript Function

Source: https://help.nicecxone.com/pt-br/content/agent/agentforsalesforce/lightningagentforsalesforce/realtimeinteractionguidancesfa_tocpath=Salesforce+Agent%7CLightning+Salesforce+Agent+%7CVoice%7C_____5

A basic JavaScript function example. This snippet demonstrates a simple function that returns a boolean value. It can be used as a placeholder or a starting point for more complex script implementations within the project.

```javascript
function example() {
  return true;
}
```

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

### Connectivity Tool Parameter Descriptions

Source: https://help.nicecxone.com/pt-br/content/recording/screenagent/screenagent_tocpath=System+Management%7CAdmin%7CRecording%7C_____4

This section provides descriptions and examples for the parameters used in the connectivity tool command. It explains the purpose of each parameter, such as the location of the downloaded EXE file and the access credentials required to authenticate with the CXone platform.

```Text
Parameter: path to exe file
Description: Localização do arquivo EXE baixado.
Example: C:%UserProfile%\downloads

Parameter: ACCESS_KEY_ID
Description: (Implicitly related to authentication, not fully provided in the snippet)
```

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

### GET BOT TRANSCRIPT Snippet Example

Source: https://help.nicecxone.com/pt-br/content/studio/actionscx/getbottranscript/getbottranscript_tocpath=Studio%7CStudio%7CA%C3%A7%C3%B5es+%28Studio%29%7C_____84

This snippet demonstrates how to use the 'GET BOT TRANSCRIPT' action within a script. It outlines the required structure and parameters for retrieving bot transcripts.

```text
Example Script:

// Define input parameters if any
// Call the GETBOTTRANSCRIPT action
GETBOTTRANSCRIPT(
  // Input parameters for GETBOTTRANSCRIPT if required
);

// Process the output of GETBOTTRANSCRIPT if necessary

```

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

### Baixar scripts de modelo do Zendesk

Source: https://help.nicecxone.com/pt-br/content/agent/agentapplicationadministration/cxoneagentembedded/setupcxae/setupcxaeinzendesk/modifystudioscriptzen_tocpath=System+Management%7CAgent+Application+Administration%7CAgent+Embedded%7CSet+Up+Agent+Embedded%7CSet+Up+in+Zendesk%7C_____3

Esta seção fornece um link para baixar um arquivo ZIP contendo scripts de modelo para Zendesk. Esses scripts são projetados para uso com o Desktop Studio e o Studio, e incluem ações pré-configuradas para fluxos de trabalho de voz e digitais.

```URL
../../../snippets/cxasuitecrm/scripting/templatescripts/zendesktemplatescripts.zip
```

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

### Embed Guide JavaScript on Website

Source: https://help.nicecxone.com/pt-br/content/acd/digital/guide/guideusecases_tocpath=Digital+Experience%7CDigital+Experience+%7CGuide%7C_____10

Copy the provided JavaScript code and paste it into the header of each page where you want to offer Guide. This enables proactive offers for your website visitors.

```javascript
<!-- Paste JavaScript code here -->
```

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

### Initialize Help System and Search Filters (JavaScript)

Source: https://help.nicecxone.com/pt-br/content/aiassistantsandbots/virtualagenthub/integrateomilia_tocpath=Automation+and+AI%7CAutomation+and+AI%7CVirtual+Agents%7CVirtual+Agent+Integrations%7COmilia%C2%A0%28DEVone%29%7C_____1

Loads the MadCapAll.js script to initialize the help system and searchfilterlabels.js for search functionality. These are essential for the interactive features of the help content.

```javascript
        <script src="../../../Resources/Scripts/MadCapAll.js" type="text/javascript" defer="defer">
        </script>
        <script src="../../resources/scripts/searchfilterlabels.js">
        </script>
```

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

### Example Guide Event Payload (JavaScript)

Source: https://help.nicecxone.com/pt-br/content/acd/digital/guide/eventbroadcasting_tocpath=System+Management%7CDigital+Experience+%7CDigital+Developer+Resources%7C_____7

This snippet demonstrates the structure of a Guide event payload, showcasing the 'type' and 'detail' properties. The 'type' indicates the event's nature, while 'detail' contains specific information relevant to that event, such as template data.

```javascript
{
  type: "templateDisplayed",
  detail: {
    // Specific details relevant to the templateDisplayed event
  }
}
```

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

### Copiar Link da Página com JavaScript

Source: https://help.nicecxone.com/pt-br/content/agent/agentapplicationadministration/cxoneagentembedded/setupcxae/setupcxaeinsnow/setupcxaeinsnow_tocpath=System+Management%7CAgent+Application+Administration%7CAgent+Embedded%7CSet+Up+Agent+Embedded%7CSet+Up+in+ServiceNow%7C_____0

Esta função JavaScript permite copiar o link da página atual para a área de transferência do usuário. Ela é acionada por um evento de clique em um botão.

```javascript
function copyLink() {
  var link = window.location.href;
  navigator.clipboard.writeText(link).then(function() {
    alert("Link copiado para a área de transferência!");
  }, function(err) {
    console.error("Erro ao copiar link: ", err);
    alert("Falha ao copiar o link.");
  });
}
```

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

### VDI Remote Apps Workaround: Chrome Browser Launch Script

Source: https://help.nicecxone.com/pt-br/content/recording/screenagent/screenagent

This batch script provides a workaround for VDI environments when ScreenAgentWatchDog.exe fails to start. It launches Google Chrome with a specified URL and ensures ScreenAgentWatchDog.exe is running, starting it if it's not detected. Remember to replace <USER_ID> and <TENANT_ID>.

```batch
@echo Off  
  
cd "C:\Program Files (x86)\Google\Chrome\Application"  
start chrome.exe https://account.activedirectory.windowsazure.com/applications/signin/<USER_ID>?tenantId=<TENANT_ID>  
  
REM Check if ScreenAgentWatchDog is already running for the current user profile  
tasklist /FI "USERNAME eq %USERNAME%" /FI "IMAGENAME eq ScreenAgentWatchDog.exe" | find /I "ScreenAgentWatchDog.exe" > nul  
if "%errorlevel%" neq "0" (  
      cd "%ProgramFiles%\NICE-InContact\ScreenAgent"  
      start ScreenAgentWatchDog.exe  
)  
  
Exit  

```

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

### API Endpoint Examples

Source: https://help.nicecxone.com/pt-br/content/aiassistantsandbots/customaiintegrations/vah/schemas_tocpath=Advanced+Tools%7CVirtual+Agents%7CVirtual+Agent+Integrations%7CCustom+Virtual+Agent%C2%A0Integrations%7C_____6

This section contains examples of API endpoints, detailing their parameters, request bodies, and responses.

```APIDOC
## GET /api/example

### Description
This endpoint retrieves example data.

### Method
GET

### Endpoint
/api/example

### Parameters
#### Query Parameters
- **id** (string) - Required - The ID of the data to retrieve.

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

### Response
#### Success Response (200)
- **data** (string) - The retrieved example data.

#### Response Example
```json
{
  "data": "example data response"
}
```
```

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

### Install NiceCxOne Screen Agent with MSIExec

Source: https://help.nicecxone.com/pt-br/content/recording/screenagent/screenagent_tocpath=System+Management%7CRecording%7C_____4

This command installs the NiceCxOne Screen Agent using msiexec. It supports specifying the installation path, access keys, region type, user resolution, frame rate, resolution level, certificate loading, and statistics logging. The installation is performed quietly with logging to 'install.log'.

```command-line
msiexec /i ScreenAgent-&lt;32|64&gt;bit-&lt;MSI version&gt;.msi INSTALL_PATH=&lt;opcional: caminho de instalação&gt; ACCESS_KEY_ID=&lt;access key ID&gt; ACCESS_KEY_SECRET=&lt;secret access key&gt; REGION_TYPE=&lt;subdomínio (primeiros 3 caracteres) do CXone Mpower URL&gt; RESOLVE_USER=&lt;opcional: auto|oslogin&gt; FRAME_PER_SECOND=&lt;opcional: 1, 2, 3, 4 ou 5&gt; RESOLUTION_LEVEL=&lt;opcional: null, low, medium ou high&gt; LOAD_CERTIFICATES=&lt;opcional: true|false&gt; STATISTICS=&lt;opcional: true|false&gt; /log install.log /quiet
```
Tokens:
Raw