Expression Editor Functions - Analyte Category
Note: Unless otherwise noted below, analytes that are included in the active specification display. For example, when creating an expression for a contract charge:
- In a set of contract terms, the contract product specifications apply.
- In overridden contract terms for a despatch order, the despatch order specifications apply.
- In a set of mark-to-market terms that has a selected product, the product specifications apply. However, if there is no selected product, all analytes display.
|
Function |
Description of Returned Value |
|---|---|
|
[Analyte] ([Unit]).BuyerAssay |
Returns the buyer's assay for the analyte, in the default unit of measure. Only available to analytes set up with a contract assay rule. Format: [Analyte] ([Unit]).BuyerAssay() Example: Ag (t.oz/st).BuyerAssay() |
|
[Analyte] ([Unit]).BuyerAssay.ConvertToUOM(uom) |
Converts the buyer's assay for the analyte from the default unit of measure to the specified unit of measure. Only available to analytes set up with a contract assay rule. Format: [Analyte] ([Unit]).BuyerAssay.ConvertToUOM(uom) Example: Cu (%).BuyerAssay.ConvertToUOM("t.oz/st") |
|
[Analyte] ([Unit]).Content |
Returns the content of the analyte, in the default unit of measure. Format: [Analyte] ([Unit]).Content() |
|
[Analyte] ([Unit]).Content.ConvertToUOM(uom) |
Converts the content of the analyte from the default unit of measure to the specified unit of measure. Format: [Analyte] ([Unit]).Content.ConvertToUOM(uom) Example: Pt (t.oz/st).Content.ConvertToUOM("%") |
|
[Analyte] ([Unit]).Lower |
Returns the analyte lower limit according to the active specification, in the default unit of measure. Format: [Analyte] ([Unit]).Lower() |
|
[Analyte] ([Unit]).Lower.ConvertToUOM(uom) |
Converts the analyte lower limit from the default unit of measure to the specified unit of measure. Format: [Analyte] ([Unit]).Lower.ConvertToUOM(uom) Example: Au (t.oz/st).Lower.ConvertToUOM("%") |
|
[Analyte] ([Unit]).Maximum |
Returns the maximum allowable value for the analyte according to the active specification, in the default unit of measure. Format: [Analyte] ([Unit]).Maximum() |
|
[Analyte] ([Unit]).Maximum.ConvertToUOM(uom) |
Converts the maximum allowable value for the analyte from the default unit of measure to the specified unit of measure. Format: [Analyte] ([Unit]).Maximum.ConvertToUOM(uom) Example: As (%).Maximum.ConvertToUOM("g/mt") |
|
[Analyte] ([Unit]).Minimum |
Returns the minimum allowable value for the analyte according to the active specification, in the default unit of measure. Format: [Analyte] ([Unit]).Minimum() |
|
[Analyte] ([Unit]).Minimum.ConvertToUOM(uom) |
Converts the minimum allowable value for the analyte from the default unit of measure to the specified unit of measure. Format: [Analyte] ([Unit]).Minimum.ConvertToUOM(uom) Example: Ag (t.oz/st).Minimum.ConvertToUOM("g/mt") |
|
[Analyte] ([Unit]).PayableContent |
Returns the payable content of the analyte, in the default unit of measure. Format: [Analyte] ([Unit]).PayableContent() |
|
[Analyte] ([Unit]).PayableContent.ConvertToUOM(uom) |
Converts the payable content of the analyte from the default unit of measure to the specified unit of measure. Format: [Analyte] ([Unit]).PayableContent.ConvertToUOM(uom) Example: Au (t.oz/st).PayableContent.ConvertToUOM("%") |
|
[Analyte] ([Unit]).Price |
Returns the analyte price, in the default unit of measure. Format: [Analyte] ([Unit]).Price() |
|
[Analyte] ([Unit]).Price.ConvertToUOM(uom) |
Converts the analyte price from the default unit of measure to the specified unit of measure. Format: [Analyte] ([Unit]).Price.ConvertToUOM(uom) Example: Cu (%).Price.ConvertToUOM("lb/st") |
|
[Analyte] ([Unit]).SellerAssay |
Returns the seller's assay for the analyte, in the default unit of measure. Only available to analytes set up with a contract assay rule. Format: [Analyte] ([Unit]).SellerAssay() |
|
[Analyte] ([Unit]).SellerAssay.ConvertToUOM(uom) |
Converts the seller's assay for the analyte from the default unit of measure to the specified unit of measure. Only available to analytes set up with a contract assay rule. Format: [Analyte] ([Unit]).SellerAssay.ConvertToUOM(uom) Example: Cu (%).SellerAssay.ConvertToUOM("kg/mt") |
|
[Analyte] ([Unit]).Target |
Returns the target value for the analyte according to the active specification, in the default unit of measure. Format: [Analyte] ([Unit]).Target() |
|
[Analyte] ([Unit]).Target.ConvertToUOM(uom) |
Converts the target value for the analyte from the default unit of measure to the specified unit of measure. Format: [Analyte] ([Unit]).Target.ConvertToUOM(uom) Example: Ni (%).Target.ConvertToUOM("lb/st") |
|
[Analyte] ([Unit]).UmpireAssay |
Returns the umpire's assay for the analyte, in the default unit of measure. Only available for analytes set up with a contract assay rule. Format: [Analyte] ([Unit]).UmpireAssay() |
|
[Analyte] ([Unit]).UmpireAssay.ConvertToUOM(uom) |
Converts the umpire's assay for the analyte from the default unit of measure to the specified unit of measure. Only available to analytes set up with a contract assay rule. Format: [Analyte] ([Unit]).UmpireAssay.ConvertToUOM(uom) Example: Pd (t.oz/st).UmpireAssay.ConvertToUOM("g/mt") |
|
[Analyte] ([Unit]).Upper |
Returns the analyte upper limit according to the active specification, in the default unit of measure. Format: [Analyte] ([Unit]).Upper() |
|
[Analyte] ([Unit]).Upper.ConvertToUOM(uom) |
Converts the analyte upper limit from the default unit of measure to the specified unit of measure. Format: [Analyte] ([Unit]).Upper.ConvertToUOM(uom) Example: Pt (t.oz/st).Upper.ConvertToUOM("g/mt") |
|
[Analyte] ([Unit]).Value |
Returns the value of the analyte, in the default unit of measure. Format: [Analyte] ([Unit]).Value() |
|
[Analyte] ([Unit]).Value.ConvertToUOM(uom) |
Converts the value of the analyte from the default unit of measure to the specified unit of measure. Format: [Analyte] ([Unit]).Value.ConvertToUOM(uom) Example: Rh (t.oz/st).Value.ConvertToUOM("%") |
|
IsOutsideSplittingLimit |
Tests whether the umpire's assay is outside the splitting limit. Only applicable to umpire assay settlement method calculations. Format: IsOutsideSplittingLimit() Example: The following formula shows the structure of an expression that can be used if Between Buyer And Seller, Within One Splitting Limit and Outside Splitting Limit are all set to Calculated in a contract assay rule. The values 10, 20 and 30 should be replaced with the required results. If(IsWithinBuyerAndSeller(), 10, |
|
IsWithinBuyerAndSeller |
Tests whether the umpire's assay is between the buyer's assay and the seller's assay. Only applicable to umpire assay settlement method calculations. Format: IsWithinBuyerAndSeller() |
|
IsWithinSplittingLimit |
Tests whether the umpire's assay is within one splitting limit. Only applicable to umpire assay settlement method calculations. Format: IsWithinSplittingLimit() |
|
SettlementBuyerAssay |
Returns the buyer's assay. Only applicable to umpire assay settlement method calculations. Format: SettlementBuyerAssay() |
|
SettlementSellerAssay |
Returns the seller's assay. Only applicable to umpire assay settlement method calculations. Format: SettlementSellerAssay() |
|
SettlementSplittingLimit |
Returns the splitting limit. Only applicable to umpire assay settlement method calculations. Format: SettlementSplittingLimit() |
|
SettlementUmpireAssay |
Returns the umpire's assay. Only applicable to umpire assay settlement method calculations. Format: SettlementUmpireAssay() |
