This repository has been archived by the owner on Mar 5, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy patharticle-convwf.html
257 lines (202 loc) · 13 KB
/
article-convwf.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Salesforce Discord Community</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="description" content="">
<meta name="author" content="">
<!-- Le styles -->
<link href="assets/css/bootstrap.css" rel="stylesheet">
<link href="assets/css/bootstrap-responsive.css" rel="stylesheet">
<link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.0.12/css/all.css" integrity="sha384-G0fIWCsCzJIMAVNQPfjH08cyYaUtMwjJwqiRKxxE/rx96Uroj1BtIQ6MLJuheaO9" crossorigin="anonymous">
<link href="assets/css/style.css" rel="stylesheet">
<link href='http://fonts.googleapis.com/css?family=Raleway:400,500,600,700,800' rel='stylesheet' type='text/css'>
<!-- HTML5 shim, for IE6-8 support of HTML5 elements -->
<!--[if lt IE 9]>
<script src="assets/js/html5shiv.js"></script>
<![endif]-->
<!-- Fav and touch icons -->
<link rel="apple-touch-icon" sizes="180x180" href="/assets/ico/apple-touch-icon.png">
<link rel="icon" type="image/png" sizes="32x32" href="/assets/ico/favicon-32x32.png">
<link rel="icon" type="image/png" sizes="16x16" href="/assets/ico/favicon-16x16.png">
<link rel="manifest" href="/assets/ico/site.webmanifest">
<link rel="mask-icon" href="/assets/ico/safari-pinned-tab.svg" color="#5bbad5">
<link rel="shortcut icon" href="/assets/ico/favicon.ico">
<meta name="msapplication-TileColor" content="#da532c">
<meta name="msapplication-config" content="/assets/ico/browserconfig.xml">
<meta name="theme-color" content="#ffffff">
</head>
<body>
<!-- NAVBAR
================================================== -->
<div class="banner navbar navbar-static-top navbar-inverse">
<div class="navbar-inner">
<div class="container">
<a class="brand" href="index.html"><img src="assets/img/logo.png" width=70px></a>
<!-- Responsive Navbar -->
<div id="nav-main">
<ul id="menu" class="nav">
<li><a href="index.html">Home</a></li>
<li class="active"><a href="wiki-index.html">Knowledge Base</a></li>
<li><a href="faq.html">Faq</a></li>
<!-- Read about Bootstrap dropdowns at http://twitter.github.com/bootstrap/javascript.html#dropdowns -->
</ul>
</div><!--/.nav-collapse -->
</div> <!-- /.container -->
</div><!-- /.navbar-inner -->
</div><!-- /.navbar -->
<!-- PAGE HEADER -->
<div id="page-header-container">
<div class="container">
<div class="page-header row">
<div class="span8">
<h1>The SFXD wiki</h1>
<p class="tagline">Literally one page</p>
</div>
</div>
</div>
</div>
<!-- PAGE CONTENT -->
<div id="wrap" class="container" role="document">
<div id="content" class="row">
<div id="main" class="single-post span12" role="main">
<article class="post type-post">
<header>
<h1 class="entry-title">Workflow Naming Convention</h1>
<div class="post-meta">
<time class="updated" pubdate>Last Updated: June 13, 2018</time>
</div>
</header>
<div class="page-main">
<p>All Naming Conventions Are <a href="https://www.ietf.org/rfc/rfc2119.txt">RFC 2119</a> and <a href="https://tools.ietf.org/html/rfc6919">RFC 6919</a> compliant.</p>
<p><h3> Triggers</h3>
<p>A trigger <strong><em>MUST</em></strong> always be named after what Triggers the workflow, and not the actions.
In all cases possible, the number of triggers per object <strong><em>SHOULD</em></strong> be limited - reading the existing trigger names allows using existing ones when possible.
Knowing that all automations count towards Salesforce alloted CPU time per record, a consultant <strong><em>SHOULD</em></strong> consider how to limit the number of workflows in all cases.</p>
<ol>
<li>All Worfklow Triggers MUST contain a Bypass Rule check.</li>
<ul><li> - If more Granularity is needed, a consultant <b>MAY</b> want to create a <code>Hierarchical Custom Setting</code> to implement the bypass.</li>
<li>- This bypass can be added to the more common User-based bypass, but <b>SHOULD NOT</b> supplant it.</li></ul>
<li>A Workflow Trigger <b>SHALL</b> always start by <code>WF</code>, followed by a number corresponding to the number of workflows on the triggering Object, followed by an underscore.</li>
</ol>
<ol>
<li>The WorkFlow Trigger name <strong>MUST</strong> try to explain in a concise manner what triggers the WF.
Note that conciseness trumps clarity for this field.</li>
<li>All Workflows Trigger MUST have a description detailing how they are triggered.</li>
<li>Wherever possible, a Consultant <strong><em>SHOULD</em></strong> use operators over functions.</li>
</ol>
<h4>Examples</h4>
<table>
<th>Object</th><th>WF Name</th><th>Description</th><th>WF Rule</th>
<tr><td>Invoice</td><td>WF01_WhenInvoicePaid</td><td>This WF triggers when the invoice Status is set to "Paid". Triggered from another automation.</td><td><code>!$User.BypassWF__c && ISPICKVAL(Status__c, "Paid")</code></td></tr>
<tr><td>Invoice</td><td>WF02_CE_WhenStatusChanges</td><td>This WF triggers every time the Status of the invoice is changed.</td><td><code>!$User.BypassWF__c && ISCHANGED(Status__c)</code></td></tr>
<tr><td>Contact</td><td>WF01_C_IfStreetBlank</td><td>This WF triggers on creation if the street is Blank</td><td><code>!$User.BypassWF__c && ISBLANK(MailingStreet)</code></td></tr>
</table>
<br/><br/><br/>
<p><h3> Field Updates</h3>
<ol>
<li>A Workflow Field Update <strong><em>MUST</em></strong> Start with <code>FU</code>, followed by a number corresponding to the number of field updates on the triggering Object.</li>
<li>A Workflow Field Update <strong><em>SHOULD</em></strong> contain the Object name, or an abbreviation thereof, in the Field Update Name. <em>\\\\\\\\</em>2*</li>
<li>A Workflow Field Update <strong><em>MUST</em></strong> be named after the field that it updates, and then the values it sets, in the most concise manner possible.</li>
<li>The Description of a Workflow Field Update<strong><em>SHOULD</em></strong> give precise information on what the field is set to.</li>
</ol>
<h4 id="examples-1">Examples</h4>
<table>
<th>Object</th><th>FU Name</th><th>Description</th>
<tr><td>Contact</td><td>FU01_SetEmailOptOut</td><td>Sets the Email Opt Out checkbox to TRUE.</td></tr>
<tr><td>Invoice</td><td>FU02_SetFinalBillingStreet</td><td>Calculates the billing street based on if the client is billed alone, via an Agency, or via a mother company. Part of three updates that handle this adress.</td></tr>
<tr><td>Contact</td><td>FU03_CalculateFinalAmount</td><td>Uses current Tax settings and information to set the final amount</td></tr>
</table>
<p><h3> Email Alerts</h3>
<ol>
<li><p>A Workflow Email Alert <strong><em>MUST</em></strong> Start with <code>EA</code>, followed by a number corresponding to the number of email alerts on the triggering Object.</p></li>
<li><p>A Workflow Email Alert <strong><em>SHOULD</em></strong> contain the Object name, or an abbreviation thereof, in the Field Update Name. <em>\\\\\\\\</em>2*</p></li>
<li><p>A Workflow Email Alert's Unique Name and Description <strong><em>SHOULD</em></strong> contain the exact same information, except where a longer description is absolutely necessary. <em>\\\\\\\\</em>3*</p></li>
<li><p>A Workflow Email Alert <strong><em>SHOULD</em></strong> be named after the type of email it sends, or the reason the email is sent.</p>
<p>Note that declaratively, the Name of the template used to send the email is always shown by default in Email Alert lists.</p></li>
</ol>
<h4 id="examples-2">Examples</h4>
<table>
<th>Object</th><th>EA Name</th><th>Description</th>
<tr><td>Invoice</td><td>EA01_Inv_SendFirstPaymentReminder</td><td>EA01_Inv_SendFirstPaymentReminder.</td></tr>
<tr><td>Invoice</td><td>EA02_Inv_SendSecondPaymentReminder</td><td>SendSecondPaymentReminder</td></tr>
<tr><td>Contact</td><td>EA03_Con_SendBirthdayEmail</td><td>EA03_Con_SendBirthdayEmail</td></tr>
</table>
<p><h3> Workflow Tasks</h3>
<ol>
<li><p>A Workflow Task Unique Name <strong><em>MUST</em></strong> Start with <code>TSK</code>, followed by a number corresponding to the number of tasks on the triggering Object.</p></li>
<li><p>A Workflow Task Unique Name <strong><em>COULD</em></strong> contain the Object name, or an abbreviation thereof, in the Field Update Name. This is to avoid different conventions for Workflow Actions in general.</p>
<p>Most information about tasks are displayed by default declaratively, and creating a task should rarely impact internal processes or external processes in such a manner that urgent debugging is required.
As Users will in all cases never see the Unique Name of a Workflow Task, it is not needed nor recommended to norm them more than necessary.</p>
</li>
</ol>
<h3>Outbound Messages</h3>
<ol>
<li><p>An Outbound Message Name <strong><em>MUST</em></strong> Start with <code>OM</code>, followed by a number corresponding to the number of outbound mesages on the triggering Object.</p></li>
<li><p>An Outbound Message Name <strong><em>COULD</em></strong> contain the Object name, or an abbreviation thereof, in the Field Update Name. This is to avoid different conventions for Workflow Actions in general.</p></li>
<li><p>An Outbound Message <strong><em>MUST</em></strong> be named after the Service that it send information to, and then information it sends in the most concise manner possible.</p></li>
<li><p>The Description of An Outbound Message <strong><em>SHOULD</em></strong> give precise information on why the Outbound Message is created.</p></li>
<li><p>Listing the fields sent by the Outbound Message is <strong><em>NOT RECOMMENDED</em></strong>.</p></li>
</ol>
<h4 id="examples-3">Examples</h4>
<table>
<th>Object</th><th>EA Name</th><th>Description</th>
<tr><td>Invoice</td><td>OM01_Inv_SendBasicInfo</td><td>Send the invoice header to the client software.</td></tr>
<tr><td>Invoice</td><td>OM02_Inv_SendStatusPaid</td><td>Sends a flag that the invoice was paid to the client software.</td></tr>
<tr><td>Contact</td><td>OM01_SendContactInfo</td><td>Sends most contact information to the internal Directory.</td></tr>
</table>
<p>*1 This is also the default Salesforce setting.*
*2 While Field Updates are segregated by Object when viewed through an IDE or through code, the UI offers no such ease of use. If this is not done, a consultant <strong><em>WOULD PROBABLY</em></strong> create list views for field updates per Object.*
*3 Email Alert's Unique Names are generated from the Description by default in Salesforce. As Email Alerts can only send emails, this convention describes a less exhaustive solution than could be, at the profit of speed while creating Email Alerts declaratively.*</p>
</div>
</article>
</div>
</div><!-- /#content -->
</div><!-- /#wrap -->
<!-- FOOTER -->
<footer>
<div class="main-footer">
</div>
<!-- Sub footer -->
<div class="sub-footer">
<div class="container">
<div id="social-icons">
<ul>
<li class="social-icon discord">
<a class="fade-img" href="http://discord.gg" target="_blank" rel="tooltip" title="Discord">
<img src="assets/img/social/icons_discord.png" alt="Discord" />
</a>
</li>
<li class="social-icon salesforce">
<a class="fade-img" href="http://www.salesforce.com" target="_blank" rel="tooltip" title="Salesforce">
<img src="assets/img/social/icons_salesforce.png" alt="Salesforce" />
</a>
</li>
</ul>
</div>
<div class="copyright-text">Copyright 2018. Powered by <a href='http://github.io/'>GitHub</a>
</div>
</div>
</div>
</footer>
<!-- Javascript
================================================== -->
<!-- Placed at the end of the document so the pages load faster -->
<script src="assets/js/jquery.js"></script>
<script src="assets/js/bootstrap-transition.js"></script>
<script src="assets/js/bootstrap-alert.js"></script>
<script src="assets/js/bootstrap-modal.js"></script>
<script src="assets/js/bootstrap-dropdown.js"></script>
<script src="assets/js/bootstrap-tab.js"></script>
<script src="assets/js/bootstrap-tooltip.js"></script>
<script src="assets/js/bootstrap-popover.js"></script>
<script src="assets/js/bootstrap-button.js"></script>
<script src="assets/js/bootstrap-collapse.js"></script>
<script src="assets/js/bootstrap-carousel.js"></script>
<script type="text/javascript" src="assets/js/jquery.autocomplete.js"></script>
<script type="text/javascript" src="assets/js/jquery.fitvids.js"></script>
<script type="text/javascript" src="assets/js/application.js"></script>
<script src="assets/js/holder/holder.js"></script>
</body>
</html>