Getting Started Archives - Stilo https://www.stilo.com/docs/%knowledge_base%/getting-started/ experience XML in a whole new way | exceptional tools for structured content solutions Tue, 13 Apr 2021 19:11:00 +0000 en-US hourly 1 https://wordpress.org/?v=6.7.1 https://www.stilo.com/wp-content/uploads/2017/03/favicon-150x150.png Getting Started Archives - Stilo https://www.stilo.com/docs/%knowledge_base%/getting-started/ 32 32 Anatomy of the Dashboard https://www.stilo.com/docs/migrate/getting-started/anatomy-of-the-dashboard/ Mon, 15 Mar 2021 00:00:00 +0000 https://www.stilo.com/?post_type=docs&p=63883 The anatomy of the Migrate dashboard. Red Box Description 1 Site navigation buttons — These bring you to the main […]

The post Anatomy of the Dashboard appeared first on Stilo.

]]>

The anatomy of the Migrate dashboard.

anatomy of the dashboard

Red Box Description
1 Site navigation buttons — These bring you to the main screens of the Migrate dashboard.
2 Side bar — Side bars provide useful information and functionality appropriate to the screen you are currently on.
3 Action buttons — These buttons operate on the items selected in the table below.
4 Document link — Click here to go to the document details screen.
5 List — This is a listing of objects appropriate to the screen. In the image above, we see a listing of documents on the portal in the basket Kenora.
6 Number of entries — This displays the number of entries on the screen and the total number of entries in the current basket.
7 Page list — This displays the current page number and, if applicable, movement links to other pages.
8 Entries per page — This dropdown allows you to choose to display 10 (default), 25, 50, or 100 entries per page.
9 Top bar — The top bar displays the portal name; a link to Account Settings; a link to the Migrate Help files; a link to let you contact Migrate Support; and a Logout link.
10 Search bar — Type in the text area to locate files with your search characteristics.
11 Column headings — Click on a column heading to sort the table by that column.

  • Document, Basket, Type, Rule Set, and Target are sorted alphabetically on first click, then reverse-alphabetically on a second click.
  • The Credits column is sorted first in ascending order, then in descending order.
  • The Last Processed Time column is first sorted least recent to most recent, then on a second click is sorted most recent to least recent. (The most recent to least recent is the default sort used.)
  • The Processing Time column shows you how long the previous conversion took to complete. This column is not sortable.
  • The Status column (also not sortable) shows you the current status of each document. The three stages of the Migrate process are Analysis, Annotation, and Conversion, and there are messages for each stage. Each stage can fail, complete with messages, or complete successfully.

The post Anatomy of the Dashboard appeared first on Stilo.

]]>
Changing Your Password https://www.stilo.com/docs/migrate/getting-started/changing-your-password/ Mon, 15 Mar 2021 00:00:00 +0000 https://www.stilo.com/?post_type=docs&p=63951 To protect your documents, it is wise to set use a strong password for your user account, and to change […]

The post Changing Your Password appeared first on Stilo.

]]>
To protect your documents, it is wise to set use a strong password for your user account, and to change it regularly.

Procedure

  1. Click Account Settings in the top right corner.
  2. Enter your new password twice.
  3. Click Update Password.

Result

The password has been updated.

The post Changing Your Password appeared first on Stilo.

]]>
Credits https://www.stilo.com/docs/migrate/getting-started/credits/ Mon, 15 Mar 2021 00:00:00 +0000 https://www.stilo.com/?post_type=docs&p=63953 Migrate is a pay-as-you-use conversion service. Every document uploaded to the portal has an associated cost in credits which must […]

The post Credits appeared first on Stilo.

]]>
Migrate is a pay-as-you-use conversion service. Every document uploaded to the portal has an associated cost in credits which must be explicitly accepted before you can carry on with the conversion.

Migrate is a pay-as-you-use conversion service. Prepaid credits are made available on your portal. When you upload a document to the portal, Migrate analyzes it and determines a cost, in credits, for your document. Depending on your portal configuration, various document artifacts will be chargeable, such as:

  • tex
  • convert images
  • formulae

The charge for a document is shown in the dashboard on the Documents page. A finer breakdown of the credit charges for a document is shown in its document details page. Once you accept the charges for a document, you are free to work with it as much as you’d like. You can convert, adjust conversion rules, and download the document as many times as necessary. You will never be charged again for that document.

You can access a credit use report to see how credits have been used on your portal.

The post Credits appeared first on Stilo.

]]>
Accepting Credit Charges https://www.stilo.com/docs/migrate/getting-started/accepting-credit-charges/ Mon, 15 Mar 2021 00:00:00 +0000 https://www.stilo.com/?post_type=docs&p=63955 Before working with a document, you must accept to use the required number of pre-paid credits for that document. Once […]

The post Accepting Credit Charges appeared first on Stilo.

]]>
Before working with a document, you must accept to use the required number of pre-paid credits for that document.

Once a document is uploaded, Migrate analyzes and discovers many things about it. This allows Migrate to determine the credit cost of the document. For more information on how credit works see credits. For more information about Migrate’s analysis of your documents see viewing Migrate’s analysis of a document.

Procedure

    1. Go to the Documents page.
    2. Select the documents for which you would like to accept charges.
      • The credit cost for each document is listed in the Credits column of the table. If the number is black, credits have already been accepted. If the number is red, credits have not been applied to the document.
    3. Click Accept Charges.
      • Migrate will never charge you more than once for a given document. Even if you accidentally select documents that have already been paid for, and click on Accept Charges, Migrate will be sure to skip those documents.
      • A dialog box containing summarizing the credits to be used is displayed.
    4. Review the information presented in the Confirm Credit Usage dialog.
      • Press Accept to apply credits.
      • Press Decline to back out.

Result

  • Credits have been deducted from your portal and the Credit Summary sidebar has been updated to reflect this.
  • The credit cost for the selected documents now appears in black, rather than red.
  • You may now work with these documents, assigning them rule sets and targets, viewing them in the rules editor, and converting and downloading the results.

The post Accepting Credit Charges appeared first on Stilo.

]]>
Obtaining a Credit Use Report https://www.stilo.com/docs/migrate/getting-started/obtaining-a-credit-use-report/ Mon, 15 Mar 2021 00:00:00 +0000 https://www.stilo.com/?post_type=docs&p=63957 You can review your consumption of credits by viewing a credit use report. Procedure Click on Download Report in the Credit Summary sidebar […]

The post Obtaining a Credit Use Report appeared first on Stilo.

]]>
You can review your consumption of credits by viewing a credit use report.

Procedure

  1. Click on Download Report in the Credit Summary sidebar

  2. Save the zip file to your file system.

Result

A zip file containing the credit summary will be placed on your system.

Once you are done

Use a ZIP-compatible compression utility to unzip the downloaded package. The zip file contains two spreadsheets.

Spreadsheet Description
adjustments lists the credit purchases, refunds and grants that have occurred
documents provides credit consumption details for every document

 

The post Obtaining a Credit Use Report appeared first on Stilo.

]]>
Baskets https://www.stilo.com/docs/migrate/getting-started/baskets/ Mon, 15 Mar 2021 00:00:00 +0000 https://www.stilo.com/?post_type=docs&p=63959 Documents are placed into baskets in order to organize and de-clutter your dashboard. A basket is simply a container in […]

The post Baskets appeared first on Stilo.

]]>
Documents are placed into baskets in order to organize and de-clutter your dashboard.

A basket is simply a container in which you may place documents. This allows you to reduce the clutter that can build up in the dashboard as more and more documents are uploaded. A document may only belong to one basket at a time, though it need not be in any basket at all.

Baskets are commonly used to organize documents based on:

  • the user responsible for the document
  • workflow status (e.g. completed versus in-progress)
  • the documentation set to which it belongs
  • a combination of the above

Example: basket names

    • Benjamin’s documents
    • Model TX4000
    • Model TX4000 – in progress
    • Model TX4000 – completed

The post Baskets appeared first on Stilo.

]]>
Rule Sets https://www.stilo.com/docs/migrate/getting-started/rule-sets/ Mon, 15 Mar 2021 00:00:00 +0000 https://www.stilo.com/?post_type=docs&p=63961 Migrate allows you to control the conversion of your documents. By creating and managing rule sets you can ensure that […]

The post Rule Sets appeared first on Stilo.

]]>
Migrate allows you to control the conversion of your documents. By creating and managing rule sets you can ensure that each document is provided with the guidance appropriate for its successful conversion.

To guide the conversion of your document, you must create a rule set. The rule set instructs Migrate as to how various aspects of the input should be treated during conversion to the desired target format. A rule set is simply a named collection of rules. Rules are described in detail in the Rules Editor section of the Migrate documentation.

To edit a rule set, you use the rules editor (see Opening the Rules Editor). To manage your rules you use the dashboard. From the dashboard, you can:

  • clone rule sets,
  • delete rule sets,
  • associate rule sets to documents.

The post Rule Sets appeared first on Stilo.

]]>
Uploading Documents https://www.stilo.com/docs/migrate/getting-started/uploading-documents/ Mon, 15 Mar 2021 00:00:00 +0000 https://www.stilo.com/?post_type=docs&p=63963 The first step of the Migrate workflow consists of uploading your document (or documents) to the portal so that you […]

The post Uploading Documents appeared first on Stilo.

]]>
The first step of the Migrate workflow consists of uploading your document (or documents) to the portal so that you can work with it (or them).

Before you begin

Depending on the type of document you are uploading, you may need to prepare a package for your document. Details are provided for each document type under the Dashboard reference:

This topic explains how to upload documents to your portal.

Procedure

  1. Go to the Upload page.
  2. Click the Select Files button, and select files to upload. You can upload a single file or multiple files at this stage, and you can upload multiple file types at the same time. If you want to upload all files in a given directory, for example, you can select all files in the File Upload window and then click the Open button.
  3. Choose the file type from the combo box for each file you have uploaded. The options available will depend on your portal’s configuration.
  4. Click Upload when you have finished selecting file types for all of your documents.

Result

The document(s) will start uploading to your portal. The upload(s) will be finished when the upload dialog(s) have all disappeared. Once uploaded, Migrate will automatically analyze your document(s). Go to the Documents page to see your document(s).

If you have selected a current basket, your upload(s) will be placed in that basket for you.

The post Uploading Documents appeared first on Stilo.

]]>
Viewing Analysis Reports https://www.stilo.com/docs/migrate/getting-started/viewing-analysis-reports/ Mon, 15 Mar 2021 00:00:00 +0000 https://www.stilo.com/?post_type=docs&p=63965 Migrate generates an analysis report immediately after a document has been uploaded. You can view this report from the document’s […]

The post Viewing Analysis Reports appeared first on Stilo.

]]>
Migrate generates an analysis report immediately after a document has been uploaded. You can view this report from the document’s details page.

Before you begin

The document must have been imported successfully into Migrate.

Procedure

  1. Go to the Documents page.
  2. From the dashboard, click on the name of the document for which you would like to see an analysis report.
  3. You have been taken to the document details page for the document you have selected.
  4. In the left side bar, click the show/hide report link.

The post Viewing Analysis Reports appeared first on Stilo.

]]>
Structure of a FrameMaker Book Upload package https://www.stilo.com/docs/migrate/getting-started/structure-of-a-framemaker-book-upload-package/ Mon, 15 Mar 2021 00:00:00 +0000 https://www.stilo.com/?post_type=docs&p=63967 A FrameMaker book consists of multiple files, all of which must be provided to Migrate. You must therefore prepare a […]

The post Structure of a FrameMaker Book Upload package appeared first on Stilo.

]]>
A FrameMaker book consists of multiple files, all of which must be provided to Migrate. You must therefore prepare a zip package to upload to your portal.

FrameMaker documents must be uploaded in the MIF interchange format for processing by Migrate. When uploading a book, all constituent chapters as well as the book file itself must be in MIF format.

The zip file must contain the following files.

File Description
bookfilename.txt This file must contain nothing but the name of the MIF file in the upload package corresponding to the FrameMaker book file.
FrameMaker book file The FrameMaker book file itself in MIF format.
FrameMaker documents The FrameMaker documents, all in MIF format. These documents may be placed in subdirectories, but must match with the book file.

It is possible that your portal requires that additional files be included in the upload package due to customer-specific configuration.

It is not necessary to include image files with your upload.

The post Structure of a FrameMaker Book Upload package appeared first on Stilo.

]]>