Conector CSV Genérico - Guia de Referência Passo a Passo (Prévia)

Este artigo descreve o conector CSV genérico. O artigo aplica-se aos seguintes produtos:

• Microsoft Identity Manager 2016 (MIM2016)

Para o MIM 2016, o Conector está disponível para download no Centro de Download da Microsoft.

Preparar os arquivos CSV de exemplo

Em um servidor que executa o Servidor de Sincronização do MIM, crie a pasta C:\GCSV e copie os seguintes arquivos CSV encontrados no Apêndice A – Arquivos CSV de exemplo para ele. Certifique-se de conceder à conta do Serviço de Sincronização do MIM permissões de leitura e gravação para essa pasta.

Copie o seguinte CSV para a pastaC:\GCSV\SCRIPTS:

• Arquivo CSV de usuários de exemplo (Users.csv)
• Arquivo CSV de grupos de exemplo (Groups.csv)
• Ficheiro CSV de Membros de Amostra (Members.csv)

Preparar os scripts de exemplo do PowerShell

Em um servidor que executa o Servidor de Sincronização do MIM, crie a pasta C:\GCSV\SCRIPTS e copie os scripts PowerShell de exemplo localizados no Apêndice B - Arquivos PowerShell de Exemplo nele. Certifique-se de que a conta de serviço de Sincronização do MIM tenha permissões apropriadas PowerShell ExecutePolicy para executar os scripts.

Copie os seguintes scripts do PowerShell para a pastaC:\GCSV\SCRIPTS:

• Exemplo de script de pré-importação (Pre-Import.ps1)
• Exemplo de script de pós-importação (Post-Import.ps1)
• Exemplo de script de pré-exportação (Pre-Export.ps1)
• Exemplo de script pós-exportação (Post-Export.ps1)

Criar um novo conector

A lista a seguir é uma visão geral de alto nível das etapas descritas neste guia. Para isso, uma conta com a função MIM Syncs Admin precisa ser usada para executar estas tarefas:

• Abra a janela Create New Management Agent (MA) a partir do MIM Sync Service Manager.
• Selecione o Conector CSV Genérico como o tipo de conector.
• Forneça o caminho do arquivo e o nome do arquivo CSV a ser importado ou exportado.
• Especifique a codificação de arquivo, o separador de valor, o separador de vários valores e o qualificador de texto para o arquivo CSV.
• Escolha se deseja usar os valores na primeira linha como campos de cabeçalho ou não.
• Selecione os tipos de objeto e atributos a serem importados ou exportados do arquivo CSV.
• Configure a partição, o perfil de execução e os detalhes de mapeamento para o MA.
• Forneça os caminhos de script e parâmetros para os scripts do PowerShell, se houver.
• Execute a MA para executar as operações de importação, sincronização ou exportação.
• Avalie os resultados.

Vamos começar!

Para criar um conector CSV genérico, em MIM Synchronization Service Manager selecione Management Agent e Create. Selecione o Generic CSV (Microsoft) Conector.

Forneça o nome do conector (por exemplo: CSV Genérico) e clique no botão Avançar.

Conectividade

A página de Conectividade contém os caminhos dos ficheiros onde o conector pode encontrar os ficheiros CSV de Utilizador, Grupos e Membros dos Grupos.

A imagem a seguir é um exemplo da página Conectividade:

A seguir está uma lista dos valores que devem ser fornecidos para as configurações nesta página:

Depois de verificar se as configurações correspondem aos valores fornecidos, clique no botão Avançar.

Capacidades

Esta página descreve os recursos do conector. Os recursos do conector GCSV são fixos e não podem ser modificados.

A seguinte imagem é um exemplo da página Capabilities:

Para obter uma descrição detalhada dessas configurações de recursos, consulte o Generic CSV Connector – Technical Reference Guide.

Depois de rever as configurações acima referidas, clique no botão Avançar.

Esquema 1 (Configurações de formato de arquivo CSV)

O Conector CSV Genérico (GCSV) utiliza três tipos de separadores (ou delimitadores) para delimitar e analisar campos CSV e seus valores: Separadores de Valor, Separadores de valores múltiplose qualificadores de texto . Para obter uma explicação mais detalhada desses tipos de delimitadores, consulte o Generic CSV Connector – Technical Reference Guide

Esta página contém as configurações de valor de caractere para esses delimitadores e o tipo de codificação que foi usado para criar o arquivo como CSV.

A imagem a seguir é um exemplo da página Schema 1 (Configurações de formato de arquivo CSV):

A seção a seguir é uma lista das configurações individuais:

• Usar cabeçalhos para descoberta de esquema: Se essa opção estiver selecionada, ela instrui o conector a ignorar o primeiro registro de cada arquivo CSV como um registro de dados e usá-lo como um registro de cabeçalho (ou seja, que tem os nomes de cada campo). Se essa opção não estiver selecionada, o conector dará um nome genérico a cada campo (por exemplo, Atributo1, Atributo2, etc.) e usará a primeira linha como um registro de dados.
• Separador de valores: Este caractere separa os campos (ou seja, valores) dos registros CSV. A vírgula (,) é o padrão, mas qualquer caractere alfanumérico que possa ser impresso é permitido.
• Separador de vários valores: Este tipo de separador é usado para delimitar os valores individuais de uma cadeia de caracteres de vários valores (por exemplo, endereços proxy) ou atributos de referência (por exemplo, subordinados). O padrão é um ponto-e-vírgula (;) mas qualquer caractere alfanumérico imprimível é aceitável.
• Qualificador de texto: Se um valor de cadeia de caracteres contiver caracteres que, de outra forma, seriam interpretados como delimitadores (por exemplo, como vírgulas), ele exigirá que o valor seja qualificado para que o analisador CSV possa interpretar corretamente a cadeia de caracteres como um único campo. As aspas duplas (") são o padrão, mas qualquer caractere alfanumérico que possa ser impresso é permitido.
• Codificação de arquivo: Esta configuração indica a codificação usada nos arquivos CSV adicionados na guia Conectividade. Certifique-se de que corresponde à codificação dos seus ficheiros CSV.

Esquema 2 (Configurações de Identidade e Campo de Referência)

O valor de âncora é um identificador exclusivo para um registro em um arquivo CSV. Diferencia um disco dos outros. O conector GCSV também usa esse valor para criar o nome distinguido (DN) que identifica exclusivamente o seu objeto de espaço de conector.

Nesta página, as configurações do atributo âncora são configuradas para cada um dos arquivos CSV listados na página Conectividade.

A imagem a seguir é um exemplo da página Schema 2 (Configurações de campo de identidade e referência).

Na tabela a seguir estão os valores individuais que devem ser atribuídos a cada uma das configurações nesta página:

Depois de verificar se as configurações correspondem aos valores fornecidos, clique no botão Avançar.

Esquema 3 (Configurações do esquema de atributos de ficheiro para utilizadores)

Esta página é usada para atribuir um tipo de dados a cada atributo no esquema do arquivo CSV dos Utilizadores e se estes podem ter mais de um valor.

A imagem a seguir é um exemplo da página do Esquema 3 de Atributos de Ficheiro de Utilizadores (Configurações de Esquema de Atributos de Ficheiro de Utilizadores).

Na tabela a seguir estão os valores individuais que devem ser atribuídos a cada uma das configurações nesta página:

Depois de verificar se as configurações correspondem aos valores fornecidos, clique no botão Avançar.

Esquema 4 (Configurações de esquema de atributo de arquivo de grupos)

Esta página é usada para atribuir um tipo de dados para cada atributo no esquema do arquivo CSV Grupos e se eles podem ter mais de um valor.

A imagem a seguir é um exemplo da página Schema 4 (Configurações de esquema de atributo de arquivo de grupos).

Na tabela a seguir estão os valores individuais que devem ser atribuídos a cada uma das configurações nesta página:

Depois de verificar se as configurações correspondem aos valores fornecidos, clique no botão Avançar.

Parâmetros globais (configuração de scripts do PowerShell)

Esta página permite a configuração de scripts do PowerShell que serão executados antes e/ou depois das operações de importação e/ou exportação. O valor desses parâmetros de entrada oferece uma oportunidade de executar uma ampla variedade de ações de pré e pós-processamento em seus registros de identidade, usuário e grupo.

A imagem a seguir é um exemplo da página Parâmetros Globais.

Na tabela a seguir estão os valores individuais que devem ser atribuídos a cada uma das configurações nesta página:

Depois de verificar se as configurações correspondem aos valores fornecidos, clique no botão Avançar.

Execução de scripts do PowerShell

O Conector GCSV executa cada script do PowerShell configurado em sua própria sessão e não fornece suporte para a passagem de variáveis entre a execução de scripts.

Além disso, o GCSV Connector executa o script do PowerShell dentro dos arquivos, não como um cmdlet. Isso significa que os parâmetros de entrada não podem ser passados para scripts adicionando-os ao final de suas instruções de caminho. Isso faz com que a execução do script falhe.

Se uma execução de script de pré-importação ou pré-exportação gerar uma exceção, para impedir a importação ou exportação de registros de Usuário ou Grupo processados incorretamente, o Conector GCSV abortará e interromperá a execução de todo o perfil de execução.

Da mesma forma, se uma operação pós-importação ou pós-exportação encontrar uma exceção, isso fará com que o status da operação falhe.

Os erros encontrados durante a execução do script do PowerShell serão registrados no *Event *Log' do servidor de Sincronização do MIM.

Parâmetro de entrada do PowerShell: OperationType

Embora não haja suporte para o uso de parâmetros de entrada, o Conector GCSV passa um parâmetro de entrada para a execução de cada script do PowerShell: OperationType.

A variável de entrada OperationType terá o valor Full ou Delta para mostrar o tipo de operação (por exemplo, Full Import, Delta Import, Full Export, (Delta) Export) que está sendo executada com o script. Esse valor permite que os scripts verifiquem se estão sendo executados em um contexto de importação/exportação completo ou delta e façam suas tarefas de pré ou pós-processamento de acordo.

Hierarquia de provisionamento

Porque os arquivos CSV não armazenam informações em uma estrutura hierárquica; o conector CSV genérico não suporta nenhuma configuração de provisionamento hierárquico.

A imagem a seguir é um exemplo da página Hierarquia de Provisionamento.

Depois de verificar se as configurações correspondem aos valores fornecidos, clique no botão Avançar.

Partições e Hierarquias

O Conector CSV Genérico cria um nome distinto (DN) exclusivo para cada registo de utilizador e grupo no seu espaço de conector, seguindo este formato LDAP:

CN=[ANCHOR_VALUE],Object=User|Group,O=CSV

A imagem a seguir é um exemplo da página Partições e Hierarquias.

Depois de verificar se as configurações correspondem aos valores fornecidos, clique no botão Avançar.

Tipos de objeto

O conector CSV genérico requer que pelo menos o tipo de objeto User seja especificado. A escolha do tipo de objeto Group é opcional.

A imagem a seguir é um exemplo da página Tipos de objeto.

Depois de verificar se as configurações correspondem aos valores fornecidos, clique no botão Avançar.

Atributos

Esta página exibe uma lista normalizada de todos os atributos em todos os esquemas de tipo de objeto selecionados.

A imagem seguinte é um exemplo da página Atributos.

Depois de verificar se as configurações correspondem aos valores fornecidos, clique no botão Avançar.

Âncoras

O Conector CSV Genérico não suporta o uso de âncoras complexas ou configurações de atributos de âncora que diferem da designação de campo ID de âncora do arquivo CSV do objeto correspondente. É por isso que os campos de seleção de âncora estão bloqueados. Para fazer uma alteração na designação do atributo âncora, retorne à página Esquema 2 (Configurações de Identidade e Campo de Referência).

A imagem a seguir é um exemplo da página Âncoras.

Depois de revisar as configurações padrão na página, clique no botão Avançar.

Filtros de conector

Este guia não fará uso de nenhuma configuração de filtro de conector. Esta seção está aqui para dar continuidade ao guia.

A imagem a seguir é um exemplo da página Connector Filters.

Depois de verificar as configurações padrão na página, clique no botão Avançar.

Regras de Junção e Projeção

Este guia não fará uso de nenhuma configuração de regras de junção e projeção. Esta seção está aqui para dar continuidade ao guia.

A imagem a seguir é um exemplo da página Regras de Junção e Projeção.

Depois de revisar as configurações padrão na página, clique no botão Avançar.

Fluxo de atributos

Este guia não fará uso de nenhuma configuração de regras de fluxo de atributo. Esta seção está aqui para dar continuidade ao guia.

A imagem a seguir é um exemplo da página Fluxo de Atributos.

Depois de verificar se as configurações correspondem aos valores padrão, clique no botão Avançar.

Desprovisionamento

Neste guia, não alteraremos as configurações de desprovisionamento padrão desse conector. Esta seção está aqui para dar continuidade ao guia.

A imagem a seguir é um exemplo da página Desprovisionamento.

Depois de verificar se as configurações correspondem aos valores padrão, clique no botão Avançar.

Criar um perfil de execução de importação completa

Um Perfil de Execução de Importação Completa é necessário para importar dados de identidade de Utilizador e Grupo a partir dos registos CSV para objetos no Espaço de Conector.

Use as seguintes etapas para criar um novo perfil de execução de importação completa:

• Volte para o Synchronization Service Manager.
• Selecione o agente de gerenciamento GCSV.
• Clique com o botão direito do mouse nele e escolha Configurar perfis de execução.
• Clique Novo Perfil.

A janela Configurar perfil de execução será exibida.

Nomeie o perfil de execução

Na página Nome do perfil, digite o nome Importação Completa

A imagem a seguir é um exemplo da página Perfil.

Depois de verificar se as configurações correspondem aos valores fornecidos, clique no botão Avançar.

Especificar tipo

Na página Etapa de Configuração, selecione o Tipo: Importação Completa.

A filtragem do conector opera da mesma forma no conector GCSV como em qualquer outro conector ECMA.

A imagem a seguir é um exemplo da página do filtro do conector .

Depois de verificar se as configurações correspondem aos valores fornecidos, clique no botão Avançar.

Tipo de configuração do agente de gerenciamento

Na página Tipo de Configuração do Agente de Gestão, verifique se a partição O=CSV está selecionada.

Deixe o restante das configurações em seus valores padrão. Clicar no botão Concluir criará o Perfil de Execução de Tarefas.

Validar resultados

Esta seção detalha as etapas necessárias para validar os resultados da criação de um novo Conector GCSV e da importação dos registros de Usuário e Grupo dos arquivos CSV de exemplo.

Executar importação completa

Depois de criar o perfil de execução, use as seguintes etapas para executar este novo perfil de execução de importação completa:

• Volte para o Synchronization Service Manager.
• Selecione o agente de gerenciamento GCSV.
• Clique com o botão direito do mouse sobre ele e escolha Executar.
• Selecione Importação Completa e clique no OK.

Validar resultados completos da operação de importação

Deve haver cinco (5) Adições com base no conteúdo dos Arquivos CSV de Exemplo:

A imagem a seguir é um exemplo dos resultados da importação bem-sucedida do conteúdo dos arquivos CSV de exemplo:

Examine o espaço do conector GCSV

Depois de criar o perfil de execução, siga os seguintes passos para executar este novo Perfil de Importação Completa:

• Volte para o Synchronization Service Manager.
• Selecione o agente de gerenciamento do conector GCSV .
• Clique com o botão direito do rato sobre ele e selecione Pesquisar no Espaço do Conector.
• Deixe o escopo com o seu valor padrão de Subárvore e clique no botão Pesquisa.

A imagem a seguir é um exemplo da janela Search Connector Space que aparecerá.

Validar objeto de usuário

Selecione um dos objetos de usuário para inspeção. A imagem a seguir é um exemplo do objeto de espaço do conector GCSV de um usuário:

O exame do campo DisplayName mostra como uma cadeia de caracteres qualificada foi analisada corretamente.

Clicar no botão dentro da entrada ProxyAddresses revela que a cadeia de caracteres de valores múltiplos também foi analisada corretamente em valores individuais.

Validar objeto de grupo

Selecionar um dos objetos de grupo para inspeção. A imagem seguinte é um exemplo de um objeto de espaço de conector GCSV de um grupo:

Clicar no botão dentro da entrada Membro revela como os registros de membros do arquivo de grupo de registros associados com o arquivo Membros foram carregados corretamente como membros:

Validar logs de execução do PowerShell

Os scripts PowerShell de exemplo fornecidos neste guia são projetados para adicionar uma entrada CSV a um log central para demonstrar sua execução bem-sucedida.

O local padrão para esse log é C:\GCSV\PS_Run_Ledger.csv.

A abertura do log revela:

"DateTime","Stage","Name","Type","Description"

"3/17/2024 1:05:44 PM","Pre","Import","Full","The Pre-Import PowerShell script was executed successfully."
"3/17/2024 1:05:46 PM","Pre","Import","Full","The Post-Import PowerShell script was executed successfully."

Esses dois registros indicam que os scripts PowerShell Pré-Importação e Pós-Importação foram executados com êxito. Observação O campo Tipo indica que esses scripts do PowerShell foram executados durante uma Importação Completa. Ele obtém esses valores do parâmetro de entrada OperationType PowerShell que indica se o script foi executado durante uma operação Full ou Delta.

Apêndice A - Arquivos CSV de exemplo

As seções a seguir contêm os arquivos CSV usados neste guia.

Arquivo CSV de usuários de exemplo

Na configuração do conector, este guia assume o nome do ficheiro USERS.CSV.

EmployeeID,DisplayName,AccountName,CountryCode,Manager,ProxyAddresses,IsActive,ProfilePic
E001,"Smith, John",JS001,1,,SMTP:john.smith@contoso.com;smtp:js001@contoso.com,True,SgBTADAAMAAxAA==
E002,"Doe, Jane",JD003,1,E001,SMTP:jane.doe@contoso.com;smtp:jd002@contoso.com,True,SgBEADAAMAAyAA==
E003,"Perez, Juan",JP003,1,E001,SMTP:juan.perez@contoso.com;smtp:jp003@contoso.com,False,SgBEADAAMAAyAA==

Arquivo CSV de grupos de exemplo

Na configuração do conector, este guia assume o nome do ficheiro de GROUPS.CSV.

GroupID,DisplayName,Description,Owner
G001,Test Group (G001),"This group is for teams A, B, and C",E002
G002,Test Group (G002),"This group is for teams D, E, and F",E003

Arquivo CSV de membros de exemplo

Na configuração do conector, este guia assume o nome de arquivo de MEMBERS. CSV.

ParentID,MemberID,ObjectType
G001,E001,USER
G001,E002,USER
G001,E003,USER
G002,E001,USER
G002,E002,USER
G002,E003,USER
G002,G001,GROUP
G003,E001,USER
G003,E002,USER
G003,E003,USER
G003,G001,GROUP

Apêndice B - Arquivos PowerShell de exemplo

Este apêndice contém o conjunto de scripts PowerShell de exemplo usados neste guia. As seções a seguir detalham algumas das considerações que devem ser feitas quando

Exemplo de script PowerShell de pré-importação

Na configuração do conector, este guia assume que o nome do ficheiro é PRE-IMPORT.PS1.

param ([string]$OperationType)

[string]$stage = "Pre"
[string]$operation = "Import"
[string]$filePath = "C:\GCSV\PS_Run_Ledger.csv"

# Create a new record
$record = [PSCustomObject]@{
    "DateTime" = (Get-Date).ToString()
    "Stage" = $stage
    "Type" = $OperationType
    "Name" = $operation
    "Description" = "The $stage-$operation PowerShell script was successfully executed before a $OperationType-$operation."
}

$record | Export-Csv -Path $FilePath -NoTypeInformation -Append

Exemplo de script PowerShell pós-importação

Na configuração do conector, este guia assume o nome do ficheiro POST-IMPORT.PS1.

param ([string]$OperationType)

[string]$stage = "Post"
[string]$operation = "Import"
[string]$filePath = "C:\GCSV\PS_Run_Ledger.csv"

# Create a new record
$record = [PSCustomObject]@{
    "DateTime" = (Get-Date).ToString()
    "Stage" = $stage
    "Type" = $OperationType
    "Name" = $operation
    "Description" = "The $stage-$operation PowerShell script was successfully executed after a $OperationType-$operation."
}

$record | Export-Csv -Path $FilePath -NoTypeInformation -Append

Exemplo de script PowerShell de pré-exportação

Na configuração do conector, este guia assume o nome do arquivo de PRE-EXPORT.PS1.

param ([string]$OperationType)

[string]$stage = "Pre"
[string]$operation = "Export"
[string]$filePath = "C:\GCSV\PS_Run_Ledger.csv"

# Create a new record
$record = [PSCustomObject]@{
    "DateTime" = (Get-Date).ToString()
    "Stage" = $stage
    "Type" = $OperationType
    "Name" = $operation
    "Description" = "The $stage-$operation PowerShell script was successfully executed before a $OperationType-$operation."
}

$record | Export-Csv -Path $FilePath -NoTypeInformation -Append

Exemplo de script PowerShell pós-exportação

Na configuração do conector, este guia assume o nome de arquivo de POST-EXPORT.PS1.

param ([string]$OperationType)

[string]$stage = "Post"
[string]$operation = "Export"
[string]$filePath = "C:\GCSV\PS_Run_Ledger.csv"

# Create a new record
$record = [PSCustomObject]@{
    "DateTime" = (Get-Date).ToString()
    "Stage" = $stage
    "Type" = $OperationType
    "Name" = $operation
    "Description" = "The $stage-$operation PowerShell script was successfully executed after a $OperationType-$operation."
}

$record | Export-Csv -Path $FilePath -NoTypeInformation -Append