1

Objetivo

Gerador de Sadas
Equipe de Tecnologia / Dezembro 2012

1 de

Gerador de Sadas
NDICE
1) Introduo : A Ferramenta
1.1) Objetivo do
Treinamento
1.2) O que o Gerador de
Sadas
1.3) Disponibilidade
1.4)Layout: Conceito
1.5) Conceitos Bsicos
1.6) Boas Prticas
1.7) Acessando a Ferramenta
2) Layout
2.1) Criao
2.2) Criao
2.3) Criao
um layout
2.4) Criao
2.5) Criao
2.6) Criao
2.7) Criao

de Categoria
do Tipo
e Configurao
de
de
de
2
de

Arquivos
Contexto
Registros
Campos

Gerador de Sadas
NDICE
3) Operaes com o Layout
3.1) Gerao do Layout
3.2) Exportao e Importao
de Layout
3.3) Comparao de Layout
3.4) Gerao de
Documentao
3.5) Gerao de Classe
Configurao para gerao em 3
camadas

Introduo: A Ferramenta

4
Ncleo de Tecnologia
- CSA

1) Introduo: A Ferramenta
1.1) Objetivo do Treinamento
Apresentar as funcionalidades da ferramenta Gerador de
sadas.
Conceitos Bsicos: Layout, Arquivo, Registro, Campo, Contexto
Acessando o Gerador de Sadas
Criao dos contextos do layout
Incluso de um layout
Configurao do layout
Criao dos campos do registro
Associando o contexto aos registros
Associando informaes do contexto aos campos do registro
Filtrando os registros da exportao
Gerando o arquivo do layout

Introduo: A Ferramenta

Ncleo de Tecnologia
- CSA

1.2) O que o Gerador de Sadas?

uma ferramenta de integrao criada para exportar dados
de

qualquer

mdulo

do

RM

atravs

de

arquivo

texto.

Inicialmente a ferramenta foi desenvolvida para ser utilizada

pelo TOTVS Gesto Fiscal onde as rotinas so todas geradas
no formato texto. O Gerador de Sadas hoje se encontra
disponvel

somente

no

mdulo

de

Gesto

Fiscal

de

Integrao. Estuda-se a possibilidade desta exportao ser

feita em outros formatos, como o XML por exemplo.

Introduo: A Ferramenta

6
Ncleo de Tecnologia
- CSA

1.3) Disponibilidade
O Gerador de sadas s est disponvel a partir da verso
11.40 podendo ser acessado pela nova MDI.
Em verses anteriores a 11.40 possvel executar somente o
servio, no sendo possvel a criao e edio dos layouts.

Introduo: A Ferramenta

7
Ncleo de Tecnologia
- CSA

1.4) Layout: Conceito

Quando se fala em layout refere-se a organizao. Definir o
layout de um escritrio, por exemplo organizar as mesas e
armrios da melhor maneira possvel para que se possa
aproveitar o espao da sala. No caso de rotinas legais e da
integrao, layout um arquivo que define a organizao das
informaes solicitadas: Ordenao, hierarquia, formato de
dados e formato do arquivo. Sempre que se trabalha com
exportao de informaes deve-se definir um layout para
auxiliar na leitura das mesmas por uma pessoa ou um outro
sistema.

Introduo: A Ferramenta

8
Ncleo de Tecnologia
- CSA

1.5) Conceitos Bsicos

Layout: contm os registros com as informaes que sero
geradas no arquivo. Determina a organizao destas informaes
no arquivo gerado.
Arquivo: arquivo a ser gerado pelo Gerador de Sadas.
Registro: informao a ser gerada no arquivo.
Campo: parte da informao (registro) a ser gerada no arquivo.
Contexto: origem das informaes que sero geradas no arquivo.

Introduo: A Ferramenta

9
Ncleo de Tecnologia
- CSA

1.6) Boas Prticas

Evite utilizar caractere especial na criao do Layout ( Arquivos,
Registros, Campos e Contextos ). Na gerao ir acontecer a
compilao do layout e esses caracteres especiais podem gerar
dificuldades na compilao.

Introduo: A Ferramenta
1.7) Acessando a Ferramenta

Acessando todos os
mdulos.
Acessar o mdulo
integrao.

10
Ncleo de Tecnologia
- CSA

Introduo: A Ferramenta

11
Ncleo de Tecnologia
- CSA

Acessar a guia
Integrao \ Gerador
de Sada \ Layouts

Tela dos Layouts

Layouts
2) Layout
Primeiros Passos
2.1) Criao da Categoria
Selecionar em Gerador de Sada o Item Categoria

12
Ncleo de Tecnologia
- CSA

Layouts

13
Ncleo de Tecnologia
- CSA

Cadastrando a Nova Categoria.

Clique no boto Novo e informe o Nome e a Descrio da
Categoria.

Layouts

14
Ncleo de Tecnologia
- CSA

O(s) perfil(s) que inserir na guia Perfis da Categoria do Gerador

de Sadas que determinam quem tem acesso ao layout. Escolha
os perfis para os quais deseja fornecer acesso clicando no boto
incluir.

Layouts

15
Ncleo de Tecnologia
- CSA

2.2) Criao do Tipo

Selecionar em Gerador de Sada o Item Tipo

O tipo de layout no cadastrado pelo usurio. So tipos pr-definidos que so

includos pelo analista responsvel de cada produto via banco de dados no script de
converso da base. Os tipos so utilizados para separar os layout por processos /
aplicativos.
Ex.: Quando for criada uma chamada para layouts do financeiro no sero
apresentados outros tipos de layout.

Layouts

16
Ncleo de Tecnologia
- CSA

2.3) Criando e Configurando um Layout

Para criar um novo layout clique no boto Gerador de Sadas em
seguida Layout. Em seguida clique no boto Incluir.
Preencha
os
campos
necessrios
para
a
identificao do layout.
Nome e Categoria so
obrigatrios.
Aps preencher clique no
boto Salvar ou OK.

O campo Layout Pai serve

para criar uma estrutura de
rvore em sua viso para
melhor
organizar
e
visualizar seus layouts.

Layouts

17
Ncleo de Tecnologia
- CSA

Para editar o Layout criado d um duplo clique.

Preencha sempre os campos de descrio com o maior nmero de informaes

possveis pois desta forma a documentao do layout gerada pela ferramenta ser
mais completa.

Layouts

18
Ncleo de Tecnologia
- CSA

Formatao padro do Layout

Preenchendo esta formatao todos os campos do Layout criado
respeitaro esta formatao

Esta formatao deve ser feita separadamente pelo tipo do campo.

Formatao dos campos Texto, Nmero Inteiro, Nmero Decimal,
Data e Lgico.

Layouts

19
Ncleo de Tecnologia
- CSA

Formatao padro do Layout

Observaes:
Substituir Caracteres Especiais: no substitui a funo remove os
caracteres especiais.
Expresso regular para pesquisa no texto: possui a funo de
obter uma parte do texto desejado.
Exemplo: "Nome: ROGERIO" voc poderia fazer .*?: (.*?) ser
retornado a parte do texto ROGERIO.
Expresso regular dos caracteres no permitidos: possvel
definir uma expresso regular para remover caracteres que no
podem sair no layout.
Exemplo: [^0-9] neste caso, remove tudo que no for numero.

Layouts
2.4) Criao de Arquivos
Clique no boto Adicionar Arquivo

20
Ncleo de Tecnologia
- CSA

Layouts

21
Ncleo de Tecnologia
- CSA

possvel preencher o Nome, Descrio, Tipo do Arquivo e

Codificao do Arquivo.

Ateno para a Codificao do Arquivo dependendo da codificao

escolhida os caracteres especiais podem apresentar formato invlido na
gerao do layout.
At ento o nico Tipo do Arquivo disponvel para gerao do arquivo o
Arquivo Texto.

Layouts

22
Ncleo de Tecnologia
- CSA

Na aba Propriedades possvel configurar as propriedades do seu

Arquivo

Nesta aba que ser definido se o arquivo ter uma linha em branco no fim
do arquivo, o separador de campos, separador final da linha e separador
inicial da linha.
At ento a nica extenso disponvel para gerao do arquivo a TXT,
observe que o campo Extenso do Arquivo no pode ser editado.

Layout

23
Ncleo de Tecnologia
- CSA

2.5) Criao de Contexto

O Contexto do Layout a Fonte de

Dados para gerao do seu Arquivo.
Selecionar a guia Contexto, clicar no boto
Adicionar Layout.

Layout

24
Ncleo de Tecnologia
- CSA

2.5) Criao de Contexto

Modo de Carga do Contexto
a) Carregar no incio da gerao
No incio da gerao do layout
carregar todos os dados. Em
layouts muito grandes a gerao
pode
ter
o
desempenho
comprometido.
b) Carregar sob demanda
Carrega o contexto sob demanda, somente no momento que
requerido pelo Layout.

Layout

25
Ncleo de Tecnologia
- CSA

2.5) Criao de Contexto

c) Carregar sob demanda (cacheado)
Carrega sob demanda e s descarrega aps utilizar as informaes
em todo os layout.
Exemplo: No layout com a seguinte estrutura:
Registro 01
Registro 01.01
Registro 01.02
Registro 02
Registro 03
utilizado a informao dos cliente/fornecedores no registro 1,
registro 2, este contexto ser carregado na gerao do registro 1
e ser descarregado somente aps a utilizao das informaes
no registro 2.

Layout

26
Ncleo de Tecnologia
- CSA

Contexto Classe RM.NET

O Contexto Classe RM.NET um contexto programado

utilizado somente internamente aqui na TOTVS.

Layout

27
Ncleo de Tecnologia
- CSA

Contexto Classe RM.NET

O Contexto Classe RM.NET um contexto retorna os dados
conforme a regra de negcios criada pelo PDE.
No possvel a criao de contextos deste tipo pelos analistas
que desenvolvem os layouts.
Para saber quais os dados que um contexto Classe RM.NET(dll)
retorna necessrio verificar com o PDE ( com os responsveis
que criaram o contexto ). Exemplo, se foi criado um contexto do
financeiro, os analistas do financeiro que desenvolveram o
contexto devero informar o que ele retorna.

Layout
Contexto Parmetros

28
Ncleo de Tecnologia
- CSA

Layout

29
Ncleo de Tecnologia
- CSA

Tipos de Parmetros
Texto

Preencher o Nome, Ttulo e Descrio. Informar se o parmetro

Obrigatrio para a gerao ou no.

Layout

30
Ncleo de Tecnologia
- CSA

Nmero Inteiro

Preencher o Nome, Ttulo e Descrio. Informar se o parmetro

Obrigatrio para a gerao ou no.

Layout

31
Ncleo de Tecnologia
- CSA

Nmero Decimal

Preencher o Nome, Ttulo e Descrio. Informar se o parmetro

Obrigatrio para a gerao ou no.

Layout

32
Ncleo de Tecnologia
- CSA

Data

Preencher o Nome, Ttulo e Descrio. Informar se o parmetro

Obrigatrio para a gerao ou no.

Layout

33
Ncleo de Tecnologia
- CSA

Lgico

Preencher o Nome, Ttulo e Descrio. Informar se o parmetro

Obrigatrio para a gerao ou no.

Layout

34
Ncleo de Tecnologia
- CSA

Lista

Preencher o Nome, Ttulo e Descrio. Informar se o parmetro

Obrigatrio para a gerao ou no.
Informe tambm a Lista com os respectivos valores que devero
ser selecionadas pelo usurio na gerao do Layout.

Layout

35
Ncleo de Tecnologia
- CSA

Lookup

Preencher o Nome, Ttulo e Descrio. Informar se o parmetro

Obrigatrio para a gerao ou no.
Selecionar a Action que dever ser utilizada no Lookup dos
Parmetros do Layout.

Layout

36
Ncleo de Tecnologia
- CSA

Lookup

Selecionar a Action desejada para utilizao no Layout como

Parmetros.

Layout

37
Ncleo de Tecnologia
- CSA

Lookup

Selecionar as colunas na seo Campos, selecionar a coluna que

ser utilizada na descrio do filtro na seo Descrio e o cdigo
que ser passado como parmetro da Action para o Layout na
seo Cdigo.
Nas sees Descrio e Cdigo estaro disponveis as colunas
disponvel na seo Campos.

Layout

38
Ncleo de Tecnologia
- CSA

Filtros

Preencher o Nome, Ttulo e Descrio. Informar se o parmetro

Obrigatrio para a gerao ou no.
Selecionar a Tabela que dever ser utilizada no Filtro dos
Parmetros do Layout. Poder ser utilizado no Layout aps a
criao.

Layout

39
Ncleo de Tecnologia
- CSA

Contexto Consulta SQL

Selecione a Consulta SQL que ser utilizada com Contexto do

Layout.

Layout

40
Ncleo de Tecnologia
- CSA

Contexto Consulta SQL

Associar os Parmetros criados na Consulta SQL utilizada como

Contexto.
Selecionar o parmetro correspondente e associar aos parmetros
da Consulta SQL utilizada como Contexto.

41

Layout

Ncleo de Tecnologia
- CSA

Contexto Cadastro do Sistema (Tela do Sistema )

Selecionar o Cadastro do Sistema que ser utilizado como

Contexto do Layout.
Localizar

Cadastro

do

Sistema

selecionar o resultado desejado.

no

lookup

Pesquisar

Layout
Contexto Cadastro do Sistema

possvel a associao de uma parmetro ao Contexto

42
Ncleo de Tecnologia
- CSA

Layout
Contexto de Aplicao

Contexto de Aplicao de disponveis no sistema.

43
Ncleo de Tecnologia
- CSA

Layout

44
Ncleo de Tecnologia
- CSA

Contexto Conjunto de Dados

Adicionar Tabela ao contexto.

Selecionar a tabela, as colunas

e configurar a
utilizada
Layout.

com

tabela que ser

Contexto

do

Layout

45
Ncleo de Tecnologia
- CSA

Contexto Conjunto de Dados

Adicionar Relacionamento ao contexto.

Configurando o relacionamento
das tabelas do Conjunto de
Dados.
Obs.: Esto disponveis somente as colunas
selecionadas em cada tabela.

46

Layout

Ncleo de Tecnologia
- CSA

Contexto Conjunto de Dados

Contexto Conjunto de
Dados pronto para uso no
Layout.
A partirHoje no preciso
inserir vrias tabelas que
se relacionam. Exemplo
GCOLIGADA e GFILIAL,
necessrio somente
inserir.
a tabela GFILIAL que nela
voc encontrar as
informaes da
GCOLIGADA.

Layout

47
Ncleo de Tecnologia
- CSA

Contexto Contadores

Adicionar o Contexto Contadores e configurar qual o campo que

dever ser contato no Layout.

Layout

48
Ncleo de Tecnologia
- CSA

Contexto Contadores

Existe no Contexto Contadores um contador sequencial de linha.

49

Layout

Ncleo de Tecnologia
- CSA

Contexto Stored Procedure

Selecionando a Procedure
que ser utilizada como
Contexto do Layout.
O lookup busca todas as
procedures

que

esto

criadas na base de dados.

Layout

50
Ncleo de Tecnologia
- CSA

Contexto Stored Procedure

Caso a procedure tenha parmetros necessrio informar valores

vlidos de parmetros para alimentar o Contexto para a montagem
do Layout.

Layout

51
Ncleo de Tecnologia
- CSA

Contexto Stored Procedure

Aps a montagem do Layout necessrio inserir valores invlidos
nos parmetros para que o Contexto no seja alimentado somente
com os dados gerados para a montagem do Layout.
Obs.: Os parmetros da porcedure devem ter o mesmo nome dos
parmetros criados no Layout.

Layouts

52
Ncleo de Tecnologia
- CSA

2.6) Criao de Registro

Selecionar a aba Layout e clicar no boto Adicionar Registro.

Layouts

53
Ncleo de Tecnologia
- CSA

2.6) Criao de Registro

Configurao do Registro do Layout
Nome: Nomeie aqui o Registro. No utilize espaos ou caracteres
especiais.
Descrio: Descreva o seu Registro.
Arquivo: Selecione o Arquivo que o Registro pertence.
Tipo: Selecione o Tipo do Registro (Lista, Registro e Agrupador).
Lista: Repete mais de uma vez
Registro: No repete

Layouts

54
Ncleo de Tecnologia
- CSA

2.6) Criao de Registro

Agrupador: "Registro Fantasma". No aparece no layout.
ser utilizado baseado na hierarquia das informaes
Exemplo: Para obter as informaes da COLIGADA
DEPARTAMENTO necessrio utilizar a tabela de FILIAL.

Deve
e

dos

As informaes da Filial no so necessrias no meu layout, ento a

tabela de FILIAL ser um registro agrupador.
Requerido: Informe se o campo obrigatrio ou no.

Layouts

55
Ncleo de Tecnologia
- CSA

2.6) Criao de Registro

Associando o Contexto ao Registro

Selecione o Contexto desejado e arraste-o para o Registro, na

aba Ligao.

Layouts

56
Ncleo de Tecnologia
- CSA

2.6) Criao de Registro

Tipo do Registro:
Lista: Repetir mais de uma vez
Registro: No repetir.
Agrupador: "Registro Fantasma". No aparece no layout. Depende
da hierarquia das informaes. Serve p
Exemplo: GCOLIGADA
--->
GFILIAL
---> DEPARTAMENTO
Quero as informaes da coligada e do departamento e no precisa
da filial, ento a GFILIAL ser um registro agrupador.

Layouts

57
Ncleo de Tecnologia
- CSA

2.6) Criao de Registro

possvel associar Filtros e criar uma Ordenao no Registro

Layouts
2.7) Criao de Campos

58
Ncleo de Tecnologia
- CSA

Layouts

59
Ncleo de Tecnologia
- CSA

2.7) Criao de Campos

O Boto Verde adiciona um novo registro, o Azul um novo

registro Invisvel e o Vermelho remove um registro selecionado.
Setas servem para movimentar os campos no registro.
O ltimo boto exibe o Nome da Ligao dos campos.

Ser descontinuado, pois o modo de carga do layout executa de

forma mais eficiente esta funo.

Layouts

60
Ncleo de Tecnologia
- CSA

2.7) Criao de Campos

Configurao do Registro do Layout
Nome: Nomeie aqui o campo. No utilize espaos ou caracteres
especiais.
Descrio: Descreva o campo do seu registro.
Tamanho: Especifique o tamanho do campo.
Requerido: Informe se o campo obrigatrio ou no.

Layouts

61
Ncleo de Tecnologia
- CSA

2.7) Criao de Campos

Parametrizao do Modo do campo criado:
Chave Primria: Utilizado quando o dado no pode ser repetido no
registro.
Primeiro Valor

e ltimo Valor: Retornam o primeiro e ltimo

valor de uma srie quando utilizados em conjunto com a Chave

Primria.
Sequencial: Incrementa o valor em 1 a cada registro impresso.
Contar: Conta a quantidade de dados impressos no registros.
Utilizado em conjunto com a Chave Primria.

Layouts

62
Ncleo de Tecnologia
- CSA

2.7) Criao de Campos

Somar: Utilizado para somar valores. Utilizado em conjunto com a
Chave Primria
Mdia: Calcula a mdia dos valores de um registros. Utilizado em
conjunto com a Chave Primria
Mnimo e Mximo: Retornam o menor e o maior valor de uma sria
quando utilizados em conjunto com a Chave Primria

Layouts

63
Ncleo de Tecnologia
- CSA

2.7) Criao de Campos

Parametrizaes do Tipo do campos:
Tipo de dado: Texto, Nmero Inteiro, Nmero decimal, Data e
Lgico Armazenas os valores verdadeiro e falso
Boto Parametrizar Possibilita a personalizao do campo conforme
seu tipo.

Layouts

64
Ncleo de Tecnologia
- CSA

2.7) Criao de Campos

Edio das propriedades avanadas do campo Neste local so
acessadas todas as parametrizaes do campo e ainda pode-se fazer
converso de valores: de-para .

Layouts

65
Ncleo de Tecnologia
- CSA

2.7) Criao de Campos

Na guia Ligao possvel visualizar a ligao do Contexto ao
Campo.

Layouts

66
Ncleo de Tecnologia
- CSA

2.7) Criao de Campos

Associando uma coluna do Contexto a um Campo do Layout.
Clique sobre o nome do contexto criado, arraste e solte a coluna
desejada no campo desejado.

Layouts

67
Ncleo de Tecnologia
- CSA

2.7) Criao de Campos

Filtro da Ligao:
Selecionar o campo do contexto que ser utilizado no filtro e montar
a expresso.
Exemplo:Util.ValueIn(CODCFO,"C01397").

No necessrio replicar o filtro para os registros filhos.

Layouts

68
Ncleo de Tecnologia
- CSA

2.7) Criao de Campos

Operao de campos com outros campos do Layout. Marcar a
opo Utilizar Expresso no clculo do registro.

Operaes com Layouts

69
Ncleo de Tecnologia
- CSA

3) Operaes com Layouts

3.1) Gerao do Layout
Selecione Layout deseja, no boto Processo item Gerao de
Sadas.

Operaes com Layouts

70
Ncleo de Tecnologia
- CSA

3.1) Gerao do Layout

Selecione o diretrio onde o arquivo ser salvo. Esta opo funciona
apenas para ambiente simples.

Operaes com Layouts

71
Ncleo de Tecnologia
- CSA

3.1) Gerao do Layout

Para ambientes 3 camadas necessrio inserir a Tag abaixo nos
arquivos

RM.Host.exe.Config

ou

RM.Host.Service.config

liberar acesso de gravao para o usurio que executa o Host no

diretrio compartilhado.

necessrio marcar a opo Gerar Arquivo em Servidor

Operaes com Layouts

3.1) Gerao do Layout
Informar os parmetros necessrio para a Gerao

72
Ncleo de Tecnologia
- CSA

Operaes com Layouts

3.1) Gerao do Layout
Arquivo Gerado com sucesso

73
Ncleo de Tecnologia
- CSA

Operaes com Layouts

74
Ncleo de Tecnologia
- CSA

3.1) Gerao do Layout

Visualizando o arquivo gerado, por padro o arquivo salvo no
caminho abaixo C:\TOTVS\CorporeRM\RM.Net\Arquivos\Saidas

Operaes com Layouts

75
Ncleo de Tecnologia
- CSA

3.2) Exportao e Importao de Layout

Recurso padro e Importao e Exportao de objetos do sistema

Operaes com Layouts

76
Ncleo de Tecnologia
- CSA

3.3) Comparao de Layouts

Recurso permite comparar dois layouts criados, selecione o Layout
v em Processos \ Comparao de Layouts.

Operaes com Layouts

77
Ncleo de Tecnologia
- CSA

3.4) Gerar Documentao

possvel gerar uma documentao detalhada do Layout bastar
editar o Layout e clicar no boto Gerar Documentao.

Operaes com Layouts

78
Ncleo de Tecnologia
- CSA

3.5) Gerar Classe

Gerar cdigo fonte para o desenvolvedor vai utilizar para debugar

em caso de problema.

Agradecimentos

79
Ncleo de Tecnologia
- CSA

8080

Colaborao

M
E
G
A
IM

TOTVS

Bruno Alexandre
Ceclia Franco
Rogrio Ohashi
Vander Lcio

8181

Fim

M
E
G
A
IM

TOTVS

QUESTES?
Eduardo Santos
eduardo.santos@totvs.com.br