If you have enabled the token expiration options in the DeviceID policy, then you must also set up the task called "Token Notification Service"

Introduction

The "Token Notification Service" task periodically checks if tokens are about to reach their renewal time, and sends out notification messages to the users.

A token expiry notification may be sent based on the date of token creation and the value specified in the DeviceID policy setting "Token Lifetime (days):" (see below);

The task can be found by navigating to "Administration | Tasks", then scrolling down to the task "Token Notification Service";

Task Parameters

The task parameters are used by the task script to determine which tokens are to be deleted and are edited by left clicking on the context menu of the task and selecting "Parameters";

A new window titled "Task Parameters" will now open that lists the parameters making them available for editing, and the default parameters for this task are as follows

The "Token Notification Service" task uses the following parameters;





Specify the computer name of the server the task is to be run on,.


If you have multiple DualShield backend servers, then you need to specify the computer name of the server that will run this task

Select the parameter "Server" then click the  button, and a new window titled "Parameter - Edit" will open;

At the parameter "Default Value:" supply the name of the server the task is to run on., then click to update the parameter.

  • Before tasks are scheduled (or run manually), we should provide the task parameters that are used during processing of the task script.

    To access the task parameters left click on the context menu of the task then select "Parameters";

    A new window titled "Task Parameters" will now open that lists the parameters that have been created for this task (see example below);



    Specify the domain that assigned users of the tokens must be members of if the tokens are to be deleted by the task.

    Specifies the Product Code of the tokens to be deleted.


    Specifies if only inactive tokens are to be deleted when the task is run.

    In the top right hand corner of this window are the buttons that all viewing, editing and deletion of task parameters;

    To edit one of the listed parameters first select the parameter to be edited then click on the button.

    A new window will now open that will allow you to edit the parameter (example below);

    In most cases the only value that should be changed is the "Default Value" setting.

    If the default value is updated, and the button is pressed, then this new value will be used by the task script next time the task is run.

Editing and Scheduling the Task

Viewing and Editing the task

By default, the Token Notification task is not enabled, but may be enabled by left clicking on the context menu of the task and selecting "Edit";

A new window will now open titled "Task - Edit";




Enter the name to be assigned to the task within the management console.


Enter a description of what the task will do.


The version number of the task.


This field is used to specify when the task is scheduled to executed.


This field will determine if the task schedule is enabled (if enabled the task will execute at the scheduled time).


Specifies how many times the task should be repeated after the task is executed.



import com.deepnet.das.services.TokenNotificationService
import com.deepnet.das.util.Util

if(server && ! InetAddress.getLocalHost().getHostName().equalsIgnoreCase(server)){
            setEndMessage("Task execution has been bypassed")
            return;
        }

                Util.getBean("tokenNotificationService", TokenNotificationService.class).sendTokenNotification()


Scheduling the Task

Select the "Enable Schedule" checkbox to ensure the task schedule is activated, then use the pencil icon ("")  to specify the time and frequency settings for automated task execution.

  • Tasks can be scheduled for automatic execution by selecting the "Schedule Enable" option then clicking on the icon;

    When the is pressed a window will open titled "Schedule" that can be used to specify the when the report is scheduled to run; 


    As an example, we can schedule the report to run at 1am every weekday using the following settings;

    After clicking on the schedule details will be converted into text form and added against the report parameter "Schedule"; 

Manual Task Execution

The task can be run manually from the management console by left click on the context menu of the task, then selecting "Run";

A new window will open titled "Execute Task" will then open (the window will be populated with the default task property settings);

Ensure the parameter "Execute On Server" contains the computer name of the server the task is to be run on, then click the  button. 

  • Tasks can be run manually from the management console by left click on the context menu of the task, then selecting "Run";

    A new window will open titled "Execute Task" will then open (the window will be populated with the default task property values for this task (example below);


     


    Provide a brief description that will be used to describe the purpose of the task in the audit log.


    Specify the domain that assigned users of the tokens must be members of if the tokens are to be deleted by the task.

    If specified, this property will restrict token deletion to tokens that are assigned to users who are members of the selected Unit.


    If supplied this parameter specifies that only tokens with the specified Product will be deleted.

     

     

    Specifies if only inactive tokens are to be deleted when the task is run.

     

     

    Before manually running the task the system administrator has the opportunity to temporarily replace these default values (the default values will return to their original state after the task has run).

    When you have finished supplying the property settings, the task can be manually run by clicking on the  button. 

  • No labels