INTRODUÇÃO
O TDSCLI.JAR deve estar na mesma pasta de instalação do TDS.
Os comandos devem ser executados na pasta onde foi instalado o TDS.
Como exemplo usaremos a pasta "C:\TOTVS\TOTVS Developer Studio\"
, como local de instalação e sistema operacional Windows. Nos demais sistemas operacionais os procedimentos é o mesmo mudando somente a forma de acessar a pasta do TDS.
Para obter instruções, acesse a linha de comando (command ou terminal) e digite:
java -jar "C:\TOTVS\TOTVS Developer Studio\tdscli.jar" -help
SINTAXE DE USO
Os parâmetros requeridos variam de acordo com o comando escolhido. Para saber quais são, utilize o -help.
java -jar tdscli.jar command parameters
O -help
traz os parâmetros requeridos do comando.
java -jar tdscli.jar command -help
A opção @file é utilizada para receber um arquivo de parâmetro que contenha todos os parâmetros utilizado no comando.
java -jar tdscli.jar command @file
ARQUIVO DE PARÂMETROS
Utilizaremos o comando de compilação somente para demonstração.
Cada comando será detalhado em sua seção.
O arquivo de parâmetros serve para substituir os parâmetros na linha de comando, afim de minimizar o tamanho da linha e separar os parâmetros em um único lugar e arquivo.
Regras
- Pode ser utilizado para qualquer comando, desde que os parâmetros dentro do arquivo sejam válidos para o comando utilizado.
- Deve ter o formato .txt e tem que estar no mesmo diretório raiz que o TDSCLI.JAR.
includes=D:/Servers/Protheus/includes serverType=AdvPL server=127.0.0.1 build=7.00.131227A port=1312 user=admin psw= environment=P11 program=D:/Fontes/ADVPL/NEW_1.PRW authorization=D:/Chave de compilacao/chave.aut recompile=t #COMENTÁRIO
Regras de Sintaxe
- TODAS as barras devem ser para o lado direito. (Exceto para separar a lista de fontes).
- Para os comentários devem ser utilizados #.
- Não existe aspas ou apóstrofo no arquivo.
- Cada chave deve ficar em um linha.
- Deve se respeitar a estrutura:
parametro=valor.
- Cada parâmetro deve ficar em uma linha.
- Espaços não necessitam de barra invertida ou aspas.
- Os parâmetros não obrigatórios podem ser apagados ou comentados.
- Caso algum parâmetro não tenha valor, apenas pule de linha.
BÁSICO
TDSAPPRE
Para utilização de alguns comandos, é necessário setar a variável de ambiente TDS_APPRE com o diretório de instalação do TDS .
SET TDS_APPRE=C:\TOTVS\TOTVS Developer Studio\
OBS
A variável deve conter o verdadeiro diretório de instalação do TDS. Não é necessário aspas.
PARÂMETROS
Os parâmetros são separados apenas por espaço após o valor. Caso algum parâmetro não tenha valor, ou seja branco, apenas coloque o espaço para o próximo parâmetro, como no exemplo abaixo.
Todas as barras devem ser para a direita.
Caso o valor tenha espaços, coloque-o todo com aspas, exemplo: parametro="valor com espaco", parametro2=valorSemAspas
LOG
Caso queira gerar um log da execução do comando, pode ser o utilizado o -logToFile=valor.
Esse comando gera um arquivo no formato que desejar contendo todas as informações da execução.
- É obrigatório a utilização do hífen "-" antes do comando, ficando -logtofile.
- É necessário informar a extensão do arquivo. Ex: .log, .txt
COMPILAÇÃO
O comando de compilação é utilizado tanto para fontes quanto para recursos, em qualquer servidor.
Parâmetro | Descrição | Requerimento |
---|---|---|
INCLUDE | PASTA DE INCLUDES | OBRIGATÓRIO |
SERVERTYPE | TIPO DE SERVIDOR (ADVPL OU 4GL) | OBRIGATÓRIO |
SERVER | IP OU NOME DA MÁQUINA | OBRIGATÓRIO |
BUILD | BUILD DO SERVIDOR | OBRIGATÓRIO |
PORT | PORTA DO SERVIDOR | OBRIGATÓRIO |
USER | USUÁRIO DO SERVIDOR | OBRIGATÓRIO |
PSW | SENHA DO SERVIDOR | OBRIGATÓRIO |
ENVIRONMENT | AMBIENTE PARA COMPILAÇÃO | OBRIGATÓRIO |
PROGRAM | CAMINHO PARA O ARQUIVO A SER COMPILADO | OPCIONAL |
PROGRAMLIST | CAMINHO DO ARQUIVO COM A LISTA DE COMPILAÇÃO | OPCIONAL |
AUTHORIZATION | CAMINHO PARA CHAVE DE COMPILAÇÃO .AUT | OPCIONAL |
RECOMPILE | FORÇA A RECOMPILAÇÃO DO ARQUIVO( T OU F) | OPCIONAL |
COMPILAÇÃO SIMPLES
Para compilação de apenas um arquivo, o parâmetro PROGRAM é obrigatório, ele deve conter o caminho do arquivo a ser compilado com extensão.
Dependendo do arquivo que é compilado, é necessário utilizar a chave de compilação e o parâmetro AUTHORIZATION deve ser utilizado contendo o caminho da chave com extensão.
COMPILAÇÃO DE DIRETÓRIO
O parâmetro PROGRAM também aceita um diretório como valor.
TODOS os arquivos que estiverem dentro desta pasta, incluindo subpastas, serão compilados.
COMPILAÇÃO DE LISTA DE ARQUIVOS
O parâmetro PROGRAMLIST server para receber o caminho de um arquivo no formato .TXT que contenha o caminho dos arquivos a serem compilados separados por linha.
D:/Fontes/ADVPL/NEW_1.PRW D:/Fontes/ADVPL/NEW_2.PRW D:/Fontes/ADVPL/NEW_3.PRW D:/Fontes/ADVPL/NEW_4.PRW D:/Fontes/ADVPL/NEW_5.PRW
Regras da Lista
- Cada arquivo deve estar em um linha.
- TODAS as barras para a direita.
- Não é necessário aspas.
- Não é necessário separar com ponto e vírgula.
- O formato deve ser TXT.
GERAÇÃO DE PATCH