SDX 6.4.x Application Library Guide > Work Item Library > Token Processor Work Items

Token Processor Work Items

The token processor work items can alter the token in any way, as long as they do not take a long time to complete. What distinguishes a long-time task from a common task is that the latter does not use external resources that might not be available, and the computation is not complex enough to take more than a few seconds.

Token processor work items never fail or terminate.

Token Value Checker Work Item

This work item checks to see if the set of specified token parameters have the given values. The output token will have a proceed result only if all the specified parameters are defined and their values are exactly the ones specified in the TokenAttributeValuePair property. This is the only property of the work item. This work item only allows checks of single-valued properties.

The TokenAttributeValuePair property is a String-indexed property. Each element of the array is in the form <parameter name>=<value> or <parameter name>, where both sides of the equals sign are free-form strings. Figure 40 shows what this property looks like. In this example, the result will proceed only if the Name parameter in the token has a value of Bill and the Mail parameter is defined.

Figure 40: TokenAttributeValuePair

Token Value Assigner Work Item

This work item allows you to assign values to token parameters (see Figure 41). The parameter names and the values are specified in the indexed property Assignments, where the left side of the equals sign is the parameter name and the right side is its value. Values can be taken from a token parameter, statically configured, or both.

A string between '%' is considered a token parameter and will be replaced by its value. The '%%' sequence represents the '%' character. If only a name with no value is specified, a parameter is created with an empty string as a value. You can also specify multivalued parameters by using the vertical bar '|' as a separator. The separator must not be present in the string. White spaces are significant. This work item either completes successfully or terminates if a token parameter specified as a value is not present in the input token.

Figure 41: Token Value Assigner Work Item Property Sheet

Filter/Pass Work Item

The Filter/Pass work item filters or permits passage of a set of properties from the token. The behavior property determines whether it should filter or let pass the token parameters listed on the Properties set property. Its property sheet is shown in Figure 42.

Figure 42: Filter/Pass Work Item Property Sheet

MIME Form Encoder Work Item

This work item encodes in a token parameter a form in the MIME formats multipart/form-data or application/x-url-encoded. Form fields and their contents are specified in a properties table (PropertyTable property) where the left side of the equals sign is the form field name and the right side is the value. The value can be a literal or a token parameter, in which case it should be specified between percents ('%').

You must specify a boundary must when using the multipart/form-data encoding. The boundary must be a string that is not present in the content of any of the values. For more details, see RFC 2388—Returning Values from Forms: multipart/form-data.

If a token parameter is not defined, it is simply not included in the output. The work item property sheet is shown in Figure 43 and is described in Table 59.

Figure 43: MIME Form Encoder Work Item Property Sheet

 Table 59:  MIME Form Encoder Work Item Properties 

 Property
 Description

 EncodingType

 MIME type into which you encode the form


 MultipartBoundary

 String used as boundary for the multipart encoding


 OutputParameterName

 Name of the token parameter that will contain the encoded data


 PropertyTable

 Specifies the values for the form fields. Each element of the array specifies one form field in the format specified above.



 

Token Logger Work Item

The Token Logger work item dumps the token to the console or a file. The file to contain the token is specified by the OutputFile property. If the OutputFile property is not specified, the token is dumped to the console. An optional header can be specified through the Header property.

The output token is exactly the same as the input token. The property sheet for the work item is shown in Figure 44.

Figure 44: Token Logger Work Item Property Sheet