MyDinaup
El paquete NuGet que Dinaup genera con una clase por sección, informe y documento dinámico de tu esquema.
MyDinaup es la biblioteca .NET que Dinaup genera con tu esquema: cada sección, informe y documento dinámico de tu licencia se convierte en una clase con los nombres reales de tus campos. Se usa junto al SDK Dinaup, que es el que conecta con la API.
Antes de empezar
- El paquete NuGet
Dinaup, paranet10.0. Ver SDK .NET. - Una clave API de tu licencia. Ver Claves API.
- Tu paquete
{Empresa}.MyDinaup. Los ejemplos salen deDemoUp.MyDinaup, un modelo de ejemplo para pruebas: su esquema no es el tuyo.
dotnet add package Dinaup
dotnet add package {Empresa}.MyDinaupConstantes en vez de claves internas
Cada campo tiene una clave interna (pr_30655031). MyDinaup la expone como constante con el nombre del campo:
using static DemoUp.MyDinaup.SectionsD;
var data = new Dictionary<string, string>
{
{ AlmacenesD.AlmacenesES.SendcloudID, "SC-4471" }, // "pr_30655031"
{ AlmacenesD.AlmacenesES.TextoPrincipal, "Almacén central" } // "nombre"
};SectionsD, Reports y DynamicDocuments son clases parciales, no espacios de nombres: se importan con using static. Un using sin static no compila.
Qué contiene
| Carpeta | Clase generada | Hereda de |
|---|---|---|
Secciones/ | SectionsD.{Seccion}D, con {Seccion}ES y {Seccion}C anidadas | DinaupRowBase (la fila C) |
Informes/{Categoria}/ | Reports.{Categoria}D.{Informe}C con su fila {Informe}_RowC | DinaupReportBase<RowC> |
DocDinamicos/{Categoria}/ | DynamicDocuments.{Categoria}D.{Documento}C | DinaupDynamicDocumentBase |
Enumeraciones.vb | Los tipos de lista de tu esquema como enum | |
Constants.vb | Constants.{Catalogo}.{Valor} como DinaupBasicInformation, solo para secciones de catálogo | |
PGSync/ | PGSync.{Informe}Model, solo en licencias con PG Sync | Dinaup.Database.Definitions.BaseModelConverter |
El código generado es VB.NET con OptionStrict Off y se consume igual desde C#.
Secciones
| Miembro | Qué es |
|---|---|
{Seccion}D._SectionID | El GUID de la sección como string. |
{Seccion}D._SectionIDGUID | El mismo GUID como Guid: el que piden RunWriteOperationAsync y RowsGetAsync. |
{Seccion}D.GetRowByIdAsync(client, id) | Una fila {Seccion}C, o null si id es Guid.Empty o no existe. |
{Seccion}D.List(client) | Una consulta con un filtro tipado por campo, que termina en ReadUpToAsync(n) o ReadAllAsync(maxRows: n): Consultas con List. ListIncludingDeleted(client) trae también los eliminados. |
{Seccion}D.GetRowsAsync(client, RowsRequestParameters) | List<{Seccion}C> con las filas que cumplen el filtro. |
{Seccion}ES | Las claves de campo como constantes string, más _SectionID (Guid), _Table, _FieldIDs (clave a GUID de campo) y FieldsByRole. |
{Seccion}C | La fila tipada: LoadData, ToDic, ToWriteOperation(), Base__ID, Base__Label. |
Las plantillas base (ficheros B. - {Seccion}.vb) generan {Seccion}BaseD con la misma forma.
Partial Public Class SectionsD
Public Class AlmacenesD
Public Shared ReadOnly _SectionID As String = "7eec3e34-fbbd-4f1e-a77b-d4a6145686a3"
Public Shared ReadOnly _SectionIDGUID As New Guid("7eec3e34-fbbd-4f1e-a77b-d4a6145686a3")
Public Class AlmacenesES
Public Shared ReadOnly SendcloudID$ = "pr_30655031"
Public Shared ReadOnly ReferenciaResponsable$ = "pr_20010549681"
End Class
Public Class AlmacenesC
Inherits DinaupRowBase
Public Property SendcloudID As String
Public Property FechaAlta_UTC As DateTime?
Public Property ReferenciaResponsable As Dinaup.DinaupBasicInformation
End Class
End Class
End ClassUn campo que apunta a otra sección es un DinaupBasicInformation con Id, Title, SectionID e ImageId del registro relacionado, sin segunda consulta. Los campos de sistema (ID, FechaAltaDato_UTC, FechaUltimaModificacion_UTC, Eliminado, Empresa) tienen el setter privado. Cómo leer y escribir secciones, en Cliente Dinaup.
Informes
Cada informe es Reports.{Categoria}D.{Informe}C, heredera de DinaupReportBase<RowC>, con la fila {Informe}_RowC: una propiedad por columna, ya con su tipo.
Partial Public Class Reports
Partial Public Class FuncionalidadD
Public Class APIAlmacenesC
Inherits dinaup.DinaupReportBase(Of APIAlmacenes_RowC)
Public Shared _ReportID As String = "83fd57a3-893c-4651-adf9-d5d980af2c85"
Public Shared _ReportIDGuid As Guid = New Guid("83fd57a3-893c-4651-adf9-d5d980af2c85")
Public Shared _SectionIdGuid As Guid = New Guid("7eec3e34-fbbd-4f1e-a77b-d4a6145686a3")
Public Class APIAlmacenes_RowC
Implements IReportRow
Public Property ID As Guid
Public Property TextoPrincipal As String = ""
Public Property DisponibleEnTPV As Boolean
End Class
End Class
End Class
End ClassLa fila implementa IReportRow, IDinaupRow (Id, Label, SectionID, ImageId) e IDataFechaIA, y lleva la constante SchemaHash del esquema con el que se generó.
| Miembro heredado | Qué hace |
|---|---|
ExecuteQueryAsync(client, page, resultsPerPage = 2000, querysearch = "", adminMode = false, includeFiles = false, includeFieldsDetails = false) | Ejecuta una página del informe. |
LoadAllRowsAsync(client, pageSize = 10000, maxRows = 50000000, adminMode = false) | Devuelve todas las filas. Ver LoadAllRowsAsync. |
Rows, RowsDic | Las filas de la última respuesta, como lista y como diccionario por ID. |
CurrentPage, ExistNextPage, ExecuteQuery_NextPageAsync(), TotalResults, TotalPages | Paginación. TotalResults y TotalPages están marcadas [Obsolete]: ver Paginación. |
AddFilter, AddFilterIn, AddFilterBetween, AddOrder, AddVariable | Filtros, orden y variables. Ver Informes. |
TolerateMissingColumns | Si el servidor no devuelve una columna del modelo: false lanza excepción, true avisa en el log. Ver Columnas ausentes. |
MaxFechaIA, TokenChanges | Fecha de actividad más alta y token que cambia con cada carga. |
ColIdByColProperty, GetColIDByProperty(prop) | GUID de columna a partir del nombre de la propiedad. |
Documentos dinámicos
Cada documento es DynamicDocuments.{Categoria}D.{Documento}C, heredera de DinaupDynamicDocumentBase, con RequestParameters, Id y Title ya fijados. Encima de la clase va un comentario con su tipo y su código en forma legible:
' DOCUMENTO DINAMICO: Sesión
' Tipo: API
' Codigo (forma legible: campos/secciones/funciones por nombre):
' <!--: F.WriteText(D.SesionActual.TextoPrincipal) :-->
Public Class SesionC
Inherits DinaupDynamicDocumentBaseSetVariableValue(clave, valor) rellena sus variables y ExecuteAsync(client) devuelve un DynamicDocumentsGetResponse con Content, URL, FileName y Metadata. Ejemplo en Cliente Dinaup.
Enumeraciones y constantes
-
Enumeraciones.vb: los tipos de lista de tu esquema comoenum, cada valor con su atributoDescription.EnumTextoEstiloEva deIndefinido = 0aEstilo20 = 20;EnumTareaEstadoErecoge los estados de tarea. -
Constants.vb: los valores de las secciones de catálogo.Constants.EstadosDeVentas.Abierta,PagadayAnuladasonDinaupBasicInformationconId,TitleySectionID; cada catálogo tieneGetDic(), que devuelveDictionary<Guid, DinaupBasicInformation>.Entra una sección si deriva de una de las 25 secciones base de catálogo del núcleo: estados, tipos, categorías, familias, motivos, métodos, libros registro y jornadas. También entra si su título empieza por Estado, Tipo, Categoría, Clasificación, Familia, Motivo, Método, Fase, Etapa o Prioridad. En inglés cuenta la última palabra: Status, Type, Category y sus equivalentes. Cada sección da como mucho 50 constantes, las de sus 50 primeras filas por fecha de alta. Una fila sin nombre no da constante.
PGSync
En licencias con PG Sync, PGSync/ trae una clase PGSync.{Informe}Model por informe sincronizado. Hereda de BaseModelConverter, implementa IRow y declara Tabla, Campos y LastModifiedFieldDatetimeUTC para leer la réplica con Dinaup.Database.
El esquema documentado en el código
Anotaciones de cada campo
Cada constante de campo lleva su comportamiento en el servidor como documentación XML, visible al pasar el cursor o al autocompletar:
''' <summary>
''' Field ID: 6cde977d-fc04-04f6-27ac-3247ad830765
''' This field is related to the 'bd46bc13-a3be-43c7-bdf6-b063bcc082aa' section (Tipos de proyecto).
''' Auto-filled with Referencia dato: To Do (Siempre).
''' Auto-managed: filled and locked by the server, do not provide it.
''' Text field: up to 36 characters.
''' </summary>
Public Shared ReadOnly ReferenciaTipo$ = "pr_30010431914"| Anotación | Qué significa para tu código |
|---|---|
Field ID: <guid> | El GUID del campo, el mismo que _FieldIDs. |
This field is related to the '<guid>' section (Nombre). | Es una relación: escribe el GUID de un registro de esa sección. |
Auto-filled with <origen> (Siempre). | El servidor lo rellena desde la sesión, una constante o un dato de referencia. Con Siempre, no intentes sobrescribirlo. |
Auto-managed: filled and locked by the server, do not provide it. | No lo envíes: lo pone y bloquea el servidor. |
READ-ONLY: auto-calculated by the server from the section: <guid> (Nombre). Do not write it. | Contador o suma desde otra sección. Escribirlo no tiene efecto. |
Read-only: mirror/embedded field derived by the server from its source section. | Campo espejo de otra sección. |
Read-only: the main text is generated automatically. / Read-only: the main date is assigned automatically. | Texto o fecha principal calculados por el servidor. |
Read-only: auto-filled from its list document; it cannot be assigned. | Lo rellena el documento de su lista. |
REST write policy: can be set when creating the record, but read-only on update. | Solo acepta valor en el alta. |
Read-only via REST: auto-set by the server, never writable. | Campo de sistema: nunca se escribe. |
Required: you must provide this value when creating the record. | Obligatorio al crear. |
Unique: the value must not be duplicated within the section. | Sin duplicados en la sección. |
Text field: up to N characters. | Longitud máxima del texto. |
Numeric size: up to N integer digits and N decimals. | Dígitos enteros y decimales admitidos. |
Numeric validation: only values greater than 0 / only zero or positive values | El servidor rechaza negativos, y el cero en el primer caso. |
Semantic role: URL / phone number / email address / Spanish tax id NIF/CIF | Formato que el servidor valida o normaliza (correo a minúsculas, NIF a mayúsculas). |
Los scripts de la sección
Debajo de las constantes, cada sección incluye un bloque COMPORTAMIENTO / SCRIPTS con la lógica que el servidor ejecuta sobre sus registros: Script, Cuando, Campo y Codigo.
' Script: Estado cambiado
' Cuando: Campo cambiado
' Campo: pr_50010431912
' Codigo:
' if C.ReferenciaEstado.Estado = S.Enums.estadotramite.pendiente
' C.EnProceso = 1
' else
' C.EnProceso = 0
' endTu aplicación no ejecuta ese código: explica por qué una escritura da un error de validación o un campo cambia solo. La sintaxis es DinaScript, con C. apuntando al registro en edición.
Regenerar la biblioteca
Cuando cambias el modelo en Flex (un campo, una sección, un informe), regenera MyDinaup para que el código refleje el esquema. Si no, un informe pide una columna que ya no existe y lanza excepción.
Abre SDK .NET
En play.dinaup.com, abre la app Desarrollo y, en el menú, Conectar → SDK .NET. La tarjeta 5. Tu biblioteca MyDinaup la ve cualquiera con acceso a Desarrollo.
Regenera
Pulsa Regenerar MyDinaup y confirma con Regenerar. Tarda varios minutos y la pantalla espera hasta que termina: no la cierres. El aviso MyDinaup regenerado confirma que la biblioteca está lista.
Actualiza la referencia
Sube la versión de {Empresa}.MyDinaup en tu proyecto. Depende del SDK Dinaup: actualiza los dos a la vez.
La pantalla de Play se describe en SDK .NET de Play.