SHIPDEX IS

making maintenance,
and related processes, much easier.

As equipment onboard ships gets more and more complex and sophisticated, so does the work of maintaining it. Maintenance tasks need to follow precise instructions, use precise spare parts. Just like maintaining a modern car, compared to doing it 20 years ago. And that means people doing the maintenance work, and spare part ordering, need to have very quickly and exactly the right information they need.

This information is provided by the shipyards and equipment manufacturers, but up to now, it has been provided on paper or in pdf format. Such kind of information needs to be either photocopied and filed, or retyped into IT systems (ERP, CMMS, etc.). It is very easy that important instructions and data to get lost, or full of errors.

Technical information in Shipdex-D (Documentation) format means to get “electronic, structured and standardized information instead of pages of information (in paper or pdf format)”

In addition, the new Shipdex-F (in-service data Feedback) supports and standardizes the electronic exchange of products’ in-service data feedback.

Shipdex-F and Shipdex-D, allow to improve the whole products’ Life Cycle Management.

Shipdex protocol is a non-proprietary open standard to exchange electronic data about descriptive, operational, maintenance instructions, catalogues, and in-service maintenance data feedback among all the maritime stakeholders. As an open standard, nobody profits or controls it. The non-profit Shipdex organization is in charge to maintain and improve the whole Shipdex protocol.

Shipdex-D is based on the standard S1000D (www.s1000d.org)  and Shipdex-F is based on the standard S5000F (www.s5000f.org) both used in aviation and defence sector since many years ago.

History

History

The reason to develop a common and standardized Protocol for exchanging data resides on the fact that shipping companies were receiving from manufacturers technical manuals in different formats, different structures and different data quality.
This situation created several troubles to end users in terms of information comprehension and electronic usage.
For instance, end users need to store paper manuals in dedicated rooms or are obliged to use different viewers (or browsers) to visualise electronic manuals supplied in HTML, WORD, XML or PDF formats.

Moreover, since most shipping companies are utilizing Computerized Maintenance Management Systems (CMMS) and Enterprise Resource Planning (ERP) software applications to manage and optimize maintenance and material purchase processes, a standard data exchange protocol allowing databases automatic generation was deemed necessary. Therefore the Shipdex™ protocol is dealing with technical information and the technical manuals must be considered just as one of the possible output from a Shipdex™ dataset.

In 2007 – 2008 a group of ship-owners, manufacturers and an IT company organized some meetings to confirm the will to develop a common and shared Data Exchange Protocol whose name was decided to be Shipdex™. All the former Founder Members companies agreed to develop the “Shipdex™ Data Exchange Protocol”.
The very first Shipdex 1.0 issue was released in 2008.

In 2019 the Shipdex organization decided to include into the Shipdex protocol the possibility to standardize the in-service data feedback for all the products installed on-board the ships. It was decided to base the new Shipdex-F (Feedback) on the aero-space and defence S5000F standard and to implement, as a first step, the “Maintenance Analysis” data feedback area.

Shipdex-F 1.0 was released in January 2023 and will be continuously improved based on requests coming from the maritime actors.

Scope

Shipdex-D covers technical data exchange in any sea projects.
This means that Shipdex Protocol is open to any company/organization which wishes to use it and can be implemented by anyone on different Information Technology systems. Information produced in accordance with Shipdex-D is achieved in a modular form, called “Data Module”, which is defined as “the smallest self-contained information unit within a Shipdex™ dataset”. Shipdex™ Protocol defines Data Modules as containers for data exchange. The Shipdex dataset is the collection of all the information (data modules, information objects and external documents) related to a given product in a given configuration.

A Data Module contains the following kind of information:

  • An identification and status section with all identification and quality assurance information
  • A content section, which is different, depending on the Data Module type.

The Data Module types that Shipdex™ Protocol makes use are:

  • Descriptive and operational
  • Procedural
  • Spare parts, support equipment and consumables catalogues (IPD)
  • Troubleshooting
  • Maintenance Planning
  • Publication
  • Comment
  • SCO content
  • Learning
  • SCO Content Package Module (SCPM)

The above Data Module types are governed by the following S1000 issue 2.3 xml schemas:

  • Descript.xsd (Descriptive, operational and troubleshooting)
  • Proced.xsd (procedural)
  • ipd.xsd (Illustrated parts data)
  • schedule.xsd (Maintenance Planning)
  • pm.xsd (Publication)
  • comment.xsd (Comment)

and by the following S1000D issue 4.2 xml schemas:

  • scocontent.xsd (SCO content)
  • learning.xsd (Learning)
  • scormcontentpackage.xsd (SCO Content Package Module)
  • lom.xsd (to be used to validate SCPM data modules)

that are available for a free download on www.s1000d.org

All Data Modules that are applicable to different Products may be gathered and managed in a database, which is hereafter referred to as the Common Source DataBase (CSDB).

Information is not duplicated in the CSDB though individual Data Modules can be used many times in the output. Savings are therefore made in the maintenance of the data in that it only needs to be changed once, whilst the changed information appears throughout the outputs.

Shipdex-D is based on the aero-space and defence S1000D specification (www.s1000d.org) sponsored by ATA e-Business Program, AIA and ASD organizations.

Shipdex-F covers in-service data feedback exchange in any sea projects and, at this stage, is mostly focused to manage maintenance analysis data feedback. Future Shipdex-F improvements could cover different areas as:

  • Life cycle cost analysis
  • In-service environment
  • Environmental impact and disposal data
  • Others

Shipdex-F is based on the aero-space and defence S5000F specification (www.s5000f.org) sponsored by AIA and ASD organizations

Main Benefits

  • Data interoperability at data level, through use of mandatory schemas etc.
  • Non-proprietary specification and based on open standards
  • Ease of data exchange, using small xml based files structures
  • Possibility to add extra documentation features such as Link mechanisms etc., enabling better end user experience
  • Focused to produce objects of information, instead of the traditional paper bound constraints
  • Enabled to focus specifically on data
  • Layout is not included in Shipdex data structure

Authoring benefits

  • Re-use of data (in a modular format) allows to save up to 40% of data production time
  • Reduction in update costs, due to use of data module concept of up to 30%
  • Module Uniqueness (Task /Description), allows task orientated definition
  • Compliant Authoring tools available, multiple vendor support

Life Cycle benefits

  • Reduced creation and update costs, thanks to data re-use
  • Lower document distribution costs, multiple methods of delivery available
  • Wider access and more efficient retrieval of the documentation by the end user, multiple methods of delivery available
  • Easy filtering of information through the (optional) Common Source DataBase (CSDB)
  • Increased operational readiness through reduced MTTR, through more focused maintenance
  • Increase in data integrity and the generation of better quality documents, through data integration and data module concept
  • Improvement of the product by modifications and retrofit activities
  • Enhancement of the maintenance and support concept
  • Cheaper products and services
  • Improved safety
  • Environmental benefits
  • Maritime Authorities wider involvement

Common Source DataBase (CSDB)

This is the “store” where Shipdex data should be stored. CSDB is the most important technical documents repository where all the Shipdex data can be stored together with all the updates. Applying filters it is possible to retrieve required information that can be used to:

  • Export towards other IT systems (ERP, PMS, etc)
  • Produce Shipdex datasets
  • Publish selected data in the form of pdf manuals or Interactive Electronic Technical Publications (ERP)
  • Publish SCORM compliant CBTs

However Shipdex does not define its functionalities. Shipdex just recommend that there is a requirement to hold and manage the data modules produced in Shipdex format.

History

The reason to develop a common and standardized Protocol for exchanging data resides on the fact that shipping companies were receiving from manufacturers technical manuals in different formats, different structures and different data quality.
This situation created several troubles to end users in terms of information comprehension and electronic usage.
For instance, end users need to store paper manuals in dedicated rooms or are obliged to use different viewers (or browsers) to visualise electronic manuals supplied in HTML, WORD, XML or PDF formats.

Moreover, since most shipping companies are utilizing Computerized Maintenance Management Systems (CMMS) and Enterprise Resource Planning (ERP) software applications to manage and optimize maintenance and material purchase processes, a standard data exchange protocol allowing databases automatic generation was deemed necessary. Therefore the Shipdex™ protocol is dealing with technical information and the technical manuals must be considered just as one of the possible output from a Shipdex™ dataset.

In 2007 – 2008 a group of ship-owners, manufacturers and an IT company organized some meetings to confirm the will to develop a common and shared Data Exchange Protocol whose name was decided to be Shipdex™. All the former Founder Members companies agreed to develop the “Shipdex™ Data Exchange Protocol”.
The very first Shipdex 1.0 issue was released in 2008.

Scope

Shipdex™ Protocol covers technical data exchange in any sea projects.
This means that Shipdex Protocol is open to any company/organization which wishes to use it and can be implemented by anyone on different Information Technology systems. Information produced in accordance with Shipdex™ Protocol is achieved in a modular form, called “Data Module”, which is defined as “the smallest self-contained information unit within a Shipdex™ dataset”. Shipdex™ Protocol defines Data Modules as containers for data exchange. The Shipdex dataset is the collection of all the information (data modules, information objects and external documents) related to a given product in a given configuration.

A Data Module contains the following kind of information:

  • An identification and status section with all identification and quality assurance information
  • A content section, which is different, depending on the Data Module type.

The Data Module types that Shipdex™ Protocol makes use are:

  • Descriptive and operational
  • Procedural
  • Spare parts, support equipment and consumables catalogues (IPD)
  • Troubleshooting
  • Maintenance Planning
  • Publication
  • Comment
  • SCO content
  • Learning
  • SCO Content Package Module (SCPM)

The above Data Module types are governed by the following S1000D™ issue 2.3 xml schemas:

  • Descript.xsd (Descriptive, operational and troubleshooting)
  • Proced.xsd (procedural)
  • ipd.xsd (Illustrated parts data)
  • schedule.xsd (Maintenance Planning)
  • pm.xsd (Publication)
  • comment.xsd (Comment)

and by the following S1000D issue 4.2 xml schemas:

  • scocontent.xsd (SCO content)
  • learning.xsd (Learning)
  • scormcontentpackage.xsd (SCO Content Package Module)
  • lom.xsd (to be used to validate SCPM data modules)

available for a free download on www.s1000d.org

All Data Modules that are applicable to different Products may be gathered and managed in a database, which is hereafter referred to as the Common Source DataBase (CSDB).

Information is not duplicated in the CSDB though individual Data Modules can be used many times in the output. Savings are therefore made in the maintenance of the data in that it only needs to be changed once, whilst the changed information appears throughout the outputs.

Main Benefits

  • Data interoperability at data level, through use of schemas etc.
  • Non-proprietary specification and based on open standards
  • Ease of data exchange, using small xml based files structures
  • Possibility to add extra documentation features such as Link mechanisms etc., enabling better end user experience
  • Focused to produce objects of information, instead of the traditional paper bound constraints
  • Enabled to focus specifically on data data
  • Layout is not included in Shipdex dataset

Authoring benefits

  • Re-use of data (in a modular format) allows to save up to 40% of data production time
  • Reduction in update costs, due to use of data module concept of up to 30%
  • Module Uniqueness (Task /Description), allows task orientated definition
  • Compliant Authoring tools available, multiple vendor support

Life Cycle benefits

  • Reduced creation and update costs, thanks to data re-use
  • Lower document distribution costs, multiple methods of delivery available
  • Wider access and more efficient retrieval of the documentation by the end user, multiple methods of delivery available
  • Easy filtering of information through the Common Source DataBase (CSDB)
  • Increased operational readiness through reduced MTTR, through more focused maintenance
  • Increase in data integrity and the generation of better quality documents, through data integration and data module concept

Common Source DataBase (CSDB)

This is the “store” where Shipdex data should be stored. CSDB is the most important technical documents repository where all the Shipdex data can be stored together with all the updates. Applying filters it is possible to retrieve required information that can be used to:

  • Export towards other IT systems (ERP, PMS, etc)
  • Produce Shipdex datasets
  • Publish selected data in the form of pdf manuals or Interactive Electronic Technical Publications (ERP)
  • Publish SCORM compliant CBTs

However Shipdex does not define its functionalities. Shipdex just recommend that there is a requirement to hold and manage the data modules produced in Shipdex format.