forked from LHeffner/Practice-Repo
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathContentSteward.html
More file actions
407 lines (297 loc) · 24.2 KB
/
ContentSteward.html
File metadata and controls
407 lines (297 loc) · 24.2 KB
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
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
<!DOCTYPE html>
<html>
<head>
<title>ContentStewardDefined</title>
</head>
<body>
<h1 pbzloc="562">Content Steward Guide</h1>
<p>Content stewards are the gatekeepers. They oversee all listings in Marketplace. Before listings are available for users to find and use, an organizational content steward and a Marketplace content steward must approve them.</p>
<h2>Define Content Steward Roles</h2>
<p><b>Marketplace content steward</b> – People with this role have two main functions. They must approve every listing in Marketplace and administer the system and enable or disable them. Administering the system includes making new Categories, etc., and sending notifications.</p>
<p><b>Organizational content steward</b> – Every organization has at least one organizational content steward or “org steward.” The org steward must approve listings before sending them to a Marketplace steward for final approval. Org stewards can approve listings or send them back to their owners for updates. Also, they can edit or delete reviews.</p>
<h2>Define Marketplace Manager</h2>
<p>The Marketplace Content Steward has two roles:</p>
<ol>
<li><b pbzloc="538">Oversee <i>all</i> listings in Marketplace see FUTURE LINK</b>
<ol>
<li>Approve or reject listings</li>
<li>Enable or disable listings</li>
<li>Select which listings will be featured on the Search an Discovery Page using the <a href="#featureFlag">Feature Flag</a>.</li>
</ol>
</li>
<li><b>Configure and administer Marketplace</b> see <a href="#MarketplaceSettings">Marketplace Settings</a>.
<ol>
<li>Add, edit and delete Marketplace Settings including Categories, Contact Types, Intents, Organizations and Stewards</li>
<li>Send system-wide Notifications</li>
</ol>
</li>
</ol>
<h1><a id="Steward_listingManagementPage" name="Steward_listingManagementPage">Steward View</a>: Listing Management Page</h1>
<p>Org stewards can see every listing in their organization from their Listing Management page. To access this page, click the drop-down Main Menu on the right side of the Global Toolbar and select Listing Management:</p>
<p><img alt="Link to Listing Management Page from Global Toolbar" src="../ozp-help/Doc_images/ListingManagementLink.png" style="height: 320px; width: 200px" title="Listing Management Page" /></p>
<p> </p>
<p>As a Marketplace or Content Steward, the Listing Management page displays information about listings you own and listings you oversee. For user instructions about the Listing Management page see the <a href="Marketplace.html##User_listingManagementPage">User View</a>: Listing Management Page. Also, Marketplace stewards can access system settings from the listings' drop-down menus on this page.</p>
<p><img alt="Listing Management Page" src="../ozp-help/Doc_images/ListingManagementPage.png" style="height: 236px; width: 624px" title="Listing Management Page" /></p>
<p>The Listing Management page displays different information for different users. The following sections explain each field as it relates to a steward. For the user view see <a href="Marketplace.html##User_listingManagementPage">User View</a>: Listing Management Page.</p>
<h2>Steward View: Listing Management Page</h2>
<p>As a <b>steward</b>, you see multiple tabs on the Listing Management screen. The My Listings tab displays listings you own. The organizational tab(s) display listings that you oversee for a specific organization. All the organization’s listings appear there. If you are the Marketplace Steward, all listings in the system appear under the Marketplace tab. The Recent Activity tab displays changes to all listings you oversee. The left-side State panel provides slightly different information than a user’s left-side panel:</p>
<ul>
<li><b>All</b> – Listings you oversee as a steward</li>
<li><b>Published</b> – Listings that are approved by Marketplace and organizational stewards within your organization (this number includes listings that are Disabled)</li>
<li><b>Needs action</b> –Listing waiting for your approval. For instructions regarding approving or returning listings see FUTURE LINK: Manage Listings.</li>
<li><b>(Pending) Org approved</b> – Listings waiting for Marketplace steward approval</li>
<li><b>Returned</b> – Listings returned to their owners</li>
<li><b>Draft</b> – Listings that you have not yet submitted for approval</li>
</ul>
<p>Marketplace Stewards also see an <b>Organization</b> filter on the left-side panel.</p>
<p>All stewards see the <b>Enabled</b> section which allows them to filter by Enabled and Disabled listings (For information about Enabled and Disabled listings see FUTURE LINK: Manage Listings)</p>
<p><b>Marketplace Settings</b> (only visible to Marketplace Stewards) is the home page for Marketplace management tools and all customizations administered within the user interface (as opposed to backend code). To learn more about Marketplace settings see FUTURE LINK: Marketplace Manager.<br />
<br />
<b>Metrics</b> can provide data about listing Web traffic and Marketplace. It is only visible to Marketplace stewards and must be configured by one of them.</p>
<h1>Manage Listings: <a id="ApproveRejectListings" name="ApproveRejectListings">Approval and Rejection Instructions</a></h1>
<p>Before users can find and bookmark listings from Marketplace, an org steward and Marketplace steward must approve the listings as described in the following sections:</p>
<h2>Org Steward: Listing Approval/Rejection Instructions</h2>
<p>After a user submits a listing, the org steward must approve it, and then a Marketplace steward must approve it.</p>
<p>To approve a listing as an org steward:</p>
<ol>
<li>Open the Needs action page. To do this, click the drop-down Main Menu and select Listing Management. Click Needs action from the State panel on the left:<br />
<br />
<img alt="Needs Action Link on the Listing Management Page" src="../ozp-help/Doc_images/NeedsAction_ListingManagementPage.png" style="height: 292px; width: 383px" title="Listing Management Page" /></li>
<li>Listings that need approval appear here. Click a listing to open its Detailed View.</li>
<li>After reviewing the listing, click the Administration tab.</li>
<li>On the left-side, click Approve or Return to Owner:<br />
<img alt="Approve or Return the Listing" src="../ozp-help/Doc_images/AdminTab_Approve_Reject.png" style="height: 305px; width: 620px" title="Listing Management Page" />
<ol style="list-style-type: lower-alpha">
<li>If you approve the listing, it moves into the Marketplace steward's queue and you're done. After the Marketplace steward approves the listing, the owner or Marketplace steward can enable or disable it.</li>
<li>If you click Return to Owner, type instructions explaining how the user should update the listing before submitting it. Then, click Return to Owner. The listing will move out of your queue until the owner resubmits it.</li>
</ol>
</li>
</ol>
<h2>Marketplace Steward: Listing Approval Instructions</h2>
<p>Marketplace Stewards must approve all listings in the store. All Marketplace listings appear on a tab on the Marketplace steward's Listing Management page:</p>
<p><img alt="Marketplace Listings Tab on Listing Management Page" src="../ozp-help/Doc_images/MarketplaceListingsTab.png" style="height: 154px; width: 624px" title="Marketplace Tab on Listing Management Page" /></p>
<p> After an org steward approves a listing, the Marketplace steward must:</p>
<ol>
<li>Open the Needs action page. To do this, click the drop-down Main Menu and select Listing Management. Click Needs action from the state panel on the left:<br />
<img alt="Needs Action Link on the Listing Management Page" src="../ozp-help/Doc_images/NeedsAction_ListingManagementPage.png" style="height: 292px; width: 383px" title="Needs Action Link on the Listing Management Page" /></li>
<li>Listings that need approval appear on the Needs action page. Click a listing to open its Detailed View.</li>
<li>After reviewing the listing, click the Administration tab.</li>
<li>On the left-side, click Approve or Return to Owner:
<ol style="list-style-type: lower-alpha">
<li pbzloc="563">If you approve the listing, the listing is automatically Enabled and it will appear in search results and be available for download.</li>
<li>If you click Return to Owner, type instructions explaining how the user should update the listing before resubmitting it. Then, click Return to Owner. The listing will move out of your queue until it is resubmitted and approved by an org steward.</li>
</ol>
</li>
<li>As a Marketplace steward, you have to make two more decisions:
<ol style="list-style-type: lower-alpha">
<li><a id="EnableDisable" name="EnableDisable"><b>Enabled</b></a> -- Makes the listing visible to all users, i.e., it appears on the Search and Discovery Page and is searchable.</li>
<li><b>Featured</b> -- Activating the Featured button adds the listing to the group of Featured Listings that scroll across the top of the Search and Discovery Page, see FUTURE LINK<img alt="Enabled and Featured Buttons on a Listing's Detailed Page" pbzloc="561" src="../ozp-help/Doc_images/AdminTab_EnableFeatured.png" style="height: 445px; width: 502px" title="Enabled and Feature Buttons on a Listing's Detailed View" /></li>
</ol>
</li>
</ol>
<h1 pbzloc="543">Feature a Listing</h1>
<p>Marketplace stewards control the Featured Listings on the Search and Discovery Page. To add a listing to the group of Featured Listings:</p>
<ol>
<li>Open a listing's Detailed View by clicking the listing icon.</li>
<li>Click the Administration tab.</li>
<li>Click the Featured control to active it:<br />
<img alt="Enabled and Featured Buttons on a Listing's Detailed Page" src="../ozp-help/Doc_images/AdminTab_EnableFeatured.png" style="height: 445px; width: 502px" title="Enabled and Feature Buttons on a Listing's Detailed View" /><a id="featureFlag" name="featureFlag"></a></li>
<li>When the Featured control is activated, the listing appears in the Featured section of the Search and Discovery Page:<br />
<img alt="Featured Listing on the Search and Discovery Page" src="../ozp-help/Doc_images/FeaturedListing_SearchDiscoverPage.png" style="height: 175px; width: 312px" title="Featured Listing on Search and Discovery Page" /></li>
</ol>
<p> </p>
<h1><a id="MarketplaceSettings" name="MarketplaceSettings"> Marketplace Settings</a></h1>
<p>The Marketplace steward manages configurable aspects of the store. He or she adds, modifies and deletes new fields on the Listing Create/Edit Form; monitors organizational stewards and sends system-wide notifications. This section explains how to add, edit and delete fields on the <a href="Marketplace.html#form">Listing Create/Edit Form</a>.</p>
<p>To access the Marketplace Settings window:</p>
<p> </p>
<p><br />
<ol>
<li>Click <img alt="Main Menu" src="../mocks/Doc_images/Main_menu_icon.png" style="border-top: 1px solid; height: 30px; border-right: 1px solid; width: 30px; border-bottom: 1px solid; border-left: 2px solid" /> on the right-side of the Global Toolbar.</li>
<li>Select Marketplace Settings<br />
<img alt="Marketplace Settings Link on Main Menu" src="../ozp-help/Doc_images/MarketplaceSettingsLink_MainMenu.png" style="height: 318px; width: 176px" title="Marketplace Settings Link on Main Menu" /></li>
<li>The Marketplace Settings page will open to the Categories tab:<br />
<img alt="Marketplace Settings Page" src="../ozp-help/Doc_images/MarketplaceSettings.png" style="height: 266px; width: 624px" title="Marketplace Settings Page" /></li>
</ol>
</p>
<p> </p>
<h2>Marketplace Settings: <a id="AddEditDelete" name="AddEditDelete">Add/Edit/Delete</a></h2>
<p>Marketplace Stewards can add, edit or delete the following fields on the Listing Create/Edit Form. Categories, Contact Types, Intents and Organizations. Also, they can assign Stewards and send/update/delete Notifications. Each function will be explain in the following sections.</p>
<h3><a id="Categories" name="Categories">Categories</a></h3>
<p>Categories can group listings by similar characteristics. They help people narrow their search results on the Search and Discovery Page:</p>
<p><img alt="Categories on the Search and Discovery Page" src="../ozp-help/Doc_images/categories_SearchDiscoverPage.png" style="height: 321px; width: 398px" title="Categories on the Search and Discovery Page" /></p>
<p>To <b>create</b> a category:</p>
<ol>
<li>Click the Add New button at the top of the Categories table:<br />
<img alt="Add new category" src="../ozp-help/Doc_images/AddNewCategory.png" style="height: 146px; width: 372px" title="Add new category" /></li>
<li>The Create Category window opens. Give the category a Title and Description, and then click Save.</li>
<li>The category will appear on the list of categories on the Marketplace Settings page and on the Search and Discovery Page.</li>
</ol>
<p>To <b>edit</b> a category:</p>
<ol>
<li> From the Categories tab on the Marketplace Seetings page, click the category thta you want to edit.</li>
<li>The Edit button will become active, click it.</li>
<li>The Edit Category window will open, make your change and click Save.</li>
<li>The change will appear on the list of categories on the Marketplace Settings page and on the Search and Discovery Page.</li>
</ol>
<p>To <b>delete</b> a category:</p>
<ol>
<li>From the Categories tab on the Marketplace Settings page, click the category that you want to delete.</li>
<li>The Delete button will become active, click it.</li>
<li>A confirmation window appears, click Delete:<br />
<img alt="Category Delete Warning" src="../ozp-help/Doc_images/categoryDeleteWarning.png" style="height: 177px; width: 436px" title="Category Delete Warning" /></li>
<li>The category will be removed from the list of categories on the Marketplace Settings page and on the Search and Discovery Page.<br />
<i>However, if the category is associated with a listing, it cannot be deleted. To delete the category you have to remove its association with all listings. Edit each listing using the Create/Edit Form. </i></li>
</ol>
<h3><a id="contactTypes" name="contactTypes"> Contact Types</a></h3>
<p>Contact Types identify designated contact people. The information appears on the Resources tab of the listing’s Detailed View:</p>
<p><img alt="Contact Type Example" src="../ozp-help/Doc_images/ContactType.png" style="height: 222px; width: 479px" title="Contact Type Example" /></p>
<p>To <b>create</b> a Contact Type:</p>
<ol>
<li>Click the Contact Types tab on the Marketplace Settings page.</li>
<li>Click Add New at the top of the table:<br />
<img alt="Add new contact type" src="../ozp-help/Doc_images/AddNewContactType.png" style="height: 148px; width: 319px" title="Add new contact type" /></li>
<li>The Create Contact Type window opens. Give the contact type a Title and check Required if the field is required for listing submission.</li>
<li>Click Save.
<ul>
<li>The contact type will appear on the list of contact types on the Marketplace Settings page.</li>
<li>It will be a drop-down choice on the Contacts section of the Listing Create/Edit Form.</li>
<li>If the contact type is required, it must be populated when anyone edits an existing listing.</li>
</ul>
</li>
</ol>
<p> To <b>edit </b>a contact type:</p>
<ol>
<li>From the Contact Types tab on the Marketplace Settings page, click the contact type that you want to edit.</li>
<li>The Edit button will become active, click it.</li>
<li>The Edit Contact Type window will open, make your change and click Save.</li>
<li>The change will appear on the list of contact types on the Marketplace Settings page and on the Listing Create/Edit Form.</li>
</ol>
<p> To <b>delete </b>a contact type:</p>
<ol>
<li>From the Contact Types tab on the Marketplace Settings page, click the contact type that you want to delete.</li>
<li>The Delete button will become active, click it.</li>
<li>A confirmation window appears, click Delete.</li>
<li>The contact type will be removed from the list of contact types on the Marketplace Settings page and on the Listing Create/Edit Form.</li>
</ol>
<h3><a id="Intents" name="Intents">Intents</a></h3>
<p>Intents are the instructions for carrying out a listing’s intentions. Intents comprise an Action (graph, view, edit, etc.), a Data Type (HTML, text, image, etc.) and a Send/Receive request. You can associate this action or data type with an icon. However, this information is only metadata used as a placeholder. <mark>For any intent to function, a developer has to code the actual function into the listing.</mark></p>
<p>From the Intents tab on the Marketplace Settings page, you can create an intent placeholder that will appear on the Listing Create/Edit Form.</p>
<p>To <b>create </b>an Intent placeholder:</p>
<ol>
<li>Click the Intent tab on the Marketplace Settings page.</li>
<li>Click Add New at the top of the table.</li>
<li>The Create Intent window opens. Populate the following fields:
<ol style="list-style-type: lower-alpha">
<li><b>Label</b> – Explain what the intent does. This label will appear in the drop-down list when a user chooses an intent on the Listing Create/Edit Form.</li>
<li><b>Action</b> – Describe the intent in 64 characters.</li>
<li><b>Type</b> – Describe the intent in 64 characters.<br />
Ex: application/json, application/custom-type, etc.</li>
<li><b>Icon </b>– Attach an image that will appear when anyone uses the intent. Think of this like the icon that appears on a smart phone when you decide to open an address and the system prompts you to open that address in a browser or a mapping app.</li>
</ol>
</li>
<li>Click Save.
<ol style="list-style-type: lower-alpha">
<li>The intent will appear on the list of intents on the Marketplace Settings page.</li>
<li>It will be a drop-down choice in the Intents section of the Listing Create/Edit Form.</li>
</ol>
</li>
</ol>
<p> To <b>edit </b>an intent Label or Icon:</p>
<ol>
<li>From the Intents tab on the Marketplace Settings page, click the intent that you want to edit.</li>
<li>The Edit button will become active, click it.</li>
<li>The Edit Intent window will open, make your change and click Save.<br />
<i>Note: You cannot edit the intent Action and Type after it is created. </i></li>
</ol>
<p>The change will appear on the list of Intents on the Marketplace Settings page and on the Listing Create/Edit Form.</p>
<p> To <b>delete </b>an Intent:</p>
<ol>
<li>From the Intents tab on the Marketplace Settings page, click the Intent that you want to delete.</li>
<li>The Delete button will become active, click it.</li>
<li>A confirmation window appears, click Delete.</li>
</ol>
<p>The intent will be removed from the list of intents on the Marketplace Settings page and on the Listing Create/Edit Form.</p>
<h3><a id="Orgs" name="Orgs">Organizations</a></h3>
<p>Marketplace can filter listings by organizations.</p>
<p>To <b>create</b> an organization:</p>
<ol>
<li>Click the Organizations tab on the Marketplace Settings page.</li>
<li>Click Add New at the top of the table.</li>
<li>The Create Organization window opens. Enter a Title and Acronym or Abbreviation that will appear on the listing’s Short View and Detailed View.</li>
<li>Click Save. After refreshing, the organization will appear as an option in the Stewards drop-down. See the next section “Stewards” to learn how to associate a steward with the new organization.</li>
</ol>
<p>To <b>edit </b>an organization:</p>
<ol>
<li>From the organization tab on the Marketplace Settings page, click the organization that you want to edit.</li>
<li>The Edit button will become active, click it.</li>
<li>The Edit Organization window will open, make your change and click Save.</li>
<li>The change will appear on the list of Organizations on the Marketplace Settings page.</li>
</ol>
<p>To <b>delete </b>an organization:</p>
<ol>
<li>From the organizations tab on the Marketplace Settings page, click the organization that you want to delete.</li>
<li>The Delete button will become active at the top of the table, click it.</li>
<li>A confirmation window appears, click Delete.</li>
</ol>
<p>The organization will be removed from the list of organizations on the Marketplace Settings page and on the Listing Create/Edit Form.</p>
<p><i>Note: An organization <b>cannot</b> be removed if it is associated with a listing. </i></p>
<h3><a id="Stewards" name="Stewards">Stewards</a></h3>
<p>Stewards oversee listings in Marketplace. They are the gatekeepers that approve, enable and moderate listings. There are two kinds of stewards: <b>Org Stewards</b> who oversee specific organizations and <b>Marketplace Stewards</b> who oversee all listings and specific settings in the store. At log-in, your system will determine your role as a user, org steward or Marketplace steward. When someone signs in as a steward, their name is added to the list of Stewards in the Marketplace Settings page:</p>
<p><img alt="Add new steward" src="../ozp-help/Doc_images/AddNewSteward.png" style="height: 214px; width: 624px" title="Add new steward" /></p>
<p>Marketplace stewards cannot add or delete stewards listed on the Stewards tab. However, they can edit the organizations assigned to each steward.</p>
<p>To <b>edit </b>a steward’s assigned organization(s):</p>
<ol>
<li>From the Stewards tab on the Marketplace Settings page, click the Display Name that you want to edit.</li>
<li>The Edit button in the table header will become active, click it.</li>
<li>The Edit Steward window will open:
<ol style="list-style-type: lower-alpha">
<li>To remove an organization, click Remove beside the Stewarded organizations drop-down field.</li>
<li>To add an organization, click Add and select the new organization from the drop-down list.</li>
</ol>
</li>
<li>Click Save, the change will appear on the list of Stewards on the Marketplace Settings page.</li>
</ol>
<h2><a id="Notifications" name="Notifications">Notifications</a></h2>
<p>Only Marketplace Stewards can alert all system users via the Notifications feature.</p>
<p> This section explains how to send and delete notifications:</p>
<ol>
<li>From the Marketplace Settings page, click the Notifications tab.</li>
<li>Schedule and write the notification:
<ol style="list-style-type: lower-alpha">
<li>In the Expires At field, enter the date when you want the Notification message to disappear from users’ drop-down notifications list on their Global Toolbars.<br />
<b>By default, you enter the Expires At time in Zulu Time.</b> It appears as the local time zone time on each person's Notification's tab.</li>
<li>Write the notification:<br />
<img alt="Create Notifications window" src="../ozp-help/Doc_images/CreateNotification.png" style="height: 309px; width: 335px" title="Create notification window" /></li>
</ol>
</li>
<li>Click Send, the Notification will appear two places in the system:<br />
<img alt="Notifications example" src="../ozp-help/Doc_images/Notification_example.png" style="height: 230px; width: 530px" title="Notification example" />
<ol style="list-style-type: lower-alpha">
<li>The list of Active Notifications on the right-side of the screen (all Marketplace Stewards will see it there).</li>
<li>Under the Notifications icon on the Global Toolbar (all users will see it there). Users can click the X in the upper-right corner of the notification to dismiss the notification or wait for the notification to expire, at which point it will be removed from their list.</li>
</ol>
</li>
</ol>
<h3><a id="CancelNotification" name="CancelNotification">Cancel a Notification</a></h3>
<p>Any Marketplace Steward can cancel a notification:</p>
<ol>
<li>From the Notifications tab on the Marketplace Settings window, click the remove icon beside the Active Notification:<br />
<img alt="Dismiss notification" src="../ozp-help/Doc_images/DismissNotification.png" style="height: 259px; width: 579px" title="Dismiss notification" /></li>
<li>The notification will be removed without a confirmation message. It will be removed from users’ Global Toolbars when they refresh their page.</li>
</ol>
<p> </p>
<p> </p>
<p> </p>
<p> </p>
<p> </p>
<p> </p>
<p> </p>
<p> </p>
<p> </p>
<p> </p>
<p> </p>
<p> </p>
<p> </p>
<p> </p>
</body>
</html>