本指南說明如何管理流程步驟執行時發生的錯誤。您可以指定失敗的步驟是否需要使用者採取行動才能解決，或是可以重試。
- 傳回可執行的錯誤：在錯誤記錄中附加按鈕，將使用者導向步驟的設定資訊卡，讓他們修改輸入內容來解決錯誤。如要將錯誤標示為可採取行動，請傳回
AddOnsResponseService.ErrorActionability.ACTIONABLE。如要將錯誤標示為無法處理，請傳回AddOnsResponseService.ErrorActionability.NOT_ACTIONABLE。 - 發生錯誤後重試步驟：流程會嘗試重新執行步驟最多 5 次，然後停止。如要將錯誤標示為可重試的錯誤，請傳回
AddOnsResponseService.ErrorRetryability.RETRYABLE。如要標示無法重試的錯誤，請傳回AddOnsResponseService.ErrorRetryability.NOT_RETRYABLE。
您也可以建立自訂錯誤記錄，並加入晶片、超連結和樣式化文字，為使用者提供更詳細的錯誤背景資訊。
傳回可採取行動的錯誤
以下範例會建構一個步驟，要求使用者輸入負數。如果使用者輸入正數，這個步驟會傳回可執行的錯誤，提示使用者修正輸入內容。
以下資訊清單檔案定義步驟的輸入內容、輸出內容，以及要呼叫的設定和執行函式。
JSON
{
"timeZone": "America/Toronto",
"dependencies": {},
"exceptionLogging": "STACKDRIVER",
"runtimeVersion": "V8",
"addOns": {
"common": {
"name": "Retry Errors Example",
"logoUrl": "https://www.gstatic.com/images/icons/material/system/1x/pets_black_48dp.png",
"useLocaleFromApp": true
},
"flows": {
"workflowElements": [
{
"id": "returnElementError",
"state": "ACTIVE",
"name": "Return Element Error Action",
"description": "To notify the user that some error has occurred",
"workflowAction": {
"inputs": [
{
"id": "value1",
"description": "The input from the user",
"cardinality": "SINGLE",
"dataType": {
"basicType": "STRING"
}
}
],
"outputs": [
{
"id": "output_1",
"description": "The output",
"cardinality": "SINGLE",
"dataType": {
"basicType": "STRING"
}
}
],
"onConfigFunction": "onConfiguration",
"onExecuteFunction": "onExecution"
}
}
]
}
}
}
下列程式碼會建構設定資訊卡，並處理執行邏輯，包括錯誤處理。
Apps Script
/**
* Returns a configuration card for the step.
* This card contains a text input field for the user.
*/
function onConfiguration() {
let section = CardService.newCardSection()
.addWidget(CardService.newTextInput()
.setFieldName("value1")
.setId("value1")
.setTitle("Please input negative numbers!"));
const card = CardService.newCardBuilder().addSection(section).build();
return card;
}
/**
* Gets an integer value from variable data, handling both string and integer formats.
* @param {Object} variableData The variable data object from the event.
* @return {number} The extracted integer value.
*/
function getIntValue(variableData) {
if (variableData.stringValues) {
return parseInt(variableData.stringValues[0]);
}
return variableData.integerValues[0];
}
/**
* Executes the step.
* If the user input is a positive number, it throws an error and returns an
* actionable error message. Otherwise, it returns the input as an output variable.
* @param {Object} e The event object from the workflow.
*/
function onExecution(e) {
try {
var input_value = getIntValue(e.workflow.actionInvocation.inputs["value1"]);
if (input_value > 0) {
throw new Error('Found invalid positive input value!');
}
// If execution is successful, return the output variable and a log.
const styledText_1 = AddOnsResponseService.newStyledText()
.setText("Execution completed, the number you entered was: ")
.addStyle(AddOnsResponseService.TextStyle.ITALIC)
.addStyle(AddOnsResponseService.TextStyle.UNDERLINE);
const styledText_2 = AddOnsResponseService.newStyledText().setText(input_value)
.setFontWeight(AddOnsResponseService.FontWeight.BOLD);
const workflowAction = AddOnsResponseService.newReturnOutputVariablesAction()
.setVariables({
"output_1": AddOnsResponseService.newVariableData().addStringValue(input_value)
})
.setLog(AddOnsResponseService.newWorkflowTextFormat()
.addTextFormatElement(
AddOnsResponseService.newTextFormatElement().setStyledText(styledText_1)
).addTextFormatElement(
AddOnsResponseService.newTextFormatElement().setStyledText(styledText_2)
));
let hostAppAction = AddOnsResponseService.newHostAppAction().setWorkflowAction(workflowAction);
return AddOnsResponseService.newRenderActionBuilder().setHostAppAction(hostAppAction).build();
} catch (err) {
// If an error occurs, return an actionable error action.
Logger.log('An error occurred: ' + err.message);
const workflowAction = AddOnsResponseService.newReturnElementErrorAction()
// Sets the user-facing error message.
.setErrorLog(
AddOnsResponseService.newWorkflowTextFormat()
.addTextFormatElement(
AddOnsResponseService.newTextFormatElement().setText("Failed because of invalid input values!"))
)
// Makes the error actionable, allowing the user to correct the input.
.setErrorActionability(AddOnsResponseService.ErrorActionability.ACTIONABLE)
// Specifies that the error is not automatically retried.
.setErrorRetryability(AddOnsResponseService.ErrorRetryability.NOT_RETRYABLE);
let hostAppAction = AddOnsResponseService.newHostAppAction().setWorkflowAction(workflowAction);
return AddOnsResponseService.newRenderActionBuilder().setHostAppAction(hostAppAction).build();
}
}
發生錯誤後重試步驟
以下範例會建構模擬暫時性失敗的步驟。如果發生錯誤，這個步驟會傳回可重試的錯誤，導致流程重新執行這個步驟。
資訊清單檔案會定義步驟。
JSON
{
"timeZone": "America/Toronto",
"dependencies": {},
"exceptionLogging": "STACKDRIVER",
"runtimeVersion": "V8",
"addOns": {
"common": {
"name": "Retry Errors Example",
"logoUrl": "https://www.gstatic.com/images/icons/material/system/1x/pets_black_48dp.png",
"useLocaleFromApp": true
},
"flows": {
"workflowElements": [
{
"id": "retryError",
"state": "ACTIVE",
"name": "Retry an error",
"description": "Simulates a temporary failure and retries the step.",
"workflowAction": {
"inputs": [
{
"id": "value1",
"description": "Any input value",
"cardinality": "SINGLE",
"dataType": {
"basicType": "STRING"
}
}
],
"outputs": [
{
"id": "output_1",
"description": "The output",
"cardinality": "SINGLE",
"dataType": {
"basicType": "STRING"
}
}
],
"onConfigFunction": "onRetryConfiguration",
"onExecuteFunction": "onRetryExecution"
}
}
]
}
}
}
下列程式碼會建構設定資訊卡，並處理重試邏輯。
Apps Script
/**
* Returns a configuration card for the step.
* This card contains a text input field for the user.
*/
function onRetryConfiguration() {
let section = CardService.newCardSection()
.addWidget(CardService.newTextInput()
.setFieldName("value1")
.setId("value1")
.setTitle("Enter any value"));
const card = CardService.newCardBuilder().addSection(section).build();
return card;
}
/**
* Executes the step and simulates a transient error.
* This function fails 80% of the time. When it fails, it returns an
* error that can be retried.
* @param {Object} e The event object from the workflow.
*/
function onRetryExecution(e) {
try {
// Simulate a transient error that fails 80% of the time.
if (Math.random() < 0.8) {
throw new Error('Simulated transient failure!');
}
// If execution is successful, return the output variable and a log.
var input_value = e.workflow.actionInvocation.inputs["value1"].stringValues[0];
const styledText = AddOnsResponseService.newStyledText()
.setText(`Execution succeeded for input: ${input_value}`);
const workflowAction = AddOnsResponseService.newReturnOutputVariablesAction()
.setVariables({
"output_1": AddOnsResponseService.newVariableData().addStringValue(input_value)
})
.setLog(AddOnsResponseService.newWorkflowTextFormat()
.addTextFormatElement(
AddOnsResponseService.newTextFormatElement().setStyledText(styledText)
));
let hostAppAction = AddOnsResponseService.newHostAppAction().setWorkflowAction(workflowAction);
return AddOnsResponseService.newRenderActionBuilder().setHostAppAction(hostAppAction).build();
} catch (err) {
// If a transient error occurs, return an error message saying the step tries to run again.
Logger.log('A error occurred, trying to run the step again: ' + err.message);
const workflowAction = AddOnsResponseService.newReturnElementErrorAction()
// Sets the user-facing error message.
.setErrorLog(
AddOnsResponseService.newWorkflowTextFormat()
.addTextFormatElement(
AddOnsResponseService.newTextFormatElement().setText("A temporary error occurred. The step will be retried."))
)
// Makes the error not actionable by the user.
.setErrorActionability(AddOnsResponseService.ErrorActionability.NOT_ACTIONABLE)
// Specifies that the error is automatically retried.
.setErrorRetryability(AddOnsResponseService.ErrorRetryability.RETRYABLE);
let hostAppAction = AddOnsResponseService.newHostAppAction().setWorkflowAction(workflowAction);
return AddOnsResponseService.newRenderActionBuilder().setHostAppAction(hostAppAction).build();
}
}