Prticas e Padres FCA - SharePoint Server 2013

Prticas e Padres FCA de

desenvolvimento de Solues baseadas no
SharePoint Server 2013
Ultima reviso: 18/09/2015

Prticas e Padres FCA de desenvolvimento de Solues

baseadas no SharePoint Server 2013

Verso 1.1

Prticas e Padres FCA - SharePoint Server 2013

Sumrio
1.

Introduo ........................................................................................................................... 3

2.

Objetivo .............................................................................................................................. 3

3.

Ambiente............................................................................................................................. 3

4.

Pontos Importantes ............................................................................................................. 4

4.1.

Disponibilidade ............................................................................................................ 4

4.2.

Performance ................................................................................................................ 4

4.3.

Segurana ................................................................................................................... 4

4.4.

Solues ...................................................................................................................... 5

4.4.1.

Deploy das Solues ................................................................................................ 5

4.4.2.

Solues .................................................................................................................. 5

4.4.3.

Features ................................................................................................................... 6

5.

Melhores prticas................................................................................................................ 7

6.

Outras informaes............................................................................................................. 7

Prticas e Padres FCA de desenvolvimento de Solues

baseadas no SharePoint Server 2013

Verso 1.1

Prticas e Padres FCA - SharePoint Server 2013

1. Introduo
Devido as facilidades e benefcios gerados pelo Sharepoint, hoje temos vrios fornecedores
desenvolvendo aplicaes e portais para Sharepoint no ambiente da FCA. Por este motivo so
necessrias algumas padronizaes e melhores prticas que ajudam na manuteno e
disponibilidade das FARMs de Sharepoint.

2. Objetivo
O objetivo deste documento informar sobre alguns pontos importantes que devero ser
levados em considerao pelos fornecedores que desenvolvem aplicaes/portais para o
ambiente de SharePoint na FCA. O fornecedor deve atentar-se as informaes contidas neste
documento para que sua soluo possa ser aprovada para publicao nos ambientes de
Homologao e Produo.

3. Ambiente
O ambiente totalmente virtualizado e configurado de forma que os servios em produo
tenham alta disponibilidade.
Verses dos softwares instalados no ambiente de Homologao e Produo.
Sistema Operacional Windows Server 2012 R2 (Build 9600)
Banco de Dados SQL Server 2012 R2 SP2 Cumulative Update 5 (Build 11.0.5582)
Sharepoint Sharepoint 2013 SP1 + Cumulative Update Maio de
15.0.4719.1000)

2015 (Build

OBS.: Sempre que necessrio ser feita a atualizao dos softwares que envolvem a
infraestrutura do Sharepoint. imperativo que o ambiente de desenvolvimento do fornecedor,
quando utilizado, deva conter a mesma verso do SQL e do SharePoint para evitar quaisquer
incopatibilidade das solues.

Prticas e Padres FCA de desenvolvimento de Solues

baseadas no SharePoint Server 2013

Verso 1.1

Prticas e Padres FCA - SharePoint Server 2013

4. Pontos Importantes
4.1.

Disponibilidade

Todas as alteraes do ambiente so feitas atravs de Change pr-agendadas de

acordo com o processo de Change Management da FCA.
Atualizao de uma aplicao/portal, liberada pelo fornecedor ser aplicada
primeiramente no ambiente de homologao, ser testada e validada pela rea
solicitante. Logo aps todos os testes, ser
realizado o agendamento da
implementao no ambiente de Produo.
Alteraes (deploy de soluo global, Updatesolution, etc.) que implicam em paradas do
IIS, que iro afetar demais aplicaes/portais do ambiente de produo, sero
realizadas fora do horrio comercial.
O fornecedor sempre deve detalhar riscos e impactos de configuraes extras a serem
realizadas nos servidores de SharePoint (Ex.: Alteraes de Web.Config, criao de
mdulos, etc).

4.2.

Performance

Consultas de listas devero retornar no mximo 5000 items.

Caso seja necessria que uma lista tenha mais de 5000 items, necessrio que o
fornecedor indique quais so colunas mais importantes para o funcionamento da
aplicao/portal (mximo de 20 colunas). Essas colunas sero indexadas pela
administrao do SharePoint FCA.
Mximo de 8 Lookups por lista. (Veja na seo 5 Melhores Prticas, quando usar
Choice, lookup ou Taxinomia).

4.3.

Segurana

Os requisitos de segurana devero ser verificados no documento Requisitos de

Segurana para desenvolvimento de SW - v01 - 2012 01 12.pdf.

Prticas e Padres FCA de desenvolvimento de Solues

baseadas no SharePoint Server 2013

Verso 1.1

Prticas e Padres FCA - SharePoint Server 2013

4.4.

Solues

4.4.1. Deploy das Solues

Solues que so implementadas como Farm Solutions devem ser desenvolvidas
sempre no escopo Web Application.
Pacotes globais (Escopo Farm) devero ser analisados pela rea de arquitetura FCA e
devero ter uma justificativa da rea que est solicitando a aplicao.
Copia manual de arquivos (dll, rdlc, aspx e etc.) para diretrios do Sharepoint no
podero ser realizadas.
As solues que no estiverem de acordo com os padres de nomenclatura,
principalmente no que se refere ao nome do arquivo .wsp, ttulo e descrio de
Features, no sero disponibilizadas para validao do usurio (cliente final) at que
sejam corrigidas.
O fornecedor responsvel por enviar todo o procedimento de instalao da soluo,
contendo todos os passos detalhados no maior nvel possvel, de forma que qualquer
pessoa possa executar o procedimento. Ser disponibilizado um modelo de plano de
implementao ao fornecedor. Esse modelo deve ser preenchido e enviado junto com a
entrega.

4.4.2. Solues
As solues (arquivos .wsp) devem ser nomeadas conforme especificado abaixo :
<PRE>.<NOME_DA_EMPRESA>.<TIPO>.<PORTAL/APLICACAO
AFETADO>.<IDENTIFICACAO>
<PRE>: Sempre ser Fiat.
<NOME_DA_EMPRESA>: Identificao da empresa que desenvolveu a soluo de
forma reduzida/abreviada.
<TIPO>: Define o escopo da soluo. Usar FRM para solues de escopo Farm, e WEB
para usar solues de escopo Web Application.
<PORTAL/APLICACAO AFETADO>: Nome do Portal ou Aplicao que a soluo
direcionada.
Prticas e Padres FCA de desenvolvimento de Solues
baseadas no SharePoint Server 2013

Verso 1.1

Prticas e Padres FCA - SharePoint Server 2013

<IDENTIFICACAO>: Nome sugestivo da soluo.

Ex.: fiat.aaa.frm.backoffice.identificacao

4.4.3. Features
As features, acessadas pelas Configuraes de Sites/Recursos do Site Collection (ou
Recursos do Site) tambm devem seguir um padro de nomenclatura:
<NOME_DA_EMPRESA>.<PORTAL/APLICACAO AFETADO>.<IDENTIFICACAO>
<NOME_DA_EMPRESA>: Identificao da empresa que desenvolveu a soluo de
forma reduzida/abreviada.
<PORTAL/APLICACAO AFETADO>: Nome do Portal ou Aplicao que a soluo
direcionada.
<IDENTIFICACAO>: Nome sugestivo da soluo.
Observao: Todas as features devem ter uma descrio clara do que ela fornece ao
portal quando ativada.

Prticas e Padres FCA de desenvolvimento de Solues

baseadas no SharePoint Server 2013

Verso 1.1

Prticas e Padres FCA - SharePoint Server 2013

5. Melhores prticas
Abaixo seguem alguns links (em ingls) com as melhores prticas para desenvolvimento no
SharePoint Server 2013.
Obs.: altamente recomendvel que sejam desenvolvidos Apps SharePoint ao invs
de solues de Farm. Caso sejam desenvolvidas solues de Farms o fornecedor deve
fornecer uma justificativa, esta podendo ser contestada.
http://social.technet.microsoft.com/wiki/contents/articles/13373.sharepoint-2013-what-todo-farm-solution-vs-sandbox-vs-app.aspx - Quando usar farm solutions, sandbox
solutions e SharePoint apps.
http://social.technet.microsoft.com/wiki/contents/articles/13637.sharepoint-2013-bestpractices-choosing-the-best-client-api-for-an-app.aspx - Guia para ajud-lo a escoher a
melhor API no SharePoint Server 2013.
http://msdn.microsoft.com/en-us/library/jj164060(v=office.15).aspx Guia para escolher
a melhor Client API para sua soluo SharePoint Server 2013.
http://social.technet.microsoft.com/wiki/contents/articles/16343.sharepoint-2013-bestpractices-setting-up-a-dev-environment-for-windows-apps-and-sharepoint.aspx
Melhores prticas para montar um ambiente de desenvolvimento de SharePoint Apps.
http://msdn.microsoft.com/en-us/library/jj163230.aspx
Recursos para Apps no
SharePoint.

6. Outras informaes
Caso seja necessrio, o fornecedor responsvel pela soluo dever comparecer
fisicamente a FCA no momento do deploy da soluo.
Sempre que uma nova soluo estiver homologada e apta para ser colocada em
produo o fornecedor dever ter um responsvel que possa dar o suporte necessrio
para a equipe da FCA que ir executar o plano de deploy.
Sempre que atualizado, se necessrio este documento ser enviado para o fornecedor.

Prticas e Padres FCA de desenvolvimento de Solues

baseadas no SharePoint Server 2013

Verso 1.1