> For the complete documentation index, see [llms.txt](https://ajuda.rnp.br/cafe/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://ajuda.rnp.br/cafe/pentaho/procedimentos-de-instalacao/tutorial-basico-apache-ds.md).

# Tutorial Básico Apache DS

Apache Directory Studio (ApacheDS) é uma ferramenta gráfica para manipulação de bases LDAP. O ApacheDS possui uma série de funcionalidade como por exemplo manipulação de entradas, atributos, arquivos LDIF, etc. Essa ferramenta é baseada na IDE Eclipse e possui versões para Linux, MacOS e Windows. O download pode ser feito através do seguinte link [**http://dire ctory.apache.org/studio/**](https://directory.apache.org/studio/) Neste tutorial básico serão apresentadas algumas das funcionalidades básicas desta ferramenta que serão úteis para o projeto E-AA.

#### Configuração Básica para Acesso a um Diretório LDAP

Para que o ApacheDS possa manipular um diretório LDAP deve-se inicialmente configurar o acesso a tal diretório na ferramenta. Para fazer tal configuração deve-se executar o seguinte roteiro:

1. Estando o ApacheDS em execução, clique em FILE > NEW. Expanda a o item LDAP Browser, selecione a opção LDAP Connection e clique em NEXT . A Figura 1 apresenta a tela descrita.

<figure><img src="/files/FqRLcXLQpsdhZPHY5cxG" alt=""><figcaption><p>Figura 1</p></figcaption></figure>

2. Tão logo a tela Network Parameter seja exibida informe um nome para esta conexão LDAP (campo Connection name), o endereço IP ou hostname do servidor LDAP (campo Hostname) e utilize os valores padrões para os campos porta (Port: 389) e método de encriptação (Encryption method: no encryption). A Figura 2 apresenta a tela descrita.

<figure><img src="/files/0UCsZYW7E3wsTRCjCu4V" alt=""><figcaption><p>Figura 2</p></figcaption></figure>

3. Uma vez preenchido os campos, clique sobre o botão Check Network Parameter a fim de verificar se existe conectividade entre o ApacheDS e o servidor LDAP. Se tudo ocorrer de forma adequada, será exibida uma tela conforma ilustrada na Figura 3. Clique sobre OK para fechar a tela e clique em NEXT na tela Network Parameter.

<figure><img src="/files/GdfWXzGTzephbdLudfti" alt=""><figcaption><p>Figura 3</p></figcaption></figure>

4. Na tela Authentication deverão ser preenchidos os campos relativos a autenticação no diretório LDAP. O método de autenticação deverá ser o padrão (Authentication Method: Simple Authentication), o Bind DN ou usuário deverá ser o administrador (i.e.: Bind DN or User: cn=admin,dc=cpd,dc=ufrgs,dc=br) já a senha deverá ser a senha do administrador informada durante a instalação do LDAP. A Figura 4 apresenta a tela descrita.

<figure><img src="/files/AhqP2WVwsbWHXsvn1P3l" alt=""><figcaption><p>Figura 4</p></figcaption></figure>

5. Uma vez preenchido os campos, clique sobre o botão Check Authentication a fim de verificar se existe a autenticação com o LDAP está correta. Se tudo ocorrer de forma adequada, será exibida uma tela conforma ilustrada na Figura 5. Clique sobre OK para fechar a tela e clique em NEXT na tela Au thentication.

<figure><img src="/files/LAqAqlQS1D9uCtgEY1AW" alt=""><figcaption><p>Figura 5</p></figcaption></figure>

6. Na tela Browser Options utilize os valores padrões e clique sobre NEXT. A Figura 6 apresenta a tela descrita.

<figure><img src="/files/g53Wl9a0XLweevEVmn1x" alt=""><figcaption><p>Figura 6</p></figcaption></figure>

7. Na tela Edit Options utilize os valores padrões e clique sobre FINISH. A Figura 7 apresenta a tela descrita.

<figure><img src="/files/uDdSQMVK8RjhdGbGSj5i" alt=""><figcaption><p>Figura 7</p></figcaption></figure>

8. Após seguir os passos anteriores a conexão ao Diretório LDAP estará configurada e será exibida uma tela conforma ilustrada na Figura 8.

<figure><img src="/files/RV90tn7vHgGbzhkgouVJ" alt=""><figcaption><p>Figura 8</p></figcaption></figure>

## Entradas

Entradas são tidas como a unidade básica na qual uma informação é armazenada em um diretório. Entradas representam objetos do mundo real e são compostas por uma coleção de atributos. A seguir será apresentado como fazer a manipulação básica de entradas através do ApacheDS. Vale lembrar que para realizar as tarefas a seguir presume-se que o ApacheDS já possua uma conexão configurada e ativa junto ao diretório LDAP.

#### Inserção de entrada

1. Para fazer a inserção de uma entrada, clique com o botão direito no mouse sobre algum item já existente no Diretório e selecione NEW > NEW ENTRY.
2. Na janela Entry Creation Method selecione a opção Create entry from scratch e clique sobre NEXT. A Figura 9 apresenta a ação descrita.

<figure><img src="/files/Ch6OV2XNHiPh1CraH7E2" alt=""><figcaption><p>Figura 9</p></figcaption></figure>

3. Na janela Object Classes selecione a(s) classe(s) de objeto(s) que irão compor a entrada. Para fazer a seleção, você deverá escolher um item presente na lista Avaliable Object Classes e depois clicar sobre Add. Feito isto, o referido item passará a compor a lista Selected Object Classes. Repita este processo até adicionar todas as classes de objetos necessárias. Clique sobre NEXT para avançar para próxima tela. A Figura 10 apresenta a tela descrita.

<figure><img src="/files/2QLltBct6MJipAucfIYz" alt=""><figcaption><p>Figura 10</p></figcaption></figure>

4. Na janela Distinguished Name deverá ser informado a entrada pai (Parent) bem como o RDN. Ao concluir a preenchimento desta janela clique em NEXT. Um exemplo desta configuração é apresentada na Figura 11.

<figure><img src="/files/djbvCfPgQuHU2nZ6aLw2" alt=""><figcaption><p>Figura 11</p></figcaption></figure>

5. Caso seja selecionada alguma classe de objeto que possua atributos de preenchimento obrigatório, estes serão exibidos na janela Attributes conforme ilustrado pela Figura 12. Para mudar o valor de algum atributo, clique sobre o campo Value na linha correspondente ao atributo em questão.

<figure><img src="/files/6RlM5vdmiPpMZRFocGTW" alt=""><figcaption><p>Figura 12</p></figcaption></figure>

6. Caso algum destes atributos seja uma senha, será exibida a tela Password Editor (conforme ilustrado pela Figura 13). Preencha o campo Enter new password e selecione o método de Hash SHA. Após clique em OK.

<figure><img src="/files/Pjjkb0FCXkYY7WuCEDK3" alt=""><figcaption><p>Figura 13</p></figcaption></figure>

7. Concluso o preenchimento dos atributos obrigatórios clique em FINISH.
8. Neste momento a entrada estará inserida no diretório LDAP.

#### Renomear entrada

A funcionalidade de renomear entrada é útil uma vez que se deseje alterar o nome de uma entrada já presente no diretório. O roteiro para renomear uma entrada é o seguinte:

1. Clique com o botão direito do mouse sobre a entrada e clique na opção Rename Entry.
2. Será exibida uma tela onde será possível alterar o RDN. Através desta alteração é que é possível renomear uma entrada. Altere o RDN para o novo nome da entrada e clique em OK. A Figura 14 apresenta a tela descrita.

<figure><img src="/files/vElTDcfA3fycaq94by6a" alt=""><figcaption><p>Figura 14</p></figcaption></figure>

3. Concluso este roteiro, a entrada estará renomeada.

#### Exclusão de entrada

A funcionalidade de exclusão de entrada é útil uma vez que se deseje excluir uma entrada presente no diretório. O roteiro para exclusão de uma entrada é o seguinte:

1. Clique com o botão direito do mouse sobre a entrada e clique na opção Delete Entry.
2. Será exibida uma tela solicitando a confirmação da exclusão e advertindo que eventuais entradas filho da entrada em questão também serão excluídas. Clique em OK para confirmar a exclusão. A Figura 15 apresenta a tela descrita.

<figure><img src="/files/A9bPOiGJgNrrakLN5mAr" alt=""><figcaption><p>Figura 15</p></figcaption></figure>

3. Concluso este roteiro, a entrada estará excluída.

## Atributos

Atributos contêm as informações sobre um dado objeto. Todo atributo deve possuir um tipo e pode ser multi-valorado. A seguir será apresentado como fazer a manipulação básica de atributos através do ApacheDS. Vale lembrar que para realizar as tarefas a seguir presume-se que o ApacheDS já possua uma conexão configurada e ativa junto ao diretório LDAP.

#### Inserção de atributo

1. Para fazer a inserção de um atributo, selecione a entrada a qual pertencerá o atributo e clique sobre o botão New Attribute conforme ilustrado na Figura 16.

<figure><img src="/files/ohtA6OcnCfb24s4otCde" alt=""><figcaption><p>Figura 16</p></figcaption></figure>

2. Na janela Attribute Type selecione o tipo de atributo a ser inserido e clique em FINISH conforme ilustrado na Figura 17.

<figure><img src="/files/CEeSUm3ODercTD1as4ql" alt=""><figcaption><p>Figura 17</p></figcaption></figure>

3. Ao retornar para a janela principal do ApacheDS, clique no campo VALUE e insira o valor do novo atributo conforme conforme ilustrado na Figura 18.

<figure><img src="/files/Cnu8rG5m7Oa6CxMWctND" alt=""><figcaption><p>Figura 18</p></figcaption></figure>

4. Concluso este roteiro, o atributo estará inserido.

### Edição de atributo

A edição de um atributo presta-se a alterar as caracteristicas de um atributo já existente e pode ocorrer de duas formas distintas

#### Valor do atributo

1. Para editar o valor do atributo clique sobre uma entrada e depois clique sobre o campo VALUE do atributo em questão, conforme já exemplificado através da Figura 18.
2. Concluso este roteiro, o valor do atributo estará editado.

#### Descrição do atributo

1. Para editar a descrição do atributo, ou seja, o tipo de atributo, clique com o botão direito do mouse sobre o atributo e clique na opção Edit Attribute Description.
2. Na janela Attribute Type selecione o novo tipo do atributo e depois clique em FINISH. Tal janela já foi ilustrada através da Figura 17.
3. Concluso este roteiro, a descrição do atributo estará editado.

#### Exclusão de atributo

A funcionalidade de exclusão de atributo é útil uma vez que se deseje excluir um atributo presente em uma entrada no diretório. O roteiro para exclusão de uma atributo é o seguinte:

1. Clique com o botão direito do mouse sobre o atributo e clique na opção Delete Value.
2. Será exibida uma tela solicitando a confirmação da exclusão. Clique em OK para confirmar a exclusão. A Figura 19 apresenta a tela descrita.

<figure><img src="/files/TgzswFMEL1kYgvARkjTr" alt=""><figcaption><p>Figura 19</p></figcaption></figure>

3. Concluso este roteiro, o atributo estará excluído.

## LDIF

LDIF é um formato de arquivo aceito pelo LDAP no qual pode ser descrito um conjunto de entradas ou sentenças de atualização. A seguir será apresentado como como executar LDIF já existentes através do ApacheDS.

1. Clique sobre o menu FILE > NEW
2. Expanda o item LDAP BROWSER, selecione o item LDIF FILE e clique em FINISH conforme ilustrado na Figura 20.

<figure><img src="/files/CfXAufQ61q7Dj1GsvT6x" alt=""><figcaption><p>Figura 20</p></figcaption></figure>

3. Feito isto, será exibida uma tela similar a da Figura 21.

<figure><img src="/files/kyQZzqCjWiGltE95Pc0w" alt=""><figcaption><p>Figura 21</p></figcaption></figure>

4. Clique sobre BROWSE... para selecionar o conexão ao LDAP conforme ilustrado na Figura 22. Clique sobre a conexão desejada e depois clique em OK.

<figure><img src="/files/b5Z4nLvxcL3GpwLJGpv8" alt=""><figcaption><p>Figura 22</p></figcaption></figure>

5. Na área de edição, insira o conteúdo do LDIF e posteriormente clique sobre o botão EXECUTE LDIF conforme ilustrado na Figura 23.

<figure><img src="/files/HIiH3i4Ss3DbvgKLXgtP" alt=""><figcaption><p>Figura 23</p></figcaption></figure>

6. Se tudo ocorrer corretamente, o LDIF será executado e o diretório sofrerá as modificações que constam no LDIF. No caso deste exemplo o LDIF prestava-se a inserção de uma entrada chamada ou=people. Como pode ser visto, a inserção de tal entrada ocorreu perfeitamente e pode ser visualizada na Figura 24.

<figure><img src="/files/4EqbjLSFKXCzkttW70PS" alt=""><figcaption><p>Figura 24</p></figcaption></figure>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://ajuda.rnp.br/cafe/pentaho/procedimentos-de-instalacao/tutorial-basico-apache-ds.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
