VMS Component Configuration

This guide provides detailed instructions on how to configure the components that come with the Vendor Management System (VMS). Each component is explained with its purpose, configurable options, and examples of typical configurations.

---

General Information

VMS components are designed to facilitate collaboration between clients, vendors, and master vendors. These components are flexible and can be tailored to meet specific business needs through configurable properties.

Key Configuration Notes:

1. Fields used in component configurations follow this JSON format

   [
      {"label": "Tier", "path": "Tier__c"},
      {"label": "City", "path": "b3v__Account__r.BillingCity"}
   ]
   

2. Client and Sub-Vendor users require a Customer Community License and must belong to a sharing group to enable access control and secure collaboration. For more info see VMS Prerequisites.

Component Configurations

Booking Request Pattern Detail

• Purpose: Gathers info regarnding the working pattern of the booking request.
• Configurable Options:
  • Date Format: Controls the Date Format (DD/MM/YYYY or MM/DD/YYYY).
  • Use 12-hour format: Controls whether the input fields show 12 or 24 hour format.
• Example Configuration:

{
    "Date Format": "DD/MM/YYYY",
    "Use 12-hour format": true
}

SVP Vendor Broadcast Component

• Purpose: Displays broadcast invitations sent to vendors.
• Configurable Options:
  • Card Title: The title displayed at the top of the component.
  • Fields to Display on Cards: JSON array specifying which fields appear on each card.
• Example Configuration:

{
    "Card Title": "Invitations",
    "Fields to Display on Cards": [
        {"label": "Tier", "path": "Tier__c"},
        {"label": "City", "path": "b3v__Account__r.BillingCity"}
    ]
}

SVP Vendor Workers Component

• Purpose: Enables vendors to manage their workers.
• Configurable Options:
  • Card Title: The title displayed at the top of the component.
  • Fields to Display on Cards: JSON array of fields shown on worker cards.
  • Create Flow API Name: Flow used for creating new workers.
  • Edit Flow API Name: Flow used for editing existing workers.
• Example Configuration:

{
    "Card Title": "Workers",
    "Fields to Display on Cards": [
        {"label": "Name", "path": "Name"},
        {"label": "Role", "path": "Role__c"}
    ],
    "Create Flow API Name": "New_Worker",
    "Edit Flow API Name": "Edit_Worker"
}

SVP Vendor Placements Component

• Purpose: Displays information about worker placements for vendors.
• Configurable Options:
  • Card Title: The title displayed at the top of the component.
  • Fields to Display on Cards: JSON array specifying which fields appear on placement cards.
  • Edit Flow API Name: Flow used for editing placements.
• Example Configuration:

  {
      "Card Title": "Placements",
      "Fields to Display on Cards": [
          {"label": "Start Date", "path": "StartDate__c"},
          {"label": "End Date", "path": "EndDate__c"}
      ],
      "Edit Flow API Name": "Edit_Placement"
  }
  

SVP Vendor Booking Component

• Purpose: Displays booking requests and allows vendors to propose workers.
• Configurable Options:
  • Card Title: The title displayed at the top of the component.
  • Flow API Name: Flow used for proposing new workers.
  • Update Flow API Name: Flow to present when updating a Proposed Worker.
  • Retract Flow API Name: Flow used for retracting workers.
  • Fields to Display on Cards: Separate JSON arrays for open and non-open booking requests.
  • Fields to Display on Cards when Proposing a Worker: JSON arrays for individual and proposed worker fields to be shown when proposing a worker.
• Example Configuration:

{
    "Card Title": "Jobs",
    "Flow API Name": "Create_Proposed_Worker",
    "Update Flow API Name": "Update_Proposed_Worker",
    "Retract Flow API Name": "Retract_Worker",
    "Fields to Display on Cards (Open Booking Requests)": [
        {"label": "Job Name", "path": "Name"}
    ],
    "Fields to Display on Cards (Other than Open Booking Requests)": [
        {"label": "Status", "path": "Status__c"}
    ],
    "Fields to Display on cards when proposing a worker": {    
        "individual":[       
            {"label":"Account Name", "path":"b3v__Account__r.Name" }
        ],    
        "proposedWorker":[       
            {"label":"Rate", "path":"b3v__Proposed_Rate__c" }
        ] 
    },
    "Date Format": "MM/DD/YYYY"
}

Booking Request Invitations Component

• Purpose: Displays booking requests and their invitation statuses for clients.
• Configurable Options:
  • Record ID: Passes the record ID dynamically.
  • Is Embedded?: Indicates if the component is embedded.
  • Require Booking Request Acceptance?: Boolean flag for requiring acceptance.
  • Fields to Display on Cards: JSON array of fields displayed.
• Example Configuration:

{
    "Record ID": "{!recordId}",
    "Is Embedded?": true,
    "Require Booking Request Acceptance?": false,
    "Fields to Display on Cards": [
        {"label": "Tier", "path": "Tier__c"},
        {"label": "Status", "path": "Status__c"}
    ]
}

Proposed Workers Viewer Component

• Purpose: Enables clients or vendors to review proposed workers and take actions such as acceptance or rejection.
• Configurable Options:
  • Record ID: Passes the record ID dynamically.
  • Fields to Display on Cards: JSON array of fields displayed.
  • Accept Flow API Name: Flow used for accepting workers.
  • Reject Flow API Name: Flow used for rejecting workers.
• Example Configuration:

{
    "Record ID": "{!recordId}",
    "Fields to Display on Cards": [
        {"label": "Worker Name", "path": "Worker__r.Name"}
    ],
    "Accept Flow API Name": "Accept_Proposed_Worker",
    "Reject Flow API Name": "Reject_Proposed_Worker"
}