Update External Identifier

If your documents are integrated with Hyland's OnBase, you can use the Update External Identifier to create a batch that populates the external identifiers for multiple documents at once. The external identifiers are required by Hyland's OnBase. This will associate the OnBase document type that was created with the Anthology Student document.

If you would rather add external identifiers for individual documents or you need to change an identifier that has already been assigned, refer to Documents.

Use the Process tab to filter the records and queue the batch job.

Use the History tab to review the status of all the batches, review the results of specific batches, and manage the batches.

Prerequisites

Authorizations:

  • Common - Processes - View

  • System Administration - Processes - Update External Identifier

Your institution must have configured Integration with Hyland's OnBase.

Access

Processes > System Administration > Update External Identifier

Create and Queue the Batch

Process Tab

  1. Specify the Selection Criteria to filter the records.

    CampusClosed Select the campus where the document is associated. If the document is configured for more than one campus, the same external identifier will be used for all the campuses where the document is associated.

    DMS ProviderClosed It is read-only and set to Hyland's OnBase as the software your institution uses for document integration.

    ModuleClosed The various categories that pertain to functional areas within an institution. For example, Academic Records, Financial Aid, and so on.

  2. Select Next.

    Anthology Student displays a list of the documents that do not have external identifiers assigned. The list does not contain documents where an identifier was already assigned manually or using this process.

  3. Review the values in the Results grid.

    CodeClosed The alphanumeric code assigned to the item by your institution. In most cases, codes must be unique. Select or assign the code for this item.

    Document NameClosed The name of the item (e.g., data set, batch, job, process, task, person, organization, entity, file).

    ModuleClosed The various categories that pertain to functional areas within an institution. For example, Academic Records, Financial Aid, and so on. If the list contains All, it includes all areas.

  4. Select Queue Update.

  5. Review or change the batch name and select Queue.

Anthology Student processes the batch and assigns the identifiers.

When the batch completes, Anthology Student displays the results on the History tab so that you can review the results and check for any exception messages.

History Tab

Anthology Student removes batches after 28 days. To keep the batch, use Export (Export button) on the toolbar.

  1. Review the record values.

    BatchClosed The name of the item (e.g., data set, batch, job, process, task, person, organization, entity, file).

    Created Closed The date when the item was created.

    DurationClosed The amount of time it took to process the job or batch.

    Number of DocumentsClosed Number of documents with proposed updates in the batch. You must select the batch to verify that all the documents were updated for the student.

    StartedClosed The date and time when the first job within the batch started executing.

    StatusClosed Indicates the status of processing for the student or item in the job. If all awards were successfully processed and approved, it displays Succeeded. If one or more awards were not approved, it displays Completed.

    Submitted ByClosed The name of the staff member who submitted the background job or batch for processing.

  2. Select the batch.

  3. Review the record values.

    CodeClosed The alphanumeric code assigned to the item by your institution. In most cases, codes must be unique. Select or assign the code for this item.

    Exception MessageClosed If an external identifier could not be assigned, the reason why.

    External IdentifierClosed External identifier is the document type reference received from the integrated environment (third-party). For Hyland's OnBase, it associates the OnBase document type that was created for the Anthology Student document.

    NameClosed The name of the item (e.g., data set, batch, job, process, task, person, organization, entity, file).

    Job CreatedClosed The date and time when the job was added to the background job queue.

    Job StartedClosed The date and time when the job was pulled from the queue and started executing. The start time for a job will be the same time or later than the start time for the batch.

    Job Status Closed The status of the job. Enqueued indicates the job is in the queue waiting to be executed. Scheduled indicates the job is scheduled to run at a future time. Processing indicates the job is running. Succeeded indicates the job was completed with no errors. Deleted indicates the job was completed with errors.

To display the configuration for a specific document, select the link in the Name column.