StartFinalization request message
- Last UpdatedSep 06, 2023
- 2 minute read
This is an example of the full structure of a StartFinalization request.
<StartFinalizationRequestMessage xmlns="http://www.citect.com/Ampla/Inventory/2010/03">
<Request>
<Credentials>
<Password>********</Password>
<Session />
<Username>User</Username>
</Credentials>
<FinalizationateTime>2018-09-01T00:00:00</FinalizationDateTime>
<Comment>Enter comments about this finalization action</Comment>
</Request>
</StartFinalizationRequestMessage>
Request parameters: Credentials section
The Credentials section contains the security details for authentication. You can provide the Username and Password values to use the Basic security method. If you do not provide explicit security values, Web services will attempt to use Integrated authentication. You must provide either Basic credentials, Integrated credentials, or a Session ID.
<Credentials>
<Username>User</Username>
<Password>********</Password>
<Session />
</Credentials>
|
Parameter |
Description |
|---|---|
|
Username |
The login name of the AVEVA™ Production Management user. This is a string value. Username and Password together are mutually exclusive with Session. |
|
Password |
The password that is associated with the AVEVA Production Management user. This is a string value. Username and Password together are mutually exclusive with Session. |
|
Session |
A GUID string value that identifies the session. This is a string value. Mutually exclusive with Username and Password. |
Request parameters: Localization section
The Localization section contains parameters that are relevant to localizing the data for display.
<Localization>
<Language>fr-FR</Language>
< /Localization>
|
Parameter |
Description |
|---|---|
|
Language |
The Windows regional setting to determine the language display of data in the client. This can be any Windows regional setting value, for example, en-AU, en-GB, fr-FR. If no language is specified, the default en-US is used. |
Request parameters: Request section
<Request>
<FinalizationDateTime>2018-09-01T00:00:00</FinalizationFromDateTime>
<FinalizeWithNegativeAndDebtLots>True</FinalizeWithNegativeAndDebtLots>
<FinalizeWithMovementMatchingCriteriaIgnored>False</FinalizeWithMovementMatchingCriteriaIgnored>
</Request>
|
Parameter |
Description |
|---|---|
|
FinalizationDateTime |
The time and date that Ampla should begin finalizing events from. This time must be in UTC ISO 8601 format. |
|
FinalizeWithNegativeAndDebtLots |
When this parameter is True, debt and negative lots are enabled for Finalization processing. If parameter is False and debt or negative lots exist with in the Finalization data set, the finalization process will fail. This parameter is optional; however, if not provided, you cannot finalize with debt or negative lots. |
|
FinalizeWithMovementMatchingCriteriaIgnored |
The matching criteria of Matching Movement to Plan feature can influence the result of reprocessing. This parameter enables matching criteria to be ignored during finalization. |