Diogene87 Documentation: Command rtse

[ < ]

[ > ]

[ << ]

[ Up ]

[ >> ]

[Top]

[Contents]

[Index]

[ ? ]

Command rtse

NAME

Command rtse :: Ref Task Set Enabled

SYNOPSIS

rtse RefName TaskName true/false

DESCRIPTION

The rtse command is used to enabled or disabled a task of a referential. The parameters are the referential name, the task name and a boolean value which indicates if task is enabled (`true') or disabled (`false').

A task which is disabled will not be selected when a day is created with rp. It's useful if you don't want to execute a task while one or more days.

ACCESS CONTROL

This function requires the `manage' privilege for the `referential' command family.

EXAMPLE

In this sample, we create a referential `ref1' with a task `t1'. Then we add an `add always' operation to select this task every times a day is created :

$ dio87d -d
$ dio87d -d
$ dio87d -d
$ dio87d -d
$ dio87d -d
$
$ dio87c ra ref1
$ dio87c rta ref1 t1
$ dio87c rtoa ref1 t1 add always
$

We create a new day `d1' and we check with xtl command that the task `t1' was selected :

$ dio87c rp ref1 "2004-09-21" d1 
$ dio87c xtl d1
t1
$

Now, we disable the task `t1' with xtse command and we create a second day `d2' :

$ dio87c rtse ref1 t1 false
$
$ dio87c rti ref1 t1
Task Name:      t1
Ref Name:       ref1
Description:	
Enabled:                false
Wait All Dependencies:	true
On Error Continue:	true
Target:	none
Queue:	none
$
$ dio87c rp ref1 "2004-09-21" d2 
$

We can check with xtl that the task `t1' was not selected :

$ dio87c xtl d2
$
$ dio87c xtc d2
0
$

To enable the task again, we call the rtse command with `true' as argument :