Business Keys

A Business Key is a string that uniquely identifies an object in RunMyJobs.

For example, the Business Key for a Format object named "Excel" and located in the GLOBAL Partition would be Format:GLOBAL.Excel.

  • The part before the : specifies the object type.

  • The part after the : is the period-delimited “path” to the object. For most objects, this “path” of the object starts with the Partition it belongs to.

If an item in a Business Key "path, "has a period in the name, RunMyJobs substitutes %2e for the period.

Business Keys for Folders

The Business Key for a Folder begins with the name of its parent Partition. For example:

Partition1.Folder1

To uniquely identify a nested Folder with a Business Key, you must specify all other Folders in its hierarchy, and you must specify which Partition each Folder belongs to. There are two ways of doing this: Type 1 and Type 2.

Type 1

Type 1 looks like this:

Partition1.Folder1.Folder2.Folder3

Here, all three Folders belong to Partition1, so Partition1 is not repeated in the Business Key. This format was potentially problematic, so the second method was created.

Method 2

Here is the Type 2 Business Key for the same Folder:

Partition1.Folder1.Partition1.Folder2.Partition1.Folder3.$2

There are two differences:

  • Partition names are specified for every Folder in the hierarchy.

  • The Business Key ends with .$2 to indicate that it is a Type 2 Business Key.