Order Archival yfs.properties

Review the Sterling™ Order Management System Softwareproperties of Order Archival.

The following table describes the Order Archival yfs.properties and descriptions:

Property	Values	Description
osi.archive.enabled	Valid values = Boolean Default value = N	To enable integration with Archive Service, configure the value of this property to Y.
osi.order.service.url	Valid values = Valid URL strings	Specify the URL to connect to Order Service. If you do not specify any value or leave it blank, the Order Archive agent fails.
osi.archive.order.orderLine.batch.size	Valid values = Any positive integer	Specify the batch size to use for archiving the order line part. If you do not specify the batch size, all order lines are archived in a single batch.
osi.archive.order.orderAudit.batch.size	Valid values = Any positive integer	Specify the batch size to use for archiving the order audit part. If you do not specify the batch size, all the order audit records for an order are archived in a single batch.
osi.archive.order.additional.parts	Valid values = Comma separated table names of subordinate entities of an order	Specify the list of comma separated table names for additional subordinate entities of an order, apart from order line and order audit, which you want to archive separately. By default, all subordinate entities of YFS_Order_Header, except for order line and order audit are archived along with 'order' part. Note: There is a character limit for specifying a property value in System Management Administrator (SMA). If the length of the osi.archive.order.additional.parts property value exceeds the character limit, you can configure this property by using alternate options explained in managing properties in the database.
osi.archive.order.part.<tablename>.name	Valid values = String	Specify the part name to use for the table name specified in the osi.archive.order.additional.parts property. For example, for the part name for order part payment, you can specify as `osi.archive.order.part.YFS_PAYMENT.name=payment.` It is mandatory that you provide the part name by using this property for each of the additional parts mentioned in osi.archive.order.additional.partsproperty. Otherwise, the Order Archive agent fails. Note: Ensure to configure the part names that are specified by using this property in Order Service as well.
osi.archive.order.<partname>.batch.size	Valid values = Any positive integer	Specify the batch size to use for archiving the respective additional part specified in the osi.archive.order.additional.parts property. For example, consider an order that contains 10 records for the additional part. If you want to send a maximum of 5 records of that part in each request, define the batch size as 5. In this case, 2 requests are sent to Archive Service for that part. If you do not specify the batch size, for the respective additional part the entire data is archived in a single batch.
osi.archive.max.batch.data.size	Valid values = Any positive integer Default value =1024	Specify the maximum data size in KB to send in a single batch of a part for archival. If you specify an invalid value it is ignored and the default value of the property is used as the maximum data size for a batch.
osi.archive.request.load.factor	Valid value = any decimal value that is greater than 0.0 and less than 1.0 Default value = 1.0	The value that you configure for this property is used in conjunction with the osi.archive.max.batch.data.size property to prevent any payload overload during archival request. If you specify an invalid value, it is ignored and the default value is used.
osi.archive.order.orderAudit.noArchive	Valid values = Y or true	Use this property to avoid archiving of order audit data to Archive Service. If you specify the value as Y or true, the order audit data gets deleted from Sterling Order Management System Software without archiving the data to Archive Service. By default, the order audit data are archived to the Archive Service before deleting the data from Sterling Order Management System Software.
osi.archive.order.date	Valid values = OrderDate, PurgedDate, or ArchiveDate Default value = OrderDate	Specify one of the key date attribute of an order that you want to use in archival request to Archive Service. You can specify as OrderDate, PurgedDate, or ArchiveDate. Here, OrderDate is the date when the order was placed. This information is fetched from the order. PurgedDate is the date when an order is moved to history tables. ArchiveDate is the date when an order is successfully archived to Archive Service.
osi.orderservice.auth.disabled	Valid value = Boolean Default value = False	When authentication is disabled in Order Service, set this property to 'true' so that you need not provide any supportive authentication configurations for Order Service APIs to be called from Sterling Order Management System Software.