com o mercado, para o futuro - manual do …...windows service (optional) e adicione o usuário de...

27
MANUAL DO SECURE CLIENT 07/11/2018 INFORMAÇÃO PÚBLICA

Upload: others

Post on 28-May-2020

0 views

Category:

Documents


0 download

TRANSCRIPT

Page 1: Com o mercado, para o futuro - MANUAL DO …...Windows Service (Optional) e adicione o usuário de serviço solicitado abaixo, esse usuário deverá ser administrador local da máquina

MANUAL DO SECURE CLIENT

07/11/2018 INFORMAÇÃO PÚBLICA

Page 2: Com o mercado, para o futuro - MANUAL DO …...Windows Service (Optional) e adicione o usuário de serviço solicitado abaixo, esse usuário deverá ser administrador local da máquina

MANUAL DO SECURE CLIENT

2 INFORMAÇÃO PÚBLICA

SUMÁRIO

1 APRESENTAÇÃO ........................................................................................ 3

2. OBJETIVO, APLICAÇÃO E DEFINIÇÕES .................................................... 4

A. OBJETIVOS ................................................................................................. 4

B. APLICAÇÃO ................................................................................................. 4

C. RESPONSABILIDADES ............................................................................... 4

D. CONFIGURAÇÃO DE HARDWARE E SISTEMA OPERACIONAL............. 5

3. INSTALAÇÃO ................................................................................................ 6

A. EXECUTANDO O INSTALADOR ................................................................. 6

4. ATIVAÇÃO DA LICENÇA ............................................................................ 12

A. SOLICITAÇÃO DA LICENÇA .................................................................... 12

B. APLICANDO A LICENÇA .......................................................................... 14

5. CONFIGURANDO OS ARQUIVOS ............................................................. 16

A. CRIAÇÃO DE SITE .................................................................................... 16

B. CONFIGURANDO OS DIRETÓRIOS DE ARQUIVOS ............................... 18

C. CONFIGURANDO TAREFA AGENDADA DE RECEPÇÃO DOS

ARQUIVOS ................................................................................................. 19

D. CONFIGURANDO TAREFA AGENDADA DE ENVIO DOS ARQUIVOS .. 22

6. CONTIGÊNCIA WEB ................................................................................... 25

A. ACESSO AO PORTAL WEB ..................................................................... 25

7. LOGS DA APLICAÇÃO ............................................................................... 26

Page 3: Com o mercado, para o futuro - MANUAL DO …...Windows Service (Optional) e adicione o usuário de serviço solicitado abaixo, esse usuário deverá ser administrador local da máquina

MANUAL DO SECURE CLIENT

3 INFORMAÇÃO PÚBLICA

1 APRESENTAÇÃO

Este manual apresenta às instituições que se relacionam com a B3 instruções

para a utilização do Secure Client.

O Secure Client utiliza tecnologia Secure Transport (software de troca de

arquivos) e tem como finalidade o envio e recepção de arquivos para a B3 de

forma ágil, interativa e monitorado.

O conteúdo deste manual destina-se aos gestores e funcionários das

instituições que estejam envolvidos com o assunto e contrataram o serviço.

O sistema disponibiliza funcionalidades que correspondem aos seguintes

capítulos:

• Objetivos, Definições e Normas: Orientações gerais aos usuários

quanto a utilização do sistema.

• Instalação, Acesso ao Sistema, Envio, Recepção e Configurações:

Orientações específicas sobre cada um dos assuntos.

Sempre que necessário a B3 divulgará aos usuários que receberam este manual

as atualizações com eventuais revisões nos capítulos.

Para auxílio na instalação do Secure Client, favor contatar o time de Suporte à

Negociação através do telefone (11) 2565-5000 opção 2 ou pelo e-mail

[email protected]

Page 4: Com o mercado, para o futuro - MANUAL DO …...Windows Service (Optional) e adicione o usuário de serviço solicitado abaixo, esse usuário deverá ser administrador local da máquina

MANUAL DO SECURE CLIENT

4 INFORMAÇÃO PÚBLICA

2. OBJETIVO, APLICAÇÃO E DEFINIÇÕES

A. OBJETIVOS

Orientar os usuários e/ou responsáveis do aplicativo das instituições

sobre:

• As etapas de instalação do aplicativo Secure Client;

• A utilização da funcionalidade de envio de arquivos do Secure

Client;

• A utilização da funcionalidade de recepção de arquivos do

Secure

Client;

• A utilização da funcionalidade de Agendamento do Secure

Client, que possibilita a automação de envio e recepção de

arquivos;

• Configuração do Secure Client para envio e recepção dos

arquivos do Line.

B. APLICAÇÃO

O manual se aplica às instituições que possuem relacionamento com

a B3 e que efetuam trocas de arquivo do Line, com formatos pré-

definidos e autorizados.

C. RESPONSABILIDADES

1.1 Usuário Externo

• Instalar o software e configurá-lo conforme descrito

neste documento.

• Formalizar contrato com a B3.

Page 5: Com o mercado, para o futuro - MANUAL DO …...Windows Service (Optional) e adicione o usuário de serviço solicitado abaixo, esse usuário deverá ser administrador local da máquina

MANUAL DO SECURE CLIENT

5 INFORMAÇÃO PÚBLICA

1.2 BM&FBOVESPA

• Disponibilizar versões atualizadas deste manual e

oferecer suporte técnico.

• Fornecer contrato, login de usuário privilegiado e

senha devidamente cadastrada.

D. CONFIGURAÇÃO DE HARDWARE E SISTEMA

OPERACIONAL

A configuração mínima necessária para a instalação e uso do Secure

Client deve ser:

• Mínimo de 500 MB de disco disponível para instalação.

• Mínimo 2GB, recomendado 4 GB de memória RAM.

• Sistema operacional Windows x86-32 ou x86-64 7/8/8.1/10 ou

Windows Server 2008/2008R2/2012/2012R2.

Page 6: Com o mercado, para o futuro - MANUAL DO …...Windows Service (Optional) e adicione o usuário de serviço solicitado abaixo, esse usuário deverá ser administrador local da máquina

MANUAL DO SECURE CLIENT

6 INFORMAÇÃO PÚBLICA

3. INSTALAÇÃO

A. EXECUTANDO O INSTALADOR

Descompacte o arquivo SecureClient_6.2.0_Install_win-

x86_BN861.zip no diretório local da estação ou servidor que será

instalado o sistema.

Executar o arquivo SecureClient_6.2.0_Install_win-x86_BN861.exe.

Clicar sobre o botão Next para continuar a instalação. Para cancelar a

instalação, basta clicar sobre o botão Cancel.

Page 7: Com o mercado, para o futuro - MANUAL DO …...Windows Service (Optional) e adicione o usuário de serviço solicitado abaixo, esse usuário deverá ser administrador local da máquina

MANUAL DO SECURE CLIENT

7 INFORMAÇÃO PÚBLICA

A tela License Agreement é de abertura da instalação do sistema. Ao

ser exibida, o Usuário deve ler o termo de uso e, caso concorde, deve

selecionar a opção “I Accept the terms of the License Agreement”.

Caso contrário, selecionar a opção de não aceitação para que a

instalação seja encerrada.

Ao aceitar o termo, clicar sobre o botão Next para continuar a

instalação.

Para cancelar a instalação, basta clicar sobre o botão Cancel.

Page 8: Com o mercado, para o futuro - MANUAL DO …...Windows Service (Optional) e adicione o usuário de serviço solicitado abaixo, esse usuário deverá ser administrador local da máquina

MANUAL DO SECURE CLIENT

8 INFORMAÇÃO PÚBLICA

Clique em Anyone who uses this computer para que qualquer

usuário que possua o login e senha do sistema, consiga operar.

Por padrão será instalado em:

C:\Program Files (x86)\Axway\SecureClient

Page 9: Com o mercado, para o futuro - MANUAL DO …...Windows Service (Optional) e adicione o usuário de serviço solicitado abaixo, esse usuário deverá ser administrador local da máquina

MANUAL DO SECURE CLIENT

9 INFORMAÇÃO PÚBLICA

Utilizar a versão da Java Virtual Machine instalada com a aplicação,

selecionando a opção Use Java Virtual Machine Installed with this

application.

Page 10: Com o mercado, para o futuro - MANUAL DO …...Windows Service (Optional) e adicione o usuário de serviço solicitado abaixo, esse usuário deverá ser administrador local da máquina

MANUAL DO SECURE CLIENT

10 INFORMAÇÃO PÚBLICA

Atenção, o usuário deverá sempre selecionar a opção Install

Windows Service (Optional) e adicione o usuário de serviço

solicitado abaixo, esse usuário deverá ser administrador local da

máquina.

Obs: o usuário definido no serviço deverá ser utilizado para abrir o

Secure Client diretamente logado no servidor ou por meio da opção

“run as”.

Page 11: Com o mercado, para o futuro - MANUAL DO …...Windows Service (Optional) e adicione o usuário de serviço solicitado abaixo, esse usuário deverá ser administrador local da máquina

MANUAL DO SECURE CLIENT

11 INFORMAÇÃO PÚBLICA

Logo após será apresentado um resumo da instalação.

Progresso da instalação.

Resumo final da instalação, com a informação de instalação realizada

com sucesso.

Page 12: Com o mercado, para o futuro - MANUAL DO …...Windows Service (Optional) e adicione o usuário de serviço solicitado abaixo, esse usuário deverá ser administrador local da máquina

MANUAL DO SECURE CLIENT

12 INFORMAÇÃO PÚBLICA

4. ATIVAÇÃO DA LICENÇA

A. SOLICITAÇÃO DA LICENÇA

Acessar o sistema a partir do ícone “Start Secure Client”

.

Page 13: Com o mercado, para o futuro - MANUAL DO …...Windows Service (Optional) e adicione o usuário de serviço solicitado abaixo, esse usuário deverá ser administrador local da máquina

MANUAL DO SECURE CLIENT

13 INFORMAÇÃO PÚBLICA

O sistema apresentará a tela de ativação no primeiro acesso, o

Usuário deverá clicar na opção License Activation Through Email.

Copiar o valor do HostID que será apresentado conforme tela abaixo.

Page 14: Com o mercado, para o futuro - MANUAL DO …...Windows Service (Optional) e adicione o usuário de serviço solicitado abaixo, esse usuário deverá ser administrador local da máquina

MANUAL DO SECURE CLIENT

14 INFORMAÇÃO PÚBLICA

Abrir solicitação de serviço por meio da ferramenta CSNET, com as informações

de HostID. Para sanar eventuais dúvidas sobre o processo de licenciamento do

Secure Client contatar a área de Desenvolvimento de Serviços no telefone

(11) 2565-7102.

B. APLICANDO A LICENÇA

Acessar o sistema a partir do ícone “Start Secure Client”.

.

O sistema apresentará a tela de ativação no primeiro acesso, o usuário

deverá clicar na opção License Activation Through Email.

Page 15: Com o mercado, para o futuro - MANUAL DO …...Windows Service (Optional) e adicione o usuário de serviço solicitado abaixo, esse usuário deverá ser administrador local da máquina

MANUAL DO SECURE CLIENT

15 INFORMAÇÃO PÚBLICA

Na tela seguinte o usuário deverá clicar em Browse e selecionar o

arquivo de licença LicenseFile.lic e clicar em Activate.

A tela abaixo será apresentada ao término da ativação do sistema.

Page 16: Com o mercado, para o futuro - MANUAL DO …...Windows Service (Optional) e adicione o usuário de serviço solicitado abaixo, esse usuário deverá ser administrador local da máquina

MANUAL DO SECURE CLIENT

16 INFORMAÇÃO PÚBLICA

5. CONFIGURANDO OS ARQUIVOS

A. CRIAÇÃO DE SITE

Acessar o sistema a partir do ícone “Start Secure Client”.

.

A tela principal do sistema será apresentada log em seguida, conforme

abaixo. Clique em Create a Site.

Page 17: Com o mercado, para o futuro - MANUAL DO …...Windows Service (Optional) e adicione o usuário de serviço solicitado abaixo, esse usuário deverá ser administrador local da máquina

MANUAL DO SECURE CLIENT

17 INFORMAÇÃO PÚBLICA

Preencha os campos conforme tabela de parâmetros abaixo, de

acordo com o ambiente que será configurado. É recomendado a criação

de até 10 sites por Secure Client.

Alias Procotol Host Port

mft-trade SSH FTP mft-trade.bvmfnet.com.br 10022

Page 18: Com o mercado, para o futuro - MANUAL DO …...Windows Service (Optional) e adicione o usuário de serviço solicitado abaixo, esse usuário deverá ser administrador local da máquina

MANUAL DO SECURE CLIENT

18 INFORMAÇÃO PÚBLICA

B. CONFIGURANDO OS DIRETÓRIOS DE ARQUIVOS

Criar diretórios no participante para envio e recepção dos arquivos

processados pelo alias cadastrado.

Entrar no prompt do MS-DOS e executar comandos abaixo:

=================================

Mkdir D:\BVMF\transfer\<alias>\receber

Mkdir D:\BVMF\transfer\<alias>\enviar

=================================

Caso tenha mais de um código da participante crie no molde abaixo:

=================================

Mkdir D:\BVMF\transfer\<alias>\[identificao_corretora]\receber

Mkdir D:\BVMF\transfer\<alias>\[identificao_corretora]\enviar

=================================

Page 19: Com o mercado, para o futuro - MANUAL DO …...Windows Service (Optional) e adicione o usuário de serviço solicitado abaixo, esse usuário deverá ser administrador local da máquina

MANUAL DO SECURE CLIENT

19 INFORMAÇÃO PÚBLICA

C. CONFIGURANDO TAREFA AGENDADA DE RECEPÇÃO DOS

ARQUIVOS

Clique em Schedule a Transfer para configurar o schedule de envio e

recepção dos arquivos.

Page 20: Com o mercado, para o futuro - MANUAL DO …...Windows Service (Optional) e adicione o usuário de serviço solicitado abaixo, esse usuário deverá ser administrador local da máquina

MANUAL DO SECURE CLIENT

20 INFORMAÇÃO PÚBLICA

Preencha os campos conforme tabelas abaixo, para criar o schedule

de recepção, caso tenha mais de uma identificação de corretora

apontar para o diretório de recepção em questão.

Campo Conteúdo

Job Name RECEBER-<alias>

Description Receber <alias>, <código da instituição> e <usuário>

Direction Download

Site <alias>

Save Directory D:\BVMF\transfer\<alias>\receber

Bandwidth Policy Normal Speed (default)

Page 21: Com o mercado, para o futuro - MANUAL DO …...Windows Service (Optional) e adicione o usuário de serviço solicitado abaixo, esse usuário deverá ser administrador local da máquina

MANUAL DO SECURE CLIENT

21 INFORMAÇÃO PÚBLICA

Clique em Add File or Folder.

Campo Conteúdo

File or Folder /RECEBER

Format Auto

Pattern All (*)

Transfer Move

Size

Schedule Recurrent (Minutely)

Start Date Data / hora de início da tarefa

Expiration Date Marcar Never Expires

Every 5 minutes

Ao final clique em Submit para iniciar a recepção.

Page 22: Com o mercado, para o futuro - MANUAL DO …...Windows Service (Optional) e adicione o usuário de serviço solicitado abaixo, esse usuário deverá ser administrador local da máquina

MANUAL DO SECURE CLIENT

22 INFORMAÇÃO PÚBLICA

D. CONFIGURANDO TAREFA AGENDADA DE ENVIO DOS

ARQUIVOS

Clique em Schedule a Transfer para configurar o schedule de envio dos

arquivos.

Preencha os campos conforme tabelas abaixo, para criar o schedule de envio,

caso tenha mais de uma identificação de corretora apontar para o diretório de

envio em questão.

Campo Conteúdo

Job Name ENVIAR -<alias>

Description Enviar <alias>, <código da instituição> e <usuário>

Direction Upload

Site <alias>

Page 23: Com o mercado, para o futuro - MANUAL DO …...Windows Service (Optional) e adicione o usuário de serviço solicitado abaixo, esse usuário deverá ser administrador local da máquina

MANUAL DO SECURE CLIENT

23 INFORMAÇÃO PÚBLICA

Upload Directory /ENVIAR

Bandwidth Policy Normal Speed (default)

Clique em Add File or Folder.

Campo Conteúdo

File or Folder D:\BVMF\transfer\<alias>\enviar

Rename To

Format Auto

Pattern All (*)

Transfer Move

Size

Schedule Recurrent (Minutely)

Start Date Data / hora de início da tarefa

Expiration Date Marcar Never Expires

Every 5 minutes

Page 24: Com o mercado, para o futuro - MANUAL DO …...Windows Service (Optional) e adicione o usuário de serviço solicitado abaixo, esse usuário deverá ser administrador local da máquina

MANUAL DO SECURE CLIENT

24 INFORMAÇÃO PÚBLICA

Ao final clique em Submit para iniciar o envio.

Caso a instituição possua mais de um código de participante,

execute esse procedimento, alterando usuário e senha da instituição

em questão.

Obs: Caso seja necessário editar uma Tarefa (Schedule) existente, é preciso

antes alterá-lo para o status de Canceled, após isso a mesma poderá ser

editada e resubmetida, caso contrário a tarefa ficará duplicada, uma com as

configurações antigas e outra com as novas configurações

Page 25: Com o mercado, para o futuro - MANUAL DO …...Windows Service (Optional) e adicione o usuário de serviço solicitado abaixo, esse usuário deverá ser administrador local da máquina

MANUAL DO SECURE CLIENT

25 INFORMAÇÃO PÚBLICA

6. CONTIGÊNCIA WEB

A. ACESSO AO PORTAL WEB

Tela exclusiva para o caso de indisponibilidade do Secure Client na

instituição.

Alias Host

mft-trade https://mft-trade.bvmfnet.com.br

Page 26: Com o mercado, para o futuro - MANUAL DO …...Windows Service (Optional) e adicione o usuário de serviço solicitado abaixo, esse usuário deverá ser administrador local da máquina

MANUAL DO SECURE CLIENT

26 INFORMAÇÃO PÚBLICA

7. LOGS DA APLICAÇÃO

Toda transferência realizada com sucesso no Secure Client, fica com o status

Finished na aba de Transfer Queue da aplicação. Além disso a tarefa original

permanece com o status To Begin e esse é o funcionamento normal da

aplicação.

Page 27: Com o mercado, para o futuro - MANUAL DO …...Windows Service (Optional) e adicione o usuário de serviço solicitado abaixo, esse usuário deverá ser administrador local da máquina

MANUAL DO SECURE CLIENT

27 INFORMAÇÃO PÚBLICA

Em caso de algum problema no envio/recepção dos arquivos, além do status da

tarefa indicar esse comportamento anômalo, é possível verificar os logs da

aplicação pela aba de Log, conforme abaixo.

Também é possível verificar as mesmas informações acimas diretamente nos

arquivos de log que se encontram no diretório:

%APPDATA%\axway\SecureClient\log\scheduler.txt

Abaixo segue um trecho desse arquivo log como exemplo: