Protheus :: Desvendando o sigapss.spf

Atendendo a uma reivindicação antiga, começarei a postar neste blog algumas dicas à respeito dos segredos do Protheus. E o primeiro artigo não poderia ser outro, senão sobre o misterioso sigapss.spf ( o arquivo de senhas do protheus ).

O sigapss.spf é a tabela que armazena os usuários do protheus e suas configurações. Não é um a tabela comum e, em função dessa característica, não pode ser aberta com a função dbUseArea(). Ela é um ctree SuperFile e, para que seja possível manipula-la ( incluir, excluir, alterar ou pesquisar registros ) faz-se necessário utilizar funções específicas para esse fim.

As funções a serem utilizadas são:

Internal Functions (Funcões da API ):

SPF_CanOpen(cSPFFile)->0||-1
SPF_Close(cSPFFile)
SPF_CopyTo(cSPFSource,cSPFTarget)
SPF_Delete(cSPFFile,nSPFRec)
SPF_GetFields(cSPFFile,SPFRec,@SPFId,@cSPFName,@cSPFPwd,@SPFDet)->0||-1
SPF_GoTop(cPswFile,nSPFOrder)
SPF_Insert(cSPFFile,cSPFId,cSPFuser,cSPFPassword,cSpFDet)
SPF_RecCount(cSPFFile,nSPFOrder)
SPF_Seek(cSPFFile,cSPFKeySeek,nSPFOrder) -> nSPFRec
SPF_Skip(cSPFFile,nSPFSkip,nSPFOrder)
SPF_Update(cSPFFile,@nSPFRec,cSPFId,cSPFName,cSPFPwd,cSPFDet)

Advpl Functions (Funções em ADVPL ):

PswEncript(cStrEncrypt,nType) -> cStrEncrypt || cStrDecrypt
Str2Array(cSPFDet,lEncrypt) -> aSPFDet
Array2Str(aSPFDet,lEncrypt) -> cSPFDet
PswOrder(nPswOrder)
PswSeek(cPswKey) -> lFound
PswRet(nType) -> aPswDet
PswRecno() -> nPswRecno
AllGroups() -> aPswGroups
AllUsers() -> aPswUsers
PswUsrGrp(cPswUserId,cPswGroupId) -> lPswUserInPswGroup

dentre outras...

Nosso primeiro exemplo será a inclusão de um novo usuário herdando as características de um usuário pré-existente. Então o primeiro passo é incluir um usuário no siga usando o módulo SIGACFG ( configurador ). Faz-se necessário, para que esse exemplo funcione, que o arquivo de senhas (sigapss.spf) esteja criado e pelo menos um usuário ( que não o Administrador ) esteja cadastrado. É altamente recomendado que todas as características do novo usuário sejam preenchidas, isso facilitará identificar cada uma delas dentro do Array com as configurações do usuário que iremos manipular.

Obs.: Utilizaremos o Protheus 10.2

Então mãos à obra.

Incluindo um usuário no Protheus:

No módulo SIGACFG acesse a opção conforme figura abaixo:

Programa: CFGX021 - Menu:SIGACFG.XNU

Opção do Menu: &Ambiente->&Usuário->Senhas->Senhas de Usuario

Inclua o usuário base. No nosso exemplo: Usuario.000001:

Defina as "Restrições" do usuário:

Defina as "Outras Informações" do usuário:

Defina o "Vínculo Funcional" do usuário:

Defina o "Grupo" do usuário:

Defina as "Empresas/Filiais" e os "Módulos" aos quais o usuário terá acesso:

Defina as "Restrições de Acesso" e os "Acessos":

Defina as "Preferências de Impressão":

E assim por diante. Quanto mais detalhes forem configurados para o Usuário base, mais detalhes poderemos identificar e Manipular no sigapss.spf.

Nesse exemplo, iremos utilizar como base as características do Usuario.000001 que, no nosso caso, por ser o primeiro usuário cadastrado, também possuirá o ID 000001. Incluiremos os usuários seqüencialmente e alteraremos algumas das características.

Agora vamos ao código:

Utilizaremos a IDE do Protheus para desenvolve-lo:

Definindo constantes com o Mapeamento
das Informações do usuário
(clique na imagem para ampliá-la)

Inserindo um novo usuário no sigapss.spf
(clique na imagem para ampliá-la)

Função para Obter um usuário válido
(clique na imagem para ampliá-la)

Para executar e depurar o programa utilize a IDE do Protheus conforme imagem abaixo:

Detalhes das informações do usuário retornado do sigapss.spf:

Para obter o código de exemplo completo clique aqui