Set up SmartReferences in Typefi Orion Compass

Note

This article is for existing eXtyles customers migrating to Typefi Orion. For Cloud environments, your Typefi team configures SmartReferences on your behalf. For Workgroup and Desktop environments, your Local Administrator with the Manage Configuration privilege performs the steps in this article.

SmartReferences automatically corrects, links, and formats your citations and bibliographic references using Edifix with PubMed® and Crossref™. SmartReferences is powered by the SmartRefs plug-in and runs as a server-side job.

Gather requirements

Before SmartReferences configuration begins, you'll work with your Typefi team to confirm the following for each publication:

• Reference style requirements for each publication
• Sample content with representative references
• Paragraph style names that identify reference paragraphs in your documents

Prerequisites

Workgroup and Desktop: Before SmartReferences configuration begins, ensure your IT or local administrator has completed the following in Typefi Server:

1. Installed a valid Typefi license (contains the installation ID required for SmartReferences).
2. Configured a telemetry token. See Send telemetry data.

If the telemetry token is missing, you'll see an error when using SmartReferences in Typefi Orion for Microsoft Word. If you don't have a telemetry token, contact your Solutions Consultant.

Once the relevant styles are identified, your Typefi team configures the SmartReferences workflow in Typefi Server to:

• Apply your selected citation style to references
• Identify reference paragraphs using your specified paragraph styles
• Enable the appropriate reference processing sources (PubMed®, Crossref™, and others)

Coming soon

Step-by-step guidance for creating and managing your SmartReferences workflow in Typefi Server for Workgroup and Desktop environments will be available soon.

Set up your reference style

Your Typefi team will:

1. Analyse your journal's reference style requirements
2. Select the appropriate Edifix reference style for each publication
3. Create a workflow in Typefi Server with the SmartRefs plug-in
4. Add the SmartReferences workflow to Orion Compass

Add a SmartReferences workflow

At this stage, your Typefi team or Local Administrator adds the workflow to Orion Compass. The workflow file is stored in a SmartReferences folder in Typefi Server filestore. Only one SmartReferences workflow is supported per configuration.

To add a workflow:

1. Sign in to Typefi Server with admin credentials.
   • Workgroup or Desktop: http://localhost:8080
2. Select the Switch App (9-dot menu) in the top-right corner, then select Orion Compass.
3. Navigate to the Global Settings menu (Orion Compass → Configuration Options → Global Settings) and select SmartReferences in the left menu.
4. Click Add Workflow.
5. In the Choose Workflow dialog, navigate to the SmartReferences folder (for example, /Files/Orion workflows/SmartReferences) and select the workflow.
6. Click Select to add the workflow.
7. Click Save.

Validation and training

After adding the SmartReferences workflow to Orion Compass, your Typefi team processes sample documents, reviews reference formatting and linking results with you, and confirms output meets your journal's requirements. Your Typefi team makes any adjustments needed before training your editorial team on using SmartReferences.

Next steps

After onboarding, your team can start using SmartReferences from the Typefi Orion for Microsoft Word ribbon. For guidance, see SmartReferences.