Integrando com McFile Widget

Uma maneira fácil de integrar o McFile é via Widget, uma ferramenta embutida que fornece funcionalidades de cadastro, busca e recuperação de documentos na própria interface do McFile. O Widget é processado dinamicamente em JavaScript e está abrigado em nossos servidores, o que nos permite enviar atualizações para você sem trabalho adicional de sua parte.

Demo do McFile Widget

Veja o McFile Widget em ação. Você precisará de sua chave de integração de usuário (key).

Colocando o McFile Widget na sua aplicação

Para começar, adicione o seguinte código na sua página.

<script data-main="https://my.mcfile.com/widget/js/McFileWidgetBoot" src="https://my.mcfile.com/widget/js/vendor/require.js"></script>

Iniciando, configurando e usando:

McFileWidget.ready(function(){                  
	var widget = McFileWidget.configure({
		key: '...', 
		beforeOpen: function() {},
		afterOpen: function() {},
		beforeClose: function() {},
		afterClose: function() {},
		save: function (docId, filesCount) {},
		error: function (code, message) {}
	});
	widget.open({
		width: '...',
		height: '...',
		action: '...',
		idCliente: '...', 
		idAssunto: '...', 
		idEvento: '...', 
		descEvento: '...',
		idEntidade: '...',
		idDocMcFile: '...',
		tipoDocumento: '...'
	});
});

Opções

Parâmetros de negócio para o McFile Widget. A coisa mais importante a notar é o atributo key. Este parâmetro identifica a conta do usuário ao se comunicar com McFile.

Nome do parâmetro      
Descrição
key                                    
Chave de integração do usuário. Campo obrigatório.

Eventos

Eventos de callback

Evento         
Descrição
beforeOpen()                               
Invocado antes da abertura do Widget
afterOpen()
Invocado após abertura do Widget
beforeClose() Invocado antes do Widget fechar
afterClose() Invocado após o Widget fechar
save(docId, filesCount) Invocado quando o formulário de documento foi salvo com sucesso ou houve alguma operação de inserção/exclusão/alteração de arquivos nele.
docId - Identificador do formulário de documento no McFile.
filesCount - Contagem atual dos arquivos anexados ao formulário de documento no McFile
error(code, message) Invocado quando há erro de integração
code - Identificador do erro.
message - Detalhes do erro

API

O McFile Widget pode ser controlado por meio de programação através dos métodos descritos nesta seção

Método         
Descrição
ready(handler)                               
O Widget não pode ser manipulado de modo seguro até estar pronto. O código incluído dentro do ready() somente será executado quando este status for alcançado.
handler - Função que será executada quando o Widget estiver pronto.
configure(options)
Configura o Widget com as opções fornecidas.
options - Objeto contendo as opções de configuração - Parâmetro obrigatório
open(options) Abre o Widget considerando as opções passadas.
options - Objeto contendo as opções de abertura:
    - width: Largura do Widget. Default: '100%'
    - height: Altura do Widget. Default: '85vh'
    - action: Tipo de operação. Possíveis valores: 'cadastrar', 'pesquisar' e 'exibir'. Default: 'cadastrar'
    - idCliente: Identificador do cliente.
    - idAssunto: Identificador do assunto.
    - idEvento: Identificador do evento de integração.
    - descEvento: Descrição do evento de integração
    - idEntidade: Identificador da entidade de integração.
    - idDocMcFile: Identificador do documento no McFile
    - tipoDocumento: Nome de um tipo qualquer de documento
setConfig(config) Define as opções de configuração do Widget.
config - Objeto contendo as configurações
getConfig() Retorna o objeto com as opções de configuração do Widget.
close() Fecha o Widget.