Projetos do Workspace

Parent page: Altium On-Prem Enterprise Server

Altium Designer, em conjunto com o Workspace do Enterprise Server, oferece suporte para Workspace Projects. Os projetos do Workspace destinam-se à fase de desenvolvimento do ciclo de vida do projeto, simplificando a criação e o fluxo de trabalho contínuo para projetos com controlo de versões. O armazenamento centralizado sob o controlo do Workspace também permite que esta funcionalidade sirva de base para outros serviços colaborativos.

Alguns dos principais benefícios da utilização de projetos do Workspace são:

• Armazenamento simplificado. Não é necessário tomar decisões sobre localizações de armazenamento. As cópias de segurança e outros serviços básicos são assegurados.
• Base para funcionalidades colaborativas.
• Controlo de versões imposto.
• Vantagens de um sistema de comentários dedicado.
• Notificações e estado. O estado do documento, incluindo modificações locais, é visível para equipas de design inteiras.
• O design PCB concorrente funciona sem qualquer configuração complexa.
• Capacidade de partilhar uma vista interativa de um projeto, baseada em navegador e em modo só de leitura, com outros utilizadores, através do Web Viewer.
• Um conjunto de funcionalidades avançadas de controlo de versões, como uma vista interativa do histórico do projeto.

Do ponto de vista técnico, um projeto do Workspace é a combinação de meta-informação armazenada no Workspace do Enterprise Server com uma integração estreita com o serviço de Version Control do próprio Workspace. O fluxo de trabalho típico é o seguinte:

1. Um utilizador cria um novo projeto do Workspace através da caixa de diálogo Create Project do Altium Designer, convertendo um projeto local existente através da caixa de diálogo Make Available On Server, ou a partir da interface do navegador do Workspace (detalhada abaixo). Durante a criação, esse utilizador define o nome, a descrição e o repositório de design do projeto.
2. O acesso ao projeto é definido e gerido na interface do Workspace baseada em navegador, ou diretamente no Altium Designer.
3. Todos os colaboradores selecionam o projeto para o abrir (quer a partir do Altium Designer quer a partir da interface do navegador do Workspace), após o que este é automaticamente obtido como ficheiros de design.

Este documento analisa o trabalho com projetos através da interface de navegador do Workspace do Enterprise Server. Para obter informações sobre como trabalhar com projetos no seu software de design, consulte Trabalhar com Projetos.

Criar um Novo Projeto do Workspace

Existem três formas principais de criar um projeto do Workspace:

• Criação de um novo projeto a partir da interface do Workspace baseada em navegador, ou a partir do Altium Designer.
• Disponibilizar um projeto existente (um projeto local, ou um projeto local atualmente sob controlo de versões externo) ao Workspace, a partir do Altium Designer – isto é, converter um projeto local num projeto do Workspace. Consulte a página Disponibilizar um Projeto Existente no Workspace para saber mais.
• Clonar um projeto existente do Workspace através da interface do Workspace baseada em navegador, ou clonando um projeto a partir do painel Projects do Altium Designer.

Para criar um projeto do Workspace diretamente através da interface de navegador do Workspace:

1. Inicie sessão na interface e selecione a opção de menu Projects para aceder à página Designs . Quaisquer projetos criados anteriormente serão aqui listados.

2. Clique no botão no topo da página e depois na opção de menu Create Project para abrir a janela Create Project .

   Se existirem definições de processo ativas disponíveis para o tema de processo Project Creations – definidas no separador Project Creations da página Processes da interface de navegador do Workspace – então o menu do botão oferecerá esses processos como opções em vez da opção Create Project. Escolha a entrada necessária para invocar esse fluxo de processo.

3. A janela será inicialmente apresentada numa vista simplificada. Introduza o nome pretendido para o projeto, uma descrição (se necessário), e escolha um Project Template adequado no menu pendente Templates.

   O nome do projeto deve começar por, e pode conter, A-Z, a-z ou 0-9. São permitidos sublinhados, hífenes e espaços, mas estes últimos só podem ser usados no meio do nome (os espaços no início e no fim serão ignorados). Não pode utilizar as seguintes palavras: AUX, COM1-COM9, LPT1-LPT9, CON, NUL e PRN. Além disso, o nome não pode conter os seguintes caracteres: \ . / ? % * : | " < >.
4. Para aceder a mais controlos, clique no botão . Serão apresentados os seguintes campos:
   1. Parent Folder – utilize este campo para especificar onde deve ser criada a pasta do projeto na estrutura de pastas do Workspace. Por predefinição, será Projects\<ProjectName>. O caminho predefinido para novos projetos é especificado na página Admin – Settings – Projects da interface de navegador do Workspace.

   2. Repository – este campo listará todos os Repositórios de Design geridos através do serviço local de Version Control do Workspace e que lhe tenham sido partilhados para utilização. Escolha o repositório onde pretende armazenar o novo projeto e os respetivos ficheiros. Por predefinição, será selecionado o repositório Versioned Storage (baseado em Git).

      Se atualizou para o Enterprise Server a partir de tecnologia de servidor anterior e ainda tem a possibilidade de utilizar repositórios de design internos (SVN) e/ou externos (SVN/Git), será apresentado o campo Repository . Este lista todos os repositórios de design geridos através do serviço local de Version Control do Workspace e que lhe tenham sido partilhados para utilização. Escolha o repositório onde pretende armazenar o novo projeto e os respetivos ficheiros. Se for escolhido um repositório baseado em SVN, será apresentado o campo Repository Folder. Utilize este campo para especificar o nome da pasta dentro do repositório onde será alojado o projeto e os respetivos ficheiros associados. Por predefinição, este assumirá o nome do projeto.

Definição de um novo projeto do Workspace diretamente através da interface de navegador do Workspace.

Depois de definir o novo projeto conforme necessário, clique em – o novo projeto será criado. Voltará à lista de projetos ao nível do resumo, onde verá agora uma entrada para o projeto recém-criado.

Um projeto adicional do Workspace, criado através da interface de navegador.

Navegar pelos Projetos do Workspace

A listagem de projetos na página Projects da interface de navegador do Workspace inclui todos os projetos que lhe foram partilhados e oferece um conjunto de controlos para aceder a funcionalidades de gestão de projetos. Utilize o botão  para mudar a página para o modo de pré-visualização de projetos (mosaicos gráficos) e o botão para mudar a página para o modo de lista detalhada.

A página Designs da interface de navegador do Workspace – o centro de comando para trabalhar com os seus projetos do Workspace. Aqui é apresentado o modo de lista detalhada da página. Passe o rato sobre a imagem para ver o modo de pré-visualização de projetos.

As entradas de projeto da vista são automaticamente ordenadas por data de Last modified, com o projeto modificado mais recentemente a aparecer primeiro na lista. Clique no botão para alterar a ordenação para o Nome do projeto, e clique novamente para alternar entre ordem ascendente e descendente.

A vista em modo Lista () pode ser ordenada por Name, Author ou Date, utilizando o cabeçalho da coluna em cada caso. Clique uma vez para ordenar por ordem ascendente, clique novamente para ordenar por ordem descendente. As setas à direita do nome da coluna indicarão a direção de ordenação atualmente ativa.

A vista Projects disponibiliza dados Properties e Activities relacionados com o projeto selecionado, disponíveis no painel lateral direito da vista.

A informação do painel lateral inclui: Properties tab: Project – um resumo de alto nível do estado do projeto, incluindo a vista 3D da placa (quando existe um PCB disponível para o projeto). Shared With – os utilizadores e/ou funções que têm acesso ao projeto. Passe o cursor sobre uma entrada para ver o nome completo do utilizador/função. Parameters – metadados detalhados extraídos ou calculados a partir do próprio design do projeto. Clique no controlo Show More para expandir a lista completa. Releases – uma lista das versões do projeto por ordem cronológica. Clique numa entrada para abrir essa versão no Manufacturing Portal do Workspace. Activity separador – uma lista cronológica de eventos do projeto, tais como um Commit, Release, ou um fluxo de processo concluído associado ao projeto.

Para cada projeto, também são disponibilizadas as seguintes operações através dos botões no topo da vista (e detalhadas nas secções associadas que se seguem):

• Share – controlos de acesso para configurar as permissões de acesso ao projeto.
• Activities – acesso por menu às atividades de processo disponíveis para o projeto.
• Functions – acesso por menu às funções do projeto. Também disponível a partir do botão de um projeto selecionado quando está no modo Preview:
  • Open – abre o projeto na sua vista detalhada centrada em CAD. Equivalente a clicar (modo Preview) ou fazer duplo clique (modo List) numa entrada de nome de projeto.
  • Move – desloca o projeto para outra pasta principal dentro da estrutura de pastas do Workspace.
  • Edit – edita o projeto em termos do seu Name, Description e Workspace Parameters.
  • Clone – cria uma cópia idêntica do projeto com outro nome.
  • Watch/Unwatch – seguir/deixar de seguir a atividade de um projeto ao receber notificações relacionadas (atualizado, libertado, etc.) no separador Activitiy do projeto, e também por email se as Email Notifications estiverem ativadas.
  • Delete – remove a entrada do projeto movendo a sua estrutura e dados para o Workspace Trash, onde pode ser eliminado permanentemente do Workspace ou restaurado ao seu estado anterior.

Também está incluída uma funcionalidade de Search do projeto que pode filtrar a lista de projetos por um conjunto de propriedades como Nome, Autor, Descrição, etc. Introduza qualquer parte de uma cadeia de pesquisa no campo no topo da interface do navegador. A lista será atualizada para incluir apenas as entradas de projeto cujos atributos incluam a cadeia de pesquisa.

Para limpar o filtro da pesquisa, clique na entrada principal da página Projects no painel de navegação à esquerda, ou limpe o campo de pesquisa e prima Enter.

Exemplo de utilização da funcionalidade de pesquisa, neste caso para encontrar um projeto com base na sua Descrição.

Trabalhar com Pastas do Workspace

O Workspace também disponibiliza a capacidade de criar e gerir pastas de projeto dentro da estrutura do Workspace. Os projetos podem depois ser criados em qualquer pasta da hierarquia resultante ou movidos para ela.

Para criar uma nova pasta sob a pasta de nível superior (predefinida) Project, escolha a opção Create Folder no menu do botão . Na janela Create Folder seguinte, especifique o nome da nova pasta, a sua pasta principal e uma descrição opcional. Uma nova pasta é sempre criada sob a pasta atualmente selecionada, que se torna a sua pasta principal.

Abra uma pasta criada selecionando o respetivo título e navegue de volta na hierarquia usando o trilho de navegação acima.

Utilize as opções do menu para modificar os detalhes de uma pasta (Edit), deslocar a pasta para outra pasta principal (Move) ou remover a pasta da estrutura de pastas do Workspace (Delete). Ao mover uma pasta, selecione uma nova pasta principal na árvore hierárquica na janela Move folder <folder> to.

Carregar um Projeto

No Altium Designer, o comando Make Available on Server irá carregar um projeto local para o Workspace, onde passa a ser um projeto do Workspace sob o respetivo controlo de versões. Um processo equivalente pode ser realizado na interface do navegador do Workspace a partir da opção Upload Project disponível no menu do botão . Navegue até à pasta anfitriã de um projeto local e selecione-a para carregar esse projeto, por predefinição, para a pasta atualmente selecionada do Workspace, ou utilize a opção Change na lista Parent Folder das janelas Upload Project para selecionar uma localização alternativa na hierarquia de pastas.

Quaisquer ligações de controlo de versões existentes no projeto local são ignoradas, e o projeto carregado torna-se um projeto do Workspace totalmente controlado por versões – o projeto fonte local não é alterado de forma alguma.

Mover um Projeto

Para deslocar um projeto para uma pasta diferente do Workspace, selecione a opção Move nas opções do menu suspenso e selecione uma nova localização na hierarquia de pastas na janela Move project <project> to. Quando confirmado com o botão , o projeto selecionado passará então a estar alojado na pasta principal recentemente especificada.

Partilhar um Projeto do Workspace

Assim que um projeto estiver no Workspace, será necessário determinar que utilizadores podem efetivamente aceder a esse projeto. Isto é feito partilhando o projeto, ou melhor, configurando as suas permissões de acesso. Um projeto do Workspace é partilhado, por predefinição, com o seguinte:

• O Proprietário do projeto, que normalmente é o designer que o criou (ou o disponibilizou no Workspace): permissões de acesso totais (Leitura/Escrita).
• O grupo de funções Administrators: permissões de acesso totais (Leitura/Escrita).
• Todos os membros do Workspace: com acesso apenas de visualização.

As permissões predefinidas para novos projetos podem ser definidas/alteradas na página Admin – Settings – Projects da interface do navegador do Workspace. Note que ao Proprietário do projeto é inerentemente atribuída permissão para lhe aceder e, por isso, não está presente na lista.

A configuração das permissões de acesso pode ser realizada através da interface do navegador do Workspace, e também diretamente a partir do Altium Designer.

Para configurar o acesso a um projeto a partir da interface do navegador do Workspace, selecione a entrada do projeto na página Designs  (Projects no menu principal) e clique no botão para aceder à janela Share:<project> – ou na opção Share do menu associado a uma entrada de projeto. Isto disponibiliza todos os controlos necessários para partilhar o projeto com outros utilizadores ou grupos de utilizadores (Funções).

Com os projetos geridos centralmente no Workspace, partilhar com outros é simplesmente uma questão de gerir as permissões de cada projeto.

Na janela Share <project>:

• Um utilizador/função tem acesso de Leitura/Escrita quando a opção Can Edit está ativada. Se esta opção estiver desativada, terá apenas acesso de Leitura.
• Um projeto pode ser partilhado com todos os membros do Workspace com acesso apenas de leitura (Can View) ou de leitura/escrita (Can Edit) usando o menu suspenso da entrada Workspace Members na região Shared With.
• Para remover um utilizador/função existente do acesso partilhado a um projeto, clique na opção Remove no respetivo menu suspenso.

Aspetos a ter em conta:

• Por predefinição, todos os utilizadores do Workspace poderão ver o projeto. Se quiser restringir o acesso a um conjunto específico de utilizadores e/ou grupos, deve primeiro selecionar No access no menu suspenso da entrada Workspace Members .
• O proprietário de um projeto tem acesso permanente de Leitura/Escrita.
• Também pode partilhar uma ligação direta para o projeto. A ligação é obtida clicando no controlo Copy Link, na parte inferior da janela Sharing. A ligação é copiada para a área de transferência. Quando utilizada, fornece ao utilizador aplicável – quando permitido – acesso à página detalhada de gestão do projeto, cuja visão geral é apresentada na secção seguinte.

Atividades de Projeto do Workspace

O Workspace oferece a capacidade única de aplicar Process Workflows configuráveis a projetos do Workspace, de modo a executar tarefas específicas, como realizar revisões de design e criar novos projetos. Os processos e os respetivos Workflows subjacentes são criados e configurados por um administrador do Workspace e, quando ativados, ficam disponíveis para os utilizadores tanto do Altium Designer como da interface do navegador do Workspace.

► Consulte Creating & Managing Processes para mais informações.
► Consulte Performing Design Reviews para informações sobre estes processos no Altium Designer.

Na perspetiva do utilizador, os Process Workflows e os seus passos inerentes são considerados como Activities. As Atividades disponíveis podem ser invocadas pelos utilizadores, e os passos do respetivo workflow podem ser concluídos pelos utilizadores atribuídos como uma sequência de tarefas – disponíveis através da página Tasks.

Selecione o menu na página Designs (Projects) e escolha entre os Processos disponíveis para iniciar uma atividade para o projeto atualmente selecionado. Preencha os campos e opções necessários nas janelas de formulário do processo seguintes e, em seguida, inicie o processo (). Dependendo do Process Workflow que foi invocado, poderá ser necessário submeter um passo seguinte () para preparar os dados para revisão.

São então criadas Tarefas de Workflow para o utilizador, ou utilizadores, atribuídos à Atividade. Uma tarefa aplicável a um utilizador com sessão iniciada aparecerá na respetiva página Tasks, onde poderá ser executada para fazer avançar o Workflow para a fase seguinte.

Tenha em atenção que, quando uma Atividade foi atribuída a um Grupo de Funções – Engineers por exemplo – uma Tarefa relacionada fica disponível para todos os membros desse grupo, bem como para quaisquer utilizadores individuais que tenham sido atribuídos à Atividade – aqui, o utilizador Bruce (um membro da função Engineers). Nesses casos, qualquer um destes utilizadores pode concluir o passo de revisão e submeter o resultado ().

Funções de Projeto do Workspace

As operações funcionais associadas aos projetos estão disponíveis no menu na página Designs  e incluem a capacidade de abrir, mover, editar, clonar, seguir e remover um projeto do Workspace. O menu também está disponível no botão de uma entrada de projeto selecionada:

Abrir um Projeto

Selecione a opção Open no menu de uma entrada de projeto ou no menu superior para abrir um projeto na sua vista centrada em CAD e orientada para o fabrico – ou, quando estiver no modo Preview (), clique no nome do projeto. A vista fornece acesso a várias sub-vistas disponíveis no painel de navegação:

• Design – navegue e interaja com os documentos de design do projeto, inspecione as propriedades dos objetos e coloque comentários de revisão. A vista aplica-se à revisão atual (mais recente) do projeto e utiliza a interface Web Viewer.
• Supply – examine interativamente os dados de BOM em curso (WIP) extraídos dos documentos de design, incluindo entradas para dados de peças de Fabricante e Fornecedor derivados de um documento ActiveBOM preenchido do projeto.
• Releases – visualize informação resumida sobre todas as Releases do projeto atual, cada uma das quais pode ser aberta na vista Manufacturing Portal . Esta, por sua vez, fornece sub-vistas para os ficheiros do pacote da release, documentos de design e dados de fornecimento dessa release selecionada.
• Activities – visualize Process workflow Activities ativas ou concluídas que se aplicam ao projeto atual.
• History – percorra uma cronologia progressiva dos principais eventos relacionados com o projeto, incluindo a sua criação, commits, releases e clones. Sempre que ocorre um evento suportado associado ao projeto, esse evento é adicionado à cronologia como um bloco dedicado com várias ações suportadas, quando aplicável.

► Consulte Management of a Specific Project para mais informações.

Editar um Projeto

Para editar as propriedades de um projeto existente no Workspace, selecione a respetiva entrada na página Designs (Projects) e, em seguida, a opção Edit no respetivo menu ou no menu superior . Na janela Project Editing seguinte pode alterar o Name, Description do projeto e gerir entradas de Parameters do Workspace .

Clique no botão na janela Project Editing para mostrar dados adicionais de propriedades derivados do projeto e armazenados com o mesmo. Selecione o controlo Parameters para aceder e adicionar (), editar ou remover () pares Nome/Valor de parâmetros. Estes são guardados no Workspace com o projeto e podem ser utilizados como Special Strings no Altium Designer – com acesso a partir do painel Properties com um objeto de texto colocado selecionado no espaço de design. Em contrapartida, os parâmetros do tipo de projeto são guardados no ficheiro do projeto (*.PrjPcb) e podem ser editados no Altium Designer.

Clonar um Projeto

Para clonar (duplicar) um projeto existente do Workspace, selecione a respetiva entrada na página Designs (Projects) e, em seguida, a opção Clone no respetivo menu ou no menu superior . Utilize a janela Clone Project para definir o nome e a descrição do projeto clonado – por predefinição, será utilizado o nome do projeto original com o sufixo - Copy.

Clique no botão para mostrar campos de propriedades adicionais, que incluem a pasta principal de destino e informações do Repositório. A definição da pasta de destino corresponderá automaticamente ao nome do projeto, a menos que seja especificada manualmente ou atribuída a uma pasta principal existente diferente através da opção Change.

Um projeto pode ser clonado no Altium Designer a partir da opção Clone do menu  no Explorer panel, ou clicando com o botão direito no nome de um projeto no Projects panel e escolhendo a opção Clone no menu de contexto.

Depois de definir os campos conforme necessário, clique no botão para confirmar. O projeto original será clonado (duplicado) juntamente com os seus ficheiros e dados constituintes e será adicionado como uma nova entrada de projeto à listagem da página Projects.

Seguir um Projeto

Para 'seguir' – receber notificações relativas a – um projeto no Workspace, selecione a respetiva entrada na página Designs (Projects) e, em seguida, a opção Watch no respetivo menu ou no menu superior .

Quando segue (watch) um projeto, receberá notificações relacionadas com o projeto (tais como mensagens de commit, release e alteração de propriedades) no separador Activities no painel do lado direito da interface. O criador do projeto será automaticamente definido para seguir esse projeto. Quando ativado, o comando mudará para Unwatch – selecione-o para deixar de seguir o projeto e deixar de receber notificações de eventos relacionados com esse projeto.

Eliminar um Projeto do Workspace

Para eliminar (remover) um projeto existente do Workspace, selecione a respetiva entrada na página Designs (Projects) e, em seguida, a opção Delete no respetivo menu ou no menu superior . A ação é efetivamente uma “eliminação suave”, em que o repositório do projeto é movido para a área Trash do Workspace. Um projeto pode ser eliminado no Altium Designer utilizando a opção de menu  Delete no painel Explorer.

A partir dessa vista (selecione Trash no menu principal), a entrada do projeto pode ser removida completamente (Permanently Delete) ou a ação pode ser revertida (Restore). Tenha em atenção que o botão removerá todas as entradas (quando possível) armazenadas no Lixo do Workspace.