AvePoint Learn
Request an article
Contact support
Request an article
Contact support
English

    Home > Settings > Configure Stub Templates

    Download this article

    Configure Stub Templates

    Refer to the following steps to create a stub template:

    1. On the Stub template managementpage, click Create.

    2. Stub template name – Enter a name for this stub template.

    3. Stub file type – You can choose to leave the stub as a TXT or HTML file, or just leave a restore link for the stub. Before selecting the stub type, it is important to know that there is no perfect stub file type for Microsoft 365. Each file type can behave differently where it is viewed, for example in a SharePoint site compared to Microsoft Teams.

    4. Stub message – Enter a message that you want to display when users click the stub file. You can also insert tags into the stub message to provide additional information, such as:

      • File name

      • File path

      • Archived time

        The archived time is localized based on site settings, instead of the time zone configured in the AvePoint Opus system.

      • Rule name

      • Restore link

        This tag is included in the stub message by default.

      • External link

        This tag is available when the selected stub file type is HTML.

    5. Enable stub retention – Choose whether to enable retention for stubs. After enabling it, you need to define a specific retention period for stubs. By setting up an automated schedule, stubs will be automatically deleted once their retention period has expired. For detailed instructions on setting up job schedule, refer to Configure Schedule Settings.

    6. Lock each stub with the records label – Choose whether to lock stubs with a records label configured on the Settings > General settings page. For detailed instructions on configuring the records label, refer to Configure General Settings.

    7. Click Save to save the stub template.

    After creating a stub template, you can click the stub template name to open the stub template for viewing or updating.

    To delete a stub template, select the stub template, click Delete, and then click OK in the confirmation window to confirm your operation.

    The table below lists the pros and cons of each stub file type:

    Stub File TypeProsCons
    HTMLUsers can view the content information while opening the stub. This file type does not require enabling custom scripts in SharePoint Online.Users cannot directly click the restore link, but must right-click the link and open it with a new tab or window. Please note that, due to a Microsoft limitation, the restore link is not clickable within the Teams app. To access the restore link, open it in a web browser or directly from the SharePoint site.
    TXTUsers can view the content information while opening the stub. This file type does not require enabling custom scripts in SharePoint Online.There is limited support of style formatting in the stub file. Users cannot directly click or open the restore link left in the stub, but must copy and paste the link to a browser manually.
    Restore LinkUsers can be redirected to the ReCenter restore page from Teams or SharePoint directly.Users will bypass the stub that includes details and guidance on what happened to the content.