Wizard Custom IDs

To add a task to the queue using the API, you must identify the wizard that the task will run. You do so by referencing a wizard custom ID assigned to the wizard in Studio.

Accessing wizard custom IDs

To view a list of wizard custom IDs:

1. From the menu in the main Studio window, click Tools > Wizard custom IDs

   

2. A list of all previously created wizard custom IDs will open:

   

   • If the wizard you need to reference appears in the list, you're in good shape. Simply make note of the value in the Custom ID column, and use it in the Add Task API call.

   • If the wizard you are looking for doesn't appear in the list, you can create its wizard custom ID by following the steps below

Creating a wizard custom ID

To create a new wizard custom ID:

1. Access the list of wizard custom IDs as described above

2. Click the link in the upper right-hand corner of the window

3. A window displaying a hierarchy tree of all published wizards in the catalog will open

   

4. Locate the wizard you need either by browsing the tree or by clicking the button to search for it

1. Select the wizard to which you want to assign a wizard custom ID, then click OK

   

2. The name of the wizard you selected will now appear in the list of wizard custom IDs:

   

3. Double-click in the empty Custom ID column for that wizard and type the desired ID

4. Click OK to save

5. Make note of the new wizard custom ID, and use it in the Add Task API call