Exemplo de suplemento do SharePoint de carregamento de documentos em massa
Observação
O exemplo carrega um arquivo para uma biblioteca de documentos. Para carregar vários arquivos, será preciso estender o exemplo.
O suplemento de exemplo Core.BulkDocumentUploader usa um aplicativo do console para carregar arquivos usando chamadas da API REST. As definições da configuração são especificadas no XML e em um arquivo CSV.
Use esta solução se desejar:
- Carregar arquivos para o SharePoint Online.
- Migrar para o Office 365 e usar uma ferramenta de migração personalizada para mover seus arquivos.
Antes de começar
Para começar, faça o download do suplemento de exemplo Core.BulkDocumentUploader no projeto Padrões e Práticas de Desenvolvedores do Office 365 no GitHub.
Observação
The code in this article is provided as-is, without warranty of any kind, either express or implied, including any implied warranties of fitness for a particular purpose, merchantability, or non-infringement.
Antes de executar o exemplo de código, faça o seguinte:
Edite o arquivo OneDriveUploader.xml com as seguintes informações:
- O local onde você deseja salvar os arquivos de log CSV e texto.
- O caminho do arquivo para seu arquivo de mapeamento CSV (por exemplo, C:\PnP\Samples\Core.BulkDocumentUploader\Input\SharePointSites.csv).
- O local dos arquivos de política da empresa para carregamento (por exemplo, C:\PnP\Samples\Core.BulkDocumentUploader\Input\OneDriveFiles).
- Suas credenciais do SharePoint Online.
- A ação do documento para execução (carregar ou excluir).
- O novo nome de arquivo que será aplicado ao arquivo depois que o arquivo for carregado na biblioteca de documentos (por exemplo, DOCUMENTO POLÍTICA DA EMPRESA.xlsx).
No arquivo de mapeamento SharePointSites.csv, liste a URL da biblioteca de documentos para carregar arquivos e o nome do arquivo da política da empresa que será carregado.
Adicione o caminho do arquivo OneDriveUploader.xml como um argumento de linha de comando. Para fazer isso, abra as propriedades do projeto Core.BulkDocumentUploader no Gerenciador de Soluções e, em seguida, escolha Propriedades>Depurar.
Usar o suplemento de exemplo Core.BulkDocumentUploader
Do método Main em Program.cs, o método RecurseActions chama o método Run em OneDriveMapper.cs. O método Run obtém o local do arquivo que será carregado do SharePointSites.csv e chama o método IterateCollection.
public override void Run(BaseAction parentAction, DateTime CurrentTime, LogHelper logger)
{
CsvProcessor csvProcessor = new CsvProcessor();
logger.LogVerbose(string.Format("Attempting to read mapping CSV file '{0}'", this.UserMappingCSVFile));
using (StreamReader reader = new StreamReader(this.UserMappingCSVFile))
{
csvProcessor.Execute(reader, (entries, y) => { IterateCollection(entries, logger); }, logger);
}
}
O arquivo SharePointSite.csv lista um arquivo para carregamento e a biblioteca de documentos para o qual o arquivo será carregado. O método IterateCollection faz o seguinte para carregar o arquivo na biblioteca de documentos:
Obtém o arquivo para carregar.
Garante que o usuário tem permissões para adicionar itens.
Cria o objeto HttpWebRequest com o cookie de autenticação, a solicitação da cadeia de caracteres do REST para carregar o documento e o método de ação da solicitação HTTP.
Executa o carregamento do arquivo.
Observação
O nome do arquivo será substituído pelo valor de FileUploadName especificado em OneDriveUploader.xml.
public override void IterateCollection(Collection<string> entries, LogHelper logger)
{
Stopwatch IterationSW = new Stopwatch();
IterationSW.Start();
logger.LogVerbose(string.Format(CultureInfo.CurrentCulture, "Establishing context object to: '{0}'", entries[this.SiteIndex]));
try
{
// Use the context of the current iteration URL for current user item.
using (ClientContext context = new ClientContext(entries[this.SiteIndex]))
{
using (SecureString password = new SecureString())
{
foreach (char c in this.Password.ToCharArray())
{
password.AppendChar(c);
}
context.Credentials = new SharePointOnlineCredentials(this.UserName, password);
// Get the file to upload from the directory.
FileInfo theFileToUpload = new FileInfo(Path.Combine(this.DirectoryLocation + "\\", entries[this.FileIndex] + ".xlsx"));
logger.LogVerbose(string.Format(CultureInfo.CurrentCulture, "Attempting to {0} file {1}", this.DocumentAction, theFileToUpload));
// Ensure that the account has permissions to access.
BasePermissions perm = new BasePermissions();
perm.Set(PermissionKind.AddListItems);
ConditionalScope scope = new ConditionalScope(context, () => context.Web.DoesUserHavePermissions(perm).Value);
using(scope.StartScope())
{
Stopwatch tempSW = new Stopwatch();
tempSW.Start();
int success = 0;
while(tempSW.Elapsed.TotalSeconds < 20)
{
var digest = context.GetFormDigestDirect();
string cookie = ((SharePointOnlineCredentials)context.Credentials).GetAuthenticationCookie(new Uri(entries[this.SiteIndex])).TrimStart("SPOIDCRL=".ToCharArray());
using (Stream s = theFileToUpload.OpenRead())
{
// Define REST string request to upload document to context. This string specifies the Documents folder, but you can specify another document library.
string theTargetUri = string.Format(CultureInfo.CurrentCulture, "{0}/_api/web/lists/getByTitle('Documents')/RootFolder/Files/add(url='{1}',overwrite='true')?", entries[this.SiteIndex], this.FileUploadName);
// Define REST HTTP request object.
HttpWebRequest SPORequest = (HttpWebRequest)HttpWebRequest.Create(theTargetUri);
// Define HTTP request action method.
if (this.DocumentAction == "Upload")
{
SPORequest.Method = "POST";
}
else if (this.DocumentAction == "Delete")
{
SPORequest.Method = "DELETE";
}
else
{
logger.LogVerbose(string.Format(CultureInfo.CurrentCulture, "There was a problem with the HTTP request in DocumentAction attribute of XML file"));
throw new Exception("The HTTP Request operation is not supported, please check the value of DocumentAction in the XML file");
}
// Build out additional HTTP request details.
SPORequest.Accept = "application/json;odata=verbose";
SPORequest.Headers.Add("X-RequestDigest", digest.DigestValue);
SPORequest.ContentLength = s.Length;
SPORequest.ContentType = "application/octet-stream";
// Handle authentication to context through cookie.
SPORequest.CookieContainer = new CookieContainer();
SPORequest.CookieContainer.Add(new Cookie("SPOIDCRL", cookie, string.Empty, new Uri(entries[this.SiteIndex]).Authority));
// Perform file upload/deletion.
using (Stream requestStream = SPORequest.GetRequestStream())
{
s.CopyTo(requestStream);
}
// Get HTTP response to determine success of operation.
HttpWebResponse SPOResponse = (HttpWebResponse)SPORequest.GetResponse();
logger.LogVerbose(string.Format(CultureInfo.CurrentCulture, "Successfully '{0}' file {1}", this.DocumentAction, theFileToUpload));
logger.LogOutcome(entries[this.SiteIndex], "SUCCCESS");
success = 1;
// Dispose of the HTTP response.
SPOResponse.Close();
break;
}
}
tempSW.Stop();
if (success != 1)
{
throw new Exception("The HTTP Request operation exceeded the timeout of 20 seconds");
}
}
}
}
}
catch(Exception ex)
{
logger.LogVerbose(string.Format(CultureInfo.CurrentCulture, "There was an issue performing '{0}' on to the URL '{1}' with exception: {2}", this.DocumentAction, entries[this.SiteIndex], ex.Message));
logger.LogOutcome(entries[this.SiteIndex], "FAILURE");
}
finally
{
IterationSW.Stop();
logger.LogVerbose(string.Format(CultureInfo.CurrentCulture, "Completed processing URL:'{0}' in {1} seconds", entries[this.SiteIndex], IterationSW.ElapsedMilliseconds/1000));
}
}