{"type":"doc","content":[{"type":"bodiedExtension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"excerpt","parameters":{"macroParams":{},"macroMetadata":{"macroId":{"value":"9dc1e2da-9e4d-48d5-afed-1aa6ae3ea801"},"schemaVersion":{"value":"1"},"title":"Excerpt"}},"localId":"0f9ec4b0-ca78-40c2-8fda-b7952c8aaa6a"},"content":[{"type":"paragraph","content":[{"text":"Allows you to find the ids of dimensions (such as Staff or Resources) that are available for a given reservation.","type":"text"}]}]},{"type":"paragraph","content":[{"text":"This functionality is also available in Lightning (Screen) Flow, see the last section of this page.","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Methods","type":"text"}]},{"type":"expand","attrs":{"title":"findAvailableDimensionIds"},"content":[{"type":"heading","attrs":{"level":4},"content":[{"text":"Description","type":"text"}]},{"type":"paragraph","content":[{"text":"This method returns a set with dimension ids that are available for the given input.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Signature","type":"text"}]},{"type":"codeBlock","content":[{"text":"global static Set findAvailableDimensionIds(B25.AvailableDimensionIds.Context)","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Parameters","type":"text"}]},{"type":"codeBlock","content":[{"text":"B25.AvailableDimensionIds.Context","type":"text"}]},{"type":"paragraph","content":[{"text":"Class that contains the input parameters for this method. See the inner class B25.AvailableDimensionIds.Context for more details.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Return Type","type":"text"}]},{"type":"codeBlock","content":[{"text":"Set","type":"text"}]},{"type":"paragraph","content":[{"text":"Set containing all the dimension IDs that would not result in any conflicts, if used for the given Reservation and Dimension Field.","type":"text"}]}]},{"type":"expand","attrs":{"title":"findSingleAvailableDimensionIds"},"content":[{"type":"heading","attrs":{"level":4},"content":[{"text":"Description","type":"text"}]},{"type":"paragraph","content":[{"text":"This method is basically the same as ","type":"text"},{"text":"findAvailableDimensionIds","type":"text","marks":[{"type":"code"}]},{"text":" with a few differences:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"It is ","type":"text"},{"text":"invocable","type":"text","marks":[{"type":"strong"}]},{"text":", so it can be called from flows","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"It has a bulkified signature (input list + output list)","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The result not only contains the complete collection of all available ids, but also a single id for convenience in flows when you just need an arbitrary single value.","type":"text"}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Signature","type":"text"}]},{"type":"codeBlock","content":[{"text":"@InvocableMethod\nglobal static List findSingleAvailableDimensionId(List)","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Parameters","type":"text"}]},{"type":"codeBlock","content":[{"text":"List","type":"text"}]},{"type":"paragraph","content":[{"text":"A list of objects that contain the input parameters for this method. See the inner class B25.AvailableDimensionIds.Context for more details.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Return Type","type":"text"}]},{"type":"codeBlock","content":[{"text":"List","type":"text"}]},{"type":"paragraph","content":[{"text":"List of results, see the inner class B25.AvailableDimensionIds.Result for more details.","type":"text"}]}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Inner Classes","type":"text"}]},{"type":"expand","attrs":{"title":"Context"},"content":[{"type":"heading","attrs":{"level":4},"content":[{"text":"Description","type":"text"}]},{"type":"paragraph","content":[{"text":"This class wraps the input parameters, most notably the dimension field that you are searching through and the reservation that defines the times as well as any conflict related properties.","type":"text"}]},{"type":"panel","attrs":{"panelType":"warning"},"content":[{"type":"paragraph","content":[{"text":"The optional properties dimensionIds/dimensionRecordIds narrow down the search scope. If neither is set, the method will query all records of the SObject type defined by dimensionFieldName. This greatly impacts performance and it is therefore recommended to fill one of these parameters when searching in dimensions with a large amount of records.","type":"text"}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Properties","type":"text"}]},{"type":"codeBlock","content":[{"text":"@InvocableVariable\nReservation__c reservation","type":"text"}]},{"type":"paragraph","content":[{"text":"Required. ","type":"text","marks":[{"type":"strong"}]},{"text":"Reservation you want to get available dimensions for. ","type":"text"},{"text":"B25__StartLocal__c ","type":"text","marks":[{"type":"strong"}]},{"text":"and ","type":"text"},{"text":"B25__EndLocal__c ","type":"text","marks":[{"type":"strong"}]},{"text":"need to be set. Make sure that any fields that influence conflict checking are set (i.e. the status or the quantity), or the result might not contain all available dimensions.","type":"text"}]},{"type":"codeBlock","content":[{"text":"@InvocableVariable\nString dimensionFieldName","type":"text"}]},{"type":"paragraph","content":[{"text":"Required. ","type":"text","marks":[{"type":"strong"}]},{"text":"The name of the dimension field you want to search an available ID for. I.e. 'B25__Resource__c'.","type":"text"}]},{"type":"codeBlock","content":[{"text":"Set dimensionIds","type":"text"}]},{"type":"paragraph","content":[{"text":"Scope of dimension IDs to limit the search to. These have to be of the same SObject type as the dimension field that you are searching in.","type":"text"}]},{"type":"codeBlock","content":[{"text":"@InvocableVariable\nList dimensionRecordIds","type":"text"}]},{"type":"paragraph","content":[{"text":"Scope of dimension IDs that the invocable method searches through. This is a duplicate of the dimensionIds Set and is only used for ","type":"text"},{"text":"findSingleAvailableDimensionId","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]},{"type":"codeBlock","content":[{"text":"@InvocableVariable\nSet excludedReservationIds","type":"text"}]},{"type":"paragraph","content":[{"text":"Reservation IDs to ignore in conflict checking. This allows you to exclude reservations you are in the process of moving.","type":"text"}]}]},{"type":"expand","attrs":{"title":"Result"},"content":[{"type":"heading","attrs":{"level":4},"content":[{"text":"Description","type":"text"}]},{"type":"paragraph","content":[{"text":"This class wraps the result, which contains a list of available dimension ids, as well as a single arbitrary available id for convenience.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Properties","type":"text"}]},{"type":"codeBlock","content":[{"text":"@InvocableVariable\nList availableDimensionIds","type":"text"}]},{"type":"paragraph","content":[{"text":"A list of all the available dimension IDs","type":"text"}]},{"type":"codeBlock","content":[{"text":"@InvocableVariable\nId availableDimensionId","type":"text"}]},{"type":"paragraph","content":[{"text":"A single ID of the first dimension in availableDimensionIds list.","type":"text"}]}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Example","type":"text"}]},{"type":"paragraph","content":[{"text":"This example shows how you can use the class in your own code:","type":"text"}]},{"type":"codeBlock","content":[{"text":"public static Set getDimensions(B25__Reservation__c reservation, String dimensionFieldName, Set dimensionIds) {\n B25.AvailableDimensionIds.Context context = new B25.AvailableDimensionIds.Context();\n context.reservation = reservation;\n context.dimensionFieldName = dimensionFieldName;\n context.dimensionIds = dimensionIds;\n return B25.AvailableDimensionIds.findAvailableDimensionIds(context);\n}","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"GoMeddo Rest API","type":"text"}]},{"type":"paragraph","content":[{"text":"In the GoMeddo Rest API, a similar function called findAvailableDimensionIds exists, filtering a list of dimension IDs to retain only those where a specific reservation can be created.","type":"text"}]},{"type":"paragraph","content":[{"text":"https://apidocs.gomeddo.com/#/availability/post_findAvailableDimensionIds","type":"text","marks":[{"type":"link","attrs":{"href":"https://apidocs.gomeddo.com/#/availability/post_findAvailableDimensionIds"}}]},{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Lightning (Screen) Flow Apex Action","type":"text"}]},{"type":"paragraph","content":[{"text":"This functionality is also available as an Apex Action in Lightning Flow, called 'Find available dimension records':","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"4f36e1c2-761e-4c39-8103-9995067b2942"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Set Input Values for the Selected Action","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph"}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Dimension Field Name","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Name of the Dimension Field to check","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Dimension Record Ids","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"List of IDs of Dimension records to check","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Excluded Reservation Ids","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"List of IDs of Dimension records to exclude","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Reservation","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Reservation for which a Dimension record is needed","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Advanced > Manually assign variables","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph"}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Available Dimension Id","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Variable containing 1 resulting ID","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Available Dimension Ids","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Variable containing 1list of resulting IDs","type":"text"}]}]}]}]},{"type":"mediaSingle","attrs":{"layout":"center"},"content":[{"type":"media","attrs":{"width":789,"id":"90b337ac-dd1b-4c11-a1c0-9cdc3c172574","collection":"contentId-794165249","type":"file","height":1137}}]},{"type":"paragraph","content":[{"type":"hardBreak"}]}],"version":1}

Browser not supported