X4 Produktdokumentation

Operation: List Savepoints

The List Savepoints operation generates a list of the savepoints that have been set in a process.

Input

The adapter does not expect any input.

Example

Output

The adapter generates an XML file as output:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Savepoints>
    <Savepoint id="2be2eab5-317e-4c02-9896-7de77c4fa217">
        <PID>1675418719043677647</PID>
        <PUID>eab1040b-6635-4d64-9cbf-f613ace4291d</PUID>
        <Repository>1</Repository>
        <Project>SavePoints</Project>
        <Process>Processes/SaveMe.wrf</Process>
        <NextAction_ID>2</NextAction_ID>
    </Savepoint>
    <Savepoint id="72541d1c-fb40-433a-9cd3-677d8cdf814f">
        <PID>1675418719043677647</PID>
        <PUID>eab1040b-6635-4d64-9cbf-f613ace4291d</PUID>
        <Repository>1</Repository>
        <Project>SavePoints</Project>
        <Process>Processes/SaveMe.wrf/SaveMePrivateSubprocess.wrf</Process>
        <NextAction_ID>1</NextAction_ID>
    </Savepoint>
    <Savepoint id="e2c06c03-1d66-4bdf-9f15-616ee9e8ce8b">
        <PID>1675418719043677647</PID>
        <PUID>eab1040b-6635-4d64-9cbf-f613ace4291d</PUID>
        <Repository>1</Repository>
        <Project>SavePoints</Project>
        <Process>Processes/SaveMeSubprocess.wrf</Process>
        <NextAction_ID>3</NextAction_ID>
    </Savepoint>
</Savepoints>


The following elements can be included in the output:

Element

Description

Savepoint

The UUID of the savepoint is specified with the id attribute.

PID

Process ID

Note:

There are two scenarios for getting the PID:

Scenario 1
Savepoints always get the PID of the root process when the process containing a savepoint is called via the root process. This scenario is shown in the above output. Here, the PIDs are identical for all the savepoints retrieved.

Scenario 2
If the process with the savepoint is not called with the root process, the PID of the process with the savepoint is used.

Example for scenario 2:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Savepoints>
<Savepoint id="2be2eab5-317e-4c02-9896-7de77c4fa217">
<PID>1675418719043677647</PID>
<PUID>eab1040b-6635-4d64-9cbf-f613ace4291d</PUID>
<Repository>1</Repository>
<Project>SavePoints</Project>
<Process>Processes/SaveMe.wrf</Process>
<NextAction_ID>2</NextAction_ID>
<Savepoint id="44d7e9b5-5fa2-403e-8645-dee669dc69d0">
<PID>1675418719054967421</PID>
<PUID>88ffaa69-92e7-43d4-9ffc-3d36a2a50c2b</PUID>
<Repository>1</Repository>
<Project>SavePoints</Project>
<Process>Processes/SaveMeSubprocess.wrf</Process>
<NextAction_ID>3</NextAction_ID>
</Savepoint>
</Savepoints>



PUID

UUID of the process which was used to get the savepoints

Note:

For savepoints created with an X4 version prior to 7.3, only the PID is retrieved, not the PUID.


Repository

The workspace where the project is stored

Project

Name of the project which contains the Technical Process

Process

Name of the Technical Process where the savepoints are set

NextAction_ID

The Action ID of the element following the savepoint that was set in the process specified in the output

Example for the first savepoint from the above output:

image2023-2-3_11-21-46.png