This documentation supports the 22.1 version of BMC Helix Digital Workplace Basic and BMC Helix Digital Workplace Advanced. Icons distinguish capabilities available only for the Advanced and External license levels. For more information, see License types and features.

Process context variable parameters reference

As a catalog administrator, internal supplier, or internal supplier administrator, you can refer to the process context properties that you can insert into a workflow activity. To learn how to add a process context variable in a workflow, see Adding a process context variable to a workflow.


Related topics

Defining approval rules Open link (Action Request System online documentation)

Calling external workflows

Integrating BMC applications with BMC Helix Digital Workplace Catalog

Properties of a process context input variable

The following table describes the properties that you expand from a process context variable of a Service Broker Context data type:

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

Group of propertiesUI property nameProperty descriptionJSON propertyExample data
My Stuff Item

Asset External ID

The identifier of an external asset retrieved from a connected Asset Management system.

For information about how this parameter can be used, see Creating a questionnaire with answers prepopulated from an external asset form.

myStuffItem.externalIdNot applicable
IdInternal ID of a completed service request displayed on the My Stuff page.myStuffItem.idNot applicable
NameName of a completed service request displayed on the My Stuff page.myStuffItem.nameProvide a laptop
Order







Order Description

Description of an order.

orderDescription

Not applicable

Order GUID

Identifies that the request was sent as a shopping cart order.orderGuidAGGCEME2HPULZAOHWQ3GAAAC0NGVUV

Order ID

ID value of an order.

orderId

2812
Order Monthly CostMonthly recurring cost with its currency.orderMonthlyCost99 USD
Order Monthly Cost AmountMonthly recurring cost as a numeric value.orderMonthlyCostAmount99
Order One-Time CostOne time cost with its currency.orderOneTimeCost199 USD
Order One-Time Cost AmountOne time cost as a numeric value.orderOneTimeCostAmount199
Order Yearly CostYearly recurring cost with its currency.orderYearlyCost1999 USD
Order Yearly Cost AmountYearly recurring cost as a numeric value.orderYearlyCostAmount1999
Requested by user















City

City of a requested-by user.requestedBy.site.cityMiami
CompanyCompany of a requested-by user.requestedBy.companyCalbro Services

Country

Country of a requested-by user.requestedBy.site.countrythe USA

Department

Department of a requested-by user.requestedBy.departmentPay & Benefits

Email

Email of a requested-by user.

requestedBy.mailAddressmary_mann@calbroservices.com
Entitled to UserIdentifies whether the requested-by user is entitled to a service.

service.entitledToRequestedBy

0 for false; 1 for true

Full Name

Name of a requested-by user.

requestedBy.fullNameMary Mann

Job Title

Job title of a requested-by user.requestedBy.jobTitleEngineer

Login Name

Login name of a requested-by user.requestedBy.loginNamemmann

Name

Site name of a requested-by user.requestedBy.site.nameSao Paulo Agency

NT Domain

NT domain of a requested-by user.

Note: The NT domain is available only if the NT Domain (420003300) field has been created on the User form, and the field receives values from an external actor (manually or via automation).

requestedBy.ntDomain

PROD


Organization

Organization name of a requested-by user.requestedBy.organizationHR

Region

Region of a requested-by user.requestedBy.regionAmericas

Site Group

Site group of a requested-by user.requestedBy.siteGroupSouth America

State Province

State province of a requested-by user.requestedBy.site.stateProvinceFlorida

Street

Street of a requested-by user.requestedBy.site.street37th St

Zip Postal Code

Zip postal code of a requested-by user.

requestedBy.site.zipPostalCode32006
Requested for user















City

City of a requested-for user.

requestedFor.site.cityMiami
CompanyCompany of a requested-for user.requestedFor.companyCalbro Services

Country

Country of a requested-for user.

requestedFor.site.countrythe USA

Department

Department name of a requested-for user.

requestedFor.departmentPay & Benefits

Email

Email of a requested-for user.

requestedFor.emailAddressbob_baxter@calbroservices.com
Entitled to UserIdentifies whether the requested-for user is entitled to a service.service.entitledToRequestedFor0 for false; 1 for true

Full Name

Name of a requested-for user.

requestedFor.fullNameBob Baxter

Job Title

Job title of a requested-for user.

requestedFor.jobTitleCook

Login Name

Login name of a requested-for user.

requestedFor.loginNamebbaxter
Name

Site name of a requested-for user.

requestedFor.site.nameSao Paulo Agency

NT Domain

NT domain of a requested-for user.

Note: The NT domain is required for services fulfilled through the Flexera App Portal. The NT Domain field is available only if the NT Domain (420003300) field has been created on the User form, and the field receives values from an external actor (manually or via automation).

requestedFor.ntDomain

PROD


Organization

Organization name of a requested-for user.

requestedFor.organizationHR

Region

Region of a requested-for user.

requestedFor.regionAmericas

Site Group

Site group of a requested-for user.

requestedFor.siteGroupSouth America

State Province

State or province of a requested-for user.

requestedFor.site.stateProvinceFlorida

Street

Street of a requested-for user.

requestedFor.site.streetAbaco Ave

Zip Postal Code

Zip or postal code of a requested-for user.

requestedFor.site.zipPostalCode33018
Service















Connection ID

Connection ID of system integrated with BMC Helix Digital Workplace Catalog.

Notes:

  • For imported services, the Connection ID property is populated automatically.
  • For native services, administrators must insert the Connection ID property manually.
service.connectionId

101

External Service ID

ID from the external system of the service, provided by a connector.service.externalId3705

Is Bundle

Identifies whether the catalog item is a bundle of services or an individual service.

service.bundle0 for false; 1 for true
Localized Service NameCatalog profile name of the service being requested (localized).service.localizedServiceNameAccounting Software
Localized Service VersionVersion of the service (localized).service.localizedServiceVersion6.0

Service ID

ID of the service in BMC Helix Digital Workplace Catalog.

service.id

1504

Service Monthly Cost

Total recurring cost on a monthly basis along with its currency.

service.monthlyCost

123 USD

Service Monthly Cost Amount

Total recurring cost on a monthly basis as a number.
service.monthlyCostAmount
20

Service Name

Catalog profile name of the service being requested.service.nameAccounting Software

Service One Time Cost

Total one-time cost along with its currency.

service.oneTimeCost

100.99 USD, 50000 JPY

Service One Time Cost Amount

Total one-time cost amount as a numeric value.
service.oneTimeCostAmount

500, 505.55

Service Provisioning Time

Service provisioning time as a numeric value. It defines how long the the service is to be provisioned according to its SLA.

service.serviceProvisioningTime

27, 99 , 1

Service Provisioning Time Unit

Service provisioning time unit, specified in days, hours, or minutes.

service.serviceProvisioningTimeUnit

MIN, HOUR, DAY

Service Version

Version of the service

service.serviceVersion

6.0

Service Yearly Cost

Total recurring cost on a yearly basis along with its currency.

service.yearlyCost

1100 USD

Service Yearly Cost Amount

Total recurring cost on a yearly basis as a numeric value.

service.yearlyCostAmount

1000
Sub-Catalog IDID of a subcatalog associated with a service.service.subCatalogIdNot applicable
Service Request




Reopen ReasonReason for reopening the service requestserviceRequest.reopen.reasonPartially complete

Requested Item Quantity

Quantity of the individual requested items.

serviceRequest.quantity

2
Service Request GUIDGUID of the service request.processContext.sb.serviceRequest.guidNot applicable

Service Request ID

ID of the service request created when the user requests the service through BMC Helix Digital Workplace.

serviceRequest.id1201
Submitted Date

UTC date and time when an end user submits a request.

The following format is applied: YYYY-MM-DDThh:mm:ss

serviceRequest.submittedDate

2017-11-14T21:27:03.000Z

Turnaround Date

UTC date when a service request is to be completed according to an SLA defined in a service request definition.

It is calculated as follows: submittedDate + serviceProvisioningTime

The following format is applied: YYYY-MM-DDThh:mm:ss

Note: The service provisioning time excludes the weekend. For example, if the value is 10, the Turnaround Date will be 14 days later (5 days per week).

serviceRequest.turnaroundDate

2018-02-18T21:27:03.000Z

Submitted by user














City

City of a submitted-by user.submittedBy.site.cityMiami
CompanyCompany of a submitted-by user.submittedBy.companyCalbro Services

Country

Country of a submitted-by user.submittedBy.site.countrythe USA

Department

Department of a submitted-by user.submittedBy.departmentPay & Benefits

Email

Email of a submitted-by user.

submittedBy.mailAddressmary_mann@calbroservices.com

Full Name

Name of a submitted-by user.

submittedBy.fullNameMary Mann

Job Title

Job title of a submitted-by user.submittedBy.jobTitleEngineer

Login Name

Login name of a submitted-by user.submittedBy.loginNamemmann

Name

Site name of a submitted-by user.submittedBy.site.nameSao Paulo Agency

NT Domain

NT domain of a submitted-by user.

Note: The NT domain is available only if the NT Domain (420003300) field has been created on the User form, and the field receives values from an external actor (manually or via automation).

submittedBy.ntDomain

PROD


Organization

Organization name of a submitted-by user.submittedBy.organizationHR

Region

Region of a submitted-by user.submittedBy.regionAmericas

Site Group

Site group of a submitted-by user.submittedBy.siteGroupSouth America

State Province

State province of a submitted-by user.submittedBy.site.stateProvinceFlorida

Street

Street of a submitted-by user.submittedBy.site.street37th St

Zip Postal Code

Zip postal code of a submitted-by user.

submittedBy.site.zipPostalCode32006
Out of any group

Questions and Answers

A list of questions, answers, and associated metadata that are submitted in a service request. They also include those that are not assigned to process inputs.

assignedToProcessInput is true if a question is mapped to a process input.

confidential is true if the question is set to confidential, meaning that only users who have has confidential data access permission in BMC Helix Digital Workplace can view the answer.

hidden is true if the question is set to hidden, meaning that the question is not displayed to end users.

valueType indicates a type of answer. The possible values are:

  • DATE
  • TIME
  • DATE_TIME
  • BOOLEAN (for Yes/No questions)
  • ATTACHMENT
  • TEXT (for questions with text input)
  • LIST (for questions with check boxes)

For questions that have valueType = LIST, another displayValue string array is populated in the same order as Value field. For other types, displayValue field is Null.

tags indicate that internal free text tags are created in a questionnaire, and they can be used in a workflow.

For questions with multi-select and single-select tables, the metadata is populated with data from the columns parameter.

Notes:

  • If a question is attached to a process input variable, the user's response can be used directly in a workflow.

  • The service connector for the receiving system must be able to convert the list into usable data fields.

questionsAndAnswers
Example of TEXT type field
[
  {
    "key": "3",
    "label": "size",
    "valueType": "TEXT",
    "value": "S",
    "displayValue": null,
    "assignedToProcessInput": true,      	"hidden": false,
    "confidential": false,
    "tags": [
      "tag1",
      "tag2"
    ]
  }
]
Example of LIST type field
[
  {
    "key": "2",
    "label": "Colors",
    "valueType": "LIST",
    "value": [
      "green",
      "red"
    ],
    "displayValue": [
      "displaying green",
      "displaying red"
    ],
    "assignedToProcessInput": false,      	"hidden": false,
    "confidential": false,
    "tags": [
      "tag1",
      "tag2"
    ]
  }
] 
Example of Single-select table-type question
[
  {
    "key": "760e9316-4d54-84ff-a28f-a39bd1b7c533",
    "label": "Select the person who requires access",
    "value": "BMC08217E8A14330A1DE8043B7E7A27C",
    "tags": [
      
    ],
    "metaData": [
      {
        "multiSelect": false,
        "columns": [
          {
            "displayId": "ecba1271-97d9-91d3-b8bb-4fcb3635543d",
            "displayName": "Company"
          },
          {
            "displayId": "b496185d-43ab-b388-e4c7-7c33a6ba94d3",
            "displayName": "First Name"
          },
          {
            "displayId": "aa67a722-4b1a-8ca0-790b-fe7169e7579a",
            "displayName": "Last Name"
          },
          {
            "displayId": "cc3380cc-8b3a-ed2d-8f09-512e8d12e35e",
            "displayName": "Last Modified Date"
          }
        ]
      }
    ],
    "valueType": "LIST",
    "displayValue": [
      "BMC Software\\, Inc.,Yoritoki,Matsuura,2021-12-01T06:59:52.000Z"
    ],
    "assignedToProcessInput": false,
	"hidden": false,
    "confidential": false
  }
] 
Was this page helpful? Yes No Submitting... Thank you

Comments