X4 Produktdokumentation

Operation: List Savepoints

The List Savepoints operation generates a list of the Savepoints set in a process.

Input

The adapter does not expect any input.

Output

The adapter creates an XML document 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 contained in the output:

Element

Description

Savepoint

The id attribute specifies the UUID of the savepoint.

PID

Process ID

Note:

There are two scenarios when retrieving the PID:

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

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 of 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 with which the savepoints were read

Note:

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


Repository

The workspace where the project is stored

Project

Name of the project that contains the Technical Process

Process

Name of the Technical Process in which the savepoints are set

NextAction_ID

The action ID of the element that follows the savepoint that has been set in the process named in the output.

Example of the first savepoint from the output shown above:

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