Page tree
Skip to end of metadata
Go to start of metadata

Version Warning

The content below is for Apache Syncope <= 1.2 - for later versions the Reference Guide is available.

Introduction

This wiki page aims to show how to manage tasks by using Syncope console.

Tasks can be divided into:

  • Propagation task
    1. Creates, updates and deletes performed on an external resource.
    2. All the propagated operations are traced in respect of the trace level configured for the target external resource.
  • Notification task
    1. Notifications sent on events happened.
    2. Notifications to be sent are configured as described at Notification Management.
  • Scheduled task
    1. Custom jobs to be performed manually or automatically.
  • Synchronization task
    1. Synchronizations (from external resources to Syncope) to be performed manually or automatically.
  • Push task (>= 1.2.0 only)
    1. Synchronizations (from Syncope to external resources) to be performed manually or automatically.

Propagation Task

  1. Click on tab Tasks.
  2. Click on subtab Propagation Tasks.
    1. For each propagation task, information below are shown.
    • Id
      • Task identifier (automatically generated).
    • Resource
      • Resource on which operation has been propagated.
    • AccountId
      • SyncopeUser identifier for which propagated operation is about.
    • Propagation Mode
    • Propagation Operation
      • Propagated operation.
    • Last Status
      • Last execution status.

View Task

  1. Click on tab Tasks.
  2. Click on subtab Propagation Tasks.
  3. Click on Edit link in order to take a look at task details.
  4. Click on Executions tab in order to have detailed information about each execution of the task.
    1. For each execution the following information are provided
    • id
      • Execution identifier (automatically generated).
    • Start date
      • Date and time of execution start-up.
    • End date
      • Date and time of execution completion.
    • Status
      • Execution status.
      • Successful statuses are: SUCCESS for ONE_PHASE propagation and TWO_PHASE propagation at "step 2"; SUBMITTED for TWO_PHASE propagation at "step 1".
      • Failure statuses are: FAILURE for ONE_PHASE propagation and TWO_PHASE propagation at "step 2"; UNSUBMITTED for TWO_PHASE propagation at "step 1".
      • For more details about propagation statuses take a look at Propagation Mode.
    • Message
      • Click on Show in order to show returned message (if provided).
    • Delete
      • Click on Delete in order to remove an execution.

[Re-]Execute Task

  1. Click on tab Tasks.
  2. Click on subtab Propagation Tasks.
  3. Click on Execute link in order to execute a task.

Delete Task

  1. Click on tab Tasks.
  2. Click on subtab Propagation Tasks.
  3. Click on Delete link in order to remove a task.
  4. Confirm operation.

Notification Task

  1. Click on tab Tasks.
  2. Click on subtab Notification Tasks.

    • For each propagation task, information below are shown.
    • Id
      • Task identifier (automatically generated).
    • Sender
    • Recipients
    • Subject
    • Trace level
    • Last Status
      • Last execution status.

View Task

  1. Click on tab Tasks.
  2. Click on subtab Notification Tasks.
  3. Click on Edit link in order to take a look at task details.
  4. Click on Executions tab in order to have detailed information about each execution of the task.
    1. For each execution the following information are provided
    • id
      • Execution identifier (automatically generated).
    • Start date
      • Date and time of execution start-up.
    • End date
      • Date and time of execution completion.
    • Status
      • Execution status (SENT or NOT_SENT).
    • Message
      • Click on Show in order to show returned message (if provided).
    • Delete
      • Click on Delete in order to remove an execution.

[Re-]Execute Task

  1. Click on tab Tasks.
  2. Click on subtab Notification Tasks.
  3. Click on Execute link in order to execute a task.

Delete Task

  1. Click on tab Tasks.
  2. Click on subtab Notification Tasks.
  3. Click on Delete link in order to remove a task.
  4. Confirm operation.

Synchronization Task

  1. Click on tab Tasks.
  2. Click on subtab Synchronization Tasks
    1. For each sync task, information below are shown.
    • Id
      • Task identifier (automatically generated).
    • Resource Name
      • Resource to be synchronized.
    • Last Execution
      • Last date and time job execution.
    • Next Execution
      • Next date and time job execution.
    • Last Status
      • Last execution status.

Create Task

  1. Click on tab Tasks.
  2. Click on subtab Synchronization Tasks.
  3. Click on Create new task button.
  4. Click on Profile tab and provide the following information.
    1. Resource Name
      • Resource to be synchronized.
    2. Actions Class
    3. Create new identities
      • Check it in order to synchronize identities which don't exist.
    4. Update matched identities
      • Check it in order to synchronize identities which exist.
    5. Delete matched identities
      • Check it in order to synchronize retrieved identity deletions.
  5. Click on Schedule tab to schedule task executions.
    1. Provide a Quartz Cron Expression (you can use an expression template by selecting it into the combo-box provided).
  6. Click on Save button to save task.

Edit/View Task

Synchronization tasks can modified following the steps below.

Using the same steps it is possible to check execution statuses as well.

  1. Click on tab Tasks.
  2. Click on subtab Synchronization Tasks.
  3. Click on Edit link in order to take a look at task details.
  4. Click on Schedule tab in order to specify a schedule for the task.
  5. Click on Executions tab in order to have detailed information about each execution of the task.
    1. For each execution the following information are shown.
    • id
      • Execution identifier (automatically generated).
    • Start date
      • Date and time of execution start-up.
    • End date
      • Date and time of execution completion.
    • Status
      • Execution status.
    • Message
      • Click on Show in order to show returned message (if provided).
    • Delete
      • Click on Delete in order to remove an execution.
  6. Click on Save button to save changes.

Specify User Template

Specify a user template to assign default parameters to each synchronized user.

  1. Click on tab Tasks.
  2. Click on subtab Synchronization Tasks.
  3. Click on Edit link (corresponding to User template column) in order to configure a user template.
    1. Click on Details tab..
      • Provide default values for username and password.
      • Values must be provided using a JEXL expression.
    2. Click on Attributes tab.
      • Provide default value for one or more user attributes.
      • Values must be provided using a JEXL expression.
    3. Click on Derived Attributes tab.
      • Provide derived attributes to be assigned by default.
    4. Click on Virtual Attributes tab.
      • Provide default value for one or more virtual user attributes.
      • Values must be provided using a JEXL expression.
    5. Click on Resources tab.
      • Provide external resource to be automatically assigned to each synchronized user.
    6. Click on Roles tab.
      • Provide roles to be automatically assigned to each synchronized user.
  4. Click on Save button to save changes.

[Re-]Execute Task

  1. Click on tab Tasks.
  2. Click on subtab Synchronization Tasks.
  3. Click on Execute link in order to force job execution.

Dry Run

  1. Click on tab Tasks.
  2. Click on subtab Synchronization Tasks.
  3. Click on Dry run link in order to execute.

Delete Task

  1. Click on tab Tasks.
  2. Click on subtab Synchronization Tasks.
  3. Click on Delete link in order to remove a task.
  4. Confirm operation.

 

Push Task

Version warning

Content of this section applies to Apache Syncope >= 1.2.X

This tasks are used to synchronize users/groups from Apache Syncope to external resources. Take a loot at Push Task for more details.

  1. Click on tab Tasks.
  2. Click on subtab Push Tasks

    1. For each push task, information below are shown.
    • Id
      • Task identifier (automatically generated).
    • Name
      • Task name
    • Description
      • Task description
    • Resource Name
      • Resource to be synchronized.
    • Last Execution
      • Last date and time job execution.
    • Next Execution
      • Next date and time job execution.
    • Last Status
      • Last execution status.

Create Task

  1. Click on tab Tasks.
  2. Click on subtab Push Tasks.
  3. Click on Create new task button.
  4. Click on Profile tab and provide the following information.
    1. Name
    2. Description
    3. Resource Name
      • Resource to be synchronized.
    4. Actions Class
    5. Allow create operations
    6. Allow update operations
      • Check it in order to be able to perform local/remote changes.
    7. Allow delete operations
    8. Allow status synchronization
      • Check it in order to propagate user status as well.
    9. Matching Rule
    10. Unmatching Rule
    11. User Filter
      • Check it and provide a filter to restrict the set of push involved user data
    12. Role Filter
      • Check it and provide a filter to restrict the set of push involved role data
  5. Click on Schedule tab to schedule task executions.

    1. Provide a Quartz Cron Expression (you can use an expression template by selecting it into the combo-box provided).
  6. Click on Save button to save task.

Edit/View Task

Push tasks can modified following the steps below.

Using the same steps it is possible to check execution statuses as well.

  1. Click on tab Tasks.
  2. Click on subtab Push Tasks.
  3. Click on Edit link in order to take a look at task details.
  4. Click on Schedule tab in order to specify a schedule for the task.
  5. Click on Executions tab in order to have detailed information about each execution of the task.

    1. For each execution the following information are shown.
    • id
      • Execution identifier (automatically generated).
    • Start date
      • Date and time of execution start-up.
    • End date
      • Date and time of execution completion.
    • Status
      • Execution status.
    • Message
      • Click on Edit in order to show returned message (if provided).
    • Delete
      • Click on Delete in order to remove an execution.
  6. Click on Save button to save changes.

[Re-]Execute Task

  1. Click on tab Tasks.
  2. Click on subtab Push Tasks.
  3. Click on Execute link in order to force job execution.

Dry Run

  1. Click on tab Tasks.
  2. Click on subtab Push Tasks.
  3. Click on Dry run link in order to execute.

Delete Task

  1. Click on tab Tasks.
  2. Click on subtab Push Tasks.
  3. Click on Delete link in order to remove a task.
  4. Confirm operation.

Scheduled Task

  1. Click on tab Tasks.
  2. Click on subtab Scheduled Tasks.
    1. For each scheduled task, information below are shown.
    • Id
      • Task identifier (automatically generated).
    • Class
      • Java class implementing the job.
    • Last Execution
      • Last date and time job execution.
    • Next Execution
      • Next date and time job execution.
    • Last Status
      • Last execution status.

Create Task

  1. Click on tab Tasks.
  2. Click on subtab Synchronization Tasks.
  3. Click on Create new task button.
  4. Click on Profile tab and provide the following information.
    • Class
      • Java class implementing task job to be executed.
      • For more information about task job class implementation take a look at Scheduled Task Job Class.
  5. Click on Schedule tab to schedule task executions.
    • Provide a Quartz Cron Expression (you can use an expression template by selecting it into the combo-box provided).
  6. Click on Save button to save task.

Edit/View Task

Scheduled tasks can modified following the steps below.

Using the same steps it is possible to check execution statuses as well.

  1. Click on tab Tasks.
  2. Click on subtab Scheduled Tasks.
  3. Click on Edit link in order to take a look at task details.
  1. Click on Schedule tab in order to specify a schedule for the task.
  2. Click on Executions tab in order to have detailed information about each execution of the task.
    1. For each execution the following information are provided
    • id
      • Execution identifier (automatically generated).
    • Start date
      • Date and time of execution start-up.
    • End date
      • Date and time of execution completion.
    • Status
      • Execution status.
    • Message
      • Click on Show in order to show returned message (if provided).
    • Delete
      • Click on Delete in order to remove an execution.
  3. Click on Save button to save changes.

[Re-]Execute Task

  1. Click on tab Tasks.
  2. Click on subtab Scheduled Tasks.
  3. Click on Execute link in order to force job execution.

Delete Task

  1. Click on tab Tasks.
  2. Click on subtab Scheduled Tasks.
  3. Click on Delete link in order to remove a task.
  4. Confirm operation.