Linha RM

Atalhos

Páginas filhas
  • Parametrização do GED - API de Parâmetros

Sumário


Objetivo

     Esse documento tem o objetivo de exemplificar o uso da API de Parâmetros para configurar o GED.

1 - Método

     Para configurar o GED será usada a API de Parâmetros. Nessa API, é necessário utilizar o filtro "group.name" para informar qual servidor de parâmetros a API irá utilizar para apresentar os parâmetros.

     O group.name para configurar o GED é: ConParametrosData.

  • A propriedade systemParameterId é composta pelo group.CustomData|parameterCode, onde group.CustomData é o parâmetro (HCPARAMETROS.NOMECOLUNA) e parameterCode é o campo a ser alterado do parâmetro.

     A tabela que armazena os dados do GED é a HCPARAMETROS. O filtro group.customData deve ser preenchido com o valor do campo HCPARAMETROS.NOMECOLUNA desejado. Veja alguns exemplos abaixo.

1.1 - GET

1.1.1 - Get All (Recuperar os parâmetros do GED)

1.1.1 GetAll

Configuração

Máscara de Url: http://{{dominio}}:{{port}}/api/framework/v1/systemParameters?group.name=ConParametrosData&group.customData={{parametro}}

Exemplo de Configuração

Domínio: localhost

Porta: 8051

Url's Utilizada: 

Exemplo de Resultado

Resultado (JSON)
{
    "hasNext": false,
    "items": [
        {
            "scope": "Company",
            "systemParameterId": "GED_SERVIDOR|HCPARAMETROS.NOMECOLUNA",
            "code": "HCPARAMETROS.NOMECOLUNA",
            "type": "String",
            "description": [
                {
                    "language": "pt-BR",
                    "descriptionText": "NomeColuna"
                }
            ],
            "value": [
                {
                    "language": "pt-BR",
                    "parameterValue": "GED_SERVIDOR"
                }
            ],
            "group": {
                "name": "ConParametrosData",
                "displayName": "Parâmetros do Sistema (RMSParamsServer)",
                "customData": "GED_SERVIDOR"
            }
        },
        {
            "scope": "Company",
            "systemParameterId": "GED_SERVIDOR|HCPARAMETROS.VALORSTR",
            "code": "HCPARAMETROS.VALORSTR",
            "type": "String",
            "description": [
                {
                    "language": "pt-BR",
                    "descriptionText": "ValorStr"
                }
            ],
            "value": [
                {
                    "language": "pt-BR",
                    "parameterValue": "BHD050101858"
                }
            ],
            "group": {
                "name": "ConParametrosData",
                "displayName": "Parâmetros do Sistema (RMSParamsServer)",
                "customData": "GED_SERVIDOR"
            }
        },
        {
            "scope": "Company",
            "systemParameterId": "GED_SERVIDOR|HCPARAMETROS.VALORINT",
            "code": "HCPARAMETROS.VALORINT",
            "type": "Int32",
            "description": [
                {
                    "language": "pt-BR",
                    "descriptionText": "ValorInt"
                }
            ],
            "value": [
                {
                    "language": "pt-BR",
                    "parameterValue": 0
                }
            ],
            "group": {
                "name": "ConParametrosData",
                "displayName": "Parâmetros do Sistema (RMSParamsServer)",
                "customData": "GED_SERVIDOR"
            }
        },
        {
            "scope": "Company",
            "systemParameterId": "GED_SERVIDOR|HCPARAMETROS.TIPOCOLUNA",
            "code": "HCPARAMETROS.TIPOCOLUNA",
            "type": "String",
            "description": [
                {
                    "language": "pt-BR",
                    "descriptionText": "TipoColuna"
                }
            ],
            "value": [
                {
                    "language": "pt-BR"
                }
            ],
            "group": {
                "name": "ConParametrosData",
                "displayName": "Parâmetros do Sistema (RMSParamsServer)",
                "customData": "GED_SERVIDOR"
            }
        },
        {
            "scope": "Company",
            "systemParameterId": "GED_SERVIDOR|HCPARAMETROS.PACOTEPADRAO",
            "code": "HCPARAMETROS.PACOTEPADRAO",
            "type": "Int32",
            "description": [
                {
                    "language": "pt-BR",
                    "descriptionText": "PacotePadrao"
                }
            ],
            "value": [
                {
                    "language": "pt-BR",
                    "parameterValue": 0
                }
            ],
            "group": {
                "name": "ConParametrosData",
                "displayName": "Parâmetros do Sistema (RMSParamsServer)",
                "customData": "GED_SERVIDOR"
            }
        },
        {
            "scope": "Company",
            "systemParameterId": "GED_SERVIDOR|HCPARAMETROS.IDINTEGRACAO",
            "code": "HCPARAMETROS.IDINTEGRACAO",
            "type": "Int32",
            "description": [
                {
                    "language": "pt-BR",
                    "descriptionText": "IDIntegracao"
                }
            ],
            "value": [
                {
                    "language": "pt-BR",
                    "parameterValue": 0
                }
            ],
            "group": {
                "name": "ConParametrosData",
                "displayName": "Parâmetros do Sistema (RMSParamsServer)",
                "customData": "GED_SERVIDOR"
            }
        }
    ]
}


1.2 - POST

     Alguns parâmetros do GED são alterados pelo campo HCPARAMETROS.VALORSTR, outros devem ser armazenados no campo HCPARAMETROS.VALORINT. 

     Parâmetros a serem atualizados em HCPARAMETROS.VALORINT: 

  • GED_ATIVA_INTEGRACAO_FLUIG

  • GED_ATIVACERTIFICACAOVISAO

  • GED_COD_PASTA_RAIZ

  • GED_CODEMPRESA

  • GED_FLUXOAPROVACAOVISAO

  • GED_TIPOLOG

     Parâmetros a serem atualizados em HCPARAMETROS.VALORSTR: 

  • GED_COD_GRUPO_USUARIO
  • GED_MATRICULA
  • GED_PORTA
  • GED_PORTA_FTP
  • GED_SENHA
  • GED_SERVIDOR
  • GED_TIPO_PROTOCOLO

  • GED_USUARIO

  • GED_USERPASSWORD

1.2.1 - Post (Atualiza o valor de um parâmetro)

1.2.1 Post

Configuração

Máscara de Url: http://{{dominio}}:{{port}}/api/framework/v1/systemParameters

Exemplo de Configuração

Domínio: localhost

Porta: 8051

Url Utilizada: http://localhost:8051/api/framework/v1/systemParameters

Exemplo de Entrada

Resultado (JSON)
{
	"code": "HCPARAMETROS.VALORSTR",
	"value": [
	    {
	        "parameterValue": "BHD050101852"
		}
	],
	"group": {
		"name": "ConParametrosData",
		"displayName": "",
		"customData": "GED_SERVIDOR"
	}
}

Exemplo de Resultado Positivo

Resultado (JSON)
{
    "scope": "Company",
    "systemParameterId": "GED_SERVIDOR|HCPARAMETROS.VALORSTR",
    "code": "HCPARAMETROS.VALORSTR",
    "type": "String",
    "description": [
        {
            "language": "pt-BR",
            "descriptionText": "ValorStr"
        }
    ],
    "value": [
        {
            "language": "pt-BR",
            "parameterValue": "BHD050101852"
        }
    ],
    "group": {
        "name": "ConParametrosData",
        "displayName": "Parâmetros do Sistema (RMSParamsServer)",
        "customData": "GED_SERVIDOR"
    }
}

1.3 - PUT

1.3.1 - Put (Atualiza o valor do parâmetro)

1.3.1 Post

Configuração

Máscara de Url: http://{{dominio}}:{{port}}/api/framework/v1/systemParameters/{systemParameterId}

Exemplo de Configuração

Domínio: localhost

Porta: 8051

Id: GED_SERVIDOR|HCPARAMETROS.VALORSTR

Url Utilizada: http://localhost:8051/api/framework/v1/systemParameters/GED_SERVIDOR|HCPARAMETROS.VALORSTR

Exemplo de Entrada

Resultado (JSON)
{
	"code": "HCPARAMETROS.VALORSTR",
	"value": [
	    {
	        "parameterValue": "BHD050101853"
		}
	],
	"group": {
		"name": "ConParametrosData",
		"displayName": "",
		"customData": "GED_SERVIDOR"
	}
}