Creating & Cloning Documents

Whether you would like to start a new document title, or add a new version of an existing document, you always start the same way - click this button in the Issuer that owns the document.

Figure: Document or version creation starts here
Figure: Document or version creation starts here

Cloning An Existing Document Version

Once you have onboarded to the platform and uploaded your initial set of documents, this is the most common task.

  1. Click “Start or Upload Document” from the Issuer page.
  2. Choose “I want to add a new version of an existing online document title” then “I want to clone an existing version into a new one”.
  3. Choose the document and version that you wish to clone from.
  4. Set the new version number and add a summary and description if you wish.
  5. Click CLONE

This clone action will also automatically clone all certification scenarios ready for adjustment.

Starting (or Importing) A New Document

💡 Brand New Documents Only

This action is designed for new documents, not cloning an existing version. Use cloning an existing version for that.

  1. Click “Start or Upload Document” from the Issuer page.
  2. Choose “I want to create a new editable, online document” and indicate whether you are starting from scratch or importing a machine-readable document.
  3. On the next step, enter the document and version details (these will be pre-populated from FinSpec).
  4. Click START

ℹ️ Protocol

You are able to set the document protocol when going through this process. The platform can - of course - be used to manage non-API documents; simply select “Not an API document”.

If you are importing a FinSpec document which contains conformance capabilities, then these should be imported automatically. Otherwise, you will need to add these manually once you have added some messages. During the set-up process, you may specify the default conformance identifier (FIX TargetCompID), which will then set up the Service ready for conformance.

Uploading Static Documents

The platform can be used to maintain versioned PDF documents for central storage, versioning and display only.

💡 Suitable For Any PDF

Most trading firms have both inbound and outbound APIs, so why not use this function to store the PDFs that you’ve been given by partners? This avoids files scattered across shared drives, JIRA etc., and makes them easily accessible to the whole team.

  1. Click “Start or Upload Document” from the Issuer page.
  2. Choose “I want to store a read-only, downloadable file” and indicate if this is a new title or a new version of an existing title.
  3. On the next step, complete the document and version details.
  4. Finally, choose the file and read the disclaimer.
  5. Click UPLOAD

ℹ️ Future extension

This function is currently only available for PDFs. We intend to expand it over time, however, to allow storage and versioning of any sort of asset, including executables.

Frequently Asked Questions

Why can't I clone an existing document into a completely new title?

We understand this is today’s Word-based workflow: you need a new document for your new API, so you simply open an existing file and use “Save As…”.

The copying part is completely understandable, but what follows next is less attractive: you either start mass-deleting material, or you attempt to adjust the existing material to make it fit. The former (mass delete) can be better achieved with an intentional copy action. The latter (tweak) is dangerous, as sections get overlooked and the document becomes incoherent.

This is an area of active change, however, and so we may offer this in the future.

How can I access the timeline of a document?

The latest DRAFT, ACTIVE and FINAL (published) versions of a document can be found on the relevant issuer page.

You can access the full timeline by clicking on the icon in the left-hand sidebar of any version within the series.