Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Processes are the components of a workflow that move data from one object to another. They can be executed and monitored.

In this section:

Child pages (Children Display)

Get processes information

Resource GET /processes serve as the main way to list all available Extraction Processes. It supports the following input parameters:

Parameter name

Description

Usage

Notes

tableName

Filtering based on Glue table name

Optional

Array input possible; if used, other parameters are ignored

package

Filtering based on the SAP development package

Optional

Array input possible

author

Filtering based on the author

Optional

Array input possible

processID

Filtering based on the process ID

Optional

Array input possible

 All input parameters are case insensitive.

Example of the REST API call:

GET http://servername:portnumber/dvd/glue/api/v3/processes?sap-client=800

 JSON body:

Code Block
languagejson
{
    "tableName": [
        " ZTS_SFLIGHT",
        " ZZK_ERPVAL"
    ]
}

Output:

Expand
titleExample of the REST API output
Code Block
languagejson
{
  "processes": [
    {
      "name": "ZAP_SFLIGHT_1_P",
      "description": "ZAP_SFLIGHT_1_P",
      "systemId": "NSD",
      "package": "ZAP_GLUE_TEST",
      "createdOn": "2019-11-04",
      "modifiedOn": "2020-03-25",
      "createdBy": "APOLTANO",
      "transformation": [
        {
          "targetField": "GLREQUEST",
          "type": "E",
          "expression": "GL_REQUEST( )"
        },
        { "targetField": "MANDT", "type": "=", "expression": "MANDT" },
        { "targetField": "CARRID", "type": "=", "expression": "CARRID" },
        { "targetField": "CONNID", "type": "=", "expression": "CONNID" },
        { "targetField": "FLDATE", "type": "=", "expression": "FLDATE" },
        { "targetField": "PRICE", "type": "C", "expression": "PRICE" },
        { "targetField": "CURRENCY", "type": "=", "expression": "CURRENCY" },
        { "targetField": "PLANETYPE", "type": "=", "expression": "PLANETYPE" },
        { "targetField": "SEATSMAX", "type": "=", "expression": "SEATSMAX" },
        { "targetField": "SEATSOCC", "type": "=", "expression": "SEATSOCC" },
        {
          "targetField": "PAYMENTSUM",
          "type": "C",
          "expression": "PAYMENTSUM"
        },
        {
          "targetField": "SEATSMAX_B",
          "type": "=",
          "expression": "SEATSMAX_B"
        },
        {
          "targetField": "SEATSOCC_B",
          "type": "=",
          "expression": "SEATSOCC_B"
        },
        {
          "targetField": "SEATSMAX_F",
          "type": "=",
          "expression": "SEATSMAX_F"
        },
        { "targetField": "SEATSOCC_F", "type": "=", "expression": "SEATSOCC_F" }
      ],
      "fetcher": [
        {
          "id": "ZAP_SFLIGHT_1_F",
          "description": "ZAP_SFLIGHT_1_F",
          "type": "SAP Table Fetcher",
          "parameters": [
            {
              "paramName": "DELTA_FIELD",
              "numb": 0,
              "sign": "",
              "opti": "",
              "low": "FLDATE",
              "high": ""
            },
            {
              "paramName": "DELTA_TYPE",
              "numb": 0,
              "sign": "",
              "opti": "",
              "low": "DATE",
              "high": ""
            },
            {
              "paramName": "FILTER",
              "numb": 1,
              "sign": "",
              "opti": "",
              "low": "CARRID",
              "high": ""
            },
            {
              "paramName": "FILTER",
              "numb": 2,
              "sign": "",
              "opti": "",
              "low": "CURRENCY",
              "high": ""
            },
            {
              "paramName": "FILTER",
              "numb": 3,
              "sign": "",
              "opti": "",
              "low": "FLDATE",
              "high": ""
            },
            {
              "paramName": "LOAD_TYPE",
              "numb": 0,
              "sign": "",
              "opti": "",
              "low": "F",
              "high": ""
            },
            {
              "paramName": "TABLE_NAME",
              "numb": 0,
              "sign": "",
              "opti": "",
              "low": "SFLIGHT",
              "high": ""
            }
          ]
        }
      ],
      "consumer": [
        {
          "id": "ZAP_SFLIGHT_1_C",
          "description": "ZAP_SFLIGHT_1_C",
          "type": "GLUE Table Consumer",
          "parameters": [
            {
              "paramName": "GLUE_TABLE_NAME",
              "numb": 0,
              "sign": "",
              "opti": "",
              "low": "ZAP_SFLIGHT_1",
              "high": ""
            },
            {
              "paramName": "TRUNCATE_TARGET",
              "numb": 0,
              "sign": "",
              "opti": "",
              "low": "",
              "high": ""
            }
          ]
        }
      ]
    },
    {
      "name": "ZTS_SFLIGHT_E",
      "description": "SF.",
      "systemId": "NSD",
      "package": "ZTS_TEST",
      "createdOn": "2020-02-17",
      "modifiedOn": "2020-02-17",
      "createdBy": "TSLANINK",
      "transformation": [
        { "targetField": "MANDT", "type": "=", "expression": "MANDT" },
        { "targetField": "CARRID", "type": "=", "expression": "CARRID" },
        { "targetField": "CONNID", "type": "=", "expression": "CONNID" },
        { "targetField": "FLDATE", "type": "=", "expression": "FLDATE" },
        {
          "targetField": "GLREQUEST",
          "type": "E",
          "expression": "GL_REQUEST( )"
        },
        { "targetField": "PRICE", "type": "C", "expression": "PRICE" },
        { "targetField": "CURRENCY", "type": "=", "expression": "CURRENCY" },
        { "targetField": "PLANETYPE", "type": "=", "expression": "PLANETYPE" },
        { "targetField": "SEATSMAX", "type": "=", "expression": "SEATSMAX" },
        { "targetField": "SEATSOCC", "type": "=", "expression": "SEATSOCC" },
        {
          "targetField": "PAYMENTSUM",
          "type": "C",
          "expression": "PAYMENTSUM"
        },
        {
          "targetField": "SEATSMAX_B",
          "type": "=",
          "expression": "SEATSMAX_B"
        },
        {
          "targetField": "SEATSOCC_B",
          "type": "=",
          "expression": "SEATSOCC_B"
        },
        {
          "targetField": "SEATSMAX_F",
          "type": "=",
          "expression": "SEATSMAX_F"
        },
        { "targetField": "SEATSOCC_F", "type": "=", "expression": "SEATSOCC_F" }
      ],
      "fetcher": [
        {
          "id": "ZTS_SFLIGHT_F",
          "description": "SF.",
          "type": "SAP Table Fetcher",
          "parameters": [
            {
              "paramName": "DELTA_FIELD",
              "numb": 0,
              "sign": "",
              "opti": "",
              "low": "",
              "high": ""
            },
            {
              "paramName": "DELTA_TYPE",
              "numb": 0,
              "sign": "",
              "opti": "",
              "low": "FULL",
              "high": ""
            },
            {
              "paramName": "FILTER",
              "numb": 1,
              "sign": "",
              "opti": "",
              "low": "CARRID",
              "high": ""
            },
            {
              "paramName": "FILTER",
              "numb": 2,
              "sign": "",
              "opti": "",
              "low": "CONNID",
              "high": ""
            },
            {
              "paramName": "FILTER",
              "numb": 3,
              "sign": "",
              "opti": "",
              "low": "FLDATE",
              "high": ""
            },
            {
              "paramName": "LOAD_TYPE",
              "numb": 0,
              "sign": "",
              "opti": "",
              "low": "F",
              "high": ""
            },
            {
              "paramName": "TABLE_NAME",
              "numb": 0,
              "sign": "",
              "opti": "",
              "low": "SFLIGHT",
              "high": ""
            }
          ]
        }
      ],
      "consumer": [
        {
          "id": "ZTS_SFLIGHT_C",
          "description": "SF.",
          "type": "GLUE Table Consumer",
          "parameters": [
            {
              "paramName": "GLUE_TABLE_NAME",
              "numb": 0,
              "sign": "",
              "opti": "",
              "low": "ZTS_SFLIGHT",
              "high": ""
            },
            {
              "paramName": "TRUNCATE_TARGET",
              "numb": 0,
              "sign": "",
              "opti": "",
              "low": "",
              "high": ""
            }
          ]
        }
      ]
    }
  ]
}

Functionality is implemented in the SAP class /DVD/GL_EXT2_API_PROCESSES.

Edit a process

The endpoint PATCH /processes allow editing process parameters like fetcher delta type, filters, etc.

Parameter name

Description

Usage

Type

processes

array of processes to be patched, the format is the same as the get /processes output

Mandatory

JSON object

 All input parameters are case insensitive.

Note

When changing components “parameters”, all the parameters need to be specified, including the ones that will not be modified.

When passing filter parameters, the field “numb” needs to be set to value 1.

Code Block
languagejson
   ... {
            "paramName": "FILTER",
            "numb": 1,
            "sign": "",
            "opti": "",
            "low": "CARRID",
            "high": ""
       }, ...

For all the other parameters, the field “numb” needs to be set to value 0.

Code Block
languagejson
   ... {
              "paramName": "DEDUPLICATE_DELETES",
              "numb": 0,
              "sign": "",
              "opti": "",
              "low": "",
              "high": ""
        },

Example of the REST API call:

Expand
titleJSON body parameters example
Code Block
languagejson
{
    "processes": [
        {
            "name": "Z_SFLIGHT_P",
            "description": "Z_SFLIGHT_P",
            "systemId": "NSD",
            "package": "ZPACKAGE",
            "createdOn": "2020-10-27",
            "modifiedOn": "2020-10-27",
            "createdBy": "PACKAGE",
            "transformation": [
                {
                    "targetField": "MANDT",
                    "type": "=",
                    "expression": "MANDT"
                },
                {
                    "targetField": "CARRID",
                    "type": "=",
                    "expression": "CARRID"
                },
                {
                    "targetField": "CONNID",
                    "type": "=",
                    "expression": "CONNID"
                },
                {
                    "targetField": "FLDATE",
                    "type": "=",
                    "expression": "FLDATE"
                },
                {
                    "targetField": "PRICE",
                    "type": "=",
                    "expression": "PRICE"
                },
                {
                    "targetField": "CURRENCY",
                    "type": "=",
                    "expression": "CURRENCY"
                },
                {
                    "targetField": "PLANETYPE",
                    "type": "=",
                    "expression": "PLANETYPE"
                },
                {
                    "targetField": "SEATSMAX",
                    "type": "=",
                    "expression": "SEATSMAX"
                },
                {
                    "targetField": "SEATSOCC",
                    "type": "=",
                    "expression": "SEATSOCC"
                },
                {
                    "targetField": "PAYMENTSUM",
                    "type": "=",
                    "expression": "PAYMENTSUM"
                },
                {
                    "targetField": "SEATSMAX_B",
                    "type": "=",
                    "expression": "SEATSMAX_B"
                },
                {
                    "targetField": "SEATSOCC_B",
                    "type": "=",
                    "expression": "SEATSOCC_B"
                },
                {
                    "targetField": "SEATSMAX_F",
                    "type": "=",
                    "expression": "SEATSMAX_F"
                },
                {
                    "targetField": "SEATSOCC_F",
                    "type": "=",
                    "expression": "SEATSOCC_F"
                }
            ],
            "fetcher": [
                {
                    "id": "Z_SFLIGHT_F",
                    "description": "Z_SFLIGHT_F",
                    "type": "SAP Table Fetcher",
                    "parameters": [
                        {
                            "paramName": "DEDUPLICATE_DELETES",
                            "numb": 0,
                            "sign": "",
                            "opti": "",
                            "low": "",
                            "high": ""
                        },
                        {
                            "paramName": "DELTA_FIELD",
                            "numb": 0,
                            "sign": "",
                            "opti": "",
                            "low": "",
                            "high": ""
                        },
                        {
                            "paramName": "DELTA_FIELD_ADT",
                            "numb": 0,
                            "sign": "",
                            "opti": "",
                            "low": "",
                            "high": ""
                        },
                        {
                            "paramName": "DELTA_TYPE",
                            "numb": 0,
                            "sign": "",
                            "opti": "",
                            "low": "TRIGGER",
                            "high": ""
                        },
                        {
                            "paramName": "FILTER",
                            "numb": 1,
                            "sign": "",
                            "opti": "",
                            "low": "CONNID",
                            "high": ""
                        },
                        {
                            "paramName": "FILTER",
                            "numb": 1,
                            "sign": "",
                            "opti": "",
                            "low": "CARRID",
                            "high": ""
                        },
                        {
                            "paramName": "LOAD_TYPE",
                            "numb": 0,
                            "sign": "",
                            "opti": "",
                            "low": "F",
                            "high": ""
                        },
                        {
                            "paramName": "READ_DELETED_ENTRIES",
                            "numb": 0,
                            "sign": "",
                            "opti": "",
                            "low": "",
                            "high": ""
                        },
                        {
                            "paramName": "TABLE_NAME",
                            "numb": 0,
                            "sign": "",
                            "opti": "",
                            "low": "SFLIGHT",
                            "high": ""
                        }
                    ]
                }
            ],
            "consumer": [
                {
                    "id": "Z_SFLIGHT_C",
                    "description": "Z_SFLIGHT_C",
                    "type": "GLUE Table Consumer",
                    "parameters": [
                        {
                            "paramName": "DATA_VALIDATION",
                            "numb": 0,
                            "sign": "",
                            "opti": "",
                            "low": "",
                            "high": ""
                        },
                        {
                            "paramName": "GLUE_TABLE_NAME",
                            "numb": 0,
                            "sign": "",
                            "opti": "",
                            "low": "Z_SFLIGHT",
                            "high": ""
                        },
                        {
                            "paramName": "TRUNCATE_TARGET",
                            "numb": 0,
                            "sign": "",
                            "opti": "",
                            "low": "",
                            "high": ""
                        }
                    ]
                }
            ]
        }
    ]
}
Expand
titleExample of the REST API output:
Code Block
languagejson
{
    "message": [
        {
            "msgtype": "S",
            "text": "Consumer Z_SFLIGHT_C activated."
        },
        {
            "msgtype": "S",
            "text": "Filter activated for table field CONNID"
        },
        {
            "msgtype": "S",
            "text": "Filter activated for table field CARRID"
        },
        {
            "msgtype": "S",
            "text": "Fetcher Z_SFLIGHT_F activated."
        },
        {
            "msgtype": "S",
            "text": "Extraction process Z_SFLIGHT_P activated."
        }
    ]
}

Functionality is implemented in the SAP class /DVD/GL_EXT2_API_PROCESSES.