...
These are the methods for doing lookups in conversion tables.
ConversionLookup[LookupType]Value(string conversiontablename, string returncolumn, string searchcolumn[N], string searchvalue[N], …, string suppressExceptions)
This is a template for the methods used for performing a conversion table lookup.
...
Each of the three lookup types support between 1 and 5 pairs of search columns and search values.
Link settings
Should you have a need for it, you can get the value of any Link setting on the system.
GetSettingValue(string key)
Returns the value of the setting.
Error handling
These are the methods used for error handling.
RaiseError(string message, bool retryAllowed)
This method is used for making a document intentionally go into Failed status in Link.
There can be many reasons for wanting to do this. Say for instance that you know that you sometimes get an order where one of the lines is missing the EAN number of the product. You also know that this will make the order impossible to process in your system. You may prefer in this situation to have the order fail in Link with a clear error message stating exactly why it failed, rather than having it sent on to your system and have to deal with it there.
In that case you can check the existence of the EAN number in the XSLT, and if it is missing you can call this method with a message saying that the EAN number is missing.
The retryAllowed parameter should always be set to false except in very specific cases. Any error that stems from faulty input data will not be resolved by trying to map the faulty data again.
RaiseError(string message, string errorCode, bool retryAllowed)
This method is the same as above, but allows you to register the error with a specific error code. If you have a known error scenario that you know a specific department needs to take care of, you can register the error code in Link and assign a specific stakeholder to it. Then any time a document fails with that specific error code, the stakeholder will be notified.
RaiseError(string message, string errorCode, string documentStatus, bool retryAllowed)
This method is the same as above, but allows you to set a specific document status rather than defaulting to “Failed”.
The practical use for this is making a document intentionally go into Ignored status in Link.
There can be many reasons for wanting to do this. Say for instance that you know that you sometimes get an order with no lines. You know that this happens due to an error in some customer’s system from time to time, and does not need any action from your side. Rather than having the faulty but unimportant order sent on to your system, it may be better to simply halt the processing of it in Link, and put a message on it saying why it has been ignored.
Context Properties
If your XSLT is being executed within Link, you can access the context properties of the message from the extension object.
GetContextPropertyValue(string propertyName, string propertyNamespace)
This method returns the value of the given context property from the message, or an empty string if the property does not exist.
SetContextPropertyValue(string propertyName, string propertyNamespace, string value)
This method writes a value to the message context.
Data manipulation
The extension object also contains a few methods that do not extract any data from Link, but which can be useful in various mapping scenarios.
ConvertDate(string dateToConvert, string inputFormat, string outputFormat)
This method converts a date(time) from one format to another. The two format parameters use the standard .NET DateTime formatstring format.
ReturnNumberFormat(string number, string formatMask)
This method formats a number using a standard .NET number format mask.
Replace(string value, string replaceFrom, string replaceTo)
...
string suppressExceptions
This parameter is optional. If it is not used in a call, the lookup method will never fail, it will simply return an empty string if anything goes wrong, such as the conversion table not existing, or one of the lookup values being blank. If you explicitly want the map to fail in one of those situations, add the parameter to the end of the call as false() or ‘false’.
While the parameter is logically a boolean value, it is implemented as a string to make it “play nice” with XSLT.
Link settings
Should you have a need for it, you can get the value of any Link setting on the system.
GetSettingValue(string key)
Returns the value of the setting.
Error handling
These are the methods used for error handling.
RaiseError(string message, string retryAllowed)
This method is used for making a document intentionally go into Failed status in Link.
There can be many reasons for wanting to do this. Say for instance that you know that you sometimes get an order where one of the lines is missing the EAN number of the product. You also know that this will make the order impossible to process in your system. You may prefer in this situation to have the order fail in Link with a clear error message stating exactly why it failed, rather than having it sent on to your system and have to deal with it there.
In that case you can check the existence of the EAN number in the XSLT, and if it is missing you can call this method with a message saying that the EAN number is missing.
The retryAllowed parameter should always be set to false() or ‘false’ except in very specific cases. Any error that stems from faulty input data will not be resolved by trying to map the faulty data again. While the parameter is logically a boolean value, it is implemented as a string to make it “play nice” with XSLT.
RaiseError(string message, string errorCode, string retryAllowed)
This method is the same as above, but allows you to register the error with a specific error code. If you have a known error scenario that you know a specific department needs to take care of, you can register the error code in Link and assign a specific stakeholder to it. Then any time a document fails with that specific error code, the stakeholder will be notified.
RaiseError(string message, string errorCode, string documentStatus, string retryAllowed)
This method is the same as above, but allows you to set a specific document status rather than defaulting to “Failed”.
The practical use for this is making a document intentionally go into Ignored status in Link.
There can be many reasons for wanting to do this. Say for instance that you know that you sometimes get an order with no lines. You know that this happens due to an error in some customer’s system from time to time, and does not need any action from your side. Rather than having the faulty but unimportant order sent on to your system, it may be better to simply halt the processing of it in Link, and put a message on it saying why it has been ignored.
Context Properties
If your XSLT is being executed within Link, you can access the context properties of the message from the extension object.
GetContextPropertyValue(string propertyName, string propertyNamespace)
This method returns the value of the given context property from the message, or an empty string if the property does not exist.
SetContextPropertyValue(string propertyName, string propertyNamespace, string value)
This method writes a value to the message context.
Utility functions
The extension object also contains a few methods that do not extract any data from Link, but which can be useful in various mapping scenarios.
ConvertDate(string dateToConvert, string inputFormat, string outputFormat)
This method converts a date(time) from one format to another. The two format parameters use the standard .NET DateTime formatstring format.
ReturnNumberFormat(string number, string formatMask)
This method formats a number using a standard .NET number format mask.
Replace(string value, string replaceFrom, string replaceTo)
This method performs a string replace operation on value, replacing all instances of replaceFrom with replaceTo.
DateAdd(string dateTime, string format, string days, string months, string years)
Takes an input date and time string, which must be in the specified format, adds the given number of days, months, and years to it, and returns the resulting date and time formatted according to the same format.
TimeAdd(string dateTime, string format, string hours, string minutes)
Takes an input date and time string, which must be in the specified format, adds the given number of hours, and minutes to it, and returns the resulting date and time formatted according to the same format.
GetLocalDateTime()
Gets the current local date and time formatted according to the standard XML date and time format mask.
GetLocalDateTime(string formatMask)
Gets the current local date and time formatted according to the specified format mask.
GetUtcDateTime()
Gets the current UTC date and time formatted according to the standard XML date and time format mask.
GetUtcDateTime(string formatMask)
Gets the current UTC date and time formatted according to the specified format mask.
MathRound(string number, string decimals)
Round the given number to the specified number of decimal places using away-from-zero rounding.
RegexReplace(string input, string pattern, string replacement)
Apply the given regular expression pattern to substitute parts of the input string with the specified replacement string.
SplitString(string input, string separator, string index)
Divide the input string into segments using the given separator string and return the segment at the specified index (starting from 0). If no segment matches the index, an empty string is returned.
ToUpper(string input)
Transform the entire input string to uppercase.
ToLower(string input)
Transform the entire input string to lowercase.