API

Below is the list of standard services that are based on the entities:

Function	Service	FUN
Read Entity Class	B£SER_63	F(EXB;B£SER_63;RIS.OAV) 1(OG;;[T][P])
Read Entity	B£SER_63	F(EXB;B£SER_63;RIS.OAV) 1([T];[P];[K])
Read Entity List	LOA10_SE (*LIS)	F(EXB;*LIS;) 1(OG;;[T][P])
Read Entity List with Filters	LOA10_SE (*LIS)	F(EXB;*LIS;) 1(OG;;[T][P]) INPUT(FILTER([FILTER_SYNTAX])
Read Entity Action List	JATRE_06C (*FUN)	F(EXB;*FUN;) 1([T];[P];[K])
Read Entity Class as Tooltip List	WESER_23 (*FUN)	F(EXB;WESER_23;MAT.PRI) 1(OG;[T];[P])
Read Entity as Tooltip List	WESER_23 (*FUN)	F(EXB;WESER_23;MAT.ALL) 1([T];[P];[K])
Read additional columns	LOSER_25	F(EXB;LOSER_25;GET.GER) 1(OG;;[T][P]) 2(OA;;[OAV AS FOREIGN KEY]) 3(;;[OAV TO SEEK]) INPUT([K][K][K]...)
Decoding Entity Class	B£SER_DE	F(EXB;B£SER_DE;DEC.OGG) 1(OG;;[T][P])
Decoding Entity	B£SER_DE	F(EXB;B£SER_DE;DEC.OGG) 1([T];[P];[K])
Multiple Decoding Entity	B£SER_DE	F(EXB;B£SER_DE;DEC.MUL) OBJECTS(T([T]) P([P]) K([K]);T([T]) P([P]) K([K])...)
Create new Entity	LOA40_SI	F(EXB;LOA40_SI;IMP.DAT) 1([T];[P];[K]) P(AziExe(01)) INPUT(DetExe(1) InzDat([OAV_ID]([OAV_VALUE]) [OAV_ID]([OAV_VALUE]) [OAV_ID]([OAV_VALUE])...))
Update Entity	LOA40_SI	F(EXB;LOA40_SI;IMP.DAT) 1([T];[P];[K]) P(AziExe(02)) INPUT(DetExe(1) InzDat([OAV_ID]([OAV_VALUE]) [OAV_ID]([OAV_VALUE]) [OAV_ID]([OAV_VALUE])...))
Delete by Id	LOA40_SI	F(FBK;LOA40_SI;IMP.DAT) 1([T];[P];[K]) P(AziExe(04))
Retrieve external entity definition in JSON format from MONGODB	MU_173_02	FUN(EXB;MU_173_02;GET.DSL) 1(OG;;[T][P])
Update external entity definition on MONGODB	MU_173_02	FUN(FBK;MU_173_02;SET.DSL) 1(OG;;[T][P]) INPUT(DATA([JSON base 64]))
Delete external entity definition from MONGODB	MU_173_02	FUN(FBK;MU_173_02;DEL.DSL) 1(OG;;[T][P])

Filter Syntax

Filters are available when you request the execution of LOA10_SE service. The syntax is as follow:

OAV([OAV_CODE]) OPE([OPERATION]) VAL([VALUE])

The supported operators are:

Operator	Alias	Description
EQ	=	Equals
NE	<>	Not equals
GT	>	Greater Than
GE	>=	Greater or equals
LT	<	Less Than
LE	<=	Less or equals
SC		Contains
NS		Not contains
BG		Begin with
ED		End with
LS		In list
LN		Out of list

null and blank value are also supported. The syntax to setup a blank filter is:

OAV([OAV_CODE]) OPE([OPERATION]) VAL(*BLANK)

External entities definition handling (examples)

How to retrieve external entity definition

Input F(EXB;MU_173_02;GET.DSL) 1(OG;;[ENTITY_CLASS])

Output

{
   "columns":[
      {
         "code":"DSL",
         "IO":"O",
         "lun":"3461",
         "ogg":"",
         "text":"JSON entity definition",
         "tooltip":false
      }
   ],
   "debugInfo":{
      "executionTime_ms":736,
      "finalTimestamp":"2024-01-30T10:30:07.528492Z",
      "initialTimestamp":"2024-01-30T10:30:06.792392300Z"
   },
   "rows":[
      {
         "fields":{
            "DSL":{
               "name":"DSL",
               "smeupObject":{
                  "tipo":"",
                  "parametro":"",
                  "codice":"[ENTITY_DEFINITION_JSON]"
               },
               "tooltip":false
            }
         }
      }
   ],
   "type":"SmeupTable"
}

How to update external entity definition

Input F(FBK;MU_173_02;SET.DSL) 1(OG;;[ENTITY_CLASS]) INPUT(DATA([ENTITY_DEFINITION_JSON in BASE64]))

Output

{
    "debugInfo": {
        "executionTime_ms": 434,
        "finalTimestamp": "2024-01-30T10:33:28.880108700Z",
        "initialTimestamp": "2024-01-30T10:33:28.446642Z"
    },
    "messages": [
        {
            "gravity": "INFO",
            "message": "Successfully updated entity definition",
        }
    ],
    "type": "FBKData"
}

How to delete external entity definition

Input F(FBK;MU_173_02;DEL.DSL) 1(OG;;[ENTITY_CLASS])

Output

{
    "debugInfo": {
        "executionTime_ms": 381,
        "finalTimestamp": "2024-01-30T10:34:45.777611Z",
        "initialTimestamp": "2024-01-30T10:34:45.396434200Z"
    },
    "messages": [
        {
            "gravity": "INFO",
            "message": "Deleted entity definition",
        }
    ],
    "type": "FBKData"
}

Error response

Input F(FBK;MU_173_02;DEL.DSL) 1(OG;;[ENTITY_CLASS])

Output

{
    "debugInfo": {
        "executionTime_ms": 34,
        "finalTimestamp": "2024-01-30T10:36:52.261008500Z",
        "initialTimestamp": "2024-01-30T10:36:52.227082700Z"
    },
    "messages": [
        {
            "gravity": "ERROR",
            "message": "Unable to handle entity definition, cause: missing @ExternalDefinitionEntity",
            "mode": "PN"
        }
    ],
    "type": "FBKData"
}