Namespace: publish

.services.xs. publish

ESS Services Publication API Contains APIs to:

Version:
  • 2.0.0

Classes

PublishableArtifactNode

Members

(static, constant) self.LOCAL :string

Refers to the current HANA instance as a source of publication.

Type:
  • string

(static, constant) self.REMOTE :string

Refers to the current HANA instance to access remote sources.

Type:
  • string

Methods

(static) getChildrenPublishableArtifacts(publicationArtifactContainer) → {Array.<sap.hana.im.ess.services.xs.publish.PublishableArtifactNode>}

Gets the list of publishable artifacts (or their containers) located directly under a given container of publishable artifacts. In a HANA instance, the Catalog root container qualified name is 'Catalog', and the Repository root container qualified name is 'Content'. This method returns only containers that actually contain publishable artifacts; others will not be shown.

Parameters:
Name Type Description
publicationArtifactContainer string

Qualified name of a container of publication artifacts. The syntax is Catalog."schemaName" or Content.p1.p2...pN.

Returns:

List of children publishable artifacts.

Type
Array.<sap.hana.im.ess.services.xs.publish.PublishableArtifactNode>

(static) publish(request)

Creates an on-demand publish request of a single publication artifact. This request will be immediately (modulo latency in the queue of requests) processed by the Crawl and Deploy processes.

Parameters:
Name Type Description
request sap.hana.im.ess.services.xs.publish.publishRequest

(static) unpublish(request)

Unpublishes a publication artifact for a given scope. If the publication artifact was published under different scopes, its published contents will remain present in the Entity Grid under the remaining scopes.

Parameters:
Name Type Description
request sap.hana.im.ess.services.xs.publish.publishRequest

Type Definitions

publicationArtifactIdentifier

A publicationArtifactIdentifier is the qualified name of an HANA artifact to publish or unpublish in the Entity Grid.

  • HANA views in the repository
    • Analytic Views, Attribute Views and Calculation Views
    • Format: Content.p1.p2...pN.viewName where p1.p2...pN is the package name of the view, and viewName the name of the view (without quotes)
  • HANA catalog objects
    • Tables, Virtual Tables, Column Views, SQL Views
    • Format: Catalog."schemaName"."objectName". Quotes are mandatory for Catalog objects schemaName and objectName. If schemaName and objectName themselves have quotes, they must be escaped by double quoting (as in SQL).
Type:
  • string

publicationArtifactType

The publicationArtifactType identifies the type of artifact to publish.

It must be a string in one of the following enumerations, based on the type of artifact:

  • HANA views in the repository: attributeview, analyticview, calculationview
  • HANA catalog objects: table, view, columnview, virtualtable
Type:
  • string

publishRequest

Gives parameters for publishing or unpublishing a basic artifact

Type:
  • Object
Properties:
Name Type Description
publicationArtifact sap.hana.im.ess.services.xs.publish.publicationArtifactIdentifier

Qualified name of a basic artifact

typeFilter sap.hana.im.ess.services.xs.publish.publicationArtifactType

Used when the publisher wants to publish only basic artifacts of a given type. Otherwise, all publishable basic artifacts will be published whatever their type.

publisherGroup String

the publisher group. if undefined or null, 'PUBLIC' will be used. Only letters (lowercase and uppercase), digits, ., * and _ characters are allowed

computeContentTypes boolean

Whether to compute content types after publication

computeEnumeratedValues boolean

whether to compute enumerated values after publication