NBIA Help Topics

1. On the NBIA welcome page, click the Register Now link in the Register Now panel as shown below.
   
   The legal provisions page appears.
2. Review the text on the page and click the link at the bottom to indicate your agreement and continue.
   The registration form appears. 
   
   The legal provisions page appears.
3. Enter information for the new user. Required fields are preceded by an asterisk. Do not include special characters in your username, but your password can have special characters.
4. Click Register to continue or Cancel to return to the homepage.
   The NBIA administrator reviews your registration and creates the new account. Once you confirm the account registration, your account is registered. For more information, see Creating a New NBIA User.

If you do not have a User ID or password, click Register Now to apply for a user account. For more information, see Registering a New User.

If you have already registered, perform the following steps to log in.

1. In the User Login panel, enter your User ID and password.
   

2. Click Login. If your login is successful, the data portal appears.

   Tip

   NBIA uses popups. To prevent problems accessing the application, in your browser, enable a popup blocker exception for https://imaging.nci.nih.gov/ncia/login.jsf.

   If you have persistent difficulty logging in, click I cannot access my account on the NBIA login page. An NBIA account help topic opens, describing help options for resolving your login problem. Alternately, contact Application Support.

After you log in, you have more options.

Options available from this page and links to more information about them follow.

Click Help > User Guides in the top menu bar to open the NBIA User's Guide on the NCI wiki.

On any application page, click  to open the help topic that applies to features available on that NBIA page.

To perform a simple search

• On the NBIA home page, click Simple Search or Search Images > Simple Search.
  The Simple Search page appears.
  
  Choose the search criteria as described in the following table.

  Description	Simple Search Criteria
  Results per Page	Select the number of search results per page the search will return.
  Collection(s)	Collections are NCI-defined groupings of image data sets. Select from the collections to which you can access. If none are selected, then the search returns data for all collections. Click the (?) icon next to the collection name to display a popup with the collection description if it exists. Click Collection Descriptions for more information about the collections.
  Image Modality(ies)	Select from the available image classifications. If none are selected, then the search returns data for all modalities.  Specify whether to Return cases that include All or ANY Modality. Modality description Descriptive text for the modality displays when you hover the cursor over the option. The NBIA data portal can perform ultrasound-specific searches. To launch an ultrasound image search, select US in the list of Image Modalities. When you do so, three additional search options display on the page, shown below. Configure the options appropriately for the ultrasound data you want to search. Number of frames: One ultrasound DICOM file can consist of multiple frames which you can specify in this option. Specify if Ultrasound Color Data is present. Specify one or more Ultrasound Image Modes. If you choose to view an ultrasound DICOM file in animation, NBIA loops through all of the images in the file.
  Anatomical Site	To further restrict the search, optionally choose the anatomical site of interest.
  Manufacturer Model	To restrict manufacturer model results, uncheck All Manufacturers. Expand and display the list as needed, and select the items to restrict the search.
  Available (mm/dd/yyyy)	To restrict results to the date the image became available in the system, expand the panel, enter from and to dates and select Add Criteria to perform the search.
  Subject ID	To restrict results to a comma-separated list of patient IDs, expand the panel, enter the list of patient IDs, and select Add Criteria to perform the search.
  Baseline Plus	Expand the panel and specify the Minimum Number of Additional Studies.

  To clear the search criteria and start over, click .

  The search results appear.
  
  

  Save the Query

  You can save your search criteria to make it easier to repeat this query in the future. After you have selected one or more search criteria, the Save Query link appears at the bottom left of the page.

  To save a search query

  1. Select search criteria.

  2. In the box above the Save Query link, enter a name for your query.

     
     
     
     

  3. Click Save Query.
     The query is saved. You can see it by selecting Tools > View Saved Queries.

  For more information, see Managing Saved Queries.

  Navigation Tips

  • Click the down arrow next to a column title to sort the column by that item.
  • Click the arrows at the bottom of the table to display the first, previous, next, or last page of results.
  • Click the page number links to move to a specific page of results.
  The Search Results (Studies for Subject) page shows studies associated with the subject that you selected on the Search Results by Subject page. Each study, identified by Study Instance ID, Description, and Date, is followed by a table with rows for each image series in the study. At the top and bottom of the page, breadcrumbs in the format Search >> Study show the level of the data on the page. Clicking Search in those breadcrumbs returns you to your original search results.

  The following table describes the data available for each study and image series in that study.

  Field	Description
  DICOM Web Viewer link	Click this link to see all study images in the DICOM Web Viewer.
  Series	Series identification number
  Description	Description of the series
  Modality	Image modality
  Manufacturer	Name of the manufacturer of the image series
  Images	Displays the number of images in the series. This number includes visible images that meet the search criteria.
  Thumbnails	Click this link to display thumbnails of the series' images. For more information, see Search Results (Images for Series).
  Cine Mode	Click in a series record to launch an animation of the series. This feature is only available when two or more thumbnails are available for the series. For more information, see Viewing Image Animation.
  DICOM	Click to open a new window that displays DICOM metadata about the first image in the series.  Each image series can have multiple images whose thumbnails display in this search results page. While each image has its own DICOM file whose attributes may vary slightly from the others in the series, the DICOM file that opens displays values for only the first image in the series. These values represent the values for all images in the series.
  Add to Basket	Click to select a series and add it to your data basket, or to remove it from your data basket. To mark all series in the search results as records you want to add to your data basket, click . For more information, see Managing the Data Basket.
  Add a Study series to Basket	To add only the series in a single study in the search results to your basket, click in the Add This Study to Basket section.

Text search does have some restrictions. These are:

• The text string you use must have more than one character. The search won't return any values if the text string has only one character.
• Do not use a forward slash (/) in your text string.
• Do not use complex searches with AND or OR statements (text search supports Lucene syntax but only a single field can be searched at a time).

To perform a text search

1. On the NBIA home page, click Text Search or Search Images > Text Search. 
   The Text Search page appears.

   

2. Select the number of search results per page you want the search to return.
3. In the box at the top of the page, enter a text string of two characters or more.

4. Click . 
   The search results appear.
   

The following table describes each item in the search results table.

To perform an advanced search

1. On the NBIA home page, click Advanced Search or Search Images > Advanced Search.
   The Advanced Search page appears.
   
   
2. Select the number of search results per page the search will return.
3. From the Match options, select ALL to find image series that meet all of your search criteria or select ANY Criteria to find image series that meet any of your search criteria.
4. From the first Criteria list, select an NBIA entity. Your selection here determines the options available for the rest of the search criteria.

5. Select options from the lists or enter text into the box as needed to perform your search. If you enter text into the box, click the Add icon () for each set of criteria you define.
   As soon as you specify the final criterion, the criteria you selected appear in the box below the criteria and the search results appear to the right.

   Modality searches

   Modality searches only support the CT and MR modalities.

   
   

   

   Navigation Tips

   • Click the down arrow next to a column title to sort the column by that item.
   • Click the arrows at the bottom of the table to display the first, previous, next, or last page of results.
   • Click the page number links to move to a specific page of results.

   The following table describes each item in the search results table.

   Search Result	Description
   Collection ID	Collection identifier
   Subject ID	Click the Subject ID to view all study images for this subject in a DICOM web viewer, a single series' thumbnails, or the DICOM header for the first image in the series. See Search Results (Studies for Subject).
   Matched Studies	Total number of studies for this subject that match the search criteria
   Total Studies	Total number of studies for the subject
   Matched Series	Total number of image series for the subject that match the search criteria
   Total Series	Total number of image series for the subject
   	Add the images for a single series or the entire study to your data basket. When you have marked a record for addition to the data basket, it is highlighted in yellow. Click  to select the record and  to clear it. To mark all records in the search results as records you want to add to your data basket, click the basket icon in the column header or click . For more information, see Managing the Data Basket.

6. To further refine your results, select new search criteria. These new criteria filter your existing results and as with the previous search, the criteria you selected appear in a box below the criteria. Click the to delete the record from the page or click   to delete all criteria and start over.

1. Select search criteria.

2. In the box above the Save Query link, enter a name for your query.

   
   
   
   

3. Click Save Query.
   The query is saved. You can see it by selecting Tools > View Saved Queries.

The following procedures are associated with saved search queries.

• Creating Saved Queries
• Viewing and Editing Saved Queries
• Viewing Query History

To view, edit, and resubmit saved queries

• Select Tools > View Saved Queries.
  The Saved Queries page appears.
  

  

  The query table is sorted in descending order by Last Executed date by default. You can also sort by Query Name by clicking on the down arrow next to the column title.
  
  The following table describes the information about your saved queries on this page.

You can also perform the following action on the Saved Queries page.

• Select Tools > View Query History link
  or
  Click the Query History tab from the Saved Queries page.
  The Query History page appears. The Query History page displays a table of the last twenty queries that you executed. These include saved queries that you resubmitted as well as queries you have not saved.
  

The Query History page contains the following information:

Click the Saved Queries tab to view, edit, or resubmit saved queries (see Managing Saved Queries).

The following table describes the data available for each study and image series in that study.

To create a shared list

You can create a shared list from data basket or the Tools menu. Procedures for both methods follow.

Data Basket

1. Add an image series that you want to include in the shared list to the data basket.
2. Click the Create Shared List button.
3. Do the following:
   
   1. Enter a Name for the list (required).
   2. Optionally, add a description and a URL. The URL links to relevant or more detailed information about the list.
   3. Click Browse to upload a file in comma separated value format (.csv) that includes all of the series instance IDs you want to be in the shared list. This file should have one series instance UID per line.
4. Click Submit.
   The image series from the uploaded file is added to the data basket.

Menu Option:

1. Click Tools > Create Shared List.
   The Create Shared List page appears.
   
2. On this page, do the following:
3. 1. Enter a Name for the list (required).
   2. Add Comments and a Hyperlink, where appropriate, which links to relevant or more detailed information about the list (optional).
   3. In the Upload File field, enter the name of a file that includes all of the series instance IDs you want to be in the shared list. This file should have a series instance UID per line.
   4. For your convenience, a Java tool is available to aid in generating a CSV of your series instance UIDs. 
      Download: ExtractSeriesUIDs.zip
      Do the following to use this tool to generate the file to upload in the last field of our online Create Shared List form:
      1. Download the zip file, then move it to a top-level directory of DICOM files you want indexed.
      2. Extract the zip file to the top level directory where your DICOM data resides (all sub-directories will be scanned). It should extract two things.
      3. Then run ExtractSeriesUIDs.bat which should flash a quick command line window and then automatically disappear.
         A file with a name similar to SeriesUIDs.CSV is created as an output.
      4. Enter the output filename into the form.
4. Click Submit.
   The image series from the uploaded file is added to the data basket.

To search for a shared list

1. Log in to NBIA.
2. Click Tools > Search Shared List.
   The Search Shared List page appears.
   
3. Enter the name of an existing shared list. To retrieve the list, you must know the exact name given to the shared list.
4. Click Submit to launch the search or Reset to clear the field and start again.

If the search is successful, all image series in the shared list are added to the data basket. If the shared list includes series for which you do not have visibility rights, a message appears that informs you that the displayed shared list is not complete.

To edit a shared list

1. Click the Edit Shared List link under Tools on the menu bar.
   The Edit My Shared List page appears, displaying a list of shared lists you have created.
   
2. Click the name of the shared list you want to edit.
   List details appear.
   
3. In the description field, optionally enter a comment about the list or your edit.
4. In the URL field, optionally enter a web address that provides more information about the shared list.

5. Click Browse to locate the file you want to upload. Doing this replaces the current shared list.

To delete a shared list

Because editing a shared list is only possible by replacing it, you might consider backing up a shared list when you create it. To do so, export the shared list as a file when you create it. See Exporting a Shared List.

 To delete a shared list, follow these steps:

1. Click Admin > Manage Shared List.
   The Manage Shared List page appears.
   
2. Select a user name from the list.
   That user's shared list(s) appear.
   

3. Click the name link to review the shared list's details or click to delete shared the shared list.

You select items to download by first searching for them in NBIA and then adding them to your data basket.

The following is an example of the My Data Basket page with just one image collection in it. The estimated download time and the total size of your data basket appear at the bottom.

The following table describes each item in the table.

To delete all items from your basket, click the Empty Data Basket link. You can continue to add items to your data basket from the Search Results pages.

You can now download the data in your data basket using the NBIA Data Retriever.

• Click  to select the record and  to clear it.
• To mark all records in the search results as records you want to add to your data basket, click the basket icon in the column header or click .

Once you are satisfied with your selections, click Start Download at the top left of the results table to use the NBIA Data Retriever.

However, if you cannot download the application, the alternative is to use the TCIA Download Manager, a Java Network Launch Protocol (JNLP) file.

The TCIA Download Manager allows you to replicate items in your Data Basket, downloading them to your local machine. It is a Java program and requires that you install a Java Runtime Environment (JRE^TM) on your machine to run it. You can download the JRE . The TCIA Download Manager does not limit the total size of the download.

To download objects using the TCIA Download Manager

1. At the top of the My Data Basket page, click the Temporary TCIA Downloader link. You are prompted to open or save the TCIA Download Manager. Open it in the JRE^TM you installed. If you have any issues opening the TCIA Download Manager, see the note about Java Security settings.
   
   The page lists all items you selected in the data basket. You can hover your mouse over the Patient ID, Study Instance, and Series Instance columns to reveal the complete corresponding IDs. You can also resize a column by selecting and dragging the column border.
   
   
2. Click Browse to navigate to the destination where you want the images/annotations to be downloaded.

3. Click Start to begin the download. You can monitor the download in the Progress column. The Status column indicates when the download for each item is complete.

   At any point in the process, you can click the Pause and Resume buttons to temporarily stop and restart the process.
   
   

   Note that files downloaded this way are not compressed. The downloaded files are stored in a child folder under the destination folder such as Collection name/patient id/study instance UID/series instance UID/image SOP instance UID.

Downloading the NBIA Data Retriever

Installing the NBIA Data Retriever

To install the NBIA Data Retriever on Windows

1. Download the installer package for Windows using the link above.
2. Save the installer package file to your computer.
3. Install the app by double-clicking the installer package file.
4. Agree to the terms in the License Agreement and click Install.
5. When the Setup Wizard ends, click Finish.

To install the NBIA Data Retriever on Mac

1. On your Mac, find the NBIA Data Retriever on the Mac App Store.

   The NBIA Data Retriever is free but still requires you to log in to download it. Consider changing your macOS Password Settings so that you can download free software without having to log in separately for it.

2. Click Get, then click Install App. The NBIA Data Retriever is free.
   The app starts downloading to your Mac. When the download is complete, you can open a manifest file with the NBIA Data Retriever.

To install the NBIA Data Retriever on Linux (centOS or Ubuntu)

You must have the sudo privilege on your computer and a sudo password to install the NBIA Data Retriever on CentOS and Ubuntu.

1. Download the installer package for centOS or Ubuntu using the links above.
2. Save the installer package file to your computer.
3. Open a command window and go to the location where you saved the installer.

• • For a centOS system, enter the following at the command prompt:
    sudo yum -v -y remove TCIADownloader.x86_64;sudo yum -y install NBIADataRetriever-3.3-1.x86_64.rpm

  • For an Ubuntu system, enter the following at the command prompt:
    sudo -S dpkg -r tciadownloader;sudo -S dpkg -i nbia-data-retriever-3.3.deb
    Enter the sudo password when prompted.

Downloading Images Using the NBIA Data Retriever

When you start downloading the images you have added to the data basket, NBIA provides a list of those images in a manifest file (manifest-xxx.tcia). You must have already installed the NBIA Data Retriever to open this manifest file and download the images.

1. Search for images of interest.
2. Add those images to your data basket.
3. Open the My Data Basket page and click Start Download.

4. Click the manifest-xxx.tcia file.
   If you are only downloading public images, the NBIA Data Retriever appears, listing the items in your data basket. If you are downloading any private images, see the section about downloading private data.
   
   
   

   The NBIA Data Retriever lists all items you selected in the data basket. You can hover your mouse over the Patient ID, Study Instance, and Series Instance columns to reveal the complete corresponding IDs. You can also resize a column by selecting and dragging the column border.

   If you do not want to download any of those items, select them in the Downloads table and then click Delete. When you remove an item from the Downloads table, it stays in your data basket.

5. Click Browse to navigate to the destination where you want the images/annotations to be downloaded.

6. Click Start to begin the download. You can monitor the download in the Progress column. The Status column indicates when the download for each item is complete.

   At any point in the process, you can click the Pause and Resume buttons to temporarily stop and restart the process.

   Note that files downloaded this way are not compressed. The downloaded files are stored in a child folder under the destination folder such as Collection Name > Patient ID > part of Study Date + part of Study ID + part of Study Description + last 5 digits of Study Instance UID > part of Series Number + part of Series Description + last 5 digits of Series Instance UID.
   
   

   Network Error?

   If network errors occur during large downloads, the NBIA Data Retriever retries the files the number of times that your administrator has configured.

Downloading Private Data

If you are downloading any private data, you are prompted to log in.

Once you log in, the NBIA Data Retriever appears.

If you do not have permission to access even one of the collections/sites to which the images you have in your manifest file, you are prompted to contact the help desk to request permission to access all of the images.

• Using the NBIA data portal,
• Using the Manifest API,
• Using the Shared List API, and

• Using the JNLP data API.

Creating a Manifest File Using NBIA

To use the NBIA Data Retriever, you must already have a manifest file that lists the files you want to download. You create the manifest file by searching the data portal of NBIA. After installing the NBIA Data Retriever, double-click this manifest file to invoke the application.

To create a manifest file:

1. Search for images of interest.
2. Add those images to your data basket.
3. Open the My Data Basket page and click Start Download. 
   A manifest file is created and downloaded to your computer. 

• • If you have already installed the NBIA Data Retriever, double-click the manifest file to open it using the NBIA Data Retriever. Click Open when your web browser prompts you to open the file. 
  • If you want to use this manifest file to download images more than once or download images you select on other machines, click Save at the web browser prompt. You can then double-click the saved manifest file in Windows Explorer on Windows, Finder on Mac, or File Manager on Linux to invoke the NBIA Data Retriever.

Creating a Manifest File Using the Manifest API

Refer to the Manifest API documentation for instructions on how to use the API. The outcome of the REST API call must be saved as a text file with the extension .tcia. 

Example Manifest Query 

curl -H "Authorization:Bearer d98c390f-b53d-4456-beb3-110e63663762" -k "http://localhost:8080/nbia-api/services/getManifestTextV2" -d "list=1.3.6.1.4.1.9328.50.3.336&includeAnnotation=false"

The API returns text that can be used as a manifest file for the NBIA Data Retriever.

downloadServerUrl=https://imaging-devcm.nci.nih.gov/nbia-download/servlet/DownloadServlet
includeAnnotation=false
noOfrRetry=4
databasketId=manifest-1523866570303.tcia
manifestVersion=3.0
ListOfSeriesToDownload=
1.3.6.1.4.1.9328.50.3.336

Creating a Manifest File Using the Shared List API

If you have a shared list, you can use the Shared List Query API to create a manifest file. Refer to the Shared List Query API documentation for instructions on how to use the API.

Example Manifest from Shared List Query 

curl -H "Authorization:Bearer a99171a1-b289-4700-9e4e-1bd73ce1bbb5" -k "http://localhost:8080/nbia-api/services/getManifestTextFromSharedList" -d "sharedList=scottslist&includeAnnotation=false"

The API returns text that can be used as a manifest file for the NBIA Data Retriever.

downloadServerUrl=https://imaging-devcm.nci.nih.gov/nbia-download/servlet/DownloadServlet
includeAnnotation=false
noOfrRetry=4
databasketId=manifest-1523866570303.tcia
manifestVersion=3.0
ListOfSeriesToDownload=
1.3.6.1.4.1.9328.50.3.336

Creating a Manifest File Using the JNLP Data Query API

If you have a JNLP file, you can use the JNLP Data Query API to create a manifest file. Refer to the JNLP Data Query API documentation for instructions on how to use the API.

Example Manifest from JNLP Data Query 

curl -H "Authorization:Bearer 3b2bf812-a97e-454e-af94-623b868a2955" -k "http://localhost:8080/nbia-api/services/getManifestFromJNLPFileData" -d "jnlpArgument=C:\Apps\nbia\apache-tomcat-7.0.68\temp\jnlp-data1521628213301.txt&includeAnnotation=false"

The API returns text that can be used as a manifest file for the NBIA Data Retriever.

downloadServerUrl=https://imaging-devcm.nci.nih.gov/nbia-download/servlet/DownloadServlet
includeAnnotation=false
noOfrRetry=4
databasketId=manifest-1523866570303.tcia
manifestVersion=3.0
ListOfSeriesToDownload=
1.3.6.1.4.1.9328.50.3.336

For more information about roles, see Creating a New NBIA User.

When a site submits images to NBIA, a user with admin privileges can run various reports to verify that the images have been received and to monitor the status of the submitted images. This is accomplished in NBIA by generating a report with this information.

To view submission reports, follow these steps:

1. Click Admin > View Submission Reports.
   The Submission Reports page appears.
   
   The Collection//Site section displays all collections for which you, as an Admin, have permissions to view.
2. Select a collection.
3. Enter a valid date range or select one by clicking the calendar icons.
4. Click the report type you want to run: Accrual, Image, or Annotation.
   The search begins and may take a few moments.

To assist in viewing the reports, use the following icons:

• In the report results in the upper right segment of the page, click the Help button () to learn details about the report type you selected.
• Click the arrow at the left of the section to hide () or show () the results.
• To view an expanded view of the image report results, click the Expand icon () preceding each row of the New Image or Corrected summaries.

The results display Count by Day details of the submissions. For example, for each day in the time frame, you can view a list of affected patient IDs, study instance UIDs and series instance UIDs.

Fields that appear on the report are described in the following table.

Image submission results display a count of patients, studies or series for or to which an image was submitted during the specified date range in the collection or site you selected. Fields that appear on the report are described in the following table.

The annotation submission report contains a count of annotations submitted and affected patient/study/series during the specified date range for that collection site. Fields that appear on the report are described in the following table.

For more information about roles, see Creating a New NBIA User.

When an image is uploaded to NBIA, it is not made public immediately. A curator takes it through a quality control process to ensure that no private patient data is available, the image is of good quality, and so forth. Using the QC tool as a curator, you can define search criteria to locate image series for you to evaluate. You can then evaluate the submission and assign the QC status to an image or image series.

Topics in this section:

The QC Status History Report appears, displaying all changes that have been made to the status of the series you selected.

Click Back to QC Tool to close this window and return to the QC tool.

For more information about roles, see Creating a New NBIA User.

This function is part of a two-tier deletion process. A super curator can approve the deletion of image series that have been identified as "To be deleted".

To approve series deletions, follow these steps:

1. Click Admin > Approve Deletions.
   The Approve Deletions page appears.
   
2. From the Collection(s) list, select a collection (site).
3. Optionally, enter Patient IDs. Separate multiple IDs by commas.
4. Click Submit to initiate a search for the series marked for deletion.

5. From the results, click View to review the detail for an individual series. From the page that opens, click Delete to approve the deletion. Click the Skip button to go to the next series.

   Tip

   If you click Skip, this signals that you do not approve the deletion. If that is so, you should generate a report to see who requested the deletion and work with that person to resolve any deletion disagreement.

6. For batch deletion, select the checkbox for one or more series and click Delete to approve the deletion.

Image series approved for deletion are still visible in the system, identified as "To Be Deleted". They are removed from the system at a system-configured time, such as at midnight (called an "off-line deletion"), unless a manual deletion (called an "online deletion") is performed. For more information, see Manually Deleting Image Series.

For more information about roles, see Creating a New NBIA User.

This function is part of a two-tier deletion process. You can execute the online deletion of image series that are approved for deletion. This immediately removes images that are approved for deletion rather than requiring you to wait for the next scheduled system-wide deletion job.

To manually delete series, follow these steps:

1. Click Admin > Perform Online Deletion.
   A list of image series that have been approved for deletion appears.

2. Click Delete to execute the real-time series removal.

   Deleting individual series?

   All series listed in this page are deleted. There is no way to specify individual series for online deletion.

For more information about roles, see Creating a New NBIA User.

This feature allows you as an administrator to enter a brief description for a collection so the NBIA user knows what type of data comprises the collection.

To edit a collection description, follow these steps:

1. Click Admin > Edit Collection Description.
   The Edit Collection Descriptions page appears.
   
2. From the Select Collection Name list, select a collection name.
3. In the text box, enter a description or edit an existing description for the collection. Use the text formatting tools to format the text, if you like. If appropriate, you can add a hyperlink to a resource such as a wiki with a longer description.

The description displays on the simple/advanced search screen when you click the (?) button next to the collection name.

For more information about roles, see Creating a New NBIA User.

A workflow is a business process that, in the case of NBIA, an image series must pass through before it is published. Since it is a business process, these steps must be defined first within an organization. NBIA allows you to change the visibility status of an image series. This visibility change is part of the definition of a workflow item. Workflow items can also trigger a web service call to a URL. When you define a workflow item, you specify a name for it, the type of action that will take place during it (such as a visibility change), which image collection and site are involved, and the URL of a web service if the information resulting from this workflow item should be sent to one.

You can create, edit, and delete workflow items

Creating a Workflow Item

Editing a Workflow Item

You can edit a workflow item's name and collection/site.

To edit a workflow item

1. Select Admin > Manage Workflow Items.
   The Manage Workflow Items page appears.
   
2. Click the in the row of the workflow item you want to edit.
   The Workflow Item page appears, showing the values already set for the workflow item you selected.
   
3. Edit the name, type, collection, site, or URL as needed, consulting Creating a Workflow Item for details on these steps.
4. Click Save.

Deleting a Workflow Item

To delete a workflow item

1. Select Admin > Manage Workflow Items.
   The Manage Workflow Items page appears.
   
2. Click in the row of the workflow item you want to delete.
   You are prompted to confirm the deletion.

1. Select Admin > Manage Workflow Items.
   The Manage Workflow Items page appears.
   
2. Click Create Workflow.
   The Workflow Item page appears.
   

   

3. In the Name box, specify a name for the new workflow item. The name cannot be longer than 50 characters.

4. From the Type list, select Visibility Change or New Series.

   
   

   • Select the Visibility Change option when editing an existing workflow item. A visibility change occurs when the workflow item triggers a web service call to the URL you have entered in the URL field on this page.

   • Select the New Series option if you want the result of this workflow item to create a new image series. You can add this new series to a collection in the next step.
     
     

5. From the Collection list, select an existing image collection to which this workflow item should apply. Existing image collections are in the Collection list.  If you need to create a new collection to apply to this workflow item, enter it in the New Collection for List box and then click Add to Collection List.
6. From the Site list, select an existing site. Existing sites are in the Site list. If you need to create a new site to apply to this workflow item, enter it in the New Site for List box and then click Add to Site List.
7. To send information in this workflow item to a web service, enter the web service's URL in the URL box.
8. Click Save.
   The new workflow item appears on the Manage Workflow Items page.

For more information about roles, see Creating a New NBIA User.

You can review and delete queries saved by users in NBIA.

Topics in this section: