Description | Query Production Lots |
Name | QueryProductionLotISIIn |
Namespace | http://sap.com/xi/A1S/Global |
Process Component Description | Production |
Process Component Name | Production |
Process Component Namespace | http://sap.com/xi/AP/LogisticsExecution/Global |
Deployment Unit Description | Production and Site Logistics Execution |
Endpoint Activation | By Scoping of Process Component | Operations |
Release Status | Released |
An interface to query production lot data.
The web service interface Query Production Lot In enables external applications to connect to the SAP Business ByDesign system and to query production lots. This is used when external systems want to access and manage production lot data in the system.
It has the FindByElements operation that is used to query for one or more instances of the production order, based on the query filter parameters passed.
Here is an example of a simple web service request:
<n0:ProductionLotByElementsQuery_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <ProductionLotSelectionByElements> <SelectionByProductionLotID> <InclusionExclusionCode>I</InclusionExclusionCode> <IntervalBoundaryTypeCode>1</IntervalBoundaryTypeCode> <LowerBoundaryProductionLotID>34</LowerBoundaryProductionLotID> </SelectionByProductionLotID> <SelectionByProductionLotID> <InclusionExclusionCode>I</InclusionExclusionCode> <IntervalBoundaryTypeCode>1</IntervalBoundaryTypeCode> <LowerBoundaryProductionLotID>18</LowerBoundaryProductionLotID> </SelectionByProductionLotID> </ProductionLotSelectionByElements> <ProcessingConditions> <QueryHitsMaximumNumberValue>2</QueryHitsMaximumNumberValue> <QueryHitsUnlimitedIndicator>false</QueryHitsUnlimitedIndicator> <LastReturnedObjectID/> </ProcessingConditions> </n0:ProductionLotByElementsQuery_sync>
You can find general information about Web services, their structure and consumption in the Web Services documentation.
Here is an example of a web service request that requests for a production lot based on lot ID:
<n0:ProductionLotByElementsQuery_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <ProductionLotSelectionByElements> <SelectionByProductionLotID> <InclusionExclusionCode>I</InclusionExclusionCode> <IntervalBoundaryTypeCode>1</IntervalBoundaryTypeCode> <LowerBoundaryProductionLotID>34</LowerBoundaryProductionLotID> </SelectionByProductionLotID> </ProductionLotSelectionByElements> <ProcessingConditions> <QueryHitsMaximumNumberValue>2</QueryHitsMaximumNumberValue> <QueryHitsUnlimitedIndicator>false</QueryHitsUnlimitedIndicator> <LastReturnedObjectID/> </ProcessingConditions> </n0:ProductionLotByElementsQuery_sync>
Here is an example of a web service request that requests for multiple production lots based on lot ID:
<n0:ProductionLotByElementsQuery_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <ProductionLotSelectionByElements> <SelectionByProductionLotID> <InclusionExclusionCode>I</InclusionExclusionCode> <IntervalBoundaryTypeCode>1</IntervalBoundaryTypeCode> <LowerBoundaryProductionLotID>34</LowerBoundaryProductionLotID> </SelectionByProductionLotID> <SelectionByProductionLotID> <InclusionExclusionCode>I</InclusionExclusionCode> <IntervalBoundaryTypeCode>1</IntervalBoundaryTypeCode> <LowerBoundaryProductionLotID>35</LowerBoundaryProductionLotID> </SelectionByProductionLotID> <SelectionByProductionLotID> <InclusionExclusionCode>I</InclusionExclusionCode> <IntervalBoundaryTypeCode>1</IntervalBoundaryTypeCode> <LowerBoundaryProductionLotID>36</LowerBoundaryProductionLotID> </SelectionByProductionLotID> </ProductionLotSelectionByElements> <ProcessingConditions> <QueryHitsMaximumNumberValue>2</QueryHitsMaximumNumberValue> <QueryHitsUnlimitedIndicator>false</QueryHitsUnlimitedIndicator> <LastReturnedObjectID/> </ProcessingConditions> </n0:ProductionLotByElementsQuery_sync>
Here is an example of a web service request that requests for multiple production lots based on lot status:
<n0:ProductionLotByElementsQuery_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <ProductionLotSelectionByElements> <SelectionByProductionLotStatusCode> <InclusionExclusionCode>I</InclusionExclusionCode> <IntervalBoundaryTypeCode>1</IntervalBoundaryTypeCode> <LowerBoundaryLifeCycleStatusCode>2</LowerBoundaryLifeCycleStatusCode> </SelectionByProductionLotStatusCode> </ProductionLotSelectionByElements> <ProcessingConditions> <QueryHitsMaximumNumberValue>2</QueryHitsMaximumNumberValue> <QueryHitsUnlimitedIndicator>false</QueryHitsUnlimitedIndicator> <LastReturnedObjectID/> </ProcessingConditions> </n0:ProductionLotByElementsQuery_sync>
Here is an example of a web service request that requests for production lots based on production lot creation date time:
Note that the CreationDateTime must have the value in the format
YYYY-MM-DDTHH:MM:SS.1234567Z
<n0:ProductionLotByElementsQuery_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <ProductionLotSelectionByElements> <SelectionByProductionLotCreationDateTime> <InclusionExclusionCode>I</InclusionExclusionCode> <IntervalBoundaryTypeCode>3</IntervalBoundaryTypeCode> <LowerBoundaryDate>2015-11-01T00:00:00.1234567Z</LowerBoundaryDate> <UpperBoundaryDate>2015-11-05T00:00:00.1234567Z</UpperBoundaryDate> </SelectionByProductionLotCreationDateTime> </ProductionLotSelectionByElements> <ProcessingConditions> <QueryHitsUnlimitedIndicator>true</QueryHitsUnlimitedIndicator> </ProcessingConditions> </n0:ProductionLotByElementsQuery_sync>
Here is an example of a response for a request based on a production lot ID:
<nm:ProductionLotByElementsResponse_sync xmlns:nm="http://sap.com/xi/SAPGlobal20/Global" xmlns:prx="urn:sap.com:proxy:ASL:/1SAI/TAS76DC9C8C6F39A625F357:804"> <ProductionLot> <ProductionLotID>33</ProductionLotID> <ProductionOrderID>33</ProductionOrderID> <ProductionOrderUUID>00163e02-8660-1ed1-b7fa-dd4f0db7bcdc</ProductionOrderUUID> <ProductionOrderStatus> <LifeCycleStatusCode>2</LifeCycleStatusCode> <SchedulingStatusCode>3</SchedulingStatusCode> </ProductionOrderStatus> <ProductionLotUUID>00163e02-8638-1ed1-bdcf-5dffd740bd7b</ProductionLotUUID> <ProductionLotStatus> <Life_Cycle_Status_Code>2</Life_Cycle_Status_Code> <Activity_Process_Status_Code>1</Activity_Process_Status_Code> <Rep_Point_Processing_Status_Code>1</Rep_Point_Processing_Status_Code> </ProductionLotStatus> <MainOutputProductSiteID>MC64000</MainOutputProductSiteID> <MainOutputProduct>MCA-0009</MainOutputProduct> <ConfirmationGroup> <ConfirmationGroupUUID>00163e02-8638-1ed1-bdcf-5dffd745dd7b</ConfirmationGroupUUID> <ProcessorObjectTypeCode>100</ProcessorObjectTypeCode> <ProductionTask> <ProductionTaskID>227</ProductionTaskID> <ProducionTaskUUID>00163e02-8638-1ed1-bdcf-5dffd7465d7b</ProducionTaskUUID> <OperationTypeCode listVersionID=" " listAgencyID=" ">1</OperationTypeCode> <ResourceUUID>00300571-ce9b-1ddd-9285-154b873a8ee5</ResourceUUID> <Status> <ProcessingStatusCode>1</ProcessingStatusCode> <StartFeasibilityStatusCode>2</StartFeasibilityStatusCode> </Status> </ProductionTask> <Operation> <OperationID>OPR0010</OperationID> <OperationUUID>00163e02-8638-1ed1-bdcf-5dffd740fd7b</OperationUUID> <TypeCode listVersionID=" " listAgencyID=" ">1</TypeCode> <CategoryCode>1</CategoryCode> <OperationStatus> <Life_Cycle_Status_Code>2</Life_Cycle_Status_Code> <Release_Status_Code>3</Release_Status_Code> <Activit_Processing_Status_Code>1</Activit_Processing_Status_Code> </OperationStatus> <ConfirmMainResourceID>CM-WAM101</ConfirmMainResourceID> <ConfirmMainResourceUUID>00300571-cc0f-02dc-80ec-b13b286a430d</ConfirmMainResourceUUID> <ConfirmationGroupUUID>00163e02-8638-1ed1-bdcf-5dffd745dd7b</ConfirmationGroupUUID> </Operation> <Operation> <OperationID>OPR0050</OperationID> <OperationUUID>00163e02-8638-1ed1-bdcf-5dffd742fd7b</OperationUUID> <TypeCode listVersionID=" " listAgencyID=" ">1</TypeCode> <CategoryCode>1</CategoryCode> <OperationStatus> <Life_Cycle_Status_Code>2</Life_Cycle_Status_Code> <Release_Status_Code>3</Release_Status_Code> <Activit_Processing_Status_Code>1</Activit_Processing_Status_Code> </OperationStatus> <ConfirmMainResourceID>CM-WAC101</ConfirmMainResourceID> <ConfirmMainResourceUUID>00300571-ce9b-1ddd-9285-154b873a8ee5</ConfirmMainResourceUUID> <ConfirmationGroupUUID>00163e02-8638-1ed1-bdcf-5dffd745dd7b</ConfirmationGroupUUID> </Operation> <Activity> <ActivityID>ACT0010</ActivityID> <ActivityUUID>00163e02-8638-1ed1-bdcf-5dffd7415d7b</ActivityUUID> <ActivityStatus> <Activity_Status_Code>3</Activity_Status_Code> <Processing_Status_Code>1</Processing_Status_Code> </ActivityStatus> <TypeCode>1</TypeCode> <CategoryCode>1</CategoryCode> <ConfirmationGroupUUID>00163e02-8638-1ed1-bdcf-5dffd745dd7b</ConfirmationGroupUUID> <ResourceUtilization> <ResourceID>CM-WAM101</ResourceID> <ResourceType>1</ResourceType> <MainResource>true</MainResource> <NumberOfResources>0</NumberOfResources> <TotalConfirmedCapacityConsumption>PT0S</TotalConfirmedCapacityConsumption> <ConfirmedDuration>PT0S</ConfirmedDuration> <ConfirmationFinished>false</ConfirmationFinished> <ResourceUtilisationUUID>00163e07-3d62-1ee4-8a8b-3cd0da81012b</ResourceUtilisationUUID> </ResourceUtilization> <Service> <ServiceUUID>00163e02-8638-1ed1-bdcf-5dffd741fd7b</ServiceUUID> <ServiceID>MCPRDCE001</ServiceID> <ServiceDescription>On-Site Repair - Gas fueled boiler</ServiceDescription> <ResourceID>CM-WAM101</ResourceID> <ResourceDescription> <ServiceResourceDescription languageCode="EN">Washing Machine 001</ServiceResourceDescription> </ResourceDescription> <MainResource>true</MainResource> <ServiceConsumptionCalculationMethodCode>1</ServiceConsumptionCalculationMethodCode> </Service> </Activity> <Activity> <ActivityID>ACT0020</ActivityID> <ActivityUUID>00163e02-8638-1ed1-bdcf-5dffd7421d7b</ActivityUUID> <ActivityStatus> <Activity_Status_Code>3</Activity_Status_Code> <Processing_Status_Code>1</Processing_Status_Code> </ActivityStatus> <TypeCode>2</TypeCode> <CategoryCode>2</CategoryCode> <ConfirmationGroupUUID>00163e02-8638-1ed1-bdcf-5dffd745dd7b</ConfirmationGroupUUID> <ResourceUtilization> <ResourceID>CM-WAM101</ResourceID> <ResourceType>1</ResourceType> <MainResource>true</MainResource> <NumberOfResources>0</NumberOfResources> <TotalConfirmedCapacityConsumption>PT0S</TotalConfirmedCapacityConsumption> <ConfirmedDuration>PT0S</ConfirmedDuration> <ConfirmationFinished>false</ConfirmationFinished> <ResourceUtilisationUUID>00163e07-3d91-1ee4-8a8b-3cd0da81012b</ResourceUtilisationUUID> </ResourceUtilization> <Service> <ServiceUUID>00163e02-8638-1ed1-bdcf-5dffd742dd7b</ServiceUUID> <ServiceID>MCPRDCE001</ServiceID> <ServiceDescription>On-Site Repair - Gas fueled boiler</ServiceDescription> <ResourceID>CM-WAM101</ResourceID> <ResourceDescription> <ServiceResourceDescription languageCode="EN">Washing Machine 001</ServiceResourceDescription> </ResourceDescription> <MainResource>true</MainResource> <ServiceConsumptionCalculationMethodCode>1</ServiceConsumptionCalculationMethodCode> </Service> </Activity> <Activity> <ActivityID>ACT0110</ActivityID> <ActivityUUID>00163e02-8638-1ed1-bdcf-5dffd7435d7b</ActivityUUID> <ActivityStatus> <Activity_Status_Code>3</Activity_Status_Code> <Processing_Status_Code>1</Processing_Status_Code> </ActivityStatus> <TypeCode>1</TypeCode> <CategoryCode>1</CategoryCode> <ConfirmationGroupUUID>00163e02-8638-1ed1-bdcf-5dffd745dd7b</ConfirmationGroupUUID> <ResourceUtilization> <ResourceID>CM-WAC101</ResourceID> <ResourceType>1</ResourceType> <MainResource>true</MainResource> <NumberOfResources>0</NumberOfResources> <TotalConfirmedCapacityConsumption>PT0S</TotalConfirmedCapacityConsumption> <ConfirmedDuration>PT0S</ConfirmedDuration> <ConfirmationFinished>false</ConfirmationFinished> <ResourceUtilisationUUID>00163e17-3d62-1ee4-8a8b-3cd0da81012b</ResourceUtilisationUUID> </ResourceUtilization> <Service> <ServiceUUID>00163e02-8638-1ed1-bdcf-5dffd743fd7b</ServiceUUID> <ServiceID>MCPRDCE001</ServiceID> <ServiceDescription>On-Site Repair - Gas fueled boiler</ServiceDescription> <ResourceID>CM-WAC101</ResourceID> <ResourceDescription> <ServiceResourceDescription languageCode="EN">Work Station - Assembling Hot Water Cyl</ServiceResourceDescription> </ResourceDescription> <MainResource>true</MainResource> <ServiceConsumptionCalculationMethodCode>1</ServiceConsumptionCalculationMethodCode> </Service> </Activity> <Activity> <ActivityID>ACT0120</ActivityID> <ActivityUUID>00163e02-8638-1ed1-bdcf-5dffd7441d7b</ActivityUUID> <ActivityStatus> <Activity_Status_Code>3</Activity_Status_Code> <Processing_Status_Code>1</Processing_Status_Code> </ActivityStatus> <TypeCode>2</TypeCode> <CategoryCode>2</CategoryCode> <ConfirmationGroupUUID>00163e02-8638-1ed1-bdcf-5dffd745dd7b</ConfirmationGroupUUID> <ResourceUtilization> <ResourceID>CM-WAC101</ResourceID> <ResourceType>1</ResourceType> <MainResource>true</MainResource> <NumberOfResources>0</NumberOfResources> <TotalConfirmedCapacityConsumption>PT0S</TotalConfirmedCapacityConsumption> <ConfirmedDuration>PT0S</ConfirmedDuration> <ConfirmationFinished>false</ConfirmationFinished> <ResourceUtilisationUUID>00163e07-3d62-1ee4-8a8b-3cd0da81019b</ResourceUtilisationUUID> </ResourceUtilization> <Service> <ServiceUUID>00163e02-8638-1ed1-bdcf-5dffd744fd7b</ServiceUUID> <ServiceID>MCPRDCE001</ServiceID> <ServiceDescription>On-Site Repair - Gas fueled boiler</ServiceDescription> <ResourceID>CM-WAC101</ResourceID> <ResourceDescription> <ServiceResourceDescription languageCode="EN">Work Station - Assembling Hot Water Cyl</ServiceResourceDescription> </ResourceDescription> <MainResource>true</MainResource> <ServiceConsumptionCalculationMethodCode>1</ServiceConsumptionCalculationMethodCode> </Service> </Activity> <MaterialInput> <MaterialInputUUID>00163e02-8638-1ed1-bdcf-5dffd7427d7b</MaterialInputUUID> <ProductID>MCA-0010</ProductID> <ProductUUID>00300571-ce9b-1ddd-8ae6-21708d198264</ProductUUID> <SupplyPlanningArea>MC64000</SupplyPlanningArea> <ActivityID>ACT0020</ActivityID> <ActivityType>2</ActivityType> <ActivityUUID>00163e02-8638-1ed1-bdcf-5dffd7421d7b</ActivityUUID> <ConfirmLogisticsAreaID>MC64050-10</ConfirmLogisticsAreaID> <ConfirmationMethodCode>1</ConfirmationMethodCode> <LineItemGroupID>ASSEMBLED_CYLINDER</LineItemGroupID> <PlannedQuantity unitCode="EA">5.0</PlannedQuantity> <OperationID>OPR0010</OperationID> <SourceLogisticsAreaID>MC64050-10</SourceLogisticsAreaID> <SiteID>MC64000</SiteID> <SiteDescription> <SiteDescription languageCode="EN">AHT Kokomo</SiteDescription> </SiteDescription> <TotalConfirmedQuantity unitCode="EA">0.0</TotalConfirmedQuantity> <PlannedIndicator>true</PlannedIndicator> </MaterialInput> <MaterialInput> <MaterialInputUUID>00163e02-8638-1ed1-bdcf-5dffd7447d7b</MaterialInputUUID> <ProductID>MCR-0015</ProductID> <ProductUUID>00300571-ce9b-1ded-8ae7-84e7f0d5cef2</ProductUUID> <SupplyPlanningArea>MC64000</SupplyPlanningArea> <ActivityID>ACT0120</ActivityID> <ActivityType>2</ActivityType> <ActivityUUID>00163e02-8638-1ed1-bdcf-5dffd7441d7b</ActivityUUID> <ConfirmLogisticsAreaID>MC64050-10</ConfirmLogisticsAreaID> <ConfirmationMethodCode>1</ConfirmationMethodCode> <LineItemGroupID>INSULATION</LineItemGroupID> <PlannedQuantity unitCode="EA">5.0</PlannedQuantity> <OperationID>OPR0050</OperationID> <SourceLogisticsAreaID>MC64050-10</SourceLogisticsAreaID> <SiteID>MC64000</SiteID> <SiteDescription> <SiteDescription languageCode="EN">AHT Kokomo</SiteDescription> </SiteDescription> <TotalConfirmedQuantity unitCode="EA">0.0</TotalConfirmedQuantity> <PlannedIndicator>true</PlannedIndicator> </MaterialInput> <MaterialOutput> <MaterialOutputUUID>00163e02-8638-1ed1-bdcf-5dffd744bd7b</MaterialOutputUUID> <ProductID>MCA-0009</ProductID> <ProductUUID>00300571-c7cc-02db-b9cd-7dcb2c178052</ProductUUID> <SupplyPlanningArea>MC64000</SupplyPlanningArea> <ActivityID>ACT0120</ActivityID> <ActivityType>2</ActivityType> <ActivityUUID>00163e02-8638-1ed1-bdcf-5dffd7441d7b</ActivityUUID> <TargetLogisticsAreaID>MC64050-20</TargetLogisticsAreaID> <PlannedIndicator>true</PlannedIndicator> <OperationID>OPR0050</OperationID> <PlannedQuantity unitCode="EA">5.0</PlannedQuantity> <TotalConfirmedQuantity unitCode="EA">0.0</TotalConfirmedQuantity> <OpenQuantity unitCode="EA">5.0</OpenQuantity> <SiteID>MC64000</SiteID> <SiteDescription> <SiteDescription languageCode="EN">AHT Kokomo</SiteDescription> </SiteDescription> <MaterialOutputInspection> <InspectionSamplingDetails> <ProductDescription>Hot Water Cylinder (75)</ProductDescription> </InspectionSamplingDetails> </MaterialOutputInspection> </MaterialOutput> <ReportingPoint> <ReportingPointID>RPP0030</ReportingPointID> <ReportingPointUUID>00163e02-8638-1ed1-bdcf-5dffd7455d7b</ReportingPointUUID> <ReportingPointStatus> <LifeCycleStatusCode>2</LifeCycleStatusCode> <ReportingPointProcessingStatusCode>1</ReportingPointProcessingStatusCode> </ReportingPointStatus> <TotalConfirmedQuantity unitCode="EA">0.0</TotalConfirmedQuantity> <TotalConfirmedScrap unitCode="EA">0.0</TotalConfirmedScrap> <OpenQuantity unitCode="EA">5.0</OpenQuantity> <PlannedQuantity unitCode="EA">5.0</PlannedQuantity> </ReportingPoint> </ConfirmationGroup> </ProductionLot> <ProcessingConditions> <ReturnedQueryHitsNumberValue>1</ReturnedQueryHitsNumberValue> <MoreHitsAvailableIndicator>true</MoreHitsAvailableIndicator> <LastReturnedObjectID>00163E0286381ED1BDCF5DFFD740BD7B</LastReturnedObjectID> </ProcessingConditions> </nm:ProductionLotByElementsResponse_sync>
Description | Find production lots |
Name | FindByElements |
Synchronous | yes |
Release Status | Released |
To query production lot data.
The web service interface QueryProductionLotISIIn offers the operation FindByElements, which is used to query for one or more instances of production lots based on the query filter parameters passed.
Name : QueryProductionLotISIIn (II_QUERY_PROD_LOT_IN)
Operation : FindByElements (QUERY_BY_ELEMENT)
Package : AP_PRODUCTION_LOT_CSX
Implementing Process agent : FIND_PROD_LOT
Leading BO Name : ProductionLot (PRODUCTION_LOT)
The request message of the operation FindByElements contains the ProductionLotSelectionByElements node that groups all possible selection parameters.
Below is the list of available selection parameters:
SEL_BY_PROD_ORD_ID | SelectionByProductionOrderID | |
SEL_BY_PROD_REQ_ID | SelectionByProductionOrderRequestID | |
SEL_BY_PROD_ORD_STATUS | SelectionByProductionOrderStatus | |
SEL_BY_SCHEDULE_STATUS | SelectionByProductionOrderScheduleStatus | |
SEL_BY_REQ_START | SelectionByProductionOrderRequestStart | |
SEL_BY_REQ_END | SelectionByProductionOrderRequestEnd | |
SEL_BY_LATEST_START | SelectionByProductionOrderLatestStart | |
SEL_BY_LATEST_END | SelectionByProductionOrderLatestEnd | |
SEL_BY_PRD_ORD_REL_DUE_DATE | SelectionByProductionOrderDueDate | |
SEL_BY_OUT_PROD_ID | SelectionByProductID | |
SEL_BY_OUT_PROD_DESC | SelectionByProductDescription | |
SEL_BY_OUT_PROD_SPEC_ID | SelectionByProductSpecificationID | |
SEL_BY_OUT_PROD_SPEC_DESC | SelectionByProductSpecificationDescription | |
SEL_BY_OUT_PROD_GRP | SelectionByProductGroup | |
SEL_BY_ORG_SITE_ID | SelectionBySiteID | |
SEL_BY_CREATION_DATE_TIME | SelectionByProductionLotCreationDateTime | |
SEL_BY_LAST_CHANGE_DATE_TIME | SelectionByProductionLotLastChangeDateTime |
The response contains the list of found production lots, log items, and processing conditions.
In the ProductionLot node, all found production lots are contained according to the selection parameters provided in the query request.
Below is the list of available production lot elements and their corresponding business contexts with the UI.
Production Lot
After a certain quantity of materials is produced as a group with reference to an order, the production lot collects all the actual information during the production process that is described by operations and activities. The ProductionLot node element maintains this information.
The following are the elements of this node:
Elements | Description |
---|---|
ProductionLotId | Unique identifier of a production lot |
ProductionOrderID | Unique identifier of a production order |
ProductionOrderUUID | Universally unique identifier of the production order, which is assigned in order to reference a specific production order that triggered the logistics lot creation |
ProductionOrderStatus | The current step in the lifecycle of production order |
ProductionLotUUID | Universally unique identifier of a logistics lot for referencing purposes |
ProductionLotStatus | The current step in the lifecycle of production lot |
MainOutputProductSiteID | Unique identifier of output product site id |
MainOutputProduct | Unique identifier of output product id |
ProductionStartDate | Specifies the start date of the logistics lot |
ProductionEndDate | Specifies the end date of the logistics lot, where the logistics process of a logistics lot was finished |
ConfirmationGroup | The grouping of all components of a logistics lot, which are relevant for the confirmation based on predefined rules. Its structure is explained in the Confirmation Group section. |
Below is the coded representation of the statuses used in the ProductionLot node:
Production Order Status
Production Order – Lifecycle Status Code
Code Value | Description |
---|---|
1 | In Process |
2 | Released |
3 | Started |
4 | Finished |
5 | Closed |
6 | Cancelled |
Production Order – Scheduling Status Code
Code Value | Description |
---|---|
1 | Not Scheduled |
2 | Basic Dates Scheduled |
3 | Scheduled |
Production Lot Status
Production Lot – Lifecycle Status Code
Code Value | Description |
---|---|
1 | In Preparation |
2 | Released |
3 | Started |
4 | Finished |
5 | Closed |
6 | Cancelled |
Production Lot – Activity Process Status Code
Code Value | Description |
---|---|
1 | Not Started |
2 | In Process |
3 | Finished |
4 | Not Relevant |
5 | Interrupted |
Production Lot – Reporting Point Status Code
Code Value | Description |
---|---|
1 | Not Started |
2 | In Process |
3 | Finished |
4 | Not Relevant |
5 | Interrupted |
The ConfirmationGroup node can be used to maintain the grouping of all components of a logistics lot, which are relevant for the confirmation based on predefined rules.
The following are the elements of this node:
Elements | Description |
---|---|
ConfirmationGroupUUID | Universally unique identifier of a confirmation group |
ProcessorObjectTypeCode | Specifies the type of the processor object, for example, production task, site logistics task or BTM task |
ProductionTask | A task in production that a processor executes at a specific time at a predefined production step in a production process. Its structure is explained in the Production Task section . |
Operation | A self-contained part of a logistic process that was carried out by one or more resources within a predefined time, and could be divided into one or more activities. Its structure is explained in the Operation section. |
Activity | A part of an operation in which a material was produced, packed or transported, and includes the actual duration taken to complete the current activity. Its structure is explained in the Activity section. |
MaterialInput | Input materials needed to create a product. Its structure is defined in the Material Input section. |
MaterialOutput | Output product. Its structure is defined in the Material Output section. |
ReportingPoint | A milestone in the logistics process in which actual quantities are reported. Its structure is defined in the Reporting Point section. |
Production Task
The ProductionTask node can be used to represent a task in production that a processor executes at a specific time in a predefined production step in a production process.
The following are the elements of this node:
Elements | Description |
---|---|
ProductionTaskID | An identifier for a production task |
ProducionTaskUUID | A globally unique identifier for a production task for referencing purposes |
OperationTypeCode | A coded representation of the operation type of the logistics task. Its default value is taken from the referenced production lot operation. If a production task references more than one operation, the type that directly precedes the reporting point is related to the operation. |
OperationActivityTypeCode | A coded representation of the operation activity type of the production task. Its default value is taken from the referenced production lot operation activity for the production task. |
ResourceUUID | An identifier for the resource of a logistics task. For the production task, the default value is taken from the main operation resource of the production order referenced by the logistics task. If a production task references more than one operation, the resource that directly precedes the reporting point is related to the operation. |
Status | The status of the current step in the life cycle of the root node |
Below is the coded representation of the statuses used in the ProductionTask node:
Operation Type Code
Code Value | Description |
---|---|
1 | Make |
10 | Supply |
11 | Put Away |
12 | Unload |
13 | Returns Put Away |
14 | Returns Unload |
21 | Pick |
22 | Load |
23 | Returns Pick |
24 | Returns Load |
30 | Replenish |
31 | Remove |
8 | Check |
Operation Activity Type Code
Code Value | Description |
---|---|
1 | Set Up |
10 | Final Inspection |
11 | Move All |
12 | Move per Item |
13 | Supply |
2 | Produce |
3 | Tear Down |
4 | Move per Source and Destination |
5 | Move per Destination |
6 | Move per Source |
Status
Status – Processing Status Code
Code Value | Description |
---|---|
1 | Not Started |
2 | In Process |
3 | Finished |
4 | Not Relevant |
5 | Interrupted |
Status – Feasibility Status Code
Code Value | Description |
---|---|
1 | Not Feasible |
2 | Feasible |
3 | Partially Feasible |
4 | Not Relevant |
Operation
The Operation node can be used to maintain a self-contained part of a logistic process that was carried out by one or more resources within a predefined time, and that could be divided into one or more activities.
The following are the elements of this node:
Elements | Description |
---|---|
OperationID | Unique identifier of an operation in the production lot |
OperationUUID | Universally unique identifier of an operation for referencing purposes |
TypeCode | Specifies the type of the operation, for example, make and pack cases, or pick full pallet |
CategoryCode | Specifies the category of this operation, for example, pack, make or move |
OperationStatus | The current step in the life cycle of the operation |
StartDateTime | Specifies the start date and time of the operation |
EndDateTime | Specifies the end date of the operation, that is, when the logistics process of an operation is finished |
ConfirmMainResourceID | Unique identifier of the main resource to be confirmed at the operation |
ConfirmMainResourceUUID | Universally unique identifier of the main resource to be confirmed at the operation |
ConfirmationGroupUUID | Universally unique identifier of the confirmation group, which is assigned to reference the specific confirmation group to which the operation belongs |
Below is the coded representation of the statuses used in the ProductionTask node:
Type Code
Code Value | Description |
---|---|
1 | Set Up |
10 | Final Inspection |
11 | Move All |
12 | Move per Item |
13 | Supply |
2 | Produce |
3 | Tear Down |
4 | Move per Source and Destination |
5 | Move per Destination |
6 | Move per Source |
Category Code
Code Value | Description |
---|---|
1 | Make |
10 | Supply |
2 | Pack |
3 | Move |
4 | Material Count |
5 | Logistic Unit Count |
6 | Handling Unit Count |
7 | Count Approval |
8 | Quality Check |
Operation Status
Operation Status – Lifecycle Status Code
Code Value | Description |
---|---|
1 | In Preparation |
2 | Released |
3 | Started |
4 | Finished |
5 | Closed |
6 | Cancelled |
Operation Status – Release Status Code
Code Value | Description |
---|---|
1 | Not Released |
2 | Partially Released |
3 | Released |
4 | Release Discarded |
5 | Release Cancelled |
6 | Not Relevant |
7 | Release Cancellation Requested |
Operation Status – Processing Status Code
Code Value | Description |
---|---|
1 | Not Started |
2 | In Process |
3 | Finished |
4 | Not Relevant |
5 | Interrupted |
Activity
The Activity node can be used to maintain a part of an operation in which a material was produced, packed or transported, and includes the actual duration taken to complete the current activity.
The following are the elements of this node:
Elements | Description |
---|---|
ActivityID | Unique identifier of the operation activity. It is unique within the operation. |
ActivityUUID | Universally unique identifier of the operation activity for referencing purposes |
ActivityStatus | The current step in the lifecycle of the operation activity |
TypeCode | Specifies the type of the operation activity, for example, setup, make, and single move |
CategoryCode | Describes the main usage of the operation activity, for example, produce, teardown, single move, or collective move |
MaterialInspectionUUID | Universally unique identifier of the material inspection that will inspect the material resulting from the check activity |
StartDateTime | Specifies the start date and time of the activity |
EndDateTime | Specifies the end date of the operation activity, that is, when the logistics process of an operation activity is finished |
ConfirmationCompletedIndicator | Indicates whether all confirmations have been entered for the operation activity step |
ConfirmationGroupUUID | Universally unique identifier of the confirmation group, which is assigned to reference the specific confirmation group to which the operation activity belongs |
ResourceUtilization | The resource used to fulfill an operation activity. Its structure is explained in the Resource Utilization section. |
Service | The service product used to perform an operation activity. Its structure is explained in the Service section. |
Below is the coded representation of the statuses used in the Activity node:
Activity Status
Activity Status – Release Status Code
Code Value | Description |
---|---|
1 | Not Released |
2 | Partially Released |
3 | Released |
4 | Release Discarded |
5 | Release Cancelled |
6 | Not Relevant |
7 | Release Cancellation Requested |
Activity Status – Processing Status Code
Code Value | Description |
---|---|
1 | Not Started |
2 | In Process |
3 | Finished |
4 | Not Relevant |
5 | Interrupted |
Type Code
Code Value | Description |
---|---|
1 | Set Up |
10 | Final Inspection |
11 | Move All |
12 | Move Per Item |
13 | Supply |
2 | Produce |
3 | Tear Down |
4 | Move per Source and Destination |
5 | Move per Destination |
6 | Move per Source |
Category Code
Code Value | Description |
---|---|
1 | Set Up |
10 | Quality Check |
11 | Move All |
12 | Move per Item |
2 | Produce |
3 | Tear Down |
4 | Move per Source and Destination |
5 | Move per Destination |
6 | Move per Source |
7 | Pack |
8 | Unpack |
9 | Homogenous Pack |
Resource Utilization
The ResourceUtilization node can be used to represent the resource used to fulfill an operation activity.
The following are the elements of this node:
Elements | Description |
---|---|
ResourceGroupID | Universally unique identifier of the resource group that contains the resource that will be confirmed at the ResourceUtilisation node |
ResourceGroupDescription | An explanation of the properties of a resource |
ResourceID | Unique identifier of the resource to be confirmed at the ResourceUtilisation node |
ResourceType | Type of resource, for example, equipment, vehicle, or labor |
MainResource | Indicates whether a resource utilization refers to a main resource |
NumberOfResources | Defines the number of resources that will be used simultaneously in a logistics process |
TotalConfirmedCapacityConsumption | Aggregated duration reported in multiple resource utilization confirmations |
ConfirmedDuration | Time period reported at the resource utilization |
ConfirmationFinished | Indicates that the resource utilization will not be confirmed any more |
Service
The Service node can be used to maintain the service product that was used to perform an operation activity.
The following are the elements of this node:
Elements | Description |
---|---|
ServiceUUID | Universally unique identifier of the service being done as part of an activity |
ServiceID | Unique identifier of the service being done as part of an activity |
ServiceDescription | Description of the service |
ResourceID | Unique identifier of the resource being used for the service |
ResourceDescription | Description of the resource being used for the service |
MainResource | Indicates whether a resource utilization refers to a main resource |
TotalConfirmedQuantity | Aggregated quantity that was reported during confirmation |
ConfirmedQuantity | Quantity to be confirmed |
ConfirmationFinished | Indicates if confirmation is over |
ServiceConsumptionCalculationMethodCode | Describes the calculation method for the service product consumption |
Material Input
The MaterialInput node can be used to manage input materials needed to create a product.
The following are the elements of this node:
Elements | Description |
---|---|
MaterialInputUUID | Universally unique identifier for a material input for referencing purposes |
ProductID | Unique identifier of the product |
ProductUUID | Universally unique identifier of the product for referencing purposes |
SupplyPlanningArea | An identifier for an area in planning for which the punctual availability of products is guaranteed |
IdentifiedStockDescription | Description of an identified stock |
IdentifiedStockType | Type of an identified stock |
IdentifiedStockID | Unique identifier of an identified stock |
ActivityID | Unique identifier of the operation activity. It is unique within the operation. |
ActivityType | Specifies the type of the operation activity, for example, setup, make, or single move |
ActivityUUID | Universally unique identifier of the operation activity for referencing purposes |
ConfirmLogisticsAreaID | Unique identifier of the logistics area to be confirmed at the material input |
ConfirmationMethodCode | Specifies which procedure should be used to confirm the material input - backflush (default), explicit |
ConfirmationFinished | Indicates whether all confirmations have been entered for this material input |
ProductSpecificationID | An identifier for a requirement specification that is unique within one system |
ProductSpecificationDescription | An explanation of the properties of a product requirement specification |
ConfirmQuantity | Quantity to be confirmed at the material input |
LineItemGroupID | An identifier for the bill of the material item group |
PlannedQuantity | Planned input quantity |
OperationID | Unique identifier of the operation in which an unplanned material input entered a process |
SourceLogisticsAreaID | Unique identifier of the logistics area to be confirmed at the material input |
SiteID | Unique identifier of a site |
SiteDescription | Description of a site |
TotalConfirmedQuantity | Aggregated quantity that was reported during a confirmation |
PlannedIndicator | Indicates whether the material input has been planned in the production order |
InputProductQuantity | Quantity to be confirmed at the material input |
Below is the coded representation of the statuses used in the MaterialInput node:
Identified Stock Type
Code Value | Description |
---|---|
1 | Batch |
2 | Lot |
3 | Optional Specified Stock |
4 | Mandatory Specified Stock |
Activity Type
Code Value | Description |
---|---|
1 | Set Up |
10 | Final Inspection |
11 | Move All |
12 | Move Per Item |
13 | Supply |
2 | Produce |
3 | Tear Down |
4 | Move per Source and Destination |
5 | Move per Destination |
6 | Move per Source |
Material Output
The MaterialOutput node can be used to maintain the output product of the production process.
The following are the elements of this node:
Elements | Description |
---|---|
MaterialOutputUUID | Universally unique identifier for a material output for referencing purposes |
ProductID | Unique identifier of the product |
ProductUUID | Universally unique identifier of the product for referencing purposes |
SupplyPlanningArea | An identifier for an area in planning for which the punctual availability of products is guaranteed |
IdentifiedStockDescription | Description of an identified stock |
IdentifiedStockType | Type of an identified stock |
IdentifiedStockID | Unique identifier of an identified stock |
ActivityID | Unique identifier of the operation activity. It is unique within the operation. |
ActivityType | Specifies the type of the operation activity, for example, setup, make, or single move |
ActivityUUID | Universally unique identifier of the operation activity for referencing purposes |
TargetLogisticsAreaID | Unique identifier of the logistics area to be confirmed at the material output |
ConfirmationFinished | Indicates whether all confirmations have been entered for the material output |
PlannedIndicator | Indicates whether the material output has been planned in the site logistics order or the site logistics request |
OperationID | Unique identifier of the operation involved in the material output |
PlannedQuantity | Planned quantity at the material output |
TotalConfirmedQuantity | The total quantity that was reported during confirmation |
OpenQuantity | Open quantity at the material output |
ProductSpecificationID | Unique identifier of the product requirement specification that specifies the product in detail |
ProductSpecificationDescription | Description of product requirement specification |
SiteID | Unique identifier of site |
SiteDescription | Description of site |
MaterialOutputInspection | A document that describes the execution of an inspection for a particular material, and that is used to record this inspection. Its structure is explained in the Inspection section. |
Material Output Inspection
The MaterialOutputInspection node can be used to maintain a document that describes the execution of an inspection for a particular material, and that is used to record this inspection.
The following are the elements of this node:
Elements | Description |
---|---|
InspectionId | Unique identifier for a material inspection |
InspectionTypeCode | Type code that defines the logistical process during which the material inspection is performed, for example, the goods receipt |
LifeCycleStatusCode | The current step in the life cycle of the material inspection |
InspectionSamplingDetails | Information related to sample used for sampling. See the Inspection Sampling Details section for detailed structure. |
InspectionDetails | Details of inspection. See the Inspection Details section for detailed structure. |
InspectionDefects | Details of defects found in material inspection. See the Inspection Defects section for detailed structure. |
Below is the coded representation of the statuses used in the Inspection nodes:
Inspection Type Code
Code Value | Description |
---|---|
1 | Receiving Inspection - Supplier Delivery |
10 | In-process Inspection – Production |
14 | Receiving Inspection - First Article |
2 | Receiving Inspection - Customer Return |
4 | Receiving Inspection - Stock Transfer |
5 | Final Inspection - Production |
9 | Final Inspection - Customer Shipment |
Life Cycle Status Code
Code Value | Description |
---|---|
1 | New |
2 | Released |
3 | Inspection Prepared |
4 | Results Recorded |
5 | Decision Made |
6 | Decision Revoked |
7 | Cancelled |
Inspection Sampling Details
The InspectionSamplingDetails node can be used to maintain information related to sample that is used for sampling.
The following are the elements of this node:
Elements | Description |
---|---|
ProductId | Unique identifier of the product under inspection |
ProductDescription | Description of the product under inspection |
IdentifiedStockId | Unique identifier of the identified stock |
IdentifiedStockType | Type of identified stock |
LotQuantity | Specifies the lot size of inspection. The lot size is the quantity of the material to be inspected. The unit of measure can be defined outside the material inspection. |
LotSize | Quantity of the material to be inspected in a discrete unit of measure relevant for the material inspection. In a sampling inspection, this quantity is used as the basis for calculating the sample size. Only countable quantities that do not have a dimension and have a corresponding unit can be used. |
SampleSize | Sample size for a sampling inspection. The sample size describes the number of units that are to be taken from a quantity of discrete units of the material to be inspected (InspectionQuantity node). |
SampleQuantity | Sample drawing quantity that should be taken from every unit of the sample size |
SampleRecords | Specifies whether physical samples can be used, that is, whether there is a unique record in the system for this sample. |
Below is the coded representation of the statuses used in the InspectionSamplingDetails node:
Identified Stock Type
Code Value | Description |
---|---|
1 | Batch |
2 | Lot |
3 | Optional Specified Stock |
4 | Mandatory Specified Stock |
Inspection Details
The InspectionDetails node can be used to maintain the details of inspection.
The following are the elements of this node:
Elements | Description |
---|---|
EvaluationMode | Defines if and how an automatic evaluation of the inspection result should take place. The evaluation can be performed based on non-conforming units or based on the number of defects. |
InspectedQuantity | Quantity that was actually inspected |
DestructedQuantity | Quantity that was destructed |
NonConformingUnits | Number of non-conforming units in the inspected quantity |
InspectedBy | Unique identifier of an employee who processes an inspection |
EmployeeName | Name of the employee who processes a given inspection |
ProposedEvaluation | Result of the system's valuation proposal for the material inspection with regard to the acceptance or rejection of the total quantity for the continued business process |
Below is the coded representation of the statuses used in the InspectionDetails node:
Evaluation Mode
Code Value | Description |
---|---|
No evaluation mode selected | |
1 | Evaluation based on nonconforming units |
3 | Evaluation based on number of defects |
5 | Manual evaluation |
Inspection Defects
The InspectionDefects node can be used to maintain the details of defects found in material inspection.
The following are the elements of this node:
Elements | Description |
---|---|
DefectCode | Unique identifier of defect |
DefectName | Name of defect |
DefectDescription | Description of defect |
NumberOfDefects | Specifies how frequently the finding occurs |
InternalDefects | Number of internal defects. Usually, these defects originate in the internal logistic chain. |
ChangedOn | Administrative data that is stored in a system. This data includes system users and changed dates/times. |
ChangedBy | Identifies what changed the finding within a material inspection |
Reporting Point
The ReportingPoint node can be used to maintain a milestone in the logistics process at which actual quantities are reported.
The following are the elements of this node:
Elements | Description |
---|---|
ReportingPointID | Unique identifier of the reporting point. It is unique within the production lot |
ReportingPointUUID | Universally unique identifier for the reporting point for referencing purposes |
ReportingPointStatus | The current step in the lifecycle of reporting point |
TotalConfirmedQuantity | Total confirmed quantity at the reporting point |
ConfirmedQuantity | Quantity to be confirmed at the reporting point |
TotalConfirmedScrap | Total confirmed scrap quantity at the reporting point |
ConfirmedScrap | Scrap quantity to be confirmed at the reporting point |
OpenQuantity | Open quantity at the reporting point |
DeviationReason | Specifies the reason for the deviation that is confirmed at the reporting point, for example, missing parts or resource breakdown |
PlannedQuantity | Planned quantity at the reporting point |
ConfirmationFinishedIndicator | Indicates whether all confirmations have been entered for the reporting point |
Below is the coded representation of the statuses used in the ReportingPoint node:
Reporting Point Status
Reporting Point – Lifecycle Status Code
Code Value | Description |
---|---|
1 | In Preparation |
2 | Released |
3 | Started |
4 | Finished |
5 | Closed |
6 | Cancelled |
Reporting Point – Processing Status Code
Code Value | Description |
---|---|
1 | Not Started |
2 | In Process |
3 | Finished |
4 | Not Relevant |
5 | Interrupted |
Deviation Reason Code
Code Value | Description |
---|---|
001 | Resource Failure |
002 | Resource Unclean |
003 | Maintenance |
004 | Tool missing |
005 | Tool broken |
006 | Material damage |
007 | Quality issue |
008 | Invalid operation |
011 | Missing part |
020 | Peak time |
021 | Unplanned Order |
Z10 | Broken Parts |
This is a sample request for a simple wild card query and to return only 30 production lots.
<n0:ProductionLotByElementsQuery_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <ProductionLotSelectionByElements> <SelectionByProductionLotID> <InclusionExclusionCode>I</InclusionExclusionCode> <IntervalBoundaryTypeCode>1</IntervalBoundaryTypeCode> <LowerBoundaryProductionLotID>*</LowerBoundaryProductionLotID> </SelectionByProductionLotID> </ProductionLotSelectionByElements> <ProcessingConditions> <QueryHitsMaximumNumberValue>30</QueryHitsMaximumNumberValue> <QueryHitsUnlimitedIndicator>false</QueryHitsUnlimitedIndicator> </ProcessingConditions> </n0:ProductionLotByElementsQuery_sync>
Here is another example to query a specific production lot.
<n0:ProductionLotByElementsQuery_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <ProductionLotSelectionByElements> <SelectionByProductionLotID> <InclusionExclusionCode>I</InclusionExclusionCode> <IntervalBoundaryTypeCode>1</IntervalBoundaryTypeCode> <LowerBoundaryProductionLotID>14</LowerBoundaryProductionLotID> </SelectionByProductionLotID> </ProductionLotSelectionByElements> </n0:ProductionLotByElementsQuery_sync>
This interface supports extensibility
Example
The extension fields which are part of material output will be returned as part of the response to the query operation.
Response
<MaterialOutput> <MaterialOutputUUID>00163e02-9066-1ed1-bee1-6b4885b1dca1</MaterialOutputUUID> <ProductID>MCA-0009</ProductID> <ProductUUID>00300571-c7cc-02db-b9cd-7dcb2c178052</ProductUUID> <SupplyPlanningArea>MC64000</SupplyPlanningArea> <ActivityID>ACT0120</ActivityID> <ActivityType>2</ActivityType> <ActivityUUID>00163e02-9066-1ed1-bee1-6b4885b15ca1</ActivityUUID> <TargetLogisticsAreaID>MC64050-20</TargetLogisticsAreaID> <PlannedIndicator>true</PlannedIndicator> <OperationID>OPR0050</OperationID> <PlannedQuantity unitCode="EA">10.0</PlannedQuantity> <TotalConfirmedQuantity unitCode="EA">0.0</TotalConfirmedQuantity> <OpenQuantity unitCode="EA">10.0</OpenQuantity> <SiteID>MC64000</SiteID> <SiteDescription> <SiteDescription languageCode="EN">AHT Kokomo</SiteDescription> </SiteDescription> <n0:EXT12345600163E0290741EE292A110819C698C78 xmlns:n0="http://sap.com/xi/AP/CustomerExtension/BYD/ZZZZZ">Extension Field</n0:EXT12345600163E0290741EE292A110819C698C78> </MaterialOutput>