API di piattaforma > JamioPlug > JamioPlug ExternalDocument

Descrizione

I metodi del JamioPlug ExternalDocument consentono di gestire file provenienti da sistemi documentali esterni alla piattaforma.

Per poter utilizzare il JamioPlug ExternalDocument è necessario configurarlo tramite risorsa di tipo configurazione, che deve avere valorizzate le proprietà come segue:

PlugName: ExternalDocument;

Name: Nome da assegnare alla configurazione;

ServiceName: AzureBlob;

Description: descrizione opzionale della configurazione;

Nickname: Nickname da assegnare alla configurazione. Per quanto riguarda i caratteri speciali ammessi:

•può contenere lettere maiuscole e minuscole dell'alfabeto inglese, numeri e i caratteri "-", "_", "."

•non è case-sensitive

•non può iniziare con uno dei caratteri "-", "_", "."

•non può terminare con "."

•non può contenere spazi

Se la configurazione viene creata mediate Jamio Admin Console, la valorizzazione di alcuni parametri viene eseguita implicitamente con la selezione del tipo di Configurazione da creare.

Le proprietà Explorable, Icon, AuthorizationScheme, TrustAllCertificates, ClientCerThumbprint, ClientCerPath, Fields non sono attualmente utilizzate dal plug ExternalDocument, quindi non devono essere specificate.

Sulle configurazioni è necessario estendere i permessi di Utilizzo per abilitare il consumo dei servizi agli utenti della piattaforma, accedendo a Jamio Admin Console nella sezione Configurazioni Plug e utilizzando l'azione Modifica permessi oppure progettando un processo che utilizza i metodi del servizio Jamio Service (AllowPlugConfigurationAccess, DenyPlugConfigurationAccess).

Metodi

•CreateDirectories

Crea una o più strutture gerarchiche di cartelle in una Configurazione di JamioPlug ExternalDocument, riutilizzando i nodi eventualmente già esistenti.

•CreateFileInFolderWithParentReference

Crea un file in una cartella individuata tramite il suo collegamento, con fallback tramite il percorso della cartella

•CreateFolderByParentFolderPath

Crea una cartella in una destinazione individuata tramite configurazione e percorso della cartella padre, con composizione opzionale del nome.

•CreateFolderByParentReference

Crea una cartella all'interno di un'altra padre, identificata tramite il suo collegamento, con fallback su percorso simbolico.

•CreateStream

Aggiunge un file ad una Configurazione di JamioPlug ExternalDocument.

•DeleteAllStreams

Elimina tutti i file relativi ad una Configurazione di JamioPlug ExternalDocument.

•DeleteFileByReference

Elimina un file individuato tramite il suo collegamento, con fallback tramite il percorso della cartella e nome del file.

•DocumentExists

Verifica quanti file corrispondono a configurazione, percorso e nome del file senza recuperarne il contenuto.

•FolderExistByFolderReference

Verifica l'esistenza di una cartella figlia a partire dal collegamento della cartella padre e il suo nome.

•FolderExistByPath

Verifica l'esistenza di una cartella o della root operativa attraverso configurazione e percorso simbolico.

•FolderExistByReference

Verifica se un collegamento ad una cartella identifica ancora la cartella originaria e, in caso contrario, usa il percorso simbolico come fallback.

•GetStreamReferences

Ottiene i collegamenti dei file corrispondenti a configurazione, percorso e nome file.

•MoveFileToFolderReferenceByReference

Sposta un file individuato tramite il suo collegamento verso una nuova cartella padre individuata tramite il suo collegamento.

•MoveFileToPathByReference

Sposta un file individuato tramite il suo collegamento verso una destinazione identificata da configurazione e percorso.

•ReadFileByFolderReference

Legge un file a partire dal suo nome e dal collegamento della cartella, usando il percorso della cartella come fallback.

•ReadFileByPath

Legge un file a partire dal suo nome, configurazione e percorso.

•ReadFileByReference

Legge un file a partire dal suocollegamento, usando il percorso della cartella e il nome del file come fallback.

•ReadFolderMetadataByReference

Legge i dati di puntamento e i metadati di business di una cartella identificata tramite il suo collegamento.

•RenameFileByReference

Rinomina un file individuato tramite il suo collegamento, con fallback tramite percorso della cartella e nome del file.

•RenameFolderByReference

Rinomina una cartella identificata tramite il suo collegamento e, se questa non è più valida, tramite percorso simbolico di fallback

•SetFileBusinessMetadataByReference

Imposta o aggiorna i metadati di business di un file individuato tramite il suo collegamento.

•SetFolderBusinessMetadataByReference

Aggiorna i metadati di business di una cartella identificata tramite il suo collegamento, con fallback sul percorso simbolico.

•UpdateFileByReference

Sostituisce il contenuto di un file individuato tramite il suo collegamento, usando il percorso della cartella e il nome del file come fallback.