annotate xenaAdmin.xml @ 13:be73a33f333b

Tweaking of ucsc data pages tool
author melissacline
date Thu, 19 Mar 2015 14:08:11 -0700
parents ca4510434eda
children 77f5d8cbac77
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
8bb037f88ed2 Uploaded
melissacline
parents:
diff changeset
1 <tool id="xenaAdmin" name="Xena Administration" version="0.0.2">
8bb037f88ed2 Uploaded
melissacline
parents:
diff changeset
2 <description>Administer the Galaxy-embedded Xena: start, check status, stop, backup, restore</description>
8bb037f88ed2 Uploaded
melissacline
parents:
diff changeset
3 <requirements>
8bb037f88ed2 Uploaded
melissacline
parents:
diff changeset
4 <requirement type="package" version="1.0">installXena</requirement>
8bb037f88ed2 Uploaded
melissacline
parents:
diff changeset
5 </requirements>
8bb037f88ed2 Uploaded
melissacline
parents:
diff changeset
6 <command interpreter="python">
8bb037f88ed2 Uploaded
melissacline
parents:
diff changeset
7 #if $adminAction.actionType == "backup":
8bb037f88ed2 Uploaded
melissacline
parents:
diff changeset
8 xena_backup.py ${adminAction.backupDir} $outfile
1
ca4510434eda Moved the xena delete functionality into xena admin
melissacline
parents: 0
diff changeset
9 #else if $adminAction.actionType == "restore":
ca4510434eda Moved the xena delete functionality into xena admin
melissacline
parents: 0
diff changeset
10 xena_restore.py ${adminAction.restoreDir} $outfile
ca4510434eda Moved the xena delete functionality into xena admin
melissacline
parents: 0
diff changeset
11 #else if $adminAction.actionType == "delete":
ca4510434eda Moved the xena delete functionality into xena admin
melissacline
parents: 0
diff changeset
12 xena_delete.py ${adminAction.datasetId} $outfile
0
8bb037f88ed2 Uploaded
melissacline
parents:
diff changeset
13 #else:
1
ca4510434eda Moved the xena delete functionality into xena admin
melissacline
parents: 0
diff changeset
14 runXena.py ${adminAction.actionType} $outfile
0
8bb037f88ed2 Uploaded
melissacline
parents:
diff changeset
15 #end if
8bb037f88ed2 Uploaded
melissacline
parents:
diff changeset
16 </command>
8bb037f88ed2 Uploaded
melissacline
parents:
diff changeset
17 <inputs>
8bb037f88ed2 Uploaded
melissacline
parents:
diff changeset
18 <conditional name="adminAction">
8bb037f88ed2 Uploaded
melissacline
parents:
diff changeset
19 <param format="str" type="select" name = "actionType" label="Action">
8bb037f88ed2 Uploaded
melissacline
parents:
diff changeset
20 <option value="status">Check Status</option>
8bb037f88ed2 Uploaded
melissacline
parents:
diff changeset
21 <option value="start">Start Xena</option>
8bb037f88ed2 Uploaded
melissacline
parents:
diff changeset
22 <option value="stop">Stop Xena</option>
8bb037f88ed2 Uploaded
melissacline
parents:
diff changeset
23 <option value="backup">Backup the Xena data to an external directory</option>
8bb037f88ed2 Uploaded
melissacline
parents:
diff changeset
24 <option value="restore">Restore data to Xena from an external backup directory</option>
1
ca4510434eda Moved the xena delete functionality into xena admin
melissacline
parents: 0
diff changeset
25 <option value="delete">Delete a dataset from the local Galaxy-embedded Xena</option>
0
8bb037f88ed2 Uploaded
melissacline
parents:
diff changeset
26 </param>
8bb037f88ed2 Uploaded
melissacline
parents:
diff changeset
27 <when value="backup">
8bb037f88ed2 Uploaded
melissacline
parents:
diff changeset
28 <param label="External Directory" type="text" name="backupDir" value="/tmp/xena_files"/>
8bb037f88ed2 Uploaded
melissacline
parents:
diff changeset
29 </when>
8bb037f88ed2 Uploaded
melissacline
parents:
diff changeset
30 <when value="restore">
8bb037f88ed2 Uploaded
melissacline
parents:
diff changeset
31 <param label="Backup Directory" type="text" name="restoreDir" value="/tmp/xena_files"/>
8bb037f88ed2 Uploaded
melissacline
parents:
diff changeset
32 </when>
1
ca4510434eda Moved the xena delete functionality into xena admin
melissacline
parents: 0
diff changeset
33 <when value="delete">
ca4510434eda Moved the xena delete functionality into xena admin
melissacline
parents: 0
diff changeset
34 <param label="Dataset ID" type="text" name="datasetId"/>
ca4510434eda Moved the xena delete functionality into xena admin
melissacline
parents: 0
diff changeset
35 </when>
0
8bb037f88ed2 Uploaded
melissacline
parents:
diff changeset
36 <when value="status"/>
8bb037f88ed2 Uploaded
melissacline
parents:
diff changeset
37 <when value="start"/>
8bb037f88ed2 Uploaded
melissacline
parents:
diff changeset
38 <when value="stop"/>
8bb037f88ed2 Uploaded
melissacline
parents:
diff changeset
39 </conditional>
8bb037f88ed2 Uploaded
melissacline
parents:
diff changeset
40 </inputs>
8bb037f88ed2 Uploaded
melissacline
parents:
diff changeset
41 <outputs>
8bb037f88ed2 Uploaded
melissacline
parents:
diff changeset
42 <data format="txt" name="outfile"/>
8bb037f88ed2 Uploaded
melissacline
parents:
diff changeset
43 </outputs>
8bb037f88ed2 Uploaded
melissacline
parents:
diff changeset
44 <help>
8bb037f88ed2 Uploaded
melissacline
parents:
diff changeset
45
8bb037f88ed2 Uploaded
melissacline
parents:
diff changeset
46 **Xena Administration**
8bb037f88ed2 Uploaded
melissacline
parents:
diff changeset
47
8bb037f88ed2 Uploaded
melissacline
parents:
diff changeset
48 Administer the Galaxy-embedded Xena by starting it, stopping it or checking its status. If you start Xena, or if you check the status while Xena is running, the output will indicate a URL for the Xena server that you can enter in the Xena Data Hub tool. After you add a new data hub with this URL, and select it, you will be able to see the data from this Xena in the Xena browser.
8bb037f88ed2 Uploaded
melissacline
parents:
diff changeset
49
8bb037f88ed2 Uploaded
melissacline
parents:
diff changeset
50 With this tool, you can also backup the data from your Galaxy-embedded Xena to an external directory on the same computer, and can restore data from a previous backup into the Xena database. If you wish to restore data, Xena must be running first.
1
ca4510434eda Moved the xena delete functionality into xena admin
melissacline
parents: 0
diff changeset
51
ca4510434eda Moved the xena delete functionality into xena admin
melissacline
parents: 0
diff changeset
52 Finally, you can use this tool to remove a dataset from the Galaxy-embedded local Xena. Simply indicate the dataset by Dataset ID, which you will find under the Xena Data Pages.
0
8bb037f88ed2 Uploaded
melissacline
parents:
diff changeset
53
8bb037f88ed2 Uploaded
melissacline
parents:
diff changeset
54 </help>
8bb037f88ed2 Uploaded
melissacline
parents:
diff changeset
55 </tool>
8bb037f88ed2 Uploaded
melissacline
parents:
diff changeset
56
8bb037f88ed2 Uploaded
melissacline
parents:
diff changeset
57
8bb037f88ed2 Uploaded
melissacline
parents:
diff changeset
58