Documentation

Welcome to the RES Hub, a place for our technical community to find and share content such as building blocks and samples for the RES ONE Enterprise platform.

  • Unlimited access to a centralized location for all RES connectors, building blocks and samples
  • Simplify RES POC projects and deployments by leveraging existing integrations and templates
  • Get visibility within the RES technical community through comments and contributions

To make things easier, RES developed two tools to create, share and use packages:

  • The RES Hub Package Creator makes it easy to create packages of building blocks and content samples. If you are more old school, you can also create RES Hub packages with the NuGet client.
  • The RES Hub Package Installer makes it easy to install RES ONE Automation connectors or extract building blocks and content samples for your RES product.

Getting Started


Find and search packages

When you visit RES Hub, you can find a list of packages on the Packages tab.

  • The packages are sorted by total downloads, which shows which packages are most popular in the RES Hub community.
  • You can find packages by using the filters, by clicking the tags or by using the search bar. The search bar is available on all pages of the RES Hub. See the explanation below.
  • Packages that contain RES ONE Automation connectors may be certified.
    • A gray icon and the RES brand logo means that the package has been developed by the RES Engineering department.
    • A blue icon means that the package has been developed by an external party, but has been verified by RES.

Search syntax

  • Keywords: If you search on keywords, the search results will contain packages that contain any of the provided keywords. For example, if you specify fiberlink management, this will results in a list of packages that use the terms fiberlink OR management (or both).
  • Phrases: If you search on terms within quotation marks, the search results will contain packages that contain exact matches to those terms (case-insensitive). For example, if you specify "fiberlink management", this will results in a list of packages that use the phrase fiberlink management. You can also use combinations of keywords and phrases.
  • Filtering: You can also search by properties, by using the syntax <property>:<term>. Properties can be id, packageid, version, title, tags, author, description, summary and owner. You can combine terms within quotation marks, and you can search for multiple properties at the same time.

Examples of filtering

  • id:management
  • title:azure
  • packageid:azure
  • id:management tags:virtualization
  • id:azure id:management
  • title:"management connector" tags:fiberlink
top

Create packages using the RES Hub Package Creator

When you want to share building blocks or content samples on the RES Hub, the easiest way to package them is with the RES Hub Package Creator. With the RES Hub Package Creator, you can automatically create packages via a wizard.

  • RES ONE Building Block package: This type of package contains a building block made in a RES product.
  • RES ONE Sample package: This type of package is based on a content folder.

Download the RES Hub Package Creator

Create a RES ONE Building Block package

  1. In your RES product, export the content that you want to share with the RES Community as a building block.
  2. Start the RES Hub Package Creator and follow the prompts of the wizard.
  3. When prompted, select to create a RES ONE Building Block package.
  4. Specify the building block file. For RES ONE Automation building blocks, you can also select a Resource file. The RES Hub Package Creator tries to identify the RES product related to the building block (i.e. RES ONE Automation, RES ONE Identity Director or RES ONE Workspace). This will be added as a tag.
    • If automatic product identification fails, select a RES product manually.
  5. Specify a package title that is unique for the RES Hub. Best practice is to use your company name in the title.
    • Use dot notation (e.g. "RES.Automation.Tasks.Nutanix" or "RES.Automation.Tasks.Nutanix.Sample"). You are not allowed to use spaces and special characters.
  6. Specify version, author(s), summary and description of the package (e.g. "RES ONE Automation Pack for Nutanix").
    • The RES Hub Package Creator supports semantic versioning (major, minor, revision version number - as in "3.2.1"). New packages get version "1.0.0" by default.
  7. Optionally, you can specify additional information about the package:
    • Icon URL: Use this field to specify the (publicly-available) URL to an icon for the package. This icon is shown on the RES Hub when you upload the package. Supported format: 32×32 pixel PNG with transparent background.
    • Project URL: Use this field to specify a (publicly-available) link to your project, blog or product description page. This link is shown on the RES Hub and allows users to get more information about the package.
    • Tags: Use this field to add tags to the package. This allows you to group it with related packages on the RES Hub. In addition, default filters are available on the RES Hub. You can use (combinations of) the following filter tags:
      Filter Tag
      PC Lifecycle Management PCLM
      Virtualization Virtualization
      Security Security
      System State SS
      Infrastructure as a Service IaaS
      Software as a Service SaaS
      Service Desk Integration SDI
      Enterprise Mobility Management EMM
    • Copyright: Use this field to specify a copyright notice for the package.
    • Release Notes: Use this field to specify release notes for the package. This allows you to specify additional information about the package. This may be useful when you upload a new version of the package.
  8. Specify a storage location for the package.
  9. Click Create Package.

Create a RES ONE Samples package

  1. Create the content that you want to share with the RES Community.
  2. Save the content to a folder that you designated for the package. When you create the package, any file in this folder is included.
    • The file types *.DLL *.ZIP *.EXE *.AVI *.MP* *.MKV are not supported. If the content folder contains any of these file types, they will not be packaged.
    • The content folder can have a maximum size of 100MB. If the folder exceeds this limit, the entire folder will not be packaged, even if it contains unsupported files that will be skipped during packaging.
  3. Add additional files to the folder, like a readme.txt that explains the contents of the package.
  4. Start the RES Hub Package Creator and follow the prompts of the wizard.
  5. When prompted, select to create a RES ONE Samples package.
  6. Specify the folder that you want to package.
  7. Select the RES product(s) related to the sample files. This will be added as a tag.
  8. Specify a package title that is unique for the RES Hub. Best practice is to use your company name in the title.
    • Use dot notation (e.g. "RES.Automation.Tasks.Nutanix" or "RES.Automation.Tasks.Nutanix.Sample"). You are not allowed to use spaces and special characters.
  9. Specify version, author(s), summary and description of the package (e.g. "RES ONE Automation Pack for Nutanix").
    • The RES Hub Package Creator supports semantic versioning (major, minor, revision version number - as in "3.2.1"). New packages get version "1.0.0" by default.
  10. Optionally, you can specify additional information about the package:
    • Icon URL: Use this field to specify the (publicly-available) URL to an icon for the package. This icon is shown on the RES Hub when you upload the package. Supported format: 32×32 pixel PNG with transparent background.
    • Project URL: Use this field to specify a (publicly-available) link to your project, blog or product description page. This link is shown on the RES Hub and allows users to get more information about the package.
    • Tags: Use this field to add tags to the package. This allows you to group it with related packages on the RES Hub. In addition, default filters are available on the RES Hub. You can use (combinations of) the following filter tags:
      Filter Tag
      PC Lifecycle Management PCLM
      Virtualization Virtualization
      Security Security
      System State SS
      Infrastructure as a Service IaaS
      Software as a Service SaaS
      Service Desk Integration SDI
      Enterprise Mobility Management EMM
    • Copyright: Use this field to specify a copyright notice for the package.
    • Release Notes: Use this field to specify release notes for the package. This allows you to specify additional information about the package. This may be useful when you upload a new version of the package.
  11. Specify a storage location for the package.
  12. Click Create Package.
top

Upload packages

This article walks you through the process to upload packages to the RES Hub.

  1. Click the Upload Packages tab of the RES Hub.
  2. Sign in with your RES customer/community account. RES employees can sign in with their RES account.
  3. Click Choose File and browse to the file that you want to update.
  4. Click Upload.
  5. Verify the details of your package.
  6. Choose whether to list your package in the search results. Unlisting a package hides the package from search results and all RES Hub commands, but packages are still available for download. For example, they can still be downloaded as dependencies to other packages. Unlisted packages cannot be installed directly.
  7. Click Submit. This uploads your package to the RES Hub and shows the Detail page of the package. If necessary, you can use this page to make changes to the details of the package.
top

Share packages on social media

This article walks you through the process to share your packages on social media.

  1. Click the Detail page of your package
  2. Click a social media icon to share a link to your package.
top

Download and install packages using the RES Hub Package Installer

This article walks you through the process to download packages from the RES Hub and install their contents into your RES product.

Download packages

  1. Click the Packages tab of the RES Hub to get an overview of all packages you can download.
    • Use the Search Packages field in the top bar to search with a keyword or phrase.
    • You can filter by product, type, solution and tag.
  2. Click the name of the package you want to download.
  3. On the Detail page of the package, click Download at the top of the page or in the navigation menu. This downloads the package to your downloads folder.

Install or extract packages

When you have downloaded a package from the RES Hub, you can install it or extract its contents with the RES Hub Package Installer. This application makes it easy to import RES ONE Automation connectors directly from a package into a RES ONE Automation Datastore. You can also use it to extract Building Blocks and content samples for your RES product.

Download the RES Hub Package Installer

Connectors

  1. Start the RES ONE Automation Console.
  2. Start the RES Hub Package Installer and follow the prompts of the wizard.
  3. When prompted, select the RES Hub package that contains the connectors that you want to install.
  4. When prompted, verify the connection settings to the RES ONE Automation Datastore.
  5. Next, click Upgrade to install the connectors into the RES ONE Automation environment.

Building Blocks

  1. Start the Import utility and follow the prompts of the wizard.
  2. When prompted, select the RES Hub package that contains the building blocks that you want to extract.
  3. When prompted, select the extraction location of the package.
  4. Click Extract. When finished, the Explorer automatically opens the extraction location.
  5. Import the building blocks into your RES product.

Samples

  1. Start the Import utility and follow the prompts of the wizard.
  2. When prompted, select the RES Hub package that contains the sample files that you want to extract.
  3. When prompted, select the extraction location of the package.
  4. Click Extract. When finished, the Explorer automatically opens the extraction location.
top

Create packages using the NuGet CLI

This article walks you through the process to create a RES Hub package manually. The procedure is identical for building blocks, connectors and other content.

Prerequisites

  • NuGet CLI. You can download the latest version at https://dist.nuget.org, after which you save it to a location of your choice.
  • Add that location to your PATH environment variable if it isn't already. Run Nuget.exe from this location; the executable is not an installer.

Create content

  1. In your RES product, create the content that you want to share with the RES Community.
  2. Save the content to a folder that you designated for the package. When you create the package, any file in this folder is included.
  3. Add additional files to the folder, like a readme.txt that explains the contents of the package.

Create the .nuspec package manifest file

Each package needs a manifest file (.nuspec) that describes its contents and dependencies.

  1. Open a command prompt and navigate to the folder that contains the content files.
  2. Run the command nuget spec to generate the manifest file.
  3. In the Explorer, navigate to the manifest file and open it in a text editor.
  4. In the line <id>Package</id>, specify a package title that is unique for the RES Hub. Best practice is to use your company name in the title.
    • Use dot notation in the title (e.g. RES.Automation.Tasks.Nutanix or RES.Automation.Tasks.Nutanix.Sample). You are not allowed to use spaces and special characters.
  5. In the line <version>1.0.0</version>, specify the version of the package in semantic versioning format (major, minor, revision version number - as in "3.2.1"). New packages get version "1.0.0" by default.
  6. Delete the lines <licenseURL> </licenseURL> and <dependencies> </dependencies>. These options are currently not supported for RES Hub packages.
  7. In the line <projectURL> </projectURL>, specify a (publicly available) link to your project, blog or product description page. This link is shown on the RES Hub and allows users to get more information about the package.
  8. In the line <iconURL> </iconURL>, specify the (publicly available) URL to an icon for the package. This icon is shown on the RES Hub when you upload the package. Supported format: 32×32 pixel PNG with transparent background.
  9. In the line <description>Package description</description>, specify a description of the package (e.g. RES ONE Automation Pack for Nutanix).
  10. In the line <tags> </tags>, add tags to the package. This allows you to group it with related packages on the RES Hub. You can use (combinations of) the following filter tags:
    • PC Lifecycle Management: <tags>PCLM</tags>
    • Virtualization: <tags>Virtualization</tags>
    • Security: <tags>Security</tags>
    • System State: <tags>SS</tags>
    • Infrastructure as a Service: <tags>IaaS</tags>
    • Software as a Service: <tags>SaaS</tags>
    • Service Desk Integration: <tags>SDI</tags>
    • Enterprise Mobility Management: <tags>EMM</tags>
  11. After the line <tags> </tags>, add the line <packageTypes> </packageTypes>. In these tags, add the package type(s) that apply to the package. These correspond with the default filters on the RES Hub:
    • RES ONE Automation: <packageType name="Automation" />
    • RES ONE Identity Director: <packageType name="IdentityDirector" />
    • RES ONE Workspace: <packageType name="Workspace" />
    • Connector: <packageType name="Connector" />
    • Building Block: <packageType name="BuildingBlock" />
    • Samples: <packageType name="Samples" />
  12. Save the file.

Create the package

Run the following command in the command prompt: nuget pack BuildingBlock.nuspec

  • Specify the path to the nuspec file if you are not in the same folder.
  • If you did not change the default fields in the manifest file, warnings about this are shown during creation of the package.

This creates a NuGet package file with the package name and version number that you specified in the manifest file (e.g. RES.Automation.Tasks.Nutanix.Sample.1.0.0.0.nupkg).

top