Process ID

By Anna V. January 15, 2025. Revised. Version: 0.1.02

This section describes the convention used for creating Process IDs (PIDs) within the k8or Orbit application. PIDs are critical for tracking and analyzing individual steps or operations (referred to as "Parts") within a process flow. They provide a granular level of detail for understanding the execution sequence and identifying the resources involved in each step.

Process ID Convention Example

• Structure: A Process ID follows the format: <start-resource>-<end-resource>-e<execution_order>.

• Resource Identifiers: The <start-resource> and <end-resource> portions of the PID represent the starting and ending resources for a given process step. Critically, these resource identifiers utilize the Microservice Identification (MID) convention for microservices and the Resource Identification (RID) convention for backend resources. This ensures consistency and allows for easy cross-referencing with the microservice and resource naming conventions.

• Component ID Prefix: Because MIDs and RIDs already include the component ID prefix, it is implicitly included in the PID. You do not need to repeat the component ID separately in the PID. The component context is already captured through the MIDs and RIDs used within the PID.

• Execution Order: The -e<execution_order> portion of the PID indicates the sequence of execution for the process step. The e prefix stands for "execution", and the following number represents the step number. The numbers increment by 5 (e.g., e05, e10, e15, e20, etc.). This consistent increment allows for future insertions of new steps without requiring renumbering of existing PIDs.

• Example:

  Let's consider an example PID: c8fms03-c20bre06-e15

  • c8fms03: This is the start resource and is a Microservice ID (MID). It indicates that the process step begins with the Frontend Microservice fms03 belonging to Component C8.

  • c20bre06: This is the end resource and is a Resource ID (RID). It indicates that the process step ends with the Backend Resource bre06 belonging to Component C20.

  • e15: This indicates that this process step is the third step in the execution sequence within the relevant Leg (because 15 / 5 = 3). The first step in the Leg would be e05, the second e10, and so on.

  Therefore, the complete PID c8fms03-c20bre06-e15 signifies that this process step involves the Frontend Microservice c8fms03 interacting with the Backend Resource c20bre06, and it is the third step in the execution sequence within the context of its Leg. This PID provides a concise and structured way to identify and track this specific process step.