Professional Documents
Culture Documents
Histórico
Data Versão Descrição Autor
29/10/2013 3.3 Correções e atualizações Rosângela Miranda,
a
M Clareth de Castro
;
Padrão para Documentação de Procedures GPROM6 131029 Página 1 de 41
PROCESSO DE DESENVOLVIMENTO DE APLICATIVOS
Padrão para Documentação de Procedures
Índice Analítico
1. Introdução ....................................................................................................................................3
1.1 Formação do nome da Documentação ................................................................................4
2. Composição da Documentação ...................................................................................................4
2.1 Elementos e estrutura da Documentação ....... ...................................................................4
2.2 Capítulos da Documentação ................................................................................................5
2.2.1 Histórico – Capítulo 1 ... .................................................................................................5
2.2.2 Identificação – Capítulo 2................................................................................................7
2.2.3 Finalidade – Capítulo 3. ..................................................................................................7
2.2.4 Ambientes e Periodicidades – Capítulo 4. .......................................................................7
2.2.5 Horários de execução – Capítulo 5 . ................................................................................9
2.2.6 Procedures executadas antes – Capítulo 6 . ...................................................................10
2.2.7 Condições para iniciar a execução – Capítulo 7 . ..........................................................10
2.2.8 Recursos utilizados – Capítulo 8 . .................................................................................12
2.2.9 Providências complementares – Capítulo 9 . ................................................................12
2.2.10 Providências complementares – JOB – Capítulo .......................................................13
2.2.11 Parâmetros simbólicos da procedure – Obrigatórios – Capítulo 11 . ..........................16
2.2.12 Parâmetros simbólicos da procedure – Opcionais – Capítulo 12 . ..............................19
2.2.13 Parâmetros de programas (PARM) da procedure – Capítulo 13 . ...............................21
2.2.14 Parâmetro REGION do JOB para execução da procedure – Capítulo 14 . .................21
2.2.15 Parâmetro COND do JOB para execução da procedure – Capítulo 15 . .....................22
2.2.16 Códigos de retorno dos programas (Return Codes) da procedure – Capítulo 16 .......22
2.2.17 Arquivos Recebidos - Capítulo 17. .............................................................................23
2.2.18 Arquivos Enviados - Capítulo 18 . ..............................................................................23
2.2.19 Instruções para gerenciamento - Capítulo 19 . ............................................................24
2.2.20 Instruções em caso de ABEND - Capítulo 20 . ...........................................................25
2.2.21 Instruções para reprocessamento - Capítulo 21 . .........................................................25
2.2.22 Instruções para migração - Capítulo 22 . .....................................................................26
2.2.23 Instruções para contingência - Capítulo 23 . ...............................................................26
2.2.24 Relatórios - Capítulo 24 ..............................................................................................26
2.2.25 Cardlib - Capítulo 25 . .................................................................................................27
2.2.26 Linhas excluídas da versão anterior - Capítulo 26 . ....................................................28
2.2.27 Instruções Exclusivas aos Desenvolvedores do Sistema - Capítulo 27 . .....................29
3. Tabelas .......................................................................................................................................29
3.1 Tabela de Periodicidades ..................................................................................................29
3.2 Tabela de Sites de Processamento ....................................................................................30
3.3 Tabela de Silos de Aplicação .............................................................................................30
4. Exemplos de Documento de Procedure ....................................................................................30
4.1 Exemplo por site de processamento ..................................................................................30
;
Padrão para Documentação de Procedures GPROM6 131029 Página 2 de 41
PROCESSO DE DESENVOLVIMENTO DE APLICATIVOS
Padrão para Documentação de Procedures
1. Introdução
O padrão descrito neste documento é aplicável a novas documentações. As pré-
existentes deverão ser adequadas gradativamente, conforme a capacidade das gerências
envolvidas.
O objetivo é documentar uma Procedure e os procedimentos complementares
vinculados a ela para sua execução em processamento batch em ambiente de grande porte
(Mainframe) sob o subsistema JES2.
As instruções devem ser claras, sem redundâncias, sem expressões óbvias,
observações e palavras dispensáveis. Não podem ser utilizadas expressões de solicitações,
favores, caráter pessoal e generalidades eventuais. A construção da documentação da
procedure não pode ser elaborada da mesma forma que uma “Ordem de Serviço”.
Não pode constar detalhe de como a rotina deve ser estruturada no produto de schedule
(atualmente no Banco do Brasil é o Control-M) ou parâmetros da linguagem proprietária (Auto-
Edição) do scheduler. Por exemplo, usar &JOBNAME e &ORDERID ao invés de %%JOBNAME
e %%ORDERID, respectivamente.
Uma Documentação pode existir sem Procedure. É utilizada para documentar apenas a
execução de providências complementares. Neste caso, o conteúdo dos capítulos 11, 12, 13,
14, 15, 16 (da documentação) é a expressão NIHIL.
É recomendado que se faça a redação sem acentuação e letra ‘Ç’, toda em caixa-alta.
O documento deverá ser elaborado em registros de 80 colunas e não deverá conter
qualquer caractere nas colunas 1, 71 e 73 a 80, exceto no capítulo 10 (da documentação) onde
os cartões de JCL deverão iniciar na coluna 01. A coluna 72 é reservada para indicação, com a
letra ‘X’ em caixa-alta, de inclusões de linhas e alterações nas linhas relativas ao conteúdo da
versão anterior.
As linhas excluídas, em relação à versão anterior, constam do capítulo 26 (da
documentação), identificando o capítulo de origem e sem a indicação com a letra ‘X’ na coluna
72.
Para composição da DOCLIB são considerados dois tipos de ambientes:
Site de Processamento – rotinas que executam especificamente em determinadas
partições do mainframe, conforme Tabela de Sites de Processamento (capitulo 3.2).. No
capítulo 04 (da documentação), indicar todos os ambientes onde é executada a rotina.
Nos detalhes dos diversos capítulos, quando houver pelo menos uma diferença, são
indicadas todas as siglas dos ambientes onde executa.
Silo de Aplicação – rotinas agrupadas em um Pacote de Serviços que executam em
qualquer site de processamento definido pela Infraestrutura. V. Tabela de Silos de
Aplicação no capitulo 3.3. No capítulo 4 (da documentação), sempre indicar os
ambientes PRODUCAO e HOMOLOGACAO. Para rotinas que não executam em um dos
dois ambientes informar a expressão ‘NIHIL’. Nos detalhes dos diversos capítulos,
quando houver pelo menos uma diferença, são indicados para PRODUCAO e
HOMOLOGACAO.
;
Padrão para Documentação de Procedures GPROM6 131029 Página 3 de 41
PROCESSO DE DESENVOLVIMENTO DE APLICATIVOS
Padrão para Documentação de Procedures
2. Composição da Documentação
2.1 Elementos e estrutura da Documentação
A documentação da PROCEDURE é estruturada em capítulos.
A estrutura deve obedecer à formatação definida neste documento, observando a
identação de cada elemento, para viabilizar coleta dinâmica de dados.
Os capítulos da documentação são:
01. HISTÓRICO;
02. IDENTIFICAÇÃO;
03. FINALIDADE;
04. AMBIENTES E PERIODICIDADES;
05. HORÁRIOS DE EXECUÇÃO;
06. PROCEDURES EXECUTADAS ANTES;
07. CONDIÇÕES PARA INICIAR A EXECUÇÃO;
08. RECURSOS UTILIZADOS;
09. PROVIDÊNCIAS COMPLEMENTARES;
10. PROVIDÊNCIAS COMPLEMENTARES-JOB;
11. PARÂMETROS SIMBÓLICOS DA PROCEDURE-OBRIGATÓRIOS;
12. PARÂMETROS SIMBÓLICOS DA PROCEDURE-OPCIONAIS;
13. PARÂMETROS DE PROGRAMAS (PARM) DA PROCEDURE;
;
Padrão para Documentação de Procedures GPROM6 131029 Página 4 de 41
PROCESSO DE DESENVOLVIMENTO DE APLICATIVOS
Padrão para Documentação de Procedures
Quando não existir conteúdo para o capítulo este é preenchido com a expressão
"NIHIL".
As instruções nos diversos capítulos devem existir somente para os ambientes onde a
rotina é executada. Caso não haja instrução para um desses ambientes de processamento
citado, utilizar a expressão 'NIHIL'.
Nos capítulos onde as instruções são iguais para todos os ambientes de execução não indicar a
mesma informação separadamente para cada um dos ambientes. Só deverá ser informado
separadamente se existir pelo menos uma instrução diferente para um destes ambientes.
;
Padrão para Documentação de Procedures GPROM6 131029 Página 5 de 41
PROCESSO DE DESENVOLVIMENTO DE APLICATIVOS
Padrão para Documentação de Procedures
2.2 Capítulos
2.2.1 Histórico – Capítulo 1.
A descrição sumária de todas as versões inicia na coluna 6 e termina, no máximo, na
coluna 70. Manter a ordem decrescente de versões.
Exemplo:
<...+....1....+....2....+....3....+....4....+....5....+....6....+....7...
01. HISTORICO
VRS004-04/04/04-CCCCCCCC-(FULANO)-MOTIVO MOTIVO MOTIVO MOTIVO X
MOTIVO MOTIVO MOTIVO. X
CCCCCCCC-(CICRANO)-MOTIVO MOTIVO MOTIVO MOTIVO X
MOTIVO MOTIVO MOTIVO MOTIVO MOTIVO, X
MOTIVO MOTIVO MOTIVO MOTIVO MOTIVO. X
VRS003-03/03/03-CCCCCCCC-(BELTRANO)-MOTIVO MOTIVO MOTIVO MOTIVO
MOTIVO MOTIVO MOTIVO MOTIVO MOTIVO,
MOTIVO MOTIVO MOTIVO MOTIVO MOTIVO.
VRS002-12/02/02-CCCCCCCC-(BELTRANO)-MOTIVO MOTIVO MOTIVO MOTIVO
MOTIVO MOTIVO MOTIVO MOTIVO MOTIVO,
MOTIVO MOTIVO MOTIVO MOTIVO MOTIVO.
02/02/02-CCCCCCCC-(CICRANO)-MOTIVO MOTIVO MOTIVO MOTIVO
MOTIVO MOTIVO MOTIVO MOTIVO MOTIVO
MOTIVO MOTIVO MOTIVO MOTIVO MOTIVO.
VRS001-01/01/01-CCCCCCCC-(FULANO)-IMPLANTACAO.
Formatação:
VRSnnn-dd/mm/aa-cccccccc-(nome)-mmmmmmmmmmmmmmmmmm
mmmmmmmmmmmmmmmmmmmmmm
mmmmmmmmmmmmmmmmmmmmmm
onde:
• VRS - Fixo, inicia na coluna 6;
• nnn - Número da versão, inicia na coluna 9 ;
• dd/mm/aa - Data da alteração, inicia na coluna 13;
• cccccccc - Chave do responsável pela alteração, inicia na coluna 22;
• nome - Nome do responsável pela alteração, entre parênteses, iniciando na coluna
31 da primeira linha de motivos. Separar o sinal de fecha parênteses do início do
texto com um hífen e sem espaços em branco.
• mmm...m - Motivo da alteração. Inicia logo após o nome, na primeira linha, e na
coluna 31, a partir da segunda linha, e pode ser utilizada com texto até a coluna 70,
em quantas linhas forem necessárias. Não iniciar o texto com espaços em branco
visando alinhá-los com o início do texto da primeira linha. Iniciar na coluna 31,
alinhado com o parêntese aberto para citação do nome.
Os quatro campos (versão, data, chave do responsável e texto do motivo da
alteração), quando informados, são separados por hífen e sem espaços em branco.
Para uma única versão alterada por mais de um responsável, em datas diferentes ou
não, poderão ser omitidos o primeiro campo VRSnnn- e o primeiro e segundo campos
VRSnnn-dd/mm/aa-, respectivamente.
;
Padrão para Documentação de Procedures GPROM6 131029 Página 6 de 41
PROCESSO DE DESENVOLVIMENTO DE APLICATIVOS
Padrão para Documentação de Procedures
Formatação:
• Na linha 1, iniciar na coluna 6 pela palavra-chave APLICATIVO seguida de espaço,
hífen, espaço. A sigla do aplicativo inicia na coluna 19 seguida de espaço, hífen,
espaço e o nome do aplicativo inicia na coluna 25 e termina na coluna 70. Abreviar o
nome do aplicativo quando necessário. NÃO INCLUIR PONTUAÇÃO ALGUMA.
• Na linha 2, iniciar na coluna 6 pela palavra chave PROCEDURE seguida de espaço,
hífen, espaço e o nome da procedure (início na coluna 18) ou a expressão “NIHIL”.
Formatação:
• Texto livre entre as colunas 06 e 70 em quantas linhas forem necessárias.
;
Padrão para Documentação de Procedures GPROM6 131029 Página 7 de 41
PROCESSO DE DESENVOLVIMENTO DE APLICATIVOS
Padrão para Documentação de Procedures
Formatação:
• A indicação do ambiente de processamento (sigla de dois dígitos) ou de aplicação
(PRODUCAO e HOMOLOGACAO) inicia na coluna 6 seguido do sinal de dois
pontos.
• a informação de periodicidade (conforme Tabela 3.1) inicia na coluna 19. Se houver
necessidade de complementar a informação, preencher “branco hífen branco” e a
instrução, em quantas linhas forem necessárias , em texto livre até a coluna 70.
;
Padrão para Documentação de Procedures GPROM6 131029 Página 8 de 41
PROCESSO DE DESENVOLVIMENTO DE APLICATIVOS
Padrão para Documentação de Procedures
Exemplo:
<...+....1....+....2....+....3....+....4....+....5....+....6....+....7...
05. HORARIOS DE EXECUCAO
19:00 HORAS
Formatação:
• Texto livre entre as colunas 6 e 70 em quantas linhas forem necessárias (se não
houver diferença entre os ambientes)
• Se houver diferença entre os ambientes, a indicação do ambiente de
processamento ou de aplicação inicia na coluna 6 seguido do sinal de dois pontos e
o texto inicia na coluna 10 (site de processamento) ou 19 (silo de aplicação).
;
Padrão para Documentação de Procedures GPROM6 131029 Página 9 de 41
PROCESSO DE DESENVOLVIMENTO DE APLICATIVOS
Padrão para Documentação de Procedures
Formatação:
• Texto livre entre as colunas 6 e 70 em quantas linhas forem necessárias.
• Quando houver, a indicação do ambiente de processamento ou de aplicação inicia
na coluna 6 seguido do sinal de dois pontos e o texto inicia na coluna 10 (para sites
de processamento) ou 19 (para silos de aplicação).
;
Padrão para Documentação de Procedures GPROM6 131029 Página 10 de 41
PROCESSO DE DESENVOLVIMENTO DE APLICATIVOS
Padrão para Documentação de Procedures
Para rotinas ativadas por transação ONLINE, para cada ambiente de execução, deverão
ser documentados os parâmetros utilizados.
Exemplo de ativação por transação online:
<...+....1....+....2....+....3....+....4....+....5....+....6....+....7...
07. CONDICOES PARA INICIAR A EXECUCAO
BR: STARTADA POR TRANSACAO DO APLICATIVO SSS
OPCAO 9.99.A.
B2: STARTADA POR TRANSACAO DO APLICATIVO SSS
OPCAO 9.99.A.
S CONTFRC,SYS=SSS,JOB=SSSENNN,DTMOV=DDMMAA,
S1=’AAAAAAAABBBBBBBBBBBBB’,
S2=’CCCCCCDDDDDDDDEEEEEE’,
STR03=’DD.MM.AAAAFFF’
- ONDE:
AAAAAAAA = DATA = DE 01 A 08 DE S1
BBBBBBBBBBBBB = EMPRESA = DE 09 A 21 DE S1
CCCCCC = USER = DE 01 A 06 DE S1
DDDDDDDD = PUNCH = DE 07 A 14 DE S2
EEEEEE = SISTEMAS = DE 15 A 20 DE S2
DD.MM.AAAA = MVTO = DE 01 A 10 DE STR03
FFF = CODIGO = DE 11 A 13 DE STR03
Formatação:
;
Padrão para Documentação de Procedures GPROM6 131029 Página 11 de 41
PROCESSO DE DESENVOLVIMENTO DE APLICATIVOS
Padrão para Documentação de Procedures
<...+....1....+....2....+....3....+....4....+....5....+....6....+....7...
08. RECURSOS UTILIZADOS
DB2, FTS, ADABAS, CICS, FTP, GRI, RVS, CDT
Formatação:
• Texto livre entre as colunas 6 e 70 em quantas linhas forem necessárias.
Formatação:
;
Padrão para Documentação de Procedures GPROM6 131029 Página 12 de 41
PROCESSO DE DESENVOLVIMENTO DE APLICATIVOS
Padrão para Documentação de Procedures
C - BR: C=3
RJ: C=1
;
Padrão para Documentação de Procedures GPROM6 131029 Página 13 de 41
PROCESSO DE DESENVOLVIMENTO DE APLICATIVOS
Padrão para Documentação de Procedures
B) SSSD999B:
EM B2, RJ E HM, APOS O FIM NORMAL DA PSSSD999, EXECUTAR O
JOB ABAIXO, QUE TEM POR FINALIDADE FAZER LOAD
NA TABELA XXX_YYY_ZZZ.
//*-------------------------------------------------------------*
//PDB2E888 EXEC PDB2E888,
// MEMBRO01=&MEMBRO01,
// A=&A,
// CARDLIB=&CARDLIB,
// CONS=,
// CREATOR=DB2SIS,
// CSTT=,
// DIS=9,
// DRCT=NO,
// DSNREC=&HLQ..SIS.SISF999R.D&DTMOV..SS000101,
// HLQ=&HLQ,
// JOBNAME=&JOBNAME,
// LIB=&CICSLIB,
// NEW=99999,
// OBJ=S1SSS999,
// OPCAO='NEW/RESTART',
// ORD=&ORDERID,
// S=&S,
// SHLV=,
// SHRL=,
// SIS=SSS,
// SYSPUNCH=&HLQ..SIS.SISF999P.D&DTMOV..SS000101,
// TIPO=2
//*-------------------------------------------------------------*
//SYS0000A EXEC PGM=SYS000,
// PARM='&HLQ..SIS.SISF999P.D&DTMOV..SS000101'
//*-------------------------------------------------------------*
//SYS0000B EXEC PGM=SYS000,
// PARM='&HLQ..SIS.SISF999R.D&DTMOV..SS000101'
//*-------------------------------------------------------------*
ONDE:
A - B2: A=G
RJ: A=2
HM: A=G
S - B2: S=1
RJ: S=2
HM: S=3
;
Padrão para Documentação de Procedures GPROM6 131029 Página 14 de 41
PROCESSO DE DESENVOLVIMENTO DE APLICATIVOS
Padrão para Documentação de Procedures
// MEMBRO01=&MEMBRO01,
// A=&A,
// C=&C,
// CONS=,
// CREATOR=DB2SIS,
// CSTT=,
// DRCT=NO,
// HLQ=&HLQ,
// JOBNAME=&JOBNAME,
// OBJ=S1SSS001,
// OPCAO='NEW/RESTART',
// ORD=&ORDERID,
// S=&S,
// SHLV=,
// SHRL=,
// SIS=SSS
//*------------------------------------------------------------*
ONDE:
A - PRODUCAO: DATA-SHARING DO DB2
HOMOLOGACAO: DATA-SHARING DO DB2
B) SSSD999B:
EM PRODUCAO E HOMOLOGACAO, APOS O FIM NORMAL DA PSSSD999,
EXECUTAR O JOB ABAIXO, QUE TEM POR FINALIDADE FAZER LOAD
NA TABELA XXX_YYY_ZZZ.
//*-------------------------------------------------------------*
//PDB2E999 EXEC PDB2E999,
// MEMBRO01=&MEMBRO01,
// A=&A,
// CARDLIB=&CARDLIB,
// CONS=,
// CREATOR=DB2SIS,
// CSTT=,
// DIS=9,
// DRCT=NO,
// DSNREC=&HLQ..SIS.SISF999R.D&DTMOV..SS000101,
// HLQ=&HLQ,
// JOBNAME=&JOBNAME,
// LIB=&CICSLIB,
// NEW=99999,
// OBJ=S1SSS999,
// OPCAO='NEW/RESTART',
// ORD=&ORDERID,
// S=&S,
// SHLV=,
// SHRL=,
// SIS=SSS,
// SYSPUNCH=&HLQ..SIS.SISF999P.D&DTMOV..SS000101,
// TIPO=2
//*-------------------------------------------------------------*
//SYS0000A EXEC PGM=SYS000,
// PARM='&HLQ..SIS.SISF999P.D&DTMOV..SS000101'
//*-------------------------------------------------------------*
//SYS0000B EXEC PGM=SYS000,
// PARM='&HLQ..SIS.SISF999R.D&DTMOV..SS000101'
//*-------------------------------------------------------------*
ONDE:
A - PRODUCAO: DATA-SHARING DO DB2
HOMOLOGACAO: DATA-SHARING DO DB2
;
Padrão para Documentação de Procedures GPROM6 131029 Página 15 de 41
PROCESSO DE DESENVOLVIMENTO DE APLICATIVOS
Padrão para Documentação de Procedures
Formatação:
• Os ambientes indicados para execução dos jobs complementares constam do
capítulo 4.
• O capítulo é subdividido em itens sequenciados alfabeticamente, utilizando a letra na
coluna 6 e ‘)’ após a letra. O título do item inicia na coluna 9 e é seguido do sinal de
dois pontos. As instruções do item iniciam na segunda linha, em quantas linhas
forem necessárias, sempre a partir da coluna 9.
• Os itens são separados por uma linha em branco, bem como as variáveis
informadas no “ONDE:”; não há linha em branco entre as informações dos
ambientes para cada variável.
• Os cartões de JCL iniciam na coluna 1 e terminam até a coluna 70.
• Os valores variáveis utilizados em cada simbólico, por ambiente ou execução, são
descritos após o último cartão de JCL de cada JOB.
• Entre o último cartão de JCL e a descrição dos simbólicos existe uma linha com a
palavra ONDE iniciando na coluna 6, seguida do sinal de dois pontos.
• O nome de cada variável inicia na coluna 6.
• A indicação do ambiente de processamento ou de aplicação inicia na coluna 17,
seguido do sinal de dois pontos.
Parâmetro simbólico obrigatório é aquele que não consta do cartão PROC da procedure
e cujo valor deve ser atribuído no cartão EXEC para a procedure no JOB de execução.
Descrever cada um dos parâmetros simbólicos obrigatórios da procedure, informando o
seu nome, seu significado, os valores possíveis para uso e as instruções necessárias à sua
utilização.
Especificar os valores a serem utilizados, para cada um dos ambientes definidos no
capítulo 4, somente quando forem utilizados valores diferentes.
Não deverão ser informados os valores para os parâmetros simbólicos: HLQ, HLQS,
HLQN, HLQO, HLQADA, CARDLIB, CPDLIB, CICSLIB e DBRMLIB: esses valores ficarão a
cargo da infraestrutura.
;
Padrão para Documentação de Procedures GPROM6 131029 Página 16 de 41
PROCESSO DE DESENVOLVIMENTO DE APLICATIVOS
Padrão para Documentação de Procedures
Não deverão ser informados os valores para os parâmetros simbólicos: DB2, DB,
quando a DOCLIB for construída por Silo de Aplicação: esses valores ficarão a cargo da
infraestrutura.
Pode utilizar a expressão ‘NIHIL’, sendo seu uso obrigatório caso não exista procedure.
São classificados como simbólicos obrigatórios:
• high-level-qualifier dos DSN dos arquivos:
o HLQ (BRP, B2P, B3P, RJP, DSP, HMP, HMH)
o HLQO(BRO,B2O,B3O,RJO,DSO,HMO)
o HLQS (BRS, B2S, B3S, RJS, DSS, HMS)
o HLQN (NATURAL)
o HLQADA (BRADAPxx, B2ADAPxx, B3ADAPxx, RJADAPxx, DSADAPxx,
HMADAPxx)
o BBM (BBM)
• data do movimento no formato AAMMDD (seguem o calendário bancário):
o DTMOV;
o DTFUT (próximo dia útil);
o DTANT (dia útil anterior);
• Data-sharing do DB2 em quatro dígitos:
o DB2
• base de dados dos módulos em Natural:
o DB
• biblioteca de cardlib:
o CARDLIB
• biblioteca CPDLIB de programas:
o CPDLIB
• biblioteca CICSLIB de programas:
o CICSLIB
• biblioteca DBRM de programas:
o DBRMLIB
• sigla de destino (NET067) de arquivos:
o DESTCOE, para arquivos COE210*.
o DESTNTS, para arquivos NTS100*.
o DESTXX, para arquivos que serão transmitidos para silos de aplicação.
Onde XX representa a sigla do silo de aplicação.
CO – Silo Correntista
;
Padrão para Documentação de Procedures GPROM6 131029 Página 17 de 41
PROCESSO DE DESENVOLVIMENTO DE APLICATIVOS
Padrão para Documentação de Procedures
CR – Silo Crédito
FI – Silo Finanças
SE – Silo Seguridade
SU – Silo Suporte Empresarial
;
Padrão para Documentação de Procedures GPROM6 131029 Página 18 de 41
PROCESSO DE DESENVOLVIMENTO DE APLICATIVOS
Padrão para Documentação de Procedures
Formatação:
• Os parâmetros simbólicos informados iniciam na coluna 6 e suas descrições na
coluna 17. Os campos são separados por um hífen na coluna 15, somente na
primeira linha de definição de cada parâmetro.
• A partir da segunda linha, o texto é livre entre as colunas 17 e 70. Pode utilizar
várias linhas.
• Nas linhas seguintes à descrição especificar, a partir da coluna 17, os valores a
serem utilizados para todos os ambientes constantes do capítulo 4.
• Os parâmetros simbólicos informados devem ser relacionados em ordem alfabética
e separados por uma linha em branco.
Parâmetro simbólico opcional é aquele que consta do cartão PROC com um valor
informado para qualquer execução.
O valor poderá opcionalmente ser alterado em execuções específicas informando-o no
cartão EXEC para a procedure no JOB de execução.
Descrever cada um dos parâmetros simbólicos opcionais da procedure, informando o
seu nome, seu significado, os valores possíveis para uso e as instruções necessárias à sua
utilização.
Pode utilizar a expressão ‘NIHIL’ sendo seu uso obrigatório caso não exista procedure.
São classificados como simbólicos opcionais:
- para indicação de espaço para alocação de arquivos em disco:
QR...P, QR...S, QC...P, QC...S, QT...P, QT...S,
onde: R=registros,
;
Padrão para Documentação de Procedures GPROM6 131029 Página 19 de 41
PROCESSO DE DESENVOLVIMENTO DE APLICATIVOS
Padrão para Documentação de Procedures
C=Cilindros,
T=Trilhas
não indicar todos os simbólicos utilizados na procedure, indicar a existência do tipo de
simbólico substituindo o identificador do arquivo por três pontos. Não informar o valor
que assume no cartão PROC.
- para indicação de BUFNO dos arquivos de entrada/saída:
BF...E (arquivo de entrada), BF...S (arquivo de saída).
não indicar todos os simbólicos utilizados na procedure, indicar a existência do tipo de
simbólico substituindo o identificador do arquivo por três pontos. Não informar o valor
que assume no cartão PROC.
- para indicação do arquivo VSAM de controle de transmissão do FTS:
FTSRJE
- para indicação de parâmetros do ADABAS:
MODO, TIPO
Exemplo:
<...+....1....+....2....+....3....+....4....+....5....+....6....+....7...
12. PARAMETROS SIMBOLICOS DA PROCEDURE - OPCIONAIS
BF...E - PARAMETRO BUFNO DOS ARQUIVOS DE ENTRADA.
Formatação:
• Os parâmetros simbólicos informados iniciam na coluna 6 e suas descrições na
coluna 17. Os campos são separados por um hífen na coluna 15, somente na
primeira linha.
• A partir da segunda linha, o texto é livre entre as colunas 17 e 70. Pode utilizar
várias linhas.
• Nas linhas seguintes à descrição, iniciar na coluna 17 as instruções para eventual
utilização de outros valores.
;
Padrão para Documentação de Procedures GPROM6 131029 Página 20 de 41
PROCESSO DE DESENVOLVIMENTO DE APLICATIVOS
Padrão para Documentação de Procedures
Formatação:
• Informar o nome do PROGRAMA a partir da coluna 6 e as demais informações a
partir da coluna 17. Estes dois campos são separados por um hífen na coluna 15, na
primeira linha.
• Texto livre entre as colunas 17 e 70 em quantas linhas forem necessárias.
Formatação:
• Iniciar na coluna 6 com o parâmetro REGION seguido do sinal de igual.
;
Padrão para Documentação de Procedures GPROM6 131029 Página 21 de 41
PROCESSO DE DESENVOLVIMENTO DE APLICATIVOS
Padrão para Documentação de Procedures
REGION=nM
Informar o valor para o parâmetro COND a ser utilizado no cartão JOB do job que
executa a procedure.
Informação obrigatória - utilizar a expressão ‘NIHIL’ apenas no caso de não existir
procedure.
Exemplo:
<...+....1....+....2....+....3....+....4....+....5....+....6....+....7...
15. PARAMETRO COND DO JOB PARA EXECUCAO DA PROCEDURE
COND=((8,EQ),(12,EQ),(16,EQ),(888,EQ))
Formatação:
• Iniciar na coluna 6 com o parâmetro COND seguido do sinal de igual.
Formatação:
• A primeira linha dos detalhes indica o nome das três colunas separadas por hífen da
seguinte forma:
o STEPNAME iniciando na coluna 6;
;
Padrão para Documentação de Procedures GPROM6 131029 Página 22 de 41
PROCESSO DE DESENVOLVIMENTO DE APLICATIVOS
Padrão para Documentação de Procedures
Formatação:
• Informar o nome principal do arquivo a partir da coluna 6 e as demais informações a
partir da coluna 17. Estes dois campos são separados por um hífen na coluna 15 na
primeira linha.
;
Padrão para Documentação de Procedures GPROM6 131029 Página 23 de 41
PROCESSO DE DESENVOLVIMENTO DE APLICATIVOS
Padrão para Documentação de Procedures
Formatação:
• Informar o nome principal do arquivo a partir da coluna 6 e as demais informações a
partir da coluna 17. Estes dois campos são separados por um hífen na coluna 15 na
primeira linha.
;
Padrão para Documentação de Procedures GPROM6 131029 Página 24 de 41
PROCESSO DE DESENVOLVIMENTO DE APLICATIVOS
Padrão para Documentação de Procedures
Formatação:
Na primeira linha do detalhe indicar o AMBIENTE de processamento (sigla de dois
dígitos) ou de aplicação (PRODUCAO e HOMOLOGACAO). Informar também, na primeira
linha, HORÁRIO e NÍVEL seguido do sinal de dois pontos.
• Descrever os campos em linhas e colunas conforme os exemplos.
• ATRASO: inicio ou fim
• MOTIVO DA CRITICIDADE: Texto livre entre as colunas 29 e 70 em quantas linhas
forem necessárias.
• PROVIDÊNCIAS: Texto livre entre as colunas 20 e 70 em quantas linhas forem
necessárias.
• Descrever tantos eventos quantos forem necessários.
Formatação:
• Texto livre entre as colunas 6 e 70 em quantas linhas forem necessárias.
;
Padrão para Documentação de Procedures GPROM6 131029 Página 25 de 41
PROCESSO DE DESENVOLVIMENTO DE APLICATIVOS
Padrão para Documentação de Procedures
<...+....1....+....2....+....3....+....4....+....5....+....6....+....7...
21. INSTRUCOES PARA REPROCESSAMENTO
DELETAR OS ARQUIVOS BBN.SSS111 TRANSMITIDOS E REINICIAR A ROTINA
A PARTIR DO STEP SSSSSSSS.
Formatação:
• Texto livre entre as colunas 6 e 70 em quantas linhas forem necessárias.
Formatação:
• Texto livre entre as colunas 6 e 70 em quantas linhas forem necessárias.
Formatação:
• Texto livre entre as colunas 6 e 70 em quantas linhas forem necessárias.
;
Padrão para Documentação de Procedures GPROM6 131029 Página 26 de 41
PROCESSO DE DESENVOLVIMENTO DE APLICATIVOS
Padrão para Documentação de Procedures
B) RELATORIO: SSS888
TITULO: TRANSACOES ACEITAS POR CLIENTE
CONTEUDO: QUANTIDADE DE REGISTROS GRAVADOS, REJEITADOS E
PERCENTUAL DE REJEICAO POR CLIENTE.
FORMULARIO: 0.30.300-0 NR. COPIAS: 1 SALTO: 6601
FREQUENCIA: DIARIA PROGRAMA:SSSP888
DESCARBONAR: NAO - SEPARAR: NAO - CORTAR: NAO
ARQUIVO: &HLQ..SSS.SSSF888A.D&DTMOV..SS000104
EH PERMITIDO REFAZIMENTO: SIM
FORMA DE REFAZIMENTO: FMT
DESTINATARIOS: AGENCIAS
FORMA DE DISPONIBILIZACAO: GDR E IRA
CANAL1: 1AAAASSSSSNNNNN
Formatação:
;
Padrão para Documentação de Procedures GPROM6 131029 Página 27 de 41
PROCESSO DE DESENVOLVIMENTO DE APLICATIVOS
Padrão para Documentação de Procedures
Exemplo:
<...+....1....+....2....+....3....+....4....+....5....+....6....+....7...
25. CARDLIB
SSSP999A - DESCRICAO EM TEXTO LIVRE DA COLUNA 17 ATE A COLUNA 70.
SSSP999B - DESCRICAO EM TEXTO LIVRE DA COLUNA 17 ATE A COLUNA 70.
SSSDB201 - DESCRICAO EM TEXTO LIVRE DA COLUNA 17 ATE A COLUNA 70.
Formatação:
• Informar o nome da CARDLIB a partir da coluna 6 e a descrição a partir da coluna 17
até a 70. Estes dois campos são separados por um hífen na coluna 15.
;
Padrão para Documentação de Procedures GPROM6 131029 Página 28 de 41
PROCESSO DE DESENVOLVIMENTO DE APLICATIVOS
Padrão para Documentação de Procedures
// PARM='&CDP..SSS.SSSF180.D&DTMOV..SS310801'
//*-------------------------------------------------------------*
//PDB2E880 EXEC PDB2E880,
// A=G,
// AMB=BR,
// OBJ=UNLD999,
// ORD=&ORDERID,
// PART=,
// SIS=EVT
//UNLOAD.SYSRE1 DD DSN=&CDP..SSS.SSSF180.D&DTMOV..SS310801,
// SPACE=(CYL,(150,50),RLSE),DISP=(,CATLG)
//*-------------------------------------------------------------*
11. PARAMETROS SIMBOLICOS DA PROCEDURE - OBRIGATORIOS
DTANT - DATA DO MOVIMENTO ANTERIOR NO FORMATO AAMMDD.
Formatação:
• Nome do capítulo da qual as linhas excluídas faziam parte.
• Texto original da linha excluída.
Formatação:
• Texto livre entre as colunas 6 e 70 em quantas linhas forem necessárias.
3. Tabelas
3.1 Tabela de Periodicidades
Tipo Descrição
D Diária
Cíclica - Diária com
I execução em intervalos
pré-definidos.
W Semanal
E Eventual
C Decendial
;
Padrão para Documentação de Procedures GPROM6 131029 Página 29 de 41
PROCESSO DE DESENVOLVIMENTO DE APLICATIVOS
Padrão para Documentação de Procedures
Q Quinzenal
M Mensal
B Bimestral
T Trimestral
U Quadrimestral
S Semestral
A Anual
3.2 Tabela de Sites de Processamento
Sigla Descrição
BR Produção - Sysplex-1
B2 Produção - Sysplex-2
RJ Produção - Rio
DS Desenvolvimento
HM Homologação - Sysplex-1
;
Padrão para Documentação de Procedures GPROM6 131029 Página 30 de 41
PROCESSO DE DESENVOLVIMENTO DE APLICATIVOS
Padrão para Documentação de Procedures
02. IDENTIFICACAO
APLICATIVO - SSS - NOME DO APLICATIVO CONFORME DPR
PROCEDURE - PSSSD999
03. FINALIDADE
GERACAO DO ARQUIVO XXXF101 CONTENDO A DEPENDENCIA SUBORDINADORA
POR DEPENDENCIA, ANO-MES E TOTALIZACAO.
;
Padrão para Documentação de Procedures GPROM6 131029 Página 31 de 41
PROCESSO DE DESENVOLVIMENTO DE APLICATIVOS
Padrão para Documentação de Procedures
A) SSSD999A:
EM BR E RJ, ANTES DA PSSSD999, EXECUTAR O JOB ABAIXO, QUE
TEM POR FINALIDADE FAZER UNLOAD DA TABELA XXX_YYY_ZZZ.
ESSE JOB NAO PODERAH SER EXECUTADO SIMULTANEAMENTE COM
O JOB SSSD999B.
//*-------------------------------------------------------------*
//SYS000A EXEC PGM=SYS000,
// PARM='&HLQ..SSS.SSSFXXX1.D&DTMOV.SS000101'
//*-------------------------------------------------------------*
//PDB2E999 EXEC PDB2E999,
// MEMBRO01=&MEMBRO01,
// A=&A,
// C=&C,
// CONS=,
// CREATOR=DB2SIS,
// CSTT=,
// DRCT=NO,
// HLQ=&HLQ,
// JOBNAME=&JOBNAME,
// OBJ=S1SSS001,
// OPCAO='NEW/RESTART',
// ORD=&ORDERID,
// S=&S,
// SHLV=,
// SHRL=,
// SIS=SSS,
// TABLE='XXX_YYY_ZZZ'
//*------------------------------------------------------------*
ONDE:
A - BR: A=G
RJ: A=2
C - BR: C=3
RJ: C=1
B) SSSD999B:
EM B2, RJ E HM, APOS O FIM NORMAL DA PSSSD999, EXECUTAR O
JOB ABAIXO, QUE TEM POR FINALIDADE FAZER LOAD
NA TABELA XXX_YYY_ZZZ.
//*-------------------------------------------------------------*
//PDB2E888 EXEC PDB2E888,
// MEMBRO01=&MEMBRO01,
// A=&A,
// CARDLIB=&CARDLIB,
// CONS=,
// CREATOR=DB2SIS,
// CSTT=,
// DIS=9,
// DRCT=NO,
// DSNREC=&HLQ..SIS.SISF999R.D&DTMOV..SS000101,
// HLQ=&HLQ,
// JOBNAME=&JOBNAME,
// LIB=&CICSLIB,
// NEW=99999,
// OBJ=S1SSS999,
// OPCAO='NEW/RESTART',
// ORD=&ORDERID,
// S=&S,
// SHLV=,
// SHRL=,
// SIS=SSS,
// SYSPUNCH=&HLQ..SIS.SISF999P.D&DTMOV..SS000101,
// TAB='XXX_YYY_ZZZ',
// TIPO=2
;
Padrão para Documentação de Procedures GPROM6 131029 Página 32 de 41
PROCESSO DE DESENVOLVIMENTO DE APLICATIVOS
Padrão para Documentação de Procedures
//*-------------------------------------------------------------*
//SYS0000A EXEC PGM=SYS000,
// PARM='&HLQ..SIS.SISF999P.D&DTMOV..SS000101'
//*-------------------------------------------------------------*
//SYS0000B EXEC PGM=SYS000,
// PARM='&HLQ..SIS.SISF999R.D&DTMOV..SS000101'
//*-------------------------------------------------------------*
ONDE:
A - B2: A=G
RJ: A=2
HM: A=G
S - B2: S=1
RJ: S=2
HM: S=3
;
Padrão para Documentação de Procedures GPROM6 131029 Página 33 de 41
PROCESSO DE DESENVOLVIMENTO DE APLICATIVOS
Padrão para Documentação de Procedures
;
Padrão para Documentação de Procedures GPROM6 131029 Página 34 de 41
PROCESSO DE DESENVOLVIMENTO DE APLICATIVOS
Padrão para Documentação de Procedures
24. RELATORIOS
A) RELATORIO: SSS777
TITULO: TRANSACOES REJEITADAS POR CLIENTE
CONTEUDO: QUANTIDADE DE REGISTROS GRAVADOS, REJEITADOS E
PERCENTUAL DE REJEICAO POR CLIENTE.
FORMULARIO: 0.30.300-0 NR. COPIAS: 1 SALTO: 6601
FREQUENCIA: DIARIA PROGRAMA:SSSP888
DESCARBONAR: NAO - SEPARAR: NAO - CORTAR: NAO
ARQUIVO: &HLQ..SSS.SSSF777A.D&DTMOV..SS000104
EH PERMITIDO REFAZIMENTO: SIM
FORMA DE REFAZIMENTO: FMT
DESTINATARIOS: AGENCIAS
FORMA DE DISPONIBILIZACAO: UTF, IRA E GDR.
CANAL1: 1AAAASSSSSNNNNN
B) RELATORIO: SSS888
TITULO: TRANSACOES ACEITAS POR CLIENTE
CONTEUDO: QUANTIDADE DE REGISTROS GRAVADOS, REJEITADOS E
PERCENTUAL DE REJEICAO POR CLIENTE.
FORMULARIO: 0.30.300-0 NR. COPIAS: 1 SALTO: 6601
FREQUENCIA: DIARIA PROGRAMA:SSSP888
DESCARBONAR: NAO - SEPARAR: NAO - CORTAR: NAO
ARQUIVO: &HLQ..SSS.SSSF888A.D&DTMOV..SS000104
EH PERMITIDO REFAZIMENTO: SIM
FORMA DE REFAZIMENTO: FMT
DESTINATARIOS: AGENCIAS
;
Padrão para Documentação de Procedures GPROM6 131029 Página 35 de 41
PROCESSO DE DESENVOLVIMENTO DE APLICATIVOS
Padrão para Documentação de Procedures
25. CARDLIB
SSSP999A - DESCRICAO EM TEXTO LIVRE DA COLUNA 17 ATE A COLUNA 70.
SSSP999B - DESCRICAO EM TEXTO LIVRE DA COLUNA 17 ATE A COLUNA 70.
SSSP999C - DESCRICAO EM TEXTO LIVRE DA COLUNA 17 ATE A COLUNA 70.
;
Padrão para Documentação de Procedures GPROM6 131029 Página 36 de 41
4.2 Exemplo por silo de aplicação
01. HISTORICO
VRS004-04/04/04-CCCCCCCC-(FULANO)-MOTIVO MOTIVO MOTIVO MOTIVO X
MOTIVO MOTIVO MOTIVO. X
CCCCCCCC-(CICRANO)-MOTIVO MOTIVO MOTIVO MOTIVO X
MOTIVO MOTIVO MOTIVO MOTIVO MOTIVO, X
MOTIVO MOTIVO MOTIVO MOTIVO MOTIVO. X
VRS003-03/03/03-CCCCCCCC-(BELTRANO)-MOTIVO MOTIVO MOTIVO MOTIVO
MOTIVO MOTIVO MOTIVO MOTIVO MOTIVO,
MOTIVO MOTIVO MOTIVO MOTIVO MOTIVO.
VRS002-12/02/02-CCCCCCCC-(BELTRANO)-MOTIVO MOTIVO MOTIVO MOTIVO
MOTIVO MOTIVO MOTIVO MOTIVO MOTIVO,
MOTIVO MOTIVO MOTIVO MOTIVO MOTIVO.
02/02/02-CCCCCCCC-(CICRANO)-MOTIVO MOTIVO MOTIVO MOTIVO
MOTIVO MOTIVO MOTIVO MOTIVO MOTIVO
MOTIVO MOTIVO MOTIVO MOTIVO MOTIVO.
VRS001-01/01/01-CCCCCCCC-(FULANO)-IMPLANTACAO.
02. IDENTIFICACAO
APLICATIVO - SSS - NOME DO APLICATIVO CONFORME DPR
PROCEDURE - PSSSD999
03. FINALIDADE
GERACAO DO ARQUIVO XXXF101 CONTENDO A DEPENDENCIA SUBORDINADORA
POR DEPENDENCIA, ANO-MES E TOTALIZACAO.
B) SSSD999B:
EM PRODUCAO E HOMOLOGACAO, APOS O FIM NORMAL DA PSSSD999,
EXECUTAR O JOB ABAIXO, QUE TEM POR FINALIDADE FAZER LOAD
NA TABELA XXX_YYY_ZZZ.
//*-------------------------------------------------------------*
//PDB2E999 EXEC PDB2E999,
// MEMBRO01=&MEMBRO01,
// A=&A,
// CARDLIB=&CARDLIB,
// CONS=,
// CREATOR=DB2SIS,
// CSTT=,
// DIS=9,
// DRCT=NO,
// DSNREC=&HLQ..SIS.SISF999R.D&DTMOV..SS000101,
// HLQ=&HLQ,
// JOBNAME=&JOBNAME,
// LIB=&CICSLIB,
// NEW=99999,
// OBJ=S1SSS999,
// OPCAO='NEW/RESTART',
// ORD=&ORDERID,
// S=&S,
// SHLV=,
// SHRL=,
// SIS=SSS,
// SYSPUNCH=&HLQ..SIS.SISF999P.D&DTMOV..SS000101,
// TAB='XXX_YYY_ZZZ',
// TIPO=2
//*-------------------------------------------------------------*
//SYS0000A EXEC PGM=SYS000,
// PARM='&HLQ..SIS.SISF999P.D&DTMOV..SS000101'
//*-------------------------------------------------------------*
//SYS0000B EXEC PGM=SYS000,
// PARM='&HLQ..SIS.SISF999R.D&DTMOV..SS000101'
//*-------------------------------------------------------------*
ONDE:
24. RELATORIOS
A) RELATORIO: SSS777
TITULO: TRANSACOES REJEITADAS POR CLIENTE
CONTEUDO: QUANTIDADE DE REGISTROS GRAVADOS, REJEITADOS E
PERCENTUAL DE REJEICAO POR CLIENTE.
FORMULARIO: 0.30.300-0 NR. COPIAS: 1 SALTO: 6601
FREQUENCIA: DIARIA PROGRAMA:SSSP888
DESCARBONAR: NAO - SEPARAR: NAO - CORTAR: NAO
ARQUIVO: &HLQ..SSS.SSSF777A.D&DTMOV..SS000104
EH PERMITIDO REFAZIMENTO: SIM
FORMA DE REFAZIMENTO: FMT
DESTINATARIOS: AGENCIAS
FORMA DE DISPONIBILIZACAO: UTF, IRA E GDR.
CANAL1: 1AAAASSSSSNNNNN
B) RELATORIO: SSS888
TITULO: TRANSACOES ACEITAS POR CLIENTE
CONTEUDO: QUANTIDADE DE REGISTROS GRAVADOS, REJEITADOS E
PERCENTUAL DE REJEICAO POR CLIENTE.
FORMULARIO: 0.30.300-0 NR. COPIAS: 1 SALTO: 6601
FREQUENCIA: DIARIA PROGRAMA:SSSP888
DESCARBONAR: NAO - SEPARAR: NAO - CORTAR: NAO
ARQUIVO: &HLQ..SSS.SSSF888A.D&DTMOV..SS000104
EH PERMITIDO REFAZIMENTO: SIM
FORMA DE REFAZIMENTO: FMT
DESTINATARIOS: AGENCIAS
FORMA DE DISPONIBILIZACAO: GDR E IRA
CANAL1: 1AAAASSSSSNNNNN
25. CARDLIB
SSSP999A - DESCRICAO EM TEXTO LIVRE DA COLUNA 17 ATE A COLUNA 70.
SSSP999B - DESCRICAO EM TEXTO LIVRE DA COLUNA 17 ATE A COLUNA 70.
SSSP999C - DESCRICAO EM TEXTO LIVRE DA COLUNA 17 ATE A COLUNA 70.