Herramientas de usuario

Herramientas del sitio


ada:tips:sicoferp:general:pbtows:procesos:inventario:nominamaestros:tipocentrocosto

¡Esta es una revisión vieja del documento!


Maestro Tipos de Centros de Costos

Definición

Definición del Componente
Nombre n_ws05_tipo_ccosto
Descripción Gestiona el maestro de tipos de centro de costos
Proyecto PBws05_tipo_ccosto
Versión PB 12.5.1
URL SVNhttp://adacsc.co:1443/svn/repository/ADA/SICOF/SICOF%20PBtoWS/Branches/branches%2012.5.2.5.0/05_Nomina/tipo_ccosto
Librerias PropiasTipo
ws05_tipo_ccosto.pbl Libreria Lanzadora
sf05controller_tipo_ccosto.pblLibreria Controladora
sf05model_tipo_ccosto.pblLibreria Modelo DB
Librerias CoreTipo
sf00core_object.pbl Libreria Core de Objetos Base
sf00core_transaction.pblLibreria Core de control de Transacción DB
sf00core_proxy.pblLibreria de Soporte de Consumos WS - Internos
Requisitos Técnicos
Framework .Net 4.02 o Superior
Servidor Internet Information Server 7.5 o Superior
Sistema Operativo Windows Server 2012 R2
Memoria Ram 8GB
Exposición de Servicio
Tipo Servicio SOAP 1.1 y SOAP 1.2 (.Net Easy SOAP - Generado por Powerbuilder)
URL Recurso http://10.1.40.170:88/ws05_tipo_ccosto/n_ws05_tipo_ccosto.asmx?WSDL
Operaciones Objetivo
ws_listarlista las secciones actuales de la tabla NOMINA.TIPOS_NOMINA.
ws_insertaringresa un nuevo registro en la tabla NOMINA.TIPOS_NOMINA.
ws_actualizaractualiza valores en un registro de la tabla NOMINA.TIPOS_NOMINA.
ws_consultarconsulta un único registro dado de la tabla NOMINA.TIPOS_NOMINA.

Contrato de Consumo: WS_LISTAR

Contrato de Consumo
OperaciónObjetivo
ws_listarlista los registros actuales de la tabla NOMINA.TIPOS_NOMINA.
Parámetros de Entrada
NombreTipo de DatosDescripciónFormato Tipo
as_configStringCadena de Configuración del ConsumoJson
as_dataStringCadena que contiene los parámetros del ConsumoJson
Definición Interna
Parámetro EntradaAtributoTipo DatoDescripciónRequeridoValor por Defecto1)
as_configtoken_sessionStringCadena que representa el hash de autenticación de acceso al consumoSi
as_datafirstpagIntegerIdentificador de registro inicial de la paginación del consumoSi1
as_datalastpagIntegerIdentificador de registro final de la paginación del consumoSi1
as_dataorderbyStringCadena que contiene las columnas de ordenamiento del consumoNoUtilizado por la DB
as_datawhereStringCadena que contiene la sentencia de filtrado del consumoNoN/A
Parámetros de Retorno
NombreTipo de DatosDescripciónFormato Tipo
ws_listarResultStringCadena de retorno del ConsumoJson
Definición Interna
Parámetro Entrada2)Atributo3)Tipo Dato4)Descripción5)Requerido6)Valor por Defecto7)GUI8)PK9)
ws_listarResultreturn_codeStringCadena que representa el código de retorno del consumo 1: OK -1: ErrorSiN/ANoNo
ws_listarResultreturn_user_messageStringCadena que representa el mensaje de usuario de retorno del consumoSiN/ASiNo
ws_listarResultreturn_technical_messageStringCadena que representa el mensaje técnico de retorno del consumoSiN/ANoNo
ws_listarResultreturn_objectStringCadena que representa el objeto de retorno del consumoNoN/AN/ANo
return_objectalertStringCadena que representa el array de mensajes de alerta de retorno del consumoNoN/AN/ANo
alertmsgStringCadena que representan una posición del array de mensajes de alerta de retorno del consumoNoN/ASiNo
return_objectcolumncountLongValor que representa la cantidad de columnas de la data devuelve en el objeto de consumoNoN/ANoNo
return_objectrowcountLongValor que representa la cantidad de filas totales de la data que representa el objeto de consumoNoN/ASiNo
return_objecttipo_ccostoArray ObjectArray de Objetos que representan la data que devuelve el consumoNoN/AN/ANo
tipo_ccostoka_nl_tipo_nominaLongIdentificador del registroSiN/ANoSi
tipo_ccostos_descripcionStringDescripción del tipo de centro de costoSiN/ASiNo
tipo_ccostousuario_empresaStringusuario de móduloSiN/ANoNo
tipo_ccostocodigo_mempresaStringCódigo de la Empresa (Entorno Multiempresa)Si“9999999999”NoNo
tipo_ccostoliquida_por_puntosStringIdentifica que forma de liquidar tiene el tipoSiN/ASiNo
tipo_ccostornumLongIdentificador de fila del registroSiAuto incremental por filaSiNo
ws_listarResultreturn_response_dateDateFecha y hora de ejecución del consumoSifecha y hora del sistemaNoNo
ws_listarResultreturn_execution_timeLongTiempo de ejecución del consumo en milisegundosSi0NoNo

Ejemplos

Entrada
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:tem="http://tempurl.org">
   <soapenv:Header/>
   <soapenv:Body>
      <tem:ws_listar>
         <!--Optional:-->
         <tem:as_config>
           { "token_session": "75fc8798d624646a88ee12db006e5a98a477683c030e0f1f21fbaca8058d5404" }
         </tem:as_config>
         <!--Optional:-->
         <tem:as_data>
         </tem:as_data>
      </tem:ws_listar>
   </soapenv:Body>
</soapenv:Envelope>
Retorno
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <soap:Body>
      <ws_listarResponse xmlns="http://tempurl.org">
         <ws_listarResult>{
    "return_code": "1",
    "return_user_message": "consulta de datos existosa",
    "return_technical_message": "consulta de datos existosa",
    "return_object": {
        "alert": [
            {
                "msg": "no se identifica el parametro: firstpag"
            },
            {
                "msg": "no se identifica el parametro: lastpag"
            },
            {
                "msg": "no se identifica el parametro: orderby"
            }
        ],
        "dataobject": "dsg_core_dual",
        "columncount": 6,
        "tipo_ccosto": [
            {
                "ka_nl_tipo_nomina": 3,
                "s_descripcion": "NOMINA ADMINISTRATIVOS PLANTA",
                "usuario_empresa": "NOMINA",
                "codigo_mempresa": "9999999999",
                "liquida_por_puntos": "N",
                "rnum": 1
            }
        ],
        "rowcount": 15
    },
    "return_response_date": "25/06/2019 21:47:07",
    "return_execution_time": "219"
}</ws_listarResult>
      </ws_listarResponse>
   </soap:Body>
</soap:Envelope>

Contrato de Consumo: WS_INSERTAR

Contrato de Consumo
OperaciónObjetivo
ws_insertarAgrega un nuevo registro en la tabla NOMINA.TIPOS_NOMINAS.
Parámetros de Entrada
NombreTipo de DatosDescripciónFormato Tipo
as_configStringCadena de Configuración del ConsumoJson
as_dataStringCadena que contiene los parámetros del ConsumoJson
Definición Interna
Parámetro EntradaAtributoTipo DatoDescripciónRequeridoValor por Defecto10)
as_configtoken_sessionStringCadena que representa el hash de autenticación de acceso al consumoSiN/A
as_datadatarecordObjeto JsonObjeto que contiene la data a registrarSi1
datarecordka_nl_tipo_nominaLongIdentificador del registroSi0
datarecords_descripcionStringDescripción del tipo de centro de costoSiN/A
datarecordliquida_por_puntosStringIdentifica que forma de liquidar tiene el tipoSiN/A
datarecordusuario_empresaStringusuario de móduloSiN/A
datarecordcodigo_mempresaStringCódigo de la Empresa (Entorno Multiempresa)Si“9999999999”
Parámetros de Retorno
NombreTipo de DatosDescripciónFormato Tipo
ws_insertarResultStringCadena de retorno del ConsumoJson
Definición Interna
Parámetro EntradaAtributoTipo DatoDescripciónRequeridoValor por Defecto11)
ws_insertarResultreturn_codeStringCadena que representa el código de retorno del consumo 1: OK -1: ErrorSiN/A
ws_insertarResultreturn_user_messageStringCadena que representa el mensaje de usuario de retorno del consumoSiN/A
ws_insertarResultreturn_response_dateDateFecha y hora de ejecución del consumoSifecha y hora del sistema
ws_insertarResultreturn_execution_timeLongTiempo de ejecución del consumo en milisegundosSi0

Ejemplos

Entrada
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:tem="http://tempurl.org">
   <soapenv:Header/>
   <soapenv:Body>
      <tem:ws_insertar>
         <!--Optional:-->
         <tem:as_config>
         { "token_session": "75fc8798d624646a88ee12db006e5a98a477683c030e0f1f21fbaca8058d5404"}
         </tem:as_config>
         <!--Optional:-->
         <tem:as_data>
         {"datarecord":{"ka_nl_tipo_nomina":19,"s_descripcion":"CCOSTO_GENERICO_006_2",
		 "liquida_por_puntos":"S","usuario_empresa":"NOMINA","codigo_mempresa","9999999999"}}
         </tem:as_data>
      </tem:ws_insertar>
   </soapenv:Body>
</soapenv:Envelope>
Retorno
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <soap:Body>
      <ws_insertarResponse xmlns="http://tempurl.org">
         <ws_insertarResult>{
    "return_code": "1",
    "return_user_message": "información registrada correctamente.",
    "return_response_date": "25/06/2019 21:19:17",
    "return_execution_time": "226"
}</ws_insertarResult>
      </ws_insertarResponse>
   </soap:Body>
</soap:Envelope>

Contrato de Consumo: WS_ACTUALIZAR

Contrato de Consumo
OperaciónObjetivo
ws_actualizaractualiza un registro en la tabla NOMINA.TIPOS_NOMINAS.
Parámetros de Entrada
NombreTipo de DatosDescripciónFormato Tipo
as_configStringCadena de Configuración del ConsumoJson
as_dataStringCadena que contiene los parámetros del ConsumoJson
Definición Interna
Parámetro EntradaAtributoTipo DatoDescripciónRequeridoValor por Defecto12)
as_configtoken_sessionStringCadena que representa el hash de autenticación de acceso al consumoSiN/A
as_datadatarecordObjeto JsonObjeto que contiene la data a actualizarSi1
datarecordka_nl_tipo_nominaLongIdentificador del registroSi0
datarecords_descripcionStringDescripción del tipo de centro de costoSiN/A
datarecordliquida_por_puntosStringIdentifica que forma de liquidar tiene el tipoSiN/A
datarecordusuario_empresaStringusuario de móduloSiN/A
datarecordcodigo_mempresaStringCódigo de la Empresa (Entorno Multiempresa)Si“9999999999”
Parámetros de Retorno
NombreTipo de DatosDescripciónFormato Tipo
ws_actualizarResultStringCadena de retorno del ConsumoJson
Definición Interna
Parámetro EntradaAtributoTipo DatoDescripciónRequeridoValor por Defecto13)
ws_actualizarResultreturn_codeStringCadena que representa el código de retorno del consumo 1: OK -1: ErrorSiN/A
ws_actualizarResultreturn_user_messageStringCadena que representa el mensaje de usuario de retorno del consumoSiN/A
ws_actualizarResultreturn_response_dateDateFecha y hora de ejecución del consumoSifecha y hora del sistema
ws_actualizarResultreturn_execution_timeLongTiempo de ejecución del consumo en milisegundosSi0

Ejemplos

Entrada
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:tem="http://tempurl.org">
   <soapenv:Header/>
   <soapenv:Body>
      <tem:ws_actualizar>
         <!--Optional:-->
         <tem:as_config>
         { "token_session": "75fc8798d624646a88ee12db006e5a98a477683c030e0f1f21fbaca8058d5404"}
         </tem:as_config>
         <!--Optional:-->
         <tem:as_data>
         {"datarecord":{"ka_nl_tipo_nomina":17,"s_descripcion":"BCCOSTO_GENERICO_006_2",
		 "liquida_por_puntos":"S"}}
         </tem:as_data>
      </tem:ws_actualizar>
   </soapenv:Body>
</soapenv:Envelope>
Retorno
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <soap:Body>
      <ws_actualizarResponse xmlns="http://tempurl.org">
         <ws_actualizarResult>{
    "return_code": "1",
    "return_user_message": "información actualizada correctamente",
    "return_response_date": "25/06/2019 21:17:54"
}</ws_actualizarResult>
      </ws_actualizarResponse>
   </soap:Body>
</soap:Envelope>

Contrato de Consumo: WS_CONSULTAR

Contrato de Consumo
OperaciónObjetivo
ws_consultarconsulta un único registro dado de la tabla NOMINA.TIPOS_NOMINA.
Parámetros de Entrada
NombreTipo de DatosDescripciónFormato Tipo
as_configStringCadena de Configuración del ConsumoJson
as_dataStringCadena que contiene los parámetros del ConsumoJson
Definición Interna
Parámetro EntradaAtributoTipo DatoDescripciónRequeridoValor por Defecto14)
as_configtoken_sessionStringCadena que representa el hash de autenticación de acceso al consumoSiN/A
as_dataka_nl_tipo_nominaLongIdentificador del registro a consultarSi1
Parámetros de Retorno
NombreTipo de DatosDescripciónFormato Tipo
ws_consultarResultStringCadena de retorno del ConsumoJson
Definición Interna
Parámetro EntradaAtributoTipo DatoDescripciónRequeridoValor por Defecto15)
ws_consultarResultreturn_codeStringCadena que representa el código de retorno del consumo 1: OK -1: ErrorSiN/A
ws_consultarResultreturn_user_messageStringCadena que representa el mensaje de usuario de retorno del consumoSiN/A
ws_consultarResultreturn_technical_messageStringCadena que representa el mensaje técnico de retorno del consumoSiN/A
ws_consultarResultreturn_objectStringCadena que representa el objeto de retorno del consumoNoN/A
return_objectalertStringCadena que representa el array de mensajes de alerta de retorno del consumoNoN/A
alertmsgStringCadena que representan una posición del array de mensajes de alerta de retorno del consumoNoN/A
return_objectcolumncountLongValor que representa la cantidad de columnas de la data devuelve en el objeto de consumoNoN/A
return_objectrowcountLongValor que representa la cantidad de filas totales de la data que representa el objeto de consumoNoN/A
return_objecttipo_ccostoArray ObjectArray de Objetos que representan la data que devuelve el consumoNoN/A
tipo_ccostoka_nl_tipo_nominaLongIdentificador del registroSiN/A
tipo_ccostos_descripcionStringDescripción del tipo de centro de costoSiN/A
tipo_ccostousuario_empresaStringusuario de móduloSiN/A
tipo_ccostocodigo_mempresaStringCódigo de la Empresa (Entorno Multiempresa)Si“9999999999”
tipo_ccostoliquida_por_puntosStringIdentifica que forma de liquidar tiene el tipoSiN/A
tipo_ccostornumLongIdentificador de fila del registroSiAuto incremental por fila
ws_consultarResultreturn_response_dateDateFecha y hora de ejecución del consumoSifecha y hora del sistema
ws_consultarResultreturn_execution_timeLongTiempo de ejecución del consumo en milisegundosSi0

Ejemplos

Entrada
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:tem="http://tempurl.org">
   <soapenv:Header/>
   <soapenv:Body>
      <tem:ws_consultar>
         <!--Optional:-->
         <tem:as_config>
         { "token_session": "75fc8798d624646a88ee12db006e5a98a477683c030e0f1f21fbaca8058d5404" }
         </tem:as_config>
         <!--Optional:-->
         <tem:as_data>
         {"ka_nl_tipo_nomina":12}
         </tem:as_data>
      </tem:ws_consultar>
   </soapenv:Body>
</soapenv:Envelope>
Retorno
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <soap:Body>
      <ws_consultarResponse xmlns="http://tempurl.org">
         <ws_consultarResult>{
    "return_code": "1",
    "return_user_message": "consulta de datos existosa",
    "return_technical_message": "consulta de datos existosa",
    "return_object": {
        "dataobject": "dsf_tipo_ccosto_only_one",
        "columncount": 5,
        "tipo_ccosto": [
            {
                "ka_nl_tipo_nomina": 12,
                "s_descripcion": "ADMINISTRATIVOS",
                "usuario_empresa": "NOMINA",
                "codigo_mempresa": "9999999999",
                "liquida_por_puntos": "N"
            }
        ],
        "rowcount": 13
    },
    "return_response_date": "25/06/2019 21:16:57",
    "return_execution_time": "240"
}</ws_consultarResult>
      </ws_consultarResponse>
   </soap:Body>
</soap:Envelope>

Validaciones

idcodigoDescripción
162CRUD_THE_QUERY_PARAMETER_IS_NOT_IDENTIFIEDno se identifica el parámetro
163CRUD_LIMIT_CONTROL_OF_RECORD_PER_PAGEcontrol de límite de registros por paginación
283CRUD_THERE_PREVIOUSLY_ENTERED_RECORD_IDENTIFIERexiste un registro previamente ingresado con el identificador
381CRUD_INDEFINITE_QUERY_CONFIGURATIONconfiguración de consulta indefinida
402CRUD_INDEFINITE_QUERY_VALIDATIONvalidación de consulta indefinida
403CRUD_INDEFINITE_UPDATE_CONFIGURATIONconfiguración de actualización indefinida
404CRUD_INDEFINITE_UPDATE_VALIDATIONvalidación de actualización indefinida
405CRUD_INDEFINITE_INSERT_VALIDATIONvalidación de inserción indefinida
406CRUD_INDEFINITE_INSERT_CONFIGURATIONconfiguración de inserción indefinida
407CRUD_INDEFINITE_DELETE_VALIDATIONvalidación de eliminacion indefinida
408CRUD_INDEFINITE_DELETE_CONFIGURATIONconfiguración de eliminación indefinida
421CRUD_ROW_NUMBER_IN_UPDATE_IS_NOT_IDENTIFIEDno se identifica el número de fila en la actualización
441CRUD_EMPTY_OR_NULL_FIELDcampo nulo o vacío
461CRUD_THERE_IS_NO_INFORMATION_TO_ELIMINATEno existe información para eliminar
462CRUD_ERROR_WHEN_IDENTIFYING_RECORD_ELIMINATIONerror al identificar registros de la eliminación
501CRUD_CONSUMPTION_OPERATION_IS_NOT_IDENTIFIEDno se identifica la operación crud del consumo
502CRUD_NAME_CAN_NOT_BE_IDENTIFIEDno se puede identifcar el nombre del crud
1) , 7) , 10) , 11) , 12) , 13) , 14) , 15)
Los valores por defecto son asumidos por el consumo interno
2)
Nombre del Parametro Contenedor del String en Formato Json
3)
Nombre del campo o atributo interno del Parámetro de Entrada
4)
Tipo de Dato del Atributo
5)
Descripción, observación o comentario del atributo
6)
Indica si el atributo es requerido en el proceso
8)
Esta propiedad indica que el campo es visible “Si” en la interfaz gráfica del Front-End
9)
Indica que el campo hace parte de la clave primaria “Si” y debe enviarse en las operaciones CRUD
ada/tips/sicoferp/general/pbtows/procesos/inventario/nominamaestros/tipocentrocosto.1563916032.txt.gz · Última modificación: 2019/07/23 21:07 por ciro.soto