SAKAI

UMUSYNC TOOL

Sites sync tool: Tasks

In the page shown when entering to the sites synchronization tool there is a tasks list, and here we can make all the actions related to tasks.

If we are in another page inside the tool, to return to that page we have to click on the option Tasks in the upper menu.

Creating a new task

  1. Click on the option New Task
  2. Fill in the new task form, consisting in the following fields:
    • Site type: It indicates the exact type of the site we want to synchronize, in the pick list the types defined in Sakai are shown, besides, the following options:
      • ALL: It includes all the existing sites.
      • Default user site: In Sakai's default configuration, the site type for user sites isn't define, so the type MyWorkspace is not in the pick list, this option includes those user sites which don't have a defined type, for example the user's site admin is included
      • All the user site: It include all the user sites, no matter what the user type is.
    • Filter: It shows a list of previously created filters, or the option NONE if you don't want to execute any filter on the site properties. You can take a look to to the section: How to create, edit or delete filters
    • Sync homepage: The home page is a special page of a site, in a synchronizing task we have the following options:
      • NOT TO DO: The home page won't be considered.
      • Remove homepage: The home page will be deleted from the site, in case it exists.
      • -Page name-: The home page must be the same as the one we defined with that name. You can take a look to the section: How to create, edit or delete pages
      • sakai.properties: The home page must have exactly the tools defined in the property for home pages of that type sites wsetup.home.toolids.sitetype.*, in case of not existing it checks the property for default sites: wsetup.home.toolids.*
    • Several tools for page: Activating this option it considers the pages with several tools, if it isn't checked it only cheks the pages with a single tool, this checking is done when we add/delete site tools.
    • Realm template (site): realm from which we can copy to synchronize roles and permissions of the site, the identifiers of these realms start with !site.template
    • Realm template (group): realm from which we can copy to synchronize roles and permissions of the site groups, the identifiers of these realms start with !group.template
    • Comments: Brief explanation of what the tasks does, to identify it easily in the tasks list.
    • Ignore (siteId1, siteId2,...): The sites whose identifier appears here won't be considered. We can indicate several sites separating them with commas
    • Ignore permissions: It indicates which permissions won't be considered when synchronizing with the template realms, we have the following options:
      • NOT TO DO: No permission is ignored, the site will have exact copies of the site and/or group template realms.
      • sakai.properties: It ignores the permissions indicated in the property umusync.ignore.functions, if it isn't defined if takes the default value of those permissions that generally a teacher can modify, they are the following: annc.all.groups, annc.delete.any, annc.delete.own, annc.new, annc.read, annc.read.drafts, annc.revise.any, annc.revise.own, asn.all.groups, asn.delete, asn.grade, asn.new, asn.read, asn.receive.notifications, asn.revise, asn.share.drafts, asn.submit, calendar.all.groups, calendar.delete.any, calendar.delete.own, calendar.import, calendar.new, calendar.read, calendar.revise.any, calendar.revise.own, calendar.subscribe, chat.delete.any, chat.delete.channel, chat.delete.own, chat.new, chat.new.channel, chat.read, chat.revise.channel, content.all.groups, content.delete.any, content.delete.own, content.hidden, content.new, content.read, content.revise.any, content.revise.own, poll.add, poll.deleteAny, poll.deleteOwn, poll.editAny, poll.editOwn, poll.vote, rwiki.admin, rwiki.create, rwiki.read, rwiki.superadmin, rwiki.update
      • CUSTOMIZED: When selecting this option a list with all registered permissions registered in the server will appear, we can check the ones we don't want to be synchronized.
    • Tools/Pages: We have a list with all the tools in Sakai, and with all the pages we have defined. You can take a look to the section: How to create, edit or delete pages. For each page/tool you can select two options:
      • Add
        • Tool: The tool is added in case it doesn't exist in the site.
        • Page: If a page with that name exists its tools are synchronized, if not a new page is created with the defined settings.
      • Delete
        • Tool: If the tool exists in the site, then it will be deleted, if the page which have that tool runs out of tools, that page is also deleted.
        • Page: It will delete those pages matching the name of the page selected to be deleted.
  3. Once we fill in the task data we click on the button Save

Enable/Disable a task

The icon in red Disabled or green Enabled in the first column of the tasks list is used to indicate the task status, changing the state when it's clicked. When the sites synchronizing job is executed from Quartz scheduler, only enabled tasks in the list will be considered (green row) .

Edit a task

The icon pencil in the second column of the tasks list is used to edit them.

Delete a task

The icon red X in the third column of the tasks list is used to delete them.

Execute a task

The icon execute in the last column of the tasks list is used to launch a task execution. No matter what its state is. To be able to execute it you must have admin permissions.