Searching the Help
To search for information in the Help, type a word or phrase in the Search box. When you enter a group of words, OR is inferred. You can use Boolean operators to refine your search.
Results returned are case insensitive. However, results ranking takes case into account and assigns higher scores to case matches. Therefore, a search for "cats" followed by a search for "Cats" would return the same number of Help topics, but the order in which the topics are listed would be different.
Search for | Example | Results |
---|---|---|
A single word | cat
|
Topics that contain the word "cat". You will also find its grammatical variations, such as "cats". |
A phrase. You can specify that the search results contain a specific phrase. |
"cat food" (quotation marks) |
Topics that contain the literal phrase "cat food" and all its grammatical variations. Without the quotation marks, the query is equivalent to specifying an OR operator, which finds topics with one of the individual words instead of the phrase. |
Search for | Operator | Example |
---|---|---|
Two or more words in the same topic |
|
|
Either word in a topic |
|
|
Topics that do not contain a specific word or phrase |
|
|
Topics that contain one string and do not contain another | ^ (caret) |
cat ^ mouse
|
A combination of search types | ( ) parentheses |
|
Select Tokens
A token is a system value that is automatically resolved internally when the property is read. Token values are available only for the following:
- String property for a component type, component template, service component in a design, or resource offering
- Parameter when a topology component operation has a mapping type of Context Property Token
- String parameter input for an action
-
A parameter value to a script that is configured on a subscriber option property that is configured for Input Validation
-
A parameter value to a script that is configured on a subscriber option property of type List that is Dynamic Entry
-
A parameter value to a script that is configured on a user operation input parameter that is configured for Input Validation
-
A parameter value to a script that is configured on a user operation input parameter that has a mapping type of Prompt User List with the list configured for Dynamic Entry
The following tables provide all available tokens, their descriptions, and to which area they apply.
Server-side tokens
Token | Description | Applies to |
---|---|---|
Action Execution Retry |
Resolves to false on the first attempt of an action. Resolves to true for subsequent action attempts after the initial action failed. |
|
Action Name |
Resolves to the value of ORDER when initially ordering a subscription and to the value of MODIFY_SUBSCRIPTION when modifying an existing subscription. |
|
Keystone Trust ID |
Resolves to the Keystone Trust ID. |
|
Parent Service Component ID |
Resolves to the Service Component ID of the parent service component. For resource offerings, the Service Component ID refers to the service component that the resource offering is associated with in a service design. |
|
Resource Binding ID [TOKEN:RSC_BINDING_ID] |
Resolves to the Resource Binding ID that was created at subscription time. |
|
Resource Subscription ID |
Resolves to the Resource Subscription ID that was created from the resource offering at subscription time. |
|
Selected Provider ID [TOKEN:RSC_PROVIDER_ID] |
Resolves to the Provider ID that was selected at subscription time. |
|
Selected Resource Pool ID |
Resolves to the Resource Pool ID that was selected at subscription time. |
|
Service Blueprint ID [TOKEN:SVC_BLUEPRINT_ID] |
Resolves to the Service Blueprint ID. |
|
Service Catalog ID [TOKEN:SVC_CATALOG_ID] |
Resolves to the Service Catalog ID used at subscription time. |
|
Service Component ID |
Resolves to the Service Component ID of the component associated with this action. For resource offerings, the Service Component ID refers to the service component that the resource offering is associated with in a service design. |
|
Service Component Type |
Resolves to the Service Component Type (for example, Server) of the component associated with this action. For resource offerings, the Service Component Type refers to the service component that the resource offering is associated with in a service design. |
|
Service Instance ID |
Resolves to the Service Instance ID created at subscription time. |
|
Service Offering ID [TOKEN:SVC_OFFERING_ID] |
Resolves to the Service Offering ID. |
|
Service Request Organization ID [TOKEN:REQ_ORG_ID] |
Resolves to the Organization ID associated with the service request. |
|
Service Request User ID [TOKEN:REQ_USER_ID] |
Resolves the User ID associated with the service request. |
|
Subscriber's Email Address |
Resolves to email address of the subscriber. |
|
Subscriber's Organization ID [TOKEN:USR_ORG_ID] |
Resolves to the Organization ID associated with the subscriber. |
|
Subscription ID |
Resolves to the Subscription ID created at subscription time. |
|
Client-side Tokens
Token | Description | Applies to |
---|---|---|
[CLIENT:<property_name>] |
Allows you to have a dependency on a value of another property in the same option. This allows, for example, a parameter to a script on a Site option property (of type List, configured for Dynamic Entry) to reference the value of a Region option property on the same option. Note that |
|
[CLIENT:<parameter_name>] |
Allows you to have a dependency on a value of a user operation input parameter. This allows, for example, an input validation script to retrieve the value of an action parameter input for validation. |
User Operations |
[PROVIDER:<provider_name>:ID] |
The ID of the provider with the specified name that was selected by the subscriber when ordering the subscription. |
|
Portal Tokens
When a subscription is owned by a group, a requesting user can be different than the user who made the initial subscription request. Use portal tokens to retrieve the context of the requesting user.
Token | Description | Applies to |
---|---|---|
Catalog ID |
The ID of the catalog where a consumer user submits an initial subscription request or a request to modify an existing subscription. |
|
Organization ID |
The ID of the Organization to which the consumer user who submits a subscription request belongs. |
|
Organization Name |
The name of the Organization to which the consumer user who submits a subscription request belongs. |
|
User Email |
The email address of the consumer user who submits an initial subscription request or a request to modify an existing subscription. |
|
User ID |
The ID of the consumer user who submits an initial subscription request or a request to modify an existing subscription. |
|
User Name |
Resolves to the User Name. |
|
We welcome your comments!
To open the configured email client on this computer, open an email window.
Otherwise, copy the information below to a web mail client, and send this email to clouddocs@hpe.com.
Help Topic ID:
Product:
Topic Title:
Feedback: