forked from docs/doc-exports
chenxiaoxiong
f9e2808b7c
Reviewed-by: Pruthi, Vineet <vineet.pruthi@t-systems.com> Co-authored-by: chenxiaoxiong <chenxiaoxiong@huawei.com> Co-committed-by: chenxiaoxiong <chenxiaoxiong@huawei.com>
136 lines
19 KiB
HTML
136 lines
19 KiB
HTML
<a name="dataartsstudio_01_0468"></a><a name="dataartsstudio_01_0468"></a>
|
|
|
|
<h1 class="topictitle1">SMN</h1>
|
|
<div id="body8662426"><div class="section" id="dataartsstudio_01_0468__en-us_topic_0121505665_section44280035173841"><h4 class="sectiontitle">Functions</h4><p id="dataartsstudio_01_0468__en-us_topic_0121505665_p3249577917391">The <span id="dataartsstudio_01_0468__en-us_topic_0121505665_text189001738123012">SMN</span> node is used to send notifications to users.</p>
|
|
</div>
|
|
<div class="section" id="dataartsstudio_01_0468__en-us_topic_0121505665_section6331447317395"><h4 class="sectiontitle">Parameters</h4><p id="dataartsstudio_01_0468__en-us_topic_0121505665_p49252448103256"><a href="#dataartsstudio_01_0468__en-us_topic_0121505665_table3764823994826">Table 1</a> and <a href="#dataartsstudio_01_0468__en-us_topic_0121505665_table58040457102411">Table 2</a> describe the parameters of the <span id="dataartsstudio_01_0468__en-us_topic_0121505665_text45961901417">SMN</span> node.</p>
|
|
|
|
<div class="tablenoborder"><a name="dataartsstudio_01_0468__en-us_topic_0121505665_table3764823994826"></a><a name="en-us_topic_0121505665_table3764823994826"></a><table cellpadding="4" cellspacing="0" summary="" id="dataartsstudio_01_0468__en-us_topic_0121505665_table3764823994826" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameters of <span id="dataartsstudio_01_0468__en-us_topic_0121505665_text9379171614144">SMN</span> nodes</caption><thead align="left"><tr id="dataartsstudio_01_0468__en-us_topic_0121505665_row3170822394826"><th align="left" class="cellrowborder" valign="top" width="21.740000000000002%" id="mcps1.3.2.3.2.4.1.1"><p id="dataartsstudio_01_0468__en-us_topic_0121505665_p2984581994826">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="9.92%" id="mcps1.3.2.3.2.4.1.2"><p id="dataartsstudio_01_0468__en-us_topic_0121505665_p159227094826">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="68.34%" id="mcps1.3.2.3.2.4.1.3"><p id="dataartsstudio_01_0468__en-us_topic_0121505665_p6186505494826">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dataartsstudio_01_0468__en-us_topic_0121505665_row1991457694826"><td class="cellrowborder" valign="top" width="21.740000000000002%" headers="mcps1.3.2.3.2.4.1.1 "><p id="dataartsstudio_01_0468__en-us_topic_0121505665_p246794194826">Node Name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="9.92%" headers="mcps1.3.2.3.2.4.1.2 "><p id="dataartsstudio_01_0468__en-us_topic_0121505665_p6568554794826">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="68.34%" headers="mcps1.3.2.3.2.4.1.3 "><p id="dataartsstudio_01_0468__en-us_topic_0121505665_p1892909794826">Name of a <span id="dataartsstudio_01_0468__en-us_topic_0099822521_text44323307153939">node</span>. The name must contain 1 to 128 characters, including only letters, numbers, underscores (_), hyphens (-), slashes (/), less-than signs (<), and greater-than signs (>).</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dataartsstudio_01_0468__en-us_topic_0121505665_row3614415394826"><td class="cellrowborder" valign="top" width="21.740000000000002%" headers="mcps1.3.2.3.2.4.1.1 "><p id="dataartsstudio_01_0468__en-us_topic_0121505665_p4898925756">Topic Name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="9.92%" headers="mcps1.3.2.3.2.4.1.2 "><p id="dataartsstudio_01_0468__en-us_topic_0121505665_p4617707494826">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="68.34%" headers="mcps1.3.2.3.2.4.1.3 "><p id="dataartsstudio_01_0468__en-us_topic_0121505665_p4935552994826">Name of the topic. The topic has been created in SMN.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dataartsstudio_01_0468__en-us_topic_0121505665_row4154658494826"><td class="cellrowborder" valign="top" width="21.740000000000002%" headers="mcps1.3.2.3.2.4.1.1 "><p id="dataartsstudio_01_0468__en-us_topic_0121505665_p983015394826">Message Title</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="9.92%" headers="mcps1.3.2.3.2.4.1.2 "><p id="dataartsstudio_01_0468__en-us_topic_0121505665_p5804493094826">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="68.34%" headers="mcps1.3.2.3.2.4.1.3 "><p id="dataartsstudio_01_0468__en-us_topic_0121505665_p401892494826">Title of the message. The title cannot exceed 512 characters.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dataartsstudio_01_0468__en-us_topic_0121505665_row824216571514"><td class="cellrowborder" valign="top" width="21.740000000000002%" headers="mcps1.3.2.3.2.4.1.1 "><p id="dataartsstudio_01_0468__en-us_topic_0121505665_p102421575510">Message Type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="9.92%" headers="mcps1.3.2.3.2.4.1.2 "><p id="dataartsstudio_01_0468__en-us_topic_0121505665_p32421357353">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="68.34%" headers="mcps1.3.2.3.2.4.1.3 "><p id="dataartsstudio_01_0468__en-us_topic_0121505665_p324255714511">Format of the message.</p>
|
|
<ul id="dataartsstudio_01_0468__en-us_topic_0121505665_ul894915486811"><li id="dataartsstudio_01_0468__en-us_topic_0121505665_li220631610225"><strong id="dataartsstudio_01_0468__en-us_topic_0121505665_b84235270616514">Text</strong>: The message is sent in text format.</li><li id="dataartsstudio_01_0468__en-us_topic_0121505665_li011182382211"><strong id="dataartsstudio_01_0468__en-us_topic_0121505665_b6558153819206">JSON</strong>: The message is sent in JSON format. You can send different messages to types of subscribers.<ul id="dataartsstudio_01_0468__en-us_topic_0121505665_ul108611718201819"><li id="dataartsstudio_01_0468__en-us_topic_0121505665_li1569362216191">Manual: You can enter a message in <span class="parmname" id="dataartsstudio_01_0468__en-us_topic_0121505665_parmname94711855122718"><b>Message Content</b></span>.</li><li id="dataartsstudio_01_0468__en-us_topic_0121505665_li1574411618183">Automatic: Click <span class="uicontrol" id="dataartsstudio_01_0468__en-us_topic_0121505665_uicontrol106399611322"><b>Generate JSON Message</b></span>. In the displayed dialog box, enter a message and select a protocol.</li></ul>
|
|
</li><li id="dataartsstudio_01_0468__en-us_topic_0121505665_li172451726162218"><strong id="dataartsstudio_01_0468__en-us_topic_0121505665_b14840121610337">Template</strong>: The message is sent in template format, that is, in fixed format. The variables can be processed by tags.<ul id="dataartsstudio_01_0468__en-us_topic_0121505665_ul5156162214236"><li id="dataartsstudio_01_0468__en-us_topic_0121505665_li638640849409">Manual: You can enter a message in <span class="parmname" id="dataartsstudio_01_0468__en-us_topic_0121505665_parmname1777393543419"><b>Message Content</b></span>.</li><li id="dataartsstudio_01_0468__en-us_topic_0121505665_li9494182019236">Automatic: Click <span class="uicontrol" id="dataartsstudio_01_0468__en-us_topic_0121505665_uicontrol3551598355"><b>Generate Template Message</b></span>. In the displayed dialog box, select a template name and set the value of <strong id="dataartsstudio_01_0468__en-us_topic_0121505665_b216911444351">tag</strong>.</li></ul>
|
|
</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="dataartsstudio_01_0468__en-us_topic_0121505665_row86829521857"><td class="cellrowborder" valign="top" width="21.740000000000002%" headers="mcps1.3.2.3.2.4.1.1 "><p id="dataartsstudio_01_0468__en-us_topic_0121505665_p168315219518">Message Content</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="9.92%" headers="mcps1.3.2.3.2.4.1.2 "><p id="dataartsstudio_01_0468__en-us_topic_0121505665_p668310521753">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="68.34%" headers="mcps1.3.2.3.2.4.1.3 "><p id="dataartsstudio_01_0468__en-us_topic_0121505665_p176838521510">Message content to be provided. The requirements for entering different types of messages are as follows:</p>
|
|
<ul id="dataartsstudio_01_0468__en-us_topic_0121505665_ul12110204962819"><li id="dataartsstudio_01_0468__en-us_topic_0121505665_li14110154914289"><strong id="dataartsstudio_01_0468__en-us_topic_0121505665_b86921115183719">Text</strong>: The size cannot exceed 10 KB.</li><li id="dataartsstudio_01_0468__en-us_topic_0121505665_li1077411114301"><strong id="dataartsstudio_01_0468__en-us_topic_0121505665_b13123132715376">JSON</strong>: The JSON message must contain the Default protocol and the size cannot exceed 10 KB.<p id="dataartsstudio_01_0468__en-us_topic_0121505665_p3357911183013">Example:</p>
|
|
<pre class="screen" id="dataartsstudio_01_0468__en-us_topic_0121505665_screen1111832917339">{
|
|
"default": "Dear Sir or Madam, this is a default message.",
|
|
"email": "Dear Sir or Madam, this is an email message.",
|
|
"http": "{'message':'Dear Sir or Madam, this is an HTTP message.'}",
|
|
"https": "{'message':'Dear Sir or Madam, this is an HTTPS message.'}",
|
|
"sms": "This is an SMS message."
|
|
}</pre>
|
|
</li><li id="dataartsstudio_01_0468__en-us_topic_0121505665_li17627182911360"><strong id="dataartsstudio_01_0468__en-us_topic_0121505665_b64892053123716">Template</strong>: The size cannot exceed 10 KB.<p id="dataartsstudio_01_0468__en-us_topic_0121505665_p14393627193819">Example:</p>
|
|
<pre class="screen" id="dataartsstudio_01_0468__en-us_topic_0121505665_screen1768623311385">"message_template_name":"confirm_message",
|
|
"tags":{
|
|
"topic_urn":"urn:smn:regionId:xxxx:SMN_01"
|
|
}</pre>
|
|
<p id="dataartsstudio_01_0468__en-us_topic_0121505665_p261631719454">In the preceding information, <span class="parmname" id="dataartsstudio_01_0468__en-us_topic_0121505665_parmname44411925103813"><b>message_template_name</b></span> indicates the template name, and <span class="parmname" id="dataartsstudio_01_0468__en-us_topic_0121505665_parmname59411839173812"><b>tags</b></span> indicates all tags in the template.</p>
|
|
</li></ul>
|
|
<p id="dataartsstudio_01_0468__en-us_topic_0121505665_p1847153271012">For details about how to configure SMN, see section the <i><cite id="dataartsstudio_01_0468__en-us_topic_0121505665_cite937a2695a5ba4991937fa1751bea1ef6104732">Simple Message Notification User Guide</cite></i>.</p>
|
|
<p id="dataartsstudio_01_0468__p1329716304359"></p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="dataartsstudio_01_0468__en-us_topic_0121505665_table58040457102411"></a><a name="en-us_topic_0121505665_table58040457102411"></a><table cellpadding="4" cellspacing="0" summary="" id="dataartsstudio_01_0468__en-us_topic_0121505665_table58040457102411" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Advanced parameters</caption><thead align="left"><tr id="dataartsstudio_01_0468__en-us_topic_0099822521_row9846111555118"><th align="left" class="cellrowborder" valign="top" width="28.07%" id="mcps1.3.2.4.2.4.1.1"><p id="dataartsstudio_01_0468__en-us_topic_0099822521_p2846515195115">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15.659999999999998%" id="mcps1.3.2.4.2.4.1.2"><p id="dataartsstudio_01_0468__en-us_topic_0099822521_p108461215185110">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="56.269999999999996%" id="mcps1.3.2.4.2.4.1.3"><p id="dataartsstudio_01_0468__en-us_topic_0099822521_p1484719153511">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dataartsstudio_01_0468__en-us_topic_0099822521_row18847141515512"><td class="cellrowborder" valign="top" width="28.07%" headers="mcps1.3.2.4.2.4.1.1 "><p id="dataartsstudio_01_0468__en-us_topic_0099822521_p2847181535113">Max. Node Execution Duration</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.659999999999998%" headers="mcps1.3.2.4.2.4.1.2 "><p id="dataartsstudio_01_0468__en-us_topic_0099822521_p15847171511512">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.269999999999996%" headers="mcps1.3.2.4.2.4.1.3 "><p id="dataartsstudio_01_0468__en-us_topic_0099822521_p1884761565119">Execution timeout interval for the <span id="dataartsstudio_01_0468__en-us_topic_0099822521_text1344611820218">node</span>. If retry is configured and the execution is not complete within the timeout interval, the <span id="dataartsstudio_01_0468__en-us_topic_0099822521_text8447488212">node</span> will be executed again.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dataartsstudio_01_0468__en-us_topic_0099822521_row19847181555112"><td class="cellrowborder" valign="top" width="28.07%" headers="mcps1.3.2.4.2.4.1.1 "><p id="dataartsstudio_01_0468__en-us_topic_0099822521_p12847815125117">Retry upon Failure</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.659999999999998%" headers="mcps1.3.2.4.2.4.1.2 "><p id="dataartsstudio_01_0468__en-us_topic_0099822521_p8847161516511">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.269999999999996%" headers="mcps1.3.2.4.2.4.1.3 "><p id="dataartsstudio_01_0468__en-us_topic_0099822521_p684761514516">Whether to re-execute a <span id="dataartsstudio_01_0468__en-us_topic_0099822521_text68471415185118">node</span> if it fails to be executed. Possible values:</p>
|
|
<ul id="dataartsstudio_01_0468__en-us_topic_0099822521_ul18479151514"><li id="dataartsstudio_01_0468__en-us_topic_0099822521_li148481915205115"><strong id="dataartsstudio_01_0468__en-us_topic_0099822521_b692668954">Yes</strong>: The <span id="dataartsstudio_01_0468__en-us_topic_0099822521_text184861512517">node</span> will be re-executed, and the following parameters must be configured:<ul id="dataartsstudio_01_0468__en-us_topic_0099822521_ul284811151511"><li id="dataartsstudio_01_0468__en-us_topic_0099822521_li1927319416429"><strong id="dataartsstudio_01_0468__en-us_topic_0099822521_b11288652181717">Retry upon Timeout</strong></li><li id="dataartsstudio_01_0468__en-us_topic_0099822521_li1584811515119"><strong id="dataartsstudio_01_0468__en-us_topic_0099822521_b1150205942">Maximum Retries</strong></li><li id="dataartsstudio_01_0468__en-us_topic_0099822521_li1184841512511"><strong id="dataartsstudio_01_0468__en-us_topic_0099822521_b910983280">Retry Interval (seconds)</strong></li></ul>
|
|
</li><li id="dataartsstudio_01_0468__en-us_topic_0099822521_li1884851535115"><strong id="dataartsstudio_01_0468__en-us_topic_0099822521_b8133175784614">No</strong>: The <span id="dataartsstudio_01_0468__en-us_topic_0099822521_text5848215145116">node</span> will not be re-executed. This is the default setting.<div class="note" id="dataartsstudio_01_0468__en-us_topic_0099822521_note112261354122511"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="dataartsstudio_01_0468__en-us_topic_0099822521_p1722635418254">If retry is configured for a job node and the timeout duration is configured, the system allows you to retry a node when the node execution times out.</p>
|
|
<p id="dataartsstudio_01_0468__en-us_topic_0099822521_p1690217201682">If a node is not re-executed when it fails upon timeout, you can go to the <strong id="dataartsstudio_01_0468__en-us_topic_0099822521_b14924182735216">Default Configuration</strong> page to modify this policy.</p>
|
|
<p id="dataartsstudio_01_0468__en-us_topic_0099822521_p979555414426"><strong id="dataartsstudio_01_0468__en-us_topic_0099822521_b11436145811174">Retry upon Timeout</strong> is displayed only when <strong id="dataartsstudio_01_0468__en-us_topic_0099822521_b64361558201713">Retry upon Failure</strong> is set to <strong id="dataartsstudio_01_0468__en-us_topic_0099822521_b34366589176">Yes</strong>.</p>
|
|
</div></div>
|
|
</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="dataartsstudio_01_0468__en-us_topic_0099822521_row148481015115110"><td class="cellrowborder" valign="top" width="28.07%" headers="mcps1.3.2.4.2.4.1.1 "><p id="dataartsstudio_01_0468__en-us_topic_0099822521_p168481315165110">Policy for Handling Subsequent Nodes If the Current Node Fails</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.659999999999998%" headers="mcps1.3.2.4.2.4.1.2 "><p id="dataartsstudio_01_0468__en-us_topic_0099822521_p7848181515114">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.269999999999996%" headers="mcps1.3.2.4.2.4.1.3 "><p id="dataartsstudio_01_0468__en-us_topic_0099822521_p1848915165110">Operation that will be performed if the <span id="dataartsstudio_01_0468__en-us_topic_0099822521_text184871517513">node</span> fails to be executed. Possible values:</p>
|
|
<ul id="dataartsstudio_01_0468__en-us_topic_0099822521_ul684811155518"><li id="dataartsstudio_01_0468__en-us_topic_0099822521_en-us_topic_0099822521_li867222192212"><strong id="dataartsstudio_01_0468__en-us_topic_0099822521_en-us_topic_0099822521_b63511334183">Suspend execution plans of the subsequent nodes</strong>: stops running subsequent nodes. The job instance status is <strong id="dataartsstudio_01_0468__en-us_topic_0099822521_en-us_topic_0099822521_b635117371819">Failed</strong>.</li><li id="dataartsstudio_01_0468__en-us_topic_0099822521_en-us_topic_0099822521_li2533844102858"><strong id="dataartsstudio_01_0468__en-us_topic_0099822521_en-us_topic_0099822521_b31833716587">End the current job execution plan</strong>: stops running the current job. The job instance status is <strong id="dataartsstudio_01_0468__en-us_topic_0099822521_en-us_topic_0099822521_b1521193765820">Failed</strong>.</li><li id="dataartsstudio_01_0468__en-us_topic_0099822521_en-us_topic_0099822521_li22804597102858"><strong id="dataartsstudio_01_0468__en-us_topic_0099822521_en-us_topic_0099822521_b72771223151916">Go to the next node</strong>: ignores the execution failure of the current node. The job instance status is <strong id="dataartsstudio_01_0468__en-us_topic_0099822521_en-us_topic_0099822521_b1727710236199">Failure ignored</strong>.</li><li id="dataartsstudio_01_0468__en-us_topic_0099822521_en-us_topic_0099822521_li1657745411173"><strong id="dataartsstudio_01_0468__en-us_topic_0099822521_en-us_topic_0099822521_b99581526191817">Suspend the current job execution plan</strong>: If the current job instance is in abnormal state, the subsequent nodes of this node and the subsequent job instances that depend on the current job are in waiting state.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="dataartsstudio_01_0468__en-us_topic_0099822521_row443311414209"><td class="cellrowborder" valign="top" width="28.07%" headers="mcps1.3.2.4.2.4.1.1 "><p id="dataartsstudio_01_0468__en-us_topic_0099822521_p6433154115208">Enable Dry Run</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.659999999999998%" headers="mcps1.3.2.4.2.4.1.2 "><p id="dataartsstudio_01_0468__en-us_topic_0099822521_p134343417207">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.269999999999996%" headers="mcps1.3.2.4.2.4.1.3 "><p id="dataartsstudio_01_0468__en-us_topic_0099822521_p9477175317207">If you select this option, the node will not be executed, and a success message will be returned.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dataartsstudio_01_0468__en-us_topic_0099822521_row127470182515"><td class="cellrowborder" valign="top" width="28.07%" headers="mcps1.3.2.4.2.4.1.1 "><p id="dataartsstudio_01_0468__en-us_topic_0099822521_p1027414042510">Task Groups</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.659999999999998%" headers="mcps1.3.2.4.2.4.1.2 "><p id="dataartsstudio_01_0468__en-us_topic_0099822521_p1827419013254">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.269999999999996%" headers="mcps1.3.2.4.2.4.1.3 "><p id="dataartsstudio_01_0468__en-us_topic_0099822521_p4881175711254">Select a task group. If you select a task group, you can control the maximum number of concurrent nodes in the task group in a fine-grained manner in scenarios where a job contains multiple nodes, a data patching task is ongoing, or a job is rerunning.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="dataartsstudio_01_0441.html">Node Reference</a></div>
|
|
</div>
|
|
</div>
|
|
|