TOTVS Framework

https://tdn.totvs.com/display/Framework
Admin
A knowledge base and documentation portal for the TOTVS Framework, providing articles, release...
Tokens:517,001
Snippets:5,029
Trust Score:9.8
Update:2 months ago
Show doc for...
Tokens:
Raw
### Basic FWRest Usage Example

Source: https://tdn.totvs.com/display/framework/FWRest

Demonstrates initializing the FWRest client, setting a path, and executing a GET request.

```AdvPL
user function tstFwRestTest() local oRestClient as object oRestClient := FWRest():New("http://code.google.com") oRestClient:setPath("/p/json-path/") if oRestClient:Get()    ConOut(oRestClient:GetResult()) else    ConOut(oRestClient:GetLastError()) endif return
```

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

### Execute TOTVS Discovery Installer

Source: https://tdn.totvs.com/display/framework/TOTVS%2BDiscovery

Run the installer jar file with root privileges.

```bash
sudo java -jar totvsdiscoveryinstaller.jar
```

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

### MsmGet Implementation Example

Source: https://tdn.totvs.com/display/framework/MsmGet

A complete example demonstrating the setup of a MBrowse routine and the corresponding MsmGet maintenance function.

```AdvPL
#include "protheus.ch"
#include "msmgadd.ch"
//-------------------------------------------------------------------
/*/{Protheus.doc} MyMrbwEnch
    MsMget sample
@author totvs
@since 31/07/2019
//-----------------------------------------------------------------*/
User Function MyMrbwEnch()
    Private cCadastro := "Cadastro de Clientes"
    Private aRotina := {{"Pesquisar", "axPesqui", 0, 1},;
          {"Visualizar", "U_MyMsmGet", 0, 2}}
    DbSelectArea("SA1")
    DbSetOrder(1)
    MBrowse(6,1,22,75,"SA1")
Return
//-------------------------------------------------------------------
/*/{Protheus.doc} MyMsmGet
    Função de manutenção do cadastro
@author totvs
@since 31/07/2019
//-----------------------------------------------------------------*/
User Function MyMsmGet(cAlias,nReg,nOpc)
    Local oDlg
    Local oEnch
    Local lMemoria  := .T.
    Local lCreate   := .T.
    Local lSX3  := .T.  //verifica se irá criar a enchoice a partir do SX3 ou a partir de um vetor.
    Local aPos  := {000,000,400,600}        //posição da enchoice na tela
    Local aCpoEnch  := {}  //campos que serão mostrados na enchoice
    Local aAlterEnch := {"A1_COD", "A1_NOME"}  //habilita estes campos para edição
    Local aField    := {}
    Local aFolder   := {"Cadastrais","Adm/Fin.", "Fiscais", "Vendas"}
    Local cSvAlias  := Alias()
    DbSelectArea("SX3")
    DbSetOrder(1)
    DbSeek(cAlias)
    // Exemplo da estrutura do array aField
    //Aadd(aField, {"Codigo", "A1_COD", "C", 6, 0, "@!", 'IIF(Empty(M->A1_LOJA),.T.,ExistChav("SA1",M->A1_COD+M->A1_LOJA,,"EXISTCLI"))', .F., 1, "", "", "", .F., .F., "", 1, .F., "", "S"})
    //Aadd(aField, {"campo 1", "CAMPO_1", "N", 6, 2, "@E 999.99", '', .F., 1, "", "", "", .F., .F., "", 1, .F., "", "S"})
    //M->CAMPO_1 := 156
    While !Eof() .And. SX3->X3_ARQUIVO == cAlias
        If !(SX3->X3_CAMPO $ "A1_FILIAL") .And.
```

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

### Full XTree Implementation Example

Source: https://tdn.totvs.com/display/framework/XTree

A complete example showing the initialization of a dialog, creation of an XTree object, node population, and various functional buttons for interaction.

```AdvPL
#Include 'Protheus.ch'
User Function tdnXtree()  
Local oGet  
Local cGet := Space(6)  
Local cDescri := Space(10)  
DEFINE DIALOG oDlg TITLE "Exemplo de XTree" FROM 0,0 TO 600,800 PIXEL  
  
//-------------------  
//Cria o objeto XTREE  
//-------------------  
oTree := xTree():New(000,000,300,300,oDlg,/*uChange*/,/*uRClick*/,/*bDblClick*/)  
  
//-------  
//Nível 1  
//-------  
oTree:AddTree("01","folder5.png","folder6.png","01",/*bAction*/,/*bRClick*/,/*bDblClick*/)  
//-------  
//Nível 2  
//-------   
oTree:AddTree("Teste","folder5.png","folder6.png","0101",/*bAction*/,/*bRClick*/,/*bDblClick*/)  
  
oTree:EndTree()  
  
oTree:AddTree("0101","folder5.png","folder6.png","0101",/*bAction*/,/*bRClick*/,/*bDblClick*/)  
  
//-------  
//Nível 3  
//-------  
  
oTree:AddTreeItem("0102","folder5.png","0102",/*bAction*/,/*bRClick*/,/*bDblClick*/)  
  
oTree:EndTree()  
  
oTree:AddTree("0103","folder5.png","folder6.png","0103",/*bAction*/,/*bRClick*/,/*bDblClick*/)  
  
oTree:EndTree()  
  
oTree:EndTree()  
  
  
  
//---------------  
//Funcionalidades  
//---------------  
@ 000,340 GET oGet VAR cGet OF oDlg SIZE 40, 010 PIXEL  
TButton():New( 0,300 , "Seek Item", oDlg,{|| oTree:TreeSeek(AllTrim(cGet))},40,010,,,.F.,.T.,.F.,,.F.,,,.F. )  
  
  
TButton():New( 010,300 , "Add Item", oDlg,{|| AddItem(oTree) },40,010,,,.F.,.T.,.F.,,.F.,,,.F. )  
  
TButton():New( 020,300 , "Change BMP", oDlg,{|| oTree:ChangeBmp("LBNO","LBTIK","01") },40,010,,,.F.,.T.,.F.,,.F.,,,.F. )  
  
@ 030,340 GET oGet1 VAR cDescri OF oDlg SIZE 40, 010 PIXEL  
TButton():New( 030,300 , "Altera Prompt", oDlg,{|| ChangePrompt(oTree,cDescri)},40,010,,,.F.,.T.,.F.,,.F.,,,.F. )  
  
TButton():New( 040,300 , "Info Pai", oDlg,{|| ShowFatherInfo(oTree)},40,010,,,.F.,.T.,.F.,,.F.,,,.F. )  
  
  
ACTIVATE DIALOG oDlg CENTERED  
Return
Static Function ChangePrompt(oTree,cDescri)
oTree:ChangePrompt(cDescri,oTree:GetCargo())
Return
  
Static Function AddItem(oTree)
If oTree:TreeSeek("0102")  
  
oTree:AddItem("Novo Item","0106","folder5.png","folder6.png",2,/*bAction*/,/*bRClick*/,/*bDblClick*/)  
  
EndIf
Return
Static Function ShowFatherInfo(oTree)  
Local aInfo := oTree:GetFatherNode()  
Local cMessage
If Len(aInfo) > 0  
cMessage := "ID do Pai : " + aInfo[1] + CRLF  
cMessage += "ID : " + aInfo[2] + CRLF  
cMessage += "É nó? : " + IIf(aInfo[3],".T.",".F.") + CRLF  
cMessage += "cCargo : " + aInfo[4] + CRLF  
cMessage += "cResource1: " + aInfo[5] + CRLF  
cMessage += "cResource2: " + aInfo[6] + CRLF  
MsgInfo(cMessage,"Info do nó pai")  
EndIf
Return
```

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

### FWGridProcess Usage Example

Source: https://tdn.totvs.com/display/framework/FWGridProcess

A complete example demonstrating the initialization of FWGridProcess, meter configuration, and the execution of processing functions.

```AdvPL
User Function testeba()
RpcSetEnv("99","01")
__cInterNet := Nil
oGrid:=FWGridProcess():New("MATA330","teste","teste do processamento",{|lEnd| u_testeba1(oGrid,@lEnd)},"MTA330","u_testeba2")
oGrid:SetMeters(2)
oGrid:SetThreadGrid(5)
oGrid:Activate()
If oGrid:IsFinished()
alert("fim")
Else
alert("fim com erro")
EndIf
Return
User Function Testeba1(oGrid,lEnd)
Local nX,nY
oGrid:SetMaxMeter(4,1,"teste1")
For nX := 1 To 4
oGrid:SetMaxMeter(10,2,"teste2")
For nY := 1 To 10
If !oGrid:CallExecute("callexecute is load",Iif(nX==5.And.nY==10,0,1))
lEnd := .T.
EndIf
oGrid:SetIncMeter(2)
If lEnd
Exit
EndIf
Next nY
If lEnd
Exit
EndIf
oGrid:SetIncMeter(1)
Next nX
Return
//Exemplo de uso de sem Grid
User Function Testebc2(oGrid,lEnd)
Local nX,nY
oGrid:SetMaxMeter(4,1,"teste1")
For nX := 1 To 4
oGrid:SetMaxMeter(10,2,"teste2")
For nY := 1 To 10
oGrid:SetIncMeter(2)
If lEnd
Exit
EndIf
Sleep(1000)
Next nY
If lEnd
Exit
EndIf
oGrid:SetIncMeter(1)
Next nX
Return
User Function Testeba2(cParm,lErro)
Sleep(10000)
Return(.T.)
```

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

### Start TOTVS Discovery Service

Source: https://tdn.totvs.com/display/framework/TOTVS%2BDiscovery

Command to manually start the TOTVS Discovery service after installation.

```bash
sudo ./ discovery.sh start
```

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

### Consume a REST service using FWRest

Source: https://tdn.totvs.com/display/framework/FWRest

Example of initializing the client, setting headers, and performing a GET request.

```AdvPL
1. Local oRestClient := FWRest():New("http://localhost:7045")
2. Local aHeader := {}
3. aadd(aHeader,'Authorization:  BASIC Zmx1aWdjbG91ZDoxMjNAY2xvdWQ=')
4. oRestClient:setPath("/sample/?startIndex=1&count=2")
5. If oRestClient:Get(aHeader)
```

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

### DiskSpace Usage Examples

Source: https://tdn.totvs.com/display/framework/DiskSpace

Examples demonstrating how to retrieve disk space for a specific drive and how to handle error conditions or insufficient space.

```AdvPL
User Function Exemplo()
	// Retorna o tamanho em bytes do HD
	nRet := DISKSPACE( 3 ) // Resultado: 1356947456 
Return

User Function Exemplo2()
	// No exemplo abaixo, obtemos os espaços em disco do drive A:
	// da estação local, verificando se houve sucesso na operação.
	
	nBytes_A := DISKSPACE( 1 ) // Retorna o espaço disponivel no drive A: local ( remote ).
	
	If nBytes_A == -1
		MsgStop('Unidade A: não está disponível ou não há disco no Drive')
	ElseIf nBytes_A < 8192
		MsgStop('Não há espaço disponível no disco. Substitua o disco na Unidade A:')
	Else
		MsgStop('Unidade A: Verificada . '+str(nBytes_A,12)+' bytes livres.')
	Endif
Return
```

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

### Full Chart Implementation Example

Source: https://tdn.totvs.com/display/framework/FWChartBarComp

Complete example demonstrating the initialization, data series addition, legend configuration, and rendering of a bar chart within a dialog.

```AdvPL
#INCLUDE "PROTHEUS.CH"  User Function chart()Local oChartLocal oDlg      DEFINE MSDIALOG oDlg PIXEL FROM 10,0 TO 600,600oChart := FWChartBarComp():New()oChart:init( oDlg, .t. ) 
```

```AdvPL
oChart:addSerie( "Votos PT", { {"Jan",50}, {"Fev",55}, {"Mar",60} })
oChart:addSerie( "Votos PMDB", { {"Jan",30}, {"Fev",35}, {"Mar",40} } )
oChart:addSerie( "Votos PV", { {"Jan",20}, {"Fev",10}, {"Mar",10} } ) 
```

```AdvPL
oChart:setLegend( CONTROL_ALIGN_LEFT ) oChart:Build()ACTIVATE MSDIALOG oDlgReturn
```

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

### Perform Basic HTTP GET Request

Source: https://tdn.totvs.com/display/framework/FWRest?focusedCommentId=309041206

Demonstrates initializing a REST client and executing a GET request to a specified path.

```AdvPL
user function tstFwRestTest()local oRestClient as objectoRestClient := FWRest():New("http://code.google.com")oRestClient:setPath("/p/json-path/")if oRestClient:Get()   ConOut(oRestClient:GetResult())else   ConOut(oRestClient:GetLastError())endif return
```

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

### FWPrintSetup:Activate()

Source: https://tdn.totvs.com/display/framework/FwPrinterSetup

Activates the printer setup configuration.

```APIDOC
## FWPrintSetup:Activate()

### Description
Applies the current printer configuration settings.
```

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

### Initialize FWChartBar instance

Source: https://tdn.totvs.com/display/framework/FWChartBar

Example of instantiating the FWChartBar class.

```AdvPL
oChart := FWChartBar():New()
```

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

### Implementing a Wizard Interface

Source: https://tdn.totvs.com/display/framework/FWWizardControl

This example demonstrates the initialization of FWWizardControl, adding steps with custom construction and navigation blocks, and activating the wizard within a dialog.

```AdvPL
User function teste_stepwiz()
Local oPanel
Local oNewPag
Local cNome   := ""
Local cFornec := ""
Local cCombo1 := ""
Local oStepWiz := nil
Local oDlg := nil
Local oPanelBkg
DEFINE DIALOG oDlg TITLE 'aaaaa' PIXEL 
oDlg:nWidth := 1100 
oDlg:nHeight := 800 
oPanelBkg:= tPanel():New(20,70,"",oDlg,,,,,,300,300)
oStepWiz:= FWWizardControl():New(oPanelBkg)//Instancia a classe FWWizard
oStepWiz:ActiveUISteps()
//----------------------
// Pagina 1
//----------------------
oNewPag := oStepWiz:AddStep("1")
//Altera a descrição do step
oNewPag:SetStepDescription("Primeiro passo")
//Define o bloco de construção
oNewPag:SetConstruction({|Panel|cria_pg1(Panel, @cNome, @cFornec)})
//Define o bloco ao clicar no botão Próximo
oNewPag:SetNextAction({||valida_pg1(@cNome, @cFornec)})
//Define o bloco ao clicar no botão Cancelar
oNewPag:SetCancelAction({||Alert("Cancelou na pagina 1"), .T.})

//----------------------
// Pagina 2
//----------------------
oNewPag := oStepWiz:AddStep("2", {|Panel|cria_pg2(Panel, @cCombo1)})
oNewPag:SetStepDescription("Segundo passo")
oNewPag:SetNextAction({||valida_pg2(@cCombo1)})
//Define o bloco ao clicar no botão Voltar
oNewPag:SetCancelAction({||Alert("Cancelou na pagina 2"), .T.})
oNewPag:SetPrevAction({||Alert("Ops, voce não pode voltar a partir daqui"), .F.})
oNewPag:SetPrevTitle("Voltar(ou não)")

//----------------------
// Pagina 3
//----------------------
oNewPag := oStepWiz:AddStep("3", {|Panel|cria_pn3(Panel)})
oNewPag:SetStepDescription("Terceiro passo")
oNewPag:SetNextAction({||Alert("Fim"), .T.})
oNewPag:SetCancelAction({||Alert("Cancelou na pagina 3"), .T.})
oNewPag:SetCancelWhen({||.F.})
oStepWiz:Activate()
ACTIVATE DIALOG oDlg CENTER 
oStepWiz:Destroy()
Return

//--------------------------
// Construção da página 1
//--------------------------
Static Function cria_pg1(oPanel, cNome, cFornec)
Local oTGet1
Local oTGet2
oSay1:= TSay():New(10,10,{||'Cliente'},oPanel,,,,,,.T.,,,200,20) 
cNome := Space(30)
oTGet1 := TGet():New( 20,10,{|u| if( PCount() > 0, cNome := u, cNome ) } ,oPanel,096,009,"@!",,0,,,.F.,,.T.,,.F.,,.F.,.F.,,.F.,.F.,,cNome,,,, )
oSay2:= TSay():New(40,10,{||'Fornecedor'},oPanel,,,,,,.T.,,,200,20) 
cFornec := Space(30)
oTGet2 := TGet():New( 50,10,{|u| if( PCount() > 0, cFornec := u, cFornec ) },oPanel,096,009,"@!",,0,,,.F.,,.T.,,.F.,,.F.,.F.,,.F.,.F.,,cFornec,,,, )
Return

//----------------------------------------
// Validação do botão Próximo da página 1
//----------------------------------------
Static Function valida_pg1(cNome, cFornec)
MsgInfo("Cliente: " + cNome + chr(13)+chr(10) + "Fornecedor: " + cFornec)
Return .T.

//--------------------------
// Construção da página 2
//--------------------------
Static Function cria_pg2(oPanel, cCombo1)
Local aItems := {'Item1','Item2','Item3'}
Local oCombo1
cCombo1:= aItems[1]   
oCombo1 := TComboBox():New(20,20,{|u|if(PCount()>0,cCombo1:=u,cCombo1)},aItems,100,20,oPanel,,{|| },,,,.T.,,,,,,,,,'cCombo1')
Return

//----------------------------------------
// Validação do botão Próximo da página 2
//----------------------------------------
Static Function valida_pg2(cCombo1)
Local lRet := .F.
If cCombo1 == 'Item3'
    lRet := .T.
Else
    Alert("Você selecionou: " + cCombo1 + " para prossegir selecione Item3")
EndIf
Return lRet

//--------------------------
// Construção da página 3
//--------------------------
Static Function cria_pn3(oPanel)
Local oBtnPanel := TPanel():New(0,0,"",oPanel,,,,,,40,40)
oBtnPanel:Align := CONTROL_ALIGN_TOP
oTButton1 := TButton():New( 010, 010, "Botão 01",oBtnPanel,{||alert("Botão 01")}, 80,20,,,.F.,.T.,.F.,,.F.,,,.F. )
oTButton2 := TButton():New( 010, 0200, "Botão 02",oBtnPanel,{||alert("Botão 02")}, 80,20,,,.F.,.T.,.F.,,.F.,,,.F. )
Return
```

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

### Initialize FWCarolWizard Integration

Source: https://tdn.totvs.com/display/framework/FWCarolWizard

Example demonstrating the construction of a wizard screen for TechFin integration.

```AdvPL
#include "protheus.ch"
/*/{Protheus.doc} WizardTF
Wizard para ativação da integração com a TechFin
/*/
Main Function WizardTF()
    MsApp():New( "SIGAFIN" )
    oApp:cInternet  := Nil
    __cInterNet := NIL
    oApp:bMainInit  := { || ( oApp:lFlat := .F. , TechFinWiz() , Final( "Encerramento Normal" , "" ) ) }//"Encerramento Normal"
    oApp:CreateEnv()
    OpenSM0()
    PtSetTheme( "TEMAP10" )
    SetFunName( "UPDDISTR" )
    oApp:lMessageBar := .T.
    oApp:Activate()
Return
/*/{Protheus.doc} FintechWiz
Construção da Tela de Wizard
@return Nil
/*/
Static Function TechFinWiz()
    Local oWizard       As Object
    Local cDescription  As Character
    Local bConstruction As CodeBlock
    Local bNextAction   As CodeBlock
    Local bPrevWhen     As CodeBlock
    Local bCancelWhen   As CodeBlock
    Local bProcess      As CodeBlock
    Local aParam        As Array
    Local cReqDes       As Character
    Local cReqCont      As Character
    Local bReqVld       As CodeBlock
    Local cReqMsg       As Character
    oWizard := FWCarolWizard():New()
    cDescription := "Novo Passo "
    //Passa o objeto para ser manipulado posteriormente nos steps adicionados
    bConstruction := { | oPanel | aParam := StepPage( oPanel , oWizard ) }
    bNextAction   := { || VldStep( aParam ) }
    bPrevWhen     := { || .F. }
    bCancelWhen   := { || .T.
```

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

### Using FWBmpRep for Image Repository Management

Source: https://tdn.totvs.com/display/framework/FWBmpRep

Demonstrates initializing the repository, checking for existing images, inserting new images, and extracting them back to the file system.

```AdvPL
#include "protheus.ch"
#define C_GRUPO  "99"
#define C_FILIAL "01"
//-------------------------------------------------------------------
/*{Protheus.doc} imgReposit
Exemplo de utilização da classe FWBmpRep, classe responsável pela
manipulação do repositório de imagens
@author Daniel Mendes
@since 12/08/2020
@version 1.0
*/
//-------------------------------------------------------------------
user function imgReposit()
local oImgRepo as object
local lInluiu as logical
local cEntry as char
RpcSetEnv(C_GRUPO, C_FILIAL)
oImgRepo := FWBmpRep():New()
if oImgRepo:OpenRepository()
    lInluiu := .F.
    ConOut("Quantidade de registros: ", oImgRepo:RecordCount())
    if oImgRepo:ExistBmp("xisto")
        oImgRepo:DeleteBmp("xisto")
    endif
    cEntry := oImgRepo:InsertBmp("xisto.jpg",/*cEntry*/, @lInluiu)
    if lInluiu
        FErase("xisto.jpg")
        ConOut("Imagem " + cEntry + " inclusa")
        if oImgRepo:Extract(cEntry, "xisto.jpg")
            ConOut("Imagem " + cEntry + " recuperada")
        else
            ConErr("Erro ao recuperar a imagem " + cEntry)
        endif
    else
        ConErr("Erro ao incluir a imagem xisto.jpg")
    endif
    oImgRepo:CloseRepository()
endif
FreeObj(oImgRepo)
RpcClearEnv()
return
```

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

### Configure LicenseServer.ini

Source: https://tdn.totvs.com/display/framework/Troubleshooting

Example configuration block for the LicenseServer.ini file located in the installation Bin directory.

```ini
[LICENSESERVER]
TypeLocalId=2
NetworkList=08:00:27:00:C4:6F;F0:1F:AF:26:70:50;
TOTVSID=05822d3525b84000B49706806b1451ad   
LocalID=316691fefc6066bfbf06079f526469c7ca38babe
LocalHA=
CheckSum=5ea7e1fff5f94efb3aaf487711115e93623698d3
SMBIOS=4C4C4544-0058-4610-8032-B5C04F315932
```

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

### Get selected item level

Source: https://tdn.totvs.com/display/framework/DBTree

Returns the hierarchical level of the selected item, starting at 1.

```AdvPL
oTree:Nivel() // Result: 3
```

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

### Request Smart View Data

Source: https://tdn.totvs.com/display/framework/GenericLookupService

Example of a GET request to the Smart View endpoint with pagination and search parameters.

```http
http://localhost:8080/rest/api/framework/v1/genericLookupService/smartview/SA1?pageSize=2&page=1&q=000001
```

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

### Initialize and Reset Environment

Source: https://tdn.totvs.com/display/framework/Prepare%2BEnvironment

Example of initializing an environment with specific parameters and resetting it.

```text
PREPARE ENVIRONMENT EMPRESA '01' FILIAL '01' USER 'Administrador' PASSWORD '' TABLES 'SE1,SA1,SE2' MODULO ‘FAT’  
/*******COMANDOS *********/
RESET ENVIRONMENT
```

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

### Initialize FWPrintSetup

Source: https://tdn.totvs.com/display/framework/FWPrintSetup

Instantiate the FWPrintSetup class with specific configuration flags and a window title.

```AdvPL
oPrintSetup := FWPrintSetup():New(PD_ISTOTVSPRINTER+PD_DISABLEDESTINATION, "Set Device Printer")
```

```AdvPL
oSetup := FWPrintSetup():New(PD_ISTOTVSPRINTER, "Set Device Print")
```

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

### REST Service Implementation

Source: https://tdn.totvs.com/display/framework/02.%2BCriando%2Buma%2Bclasse%2BREST?focusedCommentId=485857441

Examples of implementing GET and POST methods for a REST service using the TOTVS framework.

```APIDOC
## GET /sample

### Description
Retrieves sample data. Supports path parameters for specific IDs or query parameters for pagination.

### Method
GET

### Parameters
#### Path Parameters
- **aURLParms** (array) - Optional - Parameters extracted from the URL path (e.g., /sample/1).

#### Query Parameters
- **startIndex** (numeric) - Optional - Starting index for pagination.
- **count** (numeric) - Optional - Number of records to return.

### Response
#### Success Response (200)
- **JSON Object/Array** - Returns a JSON representation of the requested sample data.

---

## POST /sample

### Description
Creates a new sample resource. Requires a path parameter to identify the resource.

### Method
POST

### Parameters
#### Path Parameters
- **aURLParms** (array) - Required - Parameters extracted from the URL path.

### Response
#### Success Response (200)
- **JSON Object** - Returns the created resource.

#### Error Response (400)
- **SetRestFault** - Returns a 400 error if mandatory parameters are missing.
```

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

### Initialize FWLayer and Configure Columns

Source: https://tdn.totvs.com/display/framework/FWLayer

Demonstrates the initialization of an FWLayer instance, the addition of columns, and the configuration of windows within those columns inside a dialog.

```AdvPL
#include "protheus.ch"
User Function Layer()
Local oDlg as object
Local oLayer as object
oLayer := FWLayer():new()
DEFINE MSDIALOG oDlg FROM 000,000 TO 500,500 PIXEL TITLE "FWLayer"
//Inicializa o FWLayer com a janela que ele pertencera e se sera exibido o botão de fechar
oLayer:init(oDlg,.T.)
//Cria as colunas do Layer
oLayer:addCollumn('Col01',60,.F.)
oLayer:addCollumn('Col02',40,.F.)
//Adiciona Janelas as colunas
oLayer:addWindow('Col01','C1_Win01','Janela 01',60,.T.,.F.,{|| Alert("Clique janela 01!") },,{|| Alert("Janela 01 recebeu foco!") })
oLayer:addWindow('Col01','C1_Win02','Janela 02',40,.T.,.T.,{|| Alert("Clique janela 02!") },,{|| Alert("Janela 02 recebeu foco!") })
oLayer:addWindow('Col02','C2_Win01','Janela 01',60,.T.,.F.,{|| Alert("Clique janela 01 Coluna 2!") },,{|| Alert("Janela 01 recebeu foco Coluna 2!") })
oLayer:getWinPanel('Col02','C2_Win01')
//Coloca o botão de split na coluna
oLayer:setColSplit('Col01',CONTROL_ALIGN_RIGHT,,{|| Alert("Split Col01!") })
ACTIVATE MSDIALOG oDlg CENTERED
Return
```

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

### Usage Example of FWPreparedStatement

Source: https://tdn.totvs.com/display/framework/FWPreparedStatement

Demonstrates how to initialize the class, define a query with placeholders, bind string parameters, and retrieve the final query string.

```AdvPL
User Function tPrepStat
Local oStatement
Local cQuery
Local cFinalQuery 
Local cUser := "000001"
Local cPassword := "testeFWPS" 
oStatement := FWPreparedStatement():New()
cQuery := "SELECT * FROM users WHERE username=? AND password=?" 
//Define a consulta e os parâmetros
oStatement:SetQuery(cQuery)
oStatement:SetString(1,cUser)
oStatement:SetString(2,cPassword) 
//Recupera a consulta já com os parâmetros injetados
cFinalQuery := oStatement:GetFixQuery()
```

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

### IsLower Usage Example

Source: https://tdn.totvs.com/display/framework/IsLower

Demonstrates the basic usage of the IsLower function to check if a string starts with a lowercase letter.

```AdvPL
user function islower1()
  Local cTest := "Alpha"
  conout( IsLower( cTest ) ) // Resultado: .F.
return
```

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

### FWREST():Get

Source: https://tdn.totvs.com/display/framework/FWRest

Executes an HTTP GET request.

```APIDOC
## FWREST():Get

### Description
Performs the GET command on the previously configured host and path. Use getResult to retrieve the response or GetLastError to check for errors.

### Syntax
FWREST():Get(aHeadStr, cGetParam)

### Parameters
- **aHeadStr** (Array) - Required - Array containing header parameters.
- **cGetParam** (Character) - Optional - List of parameters to be sent to the HTTP server via URI query component. Should be formatted according to URI standards (use Escape function).

### Returns
- **lOK** (Boolean) - Returns .T. if the GET request returns HTTP code 200.
```

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

### Create a file using FCreate

Source: https://tdn.totvs.com/display/framework/FCreate

Demonstrates creating a file, checking for errors with FError, writing content with FWrite, and closing the handle with FClose.

```AdvPL
#include "Fileio.ch"
user function exemplo()
    local nHandle := FCREATE("\Testfile.txt")
    if nHandle = -1
        conout("Erro ao criar arquivo - ferror " + Str(Ferror()))
    else
        FWrite(nHandle, Time() + CRLF)
        FClose(nHandle)
    endif
return
```

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

### FWOAUTHCLIENT():Get

Source: https://tdn.totvs.com/display/framework/FWoAuthClient

Consumes a service via HTTP GET.

```APIDOC
## FWOAUTHCLIENT():Get(cURL, cQuery, cBody, aHeadOut, cHeadRet, lUTF8)

### Description
Consumes the service indicated by the URL via GET.

### Parameters
- **cURL** (Caracteres) - Required - HTTP address including folder and document.
- **cQuery** (Caracteres) - Optional - Parameters to be sent in the GET request.
- **cBody** (Objeto) - Optional - Parameters sent in the Body.
- **aHeadOut** (Array) - Optional - Strings to be added to the HTTP request header.
- **cHeadRet** (Caracteres) - Optional - Reference to return the HTTP response header.
- **lUTF8** (Lógico) - Optional - Defines if the body should be encoded in UTF8.

### Returns
- **cResponse** (Caracteres) - The string corresponding to the requested document.
```

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

### FWIPCWait Usage Example

Source: https://tdn.totvs.com/display/framework/Classe%2BFWIPCWait

Demonstrates initializing the FWIPCWait class, configuring threads and environment, and executing tasks across multiple threads.

```AdvPL
#include "protheus.ch"
#include "parmtype.ch"

//---------------------------------------------------------------------
/*/{Protheus.doc} IPCTeste
Função para exemplo de uso da classe FWIPCWait
@author  FRAMEWORK
@since   11/09/2024
@version 1.0
/*/
//---------------------------------------------------------------------
User Function IPCTeste()
Local oIPC as object
Local nX as numeric

RpcSetEnv("99","01")

oIPC := FWIPCWait():New("TESTE",10000)
oIPC:SetThreads(1)
oIPC:SetEnvironment(cEmpAnt,cFilAnt)
oIPC:Start("U_IPCTEST2")

For nX := 1 To 1000
    oIPC:Go(nX)
Next nX

oIPC:Stop()

FreeObj(oIPC)
oIPC := Nil
Return

//---------------------------------------------------------------------
/*/{Protheus.doc} IPCTEST2
Função que será executada nas threads de exemplo da FWIpcWait
@author  FRAMEWORK
@since   11/09/2024
@version 1.0
/*/
//---------------------------------------------------------------------
User Function IPCTEST2(nX as numeric)

ConOut("Entrei...", nX, Time())
Sleep(2000)
ConOut("Saindo...", nX, Time())

Return
```

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

### Initialize and Configure FWMsPrinter

Source: https://tdn.totvs.com/display/framework/FWMsPrinter

Example showing the instantiation of the FWMsPrinter object and the mandatory configuration sequence for report settings.

```AdvPL
lAdjustToLegacy := .F. 
lDisableSetup  := .T.
oPrinter := FWMSPrinter():New("Danfe.rel", IMP_PDF, lAdjustToLegacy, , lDisableSetup)
// Ordem obrigátoria de configuração do relatório
oPrinter:SetResolution(72)
oPrinter:SetPortrait()
oPrinter:SetPaperSize(DMPAPER_A4) 
oPrinter:SetMargin(60,60,60,60) // nEsquerda, nSuperior, nDireita, nInferior 
oPrinter:cPathPDF := "c:\directory\" // Caso seja utilizada impressão em IMP_PDF
```

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

### ProSessionInfoService Return Examples

Source: https://tdn.totvs.com/display/framework/Protheus-lib-core

Examples of return structures for various methods within the ProSessionInfoService.

```json
{  proCompany: ProCompany;  proBranch: ProBranch;  proModule: string;  appName: string;  proSystemModule: ProSystemModules;  proDatabase: string;  remoteRype: number;  socketPort: number;  proAppConfig: ProAppConfig;  proIdiom: string;  proRole: ProRole;  token: ProAuthToken;  erpAppConfig: ProAppConfig;  proUser: ProUser;  erpToken: ProAuthToken;}
```

```json
{
    Code: "T1",
    InternalId: "T1",
    CorporateName: "Grupo TOTVS 1                                       "
}
```

```json
{
    CompanyCode: "T1",
    EnterpriseGroup: "T1",
    ParentCode: "D MG 01 ",
    Code: "D MG 01 ",
    Description: "Filial BELO HOR                                 "
}
```

```javascript
'CFG'
```

```javascript
'nomeApp'
```

```json
{
    id: 99,
    name: "SIGACFG",
    description: "Configurador"
}
```

```javascript
'20240805'
```

```javascript
5
```

```javascript
1254
```

```json
{
    name: "Schedule",
    version: "1.0.0",
    versionAPI: "",
    productLine: "Protheus",
    api_baseUrl: "/",
    multiProtocolPort: null,
    serverBackend: null
}
```

```javascript
'pt-BR'
```

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

### Calendar Widget Event Example

Source: https://tdn.totvs.com/display/framework/FWCalendarWidget

Example of defining event buttons for the calendar widget.

```AdvPL
{{'Evento qualquer', "Alert('Teste') " } , {'Segundo botão', "Alert('segundo botão') " } }
```

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

### Install Java JDK 11

Source: https://tdn.totvs.com/display/framework/TOTVS%2BDiscovery

Command to install OpenJDK 11 on Linux systems.

```bash
sudo apt install openjdk-11-jdk
```

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

### Instantiate FWDBAccess

Source: https://tdn.totvs.com/display/framework/FWDBAccess

Example of initializing the connection object with database alias, server, and port.

```AdvPL
// Instancia da Classe de Conexao ao TOTVSDBAcess
//New( , , )
// cDBMSAlias - Tipo/Nome da conexao configurada no TOTVSDBAcess
// cServer - Nome ou IP do Servidor onde esta o TOTVSDBAcess
// nPort - Porta do Servidor onde esta o TOTVSDBAcess
// Ex. oCnx := FWDBAccess():New( 'ORACLE/P10', '192.168.0.2' )
// oCnx := FWDBAccess():New( 'MSSQL7/ENVTOP', 'SERVIDOR' )
// oConx := FWDBAccess():New( 'ORACLE/ENVTOP', '172.162.0.5' )
oConx:SetConsoleError( .T. )
```

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

### Install Java JDK 8

Source: https://tdn.totvs.com/display/framework/TOTVS%2BDiscovery

Command to install OpenJDK 8 on Linux systems.

```bash
sudo apt-get install openjdk-8-jdk
```

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

### Configure and Activate FWCarolWizard

Source: https://tdn.totvs.com/display/framework/FWCarolWizard

Example of setting up wizard requirements, steps, and activating the wizard instance.

```AdvPL
bProcess      := { | cGrpEmp, cMsg | ProcAnt( cGrpEmp, @cMsg, aParam ) }
    cReqDes  := "Release do RPO"
    cReqCont := GetRpoRelease()
    bReqVld  := { || GetRpoRelease() >= "12.1.023" }
    cReqMsg  := "Versão de RPO deve ser no mínimo 12.1.23"
    oWizard:SetWelcomeMessage( "Minha mensagem de boas vindas customizada" )
    oWizard:AddRequirement( cReqDes, cReqCont, bReqVld, cReqMsg )
    oWizard:AddStep( cDescription + "1", bConstruction, bNextAction, bPrevWhen, bCancelWhen )
    oWizard:AddStep( cDescription + "2", bConstruction, bNextAction, bPrevWhen, bCancelWhen )
    oWizard:AddStep( cDescription + "3", bConstruction, bNextAction, bPrevWhen, bCancelWhen )
    oWizard:AddProcess( bProcess )
    oWizard:SetTrialMode(.T.)
    oWizard:Activate()
Return
```

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

### Code Block Examples

Source: https://tdn.totvs.com/display/framework/SDK%2BMicrosiga%2BProtheus

Various examples of code block definitions with different argument counts.

```AdvPL
{ | | “Bloco sem argumentos” }{ | x | x + 1 }{ | a, b | Func1(a) + Func2(b) }{ | i, j, k | Func(i), Func(j), Func(k) }
```

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

### Parameter Handling Example

Source: https://tdn.totvs.com/display/framework/Classe%2BAutomatic

Demonstrates how to retrieve and initialize parameters for a routine using the totvs.framework.schedule.utils.getParamsMv method.

```AdvPL
MV_PAR07        aAdd(aParams, 2)                // MV_PAR08        aAdd(aParams, 3)                // MV_PAR09        aAdd(aParams, 2)                // MV_PAR10        aAdd(aParams, 2)                // MV_PAR11        aAdd(aParams, 2)                // MV_PAR12        aAdd(aParams, "")               // MV_PAR13        aAdd(aParams, 2)                elseIf nType == 3        cRoutine := 'ATFA050'        aMVParams := totvs.framework.schedule.utils.getParamsMv(cRoutine)        aParams := Array(Len(aMVParams))                for nX := 1 To Len(aMVParams)            if aMVParams[nX][2] == "D"                aParams[nX] := SToD("00000000")            elseIf aMVParams[nX][2] == "N"                aParams[nX] := 1            elseIf aMVParams[nX][2] == "C"                aParams[nX] := ""            endIf        next nX    endIf Return aParams
```

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

### Retrieve Session Information Return Example

Source: https://tdn.totvs.com/display/framework/Protheus-lib-core

Example JSON structure returned by the session information service.

```json
{
    name: "Schedule",
    version: "1.0.0",
    versionAPI: "",
    productLine: "Protheus",
    api_baseUrl: /,
    multiProtocolPort: null,
    serverBackend: null}
```

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

### DBTree Implementation Example

Source: https://tdn.totvs.com/display/framework/DBTree

Demonstrates the creation of a DBTree, adding items, and using buttons to interact with the tree structure.

```AdvPL
#include "TOTVS.CH"User Function DbTree()            DEFINE DIALOG oDlg TITLE "Exemplo de DBTree" FROM 180,180 TO 550,700 PIXEL	    // Cria a Tree    oTree := DbTree():New(0,0,160,260,oDlg,,,.T.)		    // Insere itens    oTree:AddItem("Primeiro nível da DBTree","001", "FOLDER5" ,,,,1)    If oTree:TreeSeek("001")       oTree:AddItem("Segundo nível da DBTree","002", "FOLDER10",,,,2)	      If oTree:TreeSeek("002")         oTree:AddItem("Subnível 01","003", "FOLDER6",,,,2)	        oTree:AddItem("Subnível 02","004", "FOLDER6",,,,2)	        oTree:AddItem("Subnível 03","005", "FOLDER6",,,,2)	      endif    endif                         oTree:TreeSeek("001") // Retorna ao primeiro nível        // Cria botões com métodos básicos    TButton():New( 160, 002, "Seek Item 4", oDlg,{|| oTree:TreeSeek("004")};       ,40,010,,,.F.,.T.,.F.,,.F.,,,.F. )    TButton():New( 160, 052, "Enable"	, oDlg,{|| oTree:SetEnable() };       ,40,010,,,.F.,.T.,.F.,,.F.,,,.F. )    TButton():New( 160, 102, "Disable"	, oDlg,{|| oTree:SetDisable() };       ,40,010,,,.F.,.T.,.F.,,.F.,,,.F. )    TButton():New( 160, 152, "Novo Item", oDlg,{|| TreeNewIt() };       ,40,010,,,.F.,.T.,.F.,,.F.,,,.F. )    TButton():New( 172,02,"Dados do item", oDlg,{|| ;         Alert("Cargo: "+oTree:GetCargo()+chr(13)+"Texto: "+oTree:GetPrompt(.T.)) },;		 40,10,,,.F.,.T.,.F.,,.F.,,,.F. )    TButton():New( 172, 052, "Muda Texto", oDlg,{|| ;         oTree:ChangePrompt("Novo Texto Item 001","001") },;         40,010,,,.F.,.T.,.F.,,.F.,,,.F. )    TButton():New( 172, 102, "Muda Imagem", oDlg,{||;         oTree:ChangeBmp("LBNO","LBTIK",,,"001") },;         40,010,,,.F.,.T.,.F.,,.F.,,,.F. )    TButton():New( 172, 152, "Apaga Item", oDlg,{|| ;         if(oTree:TreeSeek("006"),oTree:DelItem(),) },;         40,010,,,.F.,.T.,.F.,,.F.,,,.F. )    // Indica o término da contrução da Tree    oTree:EndTree()  ACTIVATE DIALOG oDlg CENTERED Return                                             //----------------------------------------// Função auxiliar para inserção de item//----------------------------------------Static Function TreeNewIt()  // Cria novo item na Tree  oTree:AddTreeItem("Novo Item","FOLDER7",,"006")  if oTree:TreeSeek("006")     oTree:AddItem("Sub-nivel 01","007", "FOLDER6",,,,2)	    oTree:AddItem("Sub-nivel 02","008", "FOLDER6",,,,2)	  endifReturn
```

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

### Descend Function Usage Examples

Source: https://tdn.totvs.com/display/framework/Descend

Examples demonstrating the use of Descend for indexing and searching in descending order.

```AdvPL
//Exemplo 1
  Descend(cDesc)
  ------------------------------------------------------------------
  //Exemplo 2
  //Este exemplo utiliza DESCEND() em uma expressao INDEX para criar um índice de datas de ordem descendente:
  
  USE Sales NEW
  INDEX ON DESCEND(DTOS(OrdDate)) TO SalesDate
  
  //Depois, DESCEND() pode ser utilizado para fazer uma pesquisa (SEEK) no índice descendente:
  
  DbSEEK(DESCEND(DTOS(dFindDate)))
  
  //Observação : Faz-se necessária a conversão da Data para String m através da função DTOS(), pois a função DESCEND apenas trabalha com Strings.
```
Tokens:
Raw