Documento de API
Produto: | Datasul |
Ocorrência: | Documentação de API |
Nome Físico | ipp/ipapi006.p |
Exportar para o formato do MS Excel informações através de substituição, recebendo as informações através de uma tabela temporária padrão e, através de um modelo pré-definido, substituindo palavras chaves encontradas neste modelo pelos valores passados através da temp-table. Estes valores poderão ser texto (string), numérico (passado como string) ou ainda imagem. Neste último caso, deverá ser passado como parâmetro o caminho físico da imagem.
O computador deverá ter instalado o MS Excel.
A API deve ser executada diretamente, passando-se alguns parâmetros pré-definidos.
A sintaxe para chamada da api é a seguinte:
run ipp/ipapi006.p (input <character>,
input <character>,
input table <temp-table>).
Tabelas Temporárias
Tabela Temporária | Descrição | Entrada/Saída |
tt-Dados | Tabela utilizada na comunicação com a API | Entrada |
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
sequencia | integer | Padrão | Seqüência | Sim | 001 |
campo | char | Padrão | Palavra-chave a ser substituida | Sim | 001 |
conteudo | char | Padrão | Valor que substituirá a palavra-chave | Sim | 001 |
multivalorado | Log | Padrão | Indica se o campo é multivalorado ou simples | Sim | 001 |
tipo | Integer | Padrão | Tipo de conteúdo: 1: Texto 2: Imagem | Sim | 001 |
Descrição Parâmetros
Parâmetros | Descrição |
p-cModeloArquivo | Caminho do modelo a ser utilizado na substituição. |
p-cNovoArquivo | Caminho onde o novo arquivo será gerado |
tt-Dados | Temp-table com as informações a serem exportadas. A forma como a temp-table deve ser montada está a seguir. |
Geração da Temp-table de Comunicação
Na planilha Excel modelo, deverão haver palavras-chave que, no processamento da API, são substituidas pelas informações passadas. O padrão para estas palavras-chave é [palavra_chave], entre colchetes e sem espaços. Os espaços podem ser substituidos por underline ( _ ).
Para cada informação à ser exportada para a planilha, deve ser criado um registro na temp-table tt-dados, onde cada campo deve ser alimentado da seguinte forma:
Campo | Descrição |
sequencia | Quando a informação não for multivalorada, deve ser gravado 1 neste campo. Quando for multivalorado, deve ser passado um valor sequencial. O conceito de multivaloração será explicado a seguir. |
campo | É a palavra-chave [entre_colchetes] que está presente na planilha de modelo, e será substituida. Quando se tratar de imagem, será imagem_xxx, onde xxx = número sequencial – será explicado à seguir. |
conteudo | É a informação, em formato character, que substituirá o valor da palavra-chave informada no atributo campo. Quando for imagem, deverá ser gravado neste campo o caminho da mesma. |
multivalorado | Indica que o campo a ser exportado é multivalorado. O conceito de multivaloração será explicado a seguir. |
tipo | Indica o tipo de informação à ser mostrada. 1 = texto ou numérico (passar como string); 2 = imagem |
Multivaloração
Trata-se de uma informação onde uma ou mais palavras-chave específicas representam uma listagem, e não apenas um valor único. Neste caso, deve ser criado um registro na tt-dados para cada campo desta lista que se queira exportar, gravando no atributo “multivalorado” o valor “yes” e no campo “sequência” uma numeração deve ser única para a determina seqüência desta listagem. Na planilha de modelo do Excel, em todas as células onde deve ficar a lista, devem ser colocadas as palavras-chaves que representam os atributos desta lista. Por exemplo:
MODELO
[codigo] | [descricao] |
|
|
|
|
RESULTADO
100 | Descricao do item 100 |
200 | Descricao do item 200 |
300 | Descricao do item 300 |
Neste caso, seriam criados 6 registros distintos na tt-dados: 3 registros para a palavra-chave [codigo], cada um com a mesma seqüência, e 3 registros para a palavra-chave [descricao], com as mesmas características, ou seja, as colunas correspondentes tendo o mesmo número de seqüência.
Imagem
A inserção de uma imagem se dá através da criação de um registro na tt-dados, onde deve-se atribuir ao campo “tipo“ o valor 2 e, ao campo conteúdo, o caminho da imagem a se carregar na planilha. Dentro da planilha de modelo, deverão haver autoformas destinadas à inserção dessa imagem:
Devendo ser informada na planilha de modelo no campo posicionado no lado esquerdo-superior da tela do Excel. A mesma nomenclatura feita no Excel deve ser utilizada na criação da tt-dados, na atribuição do campo “campo”, onde é informada a palavra-chave.
