About 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 Applications

Applications can be nested one inside the other, and each application belongs to a partition. For example, here is the hierarchy for an application named Application3.

Copy 
Partition1.Appliation1
  Partition1.Application2
    Partition1.Application3

To uniquely identify an Application with a business key, you must specify all other Applications in its hierarchy, and you must specify which partition each Application belongs to.

There are two types of business keys for Applications: Type 1 and Type 2.

Type 1

A Type 1 Application business key looks like this:

Partition1.Application1.Application2.Application3

Here, all three Applications belong to Partition1, so Partition1 is not repeated in the business key. This format was potentially problematic, so the Type 2 business key was created.

Type 2

A Type 2 Application business key looks like this:

Partition1.Application1.Partition1.Application2.Partition1.Application3.$2

This business key identifies the same Application (Application3) as the first one. There are two differences in Type 2:

  • Partition names are specified even when they are the same as they were for the previously declared Application.

  • The business key ends with .$2 to indicate that it is a Type 2 business key.