Generated Custom Property Values

Document created by Chris Sommerstad Employee on Jul 21, 2017
Version 1Show Document
  • View in full screen mode

You can generate values of various types for a custom property at the message/action, clip, and track levels using the Custom Property, Value drop-down, Generated Value.

Once generated value is selected, the default Date tab appears with the other tabs shownI is the same in each of the supported custom properties types (i.e. message or action, clip, and track). Custom property generation can be accomplished by using any of the three tabs in the Generated Value tabs: Date/Time, String, or Number.

Generated Value: Date tab

When Date/Time values are set, the Custom property is initialized to a Date/Time value, or the string representation of a Date/Time value.

Start Time

The Start Time is a required field set either to Now or Composition Start Time.

Note: All times are the times on the Maestro server.

Now – The time at which the property is created (it┬ owning object comes into existence during Composition play). For example, if it is a Clip Custom Property, the time at which the instance of the Clip is created.

Composition Start Time – The time at which Composition play started.

Include Time

The Include Time checkbox is true/false according to whether the time is to be included. If false, the time is set to 12:00 am (00:00).

Offset

The Optional offset to add to the Start Time value. Can be positive to go into the future, or negative to go into the past.

Set the integer amount of the offset and set a unit of time to use (defaults to milliseconds):

Round To

This optional value will round the date forward to a particular day of the week.

Note that Next Weekday applies only to Monday-Friday.

The rounding is done after any offset is applied. The rounding is always done forward regardless of whether any offset, if given, is positive or negative. If the Date/Time value is already one of the specified days, it is not changed.

Pattern

If this optional formatting pattern is given, the Custom Property┬ value will be a string, rather than a Date/Time, and the string will be the Date/Time value formatted as specified by the pattern. The standard Java object "SimpleDateFormat" is used to do the formatting, and any pattern accepted by that object can be used.

The Generated Value form will validate any entered pattern to ensure that it is valid, so that you don't have to wait until the Composition is played to discover an invalid pattern.

Generated Value: Number Tab

This tab's three radio buttons (Random, Unique Per Virtual User, and Range) allow the user to generate a custom property value using an random integer number (from a defined range), or as a string representation of one; or, as a Unique Per Virtual User or by using a Range.

Random Button

Select the Random radio button (default) to set a random integer range using From: and To: fields as well as to provide an optional pattern (at the bottom of the form).

Note: The term “integer” is used here in the mathematical sense. The value is actually a Java long type.

You are required to provide the minimum and maximum values. Either can be positive or negative, but the minimum must be less than or equal to the maximum.

Pattern

If this is given, the Custom Property’s value will be a string, rather than a number, and the string will be the number formatted as specified by the pattern. The standard Java object “DecimalFormat” is used to do the formatting, and any pattern accepted by that object can be used.

The Generated Values form will validate any entered pattern, and display the green check mark (shown above) to indicate a valid pattern. Note that if the pattern is played without this validation an error will appear when the Composition is played.

Unique Per Virtual User Button

Select the Unique Per Virtual User radio button to use the “VUNumber” Track System Property for the Track in which this Custom Property resides.

The value will be either a number or the string representation of one.

Pattern

If this is given, the Custom Property’s value will be a string, rather than a number, and the string will be the number formatted as specified by the pattern. The standard Java object “DecimalFormat” is used to do the formatting, and any pattern accepted by that object can be used.

The Generated Values form will validate any entered pattern, and display the green check mark (shown above) to indicate a valid pattern. Note that if the pattern is played without this validation an error will appear when the Composition is played.

Range Button

Select the Range radio button (default) to set a unique, sequential integer number, within “blocks” of numbers allocated to each Maestro Server.

The value will be either a number or the string representation of one.

Start – The required starting number (the first number to be allocated).

Server Block Size – The required size of the block of numbers to be allocated to each Maestro Server in the Composition. Each server will allocate numbers from its assigned block.

Range End Action – Specifies what is to happen if a server reaches the end of its block of numbers.

The options are very similar to what happens for the similar situation when using Seed Data:

  • Wrap – Property values will start over at the beginning of the data range.
  • Null – The value of the Custom Property will be set to null.
  • Error – The item containing the Custom Property will fail. Error handling will proceed according to the regular "Failure action" settings of the item, it's parents, and the Composition.
  • Stop Track and Drain – The current instance of the item's parent Track on the current server (and everything in it) is stopped. No new repeats or parallel repeat renewals will occur for that Track on this server. Other instances of the Track on this server that already exist will continue to their normal end, but no new instances will be started on this server. In other words, if using the recommended approach of having each Track represent a "Virtual User," and if using "Parallel Repeat Renewal" to cause each Virtual User to be automatically replaced when it ends, then this setting will cause no new Virtual Users to be created on this server when its seed data runs out.
  • Stop Composition – The entire Composition (on all servers) will be stopped immediately (as if the "Stop" button had been pressed).

Pattern

If this is given, the Custom Property’s value will be a string, rather than a number, and the string will be the number formatted as specified by the pattern. The standard Java object “DecimalFormat” is used to do the formatting, and any pattern accepted by that object can be used.

The Generated Values form will validate any entered pattern, and display the green check mark (shown above) to indicate a valid pattern. Note that if the pattern is played without this validation an error will appear when the Composition is played.

Generated Value: String Tab

The String Tab's two radio buttons allow the user to either generate random text based on length and type (i.e. alphanumeric, alpha, decimal, or hex), or, to generate random text from a random pool by length and pool.

Random

Select the Random button to set a string of random characters by length and type (both required).

  • Length – The length of the string to be generated. Must be at least 1.
  • Type – The type of string to generate: alphanumeric, alpha, decimal, or hex.

Random from Pool

Select the Random from Pool button to set a string of random characters chosen from the given set of characters by length and pool (both required).

  • Length – The length of the string to be generated. Must be at least 1.
  • Pool – The list of characters from which to randomly choose in order to construct the string. Must contain at least one character. Typically, there would be no duplicates in the list, but there can be, in which case the odds of that character being randomly chosen will be increased proportionally to how many times it appears in the list.

Attachments

    Outcomes