...
| Cloak |
|---|
| visible | true |
|---|
| title | Lista de webservices |
|---|
|
No startProcessClassic No quadro 1, é mostrado o comando necessário para criação de stubs de cada serviço disponível no Fluig. Webservices (WSDL) | Comando | ECMAttributionMecanismService | wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMAttributionMecanismService?wsdl | ECMBusinessPeriodService | wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMBusinessPeriodService?wsdl | ECMCardIndexService | wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMCardIndexService?wsdl | ECMCardService | wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMCardService?wsdl | ECMColleagueGroupService | wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMColleagueGroupService?wsdl | ECMColleagueReplacementService | wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMColleagueReplacementService?wsdl | ECMColleagueService | wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMColleagueService?wsdl | ECMCompanyService | wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMCompanyService?wsdl | ECMCustomFieldsService | wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMCustomFieldsService?wsdl | ECMDashBoardService | wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMDashBoardService?wsdl | ECMDataServiceService | wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMDataServiceService?wsdl | ECMDatasetService | wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMDatasetService?wsdl | ECMDocumentService | wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMDocumentService?wsdl | ECMFavoritesService | wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMFavoritesService?wsdl | ECMFolderService | wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMFolderService?wsdl | ECMGlobalParamService | wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMGlobalParamService?wsdl | ECMGroupService | wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMGroupService?wsdl | ECMOutstandingService | wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMOutstandingService?wsdl | ECMReportService | wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMReportService?wsdl | ECMSearchDocumentService | wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMSearchDocumentService?wsdl | ECMSignalService | wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMSignalService?wsdl | ECMTokenService | wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMTokenService?wsdl | ECMWorkflowEngineService | wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMWorkflowEngineService?wsdl | ECMWorkflowRoleService | wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMWorkflowRoleService?wsdl |
Quadro 1: Comandos para criação de stubs. |
...
| Cloak |
|---|
| visible | true |
|---|
| title | No quadro 8, é mostrado todos os métodos disponíveis na classe ColleagueService. |
|---|
|
createColleague | Cria um usuário. Método: createColleague(String username, String password, int companyId, ColleagueDto[] colleagues) Parâmetros: - username: login do usuário.
- password: senha do usuário.
- companyId: código da empresa.
- colleagues: usuários.
Retorno: String. Estrutura de retorno com sucesso
Estrutura de retorno com erro
| createColleaguewithDependencies | Cria um usuário com grupos e papéis. Método: createColleaguewithDependencies(String username, String password, int companyId, ColleagueDto[] colleagues, GroupDto[] grupos, WorkflowRoleDto[] papeis) Parâmetros: - username: login do usuário.
- password: senha do usuário.
- companyId: código da empresa.
- colleagues: usuários.
- grupos: grupos.
- papeis: papéis.
Retorno: String. Estrutura de retorno com sucesso
Estrutura de retorno com erro
| getColleague | Retorna um usuário. Método: getColleague(String username, String password, int companyId, String colleagueId) Parâmetros: - username: login do usuário.
- password: senha do usuário.
- companyId: código da empresa.
- colleagueId: matrícula do usuário.
Retorno: ColleagueDto[]. Atributos de Retorno: active adminUser maxPrivateSize colleagueName companyId defaultLanguage dialectID emailHtml gedUser login mail colleagueId menuConfig newsPublisher rowId usedSpace
| getColleagueByLogin | Retorna o usuário a partir do login. Método: getColleagueByLogin(String username, String password) Parâmetros: - username: login do usuário.
- password: senha do usuário.
Retorno: ColleagueDto[]. Atributos de Retorno: active adminUser maxPrivateSize colleagueName companyId defaultLanguage dialectID emailHtml gedUser login mail colleagueId menuConfig newsPublisher rowId usedSpace
| getColleagues | Retorna todos os usuários ativos. Método: getColleagues(String username, String password, int companyId) Parâmetros: - username: login do usuário.
- password: senha do usuário.
- companyId: código da empresa.
Retorno: ColleagueDto[]. Atributos de Retorno: active adminUser maxPrivateSize colleagueName companyId defaultLanguage dialectID emailHtml gedUser login mail colleagueId menuConfig newsPublisher rowId usedSpace
| getColleaguesMail | Retorna um usuário utilizando um e-mail. Método: getColleaguesMail(String username, String password, int companyId, String mail) Parâmetros: - username: login do usuário.
- password: senha do usuário.
- companyId: código da empresa.
- mail: e-mail do usuário.
Retorno: ColleagueDto[]. Atributos de Retorno: active adminUser maxPrivateSize colleagueName companyId defaultLanguage dialectID emailHtml gedUser login mail colleagueId menuConfig newsPublisher rowId usedSpace - volumeId
Estrutura de retorno com sucesso xml | getColleagueWithMap | Retorna uma mensagem informando se o usuário foi criado corretamente. Método: getColleagueWithMap(String colleagueXML, String username, String password) Parâmetros: - username: login do usuário.
- password: senha do usuário.
- colleagueXML: lista normalizada de documentos.
Retorno: String. | getGroups | Retorna os grupos que o usuário participa. Método: getGroups(String username, String password, int companyId, String colleagueId) Parâmetros: - username: login do usuário.
- password: senha do usuário.
- companyId: código da empresa.
- colleagueId: matrícula do usuário.
Retorno: GroupDto[]. Atributos de Retorno: companyId - groupDescription
groupId
| getSimpleColleague | Retorna o usuário. Método: getSimpleColleague(String username, String password) Parâmetros: - username: login do usuário.
- password: senha do usuário.
Retorno: ColleagueDto[]. Atributos de Retorno: active adminUser maxPrivateSize colleagueName companyId defaultLanguage dialectID emailHtml gedUser login mail colleagueId menuConfig newsPublisher rowId usedSpace
| getSummaryColleagues | Retorna todos os usuários ativos. Método: getSummaryColleagues(int companyId) Parâmetros: - companyId: código da empresa.
Retorno: ColleagueDto[]. Atributos de Retorno: active colleagueId colleagueName companyId maxPrivateSize rowId usedSpace
| removeColleague | Desativa um usuário. Método: removeColleague(String username, String password, int companyId, String colleagueId) Parâmetros: - username: login do usuário.
- password: senha do usuário.
- companyId: código da empresa.
- colleagueId: matrícula do usuário.
Retorno: String. Estrutura de retorno com sucesso
Estrutura de retorno com erro
| | activateColleague | Ativa um usuário. Método: activateColleague(String username, String password, int companyId, String colleagueId) Parâmetros: - username: login do usuário.
- password: senha do usuário.
- companyId: código da empresa.
- colleagueId: matrícula do usuário.
Retorno: String. Estrutura de retorno com sucesso
Estrutura de retorno com erro
| updateColleague | Altera um usuário. Método: updateColleague(String username, String password, int companyId, ColleagueDto[] colleagues) Parâmetros: - username: login do usuário.
- password: senha do usuário.
- companyId: código da empresa.
- colleagues: usuários.
Retorno: String. Estrutura de retorno com sucesso
Estrutura de retorno com erro
| updateColleaguewithDependencies | Altera um usuário com grupos e papéis. Método: updateColleaguewithDependencies(String username, String password, int companyId, ColleagueDto[] colleagues, GroupDto[] grupos, WorkflowRoleDto[] papeis) Parâmetros: - username: login do usuário.
- password: senha do usuário.
- companyId: código da empresa.
- colleagues: usuários.
- grupos: grupos.
- papeis: papéis.
Retorno: String. Estrutura de retorno com sucesso
Estrutura de retorno com erro
| validateColleagueLogin | Valida o acesso de um usuário no produto. Método: validateColleagueLogin(int companyId, String colleagueId, String password) Parâmetros: - companyId: código da empresa.
- colleagueId: matrícula do usuário.
- password: senha do usuário.
Retorno: String. Estrutura de retorno com sucesso
Estrutura de retorno com erro
|
Quadro 8: Métodos da ColleagueService.
|
...
| Cloak |
|---|
| visible | true |
|---|
| title | No quadro 24, é mostrado todos os métodos disponíveis na classe WorkflowRoleService. |
|---|
|
createWorkflowRole | Cria um papel no Fluig. Método: createWorkflowRole(String username, String password, int companyId, workflowRoleDto role) Parâmetros: - username: login do usuário.
- password: senha do usuário.
- companyId: código da empresa.
- role: papel que será criado.
Retorno: String. Estrutura de retorno com sucesso
Estrutura de retorno com erro
| deleteWorkflowRole | Exclui um papel do Fluig. Método: deleteWorkflowRole(String username, String password, int companyId, String roleId) Parâmetros: - username: login do usuário.
- password: senha do usuário.
- companyId: código da empresa.
- roleId: código do papel a ser excluído.
Retorno: String. Estrutura de retorno com sucesso
Estrutura de retorno com erro
| getWorkflowRole | Retorna um papel cadastrado no Fluig. Método: getWorkflowRole(String username, String password, int companyId, String roleId) Parâmetros: - username: login do usuário.
- password: senha do usuário.
- companyId: código da empresa.
- roleId: código do papel.
Retorno: WorkflowRoleDto. Atributos de Retorno: - companyId
- roleDescription
- roleId
| getWorkflowRoles | Retorna todos os papéis cadastrados no Fluig. Método: getWorkflowRoles(String username, String password, int companyId) Parâmetros: - username: login do usuário.
- password: senha do usuário.
- companyId: código da empresa.
Retorno: WorkflowRoleDto[]. Atributos de Retorno: - companyId
- roleDescription
- roleId
| updateWorkflowRole | Atualiza um papel no Fluig. Método: updateWorkflowRole(String username, String password, int companyId, workflowRoleDto role) Parâmetros: - username: login do usuário.
- password: senha do usuário.
- companyId: código da empresa.
- role: papel que será criado.
Retorno: String. Estrutura de retorno com sucesso
Estrutura de retorno com erro
|
Quadro 25: Métodos da WorkflowRoleService
|
<result> <item> <active>true</active> <adminUser>true</adminUser> <colleagueId>adm</colleagueId> <colleagueName>Administrador</colleagueName> <companyId>1</companyId> <defaultLanguage>pt_BR</defaultLanguage> <dialectId>PT_BR</dialectId> <ecmVersion>3.0.35.0</ecmVersion> <emailHtml>true</emailHtml> <gedUser>true</gedUser> <groupId>Informática</groupId> <login>adm</login> <mail>[email protected]</mail> <menuConfig>0</menuConfig> <passwd/> <rowId>0</rowId> <usedSpace>0.0</usedSpace> <volumeId>Default</volumeId> </item> </result>