Post Demand Collaborators Using Collaboration Demand Planners
Demand collaborators are Oracle Fusion application users assigned to a security context to access collaboration demand data. A user can either be an enterprise participant or a customer participant. An enterprise participant is an existing application employee person in Human Capital Management (HCM) with a user account. A customer participant is an existing party person with or without a user account.
You create a solution that enables your customer to use a client to connect to your partner application, and then use REST API to create new demand collaborators for demand collaboration.
-
Create an enterprise demand collaborator with access to all customers and sites, and visibility to all documents.
- Create a customer demand collaborator with access to one customer and visibility to the Forecast document.
Here's a typical application processing flow for the scenario:
-
Authenticate as an administrative user.
-
Run the POST operation against the Collaboration Demand Planners resource to add a demand collaborator.
The response payload includes details that describe the results of the request.
Your partner application extracts the values for these attributes from the response payload, and then displays them in the client.
Attribute | Description | Required | User Key |
---|---|---|---|
collaborationDemandPlanners.ParticipantCode | Abbreviation that identifies the user's participant type. A list of accepted values is ORA_VCS_CUSTOMER or ORA_VCS_ENTERPRISE. | Yes | |
collaborationDemandPlanners.UserName | Login that the demand planner used to directly authenticate with the service provider. This attribute is required. | Yes | Yes |
collaborationDemandPlanners.FullAccessFlag | Contains one of the following values: Yes or No. If Yes, then the demand planner has access to the entire customer forecast data. If No, then the demand planner does not have access to the entire customer forecast data. The default value is No. | Optional | |
dataAccessSecurity.CustomerNumber | Number that identifies the customer in the customer forecast that receives the item. | Optional | Yes |
dataAccessSecurity.CustomerName | Name of the customer in the customer forecast that receives the item. | Optional | |
dataAccessSecurity.CustomerSiteNumber | Number that identifies customer site in the customer forecast that receives the item. | Optional | Yes |
dataAccessSecurity.SecurityContextCode | Abbreviation that identifies the level of security applied. A list of accepted values is defined in the lookup type ORA_VCS_SECURITY_CONTEXT. | Optional | Yes |
Example URL
Use this URL format.
curl -u username:password -X POST -H "Content-Type:application/json" -d 'request payload' "https://servername/fscmRestApi/resources/version/collaborationDemandPlanners"
Example Request
{ "ParticipantCode":"ORA_VCS_ENTERPRISE", "UserName":"darryl.lacroix", "FullAccessFlag": true, "documentVisibility": [ { "DocumentTypeCode": "VCS_FORECAST" }, { "DocumentTypeCode": "VCS_CONSUMPTION" } ] }
Example Response
{ "DemandPlannerId": 300100549464056, "UserName": "darryl.lacroix", "DisplayName": null, "ListName": null, "Email": null, "StatusCode": "ORA_VCS_ACTIVE", "Status": null, "CreatedBy": "COLLABPLANNER", "CreationDate": "2021-08-31T16:13:31+00:00", "LastUpdatedBy": "COLLABPLANNER", "LastUpdateDate": "2021-08-31T16:13:32.213+00:00", "FullAccessFlag": "true", "FirstName": null, "LastName": null, "ParticipantCode": "ORA_VCS_ENTERPRISE", "ParticipantName": null, "PersonPartyId": null, "documentVisibility": { "items": [ { "DocumentVisibilityId": 300100549464057, "DocumentId": -10001, "DocumentTypeCode": null, "DocumentTypeName": null, "CustomerLevelCode": null, "CustomerLevel": null, "OrganizationLevelCode": null, "OrganizationLevel": null, "ItemLevelCode": null, "ItemLevel": null, "StatusCode": null, "Status": null, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/collaborationDemandPlanners/300100549464056/child/documentVisibility/300100549464057", "name": "documentVisibility", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/collaborationDemandPlanners/300100549464056/child/documentVisibility/300100549464057", "name": "documentVisibility", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/collaborationDemandPlanners/300100549464056", "name": "collaborationDemandPlanners", "kind": "item" } ] }, { "DocumentVisibilityId": 300100549464058, "DocumentId": -10002, "DocumentTypeCode": null, "DocumentTypeName": null, "CustomerLevelCode": null, "CustomerLevel": null, "OrganizationLevelCode": null, "OrganizationLevel": null, "ItemLevelCode": null, "ItemLevel": null, "StatusCode": null, "Status": null, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/collaborationDemandPlanners/300100549464056/child/documentVisibility/300100549464058", "name": "documentVisibility", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/collaborationDemandPlanners/300100549464056/child/documentVisibility/300100549464058", "name": "documentVisibility", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/collaborationDemandPlanners/300100549464056", "name": "collaborationDemandPlanners", "kind": "item" } ] } ], "count": 2, "hasMore": false, "limit": 25, "offset": 0, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/collaborationDemandPlanners/300100549464056/child/documentVisibility", "name": "documentVisibility", "kind": "collection" } ] }, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/collaborationDemandPlanners/300100549464056", "name": "collaborationDemandPlanners", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/collaborationDemandPlanners/300100549464056", "name": "collaborationDemandPlanners", "kind": "item" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/collaborationDemandPlanners/300100549464056/child/dataAccessSecurity", "name": "dataAccessSecurity", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/collaborationDemandPlanners/300100549464056/child/documentVisibility", "name": "documentVisibility", "kind": "collection" } ] }
Create a Customer Demand Collaborator With Access to One Customer Site and Visibility to the Forecast Document
To create a customer demand collaborator:
- Run the GET operation against the Collaboration Contacts List of Values resource to get the Party ID of the customer contact you want to add.
- Run the POST operation against the Collaboration Demand Planners resource to add a demand collaborator.
The response payload includes details that describe the results of the request.
Your partner application extracts the values for these attributes from the response payload, and then displays them in the client.
Attribute | Description | Required | User Key |
---|---|---|---|
collaborationContactsLOV.PartyId | Value that uniquely identifies the collaboration contact. | N/A | N/A |
collaborationContactsLOV.PartyName | Name of the user displayed on the UI. | N/A | Yes |
collaborationDemandPlanners.ParticipantCode | Abbreviation that identifies the user's participant type. A list of accepted values is ORA_VCS_CUSTOMER or ORA_VCS_ENTERPRISE. | Yes | N/A |
collaborationDemandPlanners.PersonPartyId | Contains one of the following values: Yes or No. If Yes, then the demand planner has access to the entire customer forecast data. If No, then the demand planner does not have access to the entire customer forecast data. The default value is No. | Yes | N/A |
collaborationDemandPlanners.UserName | Login that the demand planner used to directly authenticate with the service provider. This attribute is required. | Yes, if the customer contact party's user account doesn't exist. | Yes |
collaborationDemandPlanners.Email | Primary work email of the user. | Yes, if the customer contact party's email address doesn't exist. | N/A |
dataAccessSecurity.CustomerNumber | Number that identifies the customer in the customer forecast that receives the item. | Optional | Yes |
dataAccessSecurity.CustomerName | Name of the customer in the customer forecast that receives the item. | Optional | N/A |
dataAccessSecurity.CustomerSiteNumber | Number that identifies customer site in the customer forecast that receives the item. | Optional | Yes |
dataAccessSecurity.SecurityContextCode | Abbreviation that identifies the level of security applied. A list of accepted values is defined in the lookup type ORA_VCS_SECURITY_CONTEXT. | Optional | Yes |
Example URL
Use this resource URL format:
GET collaborationContactsLOV
curl -u username:password -X GET -H "Content-Type:application/json" -d 'request payload' "https://servername/fscmRestApi/resources/version/collaborationContactsLOV?q=PartyName='Roger Jones&onlyData=true'"
Example Response
{ "items": [ { "PartyId": 300100549453259, "PartyName": "Roger Jones", "FirstName": "Roger", "LastName": "Jones", "EmailAddress": "roger.jones@customerweb.com", "UserName": null, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/collaborationContactsLOV/300100549453259", "name": "collaborationContactsLOV", "kind": "item" }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/collaborationContactsLOV/300100549453259", "name": "collaborationContactsLOV", "kind": "item" } ] } ], "count": 1, "hasMore": false, "limit": 25, "offset": 0, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/collaborationContactsLOV", "name": "collaborationContactsLOV", "kind": "collection" } ] }
POST collaborationDemandPlanners
curl -u username:password -X POST -H "Content-Type:application/json" -d 'request payload' "https://servername/fscmRestApi/resources/version/collaborationDemandPlanners"
Example Request
{ "ParticipantCode":"ORA_VCS_CUSTOMER", "PersonPartyId":300100549453259, "UserName":"roger.jones", "dataAccessSecurity": [ { "SecurityContextCode":"ORA_VCS_CUSTOMER_SITE", "CustomerNumber":"CustomerWeb", "CustomerSiteNumber":"Atlanta" } ], "documentVisibility": [ { "DocumentTypeCode": "VCS_FORECAST" }, { "DocumentTypeCode": "VCS_CONSUMPTION" } ] }
Example Response
Here's an example of the response body in JSON format:
{ "DemandPlannerId": 300100549469123, "UserName": "roger.jones", "DisplayName": null, "ListName": null, "Email": "sendmail-test-discard@oracle.com", "StatusCode": "ORA_VCS_PENDING_ACTIVE", "Status": null, "CreatedBy": "COLLABPLANNER", "CreationDate": "2021-08-31T16:56:36+00:00", "LastUpdatedBy": "COLLABPLANNER", "LastUpdateDate": "2021-08-31T16:56:36.391+00:00", "FullAccessFlag": "false", "FirstName": "Roger", "LastName": null, "ParticipantCode": "ORA_VCS_CUSTOMER", "ParticipantName": null, "PersonPartyId": 300100549453259, "dataAccessSecurity": { "items": [ { "DataAccessId": 300100549469124, "SecurityContextCode": "ORA_VCS_CUSTOMER_SITE", "SecurityContext": null, "CustomerId": 12543, "CustomerNumber": "CustomerWeb", "CustomerName": null, "CustomerSiteId": 999990000590315, "CustomerSiteNumber": "Atlanta", "CustomerSiteAddress": null, "CustomerSiteLocation": null, "CreatedBy": "COLLABPLANNER", "CreationDate": "2021-08-31T16:56:36.032+00:00", "LastUpdatedBy": "COLLABPLANNER", "LastUpdateDate": "2021-08-31T16:56:36.393+00:00", "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/collaborationDemandPlanners/300100549469123/child/dataAccessSecurity/300100549469124", "name": "dataAccessSecurity", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/collaborationDemandPlanners/300100549469123/child/dataAccessSecurity/300100549469124", "name": "dataAccessSecurity", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/collaborationDemandPlanners/300100549469123", "name": "collaborationDemandPlanners", "kind": "item" } ] } ], "count": 1, "hasMore": false, "limit": 25, "offset": 0, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/collaborationDemandPlanners/300100549469123/child/dataAccessSecurity", "name": "dataAccessSecurity", "kind": "collection" } ] }, "documentVisibility": { "items": [ { "DocumentVisibilityId": 300100549469125, "DocumentId": -10001, "DocumentTypeCode": null, "DocumentTypeName": null, "CustomerLevelCode": null, "CustomerLevel": null, "OrganizationLevelCode": null, "OrganizationLevel": null, "ItemLevelCode": null, "ItemLevel": null, "StatusCode": null, "Status": null, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/collaborationDemandPlanners/300100549469123/child/documentVisibility/300100549469125", "name": "documentVisibility", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/collaborationDemandPlanners/300100549469123/child/documentVisibility/300100549469125", "name": "documentVisibility", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/collaborationDemandPlanners/300100549469123", "name": "collaborationDemandPlanners", "kind": "item" } ] }, { "DocumentVisibilityId": 300100549469126, "DocumentId": -10002, "DocumentTypeCode": null, "DocumentTypeName": null, "CustomerLevelCode": null, "CustomerLevel": null, "OrganizationLevelCode": null, "OrganizationLevel": null, "ItemLevelCode": null, "ItemLevel": null, "StatusCode": null, "Status": null, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/collaborationDemandPlanners/300100549469123/child/documentVisibility/300100549469126", "name": "documentVisibility", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/collaborationDemandPlanners/300100549469123/child/documentVisibility/300100549469126", "name": "documentVisibility", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/collaborationDemandPlanners/300100549469123", "name": "collaborationDemandPlanners", "kind": "item" } ] } ], "count": 2, "hasMore": false, "limit": 25, "offset": 0, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/collaborationDemandPlanners/300100549469123/child/documentVisibility", "name": "documentVisibility", "kind": "collection" } ] }, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/collaborationDemandPlanners/300100549469123", "name": "collaborationDemandPlanners", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/collaborationDemandPlanners/300100549469123", "name": "collaborationDemandPlanners", "kind": "item" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/collaborationDemandPlanners/300100549469123/child/dataAccessSecurity", "name": "dataAccessSecurity", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/collaborationDemandPlanners/300100549469123/child/documentVisibility", "name": "documentVisibility", "kind": "collection" } ] }