SIX Flex · SIX Flex . User Guide SIX Flex delivers reference, market, regulation and tax data in...

SIX Flex

User Guide

SIX Flex delivers reference, market, regulation and tax data in easy-to-consume data files. Files are delivered on demand and/or on a regular basis.

This guide will show you the ins and outs of SIX Flex, from the first login to the day-to-day use of the application.

1 SIX Financial Information 15.09.2018

Contents

First time login .............................................................................................................................................. 2

SIX Home ....................................................................................................................................................... 4

SIX Flex ........................................................................................................................................................... 5

Delivery interface overview ......................................................................................................................... 6

Create a subscription ................................................................................................................................... 7

Deliver now .................................................................................................................................................. 11

Rename a subscription .............................................................................................................................. 12

Archive a subscription ............................................................................................................................... 12

Deliveries ..................................................................................................................................................... 13

Preferences ................................................................................................................................................. 15

Notifications settings ............................................................................................................................ 15

Corporate Action Package options .......................................................................................................... 16

FTP Access ................................................................................................................................................... 18

Delivery File Names .................................................................................................................................... 20

Selection File Format .................................................................................................................................. 22

Data File Format ......................................................................................................................................... 23

Report file format ....................................................................................................................................... 23

Appendix ...................................................................................................................................................... 25

Report file – statuses ............................................................................................................................. 25

List of identifier code schemes ............................................................................................................ 26


First time login As soon as your SIX Flex user account is created you will receive a Welcome email, which will guide you through the first login process.

Welcome email

Begin by clicking the link.

Choose your password

Enter your password twice and click on the arrow to navigate to the login page

Note: For security reasons the welcome email is only valid 7 days. If you are unable to set up before the 7 days are up, you will have to request a new welcome email by contacting SIX support:

[email protected]


Login page

Type your email address and password and click on the arrow to login and navigate to SIX Home page.

Note 1: “Customer and User ID” option applies only for the technical user to configure the FTP password.

Note 2: “You are already logged in…” message may appear when you are connected on another machine or browser. Click on the arrow button to connect on this machine and terminate the session on the other machine or browser.

Top Tip: To easily access SIX Flex we recommend you to bookmark the following address: client-portal.six-financial-information.com.

https://client-portal.six-financial-information.com/


SIX Home After login, the SIX Home page presents all applications you have access to.

1 Delivery is the entry point to SIX Flex.

2 Last content delivered by SIX Flex.

3 Inbox is the place where you can raise questions, report data issues, or request instrument opening.

4 Latest update in your Inbox.

5 Notifications: SIX messages about product changes, data changes, product releases and relevant client information.

6 Latest notification sent to you.

7 Menu to update your profile or logout.

Top Tip: Select Notifications to customize what product, data or news updates you would like to receive. Use the Subscriptions link on the notifications page to edit this.

Note: you can change your password by using the link at the bottom of your profile page.

1 2

3 4

5 6

7


SIX Flex Click on Delivery on the home page to access the SIX Flex Delivery user interface. Here is a breakdown of the vocabulary needed to navigate SIX Flex.

To retrieve data, you have to create a subscription. A subscription is defined by a selection, a package, a scheduling and the format settings.

The format settings define the number and date format in the file.

A selection is a list of listings, instruments or companies you are interested in.

A package is a list of fields that meet key business activities (Cross Reference identifiers, Valuation Price, Corporate Action, MiFID II, ToB…).

A field is a unique data element. You can find the field description in the dictionary or in the package views.

Finally, a Delivery is all the delivered files for a Subscription at a scheduled time or for an “on demand” request.

Sn

Se

Pk

Fd

De


Delivery interface overview

1

2

3

6

4

8 7

5

Subscription:

• Latest: list of subscription sorted by latest event. An event is either a subscription configuration change or a delivery notification

• All subscriptions: list of subscriptions sorted in alphabetical order • Archived: a list of archived subscriptions

2 Deliveries: list of delivery files (from latest to oldest)

3 Selections: list of the selections you defined

4 Packages and dictionary provides detailed descriptions on packages and fields.

6 About contains product information and links to support documentation

7 Click on the + button to create a new subscription

8 All/Mine filter: displays only the subscriptions you created (mine) or all subscriptions you have access to (all). The filter also applies to deliveries view, and displays all deliveries that belong to the subscriptions you created (mine)

1

5 Preferences contains product configuration settings


Create a subscription

1 Start by clicking on the + button to create a subscription

1 The package category

2 Package name.

3 Link to preview the content of the package

4 Progress indicator, the check mark changes to blue when this section is completed

5 Restricted indicates that your company did not subscribe to this package. The content of a restricted package can be explored. However it is not possible to create a subscription using a restricted package.

1

1

2

3

4

5


Once the package is selected, click on the section below to expand the selection configuration.

Once your selection is defined, move onto the schedule section.

1 Select an already uploaded selection

2 Upload a new selection

3 The quick guide helps you to define a selection

1 By default, the subscription is on demand, meaning there is no recurrent delivery

2 Click on the buttons to schedule a daily, weekly or monthly delivery. If you would like more scheduled delivery configurations, you can easily add some by clicking again on the daily, weekly or monthly buttons

1 2

3

1

2


In the example below, two daily deliveries are configured. The first delivery will be at 09:00 and the second at 18:00.

Below are two examples of weekly and monthly schedule.

1 Configure a delivery on all days (from Monday to Sunday) or weekdays (Monday to Friday)

2 Define when the subscription processing starts

3 Define the time zone of your schedule time

1 2 3


In the next section, define the CSV (Character Separated Values) output file format.

Finalize the subscription creation by clicking on add or subscribe at the bottom right.

1 The CSV separator

2 The date format and the separator for the dates

3 How the decimal part of numbers shall be separated

1

2

3


Deliver now Once the subscription is created click on Deliver now to get an immediate delivery.

1 A delivery happened 3 hours ago. Expand this line to discover the delivered files

2 Activity displays the history of all the events for a given subscription. It allows you to track all the definition changes and deliveries

3 Definition gives you access to the editor you discovered during creation. You can change package and selection, define a new schedule or update the delivery format

4 Click here to request an immediate delivery of the subscription

Note: Deliver now button is hidden when a scheduling is defined and the delivery mode is Updates. This is to prevent accidental deliveries of full deliveries

4

1

4 2 3


Rename a subscription The name of a subscription is initially composed by using the selection file name and the package used in the subscription. Once the subscription is created, it can be renamed.

To name a subscription select the option Rename form the card menu

Note: changing a subscription name affects the name of the subscription in the user interface as well as the delivery file names (cf Delivery File Names).

Archive a subscription Archiving a subscription is the first step before deleting it.

When a subscription is archived, it will move into the archived view and its scheduled deliveries are paused.

To archive a subscription select the option Move to archive from the card menu

Once archived, the same menu on the archived subscription allows you to unarchive a subscription. The subscription schedule configuration is then active again.

1 2

1

2

1 2

2 1


Deliveries The delivery view lists all deliveries in reverse chronological order.

1 Activity that triggered the delivery. The message either shows the schedule that triggered the delivery or “on demand” followed by the user name who requested an immediate delivery via the Deliver now button

3 Date and time of the scheduling in your machine timezone

2 Number of items (listings, instruments) delivered compared to the total number of the requested items in the selection file. On a complete delivery, only the total number of items is presented

4 We deliver two files per content. A data file that only contains data and the report file that in addition contains all error messages and statistics for the delivery

Note: in the above example, the Corporate Action package delivers multiple data files with their respective report files

5 Click all files to download all files grouped in a single ZIP file

1 2 3

4

5


When a delivery fails an error delivery card is displayed in the list as illustrated below.

Should this happen, you can directly open the inbox by clicking on the Support button.

In Inbox create a support ticket and mention the OutputID. SIX Support will get in touch with you to assist you.


Preferences Preferences contains all your preference settings.

Notifications settings These settings enable you to control the notification emails you will receive. These settings only apply to the subscription you created.

With administrative rights you can configure notifications for all subscriptions and send them to email addresses of your choice.

1

2

1 Failed deliveries send emails when the scheduled deliveries of your subscriptions are failing

2 Successful deliveries send emails when the scheduled deliveries of your subscriptions are successful

Note: emails will not be sent when clicking on the Deliver now button.


Corporate Action Package options

Choose among the following delivery options:

• Updates sends a full delivery followed by update deliveries.

A full delivery consists of upcoming and past events. For past events we retrieve 90 days of history, based on the significant date of the events. An update contains all modified events since the last delivery.

Scheduled subscriptions (daily, weekly, monthly) only deliver a full delivery on the first delivery, afterwards they deliver updates. In addition, when you add new instruments, the update will include the equivalent information of a full delivery for the added instruments.

The full delivery and update format is identical, in order to ease data integration.

On-demand subscriptions always deliver a full delivery, you can request it by clicking the Deliver now button. Setting a scheduled subscription for Corporate Action hides the Deliver now button.

• Snapshots always send full delivery

Whether subscriptions are scheduled or not, this modes always deliver a full delivery.


• Range sends all corporate action events that fall in a date range.

You can define the date range by choosing the number of days before and after. Every time the subscription is delivered, days before and days after are applied and events with a significant date in the defined range appear in the result.

The Significant date is a SIX calculated date.

We create the significant date in order to have one reference date across all event types. The logic takes all available dates for a given event type and chooses the most significant one.

The focus of the logic is to promote business relevant dates as, for example, payment dates, effective dates.


FTP Access The FTP access allows you to download delivered files and upload selection files, as well as fully automate the processing of data delivered by SIX Flex. The access to FTP is restricted to the technical user.

1. Configure the FTP password

Connect to https://client-portal.six-financial-information.com

Login as the technical user using the Customer Id authentication and the information delivered to you via email.

Click on the Technical User in the top right corner, and select profile

Select change the FTP password at the bottom of the




2. Configure the FTP connection

The FTP host is: ftp.tkfweb.com

The username is the Customer ID and the user ID separated by the character “-“.

Examples:

CH12345-flex

Where CH12345 is the Customer ID and flex is the technical user name

SIX recommends to use secured FTP connection. Here are the connection settings:

• SFTP host: sftp.tkfweb.com • SFTP port: 2222 • Fingerprint:

o SHA-256: 3rG7Bqw0fFrpqHep2KNyhceEeZkQMyzexO62cYmYH1Y= o MD5: 2f:4d:2b:b8:32:c9:ce:9e:5f:3c:f1:ec:41:db:db:5f

Enter the technical administrator password and chose your new FTP password.

Click Change.

ftp://ftp.tkfweb.com/


Delivery File Names A delivery consists of a minimum of three files:

• A data file, which only contains data. This file is designed for programmatic purposes • A report file, which is a readable file that contains data and statuses on the data • A ZIP file, which is a zip compressed file that contains all the delivered files (data and

reporting files).

The delivery file name is slightly different depending of the requested package.

Below is an example of a data file for the Cross Reference package.

The report file name is similar, except that the file names ends with “_report”:

• 134_Nasdaq-CrossReferences_20180827T1200Z_report.csv

The zip filename is the same as the data file, except for the extension (.zip instead of .csv).

• 134_Nasdaq-CrossReferences_20180827T1200Z.zip

The Corporate Action Package generates five pairs of data and report files. To differentiate the filenames, a file content qualifier is added after the unique subscription identifier.

134_Nasdaq-CrossReferences_20180827T1200Z.csv

Unique subscription identifier Date and time of the delivery in ISO8601 format – the zone is UTC

Subscription name


The file content qualifier values are: PAYMENTSTRUCTURE, DISTRIBUTION, MANDATORY, VOLUNTARY and MEETING.

Examples of data file names are:

• 134_PAYMENTSTRUCTURE_Nasdaq-CorporateActions_20171120T133300Z.csv • 134_DISTRIBUTION_Nasdaq-CorporateActions_20171120T133300Z.csv • 134_MANDATORY_Nasdaq-CorporateActions_20171120T133300Z.csv • 134_VOLUNTARY_Nasdaq-CorporateActions_20171120T133300Z.csv • 134_MEETING_Nasdaq-CorporateActions_20171120T133300Z.csv

Examples of the report files names are:

• 134_PAYMENTSTRUCTURE_Nasdaq-CorporateActions_20171120T133300Z_report.csv • 134_DISTRIBUTION_Nasdaq-CorporateActions_20171120T133300Z_report.csv • 134_MANDATORY_Nasdaq-CorporateActions_20171120T133300Z_report.csv • 134_VOLUNTARY_Nasdaq-CorporateActions_20171120T133300Z_report.csv • 134_MEETING_Nasdaq-CorporateActions_20171120T133300Z_report.csv

An example of the zip file name is:

• 134_Nasdaq-CorporateActions_20171120T133300Z.zip

134_DISTRIBUTION_Nasdaq-CorporateActions_20180827T1200Z.csv

Unique subscription identifier Date and time of the delivery in ISO8601 format – the zone is UTC

Subscription name File content qualifier


Selection File Format The selection file format is a CSV (Character Separated Values) with a header row in the first line. SIX Flex supports the following separators: comma (“,”), semicolon (“;”) , tabulation and the pipe character (“|”).

The first line must contains the following headers (separated by a semicolon character in the example below):

• identifierScheme;identifier;BC

The following lines must contain values that match the header for that column. The first value must specify the type of code you want to use (ISIN, SEDOL, … find the full list in the appendix), the second value is the code identifier and the third value is optional and should be in the SIX Market Code Numerical BC . When the SIX Market Code Numerical BC is not provided, SIX Flex returns data on all markets relevant for the identifier. The SIX Market Code Numerical BC is mandatory for ticker and listing codes (TKH and TKL identifier schemes).

Here is an example of Selection file:

identifierScheme;identifier;BC DE;A1EWWW;4 GB;BD6V6X2;6 ISIN; CH0003846729;201 CH;4910811;254

As the content of the BC column is optional you can leave the value blank. In the example below, the value is not defined for the first two instruments:

identifierScheme;identifier;BC DE;A1EWWW; GB;BD6V6X2; ISIN;CH0003846729;201 CH;4910811;254


Data File Format Data file format is CSV (Character Separated Values) with a header row on the first line.

The first headers refers to the selection file entries, and are named:

• identifierScheme • identifier • BC The following headers are named with the field technical name of the package. When reading a data file you must take into account the headers, as the column order may change and columns can be added to the package.

Screenshot of a data file displayed in Microsoft Excel.

Report file format The Report File Format is CSV (Character Separated Values) format. It delivers the content of the data file and provides metadata describing the delivery and explanations when some content is not delivered.

Important: the report file aims to help you to understand the content delivered and does not aim to be used for data ingestion, The file format may change without further communication.

The first two lines of the report files contains general metadata on the delivery such as:

• Production end: date and time of the delivery. • Total: contains the total number of requested instruments, listings or companies identifiers. • Delivered: this number indicates the number of instruments, listings or companies for which

data are delivered. • Not delivered: is the number of instruments, listings or companies identifiers for which no

data is delivered. • Column count: correspond to the number of fields in the package


• Cdm version: is the version of the Client Data Model. The Client Data Model includes the field dictionary and the packages.

• Selection name: name of the selection used to generate the delivery. • Package name: name of the package used to generate the delivery. • There could be some additional columns that report specific parameters of the package.

Line three is empty.

From line four onwards you will get the same structure as in the data file with additional information. The report file contains all identifiers specified in your selections and adds a status column. The status column indicates the state of the delivery for each instrument. The exhaustive list of statuses is available in the appendix.

In the report, the value of a field is blank when there is no data, NotAuthorized when you are not entitled, otherwise the value.


Appendix Report file – statuses

Status Description

UnknownIdentifier The identifier in column Indentifier does not exist in SIX database.

UnknownBC The market identifier in column BC does not exist in SIX database.

UnknownIdentifierScheme The identifier code scheme in column IdentifierScheme is not recognized by SIX Flex.

NotAuthorizedIdentifierScheme You are not authorized to use this identifierScheme in this context (e.g. SEDOL or CUSIP based ISIN)

NotAuthorized You are not authorized for this content.

NotExistForBC The identifier does not exist for the specified market.

NoEvent When an initial load is delivered, NoEvent specifies there is no corporate action event.

NoUpdate There has been no update (applies to delta delivery only)

Delivered Data has been delivered.

Duplicate This status indicates that the exact same identifier is present multiple times in the selection file. The first occurrence has a standard status and the subsequent ones have the Duplicate status.

MissingBC No value was provided in the BC column. The BC is mandatory when using TKH and TKL codes.


List of identifier code schemes

Identifier code scheme Description

ISIN International Instrument Identifier

CH Swiss Valor Number

AT Austrian Number

B2 FIGI Global Share Class ID

BE Belgium Number

CA Canadian CUSIP

DE German WPK

DK Danish Number

GB UK Sedol

H Hong Kong Issue Number

IT Italian Number

J Japanese Number TSE Code

JP Japanese Number SICC

NL Dutch Number

NO Norwegian Number

TKH Trading Symbol

TKL Listing Symbol

U CUSIP International number

US US CUSIP

SIX Flex · SIX Flex . User Guide SIX Flex delivers reference, market, regulation and tax data in...

Documents

Transcript of SIX Flex · SIX Flex . User Guide SIX Flex delivers reference, market, regulation and tax data in...