OneDrive

Descubra mais sobre o componente OneDrive e saiba como utilizá-lo na Digibee Integration Platform.

O OneDrive permite estabelecer uma conexão com o serviço OneDrive da Microsoft e habilita as seguintes operações: List, List Search, Pagination, Download, Download by File ID, Upload ou Delete.

Parâmetros

Dê uma olhada nas opções de configuração do componente. Parâmetros suportados por expressões Double Braces estão marcados com (DB).

Parâmetro	Descrição	Valor padrão	Tipo de dado
Account	Para o componente fazer a autenticação ao serviço do OneDrive é necessário usar uma account do tipo Oath 2 de provedor Microsoft com ao menos o escopo de "offline_access" e "Files.ReadWrite.All".	N/A	String
Operation	operação a ser executada (List, List Search, Pagination, Download, Download by File ID, Upload ou Delete).	Upload	String
Remote Directory (DB)	Diretório remoto base, que pode ser relativo (ex.: pub/tmp) ou absoluto (ex.: /root/pub). Este parâmetro aceita Double Braces.	folder	String
Page Size	Utilizado na operação List e List Search, se refere à quantidade de objetos retornados na busca.	N/A	Inteiro
Query	Presente na operação List Search. Esse parâmetro define o tipo de busca que será feito nos diretórios do OneDrive. Para saber mais sobre esse filtro, visite a documentação oficial Microsoft.	N/A	String
Next Page	Presente na operação Pagination.	N/A	String
File Name (DB)	Nome do arquivo ou caminho completo (full file path) para o arquivo (ex.: tmp/processed/file.txt). Este parâmetro aceita Double Braces.	local-test.pdf	String
Remote File Name (DB)	Nome do arquivo remoto ou caminho relativo (ex.: tmp/processed/file.txt) para o arquivo remoto. Este parâmetro aceita Double Braces.	test.pdf	String
File ID	Identificador único de um arquivo.	N/A	String
Fail On Error	Se a opção estiver habilitada, a execução do pipeline com erro será interrompida; do contrário, a execução do pipeline continua, mas o resultado vai mostrar um valor falso para a propriedade "success".	True	Booleano

Informação adicional sobre parâmetros

Se um componente OneDrive que estiver executando a operação List ou List Search gerar mais resultados do que o Page Size, então um segundo componente OneDrive ligado pode usar a operação Pagination e o parâmetro Next Page.

Isso pode ocorrer manualmente ou por meio de Double Braces. Exemplo: com {{ message. nextPage }}, mais resultados da operação anterior são carregados.

Fluxo de mensagens

Saída

Operações List e List Search

Ao executar um componente OneDrive utilizando as operações List e List Search, a seguinte estrutura de JSON será gerada:

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#users('user%40hotmail.com')/drive/root/children",
    "count": 5,
    "nextPage": "https://microsoft.graph/nextPage?token=Md",
    "value": [
        {
            "createdDateTime": "2010-10-07T23:25:28.99Z",
            "cTag": "adDpEOUMxOTZEMzdEMkQxNT42MzcyODc4NjU2Nzg0MDAwMUHDA",
            "eTag": "aRDlfdseMTk2RDRfdfDJEMTU5RSExEuMA",
            "id": "DXCC196D37D2D159E!161",
            "lastModifiedDateTime": "2020-06-26T16:42:47.84Z",
            "name": "Documentos",
            "size": 49378390,
            "webUrl": "https://1drv.ms/f/s!AGG4VLX3T6sHZgSE",
            "reactions": {
                "commentCount": 0
            },
            "createdBy": {
                "user": {
                    "displayName": "NAME",
                    "id": "d9c196d37d2d159e"
                }
            },
            "lastModifiedBy": {
                "user": {
                    "displayName": "NAME",
                    "id": "d9de396d37d2d159e"
                }
            },
            "parentReference": {
                "driveId": "d9c196d37d2d159e",
                "driveType": "personal",
                "id": "XCC196D37D2D159E!160",
                "path": "/drive/root:a_folder"
            },
            "fileSystemInfo": {
                "createdDateTime": "2010-10-07T23:25:28.99Z",
                "lastModifiedDateTime": "2010-10-07T23:25:28.99Z"
            },
            "folder": {
                "childCount": 6,
                "view": {
                    "viewType": "thumbnails",
                    "sortBy": "name",
                    "sortOrder": "ascending"
                }
            },
            "specialFolder": {
                "name": "documents"
            }
        }
    ]
}

• value[name]: nome da pasta ou arquivo.

• value[size]: tamanho em bytes.

• nextPage: url para carregar mais resultados (ver operação Pagination).

Operação Download

{
  "remoteDirectory": "REMOTE_DIRECTORY",
  "remoteFileName": "remoteFileName"
  "fileName": "file.ext",
  "success": true
}

• remoteDirectory: caminho do diretório remoto base (relativo ou absoluto).

• remoteFileName: caminho do arquivo remoto ou caminho relativo do arquivo remoto.

• fileName: nome do arquivo local.

• success: "true" se a operação sucedeu, "false" caso contrário.

Operação Download by File ID

{
  "fileId": "FILE_ID"
  "fileName": "file.ext",
  "success": true
}

• fileId: identificador único do arquivo.

• fileName: nome do arquivo local.

• success: "true" se a operação sucedeu, "false" caso contrário.

Operação Upload

{
    "remoteFileName": "remote_file.ext",
    "remoteDirectory": "Documents""fileName": "file.ext",
    "success": true
}

• remoteFileName: caminho do arquivo remoto ou caminho relativo do arquivo remoto.

• remoteDirectory: caminho do diretório remoto base (relativo ou absoluto).

• fileName: nome do arquivo local.

• success: "true" se a operação sucedeu, "false" caso contrário.

Operação Delete

{
    "fileId": "FILE_ID""success": true
}

• fileId: identificador único do arquivo.

• success: "true" se a operação sucedeu, "false" caso contrário.

A manipulação de arquivos dentro de um pipeline ocorre de forma protegida. Os arquivos ficam disponíveis em diretório temporário que somente o pipeline sendo executado tem acesso.

Leia o artigo Processamento de mensagens para entender como esse conceito funciona na Digibee Integration Platform.