CKAN DMS

Datasets in CKAN

In CKAN, datasets act as packages, each containing valuable information. When conducting a data search, what you get in results are individual datasets. Each dataset consists of two important components. Firstly, there's information about the data (aka metadata) such as the title, publisher details, publication date, available formats, and licensing specifics. Secondly, there are resources inside, containing the actual data. CKAN seamlessly handles data in diverse formats, including CSV, Excel, PDF, images, and more. CKAN can store these resources internally or as direct links to where the data resides on the web. A single dataset can encompass multiple resources, meaning One dataset can have multiple resources, catering to variations like different years or the same data presented in different formats. Inside a dataset, you have the option to either preview or download the dataset based on your specific needs. While navigating the dataset interface, you can access the Groups tab, which displays the groups to which the dataset belongs. Additionally, there's the Activity Stream tab, offering insights into previous actions and changes made to this dataset. CKAN simplifies the process of exploring and utilizing data, providing a flexible platform for your data explorations.

Publishing Datasets in CKAN: [Guide]

Adding datasets in CKAN is a fundamental process that empowers to catalog, organize, and share data with ease. Follow along as we break down the steps, providing clear instructions to ensure a smooth experience. By the end of this tutorial, you'll be well-equipped to harness the full potential of CKAN, turning raw data into a curated and accessible resource for the users. Step 1. Click CKAN’s “Add dataset” button. There's an "Add dataset" option - on the datasets page, - another when accessing the organization's data, - and a button within the datasets function on your profile What are datasets? A CKAN datasets (aka Packages for earlier versions of CKAN) is a collection of data resources (such as files), together with a description and other information, at a fixed URL. Datasets are what users see when searching for data. Step 2. Provide the details for the dataset Fields (In order of their appearance):- **Title:**The title serves as the name of the dataset, meaning that no two datasets can share the same name. Exercise caution when selecting a suitable name, ensuring it accurately reflects the overall data contained within it. It is a Mandatory field Description: Feel free to provide a more detailed description of the dataset in this section. Include details such as the data's source and any pertinent information that users may find useful when working with the data. Description is not a mandatory field but highly recommended among the users Tags: In this section, you have the option to include tags that aid in discovering the data and establishing connections with other relevant datasets. Press the return key between tags to while entering them. Tags aren't mandatory License: Providing license information is crucial to inform users about the permissible use of the data. This field should be a drop-down box. If the required license is not available in the list, please get in touch with your site administrator. License field aren't mandatory Step 3. Click the "Next:Add Data" button to start adding the data files: You can add data files by uploading from your computer or simply by pasting the URL into the box. Enter the name that should be displayed along with the description, and you're good to go! If you need to add more files, click the 'Save and Add Another' button. Finally, click 'Finish'.

Advanced Search Techniques in CKAN

From basic searches to advanced queries, CKAN provides a versatile toolkit for discovering the right data at the right time. Whether you're a researcher seeking specific insights or a data enthusiast exploring diverse datasets, understanding CKAN's search functionality is the key to unlocking the full potential of your data catalog. Searching by Metadata Field When you're searching and want to be more precise, you can concentrate on a specific type of information. Start by typing the kind of information you're interested in, such as "city," followed by a colon (":"). Then, write the specific term you're looking for after the colon. For example: title: New York Boolean Operators These operators act like filters, helping you broaden your search to get more relevant results. "AND" or "&&" When you use "AND," or "&&," it indicates that both terms on either side must be present for a match. County && City Try it out on data.dathere.com In this example, the search is narrowed to datasets where both "County" and "City" are present, providing more focused and relevant results. "NOT" or "!" When you use "NOT" or "!", it's like saying, "I want results that have the first term but without the second term. County NOT city It helps you exclude specific terms you don't want in your search results. “OR” or “||” It signifies that either one or both of the specified terms must be present for a match. letting you broaden your search to find datasets that have either one term, the other, or even both. It's a nice way to cast a wider net and gather datasets that match any of your specified terms. County OR city Here, you're saying, "Give me datasets that mention either 'County,' 'City,' or both." Remember, when you're using keywords like AND or NOT as Boolean operators in your CKAN searches, they need to be in all uppercase letters. For example, type AND, NOT, or any other Boolean operator in capital letters to make sure CKAN recognizes and processes them correctly. "+" (Symbol) The "+" symbol is like a tag for making sure a specific term is a must-have in your search. title: US + States Try it out on data.dathere.com This is saying, "Find me datasets where the title has 'US,' and it absolutely has to include 'States' too." '-' (Symbol) The "-" symbol is like a filter for excluding specific terms you don't want in your search. title: Counties - Demographics Placeholders Placeholder - Single Character"?" "?" symbol acts as a placeholder for a single character in your search term for example N?C This search might yield matches like "NYC," "NAC," or "NOC." Placeholder - Multiple Characters"*" "*". This symbol acts as a dynamic placeholder, allowing for the inclusion of multiple characters in your search term. for example NYPD* Try it out on data.dathere.com Here, the "*" acts as a placeholder, indicating, "Retrieve datasets related to NYPD and any subsequent characters." This search might yield matches like "NYPD Incidents," "NYPD Statistics," or "NYPD Crime Rates.

Managing your Profile in CKAN

You can update the information that CKAN stores about you, including what other users can see. This is particularly useful when you edit datasets or upload data to an organization that other users are following. On the user settings page, you have the option to modify... - Your full name - Your email address (note that this information is not visible to other users) - Your profile text, which is an optional short paragraph about yourself - Your password Once you've made the necessary changes, click on the "Update Profile" button to save your updates. Users are most likely to see your profile when you edit a dataset or upload data to an organization that they are following This article will walk you through the steps to access and customize your CKAN profile. 1. Navigating to Your Profile: Begin your journey by clicking on the username located at the top right corner of your screen. This will lead you to your CKAN profile. 2. Your Profile Dashboard: Your profile isn't just a static page; it's a dynamic dashboard that provides insights into your CKAN interactions. Here you could see if you have followers, datasets associated with your name, or any recent edits. 3. Activity Stream: On the left side of your profile, you'll find the activity stream. This feature acts as your digital journal, detailing changes and edits you've made. It's a handy tool to track your contributions within the CKAN community. 4. Managing API Tokens: Directly besides the activity stream lies the section for API Tokens. Here, you have the power to edit or create new API keys under your name. These tokens play a crucial role in enabling secure interactions with CKAN API's. 5. Editing Your Profile Information: To add a personal touch, click on "Manage." This will open up a range of options where you can edit your username, email, and share a brief description about yourself and update your password

Navigating the CKAN Interface

Before we begin... Before we explore the CKAN interface, it's important to understand the basic functionalities and permissions as a CKAN user.  While you possess the capability to search and access public data, as well as explore your organization's private datasets, note that certain actions, such as adding or modifying datasets, may be restricted based on your user permissions. Usually CKAN instance's homepage has the following components. 1. Datasets Search Bar: The large search bar at the center allows you to search and view any public datasets from various organizations available on the CKAN instance. 2. Organizations Tab: Navigate to the "Organizations" tab to access CKAN organizations, crucial for creating, managing, and publishing datasets. User roles within an organization determine authorization levels, such as the ability to create, edit, and publish data. 3. Showcases: Explore 'Showcases' that collect the best examples of datasets in use, providing further insights, ideas, and inspiration. CKAN Homepage Interface In this guide, we will explore the interface CKAN instance, from the main dashboard to specific features. As a CKAN user you have the capability to search public data and access your organization's private datasets. However, note that adding or modifying datasets is not within the user's permissions. Upon your initial login, you'll land on a homepage resembling the one above: Navigate using the large search bar at the center or click on "Datasets" to explore and view any public datasets from various organizations available on the CKAN instance Utilize the "Organizations" tab to access CKAN organizations, essential for creating, managing, and publishing datasets. Users may hold different roles within an organization, each role granting specific authorization levels such as the ability to create, edit, and publish data. Enhance your dataset search by utilizing 'Groups,' a categorization system that organizes datasets. For instance, a search for 'health' might lead you to relevant datasets. On the homepage, explore 'Showcases.' Showcases collect together the best examples of datasets in use to provide further insights ideas and inspiration Data Page On the data page of a CKAN instance, the layout is designed for seamless data exploration: Central Dataset Window: At the center of the page, a window displays all datasets neatly stacked up below the search bar. This is your hub for discovering and navigating through available datasets. Left-side Search Filters: On the left side, you'll find search filters. These filters serve as handy tools to refine and pinpoint your search with just a few clicks. For instance: Filter by location: You easily filter by the location of the datasets using the map tool widget. Organization Sorting: Easily sort datasets based on the organization they belong to. Groups: Similarly, groups enable you to categorically sort and search your data, allowing for a more streamlined exploration.

Using API Tokens in CKAN [Guide]

Prerequisites Before diving into using CKAN's API, there are a few prerequisites to keep in mind: - Familiarity with JSON Parsing: It's essential to have a basic understanding of how to read JSON data structures. JSON (JavaScript Object Notation) is a commonly used format for exchanging data between a server and a web application. - Understanding REST API Basics: Having a grasp of the fundamental principles of REST (Representational State Transfer) APIs is beneficial. REST APIs follow a set of architectural principles for building web services, making it crucial to understand concepts like endpoints, HTTP methods, and status codes. - Possession of an API token from the Developer Dashboard: To interact with CKAN's API, you'll need an API token obtained from the Developer Dashboard. This token serves as your authentication credential, allowing you to access and interact with CKAN's resources securely. Applications of API tokens With the CKAN API, your app can: - Retrieve data: Fetch datasets and resources from CKAN for your analysis or application. - Update datasets: Modify existing datasets, add new ones, or remove outdated ones as your data evolves. - Manage users and permissions: Control who can access and edit data on your CKAN site, ensuring security and collaboration. - Customize CKAN: Tailor CKAN's features to suit your needs, from themes and layouts to custom workflows and extensions. Generating API Tokens**:** CKAN simplifies the process of generating API tokens, empowering users to create and manage them effortlessly. Within the CKAN instance, users can navigate to their profile settings to generate API tokens. Each token is unique and associated with specific user permissions, ensuring fine-grained control over data access and manipulation.  Furthermore, CKAN provides mechanisms for revoking and regenerating tokens, enhancing security and flexibility. In the Developer Dashboard, API token can be generated, the activity can be viewed on the corresponding API.