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.
Words and Phrases
| 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. |
Using Boolean Operators
| 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 |
|
Set up approval plan for a custom record type
For custom record types created using Studio, you can create approval definitions and enable approval plans in a workflow.
Create approval definitions
-
From the main menu, select Administration > Configuration > Studio.
- Select a custom record type.
- Create an approval definition as described in How to build an approval definition.
- You can add more approval definitions to the custom record type.
Notes:
- Approval definitions of a custom record type cannot be removed after being created. This behavior is identical to the behavior of the Change or Idea record type.
-
Approval definitions is not covered by the dev2prod process. This behavior is identical to the behavior of the Change or Idea record type.
How to enable/disable approval plan in a phase
-
From the main menu, select Administration > Configuration > Studio.
-
Select a custom record type.
- Click the Processes and Rules tab.
-
Select a phase, click the Properties tab on the right panel.
-
Select or deselect the Enable Approval Plan check box.
-
Click Save.
-
Click the Fields tab, if the Enable Approval Plan check box was selected, you will find that a field named TaskPlanFor<Phase>_<UniqueSuffix> is created for the phase on which you enabled the approval plan. For example, for a field named "TaskPlanForCustomPhase2_GJGFYU09Z,” “CustomPhase2” is the phase name, and “GJGFYU09Z” is a unique suffix generated by the system. If you deselected the Enable Approval Plan check box, the corresponding field will be removed. The TaskPlanFor<Phase>_<UniqueSuffix> field can be used in DSL expressions of workflow business rules. See Studio business rules for more information.
-
If the approval plan is enabled in a phase, the phase cannot be moved to another metaphase. To move the phase to another metaphase, you will have to disable the approval plan and save.
How to select/deselect approval definition in a phase
If the Enable Approval Plan check box is selected for a phase, you can specify the approval definition to be used by the phase.
-
From the main menu, select Administration > Configuration > Studio.
-
Select a custom record type.
-
Select a phase, click the Properties tab on the right panel.
-
Select Approval Definition from the drop-down list or clear the field.
-
Click Save.
See Approval definitions for more information.
How to use approval plan on a custom record instance
- Open a custom record instance from the customized menu. Select a record instance or create a new record instance, fill in the detail page.
-
Click the Approvals tab on the left panel. This tab will not be displayed if no approval plan was enabled in any phase of the current record type.
-
Tabs of phases that have approval plans are shown on the right panel.
-
Approval pans will be shown if the phase has an approval definition. Otherwise, empty approval plan will be shown.
-
You can edit the approval plan if no approval definition has been defined in the phase.
- Click Save.
-
Customer can only view approval plan if there is approval definition defined in the phase.
-
After the record instance enters the phase that has approval plan enabled, the approval plan will be triggered.
How to make sure the process does not enter the next phase until all approvals are finished successfully
As long as there are unfinished approvals, the process should not move on to the next phase. This can be achieved using workflow business rules. The following steps give an example of it, the steps may vary depending on your business case.
In this example, the bb phase has an approval plan. The display label is "bb," the name is "CustomPhase1."
- From the main menu, select Administration > Configuration > Studio.
-
Select the custom record type, click the Processes and Rules tab.
-
Select the transition after the phase that has approval plan enabled. In this example, select the transition after the bb phase.
- Click the Properties tab on the right side panel.
-
Change transition type to Automatic.
-
Enter the following DSL expression in Condition:
${entity.TaskPlanFor<Phasename>_<UniqueSuffix>.ExecutionPlanCompletionCode == 'Success'}In this example,
TaskPlanFor<Phasename>_<UniqueSuffix>should be TaskPlanForCustomPhase2_GJGFYU09Z. You can also add other business conditions here. - Save the workflow.
Create a new record and fill in the record's detail page. The next phase will be disabled until the approval plan is finished with the status "Success," and the process will automatically move on to the next phase when the approval plan is finished.
More information
- Depending on the definition in the Studio, the Approvals tab may or may not be displayed on a record's detail page.
- An approval plan shows up in a phase only when it was enabled for the phase in Studio.
- When a record is created, everything on the Approvals tab of a record's detail page is copied from the approval definition of the record type. If you modify the approval definition of the record type, the changes will not affect the records that were created before. This behavior is identical to the behavior of the Change or Idea record type.
