Publishing Items

Publishing an Item on the Marketplace

This comprehensive guide outlines the process for publishing an item within the Marketplace, thereby rendering it discoverable and accessible to other users. Remember, publishing items can only be done if you have the add-on Publisher license purchased for your tenant and the Publisher seat assigned to you.

Estimated Time:

The duration required to publish an item is variable and contingent upon factors such as the complexity of the item, the volume of information provided, file size, and the time necessitated for security scans and admin review and approval.

Before You Begin:

To ensure a streamlined publishing experience, you should gather the following information and prepare any prerequisite files in advance:

Essential Item Details: You need a clear and compelling title, a detailed and informative description, and accurate pricing details.
Relevant Files: You should prepare any files intended for inclusion with your item, such as source files, a logo, a README file, or a user manual.
Cloud Storage Prerequisites (if applicable): If your item's source files are hosted on a cloud storage service (GCP, Azure, or AWS), you must ensure that the specific prerequisites for sharing files from your chosen platform have been fulfilled. Detailed instructions regarding cloud storage prerequisites are provided here.

Items Tab

The "Items" section within the Publishing Center is the designated area where you manage the lifecycle of your published content, encompassing creation, archiving, and gaining detailed insights into individual item performance.

Accessing the Items Section

You can navigate to the Publishing Center via the left-hand navigation panel. You should then click on the Items tab.

Publishing a New Item

For new users, the "Start Here" button will be prominently enabled on the Dashboard whereas for existing users, the "New" button would be present under the Items tab. Clicking this button initiates the process of publishing a new item, guiding you through the necessary steps to provide item details and submit it for review.

Step-by-Step Publishing Process

The following steps detail the process for publishing an item on the Marketplace:

Initiate a New Item Publication (For New Users):
- Click on the "Start Here" button that appears on the initial screen.
Initiate a New Item Publication (For Existing Users):
- Click on the "Items" tab.
- In the top right corner of the Items page, click the "New" button.
Complete the Publishing Form: A publishing form will be displayed. The first section requires fundamental details about your item.

Step 1: Basic Information
- Title: Enter a clear, concise, and descriptive title for your item. This serves as the primary identifier visible to users.
- Description: Provide a detailed and informative description of your item. Explain its features, benefits, use cases, and what users can anticipate.
- Visibility Level: Select the desired visibility level for your item:
  
  a. Public: Your item will be visible and discoverable by all users in the Marketplace.
  
  b. Share it only with: Your item will only be visible to specific users with whom it is explicitly shared. If you select "Share it only with," you will be prompted to enter the full email address of each user with whom you wish to share your item.
Step 2: Category, Specifications & Source Files
- Category: Choose the most appropriate Category for your item from the provided list.
- Sub-Category: Upon selection of a category, the relevant Sub-Categories will be populated. You should choose the most suitable sub-category for your item.
- Details: Based on the selected sub-category, you will be prompted to add specific details or Specifications relevant to your item. You should fill all required fields accurately. A detailed table outlining the specifications for each category and subcategory is provided here.
- Provide Item Source Files: You are required to provide the source files for your item. Two options are available:
  
  a. Upload Files: Click the upload button and select the files directly from your computer/local.
  
  b. Provide Cloud Storage URL: If your files are hosted on a cloud storage service (AWS, GCP, or Azure), enter the URL where the files can be accessed from.
Note

You must ensure that the files you provide are the correct and complete source files for your item and that the prerequisites for sharing from your chosen cloud platform have been followed. Refer to the Prerequisites for Cloud Storage section at the end of this guide for detailed instructions.

Step 3: Pricing

This section is for setting the price of your item.
- Price: Enter the price to be charged for your item. If you want to offer your item free of charge, enter 0.
- Currency: Select the currency for the price.
Note

Currently, only Dollar ($) is supported.

Step 4: Additional Information

This section allows you to add supplementary details to enhance your item's listing and improve its discoverability.
- Logo: Upload a logo or image that visually represents your item. This will be displayed on your item's listing page.
- Tags: Add relevant tags or keywords that will facilitate users in finding your item through search on the Marketplace. You should use comma-separated values (e.g., AI, machine learning, model).
- Expiry Date (Optional): If your item has a specific expiry date (e.g., a limited-time offer or a dataset with a defined end date) post which users shouldn't be able to use it, you can set it here.
- Additional Files: Upload any additional files that may be beneficial for users, such as a README file, user manual, supporting documentation, or sample files.
Step 5: Review and Submit Your Item:

Upon completion of all sections of the form, you can review your entry:
- Click the "Preview" button to view how your item listing will appear to users on the Marketplace. Make any necessary edits to ensure accuracy and clarity.
- When you are satisfied with all the details, click the "Submit" button to initiate the publishing process.
Item Processing and Approval:

After submission, your item will undergo the following process prior to publication:
- Security Scans: Your item will be automatically scanned for security vulnerabilities to ensure the safety of Marketplace users and adhere to our AI Innovation Platform's security standards.
- Admin Review: If your item successfully passes the security scans, it will be forwarded to the Marketplace admins (AI Innovation Platform admins) for review and approval. Admins will verify the information you provided and ensure compliance with Marketplace guidelines.
Note

The time required for security scans and admin review is variable and dependent on your item's complexity and the current volume of submissions. You can monitor the status of your submission on the Items page in the Publishing Center.
Item Publication:

Once your item is approved by the admins, it will be published in the Marketplace and become accessible based on your chosen visibility setting.
- Visibility:
  
  a. If you set the visibility to Public, your item will be visible and discoverable by all users browsing the Marketplace.
  
  b. If you set the visibility to Share it only with, your item will only be visible to the specific users with whom it has been shared (based on the email addresses you provided in Step 1).

Managing Items

The Items page is structured into three tabs to facilitate effective content management:

All Items: This tab displays a comprehensive list of all items that you have successfully published.
Drafts (Coming Soon): This section will contain any items that you have partially created and saved as a draft without being submitted for publication. This allows you to work on items incrementally before finalizing them.
Archived Items (Coming Soon): This tab will include items that have either reached their specified expiry date or have been deleted by you.

Detailed Item View

When you click on a specific item from the "All Items" list, you will access a detailed view that provides more in-depth analytics and information about that individual item. This detailed view is organized into several sections:

Performance: This section provides a comprehensive performance overview specifically for your selected item. It includes key metrics such as:
- Total Revenue generated by your item and the change in revenue compared to the last month.
- Total Orders for your item and the change in orders compared to the last month.
- Total Customers who have purchased your item and the change in customers compared to the last month.
- Total Ratings received by for item and the number of users who have provided the rating.
Revenue (Coming Soon): This forthcoming section will provide more detailed financial information specifically related to the revenue generated by your individual item.
Reviews and Feedbacks: This section displays all the reviews and feedback that your specific item has received from customers, allowing you to understand user experiences and identify areas for improvement.
Versions: If your item has undergone modifications and updates since its initial publication, this tab will display a history of all released versions. While only the latest version is consumable by users, this provides valuable visibility into the changes you have made to your item over time.
Customers (Coming Soon): This forthcoming section will provide more detailed customer information related to who purchased your individual items.

Item Management Actions

On the detailed item view page, you'll find intuitive icons for editing and deleting your items. These features are fully functional, allowing you to make real-time updates or remove listings as needed:

Edit Items: Click the pencil icon to modify any details of your published items, from descriptions to pricing.
Delete Items: Use the trash icon to completely remove items that are no longer relevant.

Coming Soon: We're excited to announce that in future updates, you'll have even more control with these additional features:

Draft saving functionality to work on listings before publishing
Archive options to temporarily hide items without deleting them

These upcoming enhancements are part of our commitment to giving you more flexibility in managing your inventory. Stay tuned for these exciting additions!

Beyond the Items Tab

In addition to the "Items" tab, the Publishing Center includes two other important pages accessible from the main navigation:

Revenue (Coming Soon): This page allows you to track the overall financial performance of your items across the Marketplace, providing a consolidated view of your earnings.
Item Support: This feature acts as a customer service tool, enabling you to track and communicate directly with customers regarding your published data items, facilitating support and addressing inquiries.

Appendix: Prerequisites and Specifications

This section provides detailed information on cloud storage prerequisites and the specifications required for different item categories.

Prerequisites for Cloud Storage

If your item's source files are stored on a cloud storage service, you must configure the necessary permissions to allow the Marketplace to securely access them.

GCP: Publishing Items from an External GCP Environment

To pull data from a Google Cloud Platform (GCP) environment that is external to the platform, you need to grant specific permissions at both the project and bucket levels.

Project-Level Permissions:

Grant Access to Storage Transfer Service:
- Open the Google Cloud Console and go to the IAM page.
- Click "GRANT ACCESS".
- In the "New principals" field, enter: project-905307810689@storage-transfer-service.iam.gserviceaccount.com
- Select the role "Storage Insights Collector Service" from the "Assign roles" dropdown.
- Click "SAVE".
Grant Access to MP API:
- Repeat the steps above, but this time enter the following in the "New principals" field: mp-api@pbeat03002010-qa-f25e-rdl-mark.iam.gserviceaccount.com
- Assign the same role: "Storage Insights Collector Service".

Bucket-Level Permissions:

Select Your Bucket: Go to Cloud Storage and choose the bucket containing the data you want to import.
Grant Access to Storage Transfer Service:
- Click the "PERMISSIONS" tab.
- Click "GRANT ACCESS".
- In the "New principals" field, enter: project-905307810689@storage-transfer-service.iam.gserviceaccount.com
- Select the role "Storage Object Viewer" from the "Assign roles" dropdown.
- Click "SAVE".
Grant Access to Marketplace API:
- Repeat the steps above, but this time enter the following in the "New principals" field: mp-api@pbeat03002010-qa-f25e-rdl-mark.iam.gserviceaccount.com
- Assign the same role: "Storage Object Viewer".

Important notes:

Keep these permissions in place until your items are successfully published.
For buckets located within the platform, permissions are automatically configured.

Azure: Prerequisites for Pulling Data from Azure Storage

To pull data from an Azure Storage container, you need to configure access using a Shared Access Signature (SAS) token.

Step-by-Step Instructions

Sign in to Azure Portal: Log in to the Azure portal.
Navigate to your Azure Storage account. You can typically find this by searching for "Storage accounts" in the search bar.
Locate Shared Access Signature: Within your Storage account settings, look for the "Shared access signature" section in the left-hand menu. This is usually located under the "Security + networking".
Configure SAS Token Settings:
- Allowed Services: Select Blob as the allowed service.
- Allowed Resource Types: Select Service and Object as the allowed resource types.
- Permissions: Select the necessary permissions for the data transfer. Common permissions include:
  - Read: Required to retrieve data.
  - List: Required to list the contents of the container.
  - Optional: Delete: Include this permission only if you intend to delete objects from the source container after they are transferred.
- Allowed Protocols: Choose HTTPS only for secure communication.
- Select the required Blob permissions
- Start/Expiry Times: Set the start and expiry times for the SAS token. Ensure the expiry time is sufficient to complete the data transfer, especially for large volumes of data.
- Allowed IP addresses: Do not specify any IP addresses in this field. The Storage Transfer Service uses various IP addresses and does not support IP address restrictions.
Generate SAS and Connection String: After configuring all the settings, click on the Generate SAS and connection string button.
Save Credentials: The portal will display the generated SAS token and the Blob service SAS URL. Important: You will need the SAS token and the Blob Endpoint (which is part of the Blob service SAS URL, typically in the format https://[yourstorageaccountname].blob.core.windows.net/) to configure the Storage Transfer Service within the Marketplace publish activity. Copy and securely store these values.

Best Practices

Grant only the minimum necessary permissions to the SAS token.
Set an appropriate expiry time for the token to limit its validity.
Store the generated SAS token securely.

AWS: Prerequisites for Pulling Data from AWS S3

To pull data from an AWS S3 bucket, you need to create an Access Key (consisting of an Access Key ID and a Secret Access Key) for an IAM user with appropriate permissions.

Step-by-Step Instructions

Sign in to AWS: Log in to your AWS account using the AWS Management Console.
Navigate to IAM: Open the IAM console. You can do this by searching for "IAM" in the search bar or navigating to the IAM service under "Security, Identity, & Compliance".
Create an Access Key:
- Go to the Users section in the left-hand navigation pane.
- Select the IAM user or account you want to use for accessing the S3 data.
- Go to the Security credentials tab for that user.
- Under the "Access keys" section, click on the Create access key button.
Configure Access Key Details:
- You will be prompted to select a use case. Choose the option that best fits (e.g., "Application running on EC2," "Local code," etc.). You can also select "Other" and provide a description.
- Click Next.
View and Save Keys:
- After creating the access key, you will see the Access Key ID and the Secret Access Key.
- Important: This is your only opportunity to view and save the Secret Access Key. You will not be able to retrieve it again after this step.
- Click the Show button to reveal the Secret Access Key.
- Copy both the Access Key ID and the Secret Access Key.
- Securely save these keys. You can download a .csv file containing the keys, but it is recommended to copy and paste them into a secure location immediately.

Note

Ensure the IAM user whose access key you are using has Read-only permission on the source S3 objects you intend to pull. Granting only read permissions is a security best practice. These keys are used by the Marketplace during the publish activity to access your S3 data.

Notes, Tips, or Best Practices

Grant only the minimum necessary permissions (Read-only) to the IAM user for accessing the S3 bucket.
Regularly rotate your access keys for enhanced security.
Store the generated Access Key ID and Secret Access Key securely.

Category and Specification Details

The following table outlines the mandatory fields and validation types for each item category and subcategory:

Category	Subcategory	Mandatory Fields	Validation Type	Validation Details
AI & software tools	Pretrained models	Framework	Dropdown	Predefined options (TensorFlow, PyTorch, ONNX)
		Model version	Text field	Validate as a valid version number (e.g., v1.0.0)
		Model download link / repository	URL field	Validate as a valid URL
	Apps	Platform	Dropdown	Predefined options (Web, Desktop, Cloud)
		Version	Text field	Validate as a valid version number (e.g., v1.0.0)
		Download / access URL	URL field	Validate as a valid URL
	APIs	API type	Dropdown	Predefined options (REST, GraphQL, SOAP, WebSocket)
		Version	Text field	Validate as a valid version number (e.g., v1.0.0)
		API endpoint URL	URL field	Validate as a valid URL
		API specification	Text field	Validate file type (Swagger, OpenAPI)
		Authentication type	Dropdown	Predefined options (Basic Auth, OAuth, API Key)
	Tools	Version	Text field	Validate as a valid version number (e.g., v1.0.0)
		Repository link	URL field	Validate as a valid URL
Code resources	Jupyter notebooks	Programming language	Dropdown	Dropdown with predefined options (Python, R, Julia)
		Repository / download link	URL field	Validate as a valid URL
	Scripts	Programming language	Dropdown	Dropdown with predefined options (Python, Bash, JS)
		Repository / download link	URL field	Validate as a valid URL
	Code utilities	Version	Text field	Validate as a valid version number (v1.0.0)
		Repository / download link	URL field	Validate as a valid URL
	Libraries	Supported platforms	Dropdown	Dropdown with predefined options (Windows, Linux, macOS)
		Version	Text field	Validate as a valid version number (v1.0.0)
		Repository / download link	URL field	Validate as a valid URL
Data asset	DICOMs	Modality type	Dropdown	Predefined options (CT, MRI, X-Ray)
		Data access link	URL field	Validate as a valid URL
	WSIs (Whole Slide Imaging)	Image format	Dropdown	Predefined options (SVS,TIFF)
		Data access link	URL field	Validate as a valid URL
	Basic Listings	Resource URL	URL field	Validate as a valid URL
	JSON Uploads	Version	Text field	Validate as a valid version number (v1.0.0)
	Live APIs	API endpoint URL	URL field	Validate as a valid URL
		API Request Method	Dropdown	Dropdown with predefined options (GET, POST)
		API specification	Text field	Validate file type (Swagger, OpenAPI)
		API type	Dropdown	Predefined options (REST, GraphQL, SOAP, WebSocket)
		Authentication Key	Text field	Validate key
		Authentication type	Dropdown	Predefined options (Basic Auth, OAuth, API Key)
		Version	Text field	Validate as a valid version number (v1.0.0)
Documents		Document type	Dropdown	Predefined options (Whitepaper, Guide)
		Document download / view link	URL field	Validate as a valid URL
External resources	URLs	Resource URL	URL field	Validate as a valid URL
	Research articles from journals	Journal name	Text field	Maximum Length: 55 characters
		DOI / article URL	URL field	Validate as a valid URL
Marketplace Partners	Data providers	Service category	Dropdown	Predefined options (AI, Consulting, Data)
		Contact email	Email field	Validate as a valid email address
		Resource URL	URL field	Validate as a valid URL
Services	Consultants	Service category	Dropdown	Predefined options (AI, Data, Cloud)
		Contact email	Email field	Validate as a valid email address
		Resource URL	URL field	Validate as a valid URL