SoftExpertAPI 1.2.12
dotnet add package SoftExpertAPI --version 1.2.12
NuGet\Install-Package SoftExpertAPI -Version 1.2.12
<PackageReference Include="SoftExpertAPI" Version="1.2.12" />
paket add SoftExpertAPI --version 1.2.12
#r "nuget: SoftExpertAPI, 1.2.12"
// Install SoftExpertAPI as a Cake Addin
#addin nuget:?package=SoftExpertAPI&version=1.2.12
// Install SoftExpertAPI as a Cake Tool
#tool nuget:?package=SoftExpertAPI&version=1.2.12
SoftExpertAPI
SoftExpertAPI é uma biblioteca que possui um conjunto de classes para abstrair a comunicação SOAP, REST com a API do SoftExpert SESuite e/ou via banco de dados para algumas implementações.<br> Esta biblioteca não está completa e será desenvolvida conforme necessidades e pedidos.
Direitos reservados a https://www.softexpert.com/
Documentação original: https://documentation.softexpert.com/en/integration/index.html
Documentação original nova versão: https://developer.softexpert.com/docs/data-integration/getting-started/platform-overview/
Meu email. hudsonventura@outlook.com
Obs.: Testado no SoftExpert 2.1.9.x e Oracle
Há exemplos funcionais no diretório Examples
Get Started
Instale os pacotes do Nuget
dotnet add package SoftExpertAPI
Importe os namespaces ...
using SoftExpert;
using SoftExpert.Workflow; //para o módulo de Workflow
using SoftExpert.Admin; //para o módulo de Administração
Crie uma instancia da API do módulo de Workflow SEM acesso a banco de dados
using SoftExpert;
using SoftExpert.Workflow;
string authorization = "Basic base64encode(DOMINIO\USUARIO:SENHA)"; //deve ser codificado em base64
string url = "https://se.dominio.com.br";
SoftExpertWorkflowApi wfAPI = new SoftExpertWorkflowApi(url, authorization);
Crie uma instancia da API do módulo de Administração COM acesso a banco de dados (necessário para muitas funcionalidades)
Necessário para as funções: listAttachmentFromInstance
<br>
Necessário a implementação de um banco de dados (IDatabase). Ver exemplo de implementação no arquivo Examples/ExampleOracleImplement.cs
. Podem ser implementados outros bancos de dados, desde que estes implementem a interface IDatabase
.
Esta biblioteca foi testada apenas no banco de dados Oracle, utilizando a implmentação do arquivo Examples/ExampleOracleImplement.cs
, mas implementando a interface IDatabase
você pode obter trabalhar normalmente.
string authorization = "Basic base64encode(DOMINIO\USUARIO:SENHA)"; //deve ser codificado em base64
string url = "https://se.dominio.com.br";
ExampleOracleImplement oracle = new ExampleOracleImplement(appsettings);
SoftExpertAdminApi adminAPI = new SoftExpertAdminApi(url, authorization, db: oracle);
Usando a API - Criando uma instancia de workflow
string ProcessID = "CCF"; //identificador do processo
string WorkflowTitle = "Teste de integração"; ; //titulo da instancia a ser criado
string UserID = "00000000000"; //matricula do usuario
try
{
string WorkflowIDCreated = wfAPI.newWorkflow(ProcessID, WorkflowTitle, UserID);
}
catch (SoftExpertException erro)
{
Console.WriteLine($"Este tipo de erro é um erro retornado pela API do SoftExpert. Quando ele for lançado, significa que a comunicação com o servidor funcionou, mas você passou algum parametro que o SESuite não aceito. No 'erro.Message' há detalhes sobre o problema. Erro: {erro.Message}");
}
catch (Exception erro)
{
Console.WriteLine($"Este tipo de erro é um erro genérico, que provavelmente acontecerá em caso de falha de comunicação com o servidor. Erro: {erro.Message}");
}
Demais exemplos
Há mais exemplos nos arquivos Examples/WorkflowExamples.cs e no Examples/AdminExamples.cs.
Não se esquece de que se precisar de acesso ao banco de dados, implemente a interface IDatabase
como no exemplo Examples/ExampleOracleImplementation.cs
Funções do módulo de Workflow
NewWorkflow - Criar uma nova instância de um processo
CancelWorkflow - Cancelar uma instância
ChangeWorflowTitle ¹ - Alterar o título de uma instância
ExecuteActivity - Executar uma atividade
NewAttachment - Anexar um novo arquivo no menu de anexos do lado esquerdo
listAttachmentFromInstance *¹ - Listar os arquivos de uma instância
EditEntityRecord - Editar os campos de um formulário
getFormData ¹ - Obter os dados (campos e valores) de um formulário
getFormSelectBox *¹ - Obter o valor de um selectbox de um formulário
getWorkFlowData *¹ -
GetFileFromOID *¹ - Onter um arquivo de um formlário
GetFileFromFormField *¹ -
NewChildEntityRecord - Criar um registro de uma grid
EditChildEntityRecord - Editar um registro de uma grid
ListGridItems ¹ - Listar os registros de uma grid do menu do lado esquerdo
Obs.:
( * ) - Itens já foram implementados mas ainda não possuem exemplos.
( ¹ ) - Itens necessitam de acesso a banco de dados, então precisarão da implementação da interface IDatabase
.
Funções do módulo de Administração
- enableUser ¹ - Ativar um usuário
- disableUser ¹ - Desativar um usuário
Obs.:
( * ) - Itens já foram implementados mas ainda não possuem exemplos.
( ¹ ) - Itens necessitam de acesso a banco de dados, então precisarão da implementação da interface IDatabase
.
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net6.0 is compatible. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
-
net6.0
- Newtonsoft.Json (>= 13.0.2)
- Newtonsoft.Json.Schema (>= 3.0.14)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
Version | Downloads | Last updated |
---|---|---|
1.2.12 | 83 | 4/24/2024 |
1.2.11 | 79 | 4/24/2024 |
1.2.10 | 98 | 3/20/2024 |
1.2.9 | 94 | 3/12/2024 |
1.2.8 | 95 | 3/4/2024 |
1.2.7 | 91 | 3/4/2024 |
1.2.6 | 89 | 3/4/2024 |
1.2.5 | 103 | 2/20/2024 |
1.2.4 | 91 | 2/20/2024 |
1.2.3 | 93 | 2/20/2024 |
1.2.2 | 90 | 2/20/2024 |
1.2.1 | 84 | 2/20/2024 |
1.2.0 | 93 | 2/20/2024 |
1.1.15 | 160 | 10/9/2023 |
1.1.14 | 115 | 10/9/2023 |
1.1.13 | 114 | 10/9/2023 |
1.1.12 | 119 | 10/9/2023 |
1.1.11 | 117 | 10/3/2023 |
1.1.10 | 117 | 10/3/2023 |
1.1.9 | 124 | 9/26/2023 |
1.1.8 | 113 | 9/19/2023 |
1.1.7 | 158 | 8/17/2023 |
1.1.6 | 129 | 8/17/2023 |
1.0.6 | 285 | 2/8/2023 |
1.0.5 | 254 | 2/8/2023 |
1.0.4 | 249 | 2/7/2023 |
1.0.3 | 417 | 5/18/2022 |
1.0.2 | 431 | 3/18/2022 |
1.0.1 | 400 | 3/18/2022 |
1.0.0 | 405 | 3/10/2022 |