This documentation supports the 3.5 version of BMC Digital Workplace. To view the latest version, select the version from the Product version menu.

Service broker context parameter reference

This topic provides a reference to the process context properties that you can insert into a workflow activity. For more details about process context , see Adding a process context variable to a workflow.


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
Service request information

Service Request ID

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

serviceRequest.id1201

Requested Item Quantity

Quantity of the individual requested items

serviceRequest.quantity

2

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

serviceRequest.turnaroundDate

2018-02-18T21:27:03.000Z


Submitted Date

UTC date and time when a request is submitted by the end user. The following format is applied: YYYY-MM-DDThh:mm:ss

serviceRequest.submittedDate

2017-11-14T21:27:03.000Z

Service information

Service ID

ID of the service in the BMC Digital Workplace Catalog

service.id

1504

External Service ID

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

Connection ID

Connection ID of system integrated with BMC 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

Service Name

Catalog profile name of the service being requestedservice.nameAccounting Software 6.0

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

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

Is Bundle

Identifies whether the service is part of a bundle 

service.bundle0 for false; 1 for true

Order Description

Description of an order
orderDescription

Order GUID

The order GUID identifies that the request was sent as a shopping cart order.orderGuidAGGCEME2HPULZAOHWQ3GAAAC0NGVUV

Order ID

ID value of an order.
orderId
2812
Requested for user

Login Name

Login name of a requested for user

requestedFor.loginNamebbaxter

Email

Email of a requested for user

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

Full Name

Name of a requested for user

requestedFor.fullNameBob Baxter

NT Domain

NT domain of a requested for user

Note: 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

Department

Department name of a requested for user

requestedFor.departmentPay & Benefits

Region

Region of a requested for user

requestedFor.regionAmericas

Site Group

Site group of a requested for user

requestedFor.siteGroupSouth America
Name

Site name of a requested for user

requestedFor.site.nameSao Paulo Agency

Country

Country of a requested for user

requestedFor.site.countrythe USA

State Province

State or province of a requested for user

requestedFor.site.stateProvinceFlorida

City

City of a requested for user

requestedFor.site.cityMiami

Zip Postal Code

Zip or postal code of a requested for user

requestedFor.site.zipPostalCode33018

Street

Street of a requested for user

requestedFor.site.streetAbaco Ave

Job Title

Job title of a requested for user

requestedFor.jobTitleCook
Requested by user

Login Name

Login of a requested by user requestedBy.loginNamemmann

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

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 userrequestedBy.organizationHR

Department

Department of a requested by userrequestedBy.departmentPay & Benefits

Site Group

Site group of a requested by userrequestedBy.siteGroupSouth America

Region

Region of a requested by userrequestedBy.regionAmericas

Country

Country of a requested by userrequestedBy.site.countrythe USA

State Province

State province of a requested by userrequestedBy.site.stateProvinceFlorida

Name

Site name of a requested by userrequestedBy.site.nameSao Paulo Agency

City

City of a requested by userrequestedBy.site.cityMiami

Zip Postal Code

Zip postal code of a requested by user

requestedBy.site.zipPostalCode32006

Street

Street of a requested by userrequestedBy.site.street37th St

Job Title

Job title of a requested by userrequestedBy.jobTitleEngineer
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.

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.

Notes:

  • If a question is attached to a process input variable, then 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
[
  {
    "key":"3",
    "label":"size",
    "valueType":"TEXT",
    "value":"S",
    "displayValue":null,
    "assignedToProcessInput":true
  },
]
[
{
    "key":"2",
    "label":"Colors",
    "valueType":"LIST",
    "value":[
      "green",
      "red"
    ],
    "displayValue":[
      "displaying green",
      "displaying red"
    ],
    "assignedToProcessInput":false
  }
]
Was this page helpful? Yes No Submitting... Thank you

Comments