How do I ensure that my custom changes to the action and relevance of a Software Distribution task get preserved the next time I go to edit the task?

Technote (troubleshooting)


Problem(Abstract)

Summary: How do I ensure that my custom changes to the action and relevance of a Software Distribution task get preserved the next time I go to edit the task?

Resolving the problem

Solution:

Definitions used in this article:
editing task refers to solely to making changes to an existing task and not the creation of a new task.
custom changes refers to any additional changes made by the user to the auto-generated relevance and action.

Manage Software Distribution dashboard , Sofware Distribution dashboard, and SWD dashboard all refer to the same dashboard.

When editing a Software Distribution task through the Manage Software Distribution Packages dashboard, you may be given the option to save previous custom changes made to the relevance and action of that task. This option is presented in the form of a checkbox labeled 'Save previous custom changes to relevance and action.'

If this checkbox is selected, only areas bounded by the comment markers are updated.

This checkbox is available under the following conditions:
1. The checkbox is available only when editing an existing task using the Manage Software Distribution Package dashboard.
2. Only tasks created with newer versions (site versions >= XXX) of the Manage Software Distribution Package dashboard will be able to preserve custom changes. Tasks created with older versions (site versions <= XXX) of the Manage Software Distribution Package dashboard will not have the option to preserve previous custom changes and the checkbox will be grayed out.
3. The checkbox will only be available for the original command chosen for the task. If you select a different installation command, the checkbox will be grayed out.


Comment Markers in Relevance:

If the Save previous custom changes to relevance and action checkbox is selected, only the relevance clause with the comment marker will be updated.

There is one available comment marker in the relevance of the task generated by the Manage Software Distribution Package dashboard:
 Optional Target Marker
o This marker presents itself when you opt to define additional applicability conditions (at the time of this writing, this would be the last page of the wizard) while creating a task through the Manage Software Distribution dashboard.

Example:

After creating a task, you end up with the following auto generated relevance clauses in your task:

Relevance 1. version of client >= "8.1"

Relevance 2.(windows of operating system AND (if( name of operating system starts with "Win" ) then platform id of operating system != 3 else true)) OR name of operating system as lowercase starts with "linux"

Relevance 3. /*Optional Target Marker*/
( ((name of it as lowercase = "Win2003" as lowercase )) of operating system)

For this example, let's add two more custom clauses:

Relevance 4. exists key "hklm/software/etc" of registry

Relevance 5. exists file "c:\test.txt"

After adding the above two clauses, you save the task. Your final task now contains the five relevance clauses above.

Now if you edit the task with the Software Distribution dashboard and select the 'Save previous custom changes to relevance and action.' checkbox, only Relevance 3 will be updated.
Relevance 3 will only be updated if you specify different applicability conditions than before.

As an example, say you want to update the applicability conditions you had originally specified. Using the SWD dashboard, you edit and the task and change the applicability condition to 'Operating Systems' that are MAC.

The following would be the result:


Relevance 1. version of client >= "8.1"

Relevance 2.(windows of operating system AND (if( name of operating system starts with "Win" ) then platform id of operating system != 3 else true)) OR name of operating system as lowercase starts with "linux"

Relevance 3./*Optional Target Marker*/
( ((mac of it )) of operating system)

Relevance 4. exists key "hklm/software/etc" of registry

Relevance 5. exists file "c:\test.txt"

Notice that only Relevance 3 has been updated.

If the Save Previous custom changes to relevance and action checkbox was not selected, you would have lost Relevance 4 and Relevance 5.

Comment Markers in Action:

If the Save previous custom changes to relevance and action checkbox is selected, only the portion of the action bound by the comment markers will be updated.

There are three available comment markers in the action of a task generated by the SWD dashboard:
 Preparation Marker
o This marker presents itself for all tasks generated by the SWD dashboard.
 Command Marker
o Available for all tasks generated by the SWD dashboard except for tasks where the chosen installation command is a Mac dmg file.
 Closing Marker
o This marker presents itself for all tasks generated by the SWD dashboard.

Simple Example:

In this example, the auto generated action is in regular font and custom changes made afterwards are in bold.

//**Begin Preparation Marker
download http://support.bigfix.com/files/util.exe
download http://support.bigfix.com/files/bfarchive.exe

//This custom change won't be preserved
//**End Preparation Marker

move __Download/util.exe util.exe //This custom change will be preserved

//**Begin Command Marker
wdinstsp -ty -uy "adobe.spb"
//**End Command Marker

//**Begin Closing Marker
exit 0
//**End Closing Marker

Real World Example:

After creating a task, you end up with the following action in your task Here the markers are formatted in bold for visibilty:

//**Begin Preparation Marker
begin prefetch block
add prefetch item name=EB7BD977A4FACD1C9346B032575DE0A7065C6F49 sha1=eb7bd977a4facd1c9346b032575de0a7065c6f49 size=6637 url=SWDProtocol://127.0.0.1:52311/uploads/EB7BD977A4FACD1C9346B032575DE0A7065C6F49/Spb_2_ForZak.spb.bfswd
end prefetch block

parameter "baseFolder" = "__Download/"

// Move files into subfolders and unescape file names
move "__Download/EB7BD977A4FACD1C9346B032575DE0A7065C6F49" "{parameter "baseFolder"}Spb_2_ForZak.spb"

//**End Preparation Marker
delete __createfile
if{name of operating system as lowercase starts with "win"}
delete run.bat
createfile until _end_
@ECHO OFF
cd "{parameter "baseFolder"}"
call "{pathname of parent folder of client & "\SIE"}\swd_env.bat"

//**Begin Command Marker
wdinstsp -ty -uy "Spb_2_ForZak.spb"
//**End Command Marker

wdlssp.exe > "{pathname of parent folder of client & "\SIE"}\software.cfg"
_end_

move __createfile run.bat
wait run.bat

//**Begin Closing Marker
exit {exit code of action}
//**End Closing Marker
-----------------------------------------
Now let's make 3 custom edits to the action so that it looks like the following (Custom changes in bold italics):



//**Begin Preparation Marker
begin prefetch block
add prefetch item name=EB7BD977A4FACD1C9346B032575DE0A7065C6F49 sha1=eb7bd977a4facd1c9346b032575de0a7065c6f49 size=6637 url=SWDProtocol://127.0.0.1:52311/uploads/EB7BD977A4FACD1C9346B032575DE0A7065C6F49/Spb_2_ForZak.spb.bfswd
end prefetch block

parameter "baseFolder" = "__Download/"

// Move files into subfolders and unescape file names
move "__Download/EB7BD977A4FACD1C9346B032575DE0A7065C6F49" "{parameter "baseFolder"}Spb_2_ForZak.spb"

//**End Preparation Marker
delete __createfile
if{name of operating system as lowercase starts with "win"}
delete run.bat
createfile until _end_
@ECHO OFF
cd "{parameter "baseFolder"}"
call "{pathname of parent folder of client & "\SIE"}\swd_env.bat"
// This is a custom comment that was added

//**Begin Command Marker
wdinstsp -ty -uy "Spb_2_ForZak.spb"
msiexec.exe âsomefile.msiâ
//**End Command Marker

wdlssp.exe > "{pathname of parent folder of client & "\SIE"}\software.cfg"
_end_

move __createfile run.bat
wait run.bat
wait c:\scanmanager.exe

//**Begin Closing Marker
exit {exit code of action}
//**End Closing Marker

After saving your changes, you use the SWD Dashboard to edit this task and select all the same parameters as before. If the Save previous action and relevance checkbox was selected, your final action would look like this.


//**Begin Preparation Marker
begin prefetch block
add prefetch item name=EB7BD977A4FACD1C9346B032575DE0A7065C6F49 sha1=eb7bd977a4facd1c9346b032575de0a7065c6f49 size=6637 url=SWDProtocol://127.0.0.1:52311/uploads/EB7BD977A4FACD1C9346B032575DE0A7065C6F49/Spb_2_ForZak.spb.bfswd
end prefetch block

parameter "baseFolder" = "__Download/"

// Move files into subfolders and unescape file names
move "__Download/EB7BD977A4FACD1C9346B032575DE0A7065C6F49" "{parameter "baseFolder"}Spb_2_ForZak.spb"

//**End Preparation Marker
delete __createfile
if{name of operating system as lowercase starts with "win"}
delete run.bat
createfile until _end_
@ECHO OFF
cd "{parameter "baseFolder"}"
call "{pathname of parent folder of client & "\SIE"}\swd_env.bat"
// This is a custom comment that was added

//**Begin Command Marker
wdinstsp -ty -uy "Spb_2_ForZak.spb"
//**End Command Marker

wdlssp.exe > "{pathname of parent folder of client & "\SIE"}\software.cfg"
_end_

move __createfile run.bat
wait run.bat
wait âc:\scanmanager.exe

//**Begin Closing Marker
exit {exit code of action}
//**End Closing Marker

Notice that only the lines
// This is a custom comment that was added
and
wait c:\scanmanager.exe
were preserved because they were inserted outside the bounds of the markers.

The line msiexec.exe âsomefile.msiâ was removed because it was inserted within the bounds of the Command Marker.


Additional Questions:

What happens if I delete the comment markers?

If you don't ever use the âSave previous custom changes to relevance and action option when editing, then the answer is nothing. In this case, deleting the markers will have no effect at all.

If you do plan on using the Save previous custom changes to relevance and action option when editing, then removing the markers will prevent the appropriate sections of your action from being updated based on your selections in the task editing wizard.
For example, if you had deleted the Preparation Markers, and then wanted to add additional files to the task, the generated action will not include the new files in the action of the task.

Rate this page:

(0 users)Average rating

Add comments

Document information


More support for:

Tivoli Endpoint Manager

Software version:

Version Independent

Operating system(s):

Platform Independent

Software edition:

Edition Independent

Reference #:

1668807

Modified date:

2014-10-13

Translate my page

Machine Translation

Content navigation