You are located in service: Coscine

Application profile generator

Application profile generator

Kurzinformation

To make it easier for you to create your own application profiles, Coscine provides a generator for user-defined application profiles. This not only allows you to create application profiles, but also validates them for syntactical correctness. You can then easily transfer your application profile directly into Coscine via the generator.


Detailinformation

Create a new Application Profile

When creating a new resource, at step 3 "Resource Metadata" you can either select an existing application profile or select the "Create" option (see figure below). Selecting "Create" will take you to the Application Profile Generator page.

Create new Application Profile - Navigation to the Application Profile Generator

 

About the Application Profile Generator

Application profiles in Coscine are formulated using SHACL and maintained in RDF data format. This format grants users the ability to specify the structure of their metadata. To enable the creation of application profiles, Coscine provides the Application Profile Generator - a simple GUI making it easier to develop an application profile without deep technical knowledge of the underlying data format.

Menu bar of the application profile generator

After navigating to the aforementioned URL, you will be confronted with the interface illustrated in the screenshot above. Note that some of the buttons described above in the menu bar may not be available in every state of the generator. Located at the top of the interface is a menu bar which you can use to perform various actions:

Action

Via "Action" (see figure above) you get access to the following options:

Create

  • Create a new application profile from scratch.
    • Note: We recommend this option for professionals - as a beginner it makes sense to base your work on an already established application profile and adapt it to your own needs.

Copy

  • Copy an existing application profile to add new fields or delete old fields.
  • These changes can then be published in a new application profile.

Expand

  • Extend an already existing application profile with new fields
  • Existing fields of the application profile cannot be changed
  • These changes can then be published in a new application profile

New version

  • Here you create a new version of an already existing application profile.
  • You remain in the context of the previous version of the application profile, changes are technically traceable
  • Based on the previous version, new fields can be added or old fields can be deleted.
  • These changes can then be published in a new application profile.

Add token

Via "Add token" (see figure on top) you can specify a personal Coscine user token, which allows you to publish your application profile directly from now on. Without a token, you can only store an application profile locally. If you have been brought to the application profile generator via Coscine, you can ignore this function.

Editor and preview

In the top center you will find the two interlinked buttons "Editor" and "Preview" (see figure above). Via a click you can switch between the editor view and a preview of the final application profile, e.g. to check the functionality and correctness of your progress so far.

Code View

Using the Code View (see figure above), you can switch between the actual RDF format and the more user-friendly representation of this format shown by the generator in the "Detail View" section.

Save

The "Save" button (see figure above) allows you to save your application profile....

  • save it locally to your hard disk (always recommended as a backup)
  • submit it via Git request for publishing on Coscine using the "Submit" button
    • Note: before publishing, the application profile will be checked by the FDM team, therefore the implementation in Coscine can take up to 4 weeks.

Web interface of the application profile generator

The interface is divided into four columns:

Available application profiles.

Here you will find an overview of all application profiles publicly available in Coscine. The text field at the top allows you to filter the listed application profiles by name. By clicking on a list entry, the corresponding application profile is loaded into the generator and made available for you to view. You can then view the individual fields of the application profile in the Detail View section.

Vocabulary terms

This section allows you to search for existing and established vocabulary terms. For example, if you want to add a date field to your application profile, you can search for the keyword "date" in the search bar and add this field to your own application profile. The search function searches all ontologies of the NFDI4Ing Terminology Service. Hover over the search results to find out the origin of each field. If you click on a field, it will be added to the current application profile and consequently appear in the "Detail View" section.

Detail view

In the detail view all fields of the currently selected application profile are listed. If you are currently editing or extending the profile, you can click on the fields to edit them using the last column. You can remove individual fields by clicking on the red cross on the far right. However, you can only do this if you are editing an application profile (i.e. if you have loaded it for editing via the pull-down menu or created a new profile).

  • Gear: Edit application profiles
    Edit Application Profiles
    PropertyDescriptionCorrelation
    Application profile URLEditable, after /ap/ a unique name should be specified for the profile, e.g. "https://purl.org/coscine/ap/engmeta"subject/baseURL
    Titlename of the application profiledcterms:title
    Descriptiondescription of the application profilerdfs:comment
    Inherits fromWith the "Expand" option, the underlying application profile is displayed heresh:node
    Target ClassCopy URL of the application profile (see above) or specify class of an ontologysh:targetClass
    ClosedDetermines whether additional metadata fields can be specified by userssh:closed
     

    Field properties

    If you have selected a field in the detail view, its parameters and properties appear for editing in the "Field properties" section.

    Standard properties
    PropertyDescriptionCorrelation
    Term IRIPath/URL to the definition of the termSHACL sh:path
    Field NameDisplay name of the fieldSHACL sh:name
    Minimale required EntriesMinumum amount of values that have to be specified by the userSHACL sh:minCount
    Maximum required entriesMaximum amount of values that can be specified by the userSHACL sh:maxCount
    Position on metadata formDisplay order of the property among the other propertiesSHACL sh:order
    Property TypeType of property - "Data type" by defaultEigenschaftstyp
    DatatypeData type/format of the expected input values (default: string) based on the XML Schema datatypes.SHACL sh:datatype
     
    Property types
    EigenschaftBedeutungEntspricht
    DatatypeExplicit datatype, e.g. string, date, integerSHACL sh:datatype
    Node KindCurrently not implemented in CoscineSHACL sh:nodeKind
    ClassSupplied value has to be an instance of the class, e.g. http://purl.org/dc/dcmitype/ (Definition)SHACL sh:class
    NodePoints to another validating application profile, e.g. https://purl.org/coscine/ap/engmetaSHACL sh:node
    ListList of string values, e.g. Apple, Banana, LemonSHACL sh:in
    ValueExplicit expected value (Currently not supported in Coscine)SHACL sh:hasValue
     
    String Properties
    PropertyDescriptionCorrelation
    Default valueDefault value in the fieldSHACL sh:defaultValue
    Minimum lengthMinimum occurrence of the valueSHACL sh:minLength
    Maximum lengthMaximum occurrence of the valueSHACL sh:maxLength
    Regex PatternRegex Pattern for the validation of the valueSHACL sh:pattern
    Regex FlagsRegex flagsSHACL sh:flags
     

    Value Properties

    PropertyDescriptionCorrelation
    Minimum ExklusiveSet the range of values for a term, Minimum Exklusive (Example: if Min. Exlusive= "1"  then value "1" is disallowed)SHACL sh:minExclusive
    Minimum InklusiveSet the range of values for a term, Maximum InklusiveSHACL sh:minInclusive
    Maximum ExklusiveSet the range of values for a term, Maximum ExklusiveSHACL sh:maxExclusive
    Maximum InklusiveSet the range of values for a term, Maximum InklusiveSHACL sh:maxInclusive
     

    Administrative Properties

    PropertyDescriptionCorrelation
    DescriptionDescription of the field displayed to the userSHACL sh:description
    Error messageError message, displayed upon a general errorSHACL sh:message
    SeveritySeverity of the errorSHACL sh:severity
     

    Error severity

    PropertyDescriptionCorrelation
    Info SHACL sh:Info
    Warning SHACL sh:Warning
    Violation SHACL sh:Violation

    Example

    To show you how to use the shape generator, we have made a short example of how to use it: Example: Creation of an application profile


     Zusatzinformation

    last changed on 03/28/2022

    How did this content help you?

    Creative Commons Lizenzvertrag
    This work is licensed under a Creative Commons Attribution - Share Alike 3.0 Germany License