Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
EITHER Go to the AP domain name web address. The default AP page is the Dashboard My Tasks view.
OR Go to the AP home page web address. This opens the Dashboard My Tasks view.
OR (from anywhere in the application)
Open the page header drop down menu and press My Tasks in the overlaid menu options list.
OR (from any Dashboard view)
Press My Tasks in the Dashboard view left sidebar menu.
The Dashboard My Tasks view is presented.
EITHER In the My Tasks view, press the name link on the task you want to open. This opens the Task View to the context of the default Task Editing layout.
The Task View is presented with the default Task Editing layout, showing 4 key content regions below the site header:
Edit panel, showing concepts loaded or created within the task (initially empty for a new task).
Concept Model panel, showing a SNOMED CT schematic representation (in SNOMED CT Diagramming Guideline notation) of concepts in the Edit panel (initially empty for a new task).
Activities (Left Sidebar) panel, containing tabs for:
From the Dashboard - My Tasks view:
EITHER
Press New Task in the left-hand menu bar.
OR
Press the blue circular + button in the upper right corner of the Dashboard - My Tasks content panel.
The Create New Task pop-up form is presented, centred on the page and overlaying the Dashboard - My Tasks view which is dimmed but still visible "below" the form.
This form has three content entry fields, and three calls to action at the bottom of the form:
Task title field (required).
Select project drop-down list selector (required).
Taxonomy
Search
Saved List
Feedback
Create Batch
Task Details
Options menu panel, containing buttons for:
Create new concept
Create new concept from template
Task Classification
Task Validation
Task Rebase
Show Task Editing layout
Hide the Left Sidebar
Hide all concept models
On opening the task, any concepts previously loaded into the editor will be reloaded to restore the editing context from your most recent task editing session (the task state is automatically saved and restored by the application). After completing loading, a blue header notification will state "All concepts loaded" for a brief interval (or until you press the X in the upper right corner of the notification box).
OR In the My Tasks view, press the classification status icon (if present), on the task you want to open. This opens the Task View to the context of the current Classification report.
Whilst loading, the main content panel is cleared, and a blue header notification stating "Loading task details..." is presented. When completed, the header notification changes to "Task details loaded".
The Task Classification layout is presented, showing the latest Classification report. This is a full-width layout, maintaining the Options panel menu for navigation back to other task contexts.
OR In the My Tasks view, press the validation status icon (if present), on the task you want to open. This opens the Task View to the context of the current Validation report.
Whilst loading, the main content panel is cleared, and a blue header notification stating "Loading task details..." is presented. When completed, the header notification changes to "Task details loaded".
The Task Validation layout is presented, showing the latest Validation Report. This is a full-width layout, maintaining the Options panel menu for navigation back to other task contexts.
OR In the My Tasks view, press the feedback status icon (if present), on the task you want to open. This opens the Task View to the context of the Review and Feedback activity tab.
Whilst loading, the main content panel is cleared, and a blue header notification stating "Loading task details..." is presented. When completed, the header notification changes to "Task details loaded". ,p>
The Task Review and Feedback layout is presented, showing concepts to review, concepts approved, and inferred concept changes within the task. This layout maintains the Activities panel (Left Sidebar), as well as the Options panel menu for navigation back to other task contexts.
Task Details optional multi-line rich text field, with a sub-menu for formatting selected contents as bold font, italic font, button list, and numbered sequential list.
Create Task button.
Create and Open Task button.
Cancel button.
The pop-up form also has a small X button in its top right corner. This has the same effect as the Cancel button.
Enter a single line Task title for identification of this task in the Authoring Platform.
Press Select project to see an overlaid list of all available projects on the Authoring Platform. Pick one from the list by moving the cursor to its title and pressing it, or using the keyboard up-arrow / down-arrow buttons to scroll the list and then press Enter on the desired selection.
Enter some further descriptive text in Task Details and use the text formatting options menu to enhance readability if desired (select some text within the field, then press the desired option button in the menu). This field is optional and can be left blank but some additional background information on the task can often be useful, particularly if many tasks end up with similar titles.
When the form fields are ready:
EITHER
Press Create Task
OR
Press Create and Open Task
A full-width "Creating task..." notification banner appears above the call to action buttons (which are greyed out) whilst the task is being set-up - this typically takes a few seconds.
On completion, a "Task initialization complete" notification banner is presented in the page header.
If Create Task was used, then the pop-up form will close and the original underlying Dashboard My Tasks view will be restored. The new task title will appear in the task list.If Create and Open Task was used, then the pop-up form will close and the task will be opened as if its listing entry link had been followed from the Dashboard - My Tasks view, allowing authoring to start immediately within the task.
EITHER (from anywhere in the application)
Open the page header drop down menu and press My Projects in the overlaid menu options list.
OR (from any Dashboard view)
Press My Projects in the Dashboard view left sidebar menu.
X
OR In the Review Tasks view, press the feedback status icon (if present), on the task you want to open. This opens the Task View to the context of the Feedback activity tab. This option is only available once at least one review comment has been added by either a reviewer or author.
Whilst loading, the main content panel is cleared, and a blue header notification stating "Loading task details..." is presented. When completed, the header notification changes to "Task details loaded".
The Task Review and Feedback layout is presented, showing concepts to review, concepts approved, and inferred concept changes within the task. This layout maintains the Activities panel (Left Sidebar), as well as the Options panel menu for navigation back to other task contexts.
EITHER In the Review Tasks view, press the name link on the task you want to open. This opens the Task View to the context of the Feedback activity tab.
If task status is Ready for Review and the review status is Available (not yet claimed) this action will claim it for review and assign you to it as a Reviewer. The task will change state to In Review and its review state will become Claimed.
If task status is In Review and review is Claimed this will re-open the task for review and show any changes made to concepts in the task.
Whilst loading, the main content panel is cleared, and a blue header notification stating "Loading task details..." is presented. When completed, the header notification changes to "Task details loaded".
The Task View Review and Feedback layout is presented, showing concepts to review, concepts approved, and inferred concept changes within the task. This layout maintains the Activities panel (Left Sidebar), as well as the Options panel menu for navigation back to other task contexts.
Claimed for review tasks are only visible in the Review Tasks view to the people named in the Reviewers list. It's possible to add/remove names from the Reviewers list whilst a review is in progress, to support nominating other people deputizing as reviewers, or switching to a replacement reviewer. This means it's also possible that the original claimant will no longer see the task in the Review Tasks list if they have been subsequently removed from the Reviewers list.
An Author can add people to the Reviewers list after submitting for review, which will have the same effect for each Reviewer as if they had claimed the task for review from the Available state. This allows an author to nominate a particular reviewer (or selected set of reviewers) when submitting for review.
EITHER (from anywhere in the application)
Open the page header drop down menu and press All Projects in the overlaid menu options list.
OR (from any Dashboard view)
Press All Projects in the Dashboard view left sidebar menu.
The Dashboard All Projects view is presented.
The Dashboard My Projects view is presented.
EITHER (from anywhere in the application)
Open the page header drop down menu and press Review Tasks in the overlaid menu options list.
OR (from any Dashboard view)
Press Review Tasks in the Dashboard view left sidebar menu.
The Dashboard Review Tasks view is presented.
Press Search Tasks in any Dashboard view left sidebar menu.
The Search Tasks pop-up dialogue is presented, containing a single text query field and a Search action button.
Enter text to match the labels of your tasks, then press Search. You can also search for exact matches to a task ID - but see the note below.
A blue Searching... prompt box is presented below the search query whilst the server finds matches to the entered text query.
On completion of the search, the panel below the search query is populated with the tasks with names (titles) either partially or fully matching the entered text query (or a single exact match to a task ID).
Each matching task result row includes a blue Open in new Tab icon button, and the task name which is an active link.
Additional information for each task is presented in the same format and styling as the My Tasks view listing.
EITHER
Press the Open in new Tab icon button to open the task in a new web browser tab (or window, if set by your personal web browser preferences). This allows the task to be viewed whilst retaining the Task Search dialogue results for further use (to review other task matches, or to modify the query for new search results).
OR Follow the task name link to open the task in the same web browser tab. This closes the Task Search dialogue and takes you into the task Edit panel view as if the task had been opened from the My Tasks view listing.
The task Edit panel view is presented (either in a new tab/window, or replacing the search dialogue in the current tab according to which option is used).</p
Authoring projects are managed and configured in the Authoring Platform (AP) underlying workflow instance (Jira), using particular field configurations, issue types, workflows and permissions schemes.
The process is outlined here to show the underlying platform dependencies and steps to prepare a project for SNOMED CT content authoring, but managing them for the International Authoring Platform is currently a SNOMED International Technical Team support activity.
Please note this is not a detailed definition of the support activity steps or Jira setup requirements - those are available in other Technical Team process documentation.
An authoring project is defined by a "project" type ticket in the AP workflow Jira instance which must exist for that project to be seen in the AP projects list (it's not sufficient just to create a Jira project). The instance of Jira used is an AP deployment configuration setting.
Once defined there is an association between the project tickets in Jira and their corresponding project content branches in the AP terminology server (Snowstorm for AP 6), which are named to match their associated Jira project key.
Similarly, authoring tasks have an associated branch under their parent project branch which is named to match their task ticket Jira ID.
These project keys and task IDs can be seen in the various page addresses when using the AP.
AP project visibility depends on a "product code" (Jira custom field) set in the project ticket. Particular AP deployments are configured to use a particular product code (or list of codes).
This allows a single Jira instance to support projects across multiple Authoring Platform deployments if needed.
You can use the Raise an Issue process outlined below to request creation of a new authoring project.
Enter the desired project details in the Raise an Issue form. The more information included the better, but the minimum needed is a new project name (this will be what appears in the AP projects listings) and a brief summary of its purpose.
Confirmation of which Authoring Platform, a preferred project key satisfying Jira key conventions, and in particular a reference to any similar existing projects, can significantly simplify and hence speed up the process, although these can also be inferred/defined by the Technical Team if not specified.
Press Raise an Issue to report issues or submit change requests related to AP usability and features.
The Raise an Issue pop-up form is presented. If the form height is larger than your available web browser display height, a vertical scroll bar will appear to allow you to scroll down and see all the form content (the form header title and footer actions remain visible whilst scrolling). The following fields are available:
Summary (required, single line text, maximum of 255 characters)
Description (multi-line text with markup formatting support for structured text)
Create test task in the new project and perform a search to initialize the project branch in the Terminology Server.
Technical Team support activity.
Notify the request originator (INFRA ticket reporter) that the new project is ready for use in the Authoring Platform.
Technical Team support activity
Priority (single choice option list selector)
Name (single line text, maximum of 255 characters)
Email (single line text, maximum of 255 characters)
Include data about your current environment, like the browser and page URL (opt-in checkbox)
The form footer has a Submit action button and a Close link.
Enter the desired details. The more information included the better, but also try to be as concise as possible and ideally keep to one identifiable issue per submission - this will simplify subsequent processing and hence make it quicker to assess, prioritise and investigate further if needed.
The minimum needed is a brief one-line Summary of the issue. Everything below that on the form is optional.
The Description field supports formatting options for structured text. Press the small question mark icon to open a Text Formatting Notation Help pop-up window with guidelines on including advanced formatting (wiki) markup.
You can use the Attach file (Choose Files) field to include a file attachment such as a screenshot.
An indication of the issue impact or urgency can be included using the Priority drop-down selector options. This will be taken into account when assessing the submitted issue but it will be treated as advisory and considered with additional contexts, including capacity and release scheduling - please elaborate any critical dependencies in the Description to help with follow-up prioritisation!
Including your Name and Email will help in identification, tracking and follow-up notifications/discussions.
The opt-in checkbox enables the form to capture details about your current web browser environment. You can press the What is included in the data about my current environment? link to preview those details and help decide whether or not to include them if unsure.
Including them can help the technical support teams when troubleshooting defect reports, particularly anything related to screen presentation/layout, but of course it's entirely optional.
Press Submit in the form footer to submit your entered feedback details. A Thank you for your feedback! message will appear for 5 seconds and then the pop-up form will automatically close, returning you to whatever AP context you were in when the Raise an Issue button was pressed.
For the International Authoring Platform this creates a Devops Support (INFRA) ticket, which the Technical Team will assess, prioritise and respond to with appropriate notifications and follow-up actions (your patience is appreciated!).
Alternatively, if you have decided not to raise an issue since opening the form, simply press Close in the form footer to immediately close the pop-up dialogue and return to your AP context.
Create a new project in the Jira workflow instance associated with the Authoring Platform, and associate the project schemes with those needed for content authoring.
Technical Team support activity.
Create a new "project" ticket type in the new project. Ensure that the "product code" matches that configured for the Authoring Platform deployment.
Technical Team support activity.
Verify the new project is available in the Authoring Platform (use the Create New Task form to view the available projects list).
Technical Team support activity.
