npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

sap-cap-sdm-plugin

v1.3.1

Published

An SAP CAP plugin designed for effortless integration with SAP Document Management Service.

Downloads

55

Readme

SAP CAP SDM Plugin

A plugin made for SAP Cloud Application Programming (CAP) projects, aimed at effortless integration with SAP Document Management Service (SDM). Achieve smooth connections in a 'CAP-ish' style, solely utilizing CDS Annotations. This makes your DMS integrations simpler and more intuitive.

Project Overview

sap-cap-sdm-plugin is a CDS plugin that provides integration to the SAP Document Management service specifically for CAP projects.

Requirements

To use the all-in-one features provided by this plugin, you'll need a paid instance of the SAP Document Management service.

Installation & Setup

1. Installation

Install the plugin using npm with the following command:

npm install sap-cap-sdm-plugin

2. Configuration

Include the plugin in the cds.requires section of your package.json:

"cds": {
    "requires": {
        "sap-cap-sdm-plugin": {
            "impl": "sap-cap-sdm-plugin",
            "settings": {
                "destination": "<YOUR_SDM_DESTINATION_NAME>",
                "repositoryId": "<YOUR_REPOSITORY_ID>"
            }
        }
    }
},

3. Entity Creation

Set up your entity with the @Sdm.Entity annotation. Link your entity properties to CMIS properties using the @Sdm.Field annotations:

service SampleService {
    @cds.persistence.skip
    @Sdm.Entity
    entity Files {
        key id           : String      @Sdm.Field      : { type : 'property', path : 'cmis:objectId' };
            name         : String      @Sdm.Field      : { type : 'property', path : 'cmis:name' };
            content      : LargeBinary @Core.MediaType : contentType  @Core.ContentDisposition.Filename : name;
            contentType  : String      @Core.IsMediaType
                                       @Sdm.Field      : { type : 'property', path : 'cmis:contentStreamMimeType' };
            createdBy    : String      @Sdm.Field      : { type : 'property', path : 'cmis:createdBy' };
            creationDate : Date        @Sdm.Field      : { type : 'property', path : 'cmis:creationDate' };
    }
}

4. Get Started

After setting up, check your configuration to make sure everything is okay.

Additional Features

  1. File URL

Obtain a direct URL to the document by specifying type: 'link' within the @Sdm.Field annotation.

    url: String @Sdm.Field : { type : 'link' };
  1. CMIS Client

If the entity annotations don't meet your needs, you can use the CMIS Client to implement your own logic.

This service follows the specs of SAP Document Management Service, Integration Options - CMIS from SAP Business Accelerator Hub.

Usage:

const client = await cds.connect.to('cmis-client');
// create a folder in root
await client
  .createFolder('your_repository_id', 'folder_name')
  .execute(destination);

Check test/cmis for more examples.

  1. SDM Administrative Operations

There's also a service for admin tasks, like adding a new repository. This service comes from the Document Management Service, Integration Options - AdminAPI.

Usage:

const admin = await cds.connect.to('sdm-admin');

// add a new repository
await admin.onboardARepository({
  repository: {
    displayName: 'sdm-plugin',
    description: 'sdm-plugin',
    repositoryType: 'internal',
    isVersionEnabled: 'false',
  },
});

Check test/admin for more examples.

Limitations

This is an early release, so some SAP DMS features are not yet supported, including:

  • Repositories with isVersionEnabled set to true;
  • Repositories with isThumbnailEnabled set to true;
  • Bulk upload;
  • Bulk download;