wiki:IIRS/WorkflowsProcesses
Last modified 3 years ago Last modified on 12/12/13 12:46:39

Workflows, Processes, Components & IA

  • See also ArchitectureOptions and the SolutionDesign.
  • Note, to avoid confusions around text and language, I've used the Drupal convention of t('text'), which means the English word 'text' translated into appropriate [language] for a user's [country]. e.g. t('Search') would be 'Rechercher' in French.

Workflows: TN.org (D6)

Note that 'Normal' initiative viewers and all regular visitors will see no changes.

'National Hub' page viewer (D6)

  1. Will see a 'National' page at http://www.transitionnetwork.org/world/[localised_country_name] (e.g. in native language like /france, /deutschland, /brasil, but not /germany, /brazil etc).
  2. Page will consist of standard D6/English TN.org site structure, menus and blocks, but content area will be the language appropriate for the country.
  3. The top part of the content area will consist of some translated welcome/info text. The lower part of the page will hold the "Full page widget" section of "Listings IIRS Widget (D7)", below.
  4. Details of the widget part of the page are below.

Workflows: Widgets (D7)

"Full page listings" widget

  1. URL TBC but similar to http://www.transitionnetwork.org/[langcode]/[localised_country_name]/widget/initiatives/display/full -- though this not be shown to the user usually except when getting the widget code.
  2. The widget will have the following display tabs:
    1. t('Latest') - shows users to see the latest [country] initiatives listed,.
    2. t('Map') - shows all the [country] initiatives on a map.
    3. t('Search') - allows searching of initiatives within [country] by criteria.
  3. An t('Add your initiative') button opening the Add widget popup -- for details of this, see next section.
  4. An t('Initiative details') page appears within the widget in the widget theme (ie with the tabs) whenever an initiative link is clicked within the widget area. This shows the full D7 node view in [language] for the initiative selected. This also allows users to log in and edit the ini if they have an account with the permissions.

"Button-only" widget

  1. Like sidebar but with only the t('Add your initiative') button which opens the "Add" widget display, below.

"Add" widget popup display (D7)

  1. User clicks button to t('Add your initiative'), popup opens showing URL TBC but similar to http://www.transitionnetwork.org/[langcode]/[localised_country_name]/widget/user/login
  2. User logs in or registers: NB: to be included at 11/12: registration includes social media option for authentication
  3. User enters initiative details. (URL TBC but similar to http://www.transitionnetwork.org/[langcode]/[localised_country_name]/widget/initiatives/add
  4. User gets thanks page. URL TBC but similar to http://www.transitionnetwork.org/[langcode]/[localised_country_name]/widget/initiatives/add/ok
  5. User also receives standard email with link to their TI submission with minimal text (needs to be translate-able by National Hub Administrator)

"View Detail" widget display (D7)

  1. Any link to an initiative within the Listings widgets shows the detail in [language] showing the full node view of the initiative. URL TBC but likely http://www.transitionnetwork.org/[langcode]/[localised_country_name]/widget/initiative/view/[nid]
  2. There will be an option to t('Log in to make changes if the user is the owner'), or register and submit their own initiative.
  3. If the user is logged in, the t('Edit') tab will be available to users who have permission (editors, admins and the content author).
  4. The page will be fully translated into [language].

Workflows: Administering the D7 site, widget and information management

For a National Hub Administrator there are four main parts to setting up and using the IIR Service

  1. Installing the National Hub installation which provides the service (online with URLs) and the widgetiser
  2. Translating the relevant content
  3. Configuring the widget using the widgetiser
  4. Administering the submissions via the widget and the standalone online service

1. Installing the National Hub installation using the Aegir system

  1. [Techie] builds Latest Transition National Hub distro/platform using the build-d7-hub-national-panopoly.make makefile OR the current one is used if already present on the target server.
  2. [Techie/Admin?] The site is installed using the Transition Network National Hub (Panopoly) profile for the chosen domain name. If using Aegir then the profile is simply chosen, otherwise a user will need to choose this when running the installer.
  3. [Administrator] Simple instructions are followed to enable the language of their choice, and give the site a name, set any other country-specific things.
  4. [Administrator] sets up a couple of key user accounts for other staff if necessary.

2. Translating the relevant content

ED QUESTION: is this where the NHA does the translation? He thinks so, so he's adding the translation pieces here -- JK YES -- process to follow:

  1. NHA needs to be able to
    1. know what they need to translate
    2. site options
    3. email confirmations
    4. about and thank you text
    5. other?
    6. have a simple process to translate these pieces
    • Ed is not sure what this is for now -- JK process to follow...

3. Configuring the widget using the Widgetizer

The National Hub administrator, and any editor added to the site, will be able to set up a widget and then add/edit/unpublish any Initiative item in their own country. They will be able to see the 'edit' function for all these initiatives as happens on TN.org now.

Useful details from PSE workflow?

  1. Go to Widgetizer build page (/widgetizer/build).
  2. Choose widget type.
  3. Add 'view pane path' (if widget type includes it) -- presently this is [language code]/tn-widgets/national/initiatives/[country code] -- e.g. pt-pttn-widgets/national/initiatives/pt
  4. Add modal popup path' -- presently this is [language code]/tn-widgets/national/user-submit-thanks/[country code]/[content type] -- e.g. pt-pt/tn-widgets/national/user-submit-thanks/pt/initiative
  5. Add modal button text -- e.g. t('Add your inititative')
  6. Preview widget.
  7. Copy widget code.
  8. Embed into full page of National Hub website -- ensure the correct text format/filter is set if using a content management system that filters input, should be equivalent to 'Full HTML' or 'Raw' etc.

4. Administering TI submissions

  1. User submits a TI via the widget. They may have set up a new account (will have for the alpha). The submission is POST-moderated - i.e. it goes into the system as PUBLISHED.
  2. Each TI submission triggers an email alert to the NHA including URL to user account and TI profile
  3. NHA can see the user account and TI profiles without logging into their service site -- JK question -- see TIs and user accounts without logging in? Why wouldn't thye log in? Why expose user accounts to public? Or is this going into the email sent to the admins? EM reply -- only view, not edit - links to the account and TI profile will be in email. TI profile will be public anyway. TI profile will include link to PPOC, which needs to be contactable?
  4. NHA can log into their service site - when logged in, the NHA can:
  5. See a list of all the TI submissions in a view showing TI name, URL, PPOC link, status ((not)published)
  6. Edit the TI node to make it
    1. UNPUBLISHED
    2. PUBLISHED
  7. Edit the user account node to make it
    1. ACTIVE
    2. BLOCKED
    3. DELETED

Information Architecture

User

Mandatory

Standard Drupal user account fields:

  1. t('Email') = (built into Drupal)
  2. t('Username') = (built into Drupal) --> will be generated from first/middle/last name fields (below) in format "First MM Last" (where M is a single middle name initial). Numbers will be appended if the resultant name is registered in site already.
  3. t('Password') = (built into Drupal)

Additional fields:

  1. t('First name') = field_user_name_first
  2. t('Middle names') = field_user_name_middle
  3. t('Last name') = field_user_name_last
  4. t('Language') = Provided by core Locale module... This will need to be set automatically by the widget context, and as a fall back should be displayed on the registration form)
  5. t('Country') OR t'('Address') A custom field, again should be filled from widget context.

Hidden metadata

  • UUID = The Universally Unique ID of the user -- system generated, globally shared.
  • Uid = The local Drupal user ID -- system generated and not shared outside current site.
  • Status = Drupal default 'active/blocked' flag. Allows users to be hidden rather than deleted.

Initiative

  • NOTE This content type does not include the old 'Status' field (Muller vs Official) as discussions around this and statuses are ongoing.

Mandatory

  1. t('Initiative name')
  2. t('Initiative location') -- Address Field widget, international standardised address formats but with the 'street' address made non-mandatory.

Optional but recommended

  1. t('Initiative website')
  2. t('Summary') - 255 character simple, punchy 'about this ini' text field

Available in CT but not in widget

  1. t('Further details') - Free text HTML/WYSIWYG field to hold anything else needed: ED 11/12/13: we will not do this for now -- JK 11/12/13 - it's already done! However, it's hidden from widget users. It's a required 'base' field and will be used by many content types. Leaving in for now as taking it out will only incur pain another time... ok Ed?

Hidden metadata

  • Language = Normally shown by Drupa, this will be hidden automatically based on the context of the widget.
  • UUID = The Universally Unique ID of the initiative -- system generated, globally shared.
  • Nid = The local Drupal node ID -- system generated and not shared outside current site.
  • Status = Drupal default 'published' flag. Allows initiatives to be hidden rather than deleted.
  • Coordinates = the 'Location' (address) field will be geocoded to provide coordinates so the ini can be placed on the map.

Attachments