importUser
Este método possibilita inserir/editar:
- Dados gerais de usuário;
- Relacionamento entre usuário Área/Função/Equipe/Grupo de Acesso;
- Relacionamento entre usuário e controlador de domínio;
Se o usuário já existir - matrícula já existente - as informações serão editadas e substituídas para as informações presentes na requisição.
- Caso seja inserido valor ‘1’ no atributo
UpdateTypeos atributos do tipo lista serão substituídos pelos presentes na requisição, caso nenhum valor ou 0 seja inserido, os valores serão adicionados aos já cadastrados no sistema.
Para a inserção de cada um destes itens é necessário seguir o padrão abaixo documentado.
| Classe Java | |
|---|---|
| Requisição | web/wwwroot/ws/java/administration/importUserRequestType.java |
| Retorno | web/wwwroot/ws/java/administration/importUserResponseType.java |
Requisição:
| Identificador | Requerido | Descrição |
|---|---|---|
| UserId | X | Matrícula do usuário. |
| UserName | X | Denominação do usuário. |
| UserLogin | X | Nome utilizado pelo usuário para entrar no sistema |
| UserPassword | X | Senha do usuário. |
| UserCounterSign | Contrassenha do usuário. | |
| UserLanguage | Informar código para idioma do usuário, conforme coluna "Código no banco de dados" da seção Localização, no documento Requisitos do Sistema | |
| IsActive | Usuário habilitado (1 - Habilitado, 0 - Desabilitado). | |
| IsEnabled | Usuário bloqueado (1 - Bloqueado, 0 - Desbloqueado). | |
| NumMaxConnections | Número máximo de conexões simultâneas do usuário. | |
| UserPhone | Telefone do usuário | |
| UserEmail | X | Endereço de e-mail do usuário. |
| LeaderId | Matrícula do usuário líder | |
| UserPhoto | Imagem do usuário em formato binário 64. | |
| UserDomainId | X¹ | Identificador único do usuário no controlador de domínio. |
| DomainId | X² | Identificador do domínio AD cadastrado no SoftExpert Suite no qual o usuário está vinculado. (Utilizado na sincronização de dados do usuário com Controlador de Domínio). |
| AccGroupIdArray | Lista de identificadores de grupo de acesso, separados por vírgula, caso queira se adicionar mais de um. | |
| RolPosIdArray | Lista de identificadores de área e função. Para cada item que representa área e função, deve ser representado como: area-identifier#department-identifier. Caso haja mais de um item, como área e função, deve-se separar por vírgula. | |
| TeamIdArray | Lista de identificadores de equipe separados por vírgula caso se queira adicionar mais de uma equipe. | |
| UpdateType | Definição de como as listas de valores dos parâmetros AccGroupIdArray, RolPosIdArray e TeamIdArray serão considerados na importação do usuário:▪ Ao salvar o usuário, quando informado 0, os valores informados nos parâmetros AccGroupIdArray, RolPosIdArray e TeamIdArray serão acrescentados aos valores já definidos em cadastro prévio do usuário;▪ Ao salvar o usuário, quando informado 1, os valores informados nos parâmetros AccGroupIdArray, RolPosIdArray e TeamIdArray substituirão os valores já definidos em cadastro prévio do usuário;Obs.: Caso o valor não seja informado, o sistema irá considerar 0 por padrão. |
- X¹ - Requerido se o campo
DomaindIdestiver preenchido. - X² - Requerido se o campo
UserDomaindIdestiver preenchido.
Para saber qual é o identificador do controlador do domínio você deve selecionar
o retorno da coluna OID da seguinte SQL:
select OID, * from ADAUTHLDAPCONFIG
Caso seja necessário fazer o vínculo do usuário com o AD via web service, recomendamos que seja desabilitada a sincronização de usuários. Para tal, basta acessar a tela Configuração -> Autenticação, ir na aba Opções Gerais e desmarcar a opção "Habilitar agendamento da sincronização".
Você só pode inserir ou editar um usuário de cada vez utilizando esse método. Isso significa que não é possível atualizar uma lista de usuários enviando uma única requisição.
Estrutura da requisição:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:admin">
<soapenv:Header/>
<soapenv:Body>
<urn:importUser>
<!--You may enter the following 19 items in any order-->
<urn:UserId>?</urn:UserId>
<urn:UserName>?</urn:UserName>
<urn:UserLogin>?</urn:UserLogin>
<urn:UserPassword>?</urn:UserPassword>
<!--Optional:-->
<urn:UserCounterSign>?</urn:UserCounterSign>
<!--Optional:-->
<urn:UserLanguage>?</urn:UserLanguage>
<!--Optional:-->
<urn:IsActive>?</urn:IsActive>
<!--Optional:-->
<urn:IsEnabled>?</urn:IsEnabled>
<!--Optional:-->
<urn:NumMaxConnections>?</urn:NumMaxConnections>
<!--Optional:-->
<urn:UserPhone>?</urn:UserPhone>
<!--Optional:-->
<urn:UserEmail>?</urn:UserEmail>
<!--Optional:-->
<urn:LeaderId>?</urn:LeaderId>
<!--Optional:-->
<urn:UserPhoto>cid:413971966625</urn:UserPhoto>
<!--Optional:-->
<urn:UserDomainId>?</urn:UserDomainId>
<!--Optional:-->
<urn:DomainId>?</urn:DomainId>
<!--Optional:-->
<urn:AccGroupIdArray>?</urn:AccGroupIdArray>
<!--Optional:-->
<urn:RolPosIdArray>?</urn:RolPosIdArray>
<!--Optional:-->
<urn:TeamIdArray>?</urn:TeamIdArray>
<!--Optional:-->
<urn:UpdateType>?</urn:UpdateType>
</urn:importUser>
</soapenv:Body>
</soapenv:Envelope>
Retorno:
| Identificador | Descrição |
|---|---|
| UserID | Matrícula do usuário cadastrado ou editado. |
| Status | Status da resposta da requisição. |
| Detail | Detalhes da requisição. |
| Código | Descrição |
|---|---|
| 59 | Idioma não suportado pela base de dados |
| 60 | Idioma inexistente |