Workflows Created by Me Operations

On the Created by Me tab of the My Workflows page you can view all the workflows that the current user initiated.

Tip:  The following permissions (see Security Overview) are required to use this feature:

Workflow Instances: Read - Started by Me
Or:
Workflow Instances: Read - All

To view details of a workflowClosed A workflow is a series of steps necessary to complete a process. In the context of Keyfactor Command, it refers to the workflow builder, which allows you automate event-driven tasks when a certificate is requested or revoked. instance:

  1. In the Management Portal, browse to Workflow > My Workflows.
  2. On the Created by Me tab of the My Workflows page, double-click or click View from either the top or right click menu.

  3. On the Workflow Signal Review page, review the information in the instance. Information on the review page includes:

    Instance Section

    • Id

      A GUID indicating the Keyfactor Command reference ID for the instance.

    • Title

      A description for the action taking place in the step. For example:

      "KEYEXAMPLE\jsmith is enrolling for a certificate with CN=appsrvr12.keyexample.com."

      Or:

      "KEYEXAMPLE\mjones is revoking certificate with CN=appsrvr14.keyexample.com."

    • Status

      The current status message of the workflow instance.

      For example, for an enrollmentClosed Certificate enrollment refers to the process by which a user requests a digital certificate. The user must submit the request to a certificate authority (CA). that succeeded, the status message might be:

      Issued. The private key was successfully retained.

      For a workflow suspended and awaiting approval, the status message might be:

      Awaiting 2 more approval(s) from approval roles.

      For an enrollment that could not be submitted because a regular expression rule was not met, the status message might be something like:

      Pre-process failed: Invalid ST provided: Value must be one of California, Washington, Texas, New York, Illinois or Ohio.

      For an enrollment that failed due to rejection by the CAClosed A certificate authority (CA) is an entity that issues digital certificates. Within Keyfactor Command, a CA may be a Microsoft CA or a Keyfactor gateway to a cloud-based or remote CA., the status message might be:

      The certificate request failed with the reason '[CA reason]'

      A workflow that failed at a PowerShell step might include the PowerShell error in the status message:

      Step 'Run PowerShell' failed: At line:5 char:19
+    [datetime]$Date
+                   ~
Missing ')' in function parameter list.
At line:7 char:1
+ )
+ ~
Unexpected token ')' in expression or statement.

    • Current Step

      The display name defined for the workflow instance step at which the instance has paused or stopped. For a successfully completed enrollment or revocation workflow, this will be either Keyfactor-Revoke or Keyfactor-Enroll. For a suspended workflow, this will be the custom step that is awaiting user input to continue the workflow. For a failed workflow, this will be the step at which the workflow failed.

    • Figure 198: Workflow Instance Review

    Current Data Section

    The data included in this section will vary depending on the request type, the status of the request, and the configuration of the workflow.

    For an enrollment, this section may include:

    For a revocation, this section may include:

    • Certificate Authority

      The certificate authority that that issued the certificate.

    • Certificate Id

      The Keyfactor Command reference ID for the certificate being revoked.

    • Comment

      A freeform reason or comment to explain why the certificate is being revoked.

    • Delegate

      A flag indicating whether delegation was enabled for the certificate authority that issued the certificate at the time revocation was requested (true) or not (false). For more information, see Authorization Methods Tab.

    • Effective Date

      The date and time when the certificate will be revoked.

    • Initiating User Name

      The name of the user who initiated the workflow in DOMAIN\\username format.

    • Operation Start

      The time at which the revocation workflow was initiated.

    • RevokeCode

      The specific reason that the certificate is being revoked. Possible values are:

    • Serial Number

      The serial number of the certificate being revoked.

    • Thumbprint

      The thumbprint of the certificate being revoked.

    • (Custom)

      Optional user-generated custom fields returning response data from PowerShell scripts or REST requests. These will be sorted alphabetically in among the other fields on the page.

    For a certificate that entered or left a certificate collectionClosed The certificate search function allows you to query the Keyfactor Command database for certificates from any available source based on any criteria of the certificates and save the results as a collection that will be availble in other places in the Management Portal (e.g. expiration alerts and certain reports)., this section generally includes:

    • Certificate Id

      The Keyfactor Command reference ID for the certificate added to or removed from the certificate collection.

    • Initiating User Name

      The name of the user who initiated the workflow—generally Timer Service in this case.

    Figure 199: View Details for the Workflow Instance

  4. Click Close to close the viewer.